Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
origin
string
required

The resource name of the origin location.

Maximum string length: 96
Example:

"locations/CO-54003000"

destination
string
required

The resource name of the destination location.

Maximum string length: 96
Example:

"locations/CO-11001000"

package
object
required

Details of the package to be quoted.

cashOnDeliveryRequestCents
number
required

The amount to be collected on delivery in cents.

Required range: x >= 0
Example:

8900000

order
string | null

The unique identifier for the order associated with the shipment.

Example:

"orders/66d86d4b05a7d437ac6c5379"

Response

200 - application/json

Successfully created a quote.

name
string
required

The unique identifier for the quote.

Example:

"quotes/669838849afe8a9d48db1c1e"

createTime
string<date-time>
required

The timestamp when the quote was created.

Example:

"2024-07-17T21:32:52.478Z"

updateTime
string<date-time>
required

The timestamp when the quote was last updated.

Example:

"2024-07-17T21:32:52.478Z"

origin
string
required

The resource name of the origin location.

Maximum string length: 96
Example:

"locations/CO-54003000"

destination
string
required

The resource name of the destination location.

Maximum string length: 96
Example:

"locations/CO-11001000"

package
object
required

Details of the package to be quoted.

cashOnDeliveryRequestCents
number
required

The amount to be collected on delivery in cents.

Required range: x >= 0
Example:

8900000

offers
object[]
required

An array of offers from courier services.

order
string | null

The unique identifier for the order associated with the shipment.

Example:

"orders/66d86d4b05a7d437ac6c5379"