Property | Description | Type | Required |
|---|---|---|---|
provider | string | true | |
noEstimate | flag that specifies whether provider gives estimates | boolean | true |
ruleApplied | Is winning estimate or not. | boolean | false. It comes only if allowOrchestration is true in API request or in the Rates configuration |
currencyCode | ISO 4217 alphabetical code, e.g. | string | true |
amount | Estimated amount that the provider will charge. Amount as integer minor unit. Eg. | integer | true |
fee | Fee to be charged from customer for the delivery. | integer | true |
currency | The minor unit of the currency in use. E.g. | string | true |
expires | Time when this estimate will get expire. | string | conditional. Only if provider gives this value in the API response. |
requestedPickupTime | Requested Order Pickup Start Time. Unix time in milliseconds e.g., | integer | conditional |
requestedPickupTimeEnds | Requested Order Pickup End Time. Unix time in milliseconds e.g., | integer | conditional |
requestedDropOffTime | Requested Order Dropoff Start Time. Unix time in milliseconds e.g., | integer | conditional |
requestedDropoffTimeEnds | Requested Order Dropoff End Time. Unix time in milliseconds e.g., | integer | conditional |
estimatedPickupTime | Provider Estimated Pickup Time. Unix time in milliseconds e.g., | integer | conditional. Only if provider gives this value in the API response. |
estimatedPickupTimeStarts | Provider Estimated Pickup Start Time. Unix time in milliseconds e.g., | integer | conditional. Only if provider gives this value in the API response. |
estimatedPickupTimeEnds | Provider Estimated Pickup End Time. Unix time in milliseconds e.g., | integer | conditional. Only if provider gives this value in the API response. |
estimatedDeliveryTime | Provider Estimated Dropoff Time. Unix time in milliseconds e.g., | integer | conditional. Only if provider gives this value in the API response. |
estimatedDeliveryTimeStarts | Provider Estimated Dropoff Start Time. Unix time in milliseconds e.g., | integer | conditional. Only if provider gives this value in the API response. |
estimatedDeliveryTimeEnds | Provider Estimated Dropoff End Time. Unix time in milliseconds e.g., | integer | conditional. Only if provider gives this value in the API response. |
type | Order type selected/given for the order (delivery/in-store-pickup/curbside/shipping) | string | true |
serviceType | Provider Service type chosen for the order. | string | true |
serviceId | Provider Service | string | true |
storeExternalId | Unique Id of the pickup location generated in your system and configured in our system. | string | true |
supportsAlternateLocation | Flag indicating whether given provider supports alternate location or not. | boolean | true |
tags | Corresponding matched tags for the DSP from the given tags in request. | array | true |
All
Pages