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

POST

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

curl --request POST \
  --url https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/outbound/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "orderNumber": "example", "customerReference": "example", "priority": 1, "requestedShipDate": "2026-04-15", "shipTo": { "name": "example", "company": "example", "line1": "example", "line2": "example", "city": "example", "region": "example", "postalCode": "example", "countryCode": "example", "phone": "example", "email": "example" }, "carrierCode": "example", "serviceLevel": "example", "lines": [ { "lineNumber": 1, "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sku": "example", "quantity": 1, "unitOfMeasureCode": "example", "lotNumber": "example" } ] }'

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Request Body^required

object

orderNumber

string

nullable

customerReference

string

nullable

priority

integer format: int32

nullable

requestedShipDate

string format: date

nullable

shipTo

object

name

string

nullable

company

string

nullable

line1

string

nullable

line2

string

nullable

city

string

nullable

region

string

nullable

postalCode

string

nullable

countryCode

string

nullable

phone

string

nullable

email

string

nullable

carrierCode

string

nullable

serviceLevel

string

nullable

lines

Array<object>

nullable

object

lineNumber

integer format: int32

nullable

productId

string format: uuid

nullable

sku

string

nullable

quantity

integer format: int32

nullable

unitOfMeasureCode

string

nullable

lotNumber

string

nullable

Example ^generated

{
  "orderNumber": "example",
  "customerReference": "example",
  "priority": 1,
  "requestedShipDate": "2026-04-15",
  "shipTo": {
    "name": "example",
    "company": "example",
    "line1": "example",
    "line2": "example",
    "city": "example",
    "region": "example",
    "postalCode": "example",
    "countryCode": "example",
    "phone": "example",
    "email": "example"
  },
  "carrierCode": "example",
  "serviceLevel": "example",
  "lines": [
    {
      "lineNumber": 1,
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "sku": "example",
      "quantity": 1,
      "unitOfMeasureCode": "example",
      "lotNumber": "example"
    }
  ]
}

object

orderNumber

string

nullable

customerReference

string

nullable

priority

integer format: int32

nullable

requestedShipDate

string format: date

nullable

shipTo

object

name

string

nullable

company

string

nullable

line1

string

nullable

line2

string

nullable

city

string

nullable

region

string

nullable

postalCode

string

nullable

countryCode

string

nullable

phone

string

nullable

email

string

nullable

carrierCode

string

nullable

serviceLevel

string

nullable

lines

Array<object>

nullable

object

lineNumber

integer format: int32

nullable

productId

string format: uuid

nullable

sku

string

nullable

quantity

integer format: int32

nullable

unitOfMeasureCode

string

nullable

lotNumber

string

nullable

Example ^generated

{
  "orderNumber": "example",
  "customerReference": "example",
  "priority": 1,
  "requestedShipDate": "2026-04-15",
  "shipTo": {
    "name": "example",
    "company": "example",
    "line1": "example",
    "line2": "example",
    "city": "example",
    "region": "example",
    "postalCode": "example",
    "countryCode": "example",
    "phone": "example",
    "email": "example"
  },
  "carrierCode": "example",
  "serviceLevel": "example",
  "lines": [
    {
      "lineNumber": 1,
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "sku": "example",
      "quantity": 1,
      "unitOfMeasureCode": "example",
      "lotNumber": "example"
    }
  ]
}

object

orderNumber

string

nullable

customerReference

string

nullable

priority

integer format: int32

nullable

requestedShipDate

string format: date

nullable

shipTo

object

name

string

nullable

company

string

nullable

line1

string

nullable

line2

string

nullable

city

string

nullable

region

string

nullable

postalCode

string

nullable

countryCode

string

nullable

phone

string

nullable

email

string

nullable

carrierCode

string

nullable

serviceLevel

string

nullable

lines

Array<object>

nullable

object

lineNumber

integer format: int32

nullable

productId

string format: uuid

nullable

sku

string

nullable

quantity

integer format: int32

nullable

unitOfMeasureCode

string

nullable

lotNumber

string

nullable

Example ^generated

