createLocation

POST

/locations

curl --request POST \
  --url https://app.dev.buildtrace.eu/api/locations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example", "name": "example", "kind": "example", "notes": "example" }'

Required scope: inventory:write.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

code

required

string

name

required

string

kind

required

string

notes

string

Example ^generated

{
  "code": "example",
  "name": "example",
  "kind": "example",
  "notes": "example"
}

Responses

201

Created

Media typeapplication/json

object

id

required

string format: uuid

code

required

string

name

required

string

kind

required

string

notes

string

isActive

required

boolean

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "code": "example",
  "name": "example",
  "kind": "example",
  "notes": "example",
  "isActive": true
}

400

Invalid: a code that isn’t 1 to 100 letters, digits, dots, dashes or underscores, a blank name, or an unknown kind

Media typeapplication/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

401

Unauthorized

409

Another location already has the code

Media typeapplication/json

object

error

required

string

Example ^generated

{
  "error": "example"
}