OrderShipments
Returns shipments and their corresponding orders.
Table Specific Information
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 | Description |
| Id [KEY] | Integer | True |
Numeric ID of this shipment within this order. |
| OrderId | Integer | False |
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. |
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. |