Prediction for the Estimated Delivery Date - AfterShip Tracking API

The estimated delivery date is provided by AfterShip, based on its AI-predictive model. You can display the EDD on the product page, cart, and order checkout page. It indicates when a customer will receive the order.

You can use AfterShip’s AI-powered predictive estimated delivery date API to provide expected delivery dates to shoppers for online orders without tracking numbers. You can get the earliest date, the latest date, and the most-likely-arrival date through our AI-predictive EDD API.

Display accurate estimated delivery dates on the product page, store cart, and order checkout page to encourage customers to check out faster and give them a better customer experience.

Contact sales to activate this feature.

[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)

Request

Security: API Key

Body

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

AfterShip’s unique code represents carrier’s shipping and delivery options. Refer to Download Link.

>= 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_region

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. Use 3 letters of ISO 3166-1 country/region code for countries/regions without state. Either origin_address.state or origin_address.postal_code is required.

>= 1 characters<= 256 characters

Example:

city

string or null

City of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without City.

>= 1 characters<= 256 characters

Example:

Seattle

postal_code

string or null

Postal code of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without postal code. Either origin_address.state or origin_address.postal_code is required.

>= 1 characters<= 256 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<= 512 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_region

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<= 256 characters

city

string or null

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

>= 1 characters<= 256 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<= 256 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<= 512 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 in the origin address time zone 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 in the origin address time zone of the package.

>= 1 characters

Example:

2021-07-01 15:04:05

order_cutoff_time

string or null

Order cut off time in the origin address time zone. The default value set by AfterShip is 18:00:00.

>= 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