Skip to main content

Generate Quote

POST 
/quote

Use this endpoint to check whether we are able to deliver a specific order. If delivery is possible, the endpoint will provide information on available services, delivery times (including cutoff times), pickup times, associated rates, and possible add-ons.

Request​

Body

required

Request a quote for a delivery

    brandId stringrequired

    Unique identifier of the brand.

    orderValueUsd number

    Total value of the order in USD

    pickUp objectrequired

    Address data

    address1 string
    address2 string
    city string
    zipCode stringrequired
    state string

    2 letter state code - ISO 3166-2

    country string

    2 letter country code - ISO 3166-2

    company string
    dropOff objectrequired

    Address data

    address1 string
    address2 string
    city string
    zipCode stringrequired
    state string

    2 letter state code - ISO 3166-2

    country string

    2 letter country code - ISO 3166-2

    company string
    addons Addon[]

    Possible values: [EXTRA_INSURANCE, SIGNATURE_REQUIRED, WITHOUT_LABEL]

    Add-ons for the delivery service

Responses​

If the request is valid, a successful response will contain a list of available services for the particular delivery including a list of associated rates.

If the request is invalid, the error response will include an error code and a useful error message, such as “The destination address is outside of our current service area”.

Schema
    success booleanrequired
    object objectrequired

    Quote with available services and prices

    availableServices object[]required
  • Array [
    • serviceType ServiceTyperequired

    Possible values: [SAME_DAY, NEXT_DAY, SCHEDULED]

    Determine the delivery date, including pick-up and drop-off times.

    jobType JobTyperequired

    Possible values: [DELIVERY, RETURN]

    cutOffTime date-time
    pickUpEarliestTime date-timerequired
    pickUpLatestTime date-timerequired
    dropOffEarliestTime date-timerequired
    dropOffLatestTime date-timerequired
    consumerSettings object
    name stringrequired
    description stringrequired
    priceUsd numberrequired
  • ]
Loading...