OrderShipments
Returns shipments and their corresponding orders.
Table Specific Information
Select
The 本製品 uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=' comparison.
- OrderId supports the '=, and IN' comparison.
The rest of the filter is executed client-side within the 本製品.
For example, the following queries are processed server-side:
SELECT * FROM OrderShipments WHERE Id = 1 SELECT * FROM OrderShipments where OrderId=1428
Insert
To insert a new Order Shipment, at least one Shipment Item is required to be attached to the INSERT query. For this reason, you can first populate a temporary ShipmentItems table with the desired items for the shipment you are about to create, and later using this table as a value for the LinkedProducts Pseudo-Columns during insertion:
INSERT INTO ShipmentItems#TEMP (Id, Quantity) VALUES (2519, 1); INSERT INTO OrderShipments (OrderId, OrderAddressId, LinkedProducts) VALUES (1106, 1007, ShipmentItems#TEMP);
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | Integer | True |
Numeric ID of this shipment within this order. | |
OrderId | Integer | False |
Orders.Id |
Numeric ID of the associated order. |
DateCreated | Datetime | True |
Creation date for the shipment. | |
TrackingNumber | String | False |
Tracking number of the shipment. | |
TrackingCarrier | String | False |
Tracking carrier for the shipment. | |
TrackingLink | String | True |
Returns a tracking link from the shipping service. | |
ShippingProvider | String | False |
Enum of the BigCommerce shipping-carrier integration/module. | |
ShippingMethod | String | False |
Enum of the BigCommerce shipping-carrier integration/module. | |
Comments | String | False |
Comments the shipper wishes to add. | |
OrderAddressId | Integer | False |
ID of this shipping address. | |
CustomerId | String | False |
ID of this order�s customer. | |
ShippingProviderDisplayName | String | True |
The human-readable name for the shipping_provider. | |
MerchantShippingCost | Decimal | True |
The shipping merchant cost. | |
BillingAddressCity | String | True |
The billing address city. | |
BillingAddressCompany | String | True |
The billing address company. | |
BillingAddressCountry | String | True |
The billing address country | |
BillingAddressCountryIso2 | String | True |
The billing address country iso2. | |
BillingAddressEmail | String | True |
The email of the Addressee. | |
BillingAddressFirstName | String | True |
Addressee's First Name. | |
BillingAddressLastName | String | True |
Addressee's Last Name. | |
BillingAddressPhone | String | True |
Addressee's Phone. | |
BillingAddressState | String | True |
Addressee's State. | |
BillingAddressStreet1 | String | True |
Street address (first line). | |
BillingAddressStreet2 | String | True |
Street address (second line). | |
BillingAddressZip | String | True |
ZIP or postal code. |
Pseudo-Columns
疑似カラムフィールドを使用して、ユーザーは新しいレコードの作成時に必要な読み取り不可のフィールドを挿入できます。
Name | Type | Description |
LinkedProducts | String |
Column for the aggregate table name holding order products. |