Poll orders
GET
/ordersThe pull-based complement to the `order.created` webhook: one page of the Seller’s Orders updated at or after `since`, keyset-paginated on `(updated_at, id)` ascending, the same opaque-cursor client as `GET /listings`. Each item is byte-identical to the webhook `data`, so a Platform that missed a delivery can self-heal by polling and reconciling on `order_id`. Follow `nextCursor` until it is null.
When to use
Use this operation to poll orders.
Endpoint
GET /orders
| Environment | Base URL |
|---|---|
| Sandbox | https://api-sandbox.snapcaster.ca/api/v1/marketplace |
| Production | https://api.snapcaster.ca/api/v1/marketplace |
marketplaceApiKey-http bearer. Seller-scoped Marketplace API key, presented as `Authorization: Bearer mp_{sellerCode}_{hex}`. The `mp_{sellerCode}_` prefix identifies the Seller; the trailing hex is the secret. Generated by the Seller and pasted into its Platform.
Request
| Field | In | Type | Constraints | Meaning | Example |
|---|---|---|---|---|---|
since | query | string | format: date-time | Return only records created or changed after this instant. | 2026-09-04T18:00:00.000Z |
cursor | query | string | minimum length: 1 | The opaque continuation token for the next page. | string (generated) |
limit | query | integer | exclusive minimum: 0; maximum: 1000 | The maximum number of records requested for this page. | 1 (generated) |
No request body.
Example
Sandbox is the default. These requests use the contract's canonical field examples.
curl --request GET \ --url 'https://api-sandbox.snapcaster.ca/api/v1/marketplace/orders' \ --header "Authorization: Bearer $MARKETPLACE_API_KEY"Response
200
A page of orders.
{ "success": true, "data": { "items": [ { "order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW", "seller_id": 42, "created_at": "2026-09-04T18:42:17.000Z", "currency": "CAD", "customer": { "name": "Alex Morgan", "email": "alex.morgan@example.test", "shipping_address": { "line1": "123 Sandbox Avenue", "line2": "Unit 4", "city": "Toronto", "province": "ON", "postal_code": "M5V 2T6", "country": "CA" } }, "lines": [ { "sku_id": 427286, "product_id": 24692, "quantity": 1, "unit_price": 2499, "name": "Lightning Bolt", "set": "Magic 2011", "condition": "Near Mint", "external_ref": "platform-listing-1042", "language": "English", "finish": "Non-Foil" } ], "totals": { "subtotal": 2499, "shipping": 599, "tax": 403, "grand_total": 3501 }, "tax": { "lines": [ { "label": "HST", "rate": 0.13, "amount": 403 } ] }, "shipping": { "method": "Tracked parcel", "cost": 599 }, "buyer_notes": "Please protect the card with a top loader." } ], "nextCursor": null }}| Field | Type | Constraints | Meaning | Example |
|---|---|---|---|---|
successrequired | boolean | allowed values: true | Whether the operation completed as requested. | true |
datarequired | object | None | The operation or event payload. | {
"items": [
{
"order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW",
"seller_id": 42,
"created_at": "2026-09-04T18:42:17.000Z",
"currency": "CAD",
"customer": {
"name": "Alex Morgan",
"email": "alex.morgan@example.test",
"shipping_address": {
"line1": "123 Sandbox Avenue",
"line2": "Unit 4",
"city": "Toronto",
"province": "ON",
"postal_code": "M5V 2T6",
"country": "CA"
}
},
"lines": [
{
"sku_id": 427286,
"product_id": 24692,
"quantity": 1,
"unit_price": 2499,
"name": "Lightning Bolt",
"set": "Magic 2011",
"condition": "Near Mint",
"external_ref": "platform-listing-1042",
"language": "English",
"finish": "Non-Foil"
}
],
"totals": {
"subtotal": 2499,
"shipping": 599,
"tax": 403,
"grand_total": 3501
},
"tax": {
"lines": [
{
"label": "HST",
"rate": 0.13,
"amount": 403
}
]
},
"shipping": {
"method": "Tracked parcel",
"cost": 599
},
"buyer_notes": "Please protect the card with a top loader."
}
],
"nextCursor": null
} |
data.itemsrequired | array of object | None | Order bodies, each byte-identical to a webhook `order.created` `data`. | [
{
"order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW",
"seller_id": 42,
"created_at": "2026-09-04T18:42:17.000Z",
"currency": "CAD",
"customer": {
"name": "Alex Morgan",
"email": "alex.morgan@example.test",
"shipping_address": {
"line1": "123 Sandbox Avenue",
"line2": "Unit 4",
"city": "Toronto",
"province": "ON",
"postal_code": "M5V 2T6",
"country": "CA"
}
},
"lines": [
{
"sku_id": 427286,
"product_id": 24692,
"quantity": 1,
"unit_price": 2499,
"name": "Lightning Bolt",
"set": "Magic 2011",
"condition": "Near Mint",
"external_ref": "platform-listing-1042",
"language": "English",
"finish": "Non-Foil"
}
],
"totals": {
"subtotal": 2499,
"shipping": 599,
"tax": 403,
"grand_total": 3501
},
"tax": {
"lines": [
{
"label": "HST",
"rate": 0.13,
"amount": 403
}
]
},
"shipping": {
"method": "Tracked parcel",
"cost": 599
},
"buyer_notes": "Please protect the card with a top loader."
}
] |
data.items[].order_idrequired | string | None | Snapcaster order id; stable per Seller-order, the reconcile key (STABLE). | ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW |
data.items[].seller_idrequired | integer | None | Routing target: the Seller that owns the inbound API key (STABLE). | 42 |
data.items[].created_atrequired | string | None | ISO-8601 UTC instant the order was created (STABLE). | 2026-09-04T18:42:17.000Z |
data.items[].currencyrequired | string | None | ISO 4217 currency code, e.g. CAD (STABLE). | CAD |
data.items[].customerrequired | object | None | The buyer identity and delivery snapshot frozen for the Order. | {
"name": "Alex Morgan",
"email": "alex.morgan@example.test",
"shipping_address": {
"line1": "123 Sandbox Avenue",
"line2": "Unit 4",
"city": "Toronto",
"province": "ON",
"postal_code": "M5V 2T6",
"country": "CA"
}
} |
data.items[].customer.namerequired | string | None | The human-readable name of the resource. | Alex Morgan |
data.items[].customer.emailrequired | string | None | The contact email for the person represented by this record. | alex.morgan@example.test |
data.items[].customer.shipping_addressrequired | object | None | The delivery address snapshot frozen for the Order. | {
"line1": "123 Sandbox Avenue",
"line2": "Unit 4",
"city": "Toronto",
"province": "ON",
"postal_code": "M5V 2T6",
"country": "CA"
} |
data.items[].customer.shipping_address.line1required | string | None | The primary street-address line. | 123 Sandbox Avenue |
data.items[].customer.shipping_address.line2required | string or null | None | The optional unit, suite, or secondary address line. | Unit 4 |
data.items[].customer.shipping_address.cityrequired | string | None | The municipality in the delivery address. | Toronto |
data.items[].customer.shipping_address.provincerequired | string | None | The Canadian province or territory in the delivery address. | ON |
data.items[].customer.shipping_address.postal_coderequired | string | None | The Canadian postal code in the delivery address. | M5V 2T6 |
data.items[].customer.shipping_address.countryrequired | string | None | ISO 3166-1 alpha-2 country code. | CA |
data.items[].linesrequired | array of object | minimum items: 1 | One or more line snapshots (STABLE). | [
{
"sku_id": 427286,
"product_id": 24692,
"quantity": 1,
"unit_price": 2499,
"name": "Lightning Bolt",
"set": "Magic 2011",
"condition": "Near Mint",
"external_ref": "platform-listing-1042",
"language": "English",
"finish": "Non-Foil"
}
] |
data.items[].lines[].sku_idrequired | integer | None | Canonical TCGplayer sku id (STABLE). | 427286 |
data.items[].lines[].product_idrequired | integer | None | Canonical TCGplayer product id (STABLE). | 24692 |
data.items[].lines[].quantityrequired | integer | None | The number of inventory units represented by this record. | 1 |
data.items[].lines[].unit_pricerequired | integer | None | Integer minor units (cents) in the order currency (STABLE). | 2499 |
data.items[].lines[].namerequired | string | None | Descriptive snapshot, frozen at order time (STABLE). | Lightning Bolt |
data.items[].lines[].setrequired | string | None | The card set or expansion. | Magic 2011 |
data.items[].lines[].conditionrequired | string | None | The normalized condition assigned to the card. | Near Mint |
data.items[].lines[].external_refrequired | string or null | None | Echo of the Seller's opaque listing ref; null if none (STABLE). | platform-listing-1042 |
data.items[].lines[].language | string or null | None | The language of the card printing. | English |
data.items[].lines[].finish | string or null | None | The physical finish or foil treatment of the card. | Non-Foil |
data.items[].lines[].disclosures | object | None | Provenance, grading, and authenticity statements shown to the buyer. | {
"image_source": "catalog",
"condition_source": "seller_declared",
"authenticity_source": "seller_attestation",
"snapcaster_inspected": false,
"snapcaster_graded": false,
"snapcaster_authenticated": false,
"grading_standard": "string",
"declared_grade": "string",
"buyer_protection": "string"
} (generated) |
data.items[].lines[].disclosures.image_sourcerequired | string | allowed values: catalog | Who supplied the product image shown to the buyer. | catalog (generated) |
data.items[].lines[].disclosures.condition_sourcerequired | string | allowed values: seller_declared | Who assigned the displayed card condition. | seller_declared (generated) |
data.items[].lines[].disclosures.authenticity_sourcerequired | string | allowed values: seller_attestation | Who supplied the authenticity determination. | seller_attestation (generated) |
data.items[].lines[].disclosures.snapcaster_inspectedrequired | boolean | allowed values: false | Whether Snapcaster physically inspected the card. | false (generated) |
data.items[].lines[].disclosures.snapcaster_gradedrequired | boolean | allowed values: false | Whether Snapcaster assigned the displayed grade. | false (generated) |
data.items[].lines[].disclosures.snapcaster_authenticatedrequired | boolean | allowed values: false | Whether Snapcaster authenticated the card. | false (generated) |
data.items[].lines[].disclosures.grading_standardrequired | string | None | The grading standard used for the declared grade. | string (generated) |
data.items[].lines[].disclosures.declared_graderequired | string or null | None | The grade declared for the card under the named standard. | string (generated) |
data.items[].lines[].disclosures.buyer_protectionrequired | string | None | The buyer-protection coverage attached to this offering. | string (generated) |
data.items[].lines[].fulfillment_obligation | object | None | The exact item characteristics the Seller must fulfill. | {
"sku": "exact",
"printing": "exact",
"language": "exact",
"finish": "exact",
"condition": "declared-or-better"
} (generated) |
data.items[].lines[].fulfillment_obligation.skurequired | string | allowed values: exact | The stock-keeping identity for the exact card offering. | exact (generated) |
data.items[].lines[].fulfillment_obligation.printingrequired | string | allowed values: exact | The exact card printing the Seller is obligated to supply. | exact (generated) |
data.items[].lines[].fulfillment_obligation.languagerequired | string | allowed values: exact | The language of the card printing. | exact (generated) |
data.items[].lines[].fulfillment_obligation.finishrequired | string | allowed values: exact | The physical finish or foil treatment of the card. | exact (generated) |
data.items[].lines[].fulfillment_obligation.conditionrequired | string | allowed values: declared-or-better | The normalized condition assigned to the card. | declared-or-better (generated) |
data.items[].totals | object | None | Order-level money rollup, integer minor units (cents) in the order currency: `grand_total = subtotal + shipping + tax`. When present, carries all four sums (STABLE). | {
"subtotal": 2499,
"shipping": 599,
"tax": 403,
"grand_total": 3501
} |
data.items[].totals.subtotalrequired | integer | None | The line-item total before shipping and tax, in minor currency units. | 2499 |
data.items[].totals.shippingrequired | integer | None | The shipping charge or delivery details for the Order. | 599 |
data.items[].totals.taxrequired | integer | None | The tax total or breakdown applied to the Order. | 403 |
data.items[].totals.grand_totalrequired | integer | None | The complete Order total including shipping and tax, in minor currency units. | 3501 |
data.items[].tax | object | None | Tax breakdown: one `{label, rate, amount}` line per applied tax. The whole block is absent exactly when there is no tax (absent if and only if `totals.tax` = 0) (STABLE). | {
"lines": [
{
"label": "HST",
"rate": 0.13,
"amount": 403
}
]
} |
data.items[].tax.linesrequired | array of object | None | The individual records carried by this request, response, or event. | [
{
"label": "HST",
"rate": 0.13,
"amount": 403
}
] |
data.items[].tax.lines[].labelrequired | string | None | The human-readable label for this entry. | HST |
data.items[].tax.lines[].raterequired | number | None | The decimal tax rate applied to the taxable amount. | 0.13 |
data.items[].tax.lines[].amountrequired | integer | None | The monetary amount in minor currency units. | 403 |
data.items[].shipping | object | None | Chosen shipping option: `method` is a plain free-text string (not an enum) and `cost` is integer minor units (cents), mirroring `totals.shipping` (STABLE). | {
"method": "Tracked parcel",
"cost": 599
} |
data.items[].shipping.methodrequired | string | None | The method used to carry out the surrounding action. | Tracked parcel |
data.items[].shipping.costrequired | integer | None | The shipping cost in minor currency units. | 599 |
data.items[].buyer_notes | string | None | Optional free-text buyer note; absent when the buyer left none (STABLE). | Please protect the card with a top loader. |
data.items[].status | string | allowed values: accepted, shipped, delivered, cancelled, refunded | The Lifecycle state. Absent until the Order first transitions: an absent status means `created`, and an `order.created` delivery never carries it (STABLE). | accepted (generated) |
data.items[].fulfillment | object | None | Tracking block; present once Tracking has been attached at fulfillment (STABLE). | {
"tracking_company": "string",
"tracking_number": "string",
"tracking_url": "string"
} (generated) |
data.items[].fulfillment.tracking_companyrequired | string | None | Carrier/company name, as the fulfiller entered it (STABLE). | string (generated) |
data.items[].fulfillment.tracking_numberrequired | string | None | Carrier tracking number (STABLE). | string (generated) |
data.items[].fulfillment.tracking_urlrequired | string or null | None | Tracking link; null if the fulfiller supplied none (STABLE). | string (generated) |
data.nextCursorrequired | string or null | None | Opaque cursor for the next page; null on the last page. | null |
Errors
| Status | Code | Meaning | Do this |
|---|---|---|---|
| 400 | INVALID_REQUEST | The request failed validation (`INVALID_REQUEST`). | Correct the fields named in the error details, then retry the request. |
| 401 | UNAUTHORIZED | Missing or invalid Marketplace API key (`UNAUTHORIZED`). | Send the Marketplace API key for this Seller as a Bearer token, then retry. |
Related
Operations
Concepts
Changelog
Schema
Full schema details (77 fields)
Parameters
| Field | In | Type | Constraints | Meaning | Example |
|---|---|---|---|---|---|
since | query | string | format: date-time | Return only records created or changed after this instant. | 2026-09-04T18:00:00.000Z |
cursor | query | string | minimum length: 1 | The opaque continuation token for the next page. | string (generated) |
limit | query | integer | exclusive minimum: 0; maximum: 1000 | The maximum number of records requested for this page. | 1 (generated) |
Request
None.
Response 200 (application/json)
| Field | Type | Constraints | Meaning | Example |
|---|---|---|---|---|
successrequired | boolean | allowed values: true | Whether the operation completed as requested. | true |
datarequired | object | None | The operation or event payload. | {
"items": [
{
"order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW",
"seller_id": 42,
"created_at": "2026-09-04T18:42:17.000Z",
"currency": "CAD",
"customer": {
"name": "Alex Morgan",
"email": "alex.morgan@example.test",
"shipping_address": {
"line1": "123 Sandbox Avenue",
"line2": "Unit 4",
"city": "Toronto",
"province": "ON",
"postal_code": "M5V 2T6",
"country": "CA"
}
},
"lines": [
{
"sku_id": 427286,
"product_id": 24692,
"quantity": 1,
"unit_price": 2499,
"name": "Lightning Bolt",
"set": "Magic 2011",
"condition": "Near Mint",
"external_ref": "platform-listing-1042",
"language": "English",
"finish": "Non-Foil"
}
],
"totals": {
"subtotal": 2499,
"shipping": 599,
"tax": 403,
"grand_total": 3501
},
"tax": {
"lines": [
{
"label": "HST",
"rate": 0.13,
"amount": 403
}
]
},
"shipping": {
"method": "Tracked parcel",
"cost": 599
},
"buyer_notes": "Please protect the card with a top loader."
}
],
"nextCursor": null
} |
data.itemsrequired | array of object | None | Order bodies, each byte-identical to a webhook `order.created` `data`. | [
{
"order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW",
"seller_id": 42,
"created_at": "2026-09-04T18:42:17.000Z",
"currency": "CAD",
"customer": {
"name": "Alex Morgan",
"email": "alex.morgan@example.test",
"shipping_address": {
"line1": "123 Sandbox Avenue",
"line2": "Unit 4",
"city": "Toronto",
"province": "ON",
"postal_code": "M5V 2T6",
"country": "CA"
}
},
"lines": [
{
"sku_id": 427286,
"product_id": 24692,
"quantity": 1,
"unit_price": 2499,
"name": "Lightning Bolt",
"set": "Magic 2011",
"condition": "Near Mint",
"external_ref": "platform-listing-1042",
"language": "English",
"finish": "Non-Foil"
}
],
"totals": {
"subtotal": 2499,
"shipping": 599,
"tax": 403,
"grand_total": 3501
},
"tax": {
"lines": [
{
"label": "HST",
"rate": 0.13,
"amount": 403
}
]
},
"shipping": {
"method": "Tracked parcel",
"cost": 599
},
"buyer_notes": "Please protect the card with a top loader."
}
] |
data.items[].order_idrequired | string | None | Snapcaster order id; stable per Seller-order, the reconcile key (STABLE). | ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW |
data.items[].seller_idrequired | integer | None | Routing target: the Seller that owns the inbound API key (STABLE). | 42 |
data.items[].created_atrequired | string | None | ISO-8601 UTC instant the order was created (STABLE). | 2026-09-04T18:42:17.000Z |
data.items[].currencyrequired | string | None | ISO 4217 currency code, e.g. CAD (STABLE). | CAD |
data.items[].customerrequired | object | None | The buyer identity and delivery snapshot frozen for the Order. | {
"name": "Alex Morgan",
"email": "alex.morgan@example.test",
"shipping_address": {
"line1": "123 Sandbox Avenue",
"line2": "Unit 4",
"city": "Toronto",
"province": "ON",
"postal_code": "M5V 2T6",
"country": "CA"
}
} |
data.items[].customer.namerequired | string | None | The human-readable name of the resource. | Alex Morgan |
data.items[].customer.emailrequired | string | None | The contact email for the person represented by this record. | alex.morgan@example.test |
data.items[].customer.shipping_addressrequired | object | None | The delivery address snapshot frozen for the Order. | {
"line1": "123 Sandbox Avenue",
"line2": "Unit 4",
"city": "Toronto",
"province": "ON",
"postal_code": "M5V 2T6",
"country": "CA"
} |
data.items[].customer.shipping_address.line1required | string | None | The primary street-address line. | 123 Sandbox Avenue |
data.items[].customer.shipping_address.line2required | string or null | None | The optional unit, suite, or secondary address line. | Unit 4 |
data.items[].customer.shipping_address.cityrequired | string | None | The municipality in the delivery address. | Toronto |
data.items[].customer.shipping_address.provincerequired | string | None | The Canadian province or territory in the delivery address. | ON |
data.items[].customer.shipping_address.postal_coderequired | string | None | The Canadian postal code in the delivery address. | M5V 2T6 |
data.items[].customer.shipping_address.countryrequired | string | None | ISO 3166-1 alpha-2 country code. | CA |
data.items[].linesrequired | array of object | minimum items: 1 | One or more line snapshots (STABLE). | [
{
"sku_id": 427286,
"product_id": 24692,
"quantity": 1,
"unit_price": 2499,
"name": "Lightning Bolt",
"set": "Magic 2011",
"condition": "Near Mint",
"external_ref": "platform-listing-1042",
"language": "English",
"finish": "Non-Foil"
}
] |
data.items[].lines[].sku_idrequired | integer | None | Canonical TCGplayer sku id (STABLE). | 427286 |
data.items[].lines[].product_idrequired | integer | None | Canonical TCGplayer product id (STABLE). | 24692 |
data.items[].lines[].quantityrequired | integer | None | The number of inventory units represented by this record. | 1 |
data.items[].lines[].unit_pricerequired | integer | None | Integer minor units (cents) in the order currency (STABLE). | 2499 |
data.items[].lines[].namerequired | string | None | Descriptive snapshot, frozen at order time (STABLE). | Lightning Bolt |
data.items[].lines[].setrequired | string | None | The card set or expansion. | Magic 2011 |
data.items[].lines[].conditionrequired | string | None | The normalized condition assigned to the card. | Near Mint |
data.items[].lines[].external_refrequired | string or null | None | Echo of the Seller's opaque listing ref; null if none (STABLE). | platform-listing-1042 |
data.items[].lines[].language | string or null | None | The language of the card printing. | English |
data.items[].lines[].finish | string or null | None | The physical finish or foil treatment of the card. | Non-Foil |
data.items[].lines[].disclosures | object | None | Provenance, grading, and authenticity statements shown to the buyer. | {
"image_source": "catalog",
"condition_source": "seller_declared",
"authenticity_source": "seller_attestation",
"snapcaster_inspected": false,
"snapcaster_graded": false,
"snapcaster_authenticated": false,
"grading_standard": "string",
"declared_grade": "string",
"buyer_protection": "string"
} (generated) |
data.items[].lines[].disclosures.image_sourcerequired | string | allowed values: catalog | Who supplied the product image shown to the buyer. | catalog (generated) |
data.items[].lines[].disclosures.condition_sourcerequired | string | allowed values: seller_declared | Who assigned the displayed card condition. | seller_declared (generated) |
data.items[].lines[].disclosures.authenticity_sourcerequired | string | allowed values: seller_attestation | Who supplied the authenticity determination. | seller_attestation (generated) |
data.items[].lines[].disclosures.snapcaster_inspectedrequired | boolean | allowed values: false | Whether Snapcaster physically inspected the card. | false (generated) |
data.items[].lines[].disclosures.snapcaster_gradedrequired | boolean | allowed values: false | Whether Snapcaster assigned the displayed grade. | false (generated) |
data.items[].lines[].disclosures.snapcaster_authenticatedrequired | boolean | allowed values: false | Whether Snapcaster authenticated the card. | false (generated) |
data.items[].lines[].disclosures.grading_standardrequired | string | None | The grading standard used for the declared grade. | string (generated) |
data.items[].lines[].disclosures.declared_graderequired | string or null | None | The grade declared for the card under the named standard. | string (generated) |
data.items[].lines[].disclosures.buyer_protectionrequired | string | None | The buyer-protection coverage attached to this offering. | string (generated) |
data.items[].lines[].fulfillment_obligation | object | None | The exact item characteristics the Seller must fulfill. | {
"sku": "exact",
"printing": "exact",
"language": "exact",
"finish": "exact",
"condition": "declared-or-better"
} (generated) |
data.items[].lines[].fulfillment_obligation.skurequired | string | allowed values: exact | The stock-keeping identity for the exact card offering. | exact (generated) |
data.items[].lines[].fulfillment_obligation.printingrequired | string | allowed values: exact | The exact card printing the Seller is obligated to supply. | exact (generated) |
data.items[].lines[].fulfillment_obligation.languagerequired | string | allowed values: exact | The language of the card printing. | exact (generated) |
data.items[].lines[].fulfillment_obligation.finishrequired | string | allowed values: exact | The physical finish or foil treatment of the card. | exact (generated) |
data.items[].lines[].fulfillment_obligation.conditionrequired | string | allowed values: declared-or-better | The normalized condition assigned to the card. | declared-or-better (generated) |
data.items[].totals | object | None | Order-level money rollup, integer minor units (cents) in the order currency: `grand_total = subtotal + shipping + tax`. When present, carries all four sums (STABLE). | {
"subtotal": 2499,
"shipping": 599,
"tax": 403,
"grand_total": 3501
} |
data.items[].totals.subtotalrequired | integer | None | The line-item total before shipping and tax, in minor currency units. | 2499 |
data.items[].totals.shippingrequired | integer | None | The shipping charge or delivery details for the Order. | 599 |
data.items[].totals.taxrequired | integer | None | The tax total or breakdown applied to the Order. | 403 |
data.items[].totals.grand_totalrequired | integer | None | The complete Order total including shipping and tax, in minor currency units. | 3501 |
data.items[].tax | object | None | Tax breakdown: one `{label, rate, amount}` line per applied tax. The whole block is absent exactly when there is no tax (absent if and only if `totals.tax` = 0) (STABLE). | {
"lines": [
{
"label": "HST",
"rate": 0.13,
"amount": 403
}
]
} |
data.items[].tax.linesrequired | array of object | None | The individual records carried by this request, response, or event. | [
{
"label": "HST",
"rate": 0.13,
"amount": 403
}
] |
data.items[].tax.lines[].labelrequired | string | None | The human-readable label for this entry. | HST |
data.items[].tax.lines[].raterequired | number | None | The decimal tax rate applied to the taxable amount. | 0.13 |
data.items[].tax.lines[].amountrequired | integer | None | The monetary amount in minor currency units. | 403 |
data.items[].shipping | object | None | Chosen shipping option: `method` is a plain free-text string (not an enum) and `cost` is integer minor units (cents), mirroring `totals.shipping` (STABLE). | {
"method": "Tracked parcel",
"cost": 599
} |
data.items[].shipping.methodrequired | string | None | The method used to carry out the surrounding action. | Tracked parcel |
data.items[].shipping.costrequired | integer | None | The shipping cost in minor currency units. | 599 |
data.items[].buyer_notes | string | None | Optional free-text buyer note; absent when the buyer left none (STABLE). | Please protect the card with a top loader. |
data.items[].status | string | allowed values: accepted, shipped, delivered, cancelled, refunded | The Lifecycle state. Absent until the Order first transitions: an absent status means `created`, and an `order.created` delivery never carries it (STABLE). | accepted (generated) |
data.items[].fulfillment | object | None | Tracking block; present once Tracking has been attached at fulfillment (STABLE). | {
"tracking_company": "string",
"tracking_number": "string",
"tracking_url": "string"
} (generated) |
data.items[].fulfillment.tracking_companyrequired | string | None | Carrier/company name, as the fulfiller entered it (STABLE). | string (generated) |
data.items[].fulfillment.tracking_numberrequired | string | None | Carrier tracking number (STABLE). | string (generated) |
data.items[].fulfillment.tracking_urlrequired | string or null | None | Tracking link; null if the fulfiller supplied none (STABLE). | string (generated) |
data.nextCursorrequired | string or null | None | Opaque cursor for the next page; null on the last page. | null |
Error 400 (application/json)
| Field | Type | Constraints | Meaning | Example |
|---|---|---|---|---|
successrequired | boolean | allowed values: false | Whether the operation completed as requested. | false (generated) |
errorrequired | object | None | Structured error information returned when the request cannot be completed. | {
"code": "UNAUTHORIZED",
"message": "string"
} (generated) |
error.coderequired | string | allowed values: UNAUTHORIZED, INVALID_REQUEST, UNSUPPORTED_API_VERSION, SELLER_SOURCE_EXCLUSIVE, BATCH_TOO_LARGE, RATE_LIMITED, ORDER_NOT_FOUND, SELLER_NOT_FOUND, INVALID_TRANSITION, CHECKOUT_IDEMPOTENCY_KEY_REUSED, CHECKOUT_MANUAL_SELLER_UNSUPPORTED, CHECKOUT_SELF_PURCHASE_NOT_ALLOWED, CHECKOUT_SELLER_UNAVAILABLE, CHECKOUT_NOT_FOUND, FEATURE_DISABLED | Stable public error code the Platform can branch on. | UNAUTHORIZED (generated) |
error.messagerequired | string | None | A human-readable explanation of the result. | string (generated) |
error.details | unknown | None | Additional structured context for diagnosing the result. | {} (generated) |
Error 401 (application/json)
| Field | Type | Constraints | Meaning | Example |
|---|---|---|---|---|
successrequired | boolean | allowed values: false | Whether the operation completed as requested. | false (generated) |
errorrequired | object | None | Structured error information returned when the request cannot be completed. | {
"code": "UNAUTHORIZED",
"message": "string"
} (generated) |
error.coderequired | string | allowed values: UNAUTHORIZED, INVALID_REQUEST, UNSUPPORTED_API_VERSION, SELLER_SOURCE_EXCLUSIVE, BATCH_TOO_LARGE, RATE_LIMITED, ORDER_NOT_FOUND, SELLER_NOT_FOUND, INVALID_TRANSITION, CHECKOUT_IDEMPOTENCY_KEY_REUSED, CHECKOUT_MANUAL_SELLER_UNSUPPORTED, CHECKOUT_SELF_PURCHASE_NOT_ALLOWED, CHECKOUT_SELLER_UNAVAILABLE, CHECKOUT_NOT_FOUND, FEATURE_DISABLED | Stable public error code the Platform can branch on. | UNAUTHORIZED (generated) |
error.messagerequired | string | None | A human-readable explanation of the result. | string (generated) |
error.details | unknown | None | Additional structured context for diagnosing the result. | {} (generated) |