GET /v2/catalog

Returns catalog entries (one per lodging) accessible to the authenticated dealer via API out gateway channels, with per-topic last-modified dates in ISO 8601 format (UTC). Each entry tracks when each topic (availabilities, promotions, services, etc.) was last changed during indexation. Use the optional after and before parameters to filter by date range.

Pagination modes

Mode Parameters Description
Cursor (recommended) pageSize + cursor Uses nextCursor from previous response. Guarantees no missed or duplicated entries even if the catalog changes between requests.
No pagination pageSize=0 Returns all matching entries at once.

Resource information

Title Value
Authentication Yes (API key, role ROLE_POPPROD_API)
Response Formats json
HTTP Method GET
Response Object Paginated wrapper containing entries, pageSize, totalCount, nextCursor. Each entry contains lodgingId, indexInterne, lastUpdatedAt, enabled, topicsUpdatedAt.
API Version v2

Resource parameters

Query Parameter Type Required Default Description
after string No empty ISO 8601 date (UTC). When provided, only returns lodgings whose lastUpdatedAt is strictly after this date.
before string No empty ISO 8601 date (UTC). When provided, only returns lodgings whose lastUpdatedAt is strictly before this date.
cursor string No empty Opaque cursor from the previous responses nextCursor. Pass this to get the next page.
pageSize integer No 100 Number of entries per page. Maximum: 1000. Set to 0 to retrieve all entries without pagination.

Response fields (root object)

Field Type Description
entries array Array of catalog entries for the requested page
pageSize integer Number of entries per page
totalCount integer Total number of matching entries across all pages
nextCursor string Opaque cursor to pass as cursor parameter for the next page. null when no more pages.

Response fields (each entry in entries)

Field Type Description
lodgingId long The lodging identifier
indexInterne string The internal index of the lodging (may be null)
lastUpdatedAt string ISO 8601 date (UTC) of the last change across all topics
enabled boolean true if the lodging is EN_DIFFUSION, false if EN_COURS_ELABORATION, BLOCKED or ARRET_VENTES. Lodgings with FIN_CONTRAT or no contract are excluded.
topicsUpdatedAt map Map of topic name to ISO 8601 date (null if never changed)

Response topics

Each entry contains a topicsUpdatedAt map with the following keys. Values are ISO 8601 date strings in UTC. Topics that have never changed appear as null.

Topic Description
availabilities Pricing, stays and availability changes
promotions Promotion changes
services Extra services changes (housework, linen, etc.)
photos Photo changes
lodging General lodging data changes (contract, pax, pack, labels)
location Geolocation and address changes (geo tree, localisation, cadastral/license number)
status Diffusion state changes (published, contract state, indexation order)
rooms Room description changes
features Options and services changes
keycollection Reception information changes
reviews Customer review changes
descriptions General description and language changes

Example Requests

First page with cursor pagination:

https://api.poplidays.com/v2/catalog?pageSize=50

Next page using cursor:

https://api.poplidays.com/v2/catalog?pageSize=50&cursor=1710532800000_1430231

With date filter:

https://api.poplidays.com/v2/catalog?after=2024-03-14T00:00:00.000Z&pageSize=100

All entries (no pagination):

https://api.poplidays.com/v2/catalog?pageSize=0

Example Response (cursor mode)

json

{
    "entries": [
        {
            "lodgingId": 1432154,
            "indexInterne": "FR-1-239-54",
            "lastUpdatedAt": "2024-03-15T20:00:00.000Z",
            "enabled": true,
            "topicsUpdatedAt": {
                "availabilities": "2024-03-15T20:00:00.000Z",
                "promotions": null,
                "services": "2024-03-14T20:00:00.000Z",
                "photos": "2024-03-13T20:00:00.000Z",
                "lodging": "2024-03-15T20:00:00.000Z",
                "location": null,
                "status": "2024-03-15T20:00:00.000Z",
                "rooms": "2024-03-14T20:00:00.000Z",
                "features": "2024-03-13T20:00:00.000Z",
                "keycollection": null,
                "reviews": "2024-03-12T20:00:00.000Z",
                "descriptions": "2024-03-14T20:00:00.000Z"
            }
        },
        {
            "lodgingId": 1430231,
            "indexInterne": "FR-1-185-12",
            "lastUpdatedAt": "2024-03-14T20:00:00.000Z",
            "enabled": true,
            "topicsUpdatedAt": {
                "availabilities": "2024-03-14T20:00:00.000Z",
                "promotions": "2024-03-13T20:00:00.000Z",
                "services": null,
                "photos": "2024-03-12T20:00:00.000Z",
                "lodging": "2024-03-14T20:00:00.000Z",
                "location": "2024-03-12T20:00:00.000Z",
                "status": "2024-03-14T20:00:00.000Z",
                "rooms": null,
                "features": "2024-03-13T20:00:00.000Z",
                "keycollection": "2024-03-12T20:00:00.000Z",
                "reviews": null,
                "descriptions": "2024-03-13T20:00:00.000Z"
            }
        }
    ],
    "pageSize": 50,
    "totalCount": 1234,
    "nextCursor": "1710446400000_1430231"
}