stations

Move a whole parcel to one status

Every order under one tracking number moves to the status you name. A row whose current status cannot legally reach it is REPORTED in meta.skipped rather than failing the call: a mixed parcel is normal, and the worker holding the box needs the rest to move.

Three statuses notify the seller, so an accidental replay would notify twice. Idempotency-Key is REQUIRED.

post/stations/quick-update

Request

  • Base URL: https://0.0.0.0:3000/api/v1
  • URL: https://0.0.0.0:3000/api/v1/stations/quick-update
  • Auth: API key in header x-api-key

Headers

Idempotency-Keystring required

Required. Any unique string; reuse it for every retry of the same move.

Request body

tracking_numberstring required

The parcel's tracking number, at least 10 characters.

statusstring required

The status every order in the parcel should reach.

notestring

Anything the floor should record with the move.

occurred_atstring

When it happened on the floor, if that is not now. ISO-8601; see the scan endpoint for the limits.

Response

The parcel after the move. meta.updated counts the rows that moved; meta.skipped names the ones that could not, each with its reason.

Changes

No recorded changes to this operation across all 1 revision of this API.