QUICKSTART

Common Scenarios

Returns

CHANGELOG

Changelog

REFERENCE

Orders

Products

Stores

Model

Envelope

Shipment

tracking_number

string

Tracking number.

<= 256 characters

Example:

2591043243

slug

string

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

<= 256 characters

Example:

dhl

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

Example:

876994760

key

string

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

<= 256 characters

Example:

38784963

postal_code

string

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

<= 256 characters

Example:

058050

ship_date

string

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

Example:

20191126

Match pattern:

^[0-9]{8}$

state

string

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

<= 256 characters

Example:

NewYork

origin_country_region

string

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

Example:

USA

Match pattern:

^[A-Z]{3}$

destination_country_region

string

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

Example:

USA

Match pattern:

^[A-Z]{3}$

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

The source_id of the order item.

<= 64 characters

Example:

quantity

integer

The number of items that were shipped.

Example:

source_id

string

required

A unique identifier for the shipment in your system.

<= 32 characters

Example:

source_created_at

string

The date and time (ISO 8601 format) when shipment was created.

Example:

2021-04-15T20:02:09Z

service_type

string

The type of logistics service selected for this shipment, e.g. FedEx, SmartPost.

Example:

FedEx

ship_from_address

Address

Example:

{"source_id":"1","description":"My Home Address","company":"aftership","first_name":"teddy","last_name":"chan","email":"[email protected]","address_line_1":"address2","address_line_2":"1233","address_line_3":null,"city":"HongKong","state":"HKG","country_region":"HKG","postal_code":"12323","phone":"+8613265883816","type":null,"tax_number":null}

description

string

The name or description of this address.

<= 256 characters

company

string

The company of the person associated with this address.

<= 256 characters

first_name

string

The customer’s first name.

<= 256 characters

last_name

string

The customer’s last name.

<= 256 characters

string

The email address of the customer.

<= 256 characters

address_line_1

string

The customer's mailing address.

<= 256 characters

address_line_2

string

An additional field for the customer's mailing address.

<= 256 characters

address_line_3

string

An additional field for the customer's mailing address.

<= 256 characters

city

string

The customer’s city, town, or village.

<= 256 characters

state

string

The customer’s region name. Typically a province, a state, or a prefecture.

<= 256 characters

country_region

string

The customer's country/region.

Example:

USA

Match pattern:

^[A-Z]{3}$

postal_code

string

The customer’s postal code, also known as zip, postcode, Eircode, etc.

<= 256 characters

phone

string

The customer’s phone number at this address.

<= 256 characters

type

string

The type of address.

Allowed values:

businessresidential

tax_number

string

Tax number for the address.

<= 256 characters

source_id

string

A unique identifier for the address.

<= 32 characters

custom_fields

object

Custom fields that accept an object with string field.Show all...

Example

preparing...