Pickings
Picking runs in your warehouse. A picking collects items for one or more fulfillments; the same product from the same location and batch is picked as one line. Requires the pickings read permission.
A fulfillment can be part of several pickings, for example when missing items are picked later. List the pickings of an order with GET /v2/pickings?orderIds={orderId}.
List pickings
Returns a paginated list of pickings, newest first. Lines are not included; use GET /v2/pickings/{id}.
Without a date range, pickings from the last 60 days are returned. A date range can span up to one year. When orderIds is set, the date range is ignored.
query Parameters
pagePage number for pagination
pageSizeNumber of items per page
orderIdsOrder IDs, up to 20. Returns the pickings that include these orders; an order cancelled during a picking is removed from it and no longer finds it. Repeat the parameter for multiple values. The date range is ignored.
createdFromPickings started from this date and time, inclusive (format yyyy-MM-ddTHH:mm:ss.fff). Defaults to 60 days before createdTo, or before today. Ignored when orderIds is set.
createdToPickings started up to this date and time, inclusive (format yyyy-MM-ddTHH:mm:ss.fff). The range can span up to one year.
warehouseIdWarehouse ID
statusPicking statuses. Repeat the parameter for multiple values.
Headers
Accept-LanguageLanguage code for localized responses
List pickings › Responses
Paginated list of pickings
pageCurrent page number
pageSizeNumber of items per page
totalPagesTotal number of pages
nextPageWhether a next page exists
previousPageWhether a previous page exists
itemsCountTotal number of items across all pages
Pickings, newest first. Lines are not included; use GET /v2/pickings/{id}.
Get picking by ID
Returns a picking with its lines in route order.
path Parameters
idUnique picking identifier
Headers
Accept-LanguageLanguage code for localized responses
Get picking by ID › Responses
The picking with its lines
idUnique picking identifier
statusStatus of a picking.
active— in progresscompleted— finishedcancelled— cancelled; its picked quantities no longer count
repickWhether the picking resumes a parked fulfillment (see disposition)
Fulfillments included in the picking
lineCountNumber of lines to pick
quantityTotal quantity to pick; on a repick, includes units picked earlier
pickedQuantityTotal quantity picked; on a repick, includes units picked earlier
skippedQuantityTotal quantity skipped, for example when out of stock or damaged
createdAtWhen the picking started (format yyyy-MM-ddTHH:mm:ss.fff)
Lines to pick, in route order
Warehouse of the picking; null if none was selected or the warehouse no longer exists
completedAtWhen the picking was completed; null otherwise (format yyyy-MM-ddTHH:mm:ss.fff)
cancelledAtWhen the picking was cancelled; null otherwise (format yyyy-MM-ddTHH:mm:ss.fff)