Cancel an announcement

POST /api/v1/inbound-shipments/:id/cancel write:inbound_shipment

Withdraws an announcement, for a package you are no longer sending or announced by mistake. Only an EXPECTED shipment can be cancelled; cancelling one that is already CANCELLED returns it unchanged. If the box turns up anyway, the warehouse can still receive it, and it moves to RECEIVED.

Try it POST /api/v1/inbound-shipments/0/cancel write

These inputs are shared across all docs pages, so an id entered here carries over.

response

Not run yet. Press Run to make a live call against https://service.rip.fun (through this demo's server-side proxy; the API key never reaches the browser).

curl (tracks the inputs above)
curl -X POST 'https://service.rip.fun/api/v1/inbound-shipments/0/cancel' \
  -H 'X-API-Key: rip_…'

Response fields (data)

FieldDescription
inbound_shipmentSame shape as POST /inbound-shipments, status "CANCELLED"

Errors

StatusCodeWhen
400invalid idid is not a positive integer
404not foundinbound shipment not part of your account
409already receivedthe package has already been received

See Errors for the response envelope and the full code list.