{
  "orderNumber": "example",
  "customerReference": "example",
  "priority": 1,
  "requestedShipDate": "2026-04-15",
  "shipTo": {
    "name": "example",
    "company": "example",
    "line1": "example",
    "line2": "example",
    "city": "example",
    "region": "example",
    "postalCode": "example",
    "countryCode": "example",
    "phone": "example",
    "email": "example"
  },
  "carrierCode": "example",
  "serviceLevel": "example",
  "lines": [
    {
      "lineNumber": 1,
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "sku": "example",
      "quantity": 1,
      "unitOfMeasureCode": "example",
      "lotNumber": "example"
    }
  ]
}

Responses

200

OK

object

id

required

string format: uuid

facilityId

required

string format: uuid

orderNumber

required

string

customerReference

required

string

nullable

priority

required

integer format: int32

requestedShipDate

required

string format: date

nullable

shipTo

required

object

name

required

string

company

required

string

nullable

line1

required

string

line2

required

string

nullable

city

required

string

region

required

string

nullable

postalCode

required

string

nullable

countryCode

required

string

phone

required

string

nullable

email

required

string

nullable

carrierCode

required

string

nullable

serviceLevel

required

string

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

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lines

required

Array<object>

object

id

required

string format: uuid

lineNumber

required

integer format: int32

productId

required

string format: uuid

sku

required

string

productName

required

string

quantity

required

integer format: int32

unitOfMeasureCode

required

string

baseQuantity

required

integer format: int32

lotNumber

required

string

nullable

allocatedQuantity

required

integer format: int32

pickedQuantity

required

integer format: int32

packedQuantity

required

integer format: int32

shippedQuantity

required

integer format: int32

allocationStatus

required

string

Allowed values: NotRequested Requested Allocated Rejected Released Issued

allocationErrorCode

required

string

nullable

object

id

required

string format: uuid

facilityId

required

string format: uuid

orderNumber

required

string

customerReference

required

string

nullable

priority

required

integer format: int32

requestedShipDate

required

string format: date

nullable

shipTo

required

object

name

required

string

company

required

string

nullable

line1

required

string

line2

required

string

nullable

city

required

string

region

required

string

nullable

postalCode

required

string

nullable

countryCode

required

string

phone

required

string

nullable

email

required

string

nullable

carrierCode

required

string

nullable

serviceLevel

required

string

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

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lines

required

Array<object>

object

id

required

string format: uuid

lineNumber

required

integer format: int32

productId

required

string format: uuid

sku

required

string

productName

required

string

quantity

required

integer format: int32

unitOfMeasureCode

required

string

baseQuantity

required

integer format: int32

lotNumber

required

string

nullable

allocatedQuantity

required

integer format: int32

pickedQuantity

required

integer format: int32

packedQuantity

required

integer format: int32

shippedQuantity

required

integer format: int32

allocationStatus

required

string

Allowed values: NotRequested Requested Allocated Rejected Released Issued

allocationErrorCode

required

string

nullable

Example

{
  "status": "New",
  "lines": [
    {
      "allocationStatus": "NotRequested"
    }
  ]
}

object

id

required

string format: uuid

facilityId

required

string format: uuid

orderNumber

required

string

customerReference

required

string

nullable

priority

required

integer format: int32

requestedShipDate

required

string format: date

nullable

shipTo

required

object

name

required

string

company

required

string

nullable

line1

required

string

line2

required

string

nullable

city

required

string

region

required

string

nullable

postalCode

required

string

nullable

countryCode

required

string

phone

required

string

nullable

email

required

string

nullable

carrierCode

required

string

nullable

serviceLevel

required

string

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

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lines

required

Array<object>

object

id

required

string format: uuid

lineNumber

required

integer format: int32

productId

required

string format: uuid

sku

required

string

productName

required

string

quantity

required

integer format: int32

unitOfMeasureCode

required

string

baseQuantity

required

integer format: int32

lotNumber

required

string

nullable

allocatedQuantity

required

integer format: int32

pickedQuantity

required

integer format: int32

packedQuantity

required

