BcOrderType

OBJECT

Definition

1 type BcOrderType {
2   id: String!
3   companyName: String
4   firstName: String
5   lastName: String
6   status: String
7   customerId: Int
8   customStatus: String
9   dateCreated: String
10   dateModified: String
11   dateShipped: String
12   statusId: Int
13   subtotalExTax: String
14   subtotalIncTax: String
15   subtotalTax: String
16   baseShippingCost: String
17   shippingCostExTax: String
18   shippingCostIncTax: String
19   shippingCostTax: String
20   shippingCostTaxClassId: String
21   baseHandlingCost: String
22   handlingCostExTax: String
23   handlingCostIncTax: String
24   handlingCostTax: String
25   handlingCostTaxClassId: Int
26   baseWrappingCost: String
27   wrappingCostExTax: String
28   wrappingCostIncTax: String
29   wrappingCostTax: String
30   wrappingCostTaxClassId: Int
31   totalExTax: String
32   totalIncTax: String
33   totalTax: String
34   itemsTotal: Int
35   itemsShipped: Int
36   paymentMethod: String
37   paymentProviderId: String
38   paymentStatus: String
39   refundedAmount: String
40   orderIsDigital: Boolean
41   storeCreditAmount: String
42   giftCertificateAmount: String
43   ipAddress: String
44   geoipCountry: String
45   geoipCountryIso2: String
46   currencyId: Int
47   currencyCode: String
48   currencyExchangeRate: String
49   defaultCurrencyId: Int
50   defaultCurrencyCode: String
51   staffNotes: String
52   customerMessage: String
53   discountAmount: String
54   couponDiscount: String
55   shippingAddressCount: Int
56   isDeleted: Boolean
57   ebayOrderId: String
58   cartId: String
59   ipAddressV6: String
60   isEmailOptIn: Boolean
61   poNumber: String
62   storeDefaultCurrencyCode: String
63   storeDefaultToTransactionalExchangeRate: String
64   customerLocale: String
65   channelId: String
66   orderSource: String
67   externalSource: String
68   creditCardType: String
69   externalId: String
70   externalMerchantId: String
71   taxProviderId: String
72   canReturn: Boolean
73   createdEmail: String
74   products: GenericScalar
75   coupons: GenericScalar
76   extraFields: GenericScalar
77   billingAddress: GenericScalar
78   shippingAddresses: GenericScalar
79   shippingAddress: GenericScalar
80   shipments: GenericScalar
81   extraInt1: Int
82   extraInt2: Int
83   extraInt3: Int
84   extraInt4: Int
85   extraInt5: Int
86   extraStr1: String
87   extraStr2: String
88   extraStr3: String
89   extraStr4: String
90   extraStr5: String
91   extraText: String
92   extraInfo: GenericScalar
93   money: GenericScalar
94   referenceNumber: String
95   isInvoiceOrder: Int
96   updatedAt: String
97   externalOrderId: String
98   ipStatus: Int
99   invoiceId: Int
100   orderHistoryEvent: [OrderHistoryEventType]
101   companyInfo: CompanyInfoType
102 }

Fields

idStringRequired

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

Shipping-cost tax class.

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

The customer’s locale

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

BcOrderType

Fields

Referenced by

Queries

Fields

Referenced by

Queries