OrderShipments

Returns shipments and their corresponding orders.

Table Specific Information

Select

The server uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

Id supports the = comparison.
OrderId supports the = comparison.

The rest of the filter is executed client-side within the server.

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 order shipment, at least one shipment item must be attached to the INSERT query. First, populate a temporary ShipmentItems table with the items you want to include in the shipment. Then, use this table as the value for the LinkedProducts pseudo-column 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 [KEY]	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. Possible values are: auspost, canadapost, endicia, usps, fedex, ups, upsready, upsonline, shipperhq, or royalmail.
ShippingMethod	String	False	Additional information to describe the method of shipment (for example, Standard, Ship by Weight, or Custom Shipment). Can be used for live quotes from certain shipping providers. If different from shipping_provider, shipping_method should correspond to tracking_carrier.
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.
LinkedProducts	String	False	Column for the aggregate table name holding order products.

Code Assist MCP for BigCommerce

OrderShipments

Table Specific Information

Select

Insert

Columns