Returns
an optional BcOrderTypeidString
The ID of the order.
companyNameStringOptional
The order's company name
firstNameStringOptional
The order owner's first name
lastNameStringOptional
The order owner's last name
statusStringOptional
The status will include one of the (string, optiona) - values defined under Order Statuses
customerIdIntegerOptional
The order owner's id
customStatusStringOptional
The custom status of the order
dateCreatedStringOptional
The date the order was created, formatted in the RFC-2822 standard.
dateModifiedStringOptional
representing the last modification of the order.
dateShippedStringOptional
representing the date of shipment.
statusIdIntegerOptional
The staus ID of the order.
subtotalExTaxStringOptional
Override value for subtotal excluding tax.
subtotalIncTaxStringOptional
Override value for subtotal including tax.
subtotalTaxStringOptional
subtotal tax
baseShippingCostStringOptional
The value of the base shipping cost.
shippingCostExTaxStringOptional
The value of shipping cost, excluding tax.
shippingCostIncTaxStringOptional
The value of shipping cost, including tax.
shippingCostTaxStringOptional
shipping cost tax
shippingCostTaxClassIdStringOptional
baseHandlingCostStringOptional
The value of the base handling cost
handlingCostExTaxStringOptional
The value of the handling cost, excluding tax.
handlingCostIncTaxStringOptional
The value of the handling cost, including tax.
handlingCostTaxStringOptional
handling cost tax
handlingCostTaxClassIdIntegerOptional
Value ignored if automatic tax is enabled on the store.
baseWrappingCostStringOptional
The value of the base wrapping cost.
wrappingCostExTaxStringOptional
The value of the wrapping cost, excluding tax.
wrappingCostIncTaxStringOptional
The value of the wrapping cost, including tax.
wrappingCostTaxStringOptional
wrapping cost tax
wrappingCostTaxClassIdIntegerOptional
Value ignored if automatic tax is enabled on the store.
totalExTaxStringOptional
Override value for the total, excluding tax.
totalIncTaxStringOptional
Override value for the total, including tax.
totalTaxStringOptional
total tax
itemsTotalIntegerOptional
The total number of items in the order.
itemsShippedIntegerOptional
The number of items that have been shipped.
paymentMethodStringOptional
The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.
paymentProviderIdStringOptional
The external Transaction ID/Payment ID within this order’s payment provider
paymentStatusStringOptional
payment status
refundedAmountStringOptional
The amount refunded from this transaction.
orderIsDigitalBooleanOptional
Whether this is an order for digital products.
storeCreditAmountStringOptional
Represents the store credit that the shopper has redeemed on this individual order.
giftCertificateAmountStringOptional
gift certificate amount
ipAddressStringOptional
IPv4 Address of the customer, if known
geoipCountryStringOptional
The full name of the country where the customer made the purchase, based on the IP.
geoipCountryIso2StringOptional
The country where the customer made the purchase, in ISO2 format, based on the IP
currencyIdIntegerOptional
The display currency ID.
currencyCodeStringOptional
The currency code of the display currency used to present prices on the storefront.
currencyExchangeRateStringOptional
The exchange rate between the store’s default currency and the display currency.
defaultCurrencyIdIntegerOptional
The transactional currency ID
defaultCurrencyCodeStringOptional
The currency code of the transactional currency the shopper pays in
staffNotesStringOptional
Any additional notes for staff.
customerMessageStringOptional
Message that the customer entered
discountAmountStringOptional
Amount of discount for this transaction.
couponDiscountStringOptional
coupon discount value
shippingAddressCountIntegerOptional
The number of shipping addresses associated with this transaction.
isDeletedBooleanOptional
Indicates whether the order was deleted (archived).
ebayOrderIdStringOptional
If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.
cartIdStringOptional
The cart ID from which this order originated,
ipAddressV6StringOptional
IPv6 Address of the customer, if known.
isEmailOptInBooleanOptional
Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails.
poNumberStringOptional
PO number of the order
storeDefaultCurrencyCodeStringOptional
default currency code
storeDefaultToTransactionalExchangeRateStringOptional
store default to transactional exchange_rate
customerLocaleStringOptional
channelIdStringOptional
Shows where the order originated. The channel_id will default to 1.
orderSourceStringOptional
Orders submitted via the store’s website will include a www value.
externalSourceStringOptional
This value identifies an external system that generated the order and submitted it to BigCommerce via the Orders API
creditCardTypeStringOptional
credit card type
externalIdStringOptional
ID of the order in another system.
externalMerchantIdStringOptional
external merchant id
taxProviderIdStringOptional
BasicTaxProvider - Tax is set to manual.
canReturnBooleanOptional
whether can return
createdEmailStringOptional
Order owner's email
productsStringOptional
Order products
couponsStringOptional
Order coupons
extraFieldsStringOptional
extra fields set by b3
billingAddressStringOptional
Order's billing address
shippingAddressesStringOptional
Order's shipping address
shippingAddressStringOptional
Order's shipping address
shipmentsStringOptional
Order's shipments
extraInt1IntegerOptional
extra int 1
extraInt2IntegerOptional
extra int 2
extraInt3IntegerOptional
extra int 3
extraInt4IntegerOptional
extra int 4
extraInt5IntegerOptional
extra int 5
extraStr1StringOptional
extra str 1
extraStr2StringOptional
extra str 2
extraStr3StringOptional
extra str 3
extraStr4StringOptional
extra str 4
extraStr5StringOptional
extra str 5
extraTextStringOptional
extra text
extraInfoStringOptional
extra info
moneyStringOptional
Currency info of order
referenceNumberStringOptional
Reference number of order
isInvoiceOrderIntegerOptional
Indicate if order is in Invoice
updatedAtStringOptional
update time
externalOrderIdStringOptional
external order id
ipStatusIntegerOptional
invoice status
invoiceIdIntegerOptional
invoice id
orderHistoryEventlist of optional OrderHistoryEventTypeOptional
order's history event
companyInfoCompanyInfoTypeOptional
Company information of order
