Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

What to rate, for the ship dialog and the API alike.

order_id
string<uuid>
required
packages
object[]
required
Required array length: 1 - 20 elements
shipment_id
string<uuid> | null

A posted shipment the labels are for; its carrier and tracking number are recorded on it.

return_id
string<uuid> | null

An authorized return a return label is for.

address
object | null
insured_value
string | null

Insurance asked for, up to this value.

Pattern: ^\d{1,8}(\.\d{1,4})?$
signature
boolean

Response

RateShopResource

data
RateShopResource · object
required