Pick Incoming Order

Records the picked quantities for an incoming order and moves it to PICKED status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The incoming order must not already be in SENT status. Calling this endpoint on an order that is already PICKED replaces the previously recorded quantities and remarks.

items

Each item targets one package, identified by either incoming_order_package (an existing package on the order) or supplier_package (to attach a new supplier package to the order at pick time). Exactly one of the two is required per item — providing both, or neither, returns a 400.

quantity_picked must be zero or greater — sending 0 records that none of that package arrived. actual_price must be zero or greater when provided; on a re-pick it is preserved when omitted.

sent_date

Must not be in the future. Defaults to the current time when omitted; on a re-pick the order is restamped to the current time when omitted.

update_stock

When true (the default), the picked quantities are added to the receiving outlet's stock. Set to false to record the pick without affecting stock — for example, when the delivery has already been counted by other means.

Path Params
string
required

The incoming order's ID.

Body Params
items
array of objects
required
length ≥ 1

One entry per package to pick. Must contain at least one item. Each entry identifies the package with either incoming_order_package (an existing package on the order) or supplier_package (to add a new supplier package to the order at pick time) — exactly one of the two is required.

items*
string
required

The ID of an existing incoming order package being picked. Provide this or supplier_package, not both.

string

The ID of a supplier package to add to the order at pick time. Use this when picking a package that was not part of the original order. Provide this or incoming_order_package, not both.

string
required
^[0-9]+\.?[0-9]*$

The quantity received for this package. Must be zero or positive.

string | null

Optional remarks for this package.

string | null
^[0-9]+\.?[0-9]*$

Optional override of the price actually paid for this package. Must be zero or positive. When omitted on a re-pick, the previously recorded price is preserved.

date-time | null

Date and time the order was sent. Must not be in the future. Defaults to now when omitted; on a re-pick it is restamped to the current time when omitted.

string | null

Optional discount applied to the whole order.

string | null

Optional remarks describing the discount.

string | null

Optional remarks about the delivery itself.

boolean
Defaults to true

Whether to apply the picked quantities to the receiving outlet's stock. Defaults to true.

Responses

400

The request items are invalid (for example, both or neither of incoming_order_package and supplier_package were provided, sent_date is in the future, actual_price is negative, or the items target packages that do not belong to the order), or the order has already been shipped.

403

The user does not have permission to pick this incoming order, or a supplier package referenced in items.supplier_package is not accessible to the user.

404

Incoming order or supplier package not found.

409

The order is currently being processed by another request. Try again shortly.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json