/api/v1/facilities/{facilityId}/outbound/pick-assignments

POST

/api/v1/facilities/{facilityId}/outbound/pick-assignments

curl --request POST \
  --url https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/outbound/pick-assignments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "workerRef": "example" }'

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Request Body

object

workerRef

string

nullable

Example ^generated

{
  "workerRef": "example"
}

object

workerRef

string

nullable

Example ^generated

{
  "workerRef": "example"
}

object

workerRef

string

nullable

Example ^generated

{
  "workerRef": "example"
}

Responses

200

OK

object

order

required

object

id

required

string format: uuid

orderNumber

required

string

customerReference

required

string

nullable

priority

required

integer format: int32

requestedShipDate

required

string format: date

nullable

status

required

string

Allowed values: New Waved Allocating Allocated AllocationException Picking Picked Packed Shipped Cancelled

waveId

required

string format: uuid

nullable

waveNumber

required

string

nullable

lineCount

required

integer format: int32

totalBaseQuantity

required

integer format: int32

shipToName

required

string

shipToCountryCode

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

tasks

required

Array<object>

object

id

required

string format: uuid

waveId

required

string format: uuid

orderId

required

string format: uuid

orderNumber

required

string

orderLineId

required

string format: uuid

sequence

required

integer format: int32

locationId

required

string format: uuid

locationCode

required

string

productId

required

string format: uuid

sku

required

string

productName

required

string

lotNumber

required

string

nullable

lpnId

required

string format: uuid

nullable

lpnCode

required

string

nullable

quantity

required

integer format: int32

pickedQuantity

required

integer format: int32

pendingQuantity

required

integer format: int32

openQuantity

required

integer format: int32

shortQuantity

required

integer format: int32

status

required

string

Allowed values: Open Assigned Completed Shorted Cancelled

assignedToType

required

string

nullable

Allowed values: User ApiKey

assignedToId

required

string format: uuid

nullable

assignedWorkerRef

required

string

nullable

toteCode

required

string

nullable

inventoryStatus

required

string

Allowed values: NotPicked Pending Confirmed Rejected

inventoryErrorCode

required

string

nullable

completedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

object

order

required

object

id

required

string format: uuid

orderNumber

required

string

customerReference

required

string

nullable

priority

required

integer format: int32

requestedShipDate

required

string format: date

nullable

status

required

string

Allowed values: New Waved Allocating Allocated AllocationException Picking Picked Packed Shipped Cancelled

waveId

required

string format: uuid

nullable

waveNumber

required

string

nullable

lineCount

required

integer format: int32

totalBaseQuantity

required

integer format: int32

shipToName

required

string

shipToCountryCode

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

tasks

required

Array<object>

object

id

required

string format: uuid

waveId

required

string format: uuid

orderId

required

string format: uuid

orderNumber

required

string

orderLineId

required

string format: uuid

sequence

required

integer format: int32

locationId

required

string format: uuid

locationCode

required

string

productId

required

string format: uuid

sku

required

string

productName

required

string

lotNumber

required

string

nullable

lpnId

required

string format: uuid

nullable

lpnCode

required

string

nullable

quantity

required

integer format: int32

pickedQuantity

required

integer format: int32

pendingQuantity

required

integer format: int32

openQuantity

required

integer format: int32

shortQuantity

required

integer format: int32

status

required

string

Allowed values: Open Assigned Completed Shorted Cancelled

assignedToType

required

string

nullable

Allowed values: User ApiKey

assignedToId

required

string format: uuid

nullable

assignedWorkerRef

required

string

nullable

toteCode

required

string

nullable

inventoryStatus

required

string

Allowed values: NotPicked Pending Confirmed Rejected

inventoryErrorCode

required

string

nullable

completedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "order": {
    "status": "New"
  },
  "tasks": [
    {
      "status": "Open",
      "assignedToType": "User",
      "inventoryStatus": "NotPicked"
    }
  ]
}

object

order

required

object

id

required

string format: uuid

orderNumber

required

string

customerReference

required

string

nullable

priority

required

integer format: int32

requestedShipDate

required

string format: date

nullable

status

required

string

Allowed values: New Waved Allocating Allocated AllocationException Picking Picked Packed Shipped Cancelled

waveId

required

string format: uuid

nullable

waveNumber

required

string

nullable

lineCount

required

integer format: int32

totalBaseQuantity

required

integer format: int32

shipToName

required

string

shipToCountryCode

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

tasks

required

Array<object>

object

id

required

string format: uuid

waveId

required

string format: uuid

orderId

required

string format: uuid

orderNumber

required

string

orderLineId

required

string format: uuid

sequence

required

integer format: int32

locationId

required

string format: uuid

locationCode

required

string

productId

required

string format: uuid

sku

required

string

productName

required

string

lotNumber

required

string

nullable

lpnId

required

string format: uuid

nullable

lpnCode

required

string

nullable

quantity

required

integer format: int32

pickedQuantity

required

integer format: int32

pendingQuantity

required

integer format: int32

openQuantity

required

integer format: int32

shortQuantity

required

integer format: int32

status

required

string

Allowed values: Open Assigned Completed Shorted Cancelled

assignedToType

required

string

nullable

Allowed values: User ApiKey

assignedToId

required

string format: uuid

nullable

assignedWorkerRef

required

string

nullable

toteCode

required

string

nullable

inventoryStatus

required

string

Allowed values: NotPicked Pending Confirmed Rejected

inventoryErrorCode

required

string

nullable

completedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "order": {
    "status": "New"
  },
  "tasks": [
    {
      "status": "Open",
      "assignedToType": "User",
      "inventoryStatus": "NotPicked"
    }
  ]
}

204

No Content

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}