Shipment

tracking_number
string
required

Tracking number.

<= 256 characters
slug
string

Unique code of the courier. Get couriers here: https://www.aftership.com/couriers.

<= 256 characters
additional_fields
object
account_number
string

Account number of the shipper for a specific courier. Required by some couriers, such as dynamic-logistics.

<= 256 characters
key
string

Key of the shipment for a specific courier. Required by some couriers, such as sic-teliway.

<= 256 characters
postal_code
string

The postal code of receiver's address. Required by some couriers, such as deutsch-post.

<= 256 characters
ship_date
string
required

Shipping date in YYYYMMDD format. Required by some couriers, such as deutsch-post.

<= 32 characters
state
string

Located state of the shipment for a specific courier. Required by some couriers, such as star-track-courier.

<= 256 characters
origin_country_region
string

Origin Country of the shipment for a specific courier. Required by some couriers, such as dhl.

<= 3 characters
destination_country_region
string

Destination Country of the shipment for a specific courier. Required by some couriers, such as postnl-3s.

<= 3 characters
items
array[object]

A list of line item objects, each containing information about an item in the shipment.

<= 100 items
source_order_item_id
string
required

The ID of the order line item.

<= 64 characters
quantity
integer
required

The number of items that were shipped.

source_id
string

The ID of shipment.

<= 32 characters
Example
preparing...