CData ODBC Driver for BigCommerce 2019J - Online Help

Orders

CData ODBC Driver for BigCommerce 2019J - Build 19.0.7354

Returns data from Orders table.

Table Specific Information

Insert

To insert a new Order, at least one order item is required to be attached to the INSERT query for this order. To do so, you can first populate a temporary OrderItems table with the desired items for the order you are about to create, and later using this table as a value for the LinkedProducts Pseudo-Columns during insertion:

INSERT INTO OrderItems#TEMP (ProductId,QuantityOrdered) VALUES (961,4);
INSERT INTO OrderItems#TEMP (ProductId,QuantityOrdered) VALUES (962,3);
INSERT INTO Orders (CustomerId,LinkedProducts, BillingFirstName,BillingLastName,BillingCompany, BillingCountry, BillingZip,BillingState,BillingEmail,BillingPhone) VALUES (10002, OrderItems#TEMP, 'TSS','Dev','London Corp.', 'United Kingdom', 23433,'London','tss@dev.com','+355534445');

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

The Id of the order.

CustomerId String False

The Id of the customer assigned to this order.

DateCreated Datetime True

The date of creation for the order.

DateModified Datetime True

The last modification date of the order.

DateShipped Datetime True

The date of shipment for the order.

StatusId String True

The Id of the status for this order.

CartId String True

The Id of the cart from which this order is assigned.

SubtotalExTax Decimal False

The value for subtotal, excluding tax.

SubtotalIncTax Decimal False

The value for subtotal, including tax.

ShippingCostExTax Decimal False

The value of shipping cost, excluding tax.

ShippingCostIncTax Decimal False

The value of shipping cost, including tax.

HandlingCostExTax Decimal False

The value of handling cost, excluding tax.

HandlingCostIncTax Decimal False

The value of handling cost, including tax.

WrappingCostExTax Decimal False

The value of wrapping cost, excluding tax.

WrappingCostIncTax Decimal False

The value of wrapping cost, including tax.

TotalExTax Decimal False

The total value of the order, excluding tax.

TotalIncTax Decimal False

The total value of the order, including tax.

ItemsTotal Integer True

The total number of items in the order.

ItemsShipped Integer True

The total number of items that have been shipped.

PaymentMethod String True

The payment method for this order.

PaymentProviderId String False

The external Transaction ID/Payment ID within this order's payment provider (if a payment provider was used).

PaymentStatus String True

The payment status for this order.

RefundedAmount Decimal False

The amount refunded from this transaction.

CurrencyId String True

The ID of the currency being used in this transaction.

DefaultCurrencyId String True

The ID of the default currency for the store.

StaffNotes String False

Any additional notes for staff.

CustomerMessage String False

Message that the customer entered.

DiscountAmt Decimal False

Amount of discount for this transaction.

ShippingAddressCount Integer True

The number of shipping addresses associated with this transaction.

IsDeleted Boolean True

Indicates whether the order was deleted (archived).

ExternalSource String False

A value identifying the system used to generate the order (for orders submitted or modified via the API).

ExternalId String False

ID of the order in another system.

ExternalMerchantId String False

Id of the external merchant.

ChannelId String False

Shows where the order originated.

TaxProviderId String False

BasicTaxProvider - Tax is set to manual; AvaTaxProvider - This is for when the tax provider has been set to automatic and the order was NOT created by the API; (blank) - When the tax provider is unknown.

BillingFirstName String False

Addressee first name.

BillingLastName String False

Addressee last name.

BillingCompany String False

Addressee company.

BillingStreet1 String False

Street address (first line).

BillingStreet2 String False

Street address (second line).

BillingCity String False

Addressee city

BillingZip String False

ZIP or postal code

BillingCountry String False

Addressee's country

BillingState String False

The name of the state or province. Should be spelled out in full, for example, California.

BillingEmail String False

Recipient's email address.

BillingPhone String False

Recipient's telephone number.

Pseudo-Columns

Pseudo column fields are used to enable the user to INSERT Fields that are non-readable but required during creation of new records.

Name Type Description
LinkedProducts String

Column for the aggregate table name holding order products.

 
 
Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7354.0