Aller au contenu

Lister les unités physiques d'un établissement

GET
/v1/inventory/units
curl --request GET \
--url 'https://example.com/v1/inventory/units?pageSize=20&page=1&establishmentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--header 'X-API-Key: <X-API-Key>'
pageSize
integer
>= 1 <= 100
Example
20
page
integer
>= 1
Example
1
status
string
unitTypeId
string format: uuid
establishmentId
required
string format: uuid

Page d’unités physiques

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
unitTypeId
required
string format: uuid
establishmentId
string format: uuid
code
required
string
name
required
string
maxOccupancy
integer
status
required
string
meta
required
object
page
required
integer
>= 1
pageSize
required
integer
>= 1
total
required
integer
Example
{
"meta": {
"page": 1,
"pageSize": 20,
"total": 42
}
}

Paramètres invalides

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Non authentifié

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Permission refusée ou scope IDOR

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}