/api/v1/facilities/{facilityId}/outbound/waves (POST)

POST

/api/v1/facilities/{facilityId}/outbound/waves

const url = 'https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/outbound/waves';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"orderIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"templateId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","release":true,"pickingMode":"Discrete","putWallId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/outbound/waves \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "orderIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "release": true, "pickingMode": "Discrete", "putWallId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

Bearer

Parameters

Path Parameters

facilityId

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

orderIds

Array<string>

nullable

templateId

string format: uuid

nullable

release

boolean

pickingMode

string

nullable

Allowed values: Discrete Batch

putWallId

string format: uuid

nullable

Responses

201

Created

object

required

string format: uuid

facilityId

required

string format: uuid

number

required

string

status

required

string

Allowed values: Planned Releasing Released Completed Cancelled

templateId

required

string format: uuid

nullable

pickingMode

required

string

Allowed values: Discrete Batch

putWallId

required

string format: uuid

nullable

putWallCode

required

string

nullable

orders

required

Array<object>

object

orderId

required

string format: uuid

orderNumber

required

string

priority

required

integer format: int32

status

required

string

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

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

updatedAt

required

string format: date-time

object

required

string format: uuid

facilityId

required

string format: uuid

number

required

string

status

required

string

Allowed values: Planned Releasing Released Completed Cancelled

templateId

required

string format: uuid

nullable

pickingMode

required

string

Allowed values: Discrete Batch

putWallId

required

string format: uuid

nullable

putWallCode

required

string

nullable

orders

required

Array<object>

object

orderId

required

string format: uuid

orderNumber

required

string

priority

required

integer format: int32

status

required

string

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

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

updatedAt

required

string format: date-time

Example

{
  "status": "Planned",
  "pickingMode": "Discrete",
  "orders": [
    {
      "status": "New"
    }
  ]
}

object

required

string format: uuid

facilityId

required

string format: uuid

number

required

string

status

required

string

Allowed values: Planned Releasing Released Completed Cancelled

templateId

required

string format: uuid

nullable

pickingMode

required

string

Allowed values: Discrete Batch

putWallId

required

string format: uuid

nullable

putWallCode

required

string

nullable

orders

required

Array<object>

object

orderId

required

string format: uuid

orderNumber

required

string

priority

required

integer format: int32

status

required

string

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

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

updatedAt

required

string format: date-time

Example

{
  "status": "Planned",
  "pickingMode": "Discrete",
  "orders": [
    {
      "status": "New"
    }
  ]
}

202

Accepted

object

required

string format: uuid

facilityId

required

string format: uuid

number

required

string

status

required

string

Allowed values: Planned Releasing Released Completed Cancelled

templateId

required

string format: uuid

nullable

pickingMode

required

string

Allowed values: Discrete Batch

putWallId

required

string format: uuid

nullable

putWallCode

required

string

nullable

orders

required

Array<object>

object

orderId

required

string format: uuid

orderNumber

required

string

priority

required

integer format: int32

status

required

string

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

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

updatedAt

required

string format: date-time

object

required

string format: uuid

facilityId

required

string format: uuid

number

required

string

status

required

string

Allowed values: Planned Releasing Released Completed Cancelled

templateId

required

string format: uuid

nullable

pickingMode

required

string

Allowed values: Discrete Batch

putWallId

required

string format: uuid

nullable

putWallCode

required

string

nullable

orders

required

Array<object>

object

orderId

required

string format: uuid

orderNumber

required

string

priority

required

integer format: int32

status

required

string

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

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

updatedAt

required

string format: date-time

Example

{
  "status": "Planned",
  "pickingMode": "Discrete",
  "orders": [
    {
      "status": "New"
    }
  ]
}

object

required

string format: uuid

facilityId

required

string format: uuid

number

required

string

status

required

string

Allowed values: Planned Releasing Released Completed Cancelled

templateId

required

string format: uuid

nullable

pickingMode

required

string

Allowed values: Discrete Batch

putWallId

required

string format: uuid

nullable

putWallCode

required

string

nullable

orders

required

Array<object>

object

orderId

required

string format: uuid

orderNumber

required

string

priority

required

integer format: int32

status

required

string

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

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

updatedAt

required

string format: date-time

Example

{
  "status": "Planned",
  "pickingMode": "Discrete",
  "orders": [
    {
      "status": "New"
    }
  ]
}

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

503

Service Unavailable

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

/api/v1/facilities/{facilityId}/outbound/waves (POST)

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

201

Example

Example

202

Example

Example

400

Example generated

Example generated

404

Example generated

Example generated

409

Example generated

Example generated

422

Example generated

Example generated

503

Example generated

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated