Get coverage area and estimate pricing.

Get a pricing estimate for the given order item group and order item details.
[WARNING] This API endpoint doesn't actually create an order. See /order API about creating an new order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid

Organization ID making the order.

Required if this order is made on behalf of an organization, must be null or unset if this order is made on behalf of a user.

string

[REQUIRED] Name of the sender

string

[REQUIRED] Email of the sender

string

[REQUIRED] Phone number of the sender.

Phone number format: E.164

string

[REQUIRED] Country ID of the sender.

Country ID: ISO 3166-1 alpha-2

string

Postal code of the sender.

string

State or province of the sender.

string

City of the sender.

string

Address of the sender.

origin_geo
object

Coordinates of the address of the sender, in GeoJSON Point format.

string

Currency ID of this order.

If not specified, your organization's default currency will be used.

Currency ID: ISO 4217

date

[REQUIRED] Pick-up date/time of this order.

This must be a date between today and 1 month from now (inclusive).

This field accepts these combinations of date/time:

  • Recommended: Date time with time zone offset (e.g., '2019-12-31T10:00:00+08:00')
  • Date and time without time zone offset (e.g., '2019-12-31T15:00:00') — the time zone configured for your user account will be used. Your user account's time zone appears in /me API
  • Date only (e.g., '2019-12-31') — this is provided for convenience, we'll assume it's at 00:00:00 midnight of the given day
string
enum

[REQUIRED] Status of this order.

One of the following:

  • confirmed - Confirmed. Use this if the order should be executed now.
  • draft - Draft. Use this if the order is added for confirmation later (e.g., from the website).
Allowed:
string

The option of payment method for this organization. Please contact the Product team if you need other payment option.

order_item_groups
array of objects

[REQUIRED] Array of order item groups of this order

order_item_groups
Responses

401

Unauthorized. Ensure a valid bearer token is provided in the Authorization header. If the token was cached, please clear the cached bearer token and sign in again. The token may have expired or became invalid due to server-side reasons.

429

Too many requests. You may have hit our throttling rule, please try again.

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