Schema Documentation

`order`

Description

A order object

Response

Returns an Order

Arguments

Name	Description
`id` - `ID`	The ID for identifying the order
`idType` - `OrderIdTypeEnum`	Type of ID being used identify order

Example

Query

query order(
  $id: ID,
  $idType: OrderIdTypeEnum
){
  order(
    id: $id,
    idType: $idType
  ){
    billing {
      ...CustomerAddressFragment
    }cartHashcartTaxcommentCountcommentStatuscouponLines {
      ...OrderToCouponLineConnectionFragment
    }createdViacurrencycustomer {
      ...CustomerFragment
    }customerIpAddresscustomerNotecustomerUserAgentdatabaseIddatedateCompleteddatePaiddiscountTaxdiscountTotaldownloadableItems {
      ...OrderToDownloadableItemConnectionFragment
    }feeLines {
      ...OrderToFeeLineConnectionFragment
    }hasBillingAddresshasDownloadableItemhasShippingAddressidisDownloadPermittedlineItems {
      ...OrderToLineItemConnectionFragment
    }metaData {
      ...MetaDataFragment
    }modifiedneedsPaymentneedsProcessingneedsShippingAddressorderKeyorderNotes {
      ...OrderToCommentConnectionFragment
    }orderNumberorderVersionparent {
      ...OrderFragment
    }paymentMethodpaymentMethodTitlepricesIncludeTaxrefunds {
      ...OrderToRefundConnectionFragment
    }shipping {
      ...CustomerAddressFragment
    }shippingAddressMapUrlshippingLines {
      ...OrderToShippingLineConnectionFragment
    }shippingTaxshippingTotalstatussubtotaltaxLines {
      ...OrderToTaxLineConnectionFragment
    }totaltotalTaxtransactionId
  }
}

Variables

{"id":"4","idType":"DATABASE_ID"}

Response

{"data":{"order":{"billing":CustomerAddress,"cartHash":"abc123","cartTax":"abc123","commentCount":987,"commentStatus":"abc123","couponLines":OrderToCouponLineConnection,"createdVia":"xyz789","currency":"abc123","customer":Customer,"customerIpAddress":"xyz789","customerNote":"abc123","customerUserAgent":"xyz789","databaseId":987,"date":"abc123","dateCompleted":"abc123","datePaid":"xyz789","discountTax":"abc123","discountTotal":"xyz789","downloadableItems":OrderToDownloadableItemConnection,"feeLines":OrderToFeeLineConnection,"hasBillingAddress":false,"hasDownloadableItem":false,"hasShippingAddress":false,"id":4,"isDownloadPermitted":false,"lineItems":OrderToLineItemConnection,"metaData":[MetaData],"modified":"abc123","needsPayment":false,"needsProcessing":false,"needsShippingAddress":false,"orderKey":"xyz789","orderNotes":OrderToCommentConnection,"orderNumber":"abc123","orderVersion":"xyz789","parent":Order,"paymentMethod":"xyz789","paymentMethodTitle":"xyz789","pricesIncludeTax":false,"refunds":OrderToRefundConnection,"shipping":CustomerAddress,"shippingAddressMapUrl":"abc123","shippingLines":OrderToShippingLineConnection,"shippingTax":"abc123","shippingTotal":"abc123","status":"CANCELLED","subtotal":"xyz789","taxLines":OrderToTaxLineConnection,"total":"abc123","totalTax":"abc123","transactionId":"xyz789"}}}