integer format: int32

shippedQuantity

required

integer format: int32

allocationStatus

required

string

Allowed values: NotRequested Requested Allocated Rejected Released Issued

allocationErrorCode

required

string

nullable

Example

{
  "status": "New",
  "lines": [
    {
      "allocationStatus": "NotRequested"
    }
  ]
}

201

Created

object

id

required

string format: uuid

facilityId

required

string format: uuid

orderNumber

required

string

customerReference

required

string

nullable

priority

required

integer format: int32

requestedShipDate

required

string format: date

nullable

shipTo

required

object

name

required

string

company

required

string

nullable

line1

required

string

line2

required

string

nullable

city

required

string

region

required

string

nullable

postalCode

required

string

nullable

countryCode

required

string

phone

required

string

nullable

email

required

string

nullable

carrierCode

required

string

nullable

serviceLevel

required

string

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

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lines

required

Array<object>

object

id

required

string format: uuid

lineNumber

required

integer format: int32

productId

required

string format: uuid

sku

required

string

productName

required

string

quantity

required

integer format: int32

unitOfMeasureCode

required

string

baseQuantity

required

integer format: int32

lotNumber

required

string

nullable

allocatedQuantity

required

integer format: int32

pickedQuantity

required

integer format: int32

packedQuantity

required

integer format: int32

shippedQuantity

required

integer format: int32

allocationStatus

required

string

Allowed values: NotRequested Requested Allocated Rejected Released Issued

allocationErrorCode

required

string

nullable

object

id

required

string format: uuid

facilityId

required

string format: uuid

orderNumber

required

string

customerReference

required

string

nullable

priority

required

integer format: int32

requestedShipDate

required

string format: date

nullable

shipTo

required

object

name

required

string

company

required

string

nullable

line1

required

string

line2

required

string

nullable

city

required

string

region

required

string

nullable

postalCode

required

string

nullable

countryCode

required

string

phone

required

string

nullable

email

required

string

nullable

carrierCode

required

string

nullable

serviceLevel

required

string

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

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lines

required

Array<object>

object

id

required

string format: uuid

lineNumber

required

integer format: int32

productId

required

string format: uuid

sku

required

string

productName

required

string

quantity

required

integer format: int32

unitOfMeasureCode

required

string

baseQuantity

required

integer format: int32

lotNumber

required

string

nullable

allocatedQuantity

required

integer format: int32

pickedQuantity

required

integer format: int32

packedQuantity

required

integer format: int32

shippedQuantity

required

integer format: int32

allocationStatus

required

string

Allowed values: NotRequested Requested Allocated Rejected Released Issued

allocationErrorCode

required

string

nullable

Example

{
  "status": "New",
  "lines": [
    {
      "allocationStatus": "NotRequested"
    }
  ]
}

object

id

required

string format: uuid

facilityId

required

string format: uuid

orderNumber

required

string

customerReference

required

string

nullable

priority

required

integer format: int32

requestedShipDate

required

string format: date

nullable

shipTo

required

object

name

required

string

company

required

string

nullable

line1

required

string

line2

required

string

nullable

city

required

string

region

required

string

nullable

postalCode

required

string

nullable

countryCode

required

string

phone

required

string

nullable

email

required

string

nullable

carrierCode

required

string

nullable

serviceLevel

required

string

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

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lines

required

Array<object>

object

id

required

string format: uuid

lineNumber

required

integer format: int32

productId

required

string format: uuid

sku

required

string

productName

required

string

quantity

required

integer format: int32

unitOfMeasureCode

required

string

baseQuantity

required

integer format: int32

lotNumber

required

string

nullable

allocatedQuantity

required

integer format: int32

pickedQuantity

required

integer format: int32

packedQuantity

required

integer format: int32

shippedQuantity

required

integer format: int32

allocationStatus

required

string

Allowed values: NotRequested Requested Allocated Rejected Released Issued

allocationErrorCode

required

string

nullable

Example

{
  "status": "New",
  "lines": [
    {
      "allocationStatus": "NotRequested"
    }
  ]
}

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

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