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.
repairs:writeGrant 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'srate_id.bill_to(string, optional) —warranty,goodwill,customerorsupplierfor 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
- 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.