Shop Return Rates

Required permission: read_returns and write_returns

Get shipping rates for return shipments from various carriers. This endpoint allows you to compare return shipping rates across different carriers and services before creating a return label.

The endpoint supports multiple carrier integrations including EasyPost, EasyPost User, and Shippo. It will return rates from all available carrier connections that are enabled for returns and active.

Note: For client-level API keys, the client_id field is automatically set to the client's ID and cannot be overridden.

Body Params
integer
required
≥ 1

The ID of the warehouse that will be receiving the return. The warehouse must belong to your organization or client.

ship_from_address
object
required
float
required
≥ 0.01

The length of the package in inches.

float
required
≥ 0.01

The width of the package in inches.

float
required
≥ 0.01

The height of the package in inches.

float
required
≥ 0.01

The weight of the package in ounces.

integer
≥ 1

Required for organization-level API keys only. The ID of the client to shop rates for. For client-level API keys, this field is automatically set and cannot be overridden.

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json