Détail enrichi d'un contingent (sellable / pickup room-nights)

GET

/v1/allotments/{id}

curl --request GET \
  --url https://example.com/v1/allotments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Détail du contingent

Media type application/json

object

data

required

object

id

required

string format: uuid

establishmentId

required

string format: uuid

ratePlanId

required

string format: uuid

channelType

required

string

Allowed values: to agency group corporate direct

channelExternalId

string

nullable

allotmentType

required

string

Allowed values: allotment tentative

currency

required

string

Allowed values: EUR GBP

periodFrom

required

string format: date

periodTo

required

string format: date

unitAllocations

required

Array<object>

object

unitTypeId

required

string

quantity

required

integer

>= 1

cutoffDate

required

string format: date

minimumPickupPercent

required

number

<= 100

penaltyPerRoomNightCents

Pénalité par room-night en centimes (bigint string)

string

nullable

complimentaryRooms

required

integer

contractualHeadcount

integer

nullable

invoicingMode

required

string

Allowed values: master_single individual_per_sub

billingFolioId

string format: uuid

nullable

status

required

string

Allowed values: active cutoff_reached released cancelled

cutoffProcessedAt

string format: date-time

nullable

sellableRoomNights

required

integer

pickupRoomNights

required

integer

Example

{
  "data": {
    "channelType": "to",
    "allotmentType": "allotment",
    "currency": "EUR",
    "invoicingMode": "master_single",
    "status": "active"
  }
}

401

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
}

403

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
}

404

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