Skip to main content

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.

Required scope: repairs:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Fields:

  • direction (string, required) — customer_to_brand, brand_to_customer, brand_to_vendor or vendor_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​

OK

Response Headers
    Content-Type