Shipments

Create a tracking

Create a shipment tracker. Returns the account's remaining tracker balance and plan.

post/shipment/create/

Request body

tracking_numberstring required

Tracking number for the package.

tracking_providerstring required

Unique code of the tracking provider. See the shipping provider reference.

order_idstring required

Respective order id.

postal_codestring

Postal code of the receiver's address. Required for some couriers, such as postnl-3s.

destination_countrystring

Destination country of the receiver's address (e.g. NL). Required for some couriers, such as postnl-3s.

Tracker created (or a status message explaining why it could not be).

statusstring

Response status (e.g. ok/error).

status_msgstring

Status message explaining the state of the shipment (e.g. pending_trackship, ssl_error, Order id not found).

trackers_balancestring

Available tracker balance of the TrackShip account.

user_planstring

Active subscription plan of the TrackShip account (e.g. Free 50, Mini, Small).

No recorded changes to this endpoint across all 1 revision of this API.