Skip to content
jtWMS Docs

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

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
facilityId
required
string format: uuid

Request Body

Section titled “Request Body”
object
workerRef
string
nullable

Example generated

{
  "workerRef": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

object
wave
required
object
id
required
string format: uuid
number
required
string
status
required
string
Allowed values: Planned Releasing Released Completed Cancelled
pickingMode
required
string
Allowed values: Discrete Batch
putWallId
required
string format: uuid
nullable
putWallCode
required
string
nullable
orderCount
required
integer format: int32
pickTaskCount
required
integer format: int32
openPickTaskCount
required
integer format: int32
allocationExceptionCount
required
integer format: int32
releasedAt
required
string format: date-time
nullable
completedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
putWallId
required
string format: uuid
putWallCode
required
string
tasks
required
Array<object>
object
id
required
string format: uuid
waveId
required
string format: uuid
sequence
required
integer format: int32
>= 1 <= 2147483647
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
>= 1 <= 2147483647
pickedQuantity
required
integer format: int32
<= 2147483647
pendingQuantity
required
integer format: int32
<= 2147483647
openQuantity
required
integer format: int32
<= 2147483647
shortQuantity
required
integer format: int32
<= 2147483647
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
orderCount
required
integer format: int32
>= 1 <= 2147483647
pickTaskIds
required
Array<string>
completedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
totes
required
Array<object>
object
code
required
string
facilityId
required
string format: uuid
waveId
required
string format: uuid
waveNumber
required
string
putWallId
required
string format: uuid
putWallCode
required
string
status
required
string
Allowed values: Open Completed Inducted Emptied
orderIds
required
Array<string>
lines
required
Array<object>
object
orderId
required
string format: uuid
orderNumber
required
string
orderLineId
required
string format: uuid
productId
required
string format: uuid
sku
required
string
productName
required
string
lotNumber
required
string
nullable
quantity
required
integer format: int32
<= 2147483647
pendingQuantity
required
integer format: int32
<= 2147483647
putQuantity
required
integer format: int32
<= 2147483647
remainingQuantity
required
integer format: int32
<= 2147483647
completedAt
required
string format: date-time
nullable
inductedAt
required
string format: date-time
nullable
emptiedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

204

Section titled “204”

No Content

400

Section titled “400”

Bad Request

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable

409

Section titled “409”

Conflict

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable