NTAK Reservation event

On this page, we will explore the process of programmatically constructing the NTAK reservation report. We will delve into the steps and techniques required to build the report dynamically through code.

Send this report, when a reservation is created in your PMS, or when a reservation is modified.

Request

POST/v1/accommodations/{accommodation}/reports/ntak/reservation

curl -X POST https://api.ntak.guru/v1/accommodations/99845d23-7ffb-4267-85ef-c8d4ac70e46a/reports/ntak/reservation \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"arrival":"2022-06-15","departure":"2022-06-17","cancelled":false,"guestCount":2,"reservationNumber":34478,"marketSegment":"vacation_individual","reservedAt":"2022-06-02 13:24:32","occurredAt":"2022-06-02 13:24:32","salesChannel":"directly_online","grossAmount":286.2,"nationality":"HU","bookedResidentialUnits":[{"type":"economy","capacity":2}]}'

URL Parameters

Name	Description
`accommodation`	The accommodation `id`

Request body

`arrival`

Type	Format	Description	Required
`string`	`Y-m-d`	Arrival date of the reservation.	Yes

`departure`

Type	Format	Description	Required
`string`	`Y-m-d`	Departure date of the reservation.	Yes

`cancelled`

Type	Description	Required
`boolean`	Is the reservation cancelled?	Yes

`guestCount`

Type	Description	Required
`number`	Number of guests in the reservation. Minimum 1 guest.	Yes

`reservationNumber`

Type	Description	Required
`string` \| `number`	The unique identifier of the reservation.	Yes

`marketSegment`

Type	Description	Required
Market segment	Market segment of the reservation.	Yes

`reservedAt`

Type	Format	Description	Required
`string`	`Y-m-d H:i:s` UTC	Date of the reservation.	Yes

`occurredAt`

Type	Format	Description	Required
`string`	`Y-m-d H:i:s` UTC	Date of the event.	Yes

`salesChannel`

Type	Description	Required
Sales channel	Sales channel of the reservation.	Yes

`grossAmount`

Type	Description	Required
`number`	Gross amount of the reservation.	Yes

⚠️

This value must be converted to HUF.

`nationality`

Type	Description	Required
`string`	The ISO 3166-1 alpha-2 (opens in a new tab) code of the booking person, or `other`	Yes

If the country code does not included in the official list, NTAK.guru will transform it to other.

`bookedResidentialUnits`

Type	Description	Required
`object[]`	List of booked residential units.	Yes

bookedResidentialUnits.*.type

Type Description Required
Residential unit type Type of the residential unit. Yes
bookedResidentialUnits.*.capacity

Type Description Required
number Capacity of the residential unit. Yes

Type	Description	Required
Residential unit type	Type of the residential unit.	Yes

Type	Description	Required
`number`	Capacity of the residential unit.	Yes

{
  "arrival": "2022-06-15",
  "departure": "2022-06-17",
  "cancelled": false,
  "guestCount": 2,
  "reservationNumber": 34478,
  "marketSegment": "vacation_individual",
  "reservedAt": "2022-06-02 13:24:32",
  "occurredAt": "2022-06-02 13:24:32",
  "salesChannel": "directly_online",
  "grossAmount": 286.2,
  "nationality": "HU",
  "bookedResidentialUnits": [
    {
      "type": "economy",
      "capacity": 2
    }
  ]
}

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "messageId": "00000000-0000-0000-0000-000000000000",
  "service": "ntak",
  "status": "peding",
  "reason": "Report arrived from PMS",
  "type": "check_in",
  "context": {
    "arrival": "2022-06-15",
    "departure": "2022-06-17",
    "cancelled": false,
    "guestCount": 2,
    "reservationNumber": 34478,
    "marketSegment": "vacation_individual",
    "reservedAt": "2022-06-02 13:24:32",
    "occurredAt": "2022-06-02 13:24:32",
    "salesChannel": "directly_online",
    "grossAmount": 286.2,
    "nationality": "HU",
    "bookedResidentialUnits": [
      {
        "type": "economy",
        "capacity": 2
      }
    ]
  },
  "response": {
    "foglalasEsemenyResponse": []
  },
  "createdAt": "2024-03-26T12:53:12+00:00",
  "updatedAt": "2024-03-26T12:53:20+00:00"
}

Retry Check In