Order GraphQL

Served by OrderModule on commercetools, OrderModule on medusa and OrderModule on sfcc.

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the order types page.

Operations

Operation	Description	Served by
`orderByPublicId`Query	Get order details for anonymous/public viewing using a public ID.	commercetoolsmedusasfcc
`orderBySignedLink`Query	Get order details from a signed order link, such as the one in an order confirmation email, for a buyer who may not be signed in.	commercetoolsmedusasfcc

Type	Description
`Order`Object	Complete order information including customer details, line items, and status
`OrderActionReasonType`Enum	Why an order cannot move on by itself.
`OrderActorType`Enum	Who an order is waiting on.
`OrderDelivery`Object	A delivery (shipment) of an order with track & trace information.
`OrderDeliveryItem`Object	How much of one line item a delivery holds
`OrderDeliveryStatusType`Enum	Normalized, engine-agnostic status of a delivery
`OrderDiscountCode`Object	An OrderDiscountCode represents a discount that was applied to the order.
`OrderPaymentStateType`Enum	Whether an order has been paid for, and if not, why not.
`OrderRequiredAction`Object	Why an order is waiting, and who it is waiting on.
`OrderResult`Object	Paginated result containing orders and metadata
`OrderStatusCount`Object	The number of orders in one status
`OrderStatusType`Enum

This domain adds these fields to types that another domain defines.

Field	Type	Description
`order`B2B	`Order`	One order, by the number a buyer quotes or by its id. Give exactly one -- giving both, or neither, is an error rather than a silent preference. The id is what a payment provider hands back on its return URL, so it is the key a buyer arrives with after paying. The order number is the one they read off a confirmation.Arguments: `orderNumber`, `id`
`orders`B2B	`OrderResult`	This business unit's orders, newest first. Cancelled ones are left out unless asked for by name: a cancelled order is not something that was bought, and reopening an unpaid order for editing cancels it, so the list would otherwise fill with twins. A search term matches the order number, the purchase-order reference, or the SKU of a line item. All three are matched in full rather than as a prefix: they are codes read off a confirmation, a purchase order or a packing slip and pasted in, not phrases to type part of. Product names are deliberately not searched. Free text over what an order contains needs a separate search index, and an order history that quietly stops finding anything the day that index is rebuilt is worse than one that never claimed to.Arguments: `page`, `pageSize`, `searchTerm`, `status`, `createdFrom`, `createdUntil`, `placedByMe`

Field	Type	Description
`order`	`Order`	One order, by the number a buyer quotes or by its id. Give exactly one -- giving both, or neither, is an error rather than a silent preference. The id is what a payment provider hands back on its return URL, so it is the key a buyer arrives with after paying. The order number is the one they read off a confirmation.Arguments: `orderNumber`, `id`
`orders`	`OrderResult`	This customer's orders, newest first. Cancelled ones are left out unless asked for by name: a cancelled order is not something that was bought, and reopening an unpaid order for editing cancels it, so the list would otherwise fill with twins. A search term matches the order number, the purchase-order reference, or the SKU of a line item. All three are matched in full rather than as a prefix: they are codes read off a confirmation, a purchase order or a packing slip and pasted in, not phrases to type part of. Product names are deliberately not searched. Free text over what an order contains needs a separate search index, and an order history that quietly stops finding anything the day that index is rebuilt is worse than one that never claimed to.Arguments: `page`, `pageSize`, `searchTerm`, `status`, `createdFrom`, `createdUntil`