Batch predict the estimated delivery date

post
/estimated-delivery-date/predict-batch

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.

Supported functionalities require:

  1. One EstimatedDeliveryDate object for one prediction result.
  2. Maximum 5 EstimatedDeliveryDate objects are allowed.
  3. API call will fail if any of the requests EstimatedDeliveryDate objects do not meet the specification requirement.
estimated_delivery_dates
array[EstimatedDeliveryDate]
required
>= 1 items<= 5 items
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.

destination_address
object
required

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

weight
object or null

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

package_count
integer or null

The number of packages.

Example:
1
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.

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
Auth
:
Body
preparing...