GraphQLB2BQueries

order

Get an order details. Requires a B2B Token.

Arguments

idIntegerRequired
The order id. This field is required.

Returns

an optional Object
idString
The ID of the order.
companyNameString
The order's company name
firstNameString
The order owner's first name
lastNameString
The order owner's last name
statusString

The status will include one of the (string, optiona) - values defined under Order Statuses

customerIdInteger
The order owner's id
customStatusString
The custom status of the order
dateCreatedString

The date the order was created, formatted in the RFC-2822 standard.

dateModifiedString
representing the last modification of the order.
dateShippedString
representing the date of shipment.
statusIdInteger
The staus ID of the order.
subtotalExTaxString
Override value for subtotal excluding tax.
subtotalIncTaxString
Override value for subtotal including tax.
subtotalTaxString
subtotal tax
baseShippingCostString
The value of the base shipping cost.
shippingCostExTaxString
The value of shipping cost, excluding tax.
shippingCostIncTaxString
The value of shipping cost, including tax.
shippingCostTaxString
shipping cost tax
shippingCostTaxClassIdString

Shipping-cost tax class.

baseHandlingCostString
The value of the base handling cost
handlingCostExTaxString
The value of the handling cost, excluding tax.
handlingCostIncTaxString
The value of the handling cost, including tax.
handlingCostTaxString
handling cost tax
handlingCostTaxClassIdInteger
Value ignored if automatic tax is enabled on the store.
baseWrappingCostString
The value of the base wrapping cost.
wrappingCostExTaxString
The value of the wrapping cost, excluding tax.
wrappingCostIncTaxString
The value of the wrapping cost, including tax.
wrappingCostTaxString
wrapping cost tax
wrappingCostTaxClassIdInteger
Value ignored if automatic tax is enabled on the store.
totalExTaxString
Override value for the total, excluding tax.
totalIncTaxString
Override value for the total, including tax.
totalTaxString
total tax
itemsTotalInteger
The total number of items in the order.
itemsShippedInteger
The number of items that have been shipped.
paymentMethodString

The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.

paymentProviderIdString

The external Transaction ID/Payment ID within this order’s payment provider

paymentStatusString
payment status
refundedAmountString
The amount refunded from this transaction.
orderIsDigitalBoolean
Whether this is an order for digital products.
storeCreditAmountString
Represents the store credit that the shopper has redeemed on this individual order.
giftCertificateAmountString
gift certificate amount
ipAddressString
IPv4 Address of the customer, if known
geoipCountryString
The full name of the country where the customer made the purchase, based on the IP.
geoipCountryIso2String
The country where the customer made the purchase, in ISO2 format, based on the IP
currencyIdInteger
The display currency ID.
currencyCodeString
The currency code of the display currency used to present prices on the storefront.
currencyExchangeRateString

The exchange rate between the store’s default currency and the display currency.

defaultCurrencyIdInteger
The transactional currency ID
defaultCurrencyCodeString
The currency code of the transactional currency the shopper pays in
staffNotesString
Any additional notes for staff.
customerMessageString
Message that the customer entered
discountAmountString
Amount of discount for this transaction.
couponDiscountString
coupon discount value
shippingAddressCountInteger
The number of shipping addresses associated with this transaction.
isDeletedBoolean

Indicates whether the order was deleted (archived).

ebayOrderIdString
If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.
cartIdString
The cart ID from which this order originated,
ipAddressV6String
IPv6 Address of the customer, if known.
isEmailOptInBoolean

Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails.

poNumberString
PO number of the order
storeDefaultCurrencyCodeString
default currency code
storeDefaultToTransactionalExchangeRateString

store default to transactional exchange_rate

customerLocaleString

The customer’s locale

channelIdString

Shows where the order originated. The channel_id will default to 1.

orderSourceString

Orders submitted via the store’s website will include a www value.

externalSourceString
This value identifies an external system that generated the order and submitted it to BigCommerce via the Orders API
creditCardTypeString
credit card type
externalIdString
ID of the order in another system.
externalMerchantIdString
external merchant id
taxProviderIdString

BasicTaxProvider - Tax is set to manual.

canReturnBoolean
whether can return
createdEmailString
Order owner's email
productsGenericScalar
Order products
couponsGenericScalar
Order coupons
extraFieldsGenericScalar
extra fields set by b3
billingAddressGenericScalar
Order's billing address
shippingAddressesGenericScalar
Order's shipping address
shippingAddressGenericScalar
Order's shipping address
shipmentsGenericScalar
Order's shipments
extraInt1Integer
extra int 1
extraInt2Integer
extra int 2
extraInt3Integer
extra int 3
extraInt4Integer
extra int 4
extraInt5Integer
extra int 5
extraStr1String
extra str 1
extraStr2String
extra str 2
extraStr3String
extra str 3
extraStr4String
extra str 4
extraStr5String
extra str 5
extraTextString
extra text
extraInfoGenericScalar
extra info
moneyGenericScalar
Currency info of order
referenceNumberString
Reference number of order
isInvoiceOrderInteger
Indicate if order is in Invoice
updatedAtString
update time
externalOrderIdString
external order id
ipStatusInteger
invoice status
invoiceIdInteger
invoice id
orderHistoryEventlist of optional Objects
order's history event
companyInfoObject
Company information of order