Skip to content

Commit 8d7ac2a

Browse files
bc-afengbc-afeng
committed
fix(payment): PAYMENTS-11168 Update transaction created webhook order id to be string
1 parent 8969e12 commit 8d7ac2a

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

‎docs/integrations/webhooks/events/index.mdx‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Webhook Events
3-
keywords: webhooks, currency, currencies, events, bopis, buy online pick up in store, inventory, sort,
3+
keywords: webhooks, currency, currencies, events, bopis, buy online pick up in store, inventory, sort,
44
---
55

66
# Webhook Events
@@ -44,7 +44,7 @@ Callback payloads take the following form. The `data` property contains varying
4444
|:------------------------|:------------|
4545
| store/brand/metafield/* | Fires for all store/brand/metafield events. |
4646
| store/brand/metafield/created | Fires when a new brand metafield is created. |
47-
| store/brand/metafield/deleted | Fires when a brand metafield is deleted. |
47+
| store/brand/metafield/deleted | Fires when a brand metafield is deleted. |
4848
| store/brand/metafield/updated | Fires when a brand metafield is modified. |
4949

5050
Payload objects with the following scopes take the form that follows:
@@ -440,7 +440,7 @@ Payload objects with the following scopes take the form that follows:
440440
}
441441
```
442442

443-
## Modifiers
443+
## Modifiers
444444

445445
| Name / Scope | Description |
446446
|:-------------------------|:------------|
@@ -459,7 +459,7 @@ The payload object takes the form that follows:
459459
"context": {
460460
"channel_id": 2,
461461
"locale": "fr"
462-
}
462+
}
463463
},
464464
"hash": "a833a57fadd56a32dc752fb6ca0841dc9602a495",
465465
"created_at": 1561479233,
@@ -490,7 +490,7 @@ The payload object takes the form that follows:
490490
"context": {
491491
"channel_id": 2,
492492
"locale": "fr"
493-
}
493+
}
494494
},
495495
"hash": "a833a57fadd56a32dc752fb6ca0841dc9602a495",
496496
"created_at": 1561479233,
@@ -607,7 +607,7 @@ Payload objects with the following scopes take the form that follows:
607607
"store_id": "1025646",
608608
"data": {
609609
"type": "transaction", // will always be transaction
610-
"order_id": 250, // ID of the order associated with the transaction
610+
"order_id": "250", // ID of the order associated with the transaction
611611
"transaction_id": "176342342", // ID of the transaction; created by the payment provider
612612
"transaction_status": "complete",
613613
"transaction_type": "capture",
@@ -654,16 +654,16 @@ The following webhook events fire in response to actions that affect a specific
654654

655655
| Name / Scope | Description |
656656
|:-------------|:------------|
657-
| `store/priceList/created` | Fires when a price list is created. |
658-
| `store/priceList/updated/` | Fires when a price list is updated. |
659-
| `store/priceList/activated/` | Fires when a price list is activated. |
660-
| `store/priceList/deactivated/` | Fires when a price list is deactivated. |
661-
| `store/priceList/deleted/` | Fires when a price list is deleted. |
657+
| `store/priceList/created` | Fires when a price list is created. |
658+
| `store/priceList/updated/` | Fires when a price list is updated. |
659+
| `store/priceList/activated/` | Fires when a price list is activated. |
660+
| `store/priceList/deactivated/` | Fires when a price list is deactivated. |
661+
| `store/priceList/deleted/` | Fires when a price list is deleted. |
662662

663663
Payload objects with the following scopes take the form that follows:
664664

665665
* `store/priceList/created`
666-
* `store/priceList/updated/`
666+
* `store/priceList/updated/`
667667
* `store/priceList/activated/`
668668
* `store/priceList/deactivated/`
669669
* `store/priceList/deleted/`
@@ -684,7 +684,7 @@ The following batch webhook events fire in response to actions that affect price
684684

685685
| Name / Scope | Description |
686686
|:-------------|:------------|
687-
| `store/priceLists/deleted/` | Fires when price list are deleted. |
687+
| `store/priceLists/deleted/` | Fires when price list are deleted. |
688688

689689
Payload objects with the following scopes take the form that follows:
690690
* `store/priceLists/deleted/`
@@ -717,15 +717,15 @@ The following webhook events fire in response to actions that affect a specific
717717

718718
| Name / Scope | Description |
719719
|:-------------|:------------|
720-
| `store/priceList/record/created/` | Fires when a price list record is created. |
721-
| `store/priceList/record/updated/` | Fires when an existing specific price list record is updated by variant and currency. |
722-
| `store/priceList/record/deleted/` | Fires when a price list record is deleted. |
720+
| `store/priceList/record/created/` | Fires when a price list record is created. |
721+
| `store/priceList/record/updated/` | Fires when an existing specific price list record is updated by variant and currency. |
722+
| `store/priceList/record/deleted/` | Fires when a price list record is deleted. |
723723

724724

725725
Payload objects with the following scopes take the form that follows:
726726

727727
* `store/priceList/record/created`
728-
* `store/priceList/record/updated/`
728+
* `store/priceList/record/updated/`
729729
* `store/priceList/record/deleted/`
730730

731731
```json filename="Example payload object for creating a price list record" showLineNumbers copy
@@ -747,9 +747,9 @@ The following batch webhook events fire in response to actions that affect price
747747

748748
| Name / Scope | Description |
749749
|:-------------|:------------|
750-
| `store/priceList/records/created/` | Fires when price list records are created. |
751-
| `store/priceList/records/updated/` | Fires when you update one or more existing price list records using any batch call.|
752-
| `store/priceList/records/deleted/` | Fires when price list records are deleted. |
750+
| `store/priceList/records/created/` | Fires when price list records are created. |
751+
| `store/priceList/records/updated/` | Fires when you update one or more existing price list records using any batch call.|
752+
| `store/priceList/records/deleted/` | Fires when price list records are deleted. |
753753

754754
Payload objects with the following scopes take the form that follows:
755755
* `store/priceList/records/created`
@@ -782,10 +782,10 @@ Payload objects with the following scopes take the form that follows:
782782

783783
The following webhook events fire in response to price list assignment changes:
784784

785-
| Name / Scope | Description |
785+
| Name / Scope | Description |
786786
|:-------------|:------------|
787-
| `store/priceList/assignment/updated` | Fires when a price list assignment is assigned, reassigned, or unassigned. |
788-
| `store/priceList/assignment/deleted` | Fires when a price list assignment is deleted. |
787+
| `store/priceList/assignment/updated` | Fires when a price list assignment is assigned, reassigned, or unassigned. |
788+
| `store/priceList/assignment/deleted` | Fires when a price list assignment is deleted. |
789789

790790
Price list assignment payload objects take the form that follows:
791791
* `store/priceList/assignment/updated`
@@ -863,7 +863,7 @@ Payload objects with the following scopes take the form that follows:
863863
"context": {
864864
"channel_id": 2,
865865
"locale": "fr"
866-
}
866+
}
867867
},
868868
"hash": "a833a57fadd56a32dc752fb6ca0841dc9602a495",
869869
"created_at": 1561479233,
@@ -908,11 +908,11 @@ A change to any of the following fields triggers a `store/product/updated` event
908908
* Pre-order:
909909
* Is Preorder Only
910910
* Preorder Message
911-
* Pricing:
911+
* Pricing:
912912
* Price
913913
* Cost Price
914914
* Retail Price
915-
* Sale Price
915+
* Sale Price
916916
* Is Price Hidden
917917
* Price-hidden Label
918918
* Product Type
@@ -933,12 +933,12 @@ A change to any of the following fields triggers a `store/product/updated` event
933933
* Warranty
934934
* Weight
935935

936-
A change to the following field triggers the `store/product/updated` event only if the change is made for a _channel locale_. For more information, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements/overview) overview.
936+
A change to the following field triggers the `store/product/updated` event only if the change is made for a _channel locale_. For more information, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements/overview) overview.
937937

938938
* Custom field's name or value
939939

940940
<Callout type="info">
941-
Setting a thumbnail triggers an updated event only when that thumbnail is the first to be set. For example, setting an image as a thumbnail **after deleting all images** triggers an updated event. However, changing the current thumbnail, uploading an additional product image and setting it as the thumbnail, or even deleting all thumbnails, does not generate an update event.
941+
Setting a thumbnail triggers an updated event only when that thumbnail is the first to be set. For example, setting an image as a thumbnail **after deleting all images** triggers an updated event. However, changing the current thumbnail, uploading an additional product image and setting it as the thumbnail, or even deleting all thumbnails, does not generate an update event.
942942
</Callout>
943943

944944

@@ -1111,7 +1111,7 @@ Payload objects with the following scopes take the form that follows:
11111111
"method": "absolute", // absolute or relative
11121112
// absolute -- inventory updated using the API or the control panel
11131113
// relative -- inventory updated by an order
1114-
"value": 5, // the number of items that the inventory changed by.
1114+
"value": 5, // the number of items that the inventory changed by.
11151115
// This can be negative if the inventory is decreased (-3), or positive if an item is returned to the inventory from an order (+2).
11161116
"variant_id": 509 // ID of the variant
11171117
}

‎docs/webhooks/callbacks/store_order_transaction_created.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ properties:
1818
type: object
1919
properties:
2020
order_id:
21-
type: integer
21+
type: string
2222
transaction_id:
2323
type: string
2424
type:

0 commit comments

Comments
 (0)