Skip to main content

Update Repair Shipment Status

POST 

/api/repairs/:repair/shipments/:shipment/status

Sets a shipment's status by hand (normally it is updated from carrier tracking). A voided shipment, or one already at that status, is returned unchanged.

Required scope: repairs:write

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

Effects:

  • outbound in transit — units are marked outbound and the customer is emailed that the repair is complete and shipped;
  • outbound delivered — units are marked delivered and the repair rolls up to returned;
  • inbound in transit — units appear on the warehouse's expected inbound list;
  • inbound delivered — logged as arrived, awaiting the receive scan.

Fields:

  • status (string, required) — in_transit, delivered or exception.
  • at (date-time, optional) — when it happened; defaults to now. Sets shipped_at / delivered_at.

Authentication: Bearer token with the repairs:write scope.

Request​

Responses​

OK

Response Headers
    Content-Type