Request delivery options

Creates a pending quote and returns the available delivery products for a pickup, a destination and a parcel.

Send exactly one pickup — a warehouseId, or a custom pickupLocation — and exactly one destination — a destinationLocation, or a destinationWarehouseId. Every warehouse must belong to the authenticated merchant and be active.

Both ends must be inside our service area, whether they are an address or a warehouse's location. A pickup outside the area we collect from returns 400 PICKUP_OUT_OF_SERVICE_AREA, and a destination outside the area we deliver to returns 400 DESTINATION_OUT_OF_SERVICE_AREA. No quote is created in either case.

Who the courier meets at a custom pickup does not affect the price, so it is not part of the quote: send pickupContact when you create the transfer.

The merchant that requests the quote is the merchant that is charged, and whose webhooks fire, for the transfer, whichever pickup and destination are used.

Authorization

bearerAuth

AuthorizationBearer <token>

Access token returned by POST /auth/token.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Send exactly one of warehouseId or pickupLocation, and exactly one of destinationLocation or destinationWarehouseId.

warehouseId?string

Pickup warehouse. Must belong to the authenticated merchant and be active. Mutually exclusive with pickupLocation.

Formatuuid

pickupLocation?

Custom pickup address, instead of a warehouse. Who to meet there is sent as pickupContact when the transfer is created. Mutually exclusive with warehouseId.

destinationLocation?

Delivery address. Mutually exclusive with destinationWarehouseId.

destinationWarehouseId?string

Deliver to one of your warehouses instead of an address. Must belong to the authenticated merchant, be active, and differ from warehouseId. Mutually exclusive with destinationLocation.

Formatuuid

parcelSize?string

Required unless items is sent with at least one entry. If both parcelSize and items are present, parcelSize is used and items is ignored.

Value in

"SMALL"
"MEDIUM"
"LARGE"
"CARGO"

items?array<>

Alternative to parcelSize. Every entry must include dimensions unless parcelSize is also sent, in which case items is ignored and its dimensions are not validated. Each entry's dimensions are counted quantity times (default 1) and summed independently, axis by axis, across all entries into one combined bounding box, which is then classified (checked in any rotation) into a parcel size.

Items1 <= items

isFragile*boolean

isPerishable*boolean

Response Body

`application/json`

curl -X POST "https://example.com/options" \  -H "Content-Type: application/json" \  -d '{    "warehouseId": "11111111-1111-4111-8111-111111111111",    "destinationLocation": {      "lat": 41.7151,      "lng": 44.8271,      "display_name": "12 Rustaveli Avenue, Tbilisi",      "city": "Tbilisi"    },    "parcelSize": "SMALL",    "isFragile": false,    "isPerishable": false  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "transfer_id": "string",  "event_id": "string",  "products": {    "property1": {      "status": "string",      "common": {        "pattern": "string",        "router_id": "string",        "price": {          "original_amount": "string",          "payable_amount": "string",          "discount_pct": "string",          "courier_fee_total": "string",          "service_fee_total": "string",          "stop_fee_total": "string",          "discount_amount": "string"        },        "tags": [          "string"        ]      }    },    "property2": {      "status": "string",      "common": {        "pattern": "string",        "router_id": "string",        "price": {          "original_amount": "string",          "payable_amount": "string",          "discount_pct": "string",          "courier_fee_total": "string",          "service_fee_total": "string",          "stop_fee_total": "string",          "discount_amount": "string"        },        "tags": [          "string"        ]      }    }  }}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`