/api/v1/facilities/{facilityId}/outbound/orders (GET)

GET

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

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

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Query Parameters

Status

Array<string>

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

WaveId

string format: uuid

Q

string

Page

integer format: int32

PageSize

integer format: int32

Sort

string

Responses

200

OK

object

items

required

Array<object>

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

page

required

integer format: int32

>= 1

pageSize

required

integer format: int32

>= 1 <= 200

totalCount

required

integer format: int32

object

items

required

Array<object>

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

page

required

integer format: int32

>= 1

pageSize

required

integer format: int32

>= 1 <= 200

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "status": "New"
    }
  ]
}

object

items

required

Array<object>

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

page

required

integer format: int32

>= 1

pageSize

required

integer format: int32

>= 1 <= 200

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "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"
}