OBJECT
Order
A cart that has turned into an immutable order.
link GraphQL Schema definition
- type Order implements Node {
- Address :
- # A displayable string which summarises the status of the invoices
- InvoiceStatusEnum :
- # All invoices are in final state: eg. sent / collected / cancelled
- Boolean :
- Address :
- String :
- String :
- String :
- String :
- String :
- String :
- # ID of the cart that was converted into this order.
- ID :
- String :
- ISO8601DateTime! :
- # The discount applied to the order. Negative value. Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # The discount applied to the order. Negative value. In string with currency
- # symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- String :
- # The expected delivery date selected by the buyer for the order.
- ISO8601DateTime :
- # The expected delivery slot selected by the buyer for the order.
- String :
- String :
- ExternalID!]! : [
- String :
- ID! :
- # Arguments
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # first: Returns the first _n_ elements from the list.
- # last: Returns the last _n_ elements from the list.
- String, : String, : Int, : Int): InvoiceConnection! ( :
- # Is this order a gift order? Defaults to false.
- Boolean :
- # The id used to identify the order.
- Int! :
- # Arguments
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # first: Returns the first _n_ elements from the list.
- # last: Returns the last _n_ elements from the list.
- String, : String, : Int, : Int): LineItemConnection! ( :
- # A message that will be sent to the gift recipient.
- String :
- # Message to the seller.
- String :
- # Metadata key/values
- Metadatum!]! : [
- # Arguments
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # first: Returns the first _n_ elements from the list.
- # last: Returns the last _n_ elements from the list.
- String, : String, : Int, : Int): PaymentEventConnection! ( :
- JSON :
- String :
- String :
- Float! :
- String :
- ISO8601DateTime :
- Shipment!]! : [
- # The order postage cost. Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # The order postage cost. In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- OrderStatusEnum! :
- Float! :
- # The order subtotal, excluding discounts and postage. Tax is included for tax
- # inclusive marketplaces. Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # The order subtotal, excluding discounts and postage. Tax is included for tax
- # inclusive marketplaces. In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- String :
- Float! :
- # The tax on the order. Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # The tax on the order. In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- # Required for setting the current order on the checkout page via URL parameter.
- String! :
- Float! :
- # The order total. Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # The order total. In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- ISO8601DateTime! :
- }
link Require by
- CartCheckoutMutationPayloadAutogenerated return type of CartCheckoutMutation.
- InvoiceInvoice items associated with an order.
- InvoiceAmendmentAmendments to an invoice.
- OrderCreateMutationPayloadAutogenerated return type of OrderCreateMutation.
- OrderUpdateMutationPayloadAutogenerated return type of OrderUpdateMutation.
- ProcessPaymentGatewayRedirectMutationPayloadAutogenerated return type of ProcessPaymentGatewayRedirectMutation.
- QueryRoot queries that don't modify database records.
- UpdatedOrdersConnectionThe connection type for Order.
- UpdatedOrdersEdgeAn edge in a connection.