Docs

Create Shipment

Creates a new shipment in TrackMage.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more
string

Comma-separated response fields to include.

Body

Arguments
stringrequired

The workspace reference to which the shipment belongs.

Uncommon arguments
string

A tracking number, provided by the shipping company.

array of string

List of order numbers to which the shipment belongs.

string

Customer email address.

string

Customer phone number.

string

The code of origin [carrier](https://trackmage.com/carriers/). Origin Carrier will be identified automatically based on Tracking Number. Sometimes the carrier cannot be identified. In that case, the system will return the error with the suggested carriers list in the payload. The value of this field can be specified only once in POST request.

array of string

List of order references to which the shipment belongs.

array of object

List of shipment items references that belong to the shipment.

string

The workflow reference to integration for ecommerce store.

string

The id of the shipment in ecommerce store (WooCommerce, Shopify, etc.).

string

The workflow reference to integration for fulfillment source.

string

The id of the shipment in the fulfillment source system (AliExpress, Amazon, etc.).

string

The street address. This field is optional.

string

An optional additional field for the street address. This field is optional.

string

The city, town, or village. This field is optional.

string

The company of the person associated with the address. This field is optional.

string

The name of the country. This field is optional.

string

The two-letter country code. This field is optional.

string

The first name of the person associated with the address. This field is optional.

string

The last name of the person associated with the address. This field is optional.

string

The postal code (zip, postcode, Eircode, …). This field is optional.

string

The name of the region (province, state, prefecture, …). This field is optional.

string

A unique status code. This field is required.

string

A status name. This field is optional.

string

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is
One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.
Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.
Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.