V1 vs V2 Differences

This section highlights the key differences between Open API V1 and Open API V2 for POS integration.

---

1. Endpoint Structure

• V1: 4 different endpoints for thealth check, synchronization, validate order and create order.
• V2: Only 2 endpoints for orders and menu. Suggested to simplified and standardized under /v2/order and /v2/menu.

---

2. Authentication

• V1: API keys exchange using different methods by operations.
• V2: API keys required in headers (x-api-key) for all requests.

---

3. Order Flow

• V1: Synchronous calls.
• V2: Introduces asynchronous calls and acknoledgement responses.

---

4. Menu Synchronization

• V1: Fetch the menu as a flatlist of items.
• V2: Fully refactored menu model with clear hierarchy:
  • Main Items
  • Variations
  • Modifiers (Options & Extras)

---

5. Payload Structure

• V1: Mixed identifiers (companyProfileId vs locationId).
• V2: Uses locationId consistently and introduces requestId for traceability. More structured payload to ease providing support and reduce misundertanding.

---

6. Error Handling

• V1: No mandatory error response format.
• V2: Standardized error structure:

{
  "errors": [
    {
      "code": "TIMEOUT",
      "message": "POS did not respond in time"
    }
  ]
}

---

7. Special Use Cases

• V1: N/A
• V2: More detailed documentation on Special Use Cases.

---

8. Documentation & Developer Experience

• V1: Swagger-based, less structured.
• V2: Examples, Payloads and Postman collection provided.

---