Skip to main content

Glossary

This glossary provides definitions for terms used in this documentation.

Terms​

  • Accor OMS API: The Application Programming Interface (API) provided by Accor for managing orders. It serves as the bridge between external systems and Accor's marketplace.

  • Access Token: The string returned after successful authentication, used to authorize API requests.

  • Allergen: A substance that can cause an allergic reaction. The catalog lists allergens separated by commas.

  • AStoreShop: The specific platform used by Accor to manage suppliers and send purchase orders to them.

  • Authentication: The process of verifying the identity of a user or client accessing the OMS API. It is used to ensure that only authorized users can access the API and its resources.

  • Authorization: The process of granting or denying access to specific resources or services within the OMS API. It is used to control what actions users can perform and what data they can access.

  • Bearer: A type of HTTP authorization header used to carry an access token (e.g., Authorization: Bearer <token>).

  • Cart: A temporary collection of items selected by a customer for purchase. The cart contains information about the items, such as the product ID, quantity, and price.

  • Catalog: The comprehensive list of products (1 million+ references) available in the Accor marketplace, including details about hotels, addresses, and delivery schedules.

  • Catalog Authentication: The process of verifying identity to access the product catalog via the SFTP server.

  • Catchment Area: A geographic area defined by postal codes (e.g., 06, 83, 98) used for segmentation filtering.

  • Client Credentials: The username and password (or secret) used by an application to authenticate itself to the SFTP.

  • Client ID / Client Secret: Unique OAuth2 identifiers and secrets provided to the client application to prove its identity during authentication.

  • Companies: The entities listed in the catalog, also referred to as hotels.

  • Company: The entity representing a hotel. It contains details like the Mega Code, name, country, and segmentation filters.

  • Company Address: The physical location details associated with a Company (Hotel). Or the billing address.

  • CORS: Cross-Origin Resource Sharing. A security mechanism that allows web servers to specify which origins are permitted to access resources.

  • CSV File Naming Convention: Files are named with a timestamp in the format YYYY-MM-DD-hh-mm-ss to ensure unique identifiers and chronological ordering.

  • curl: A command-line tool used to transfer data with URLs, commonly used to test API endpoints.

  • Delivery Calendars: The data files within the catalog that contain required information for the delivery-round shipping method. These calendars provide the data required to configure delivery-round shipping.

  • Delivery-round: A specific shipping method or routing method identified in the catalog data.

  • Delivery Method: The method by which products are shipped. Values include delivery-rounds, STD, SERVICES, SDD, extra-shipping-fee, EXP, and punch_out.

  • Endpoint: A specific URL within an API that provides access to a particular resource or service. Endpoints are used to interact with different parts of the API, such as retrieving order details or placing orders.

  • GTIN (Global Trade Item Number): A unique identifier used to identify products.

  • GTIN Type: The specific format of the GTIN (e.g., EAN, UPC, ISBN).

  • Hybrid Approach: The integration strategy that combines two methods: SFTP for large data transfers (Catalog) and REST/JSON APIs for real-time transaction processing (Purchase Orders).

  • Integration: The process of connecting Partner Systems to the Accor marketplace to manage data exchange and business operations (e.g., product catalog updates and purchase orders).

  • Logistic Order: An individual order created for each supplier when a Purchase Order contains products from multiple suppliers. Each Logistic Order is shipped independently by its respective supplier.

  • Mega Code: A unique identifier used for organizations or companies within the system, often associated with price calculations and offers.

  • OAuth2: The authentication protocol (specifically the Authorization Code flow) used to secure access to the API layer, ensuring only authorized clients can interact with the system.

  • OMS: The core system handling orders, including order creation, validation, and status tracking.

  • Offer: The specific pricing deal or promotion linked to an individual product within the catalog.

  • Order: A generic request to purchase products from a supplier. It contains product details (product ID, quantity, price) and customer details (name, email, delivery address).

  • Order Types: The two primary classifications of orders in the system: Purchase Orders and Logistic Orders (the physical result shipped by suppliers).

  • P2P / Procure To Pay (P2P): The end-to-end business process of acquiring goods or services and paying for them, managed here by the Accor OMS system.

  • Partner Systems: The external software or platforms used by Accor's partners to manage their operations and interact with the marketplace. In the context of this API, they are external systems connected to Accor OMS via SFTP and REST/JSON API.

  • Pricing: The section of the catalog containing specific pricing deals between supplier groups and company groups.

  • Procure To Pay (P2P): The end-to-end business process of acquiring goods or services and paying for them, managed here by the Accor OMS system.

  • Products: The items within the catalog that have associated offers and details such as name, description, price, and availability. Since AStoreShop functions as a marketplace, multiple suppliers can offer the same product.

  • Purchase Order (PO): The document representing an order placed with a supplier.

  • REST / JSON: A software architectural style and a set of constraints for creating web services. JSON (JavaScript Object Notation) is a data interchange format used for transmitting information between systems.

  • Request For Proposal (RFP): The formal document outlining the requirements for a project. In this context, it refers to the document that dictates, for instance, the implementation of segmentations.

  • SFTP (Secure File Transfer Protocol): The protocol used to securely transfer large files, such as the product catalog and delivery calendars, from Accor to external systems.

  • SFTP server: The specific server hosting the catalog data for transfer via the Secure File Transfer Protocol.

  • Segmentation: A filter mechanism used to categorize data based on various criteria such as customer type, price, brand, or geographic location.

  • Segmentations: The plural form of Segmentation; refers to the specific set of filters applied to products and offers. There are 10 segmentations you will have to implement on your Product List Page and Product Detail Page.

  • Shop: The item within the catalog. Since AStoreShop functions as a marketplace, multiple suppliers can offer the same Shop (product).

  • Shop State: The operational status of a Shop. Possible values include OPEN, CLOSE, SUSPENDED, and TERMINATED.

  • Status (Company): The current state of a company entity. Possible values include Blocked, Pending Approval, Rejected, and Active.