Schema Documentation

order

Description

A order object

Response

Returns an Order

Arguments
NameDescription
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    }shippingTaxshippingTotalstatussubscriptions {      ...SubscriptionFragment    }subtotaltaxLines {      ...OrderToTaxLineConnectionFragment    }totaltotalTaxtransactionId  }}
Variables
{"id":4,"idType":"DATABASE_ID"}
Response
{"data":{"order":{"billing":CustomerAddress,"cartHash":"abc123","cartTax":"xyz789","commentCount":123,"commentStatus":"xyz789","couponLines":OrderToCouponLineConnection,"createdVia":"xyz789","currency":"xyz789","customer":Customer,"customerIpAddress":"xyz789","customerNote":"abc123","customerUserAgent":"abc123","databaseId":987,"date":"abc123","dateCompleted":"abc123","datePaid":"abc123","discountTax":"abc123","discountTotal":"abc123","downloadableItems":OrderToDownloadableItemConnection,"feeLines":OrderToFeeLineConnection,"hasBillingAddress":true,"hasDownloadableItem":false,"hasShippingAddress":false,"id":"4","isDownloadPermitted":true,"lineItems":OrderToLineItemConnection,"metaData":[MetaData],"modified":"xyz789","needsPayment":false,"needsProcessing":false,"needsShippingAddress":false,"orderKey":"xyz789","orderNotes":OrderToCommentConnection,"orderNumber":"xyz789","orderVersion":"abc123","parent":Order,"paymentMethod":"abc123","paymentMethodTitle":"xyz789","pricesIncludeTax":false,"refunds":OrderToRefundConnection,"shipping":CustomerAddress,"shippingAddressMapUrl":"xyz789","shippingLines":OrderToShippingLineConnection,"shippingTax":"xyz789","shippingTotal":"abc123","status":"CANCELLED","subscriptions":[Subscription],"subtotal":"abc123","taxLines":OrderToTaxLineConnection,"total":"abc123","totalTax":"xyz789","transactionId":"abc123"}}}