Skip to main content

Order shipments template

Create and update BigCommerce order shipments using Shift.

tip

Check out our step-by-step guides for how to import & export.

Quick start​

The best way to get started is to run an export and use the file as a guide to the format required.

You can download an order shipments export example.

If you are creating shipments, follow the creating order shipments guide or download the minimal order shipment creation example.

warning

Creating an order shipment can trigger an order status change email. To stop this email, disable the relevant buyer email template in the B2B app under Settings > Emails before running your import.

Import & export columns​

Basic columns​

ColumnDescription
ModeThe import mode for this row. See import modes for more information.
IDThe unique identifier provided by BigCommerce for the shipment. Use this with Order ID to update or delete an existing shipment.
This field is read-only.
Order IDThe BigCommerce order ID that this shipment belongs to.
This field is required when creating, updating, or deleting a shipment.
Customer IDThe BigCommerce customer ID for the order.
This field is read-only.
Order Address IDThe shipping address ID for the shipment.
This field is required when creating a shipment. You can find this as Address ID on the Shipping Addresses sheet of an Orders export.
Date CreatedThe date and time when the shipment was created.
This field is read-only.
Tracking NumberThe shipment tracking number.
Tracking LinkA custom tracking URL for the shipment.
Merchant Shipping CostThe merchant's shipping cost for the shipment.
Shipping MethodAdditional information about the shipping method, such as Standard or Free Shipping.
Shipping ProviderThe shipping provider code.
Example values: auspost, canadapost, endicia, usps, fedex, royalmail, ups, upsready, upsonline, shipperhq.
Tracking CarrierThe tracking carrier used for the shipment.
CommentsShipment comments.
Shipping Provider Display NameThe display name for the shipping provider.
This field is read-only.
Generated Tracking LinkThe tracking link generated by BigCommerce.
This field is read-only.

Billing address columns​

Billing address columns are exported for context.

ColumnDescription
Order Shipment IDThe shipment ID used to match this row to an existing shipment.
Order Shipment Order IDThe order ID used to match this row to a new shipment when creating shipments. Shipment creation requires rows across multiple sheets.
Billing First NameThe first name on the billing address.
Billing Last NameThe last name on the billing address.
Billing CompanyThe company on the billing address.
Billing Street 1The first line of the billing address.
Billing Street 2The second line of the billing address.
Billing CityThe billing address city.
Billing StateThe billing address state, county, or region.
Billing ZipThe billing address zip or postal code.
Billing CountryThe billing address country.
Billing Country ISO2The two-letter country code for the billing address.
Billing PhoneThe phone number on the billing address.
Billing EmailThe email address on the billing address.

Shipping address columns​

Shipping address columns are exported for context.

ColumnDescription
Order Shipment IDThe shipment ID used to match this row to an existing shipment.
Order Shipment Order IDThe order ID used to match this row to a new shipment when creating shipments. Shipment creation requires rows across multiple sheets.
Shipping First NameThe first name on the shipping address.
Shipping Last NameThe last name on the shipping address.
Shipping CompanyThe company on the shipping address.
Shipping Street 1The first line of the shipping address.
Shipping Street 2The second line of the shipping address.
Shipping CityThe shipping address city.
Shipping StateThe shipping address state, county, or region.
Shipping ZipThe shipping address zip or postal code.
Shipping CountryThe shipping address country.
Shipping Country ISO2The two-letter country code for the shipping address.
Shipping PhoneThe phone number on the shipping address.
Shipping EmailThe email address on the shipping address.

Items columns​

Shipment items are imported as rows on the Items sheet. A shipment can have multiple item rows, with each row identifying a different order product and quantity.

ColumnDescription
Order Shipment IDThe shipment ID used to match this row to an existing shipment.
Order Shipment Order IDThe order ID used to match this row to a new shipment when creating shipments. Shipment creation requires rows across multiple sheets.
Order Product IDThe order product ID to include in the shipment.
This field is required when creating a shipment. You can find this as Entity ID on the Products sheet of an Orders export.
Product IDThe BigCommerce product ID.
This field is read-only.
QuantityThe quantity of this order product included in the shipment.
This field is required when creating a shipment.
info

Billing address, shipping address, and item details can be added or updated where BigCommerce accepts them, but they cannot be deleted or replaced by importing blank rows. These related sheets always use merge behaviour.

Import modes​

Use Import modes to control the import behaviour.

The Mode column on import is used to determine what kind of update action is performed for each shipment row.

All standard import modes are supported at the shipment level.

ModeAction
MergeExisting items are updated. New items are created. Missing columns or empty column values are ignored.
This is the default mode.
UpdateExisting items are updated. New items are ignored. Missing columns or empty column values are ignored
CreateNew items are created. Existing items are ignored.
ReplaceExisting items are deleted and recreated. New items are created. This is the same as a Delete followed by a Merge.
DeleteExisting items are deleted.
SkipThis item is ignored

Export filters​

You can filter order shipment exports by:

  • Channel
  • Customer
  • Date Created
  • Date Updated
  • ID
  • Status
  • Grand Total

BigCommerce references​