About Order
Access scope
Multiple access scopes needed — refer to each endpoint for access scope requirements.
Order Management is a core component of the Genstore trading system, enabling end-to-end order lifecycle management. Through standardized order processing workflows, it provides merchants with efficient and reliable order management capabilities, ensuring transaction security and business continuity.
Core Features
- Basic Order Operations: Create order, modify order, cancel order, delete order.
- Order Status Management: Confirm order, close order, reopen order.
- Order Information Query: Get order details, list orders, count orders.
Use Cases
- Omnichannel Order Operations: Merchants can centrally manage orders from different channels, achieving unified order processing and status synchronization to improve operational efficiency.
- Order Fulfillment Management: Operations teams can monitor order status in real-time, assign processing tasks, and track exceptional orders to ensure timely delivery and customer satisfaction.
- Transaction Data Analytics: Data analysis teams can access comprehensive order data to perform transaction trend analysis and customer behavior insights, supporting business decision-making.
- Customer Service Coordination: Customer service teams can quickly retrieve order details, process after-sales requests, and document service interactions to deliver professional customer service experience.
Endpoints
EVENT orders/update: Order update
EVENT orders/create: Order create
EVENT orders/paid: Order paid
EVENT orders/fulfilled: Order fulfilled
EVENT orders/cancelled: Order cancelled
EVENT orders/partiallyFulfilled: Order partially fulfilled
Order Object
The order object.
Properties
orderobject
The order is a customer's request to purchase one or more products from a shop.
- Hide child properties
billingAddressobject
The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.
+ Show child properties
cancelReasonstring
The reason why the order was canceled.
cancelledTimestring
The date and time when the order was canceled. Returns null if the order isn't canceled.
closedTimestring
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
createdTimestring
The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.
currencystring
The three-letter code (ISO 4217 format) for the shop currency.
customerobject
Information about the customer.
+ Show child properties
discountCodesarray
A list of discounts applied to the order.
+ Show child properties
emailstring
The customer's email address.
financialStatusstring
The status of payments associated with the order. Can only be set when the order is created.Enumeration: pending - to be paid; partiallyPaid - partial; paid - paid.
fulfillmentsarray
An array of fulfillments associated with the order.
+ Show child properties
fulfillmentStatusstring
The order's status in terms of fulfilled line items. Enumeration: null - not fulfilled; partial - partial fulfilled; fulfilled - fulfilled; canceled - fulfillment canceled.
lineItemsarray
A list of line item objects, each containing information about an item in the order.
+ Show child properties
notestring
An optional note that a shop owner can attach to the order.
idnumber
The order's position in the shop's count of orders.
paymentTermsarray
The terms and conditions under which a payment should be processed.
+ Show child properties
paymentGatewayNamesarray
The list of payment gateways used for the order.Including but not limited to: CASH_ON_DELIVERY - Pay on delivery; MANUAL_METHOD - Manual payment.
phonestring
The customer's phone number for receiving SMS notifications.
shippingAddressobject
The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.
+ Show child properties
sourceIdentifierstring
The ID of the order placed on the originating platform.
subtotalPricestring
The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.
tagsstring
Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.
totalDiscountsstring
The total discounts applied to the price of the order in the shop currency.
totalPricestring
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
totalTaxstring
The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.
totalWeightstring
The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.
updatedTimestring
The date and time (ISO 8601 format) when the order was last modified.
paidTimestring
The date and time (ISO 8601 format) when the order payment was completed.
paymentTypestring
Order payment type. Enumeration values: online - online payment; offline - offline payment; noPayment - no payment required; quick - quick payment.
convertRatenumber
Exchange rate from market currency to shop currency
totalDiscountsSetobject
Total discounts amount price set.
+ Show child properties
discountApplicationsarray
Discount applications list.
+ Show child properties
processedTimestring
Processing time.
refundsarray
Refunds list.
+ Show child properties
shippingLinesarray
Shipping lines list.
+ Show child properties
subtotalPriceSetobject
Subtotal price set.
+ Show child properties
taxLinesarray
Tax lines list.
+ Show child properties
totalPriceSetobject
Total price set.
+ Show child properties
totalTaxSetobject
Total tax set.
+ Show child properties
totalShippingPricestring
Shipping fee.
totalShippingPriceSetobject
Shipping fee amount set.
+ Show child properties
userIdnumber
User ID.
i18nstring
Internationalization information.
shopCurrencystring
Shop currency.
appstring
Application identifier.
typenumber
Order type.Enumeration:1 - ordinary order; 11 - external order.
bash
{
"order": {
"note": "Please deliver after 6 PM",
"sourceIdentifier": "WEB123456",
"shopCurrency": "USD",
"totalPrice": "110.25",
"totalDiscounts": "10.25",
"paymentGatewayNames": [
"PayPal",
"Credit Card"
],
"type": "1",
"closedTime": "2023-05-20T14:45:30-05:00",
"fulfillmentStatus": "fulfilled",
"paymentType": "online",
"refunds": [
{
"totalRefundShippingPrice": "5.99",
"totalRefundPrice": "29.99",
"refundLineItems": [
{
"totalTax": "1.50",
"quantity": "1",
"lineItem": {
"quantity": "2",
"productId": "123456",
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "12",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "1",
"alreadyRightsNum": "1",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1"
},
"lineItemId": "789",
"subtotal": "19.99",
"rightsReason": "Description of Other Reasons",
"id": "201",
"rightsReasonType": "1"
}
],
"refundId": "12345",
"processedTime": "2023-05-20T10:00:00-05:00",
"status": "1"
}
],
"totalTaxSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"lineItems": [
{
"priceSet": {
"shopMoney": {
"amount": "29.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "29.99",
"currencyCode": "USD"
}
},
"variantTitle": "Red",
"quantity": "2",
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"code": "EXPRESS",
"discountedPrice": "7.99",
"price": "9.99",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"productId": "123456",
"discountAllocations": {
"amount": "2.50",
"discountApplicationIndex": "1",
"amountSet": {
"shopMoney": {
"amount": "2.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "2.50",
"currencyCode": "USD"
}
}
},
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "3",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "456",
"alreadyRightsNum": "1",
"giftCard": "false",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "987654",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1",
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
}
],
"totalTax": "8.50",
"fulfillments": [
{
"lineItems": [
{
"fulfillmentOrderId": "456",
"quantity": "2",
"productId": "1001",
"lineItemId": "789",
"id": "101",
"shopId": "123",
"variantId": "2002"
}
],
"updatedTime": "2023-05-15T14:20:00-05:00",
"orderId": "54321",
"fulfillTime": "2023-05-15T14:20:00-05:00",
"createdTime": "2023-05-15T10:30:00-05:00",
"fulfillId": "98765",
"status": "success"
}
],
"convertRate": "1.25",
"totalPriceSet": {
"shopMoney": {
"amount": "110.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "110.25",
"currencyCode": "USD"
}
},
"createdTime": "2023-05-10T09:15:00-05:00",
"currency": "USD",
"totalDiscountsSet": {
"shopMoney": {
"amount": "10.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "10.25",
"currencyCode": "USD"
}
},
"id": "54321",
"cancelReason": "customer",
"subtotalPrice": "85.50",
"email": "customer@example.com",
"paymentTerms": [
{
"amount": "100.00",
"paymentTermsName": "分期付款",
"paymentId": "1",
"channelTrxNo": "TRX123456",
"currency": "CNY"
}
],
"subtotalPriceSet": {
"shopMoney": {
"amount": "85.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "85.50",
"currencyCode": "USD"
}
},
"app": "shopify",
"updatedTime": "2023-05-15T16:30:00-05:00",
"discountCodes": [
{
"amount": "25.00",
"code": "SUMMER20",
"type": "1"
}
],
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountedPrice": "7.99",
"price": "9.99",
"id": "456",
"source": "shopify",
"title": "Express Shipping",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"totalShippingPriceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountApplications": [
{
"code": "SAVE20",
"targetType": "lineItem",
"id": "da_12345",
"title": "Summer Sale",
"value": "15"
}
],
"totalShippingPrice": "9.99",
"paidTime": "2023-05-15T10:30:00-05:00",
"userId": "12345",
"i18n": "{"language":"en", "country":"US"}",
"tags": "urgent, gift",
"processedTime": "2023-05-15T14:30:00-05:00",
"phone": "+1234567890",
"cancelledTime": "2023-05-15T10:30:00-05:00",
"financialStatus": "paid",
"totalWeight": "500",
"shippingAddress": {
"zip": "10001",
"country": "USA",
"lastName": "Smith",
"address2": "Apt 3B",
"city": "New York",
"address1": "456 Oak Street",
"provinceCode": "CA",
"latitude": "40.7128",
"firstName": "John",
"province": "California",
"phone": "+1234567890",
"countryCode": "US",
"name": "John Smith",
"company": "XYZ Corporation",
"longitude": "-74.0060"
},
"billingAddress": {
"zip": "T0E 0M0",
"country": "Canada",
"lastName": "Gorski",
"address2": "Apartment 5",
"city": "Drayton Valley",
"address1": "2259 Park Ct",
"provinceCode": "AB",
"latitude": "45.41634",
"firstName": "Christopher",
"province": "Alberta",
"phone": "(555)555-5555",
"countryCode": "CA",
"name": "Christopher Gorski",
"company": "ABC Company",
"longitude": "-75.6868"
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"customer": {
"updatedTime": "2023-05-12T16:45:20-05:00",
"lastName": "Smith",
"note": "VIP customer with multiple purchases",
"addresses": [
{
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"company": "Weimob",
"countryName": "China"
}
],
"taxExempt": "false",
"totalSpent": "542.75",
"taxExemptions": [
"VAT_EXEMPT"
],
"tags": "loyal,repeat-customer",
"firstName": "John",
"ordersCount": "100",
"phone": "+1234567890",
"createdTime": "2023-01-15T10:30:00-05:00",
"id": "12345",
"email": "customer@example.com",
"verifiedEmail": "true",
"defaultAddress": {
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"customerId": "123456",
"company": "Weimob",
"countryName": "China",
"id": "123456"
}
}
}
}EVENT Order update
Occurs whenever an order is updated.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/update
Event Data
orderobject
The order is a customer's request to purchase one or more products from a shop.
- Hide child properties
billingAddressobject
The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.
+ Show child properties
cancelReasonstring
The reason why the order was canceled.
cancelledTimestring
The date and time when the order was canceled. Returns null if the order isn't canceled.
closedTimestring
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
createdTimestring
The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.
currencystring
The three-letter code (ISO 4217 format) for the shop currency.
customerobject
Information about the customer.
+ Show child properties
discountCodesarray
A list of discounts applied to the order.
+ Show child properties
emailstring
The customer's email address.
financialStatusstring
The status of payments associated with the order. Can only be set when the order is created.Enumeration: pending - to be paid; partiallyPaid - partial; paid - paid.
fulfillmentsarray
An array of fulfillments associated with the order.
+ Show child properties
fulfillmentStatusstring
The order's status in terms of fulfilled line items. Enumeration: null - not fulfilled; partial - partial fulfilled; fulfilled - fulfilled; canceled - fulfillment canceled.
lineItemsarray
A list of line item objects, each containing information about an item in the order.
+ Show child properties
notestring
An optional note that a shop owner can attach to the order.
idnumber
The order's position in the shop's count of orders.
paymentTermsarray
The terms and conditions under which a payment should be processed.
+ Show child properties
paymentGatewayNamesarray
The list of payment gateways used for the order.Including but not limited to: CASH_ON_DELIVERY - Pay on delivery; MANUAL_METHOD - Manual payment.
phonestring
The customer's phone number for receiving SMS notifications.
shippingAddressobject
The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.
+ Show child properties
sourceIdentifierstring
The ID of the order placed on the originating platform.
subtotalPricestring
The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.
tagsstring
Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.
totalDiscountsstring
The total discounts applied to the price of the order in the shop currency.
totalPricestring
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
totalTaxstring
The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.
totalWeightstring
The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.
updatedTimestring
The date and time (ISO 8601 format) when the order was last modified.
paidTimestring
The date and time (ISO 8601 format) when the order payment was completed.
paymentTypestring
Order payment type. Enumeration values: online - online payment; offline - offline payment; noPayment - no payment required; quick - quick payment.
convertRatenumber
Exchange rate from market currency to shop currency
totalDiscountsSetobject
Total discounts amount price set.
+ Show child properties
discountApplicationsarray
Discount applications list.
+ Show child properties
processedTimestring
Processing time.
refundsarray
Refunds list.
+ Show child properties
shippingLinesarray
Shipping lines list.
+ Show child properties
subtotalPriceSetobject
Subtotal price set.
+ Show child properties
taxLinesarray
Tax lines list.
+ Show child properties
totalPriceSetobject
Total price set.
+ Show child properties
totalTaxSetobject
Total tax set.
+ Show child properties
totalShippingPricestring
Shipping fee.
totalShippingPriceSetobject
Shipping fee amount set.
+ Show child properties
userIdnumber
User ID.
i18nstring
Internationalization information.
shopCurrencystring
Shop currency.
appstring
Application identifier.
typenumber
Order type.Enumeration:1 - ordinary order; 11 - external order.
json
{
"order": {
"note": "Please deliver after 6 PM",
"sourceIdentifier": "WEB123456",
"shopCurrency": "USD",
"totalPrice": "110.25",
"totalDiscounts": "10.25",
"paymentGatewayNames": [
"PayPal",
"Credit Card"
],
"type": "1",
"closedTime": "2023-05-20T14:45:30-05:00",
"fulfillmentStatus": "fulfilled",
"paymentType": "online",
"refunds": [
{
"totalRefundShippingPrice": "5.99",
"totalRefundPrice": "29.99",
"refundLineItems": [
{
"totalTax": "1.50",
"quantity": "1",
"lineItem": {
"quantity": "2",
"productId": "123456",
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "12",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "1",
"alreadyRightsNum": "1",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1"
},
"lineItemId": "789",
"subtotal": "19.99",
"rightsReason": "Description of Other Reasons",
"id": "201",
"rightsReasonType": "1"
}
],
"refundId": "12345",
"processedTime": "2023-05-20T10:00:00-05:00",
"status": "1"
}
],
"totalTaxSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"lineItems": [
{
"priceSet": {
"shopMoney": {
"amount": "29.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "29.99",
"currencyCode": "USD"
}
},
"variantTitle": "Red",
"quantity": "2",
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"code": "EXPRESS",
"discountedPrice": "7.99",
"price": "9.99",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"productId": "123456",
"discountAllocations": {
"amount": "2.50",
"discountApplicationIndex": "1",
"amountSet": {
"shopMoney": {
"amount": "2.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "2.50",
"currencyCode": "USD"
}
}
},
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "3",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "456",
"alreadyRightsNum": "1",
"giftCard": "false",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "987654",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1",
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
}
],
"totalTax": "8.50",
"fulfillments": [
{
"lineItems": [
{
"fulfillmentOrderId": "456",
"quantity": "2",
"productId": "1001",
"lineItemId": "789",
"id": "101",
"shopId": "123",
"variantId": "2002"
}
],
"updatedTime": "2023-05-15T14:20:00-05:00",
"orderId": "54321",
"fulfillTime": "2023-05-15T14:20:00-05:00",
"createdTime": "2023-05-15T10:30:00-05:00",
"fulfillId": "98765",
"status": "success"
}
],
"convertRate": "1.25",
"totalPriceSet": {
"shopMoney": {
"amount": "110.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "110.25",
"currencyCode": "USD"
}
},
"createdTime": "2023-05-10T09:15:00-05:00",
"currency": "USD",
"totalDiscountsSet": {
"shopMoney": {
"amount": "10.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "10.25",
"currencyCode": "USD"
}
},
"id": "54321",
"cancelReason": "customer",
"subtotalPrice": "85.50",
"email": "customer@example.com",
"paymentTerms": [
{
"amount": "100.00",
"paymentTermsName": "分期付款",
"paymentId": "1",
"channelTrxNo": "TRX123456",
"currency": "CNY"
}
],
"subtotalPriceSet": {
"shopMoney": {
"amount": "85.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "85.50",
"currencyCode": "USD"
}
},
"app": "shopify",
"updatedTime": "2023-05-15T16:30:00-05:00",
"discountCodes": [
{
"amount": "25.00",
"code": "SUMMER20",
"type": "1"
}
],
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountedPrice": "7.99",
"price": "9.99",
"id": "456",
"source": "shopify",
"title": "Express Shipping",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"totalShippingPriceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountApplications": [
{
"code": "SAVE20",
"targetType": "lineItem",
"id": "da_12345",
"title": "Summer Sale",
"value": "15"
}
],
"totalShippingPrice": "9.99",
"paidTime": "2023-05-15T10:30:00-05:00",
"userId": "12345",
"i18n": "{\"language\":\"en\", \"country\":\"US\"}",
"tags": "urgent, gift",
"processedTime": "2023-05-15T14:30:00-05:00",
"phone": "+1234567890",
"cancelledTime": "2023-05-15T10:30:00-05:00",
"financialStatus": "paid",
"totalWeight": "500",
"shippingAddress": {
"zip": "10001",
"country": "USA",
"lastName": "Smith",
"address2": "Apt 3B",
"city": "New York",
"address1": "456 Oak Street",
"provinceCode": "CA",
"latitude": "40.7128",
"firstName": "John",
"province": "California",
"phone": "+1234567890",
"countryCode": "US",
"name": "John Smith",
"company": "XYZ Corporation",
"longitude": "-74.0060"
},
"billingAddress": {
"zip": "T0E 0M0",
"country": "Canada",
"lastName": "Gorski",
"address2": "Apartment 5",
"city": "Drayton Valley",
"address1": "2259 Park Ct",
"provinceCode": "AB",
"latitude": "45.41634",
"firstName": "Christopher",
"province": "Alberta",
"phone": "(555)555-5555",
"countryCode": "CA",
"name": "Christopher Gorski",
"company": "ABC Company",
"longitude": "-75.6868"
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"customer": {
"updatedTime": "2023-05-12T16:45:20-05:00",
"lastName": "Smith",
"note": "VIP customer with multiple purchases",
"addresses": [
{
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"company": "Weimob",
"countryName": "China"
}
],
"taxExempt": "false",
"totalSpent": "542.75",
"taxExemptions": [
"VAT_EXEMPT"
],
"tags": "loyal,repeat-customer",
"firstName": "John",
"ordersCount": "100",
"phone": "+1234567890",
"createdTime": "2023-01-15T10:30:00-05:00",
"id": "12345",
"email": "customer@example.com",
"verifiedEmail": "true",
"defaultAddress": {
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"customerId": "123456",
"company": "Weimob",
"countryName": "China",
"id": "123456"
}
}
}
}EVENT Order create
Occurs whenever an order is created.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/create
Event Data
orderobject
The order is a customer's request to purchase one or more products from a shop.
- Hide child properties
billingAddressobject
The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.
+ Show child properties
cancelReasonstring
The reason why the order was canceled.
cancelledTimestring
The date and time when the order was canceled. Returns null if the order isn't canceled.
closedTimestring
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
createdTimestring
The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.
currencystring
The three-letter code (ISO 4217 format) for the shop currency.
customerobject
Information about the customer.
+ Show child properties
discountCodesarray
A list of discounts applied to the order.
+ Show child properties
emailstring
The customer's email address.
financialStatusstring
The status of payments associated with the order. Can only be set when the order is created.Enumeration: pending - to be paid; partiallyPaid - partial; paid - paid.
fulfillmentsarray
An array of fulfillments associated with the order.
+ Show child properties
fulfillmentStatusstring
The order's status in terms of fulfilled line items. Enumeration: null - not fulfilled; partial - partial fulfilled; fulfilled - fulfilled; canceled - fulfillment canceled.
lineItemsarray
A list of line item objects, each containing information about an item in the order.
+ Show child properties
notestring
An optional note that a shop owner can attach to the order.
idnumber
The order's position in the shop's count of orders.
paymentTermsarray
The terms and conditions under which a payment should be processed.
+ Show child properties
paymentGatewayNamesarray
The list of payment gateways used for the order.Including but not limited to: CASH_ON_DELIVERY - Pay on delivery; MANUAL_METHOD - Manual payment.
phonestring
The customer's phone number for receiving SMS notifications.
shippingAddressobject
The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.
+ Show child properties
sourceIdentifierstring
The ID of the order placed on the originating platform.
subtotalPricestring
The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.
tagsstring
Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.
totalDiscountsstring
The total discounts applied to the price of the order in the shop currency.
totalPricestring
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
totalTaxstring
The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.
totalWeightstring
The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.
updatedTimestring
The date and time (ISO 8601 format) when the order was last modified.
paidTimestring
The date and time (ISO 8601 format) when the order payment was completed.
paymentTypestring
Order payment type. Enumeration values: online - online payment; offline - offline payment; noPayment - no payment required; quick - quick payment.
convertRatenumber
Exchange rate from market currency to shop currency
totalDiscountsSetobject
Total discounts amount price set.
+ Show child properties
discountApplicationsarray
Discount applications list.
+ Show child properties
processedTimestring
Processing time.
refundsarray
Refunds list.
+ Show child properties
shippingLinesarray
Shipping lines list.
+ Show child properties
subtotalPriceSetobject
Subtotal price set.
+ Show child properties
taxLinesarray
Tax lines list.
+ Show child properties
totalPriceSetobject
Total price set.
+ Show child properties
totalTaxSetobject
Total tax set.
+ Show child properties
totalShippingPricestring
Shipping fee.
totalShippingPriceSetobject
Shipping fee amount set.
+ Show child properties
userIdnumber
User ID.
i18nstring
Internationalization information.
shopCurrencystring
Shop currency.
appstring
Application identifier.
typenumber
Order type.Enumeration:1 - ordinary order; 11 - external order.
json
{
"order": {
"note": "Please deliver after 6 PM",
"sourceIdentifier": "WEB123456",
"shopCurrency": "USD",
"totalPrice": "110.25",
"totalDiscounts": "10.25",
"paymentGatewayNames": [
"PayPal",
"Credit Card"
],
"type": "1",
"closedTime": "2023-05-20T14:45:30-05:00",
"fulfillmentStatus": "fulfilled",
"paymentType": "online",
"refunds": [
{
"totalRefundShippingPrice": "5.99",
"totalRefundPrice": "29.99",
"refundLineItems": [
{
"totalTax": "1.50",
"quantity": "1",
"lineItem": {
"quantity": "2",
"productId": "123456",
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "12",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "1",
"alreadyRightsNum": "1",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1"
},
"lineItemId": "789",
"subtotal": "19.99",
"rightsReason": "Description of Other Reasons",
"id": "201",
"rightsReasonType": "1"
}
],
"refundId": "12345",
"processedTime": "2023-05-20T10:00:00-05:00",
"status": "1"
}
],
"totalTaxSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"lineItems": [
{
"priceSet": {
"shopMoney": {
"amount": "29.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "29.99",
"currencyCode": "USD"
}
},
"variantTitle": "Red",
"quantity": "2",
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"code": "EXPRESS",
"discountedPrice": "7.99",
"price": "9.99",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"productId": "123456",
"discountAllocations": {
"amount": "2.50",
"discountApplicationIndex": "1",
"amountSet": {
"shopMoney": {
"amount": "2.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "2.50",
"currencyCode": "USD"
}
}
},
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "3",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "456",
"alreadyRightsNum": "1",
"giftCard": "false",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "987654",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1",
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
}
],
"totalTax": "8.50",
"fulfillments": [
{
"lineItems": [
{
"fulfillmentOrderId": "456",
"quantity": "2",
"productId": "1001",
"lineItemId": "789",
"id": "101",
"shopId": "123",
"variantId": "2002"
}
],
"updatedTime": "2023-05-15T14:20:00-05:00",
"orderId": "54321",
"fulfillTime": "2023-05-15T14:20:00-05:00",
"createdTime": "2023-05-15T10:30:00-05:00",
"fulfillId": "98765",
"status": "success"
}
],
"convertRate": "1.25",
"totalPriceSet": {
"shopMoney": {
"amount": "110.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "110.25",
"currencyCode": "USD"
}
},
"createdTime": "2023-05-10T09:15:00-05:00",
"currency": "USD",
"totalDiscountsSet": {
"shopMoney": {
"amount": "10.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "10.25",
"currencyCode": "USD"
}
},
"id": "54321",
"cancelReason": "customer",
"subtotalPrice": "85.50",
"email": "customer@example.com",
"paymentTerms": [
{
"amount": "100.00",
"paymentTermsName": "分期付款",
"paymentId": "1",
"channelTrxNo": "TRX123456",
"currency": "CNY"
}
],
"subtotalPriceSet": {
"shopMoney": {
"amount": "85.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "85.50",
"currencyCode": "USD"
}
},
"app": "shopify",
"updatedTime": "2023-05-15T16:30:00-05:00",
"discountCodes": [
{
"amount": "25.00",
"code": "SUMMER20",
"type": "1"
}
],
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountedPrice": "7.99",
"price": "9.99",
"id": "456",
"source": "shopify",
"title": "Express Shipping",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"totalShippingPriceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountApplications": [
{
"code": "SAVE20",
"targetType": "lineItem",
"id": "da_12345",
"title": "Summer Sale",
"value": "15"
}
],
"totalShippingPrice": "9.99",
"paidTime": "2023-05-15T10:30:00-05:00",
"userId": "12345",
"i18n": "{\"language\":\"en\", \"country\":\"US\"}",
"tags": "urgent, gift",
"processedTime": "2023-05-15T14:30:00-05:00",
"phone": "+1234567890",
"cancelledTime": "2023-05-15T10:30:00-05:00",
"financialStatus": "paid",
"totalWeight": "500",
"shippingAddress": {
"zip": "10001",
"country": "USA",
"lastName": "Smith",
"address2": "Apt 3B",
"city": "New York",
"address1": "456 Oak Street",
"provinceCode": "CA",
"latitude": "40.7128",
"firstName": "John",
"province": "California",
"phone": "+1234567890",
"countryCode": "US",
"name": "John Smith",
"company": "XYZ Corporation",
"longitude": "-74.0060"
},
"billingAddress": {
"zip": "T0E 0M0",
"country": "Canada",
"lastName": "Gorski",
"address2": "Apartment 5",
"city": "Drayton Valley",
"address1": "2259 Park Ct",
"provinceCode": "AB",
"latitude": "45.41634",
"firstName": "Christopher",
"province": "Alberta",
"phone": "(555)555-5555",
"countryCode": "CA",
"name": "Christopher Gorski",
"company": "ABC Company",
"longitude": "-75.6868"
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"customer": {
"updatedTime": "2023-05-12T16:45:20-05:00",
"lastName": "Smith",
"note": "VIP customer with multiple purchases",
"addresses": [
{
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"company": "Weimob",
"countryName": "China"
}
],
"taxExempt": "false",
"totalSpent": "542.75",
"taxExemptions": [
"VAT_EXEMPT"
],
"tags": "loyal,repeat-customer",
"firstName": "John",
"ordersCount": "100",
"phone": "+1234567890",
"createdTime": "2023-01-15T10:30:00-05:00",
"id": "12345",
"email": "customer@example.com",
"verifiedEmail": "true",
"defaultAddress": {
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"customerId": "123456",
"company": "Weimob",
"countryName": "China",
"id": "123456"
}
}
}
}EVENT Order paid
Occurs whenever an order is paid.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/paid
Event Data
orderobject
The order is a customer's request to purchase one or more products from a shop.
- Hide child properties
billingAddressobject
The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.
+ Show child properties
cancelReasonstring
The reason why the order was canceled.
cancelledTimestring
The date and time when the order was canceled. Returns null if the order isn't canceled.
closedTimestring
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
createdTimestring
The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.
currencystring
The three-letter code (ISO 4217 format) for the shop currency.
customerobject
Information about the customer.
+ Show child properties
discountCodesarray
A list of discounts applied to the order.
+ Show child properties
emailstring
The customer's email address.
financialStatusstring
The status of payments associated with the order. Can only be set when the order is created.Enumeration: pending - to be paid; partiallyPaid - partial; paid - paid.
fulfillmentsarray
An array of fulfillments associated with the order.
+ Show child properties
fulfillmentStatusstring
The order's status in terms of fulfilled line items. Enumeration: null - not fulfilled; partial - partial fulfilled; fulfilled - fulfilled; canceled - fulfillment canceled.
lineItemsarray
A list of line item objects, each containing information about an item in the order.
+ Show child properties
notestring
An optional note that a shop owner can attach to the order.
idnumber
The order's position in the shop's count of orders.
paymentTermsarray
The terms and conditions under which a payment should be processed.
+ Show child properties
paymentGatewayNamesarray
The list of payment gateways used for the order.Including but not limited to: CASH_ON_DELIVERY - Pay on delivery; MANUAL_METHOD - Manual payment.
phonestring
The customer's phone number for receiving SMS notifications.
shippingAddressobject
The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.
+ Show child properties
sourceIdentifierstring
The ID of the order placed on the originating platform.
subtotalPricestring
The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.
tagsstring
Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.
totalDiscountsstring
The total discounts applied to the price of the order in the shop currency.
totalPricestring
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
totalTaxstring
The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.
totalWeightstring
The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.
updatedTimestring
The date and time (ISO 8601 format) when the order was last modified.
paidTimestring
The date and time (ISO 8601 format) when the order payment was completed.
paymentTypestring
Order payment type. Enumeration values: online - online payment; offline - offline payment; noPayment - no payment required; quick - quick payment.
convertRatenumber
Exchange rate from market currency to shop currency
totalDiscountsSetobject
Total discounts amount price set.
+ Show child properties
discountApplicationsarray
Discount applications list.
+ Show child properties
processedTimestring
Processing time.
refundsarray
Refunds list.
+ Show child properties
shippingLinesarray
Shipping lines list.
+ Show child properties
subtotalPriceSetobject
Subtotal price set.
+ Show child properties
taxLinesarray
Tax lines list.
+ Show child properties
totalPriceSetobject
Total price set.
+ Show child properties
totalTaxSetobject
Total tax set.
+ Show child properties
totalShippingPricestring
Shipping fee.
totalShippingPriceSetobject
Shipping fee amount set.
+ Show child properties
userIdnumber
User ID.
i18nstring
Internationalization information.
shopCurrencystring
Shop currency.
appstring
Application identifier.
typenumber
Order type.Enumeration:1 - ordinary order; 11 - external order.
json
{
"order": {
"note": "Please deliver after 6 PM",
"sourceIdentifier": "WEB123456",
"shopCurrency": "USD",
"totalPrice": "110.25",
"totalDiscounts": "10.25",
"paymentGatewayNames": [
"PayPal",
"Credit Card"
],
"type": "1",
"closedTime": "2023-05-20T14:45:30-05:00",
"fulfillmentStatus": "fulfilled",
"paymentType": "online",
"refunds": [
{
"totalRefundShippingPrice": "5.99",
"totalRefundPrice": "29.99",
"refundLineItems": [
{
"totalTax": "1.50",
"quantity": "1",
"lineItem": {
"quantity": "2",
"productId": "123456",
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "12",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "1",
"alreadyRightsNum": "1",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1"
},
"lineItemId": "789",
"subtotal": "19.99",
"rightsReason": "Description of Other Reasons",
"id": "201",
"rightsReasonType": "1"
}
],
"refundId": "12345",
"processedTime": "2023-05-20T10:00:00-05:00",
"status": "1"
}
],
"totalTaxSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"lineItems": [
{
"priceSet": {
"shopMoney": {
"amount": "29.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "29.99",
"currencyCode": "USD"
}
},
"variantTitle": "Red",
"quantity": "2",
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"code": "EXPRESS",
"discountedPrice": "7.99",
"price": "9.99",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"productId": "123456",
"discountAllocations": {
"amount": "2.50",
"discountApplicationIndex": "1",
"amountSet": {
"shopMoney": {
"amount": "2.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "2.50",
"currencyCode": "USD"
}
}
},
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "3",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "456",
"alreadyRightsNum": "1",
"giftCard": "false",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "987654",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1",
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
}
],
"totalTax": "8.50",
"fulfillments": [
{
"lineItems": [
{
"fulfillmentOrderId": "456",
"quantity": "2",
"productId": "1001",
"lineItemId": "789",
"id": "101",
"shopId": "123",
"variantId": "2002"
}
],
"updatedTime": "2023-05-15T14:20:00-05:00",
"orderId": "54321",
"fulfillTime": "2023-05-15T14:20:00-05:00",
"createdTime": "2023-05-15T10:30:00-05:00",
"fulfillId": "98765",
"status": "success"
}
],
"convertRate": "1.25",
"totalPriceSet": {
"shopMoney": {
"amount": "110.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "110.25",
"currencyCode": "USD"
}
},
"createdTime": "2023-05-10T09:15:00-05:00",
"currency": "USD",
"totalDiscountsSet": {
"shopMoney": {
"amount": "10.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "10.25",
"currencyCode": "USD"
}
},
"id": "54321",
"cancelReason": "customer",
"subtotalPrice": "85.50",
"email": "customer@example.com",
"paymentTerms": [
{
"amount": "100.00",
"paymentTermsName": "分期付款",
"paymentId": "1",
"channelTrxNo": "TRX123456",
"currency": "CNY"
}
],
"subtotalPriceSet": {
"shopMoney": {
"amount": "85.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "85.50",
"currencyCode": "USD"
}
},
"app": "shopify",
"updatedTime": "2023-05-15T16:30:00-05:00",
"discountCodes": [
{
"amount": "25.00",
"code": "SUMMER20",
"type": "1"
}
],
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountedPrice": "7.99",
"price": "9.99",
"id": "456",
"source": "shopify",
"title": "Express Shipping",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"totalShippingPriceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountApplications": [
{
"code": "SAVE20",
"targetType": "lineItem",
"id": "da_12345",
"title": "Summer Sale",
"value": "15"
}
],
"totalShippingPrice": "9.99",
"paidTime": "2023-05-15T10:30:00-05:00",
"userId": "12345",
"i18n": "{\"language\":\"en\", \"country\":\"US\"}",
"tags": "urgent, gift",
"processedTime": "2023-05-15T14:30:00-05:00",
"phone": "+1234567890",
"cancelledTime": "2023-05-15T10:30:00-05:00",
"financialStatus": "paid",
"totalWeight": "500",
"shippingAddress": {
"zip": "10001",
"country": "USA",
"lastName": "Smith",
"address2": "Apt 3B",
"city": "New York",
"address1": "456 Oak Street",
"provinceCode": "CA",
"latitude": "40.7128",
"firstName": "John",
"province": "California",
"phone": "+1234567890",
"countryCode": "US",
"name": "John Smith",
"company": "XYZ Corporation",
"longitude": "-74.0060"
},
"billingAddress": {
"zip": "T0E 0M0",
"country": "Canada",
"lastName": "Gorski",
"address2": "Apartment 5",
"city": "Drayton Valley",
"address1": "2259 Park Ct",
"provinceCode": "AB",
"latitude": "45.41634",
"firstName": "Christopher",
"province": "Alberta",
"phone": "(555)555-5555",
"countryCode": "CA",
"name": "Christopher Gorski",
"company": "ABC Company",
"longitude": "-75.6868"
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"customer": {
"updatedTime": "2023-05-12T16:45:20-05:00",
"lastName": "Smith",
"note": "VIP customer with multiple purchases",
"addresses": [
{
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"company": "Weimob",
"countryName": "China"
}
],
"taxExempt": "false",
"totalSpent": "542.75",
"taxExemptions": [
"VAT_EXEMPT"
],
"tags": "loyal,repeat-customer",
"firstName": "John",
"ordersCount": "100",
"phone": "+1234567890",
"createdTime": "2023-01-15T10:30:00-05:00",
"id": "12345",
"email": "customer@example.com",
"verifiedEmail": "true",
"defaultAddress": {
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"customerId": "123456",
"company": "Weimob",
"countryName": "China",
"id": "123456"
}
}
}
}EVENT Order fulfilled
Occurs whenever an order is fulfilled.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/fulfilled
Event Data
orderobject
The order is a customer's request to purchase one or more products from a shop.
- Hide child properties
billingAddressobject
The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.
+ Show child properties
cancelReasonstring
The reason why the order was canceled.
cancelledTimestring
The date and time when the order was canceled. Returns null if the order isn't canceled.
closedTimestring
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
createdTimestring
The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.
currencystring
The three-letter code (ISO 4217 format) for the shop currency.
customerobject
Information about the customer.
+ Show child properties
discountCodesarray
A list of discounts applied to the order.
+ Show child properties
emailstring
The customer's email address.
financialStatusstring
The status of payments associated with the order. Can only be set when the order is created.Enumeration: pending - to be paid; partiallyPaid - partial; paid - paid.
fulfillmentsarray
An array of fulfillments associated with the order.
+ Show child properties
fulfillmentStatusstring
The order's status in terms of fulfilled line items. Enumeration: null - not fulfilled; partial - partial fulfilled; fulfilled - fulfilled; canceled - fulfillment canceled.
lineItemsarray
A list of line item objects, each containing information about an item in the order.
+ Show child properties
notestring
An optional note that a shop owner can attach to the order.
idnumber
The order's position in the shop's count of orders.
paymentTermsarray
The terms and conditions under which a payment should be processed.
+ Show child properties
paymentGatewayNamesarray
The list of payment gateways used for the order.Including but not limited to: CASH_ON_DELIVERY - Pay on delivery; MANUAL_METHOD - Manual payment.
phonestring
The customer's phone number for receiving SMS notifications.
shippingAddressobject
The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.
+ Show child properties
sourceIdentifierstring
The ID of the order placed on the originating platform.
subtotalPricestring
The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.
tagsstring
Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.
totalDiscountsstring
The total discounts applied to the price of the order in the shop currency.
totalPricestring
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
totalTaxstring
The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.
totalWeightstring
The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.
updatedTimestring
The date and time (ISO 8601 format) when the order was last modified.
paidTimestring
The date and time (ISO 8601 format) when the order payment was completed.
paymentTypestring
Order payment type. Enumeration values: online - online payment; offline - offline payment; noPayment - no payment required; quick - quick payment.
convertRatenumber
Exchange rate from market currency to shop currency
totalDiscountsSetobject
Total discounts amount price set.
+ Show child properties
discountApplicationsarray
Discount applications list.
+ Show child properties
processedTimestring
Processing time.
refundsarray
Refunds list.
+ Show child properties
shippingLinesarray
Shipping lines list.
+ Show child properties
subtotalPriceSetobject
Subtotal price set.
+ Show child properties
taxLinesarray
Tax lines list.
+ Show child properties
totalPriceSetobject
Total price set.
+ Show child properties
totalTaxSetobject
Total tax set.
+ Show child properties
totalShippingPricestring
Shipping fee.
totalShippingPriceSetobject
Shipping fee amount set.
+ Show child properties
userIdnumber
User ID.
i18nstring
Internationalization information.
shopCurrencystring
Shop currency.
appstring
Application identifier.
typenumber
Order type.Enumeration:1 - ordinary order; 11 - external order.
json
{
"order": {
"note": "Please deliver after 6 PM",
"sourceIdentifier": "WEB123456",
"shopCurrency": "USD",
"totalPrice": "110.25",
"totalDiscounts": "10.25",
"paymentGatewayNames": [
"PayPal",
"Credit Card"
],
"type": "1",
"closedTime": "2023-05-20T14:45:30-05:00",
"fulfillmentStatus": "fulfilled",
"paymentType": "online",
"refunds": [
{
"totalRefundShippingPrice": "5.99",
"totalRefundPrice": "29.99",
"refundLineItems": [
{
"totalTax": "1.50",
"quantity": "1",
"lineItem": {
"quantity": "2",
"productId": "123456",
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "12",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "1",
"alreadyRightsNum": "1",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1"
},
"lineItemId": "789",
"subtotal": "19.99",
"rightsReason": "Description of Other Reasons",
"id": "201",
"rightsReasonType": "1"
}
],
"refundId": "12345",
"processedTime": "2023-05-20T10:00:00-05:00",
"status": "1"
}
],
"totalTaxSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"lineItems": [
{
"priceSet": {
"shopMoney": {
"amount": "29.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "29.99",
"currencyCode": "USD"
}
},
"variantTitle": "Red",
"quantity": "2",
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"code": "EXPRESS",
"discountedPrice": "7.99",
"price": "9.99",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"productId": "123456",
"discountAllocations": {
"amount": "2.50",
"discountApplicationIndex": "1",
"amountSet": {
"shopMoney": {
"amount": "2.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "2.50",
"currencyCode": "USD"
}
}
},
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "3",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "456",
"alreadyRightsNum": "1",
"giftCard": "false",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "987654",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1",
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
}
],
"totalTax": "8.50",
"fulfillments": [
{
"lineItems": [
{
"fulfillmentOrderId": "456",
"quantity": "2",
"productId": "1001",
"lineItemId": "789",
"id": "101",
"shopId": "123",
"variantId": "2002"
}
],
"updatedTime": "2023-05-15T14:20:00-05:00",
"orderId": "54321",
"fulfillTime": "2023-05-15T14:20:00-05:00",
"createdTime": "2023-05-15T10:30:00-05:00",
"fulfillId": "98765",
"status": "success"
}
],
"convertRate": "1.25",
"totalPriceSet": {
"shopMoney": {
"amount": "110.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "110.25",
"currencyCode": "USD"
}
},
"createdTime": "2023-05-10T09:15:00-05:00",
"currency": "USD",
"totalDiscountsSet": {
"shopMoney": {
"amount": "10.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "10.25",
"currencyCode": "USD"
}
},
"id": "54321",
"cancelReason": "customer",
"subtotalPrice": "85.50",
"email": "customer@example.com",
"paymentTerms": [
{
"amount": "100.00",
"paymentTermsName": "分期付款",
"paymentId": "1",
"channelTrxNo": "TRX123456",
"currency": "CNY"
}
],
"subtotalPriceSet": {
"shopMoney": {
"amount": "85.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "85.50",
"currencyCode": "USD"
}
},
"app": "shopify",
"updatedTime": "2023-05-15T16:30:00-05:00",
"discountCodes": [
{
"amount": "25.00",
"code": "SUMMER20",
"type": "1"
}
],
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountedPrice": "7.99",
"price": "9.99",
"id": "456",
"source": "shopify",
"title": "Express Shipping",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"totalShippingPriceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountApplications": [
{
"code": "SAVE20",
"targetType": "lineItem",
"id": "da_12345",
"title": "Summer Sale",
"value": "15"
}
],
"totalShippingPrice": "9.99",
"paidTime": "2023-05-15T10:30:00-05:00",
"userId": "12345",
"i18n": "{\"language\":\"en\", \"country\":\"US\"}",
"tags": "urgent, gift",
"processedTime": "2023-05-15T14:30:00-05:00",
"phone": "+1234567890",
"cancelledTime": "2023-05-15T10:30:00-05:00",
"financialStatus": "paid",
"totalWeight": "500",
"shippingAddress": {
"zip": "10001",
"country": "USA",
"lastName": "Smith",
"address2": "Apt 3B",
"city": "New York",
"address1": "456 Oak Street",
"provinceCode": "CA",
"latitude": "40.7128",
"firstName": "John",
"province": "California",
"phone": "+1234567890",
"countryCode": "US",
"name": "John Smith",
"company": "XYZ Corporation",
"longitude": "-74.0060"
},
"billingAddress": {
"zip": "T0E 0M0",
"country": "Canada",
"lastName": "Gorski",
"address2": "Apartment 5",
"city": "Drayton Valley",
"address1": "2259 Park Ct",
"provinceCode": "AB",
"latitude": "45.41634",
"firstName": "Christopher",
"province": "Alberta",
"phone": "(555)555-5555",
"countryCode": "CA",
"name": "Christopher Gorski",
"company": "ABC Company",
"longitude": "-75.6868"
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"customer": {
"updatedTime": "2023-05-12T16:45:20-05:00",
"lastName": "Smith",
"note": "VIP customer with multiple purchases",
"addresses": [
{
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"company": "Weimob",
"countryName": "China"
}
],
"taxExempt": "false",
"totalSpent": "542.75",
"taxExemptions": [
"VAT_EXEMPT"
],
"tags": "loyal,repeat-customer",
"firstName": "John",
"ordersCount": "100",
"phone": "+1234567890",
"createdTime": "2023-01-15T10:30:00-05:00",
"id": "12345",
"email": "customer@example.com",
"verifiedEmail": "true",
"defaultAddress": {
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"customerId": "123456",
"company": "Weimob",
"countryName": "China",
"id": "123456"
}
}
}
}EVENT Order cancelled
This webhook is triggered whenever an order is cancelled, allowing you to receive real-time updates and take appropriate actions or track cancellations.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/cancelled
Event Data
orderobject
The order is a customer's request to purchase one or more products from a shop.
- Hide child properties
billingAddressobject
The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.
+ Show child properties
cancelReasonstring
The reason why the order was canceled.
cancelledTimestring
The date and time when the order was canceled. Returns null if the order isn't canceled.
closedTimestring
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
createdTimestring
The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.
currencystring
The three-letter code (ISO 4217 format) for the shop currency.
customerobject
Information about the customer.
+ Show child properties
discountCodesarray
A list of discounts applied to the order.
+ Show child properties
emailstring
The customer's email address.
financialStatusstring
The status of payments associated with the order. Can only be set when the order is created.Enumeration: pending - to be paid; partiallyPaid - partial; paid - paid.
fulfillmentsarray
An array of fulfillments associated with the order.
+ Show child properties
fulfillmentStatusstring
The order's status in terms of fulfilled line items. Enumeration: null - not fulfilled; partial - partial fulfilled; fulfilled - fulfilled; canceled - fulfillment canceled.
lineItemsarray
A list of line item objects, each containing information about an item in the order.
+ Show child properties
notestring
An optional note that a shop owner can attach to the order.
idnumber
The order's position in the shop's count of orders.
paymentTermsarray
The terms and conditions under which a payment should be processed.
+ Show child properties
paymentGatewayNamesarray
The list of payment gateways used for the order.Including but not limited to: CASH_ON_DELIVERY - Pay on delivery; MANUAL_METHOD - Manual payment.
phonestring
The customer's phone number for receiving SMS notifications.
shippingAddressobject
The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.
+ Show child properties
sourceIdentifierstring
The ID of the order placed on the originating platform.
subtotalPricestring
The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.
tagsstring
Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.
totalDiscountsstring
The total discounts applied to the price of the order in the shop currency.
totalPricestring
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
totalTaxstring
The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.
totalWeightstring
The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.
updatedTimestring
The date and time (ISO 8601 format) when the order was last modified.
paidTimestring
The date and time (ISO 8601 format) when the order payment was completed.
paymentTypestring
Order payment type. Enumeration values: online - online payment; offline - offline payment; noPayment - no payment required; quick - quick payment.
convertRatenumber
Exchange rate from market currency to shop currency
totalDiscountsSetobject
Total discounts amount price set.
+ Show child properties
discountApplicationsarray
Discount applications list.
+ Show child properties
processedTimestring
Processing time.
refundsarray
Refunds list.
+ Show child properties
shippingLinesarray
Shipping lines list.
+ Show child properties
subtotalPriceSetobject
Subtotal price set.
+ Show child properties
taxLinesarray
Tax lines list.
+ Show child properties
totalPriceSetobject
Total price set.
+ Show child properties
totalTaxSetobject
Total tax set.
+ Show child properties
totalShippingPricestring
Shipping fee.
totalShippingPriceSetobject
Shipping fee amount set.
+ Show child properties
userIdnumber
User ID.
i18nstring
Internationalization information.
shopCurrencystring
Shop currency.
appstring
Application identifier.
typenumber
Order type.Enumeration:1 - ordinary order; 11 - external order.
json
{
"order": {
"note": "Please deliver after 6 PM",
"sourceIdentifier": "WEB123456",
"shopCurrency": "USD",
"totalPrice": "110.25",
"totalDiscounts": "10.25",
"paymentGatewayNames": [
"PayPal",
"Credit Card"
],
"type": "1",
"closedTime": "2023-05-20T14:45:30-05:00",
"fulfillmentStatus": "fulfilled",
"paymentType": "online",
"refunds": [
{
"totalRefundShippingPrice": "5.99",
"totalRefundPrice": "29.99",
"refundLineItems": [
{
"totalTax": "1.50",
"quantity": "1",
"lineItem": {
"quantity": "2",
"productId": "123456",
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "12",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "1",
"alreadyRightsNum": "1",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1"
},
"lineItemId": "789",
"subtotal": "19.99",
"rightsReason": "Description of Other Reasons",
"id": "201",
"rightsReasonType": "1"
}
],
"refundId": "12345",
"processedTime": "2023-05-20T10:00:00-05:00",
"status": "1"
}
],
"totalTaxSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"lineItems": [
{
"priceSet": {
"shopMoney": {
"amount": "29.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "29.99",
"currencyCode": "USD"
}
},
"variantTitle": "Red",
"quantity": "2",
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"code": "EXPRESS",
"discountedPrice": "7.99",
"price": "9.99",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"productId": "123456",
"discountAllocations": {
"amount": "2.50",
"discountApplicationIndex": "1",
"amountSet": {
"shopMoney": {
"amount": "2.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "2.50",
"currencyCode": "USD"
}
}
},
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "3",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "456",
"alreadyRightsNum": "1",
"giftCard": "false",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "987654",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1",
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
}
],
"totalTax": "8.50",
"fulfillments": [
{
"lineItems": [
{
"fulfillmentOrderId": "456",
"quantity": "2",
"productId": "1001",
"lineItemId": "789",
"id": "101",
"shopId": "123",
"variantId": "2002"
}
],
"updatedTime": "2023-05-15T14:20:00-05:00",
"orderId": "54321",
"fulfillTime": "2023-05-15T14:20:00-05:00",
"createdTime": "2023-05-15T10:30:00-05:00",
"fulfillId": "98765",
"status": "success"
}
],
"convertRate": "1.25",
"totalPriceSet": {
"shopMoney": {
"amount": "110.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "110.25",
"currencyCode": "USD"
}
},
"createdTime": "2023-05-10T09:15:00-05:00",
"currency": "USD",
"totalDiscountsSet": {
"shopMoney": {
"amount": "10.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "10.25",
"currencyCode": "USD"
}
},
"id": "54321",
"cancelReason": "customer",
"subtotalPrice": "85.50",
"email": "customer@example.com",
"paymentTerms": [
{
"amount": "100.00",
"paymentTermsName": "分期付款",
"paymentId": "1",
"channelTrxNo": "TRX123456",
"currency": "CNY"
}
],
"subtotalPriceSet": {
"shopMoney": {
"amount": "85.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "85.50",
"currencyCode": "USD"
}
},
"app": "shopify",
"updatedTime": "2023-05-15T16:30:00-05:00",
"discountCodes": [
{
"amount": "25.00",
"code": "SUMMER20",
"type": "1"
}
],
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountedPrice": "7.99",
"price": "9.99",
"id": "456",
"source": "shopify",
"title": "Express Shipping",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"totalShippingPriceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountApplications": [
{
"code": "SAVE20",
"targetType": "lineItem",
"id": "da_12345",
"title": "Summer Sale",
"value": "15"
}
],
"totalShippingPrice": "9.99",
"paidTime": "2023-05-15T10:30:00-05:00",
"userId": "12345",
"i18n": "{\"language\":\"en\", \"country\":\"US\"}",
"tags": "urgent, gift",
"processedTime": "2023-05-15T14:30:00-05:00",
"phone": "+1234567890",
"cancelledTime": "2023-05-15T10:30:00-05:00",
"financialStatus": "paid",
"totalWeight": "500",
"shippingAddress": {
"zip": "10001",
"country": "USA",
"lastName": "Smith",
"address2": "Apt 3B",
"city": "New York",
"address1": "456 Oak Street",
"provinceCode": "CA",
"latitude": "40.7128",
"firstName": "John",
"province": "California",
"phone": "+1234567890",
"countryCode": "US",
"name": "John Smith",
"company": "XYZ Corporation",
"longitude": "-74.0060"
},
"billingAddress": {
"zip": "T0E 0M0",
"country": "Canada",
"lastName": "Gorski",
"address2": "Apartment 5",
"city": "Drayton Valley",
"address1": "2259 Park Ct",
"provinceCode": "AB",
"latitude": "45.41634",
"firstName": "Christopher",
"province": "Alberta",
"phone": "(555)555-5555",
"countryCode": "CA",
"name": "Christopher Gorski",
"company": "ABC Company",
"longitude": "-75.6868"
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"customer": {
"updatedTime": "2023-05-12T16:45:20-05:00",
"lastName": "Smith",
"note": "VIP customer with multiple purchases",
"addresses": [
{
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"company": "Weimob",
"countryName": "China"
}
],
"taxExempt": "false",
"totalSpent": "542.75",
"taxExemptions": [
"VAT_EXEMPT"
],
"tags": "loyal,repeat-customer",
"firstName": "John",
"ordersCount": "100",
"phone": "+1234567890",
"createdTime": "2023-01-15T10:30:00-05:00",
"id": "12345",
"email": "customer@example.com",
"verifiedEmail": "true",
"defaultAddress": {
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"customerId": "123456",
"company": "Weimob",
"countryName": "China",
"id": "123456"
}
}
}
}EVENT Order partially fulfilled
An event is triggered when an order is partially fulfilled.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/partiallyFulfilled
Event Data
orderobject
The order is a customer's request to purchase one or more products from a shop.
- Hide child properties
billingAddressobject
The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.
+ Show child properties
cancelReasonstring
The reason why the order was canceled.
cancelledTimestring
The date and time when the order was canceled. Returns null if the order isn't canceled.
closedTimestring
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
createdTimestring
The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.
currencystring
The three-letter code (ISO 4217 format) for the shop currency.
customerobject
Information about the customer.
+ Show child properties
discountCodesarray
A list of discounts applied to the order.
+ Show child properties
emailstring
The customer's email address.
financialStatusstring
The status of payments associated with the order. Can only be set when the order is created.Enumeration: pending - to be paid; partiallyPaid - partial; paid - paid.
fulfillmentsarray
An array of fulfillments associated with the order.
+ Show child properties
fulfillmentStatusstring
The order's status in terms of fulfilled line items. Enumeration: null - not fulfilled; partial - partial fulfilled; fulfilled - fulfilled; canceled - fulfillment canceled.
lineItemsarray
A list of line item objects, each containing information about an item in the order.
+ Show child properties
notestring
An optional note that a shop owner can attach to the order.
idnumber
The order's position in the shop's count of orders.
paymentTermsarray
The terms and conditions under which a payment should be processed.
+ Show child properties
paymentGatewayNamesarray
The list of payment gateways used for the order.Including but not limited to: CASH_ON_DELIVERY - Pay on delivery; MANUAL_METHOD - Manual payment.
phonestring
The customer's phone number for receiving SMS notifications.
shippingAddressobject
The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.
+ Show child properties
sourceIdentifierstring
The ID of the order placed on the originating platform.
subtotalPricestring
The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.
tagsstring
Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.
totalDiscountsstring
The total discounts applied to the price of the order in the shop currency.
totalPricestring
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
totalTaxstring
The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.
totalWeightstring
The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.
updatedTimestring
The date and time (ISO 8601 format) when the order was last modified.
paidTimestring
The date and time (ISO 8601 format) when the order payment was completed.
paymentTypestring
Order payment type. Enumeration values: online - online payment; offline - offline payment; noPayment - no payment required; quick - quick payment.
convertRatenumber
Exchange rate from market currency to shop currency
totalDiscountsSetobject
Total discounts amount price set.
+ Show child properties
discountApplicationsarray
Discount applications list.
+ Show child properties
processedTimestring
Processing time.
refundsarray
Refunds list.
+ Show child properties
shippingLinesarray
Shipping lines list.
+ Show child properties
subtotalPriceSetobject
Subtotal price set.
+ Show child properties
taxLinesarray
Tax lines list.
+ Show child properties
totalPriceSetobject
Total price set.
+ Show child properties
totalTaxSetobject
Total tax set.
+ Show child properties
totalShippingPricestring
Shipping fee.
totalShippingPriceSetobject
Shipping fee amount set.
+ Show child properties
userIdnumber
User ID.
i18nstring
Internationalization information.
shopCurrencystring
Shop currency.
appstring
Application identifier.
typenumber
Order type.Enumeration:1 - ordinary order; 11 - external order.
json
{
"order": {
"note": "Please deliver after 6 PM",
"sourceIdentifier": "WEB123456",
"shopCurrency": "USD",
"totalPrice": "110.25",
"totalDiscounts": "10.25",
"paymentGatewayNames": [
"PayPal",
"Credit Card"
],
"type": "1",
"closedTime": "2023-05-20T14:45:30-05:00",
"fulfillmentStatus": "fulfilled",
"paymentType": "online",
"refunds": [
{
"totalRefundShippingPrice": "5.99",
"totalRefundPrice": "29.99",
"refundLineItems": [
{
"totalTax": "1.50",
"quantity": "1",
"lineItem": {
"quantity": "2",
"productId": "123456",
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "12",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "1",
"alreadyRightsNum": "1",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1"
},
"lineItemId": "789",
"subtotal": "19.99",
"rightsReason": "Description of Other Reasons",
"id": "201",
"rightsReasonType": "1"
}
],
"refundId": "12345",
"processedTime": "2023-05-20T10:00:00-05:00",
"status": "1"
}
],
"totalTaxSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"lineItems": [
{
"priceSet": {
"shopMoney": {
"amount": "29.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "29.99",
"currencyCode": "USD"
}
},
"variantTitle": "Red",
"quantity": "2",
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"code": "EXPRESS",
"discountedPrice": "7.99",
"price": "9.99",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"productId": "123456",
"discountAllocations": {
"amount": "2.50",
"discountApplicationIndex": "1",
"amountSet": {
"shopMoney": {
"amount": "2.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "2.50",
"currencyCode": "USD"
}
}
},
"refundableQuantity": "1",
"title": "Wireless Headphones",
"fulfillableQuantity": "3",
"fulfillmentStatus": "fulfilled",
"requiresShipping": "true",
"price": "29.99",
"locationId": "456",
"alreadyRightsNum": "1",
"giftCard": "false",
"alreadyFulfillNum": "2",
"totalDiscount": "3.50",
"id": "987654",
"variantId": "789012",
"grams": "250",
"sku": "ABC123-X",
"currentQuantity": "1",
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
}
],
"totalTax": "8.50",
"fulfillments": [
{
"lineItems": [
{
"fulfillmentOrderId": "456",
"quantity": "2",
"productId": "1001",
"lineItemId": "789",
"id": "101",
"shopId": "123",
"variantId": "2002"
}
],
"updatedTime": "2023-05-15T14:20:00-05:00",
"orderId": "54321",
"fulfillTime": "2023-05-15T14:20:00-05:00",
"createdTime": "2023-05-15T10:30:00-05:00",
"fulfillId": "98765",
"status": "success"
}
],
"convertRate": "1.25",
"totalPriceSet": {
"shopMoney": {
"amount": "110.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "110.25",
"currencyCode": "USD"
}
},
"createdTime": "2023-05-10T09:15:00-05:00",
"currency": "USD",
"totalDiscountsSet": {
"shopMoney": {
"amount": "10.25",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "10.25",
"currencyCode": "USD"
}
},
"id": "54321",
"cancelReason": "customer",
"subtotalPrice": "85.50",
"email": "customer@example.com",
"paymentTerms": [
{
"amount": "100.00",
"paymentTermsName": "分期付款",
"paymentId": "1",
"channelTrxNo": "TRX123456",
"currency": "CNY"
}
],
"subtotalPriceSet": {
"shopMoney": {
"amount": "85.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "85.50",
"currencyCode": "USD"
}
},
"app": "shopify",
"updatedTime": "2023-05-15T16:30:00-05:00",
"discountCodes": [
{
"amount": "25.00",
"code": "SUMMER20",
"type": "1"
}
],
"shippingLines": [
{
"priceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountedPrice": "7.99",
"price": "9.99",
"id": "456",
"source": "shopify",
"title": "Express Shipping",
"discountedPriceSet": {
"shopMoney": {
"amount": "7.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "7.99",
"currencyCode": "USD"
}
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
]
}
],
"totalShippingPriceSet": {
"shopMoney": {
"amount": "9.99",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "9.99",
"currencyCode": "USD"
}
},
"discountApplications": [
{
"code": "SAVE20",
"targetType": "lineItem",
"id": "da_12345",
"title": "Summer Sale",
"value": "15"
}
],
"totalShippingPrice": "9.99",
"paidTime": "2023-05-15T10:30:00-05:00",
"userId": "12345",
"i18n": "{\"language\":\"en\", \"country\":\"US\"}",
"tags": "urgent, gift",
"processedTime": "2023-05-15T14:30:00-05:00",
"phone": "+1234567890",
"cancelledTime": "2023-05-15T10:30:00-05:00",
"financialStatus": "paid",
"totalWeight": "500",
"shippingAddress": {
"zip": "10001",
"country": "USA",
"lastName": "Smith",
"address2": "Apt 3B",
"city": "New York",
"address1": "456 Oak Street",
"provinceCode": "CA",
"latitude": "40.7128",
"firstName": "John",
"province": "California",
"phone": "+1234567890",
"countryCode": "US",
"name": "John Smith",
"company": "XYZ Corporation",
"longitude": "-74.0060"
},
"billingAddress": {
"zip": "T0E 0M0",
"country": "Canada",
"lastName": "Gorski",
"address2": "Apartment 5",
"city": "Drayton Valley",
"address1": "2259 Park Ct",
"provinceCode": "AB",
"latitude": "45.41634",
"firstName": "Christopher",
"province": "Alberta",
"phone": "(555)555-5555",
"countryCode": "CA",
"name": "Christopher Gorski",
"company": "ABC Company",
"longitude": "-75.6868"
},
"taxLines": [
{
"priceSet": {
"shopMoney": {
"amount": "8.50",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "8.50",
"currencyCode": "USD"
}
},
"rate": "10",
"price": "8.50",
"title": "VAT"
}
],
"customer": {
"updatedTime": "2023-05-12T16:45:20-05:00",
"lastName": "Smith",
"note": "VIP customer with multiple purchases",
"addresses": [
{
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"company": "Weimob",
"countryName": "China"
}
],
"taxExempt": "false",
"totalSpent": "542.75",
"taxExemptions": [
"VAT_EXEMPT"
],
"tags": "loyal,repeat-customer",
"firstName": "John",
"ordersCount": "100",
"phone": "+1234567890",
"createdTime": "2023-01-15T10:30:00-05:00",
"id": "12345",
"email": "customer@example.com",
"verifiedEmail": "true",
"defaultAddress": {
"zip": "200000",
"country": "China",
"lastName": "Doe",
"address2": "Block A",
"city": "Shanghai",
"address1": "No.1 Road",
"provinceCode": "SH",
"firstName": "John",
"isDefault": "true",
"province": "Shanghai",
"phone": "13800138000",
"countryCode": "CN",
"customerId": "123456",
"company": "Weimob",
"countryName": "China",
"id": "123456"
}
}
}
}About Order
Access scope
Multiple access scopes needed — refer to each endpoint for access scope requirements.
Order Management is a core component of the Genstore trading system, enabling end-to-end order lifecycle management. Through standardized order processing workflows, it provides merchants with efficient and reliable order management capabilities, ensuring transaction security and business continuity.
Core Features
- Basic Order Operations: Create order, modify order, cancel order, delete order.
- Order Status Management: Confirm order, close order, reopen order.
- Order Information Query: Get order details, list orders, count orders.
Use Cases
- Omnichannel Order Operations: Merchants can centrally manage orders from different channels, achieving unified order processing and status synchronization to improve operational efficiency.
- Order Fulfillment Management: Operations teams can monitor order status in real-time, assign processing tasks, and track exceptional orders to ensure timely delivery and customer satisfaction.
- Transaction Data Analytics: Data analysis teams can access comprehensive order data to perform transaction trend analysis and customer behavior insights, supporting business decision-making.
- Customer Service Coordination: Customer service teams can quickly retrieve order details, process after-sales requests, and document service interactions to deliver professional customer service experience.
Order Object
The order object.
Properties
EVENT Order update
Occurs whenever an order is updated.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/update
EVENT Order create
Occurs whenever an order is created.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/create
EVENT Order paid
Occurs whenever an order is paid.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/paid
EVENT Order fulfilled
Occurs whenever an order is fulfilled.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/fulfilled
EVENT Order cancelled
This webhook is triggered whenever an order is cancelled, allowing you to receive real-time updates and take appropriate actions or track cancellations.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/cancelled
EVENT Order partially fulfilled
An event is triggered when an order is partially fulfilled.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Topic
EVENT orders/partiallyFulfilled