Order
Represents an order end-to-end: shipping and billing addresses, embedded customer, payment/fulfillment status, notes and tags, orderItems with shop/customer totals, tax, discounts, gift cards, order-level totals, fulfillments, transactions (sales and refunds), order-level discounts, returns, refunds, shipping lines, metafields, and metadata. Reference payload for order import, reconciliation, and OMS/ERP integrations.
Full JSON example
{
"id": "ex_y3Tn8kLm2Pq9",
"orderNumber": null,
"orderName": "#1067",
"channel": "demoipaas",
"srcName": null,
"srcUrl": null,
"externalRef": {
},
"note": "note",
"tags": [
"EXPORTED"
],
"test": true,
"orderNotes": {
},
"browserIp": null,
"userAgent": null,
"shippingAddress": {
"firstName": "Mario",
"lastName": "Rossi",
"company": null,
"street1": "Via Roma 45",
"street2": null,
"city": "San Casciano in Val di Pesa",
"zip": "50026",
"province": "Firenze",
"provinceCode": "FI",
"country": "Italy",
"countryCode": "IT",
"phone": null
},
"billingAddress": {
"firstName": "Mario",
"lastName": "Rossi",
"company": null,
"street1": "Via Roma 45",
"street2": null,
"city": "San Casciano in Val di Pesa",
"zip": "50026",
"province": "Firenze",
"provinceCode": "FI",
"country": "Italy",
"countryCode": "IT",
"phone": null
},
"customer": {
"id": "ex_w5Vc7bHn4Rj1",
"channel": null,
"email": "test@sintraconsulting.eu",
"createdAt": null,
"updatedAt": null,
"firstName": "Mario",
"lastName": "Rossi",
"phone": null,
"locale": "en-IT",
"tags": null,
"acceptsEmailMarketing": false,
"acceptsEmailMarketingDate": null,
"acceptsSmsMarketing": false,
"acceptsSmsMarketingDate": null
},
"paymentStatus": "PARTIALLY_REFUNDED",
"fulfillmentStatus": "FULFILLED",
"cancelReason": null,
"cancelledAt": null,
"orderItems": [
{
"id": "ex_z2Kf9mNp6Xs4",
"sku": "ABC0015-Green",
"productId": "ex_q8Lw4rTy7Ui0",
"variantId": "ex_e1As5dFg8Ho3",
"imageUrl": null,
"bundleCode": null,
"name": "ABC0015 Product - Green / One size",
"requiresShipping": false,
"vendor": "Vendor",
"isGiftCard": false,
"giftCards": [
],
"metadata": null,
"shopTotals": {
"currencyCode": "EUR",
"unitPrice": 284,
"originalUnitPrice": 284,
"totalNetPrice": 284,
"totalPrice": 284,
"originalTotalPrice": 284
},
"customerTotals": {
"currencyCode": "EUR",
"unitPrice": 284,
"originalUnitPrice": 284,
"totalNetPrice": 284,
"totalPrice": 284,
"originalTotalPrice": 284
},
"taxLines": [
],
"taxBreakdown": {
},
"unitWeight": null,
"duties": {
},
"discountAllocations": [
{
"discountCode": "0CXZ7SZP2KRG",
"discountApplicationReference": 0,
"shopDiscountAmount": 7.5,
"customerDiscountAmount": 7.5
}
],
"qtyOrdered": 1,
"qtyShipped": 1,
"qtyRefunded": 1,
"unitAmountDiscounted": 0,
"orderItemNotes": {
},
"itemGroup": null
},
{
"id": "ex_m6Bx2cVb9Zj5",
"sku": "9000Redirect",
"productId": "ex_n4Cd3eTr1Wk7",
"variantId": "ex_p9Ef6gYu2Al8",
"imageUrl": null,
"bundleCode": null,
"name": "1 Redirect Polo Nord",
"requiresShipping": false,
"vendor": "Nike",
"isGiftCard": false,
"giftCards": [
],
"metadata": null,
"shopTotals": {
"currencyCode": "EUR",
"unitPrice": 30.100000000000001,
"originalUnitPrice": 43,
"totalNetPrice": 43,
"totalPrice": 43,
"originalTotalPrice": 43
},
"customerTotals": {
"currencyCode": "EUR",
"unitPrice": 30.100000000000001,
"originalUnitPrice": 43,
"totalNetPrice": 43,
"totalPrice": 43,
"originalTotalPrice": 43
},
"taxLines": [
],
"taxBreakdown": {
},
"unitWeight": null,
"duties": {
},
"discountAllocations": [
{
"discountApplicationReference": 0,
"shopDiscountAmount": 12.9,
"customerDiscountAmount": 12.9
}
],
"qtyOrdered": 1,
"qtyShipped": 1,
"qtyRefunded": 1,
"unitAmountDiscounted": 0,
"orderItemNotes": {
},
"itemGroup": null
},
{
"id": "ex_r3Gh7hZv3Cm2",
"sku": "",
"productId": "ex_t5Ij8iAw4Dn4",
"variantId": "ex_u7Kl0jBx5Eo6",
"imageUrl": null,
"bundleCode": null,
"name": "Gift Card - $50",
"requiresShipping": false,
"vendor": "Snowboard Vendor",
"isGiftCard": true,
"giftCards": [
{
"id": "ex_v2Mn2kCy6Fp8",
"createdAt": "2025-06-27T08:51:43+00:00",
"amount": 50,
"balance": 50,
"currency": "EUR"
}
],
"metadata": null,
"shopTotals": {
"currencyCode": "EUR",
"unitPrice": 50,
"originalUnitPrice": 50,
"totalNetPrice": 50,
"totalPrice": 50,
"originalTotalPrice": 50
},
"customerTotals": {
"currencyCode": "EUR",
"unitPrice": 50,
"originalUnitPrice": 50,
"totalNetPrice": 50,
"totalPrice": 50,
"originalTotalPrice": 50
},
"taxLines": [
],
"taxBreakdown": {
},
"unitWeight": null,
"duties": {
},
"discountAllocations": [
],
"qtyOrdered": 1,
"qtyShipped": 1,
"qtyRefunded": 0,
"unitAmountDiscounted": 0,
"orderItemNotes": {
},
"itemGroup": null
}
],
"shopTotals": {
"currencyCode": "EUR",
"subTotalPrice": 364.10000000000002,
"totalNetPrice": 369,
"totalPrice": 369,
"totalShippingPrice": 0,
"totalDiscounts": 12.9
},
"customerTotals": {
"currencyCode": "EUR",
"subTotalPrice": 364.10000000000002,
"totalNetPrice": 369,
"totalPrice": 369,
"totalShippingPrice": 0,
"totalDiscounts": 12.9
},
"taxExempt": false,
"taxesIncluded": true,
"taxLines": [
],
"fulfillments": [
{
"id": "ex_x4No4lDz7Gq0",
"status": "SUCCESS",
"orderName": "#1067",
"shipmentDate": "2025-06-27T08:51:43+00:00",
"lineItems": [
{
"sku": "",
"qty": 1
}
],
"trackingInfo": {
"company": null,
"number": null,
"url": null
},
"notifyCustomer": true,
"locationReference": "ex_y6Op6mEa8Hr2"
},
{
"id": "ex_z8Pq8nFb9Is4",
"status": "SUCCESS",
"orderName": "#1067",
"shipmentDate": "2025-06-27T08:51:35+00:00",
"lineItems": [
{
"sku": "ABC0015-Green",
"qty": 1
},
{
"sku": "9000Redirect",
"qty": 1
}
],
"trackingInfo": {
"company": "UPS",
"number": "123456789",
"url": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=123456789"
},
"notifyCustomer": true,
"locationReference": "ex_a1Qr0oGc0Jt6"
}
],
"transactions": [
{
"id": "ex_b3Rs2pHd1Ku8",
"kind": "SALE",
"status": "SUCCESS",
"processedAt": "2025-06-27T08:08:47Z",
"shopCurrencyCode": "EUR",
"shopAmount": 364.10000000000002,
"customerCurrencyCode": "EUR",
"customerAmount": 364.10000000000002,
"receiptJson": "{\"paid_amount\":\"364.10\"}",
"authorizationCode": "53433",
"gateway": "bogus",
"paymentDetails": {
"avsResultCode": null,
"bin": "1",
"cvvResultCode": null,
"number": "•••• •••• •••• 1",
"company": "Bogus"
}
},
{
"id": "ex_c5St4qIe2Lv0",
"kind": "REFUND",
"status": "SUCCESS",
"processedAt": "2025-06-27T08:54:17Z",
"shopCurrencyCode": "EUR",
"shopAmount": 30.100000000000001,
"customerCurrencyCode": "EUR",
"customerAmount": 30.100000000000001,
"receiptJson": "{\"paid_amount\":\"30.10\"}",
"authorizationCode": null,
"gateway": "bogus",
"paymentDetails": {
"avsResultCode": null,
"bin": "1",
"cvvResultCode": null,
"number": "•••• •••• •••• 1",
"company": "Bogus"
}
},
{
"id": "ex_d7Tu6rJf3Mw2",
"kind": "REFUND",
"status": "SUCCESS",
"processedAt": "2025-06-27T09:20:20Z",
"shopCurrencyCode": "EUR",
"shopAmount": 279.10000000000002,
"customerCurrencyCode": "EUR",
"customerAmount": 279.10000000000002,
"receiptJson": "{\"paid_amount\":\"279.10\"}",
"authorizationCode": null,
"gateway": "bogus",
"paymentDetails": {
"avsResultCode": null,
"bin": "1",
"cvvResultCode": null,
"number": "•••• •••• •••• 1",
"company": "Bogus"
}
}
],
"discounts": [
{
"code": "0CXZ7SZP2KRG",
"type": "PERCENTAGE",
"value": 30,
"currency": null,
"targetType": "LINE_ITEM",
"targetSelection": "ENTITLED",
"allocationMethod": "EACH"
}
],
"pickupInStore": false,
"pickupStore": null,
"createdAt": "2025-06-27T08:08:50+00:00",
"updatedAt": "2025-06-27T09:20:21+00:00",
"processedAt": "2025-06-27T08:08:46+00:00",
"closedAt": "2025-06-27T09:20:21+00:00",
"returns": [
{
"id": "ex_f9Vw8sKg4Nx4",
"name": "#1067-R1",
"status": "CLOSED",
"totalQuantity": 1,
"note": "",
"returnItems": [
{
"id": "ex_g2Xy0tLh5Oy6",
"sku": "9000Redirect",
"quantity": 1
}
],
"returnShipping": [
]
},
{
"id": "ex_h4Za2uMi6Pz8",
"name": "#1067-R2",
"status": "CLOSED",
"totalQuantity": 1,
"note": "",
"returnItems": [
{
"id": "ex_j6Ab4vNj7Qa0",
"sku": "ABC0015-Green",
"quantity": 1
}
],
"returnShipping": [
{
"id": "ex_k8Bc6wOk8Rb2",
"shopAmount": 4.9000000000000004,
"customerAmount": 4.9000000000000004
}
]
}
],
"refunds": [
{
"id": "ex_m0Cd8xPl9Sc4",
"createdAt": "2025-06-27T08:54:17+00:00",
"refundNote": null,
"returnNote": "",
"returnReference": "ex_f9Vw8sKg4Nx4",
"returnReason": "",
"orderAdjustments": [
],
"refundLineItems": [
{
"id": "ex_n2De0yQm0Td6",
"sku": "9000Redirect",
"qtyRefunded": 1,
"shopTotalRefund": {
"currencyCode": "EUR",
"priceSet": 43,
"subTotalPrice": 30.100000000000001,
"totalTaxSet": 0
},
"customerTotalRefund": {
"currencyCode": "EUR",
"priceSet": 43,
"subTotalPrice": 30.100000000000001,
"totalTaxSet": 0
}
}
],
"refundShippingLines": [
]
},
{
"id": "ex_p4Ef2zRn1Ue8",
"createdAt": "2025-06-27T09:20:20+00:00",
"refundNote": null,
"returnNote": "",
"returnReference": "ex_h4Za2uMi6Pz8",
"returnReason": "",
"orderAdjustments": [
],
"refundLineItems": [
{
"id": "ex_q6Gh4aSo2Vf0",
"sku": "ABC0015-Green",
"qtyRefunded": 1,
"shopTotalRefund": {
"currencyCode": "EUR",
"priceSet": 284,
"subTotalPrice": 284,
"totalTaxSet": 0
},
"customerTotalRefund": {
"currencyCode": "EUR",
"priceSet": 284,
"subTotalPrice": 284,
"totalTaxSet": 0
}
}
],
"refundShippingLines": [
]
}
],
"shippingLines": [
{
"id": "ex_s8Ij6bTp3Wg2",
"carrierCode": "Standard",
"shopShippingCost": 0,
"customerShippingCost": 0,
"shopShippingDiscount": 0,
"customerShippingDiscount": 0
}
],
"metafields": [
],
"metadata": {
}
}
Notes
- Sample ids are fictional alphanumeric strings (
ex_...) to avoid implying a specific ecosystem; in production they use the destination platform’s id format. shopTotalsvscustomerTotalsreflect different pricing/discount perspectives.- Line items may include
isGiftCardand nestedgiftCards. transactionsuseskind(e.g.SALE,REFUND) and shop/customer amounts.returnsandrefundscross-reference each other as in the sample.