Skip to main content
POST
/
sites
/
v2
/
bo
Create new site
curl --request POST \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/sites/v2/bo \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "name": "Main site",
  "serialNumber": "123456",
  "establishmentId": 10,
  "types": [
    1,
    1
  ],
  "description": "This is the main site of the establishment.",
  "classifications": [
    "ERT",
    "ERP"
  ]
}
'
{
  "site": {
    "id": 1,
    "name": "Main site",
    "types": [
      1,
      1
    ],
    "classifications": [
      "ERT",
      "ERP"
    ],
    "isEstablishment": true,
    "serialNumber": "123456",
    "sortOrder": 1,
    "establishmentId": 10,
    "archivedAt": "2024-12-10T10:00:00.000Z",
    "deletedAt": "2024-12-15T10:00:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Body

application/json

Details required to create site

​
name
string
required

Name of the site.

Maximum string length: 250
Example:

"Main site"

​
serialNumber
string
required

Serial number of the site.

Maximum string length: 10
Example:

"123456"

​
establishmentId
integer
required

Identifier of the establishment associated with the site.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

10

​
types
enum<number>[]

Types associated with the site (N, P, M, etc.).

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19
Example:
[1, 1]
​
description
string

Description of the site.

Maximum string length: 2000
Example:

"This is the main site of the establishment."

​
classifications
string[]

Classifications associated with the site (ERT, ERP, etc.).

Maximum string length: 50
Example:
["ERT", "ERP"]

Response

201 - application/json

The site has been created

​
site
object
required