📘 User Guide Template
- Document Purpose 🟢 No changes required in this section.
This guide provides business, functional and technical context to help API consumers understand and integrate the API. It complements the OpenAPI specification and is part of the mandatory documentation set for each version ( Major.Minor.Patch ).
- Target Audience 🟢 No changes required in this section.
Profile Role Product Owner Understand the business scope and value of the API Developer Implement and integrate the API QA / Architect Validate expected behaviors and technical compliance Customer Connect API (CCA) Support API consumers during onboarding and integration 3. API Overview 🔴 This section must be completed by the feature team.
3.1 Business Context The API provides access to the breadcrumb object for a given destination page, enabling front-end applications to display contextual navigation paths based on the page’s position within the site hierarchy. V2 now retrieves breadcrumb data from middleware instead of Content Fragments. Usage context : Hotel details sheet page 3.2 Main Features List of supported operations Retrieve the breadcrumb object for a destination * 3.3 Known Limitations Functional constraints (same as V1). 4. Access & Security 🔴 This section must be completed by the feature team.
4.1 Access Requirements Requirement Provided by Accor Consumer Action Required Client ID / API Key ✅ 🔲 Request via onboarding 4.2 Authentication & Headers Auth method: API Key Required headers: apiKey 5. API Behavior 5.1 Traceability & Telemetry 5.2 Health Check 6. Endpoints 🔴 This section must be completed by the feature team.
/ecom/v2/destination-breadcrumb (GET) Description Return the breadcrumb object for a destination.
Note: Uses middleware to retrieve data, still backward compatible with V1 request parameters.
Request Rules Mandatory: siteCode , geoCode , lang or pageType Response Behavior Returns 404 status code if no breadcrumb object is found for the given destination 7. Usage Examples 🔴 This section must be completed by the feature team.
🔍 Get a breadcrumb for a destination GET /ecom/v2/destination-breadcrumb?siteCode=all&geoCode=V2996&lang=en&pageType=PDH { "geoCode": "V2996", "links": [ { "geoType": "WORLD", "href": "https://buildqa-all.accor.com/a/en/destination/world/hotels.html", "label": "Hotels" }, { "geoType": "CONTINENT", "href": "https://buildqa-all.accor.com/a/en/destination/continent/hotels-europe-c03.html", "label": "Europe" }, { "geoType": "COUNTRY", "href": "https://buildqa-all.accor.com/a/en/destination/country/hotels-france-pfr.html", "label": "France" }, { "geoType": "REGION", "href": "https://buildqa-all.accor.com/a/en/destination/region/hotels-ile-de-france-r03312.html", "label": "Ile-de-France" }, { "geoType": "CITY", "href": "", "label": "Paris" } ] } 8. Error Codes 🔴 This section must be completed by the feature team.
HTTP Code Error Code Description Recommended Action 400 INVALID_INPUT Invalid or missing fields Check input data 401 UNAUTHORIZED Invalid or expired token Refresh or re-authenticate 404 NOT_FOUND Entity does not exist Check resource ID 500 INTERNAL_ERROR Unexpected backend issue Retry or escalate