List orders
Retrieves information about all orders. Orders can be filtered by Customer ID and date ranges. The response contains order information in an Order, up to 50 Orders ordered by their modification date (modifiedOn), and supports dynamic cursors for pagination.
query Parameters
customerIdUsed to filter Orders by Customer ID.
modifiedAfterTime-boxes the request to Orders that were modified after a given ISO 8601 UTC date and time string (YYYY-MM-DDThh:mm:ss.sZ). Required when modifiedBefore is passed; cannot be used with cursor.
modifiedBeforeTime-boxes the request to Orders that were modified before a given ISO 8601 UTC date and time string (YYYY-MM-DDThh:mm:ss.sZ). Required when modifiedAfter is passed; cannot be used with cursor.
cursorIdentifies where the next page of results should begin. Should be the value of pagination.nextPageCursor from a previous response. Cannot be used with other parameters.
fulfillmentStatusUsed to filter Orders by fulfillment status. Values may be PENDING, FULFILLED, or CANCELED.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
List orders ⺠Responses
A paginated list of orders.
Create order
Creates an order using information from a third-party sales channel. A successful request creates an Order resource.
Headers
Idempotency-KeyIdempotency key to prevent duplicate order creation.
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Create order ⺠Request Body
channelNameName of third-party sales channel.
createdOnISO 8601 UTC date and time string. Represents the date and time when the order was placed through the third-party sales channel.
externalOrderReferenceOrder reference identifier used by the third-party sales channel.
Array of shipping fulfillments; up to 100 entries. Describes shipment information for the order.
A monetary amount with currency code and decimal value
Array of purchased line items; cannot be empty.
priceTaxInterpretationIndicates that lineItems.unitPricePaid includes tax. Values may be EXCLUSIVE or INCLUSIVE.
Customer's shipping address.
customerEmailEmail address provided at checkout on the third-party sales channel.
Array of discount line items. Describes the promotions redeemed during checkout.
A monetary amount with currency code and decimal value
fulfilledOnISO 8601 UTC date and time string. Represents the moment the order was fulfilled. Required if fulfillmentStatus is FULFILLED.
fulfillmentStatusCurrent fulfillment status of the order. Value may be PENDING or FULFILLED.
inventoryBehaviorIndicates whether to deduct stock quantity for the product variant upon Order creation. Values may be DEDUCT or SKIP. Defaults to SKIP.
Customer's shipping address.
Array of shipping line items. Describes the shipping options chosen at checkout. Currently accepts only one shipping entry.
A monetary amount with currency code and decimal value
shopperFulfillmentNotificationBehaviorIndicates whether to send a fulfillment notification email to the customer. Value may be SEND or SKIP.
A monetary amount with currency code and decimal value
A monetary amount with currency code and decimal value
Create order ⺠Responses
The created order.
Customer's shipping address provided at checkout or, for recurring subscription orders, the customer's current mailing address.
channelWhere the order originated; possible values are: web and pos.
channelNameName of the third-party sales channel.
createdOnISO 8601 UTC date and time string; represents the moment when the order was placed.
customerEmailEmail address entered at checkout or, for recurring subscription orders, the customer's current email address.
customerIdUnique customer id.
Array of discount line items; describes the promotions redeemed during checkout.
A monetary amount with currency code and decimal value
externalOrderReferenceOrder reference identifier used by the third-party sales channel.
Array of form data submitted via the checkout page.
fulfilledOnISO 8601 UTC date and time string; represents the moment the order was fulfilled.
fulfillmentStatusCurrent fulfillment status of the order. Value may be: PENDING, FULFILLED, or CANCELED.
Array of shipping fulfillments; describes shipment information for the order.
A monetary amount with currency code and decimal value
idUnique Order id.
Array of internal notes added to the order by the merchant.
Array of purchased line items; line items describe what product or product variant was purchased, how many of that item were purchased, and additional details.
modifiedOnISO 8601 UTC date and time string; represents when the order was last modified.
orderNumberUnique, sequential number for the Order.
priceTaxInterpretationIndicates whether lineItems.unitPricePaid includes tax. Values may be EXCLUSIVE or INCLUSIVE.
A monetary amount with currency code and decimal value
Customer's shipping address provided at checkout or, for recurring subscription orders, the customer's current mailing address.
Array of shipping line items; describes the shipping options chosen at checkout.
shippingOptionNamethe specific shipping service name selected at checkout (e.g. "USPS Ground Advantage", "Royal Mail Tracked 48").
shippingOptionServiceTypeThe carrier service type identifier.
A monetary amount with currency code and decimal value
A monetary amount with currency code and decimal value
A monetary amount with currency code and decimal value
testmodeIf true, the order is a test order created using a payment method in test mode.
Get order
Retrieves information for a specific order. The response contains order information in an Order.
path Parameters
idSpecifies the Order to retrieve.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Get order ⺠Responses
The requested order.
Customer's shipping address provided at checkout or, for recurring subscription orders, the customer's current mailing address.
channelWhere the order originated; possible values are: web and pos.
channelNameName of the third-party sales channel.
createdOnISO 8601 UTC date and time string; represents the moment when the order was placed.
customerEmailEmail address entered at checkout or, for recurring subscription orders, the customer's current email address.
customerIdUnique customer id.
Array of discount line items; describes the promotions redeemed during checkout.
A monetary amount with currency code and decimal value
externalOrderReferenceOrder reference identifier used by the third-party sales channel.
Array of form data submitted via the checkout page.
fulfilledOnISO 8601 UTC date and time string; represents the moment the order was fulfilled.
fulfillmentStatusCurrent fulfillment status of the order. Value may be: PENDING, FULFILLED, or CANCELED.
Array of shipping fulfillments; describes shipment information for the order.
A monetary amount with currency code and decimal value
idUnique Order id.
Array of internal notes added to the order by the merchant.
Array of purchased line items; line items describe what product or product variant was purchased, how many of that item were purchased, and additional details.
modifiedOnISO 8601 UTC date and time string; represents when the order was last modified.
orderNumberUnique, sequential number for the Order.
priceTaxInterpretationIndicates whether lineItems.unitPricePaid includes tax. Values may be EXCLUSIVE or INCLUSIVE.
A monetary amount with currency code and decimal value
Customer's shipping address provided at checkout or, for recurring subscription orders, the customer's current mailing address.
Array of shipping line items; describes the shipping options chosen at checkout.
shippingOptionNamethe specific shipping service name selected at checkout (e.g. "USPS Ground Advantage", "Royal Mail Tracked 48").
shippingOptionServiceTypeThe carrier service type identifier.
A monetary amount with currency code and decimal value
A monetary amount with currency code and decimal value
A monetary amount with currency code and decimal value
testmodeIf true, the order is a test order created using a payment method in test mode.
Fulfill order
Updates the status of a specific order to fulfilled, with options to include shipment information and send a customer notification.
path Parameters
idSpecifies the Order to update.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Fulfill order ⺠Request Body
Array of shipment data.
shouldSendNotificationIndicates whether the customer should receive an email notification about the added shipments.
Fulfill order ⺠Responses
No content. The order was successfully fulfilled.