v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

wms

Query Pick List Position

Query all positions for a given pick list

get/v2/wms/{warehouseId}/picklists/{picklistId}

Path parameters

warehouseIdstring uuid required

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the wms warehouse that the pick list belong to.

picklistIdstring uuid required

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the pick list.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

Returns all pick lists positions for an given pick list.

idstring uuid

warehouseIdstring uuid

picklistIdstring uuid

storageLocationIdstring uuid

itemIdstring uuid

quantitynumber

Quantity to pick.

status10 | 11 | 20 | 30 | 40

10 = Created, 11 = InProgress, 20 = Picked, 30 = InShippingBox, 40 = Completed

priorityinteger

Priority of the position.

salesOrderLineItemIdstring uuid

createdAtstring date-time

Time when the pick list was created.

Example response

[
  {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "picklistId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "storageLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  }
]