Lister les contingents d'un établissement (pickup% + attrition pending)

GET

/v1/allotments

curl --request GET \
  --url 'https://example.com/v1/allotments?pageSize=20&page=1&status=active&establishmentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

pageSize

integer

>= 1 <= 100

Example

20

page

integer

>= 1

Example

1

status

string

Allowed values: active cutoff_reached released cancelled

establishmentId

required

string format: uuid

Responses

200

Page de contingents

Media type application/json

object

data

required

Array<object>

object

id

required

string format: uuid

establishmentId

required

string format: uuid

channelType

required

string

channelExternalId

string

nullable

allotmentType

required

string

Allowed values: allotment tentative

status

required

string

Allowed values: active cutoff_reached released cancelled

currency

required

string

Allowed values: EUR GBP

periodFrom

required

string format: date

periodTo

required

string format: date

totalUnits

required

integer

complimentaryRooms

required

integer

sellableRoomNights

required

integer

pickupRoomNights

required

integer

cutoffDate

required

string format: date

minimumPickupPercent

required

number

penaltyPerRoomNightCents

string

nullable

cutoffProcessedAt

string format: date-time

nullable

attritionPendingCents

Attrition figée non régularisée (centimes bigint), null si aucune

string

nullable

meta

required

object

page

required

integer

>= 1

pageSize

required

integer

>= 1

total

required

integer

Example

{
  "data": [
    {
      "allotmentType": "allotment",
      "status": "active",
      "currency": "EUR"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 42
  }
}

400

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
}

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
}