Order

Object

Fields returned for order.

Fields

billingAddress OrderAddress: Gets the billing address associated with the order. This may be the same as the shipping address.
createdAt DateTime!: The date and time when the order was created.
customer Customer: The customer associated with this order.
discountApplications DiscountApplicationConnection!: Retrieves a paginated list of discount applications for the order
events OrderEventConnection!: Retrieves a paginated list of events for a specific order.
externalReference String: The external reference for the order.
fulfillments [OrderFulfillment!]!: Gets the fulfillments associated with the order.
id ID!: The unique identifier for the order.
isPaymentSecured Boolean!: Indicates whether the payment for the order is secured.
lineItems OrderLineItemConnection!: Retrieves a paginated list of line items for a specific order.
lineItemsQuantity Long!: Sum of all LineItem quantities.
metadata [MetadataItem!]!: Gets the metadata associated with the order.
metafields [Metafield!]!: The metafields associated with this order.
orderNumber Int!: The order number.
orderState OrderState!: Current status of the Order.
Possible enum values
CANCELLED
The order was cancelled before completion.
COMPLETE
Processing of the order has been completed.
CONFIRMED
The order has been accepted for processing.
OPEN
The order has been created and can still be processed.
paymentState PaymentState!: Payment status of the Order.
Possible enum values
AUTHORIZED
The full payable amount has been authorized but not fully captured.
BALANCE_DUE
The order still has an amount that must be paid.
FAILED
The required payment processing did not succeed.
OVERPAID
The collected amount is greater than the order's payable balance.
PAID
The order's payable balance has been collected.
PARTIALLY_AUTHORIZED
Only part of the payable amount has been authorized.
PARTIALLY_REFUNDED
Part of the captured amount has been refunded.
PENDING
No payment attempt has reached a final or authorized state.
REFUNDED
The captured amount has been fully refunded.
payments PaymentConnection!: Retrieves a paginated list of payments for a specific order.
shipmentState ShipmentState!: Shipment status of the Order.
Possible enum values
CANCELLED
The order's shipment was cancelled.
DELIVERED
The order's shipment has reached its destination.
PENDING
No shipment is ready to leave yet.
READY
At least one shipment is prepared and waiting to be sent.
SHIPPED
The order's shipment has been handed over for delivery.
shippingAddress OrderAddress: Gets the shipping address associated with the order.
shippingLines [OrderShippingLine!]!: Gets the shipping lines associated with the order.
store Store: Gets the store associated with the cart.
subtotal Money!: Gets the total price of the order before discounts and taxes.
taxedPrice TaxedPrice: Gets the taxed price of the order. This may be null if the order does not yet have a taxed price.
total Money!: Gets the total price of the order after discounts and taxes.

Queries

order: Retrieves a single order by ID.
orders: Retrieves a paged list of orders with optional filtering, sorting, and search.

Mutations

draftOrderPlace: Runs the draft order place operation.
orderCustomerAdd: Add a customer to an order
orderCustomerRemove: Remove a customer from an order
orderUpdate: Update an order