This webhook requires you to provide us with a quote/estimate for a given pickup and dropoff address.
The webhook contains the Pickup address and Dropoff address, as well as optional time windows on either pickup, dropoff, or both.
EXAMPLE PAYLOADS
Request attributes
inventory section is optional and will be present in the request body only if the "delivery_attributes" section was present in the merchant’s Get Quote service API call.
{
"pickup_address": "Barton Dock Road, UK, Manchester, United Kingdom, M417ZA",
"dropoff_address": "7 Glenville Rd, Cheetham Hill, Manchester, United Kingdom, M8 8JD",
"pickup": {
"address": "Barton Dock Road, UK, Manchester, United Kingdom, M417ZA"
},
"dropoff": {
"no_earlier_than": "2023-05-10T13:00:00.000Z",
"no_later_than": "2023-05-10T14:00:00.000Z",
"address": "7 Glenville Rd, Cheetham Hill, Manchester, United Kingdom, M8 8JD"
},
"inventory": {}
}
{
"pickup_address": "Barton Dock Road, UK, Manchester, United Kingdom, M417ZA",
"dropoff_address": "7 Glenville Rd, Cheetham Hill, Manchester, United Kingdom, M8 8JD",
"pickup": {
"no_earlier_than": "2023-05-10T13:00:00.000Z",
"no_later_than": "2023-05-10T14:00:00.000Z",
"address": "Barton Dock Road, UK, Manchester, United Kingdom, M417ZA"
},
"dropoff": {
"address": "7 Glenville Rd, Cheetham Hill, Manchester, United Kingdom, M8 8JD"
},
"inventory": {}
}
What we expect from you in response
- If you are able to return a quote estimate, use the format below.
- If you are not able to provide a quote, then return an empty array.
Quote response must be in an array
Please make sure that the response is nested within [ ].
Mandatory fields in response
- pickup_date
- dropoff_date
[
{
"fee": 490,
"currency_code": "USD",
"pickup_date": "2021-05-31T10:00:00.411820Z",
"dropoff_date": "2021-05-31T11:30:00.411820Z",
"quote_external_id": "123-your-quote-id",
"green_delivery": true
}
]
[]
BODY PARAMS
|
fee Int32 |
Your quoted fee for the delivery. This needs to be in cents e.g. 490 = $4.90. OPTIONAL |
|
currency_code string |
The 3-letter code for the currency. OPTIONAL |
|
pickup_date datetime |
The estimated time when you plan to pickup the order. This should be in UTC in the format "%Y-%m-%dT%H:%M:%S%z" |
|
dropoff_date datetime |
The estimated time when you plan to complete the delivery of the order. This should be in UTC in the format "%Y-%m-%dT%H:%M:%S%z"" |
|
quote_external_id string |
Your quote/estimate ID. OPTIONAL |
|
green_delivery boolean |
Indicate if the order will be delivered by a green vehicle. OPTIONAL |