/api/v1/facilities (POST)

POST

/api/v1/facilities

curl --request POST \
  --url https://example.com/api/v1/facilities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/yaml' \
  --data '{ "name": "example", "code": "example", "facilityType": "Warehouse", "address": { "line1": "example", "line2": "example", "city": "example", "state": "example", "postalCode": "example", "country": "example" }, "timeZone": "example" }'

Authorizations

• Bearer

Request Body^required

object

name

required

string

code

required

string

facilityType

required

string

Allowed values: Warehouse DistributionCenter FulfillmentCenter

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

object

name

required

string

code

required

string

facilityType

required

string

Allowed values: Warehouse DistributionCenter FulfillmentCenter

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

object

name

required

string

code

required

string

facilityType

required

string

Allowed values: Warehouse DistributionCenter FulfillmentCenter

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

object

name

required

string

code

required

string

facilityType

required

string

Allowed values: Warehouse DistributionCenter FulfillmentCenter

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

object

name

required

string

code

required

string

facilityType

required

string

Allowed values: Warehouse DistributionCenter FulfillmentCenter

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

Responses

201

Created

object

id

required

string format: uuid

name

required

string

code

required

string

facilityType

required

string

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

locationCodePattern

required

string

status

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

object

id

required

string format: uuid

name

required

string

code

required

string

facilityType

required

string

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

locationCodePattern

required

string

status

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "code": "example",
  "facilityType": "example",
  "address": {
    "line1": "example",
    "line2": "example",
    "city": "example",
    "state": "example",
    "postalCode": "example",
    "country": "example"
  },
  "timeZone": "example",
  "locationCodePattern": "example",
  "status": "example",
  "createdAt": "2026-04-15T12:00:00Z",
  "updatedAt": "2026-04-15T12:00:00Z"
}

object

id

required

string format: uuid

name

required

string

code

required

string

facilityType

required

string

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

locationCodePattern

required

string

status

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "code": "example",
  "facilityType": "example",
  "address": {
    "line1": "example",
    "line2": "example",
    "city": "example",
    "state": "example",
    "postalCode": "example",
    "country": "example"
  },
  "timeZone": "example",
  "locationCodePattern": "example",
  "status": "example",
  "createdAt": "2026-04-15T12:00:00Z",
  "updatedAt": "2026-04-15T12:00:00Z"
}

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

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