Get Quote Webhook

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": "1775 San Pablo Ave, Berkeley, California 94702"
  },
  "dropoff": {
    "no_earlier_than": "2021-06-29T13:00:00.000Z",
    "no_later_than": "2021-06-30T01:00:00.000Z",
    "address": "1323 Allston Way, Berkeley, California 94702"
  },
  "inventory": {
    "total_items_count" : 3,
    "total_items_weight" : 10
  }
}
{
  "pickup": {
    "no_earlier_than": "2021-06-29T13:00:00.000Z",
    "no_later_than": "2021-06-30T01:00:00.000Z",
    "address": "1775 San Pablo Ave, Berkeley, California 94702"
  },
  "dropoff": {
    "address": "1323 Allston Way, Berkeley, California 94702"
  },
  "inventory": {
    "total_items_count" : 3,
    "total_items_weight" : 10
  }
}

📘

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