/api/v1/facilities/{facilityId}/outbound/put-walls/{putWallId}/inductions

POST

/api/v1/facilities/{facilityId}/outbound/put-walls/{putWallId}/inductions

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

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

putWallId

required

string format: uuid

Header Parameters

Idempotency-Key

string

Optional, 1 to 128 characters (the IETF Idempotency-Key header). A repeat with the same key and payload within 24 hours answers the stored response and changes nothing; the same key with a different payload is 422 idempotency_key_reused; a repeat while the first is still in flight is 409 idempotency_request_in_progress.

Request Body^required

object

toteCode

string

workerRef

string

nullable

Example ^generated

{
  "toteCode": "example",
  "workerRef": "example"
}

object

toteCode

string

workerRef

string

nullable

Example ^generated

{
  "toteCode": "example",
  "workerRef": "example"
}

object

toteCode

string

workerRef

string

nullable

Example ^generated

{
  "toteCode": "example",
  "workerRef": "example"
}

Responses

200

OK

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

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

Example

{
  "status": "Open"
}

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

Example

{
  "status": "Open"
}

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"
}

404

Not Found

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"
}

422

Unprocessable Entity

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"
}