Create Pick List

POST

/api/v1/pick-lists

POST

/api/v1/pick-lists

curl -X POST https://api.getply.com/api/v1/pick-lists \
     -H "API_KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Job #1204 - Phase 2 Materials",
  "fromLocationId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "toLocationId": "d4e5f6a7-b8c9-0123-defa-456789012345",
  "note": "Needed for rough-in phase",
  "requestDate": "2026-03-25"
}'

{
  "id": "c5d6e7f8-a9b0-1234-cdef-567890123456",
  "name": "Job #1204 - Phase 2 Materials",
  "materialCount": 0,
  "kitCount": 0,
  "createdAt": "2026-03-20T14:30:00",
  "updatedAt": "2026-03-20T14:30:00",
  "note": "Needed for rough-in phase",
  "status": "NEED_REFILL",
  "fromLocation": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Main Warehouse",
    "type": "WAREHOUSE"
  },
  "toLocation": {
    "id": "d4e5f6a7-b8c9-0123-defa-456789012345",
    "name": "Job #1204 Site",
    "type": "JOB"
  },
  "requestDate": "2026-03-25"
}

Creates a new pick list. Status defaults to NEED_REFILL.

Requires scope: pick_lists:write

Authentication

API_KEYstring

API Key authentication via header

Request

This endpoint expects an object.

namestringRequired

Display name for the pick list. Required. Maximum 255 characters.

fromLocationIdUUIDRequired

ID of the source location to pick from. Required.

toLocationIdUUIDRequired

ID of the destination location to transfer to. Required.

notestringOptional

Optional note or description.

requestDatedateOptional

Requested date for the pick (ISO 8601 date, e.g. 2026-03-25).

Response

This endpoint returns an object.

idUUID

Unique identifier for the pick list.

namestring

Display name of the pick list.

materialCountlong

Number of distinct material line items in this pick list.

kitCountlong

Number of kit line items in this pick list.

createdAtdatetime

ISO 8601 timestamp when the record was created.

updatedAtdatetime

ISO 8601 timestamp when the record was last updated.

notestringOptional

Optional note or description for this pick list.

statusenumOptional

Current status of the pick list.

Allowed values:

fromLocationobjectOptional

Source location materials are picked from. null when the pick list has no source location, in which case adding a material requires materialDetailsId.

toLocationobjectOptional

Destination location materials are transferred to.

requestDatedateOptional

Requested date for the pick (ISO 8601 date, e.g. 2026-03-25).

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Rate Limit Error