API Reference

Get delivery date predictions for shipping methods

get
https://example.com/delivery-promise/predictions
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Delivery Promise API

The Delivery Promise API enables the gathering of delivery predictions for customers shopping on a website. The primary use case for this would be to display estimations on a product page for headless stores, but it could also be used in mobile apps and similar applications.

Query Params
string
required

Destination zip code

shipping_methods
array of strings

Array of shipping method names to get predictions for

shipping_methods
variant_ids
array of strings

Array of product variant IDs

variant_ids
Responses

Updated 10 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago