Commerce Order

By default, the Commerce Order's history is 12 months.

Field	Type	Description
id	uuid	Unique identifier (UUID) - e.g. "3fa85f64-5717-4562-b3fc-2c963f66afa6"
order_number	string	Friendly reference for the order in the platform
status	string	Order status - Possible values : CANCELLED PENDING PAID REFUNDED
fulfillment_status	string	The status of the fulfillment for the order - Possible values : FULFILLED PARTIAL UNFULFILLED
fulfillments	array of CommerceOrderFulfillment	Array of Fulfillment objects
line_items	array of CommerceOrderLineItem	Array of line items in the order
billing_address	Address	The billing address of the customer for the order
shipping_address	Address	The shipping address of the customer for the order
customer_id	uuid	UUID of the customer concerned by the order
total_shipping	Money	The sum of all shipping costs.
total_discount	Money	The sum of all discounts applied to the total price.
total_tax_amount	Money	The total tax paid on the order.
total_amount	Money	The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
source_created_at	datetime	Date on which the product was created (as given by the source provider).
source_updated_at	datetime	Date on which the product was updated (as given by the source provider).
transactions	string[]	Array of Transaction UUIDs associated with the Order (payments, refund, ...)
source_transactions	string[]	Array of source transaction id of PSP associated with the Order
provider_name	string	Name of the provider the data is coming from (informational field) - e.g. "Paypal", "Stripe", ...
data_connection_id	uuid	UUID of the data connection leading to this data

CommerceOrderFulfillment object

Field	Type	Description
id	uuid	Unique identifier (UUID) - e.g. "3fa85f64-5717-4562-b3fc-2c963f66afa6"
carrier	string	Carrier company, ex "USPS", "Fedex", "UPS", "Canada Post", etc. Can be any string
service	string	Carrier shipping service, e.g. "Priority Mail", "2 Days delivery", etc. Can be any string
tracking_urls	string[]	URLs to access the tracking service
tracking_numbers	string[]	Order tracking numbers
line_items	CommerceOrderFulfillmentLineItem	The product variants and quantities associated as part of this fulfillment

CommerceOrderFulfillmentLineItem object

Field	Type	Description
product_id	uuid	UUID of the product represented in the Fulfillment Line Item.
product_variant_id	uuid	UUID of the product variant represented in the Fulfillment Line Item.
quantity	int	The number of the variant fulfilled

CommerceOrderLineItem object

Field	Type	Description
id	string	Identifier of the line item, unique to the order.
title	string	Title text of the line item
quantity	int	The number of the variant sold
unit_price	Money	The price per unit of the variant associated with this line item
total_amount	Money	Total cost of all of the products associated with this line item added together
product_id	uuid	UUID of the product represented in the Line Item.
product_variant_id	uuid	UUID of the product variant represented in the Line Item.

Endpoints

GET/api/v6/users/{userId}/commerce-orders

Returns the list of commerce orders for the user.