Aller au contenu

Détail d'un type d'unité + ses attributs descriptifs (surface, couchage, etc.)

GET
/v1/inventory/unit-types/{id}
curl --request GET \
--url https://example.com/v1/inventory/unit-types/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'X-API-Key: <X-API-Key>'
id
required
string format: uuid

Détail du type d’unité

Media type application/json
object
data
required
object
id
required
string format: uuid
establishmentId
required
string format: uuid
code
required
string
name
required
string
format
required
string
Allowed values: room pitch apartment chalet mobile_home glamping
baseCapacity
required
integer
headcountBillingMode
string
housekeepingApplicable
boolean
turnoverGapDays
required

Carence entre occupations (nuits retenues à la vente après un check-out). 0 = aucune.

integer
<= 30
status
required
string
Allowed values: active inactive
unitsCount
required
integer
attributes
required

Attributs EAV de niveau type (surface_sqm, bed_config, bedroom_count, sleeps…)

Array<object>
object
code
required
string
label
required
string
dataType
required
string
Allowed values: text number boolean date enum multi_enum
value

Valeur primitive (string/number/boolean/date) ; null pour enum/multi_enum.

nullable
optionCode
string
optionLabel
string
optionCodes
Array<string>
optionLabels
Array<string>
Example
{
"data": {
"format": "room",
"status": "active",
"attributes": [
{
"dataType": "text"
}
]
}
}

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
}

Type d’unité introuvable

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
}