Get Repair Shipping Rates
POST/api/repairs/:repair/shipments/rates
Rate-shops a parcel across every connected shipping provider that can buy labels (or one of them), cheapest first. The ship-from and ship-to addresses come from the direction: your warehouse, the customer's shipping address, or the repair vendor's address. Providers that fail are skipped; the request fails only when none returns a rate.
repairs:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Fields:
direction(string, required) —customer_to_brand,brand_to_customer,brand_to_vendororvendor_to_brand.line_ids(integer[], optional) — the repair units in the parcel.repair_shipment_id(integer, optional) — an existing shipment; its vendor dispatch picks the vendor address.shipping_provider_integration_instance_id(integer, optional) — rate with this provider only.package(object, optional) —weight(number > 0),weight_unit(lb,oz,kg,g),length,width,height(numbers > 0),dimension_unit(in,cm). Without a weight the tenant's default package is used (a small padded mailer unless configured), and missing dimensions are filled from it.
Response data.rates[]: shipping_provider_integration_instance_id, provider, rate_id (pass to Buy Repair Shipping Label), service_token, carrier, service, amount, currency, estimated_days. data.warnings[] lists warnings such as a 3PL warehouse that can't ship a customer's own unit.
Authentication: Bearer token with the repairs:write scope.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.