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

POST

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

curl --request POST \
  --url https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/outbound/waves/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

waveId

required

string format: uuid

Responses

200

OK

object

id

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

id

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

id

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

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