Get Estimates

post deprecated

https://sandbox.api.deliverysolutions.co/api/v2/order/estimates

Use this API to retrieve an estimate for an order.

Body Params

type

string

enum

This field is used to indicate preferred fulfillment type. If delivery / in-store-pickup / curbside / shipping are passed, the system will dispatch to only those Providers that match the type passed. If type is not specified, all available fulfillment options will be considered for dispatch.

Allowed:

storeExternalId

string

required

Unique Id of the pickup location. See Create Location

orderExternalId

string

required

Id of the order generated in your system

orderValue

double

required

The value of the order in major units as decimals. E.g; 10.00.

pickupTime

object

Time Window in which the package will be ready for pick up.

dropoffTime

object

Time Window in which the package must be delivered.

deliveryContact

object

required

Customer Contact Information

deliveryAddress

object

required

Address where the package will be dropped off

packages

array of objects

required

Package dimensions, weight and quantity details help in providing accurate estimates and winning Providers. For shipping type orders, packages are converted to shipments with applicable Providers.

packages*

isSpirit

boolean

Order contains spirits. Defaults to false.

isBeerOrWine

boolean

Order contains beer or wine. Defaults to false.

isTobacco

boolean

Order contains Tobacco. Defaults to false.

isFragile

boolean

Order contains Fragile Items. Defaults to false.

hasRefrigeratedItems

boolean

Order contains Refrigerated Items. Defaults to false.

hasPerishableItems

boolean

Order contains Perishable Items. Defaults to false.

notifications

object

Status update notification recipients

signature

string

Signature requirement. If available, defaults to provider-level configuration. If not available, defaults to not_required if provider-level configuration is not available. (See Signature

tips

double

Driver tip amount in major units as decimals. E.g; 9.00.

pickupInstructions

string

Pickup instruction for the location. This will override the instructions configured with the pickup location.

deliveryInstructions

string

Delivery instructions for drop-off.

orderAttributes

json

Configurable key-value pairs of custom order attributes. (see Attribute)

currencyCode

string

[ISO 4217 alpha code|(https://en.wikipedia.org/wiki/ISO_4217#Active_codes), e.g. USD. Defaults from Brand or Business if not provided.

itemList

array of objects

Array of items in the order. Upon creation of an order, this list improves post-purchase experiences.In the absence of packages, cubic dimensions and weight will be derived from this list

itemList

alternateLocation

object

Alternate location details in case delivery needs to be routed to alternate location. Applicable for shipping type orders.

Responses

200200

400400