EstimatedDeliveryDate - Tracking API

slug

string

required

AfterShip's unique code of courier. Please refer to https://track.aftership.com/couriers/download.

>= 1 characters

Example:

fedex

service_type_name

string or null

Shipping and delivery options provided by the carrier.

>= 1 characters

Example:

FEDEX HOME DELIVERY

origin_address

object

required

The location from where the package is picked up by the carrier to be delivered to the final destination.

country

string

required

The country/region of the origin location from where the package is picked up by the carrier to be delivered to the final destination. Use 3 letters of ISO 3166-1 country/region code.

>= 1 characters

Example:

USA

state

string or null

State, province, or the equivalent location of the origin address. Either origin_address.state or origin_address.postal_code is required.

>= 1 characters

Example:

city

string or null

City of the origin address.

>= 1 characters

Example:

Seattle

postal_code

string or null

Postal code of the origin address. Either origin_address.state or origin_address.postal_code is required.

>= 1 characters

Example:

98108

raw_location

string or null

Raw location of the origin address. A raw address will help AI to identify the accurate location of the origin address.

>= 1 characters

Example:

Seattle, Washington, 98108, USA, United States

destination_address

object

required

The final destination of the customer where the delivery will be made.

country

string

required

The country/region of the destination location where the package will be delivered. Use 3 letters of ISO 3166-1 country code.

>= 1 characters

state

string or null

State, province, or the equivalent location of the destination address where the package will be delivered. Either destination_address.state or destination_address.postal_code is required.

>= 1 characters

city

string or null

City of the destination address where the package will be delivered.

>= 1 characters

postal_code

string or null

Postal code of the destination address. Either destination_address.state or destination_address.postal_code is required.

>= 1 characters

raw_location

string or null

Raw location of the destination address. A raw address will help AI to identify the accurate location of the destination address.

>= 1 characters

weight

object or null

AfterShip uses this object to calculate the total weight of the order.

unit

string

required

The weight unit of the package.

Example:

value

number

required

The weight of the shipment.

Example:

package_count

integer or null

The number of packages.

Example:

pickup_time

string or null

The local pickup time of the package.Show all...

Example:

2021-07-01 06:42:30

estimated_pickup

object or null

The local pickup time of the package. Either pickup_time or estimated_pickup is required.

order_time

string

required

The local order time of the package.

>= 1 characters

Example:

2021-07-01 15:04:05

order_cutoff_time

string or null

Order cut off time. AfterShip will set 18:00:00 as the default value.

>= 1 characters

Example:

20:00:00

business_days

array[integer] or null

Operating days in a week. Number refers to the weekday. E.g., [1,2,3,4,5] means operating days are from Monday to Friday. AfterShip will set [1,2,3,4,5] as the default value.

order_processing_time

object or null

pickup_time

string or null

The local pickup time of the package.

Example:

2021-07-01 20:00:00

estimated_delivery_date

string

The estimated arrival date of the shipment, provided by AfterShip.

>= 1 characters

Example:

2021-07-03

estimated_delivery_date_min

string

The earliest estimated delivery date of the shipment, provided by AfterShip.

>= 1 characters

Example:

2021-07-02

estimated_delivery_date_max

string

The latest estimated delivery date of the shipment, provided by AfterShip.

>= 1 characters

Example:

2021-07-04