Skip to main content

Buy Repair Shipping Label

POST 

/api/repairs/:repair/shipments/:shipment/buy

Buys a label for a draft (or voided) shipment from a rate returned by Get Repair Shipping Rates. The label files are stored on the shipment, the label cost is added as a freight cost, and the shipment moves to label_created. For a customer-to-us shipment the customer is emailed shipping instructions with the label attached.

Required scope: repairs:write

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

Fields:

  • shipping_provider_integration_instance_id (integer, required) — the provider the rate came from.
  • rate_id (string, required, max 191) — the rate's rate_id.
  • bill_to (string, optional) — warranty, goodwill, customer or supplier for the freight cost; defaults from the unit's coverage.
  • 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. Defaults to the shipment's saved package.

Authentication: Bearer token with the repairs:write scope.

Request​

Responses​

OK

Response Headers
    Content-Type