orders

Fill units into a parcel

Counts units as a packer fills them. On the first fill of a multi-order parcel it claims a shelf basket, and it refuses to take the count past what was ordered. The order must be IN_PRODUCTION.

A fill is a COUNTER, which makes it the one station action a replay corrupts quietly rather than refusing. Idempotency-Key is REQUIRED.

post/orders/{id}/fill

Request

  • Base URL: https://0.0.0.0:3000/api/v1
  • URL: https://0.0.0.0:3000/api/v1/orders/{id}/fill
  • Auth: API key in header x-api-key

Path parameters

idinteger required

Any order in the parcel.

Headers

Idempotency-Keystring required

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

Request body

amountinteger required

How many units this fill adds. At least 1, and never more than remains.

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, with filled updated on every order in it. meta.basket is the shelf slot it is staged in, when it has one.

Changes

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