Integration Middleware Plugins API

https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api
Admin
Integration Middleware Plugins API is an HTTP API service by Delivery Hero that allows Point-of-Sale...
Tokens:46,807
Snippets:248
Trust Score:6.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Main Product Example (YAML)

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Example of a main product definition in YAML. Main products are identified by the absence of a 'parent' field.

```yaml
PRODUCT_1:
id: PRODUCT_1
type: Product
title:
  default: My first product
active: true
isExpressItem: true
isPrepackedItem: true
excludeDishInformation: true
price: '1.50'
variants:
  PRODUCT_VARIANT_1:
    id: PRODUCT_VARIANT_1
    type: Product

```

--------------------------------

### Talabat Catalog Topping Example (YAML)

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Example of a Talabat catalog structure with nested toppings for coffee beverages. Demonstrates how to define products, toppings, and their relationships, including quantity constraints.

```yaml
items:
  HOT_CARAMEL:
    id: HOT_CARAMEL
    type: Product
    price: 23
    title:
      default: Hot Caramel
    toppings:
      HOT_CARAMEL_SIZE:
        id: HOT_CARAMEL_SIZE
        type: Topping
  HOT_CARAMEL_SIZE:
    id: HOT_CARAMEL_SIZE
    type: Topping
    title:
      default: Size (Choose 1)
    quantity:
      min: 1
      max: 1
    products:
      SIZE_GRANDE:
        id: SIZE_GRANDE
        type: Product
      SIZE_VENTI:
        id: SIZE_VENTI
        type: Product
  SIZE_GRANDE:
    id: SIZE_GRANDE
    type: Product
    title:
      default: Grande
    toppings:
      ESPRESSO_SHOT:
        id: ESPRESSO_SHOT
        type: Topping
      COFFEE_TYPE:
        id: COFFEE_TYPE
        type: Topping
      MILK_ALTERNATIVE:
        id: MILK_ALTERNATIVE
        type: Topping
  SIZE_VENTI:
    id: SIZE_VENTI
    type: Product
    title:
      default: Venti
    price: 3
  ESPRESSO_SHOT:
    id: ESPRESSO_SHOT
    type: Topping
    quantity:
      min: 1
      max: 1
    title:
      default: Add Espresso Shot
    products:
      ADD_ESPRESSO_SHOT:
        id: ADD_ESPRESSO_SHOT
        type: Product
  COFFEE_TYPE:
    id: COFFEE_TYPE
    type: Topping
    quantity:
      min: 1
      max: 1
    title:
      default: Choose your Coffee Type (choose up to 1 item)
    products:
      ADD_SIGNATURE_ESPRESSO:
        id: ADD_SIGNATURE_ESPRESSO
        type: Product
      ADD_DECAF_ESPRESSO:
        id: ADD_DECAF_ESPRESSO
        type: Product
  MILK_ALTERNATIVE:
    id: MILK_ALTERNATIVE
    type: Topping
    title:
      default: Milk & Diary Alternatives (choose up to 1 item)
    quantity:
      min: 1
      max: 1
    products:
      ADD_WHOLE_MILK:
        id: ADD_WHOLE_MILK
        type: Product
      ADD_SKIMMED_MILK:
        id: ADD_SKIMMED_MILK
        type: Product
      ADD_SOY_MILK:
        id: ADD_SOY_MILK
        type: Product
  ADD_ESPRESSO_SHOT:
    id: ADD_ESPRESSO_SHOT
    type: Product
    title:
      default: Add Espresso Shot
    price: 6
  ADD_SIGNATURE_ESPRESSO:
    id: ADD_SIGNATURE_ESPRESSO
    type: Product
    title:
      default: Signature Espresso
  ADD_DECAF_ESPRESSO:
    id: ADD_DECAF_ESPRESSO
    type: Product
    title:
      default: Decaf Espresso (Dark Roast)
  ADD_WHOLE_MILK:
    id: ADD_WHOLE_MILK
    type: Product
    title:
      default: Whole Milk
  ADD_SKIMMED_MILK:
    id: ADD_SKIMMED_MILK
    type: Product
    title:
      default: Skimmed Milk
  ADD_SOY_MILK:
    id: ADD_SOY_MILK
    type: Product
    title:
      default: Skimmed Milk

```

--------------------------------

### Catalog Import Example (YAML)

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

An example of catalog data structure in YAML format, illustrating products, menus, and their relationships. This format is used for readability before conversion to JSON for the API.

```yaml
  hamburger:
    id: hamburger
    type: Product
    title: A tasty Hamburger
    price: "1.20"
  cheesburger:
    id: cheeseburger
    type: Product
    title: A tasty Cheesburger
    prive: 1.40
  lunchmenu:
    id: lunchmenu
    title: The Lunch Menu
    products:
      # a reference to add the hamburger to the menu
      hamburger:
        id: hamburger
        type: Product
        order: 1
      cheeseburger:
        id: cheeseburger
        type: Product
        order: 2
  ...
```

--------------------------------

### Product Variant Example (YAML)

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Example of a product variant definition in YAML. Variants are of type 'Product' and must include a 'parent' field referencing the main product.

```yaml
PRODUCT_VARIANT_1:
id: PRODUCT_VARIANT_1
type: Product
title:
  default: My first product variant
active: true
isExpressItem: true
isPrepackedItem: true
excludeDishInformation: true
price: '1.50'
parent:
  id: PRODUCT_1
  type: Product

```

--------------------------------

### Get Catalog Import Logs API Endpoint

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Example of how to retrieve catalog import logs for a specific vendor. Note the path and query parameters for filtering and sorting.

```bash
GET https://integration-middleware.stg.restaurant-partners.com/v2/chains/{chainCode}/vendors/{posVendorId}/menu-import-logs?from=2016-01-02T00:00:00Z&to=2016-01-02T23:59:00Z&limit=5&sort=desc
```

--------------------------------

### Retrieve Restaurant Availability Response

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Example JSON response structure for the GET availability endpoint, showing current states and allowed reasons.

```json
[
  {
    "availabilityState": "UNKNOWN",
    "availabilityStates": [
      "CLOSED_UNTIL",
      "CLOSED",
      "OPEN"
    ],
    "changeable": false,
    "closedReason": "OTHER",
    "closingMinutes": [
      240,
      720,
      120,
      60,
      30
    ],
    "closingReasons": [
      "TOO_BUSY_KITCHEN",
      "CLOSED",
      "TOO_BUSY_NO_DRIVERS",
      "TECHNICAL_PROBLEM",
      "UPDATES_IN_MENU",
      "OTHER"
    ],
    "platformId": "12",
    "platformKey": "TB",
    "platformRestaurantId": "123456789",
    "platformType": "TALABAT"
  },
  {
    "availabilityState": "OPEN",
    "availabilityStates": [
      "CLOSED_UNTIL",
      "OPEN"
    ],
    "changeable": true,
    "closingMinutes": [
      120,
      60,
      30
    ],
    "closingReasons": [
      "OTHER"
    ],
    "platformId": "36",
    "platformKey": "FO_DE",
    "platformRestaurantId": "kg6y",
    "platformType": "FOODORA"
  },
  {
    "availabilityState": "OPEN",
    "availabilityStates": [
      "CLOSED_UNTIL",
      "CLOSED_TODAY",
      "OPEN"
    ],
    "changeable": true,
    "closingMinutes": [
      120,
      60,
      30
    ],
    "closingReasons": [
      "TOO_BUSY_KITCHEN",
      "CLOSED",
      "TOO_BUSY_NO_DRIVERS",
      "TECHNICAL_PROBLEM",
      "UPDATES_IN_MENU",
      "OTHER"
    ],
    "platformId": "1",
    "platformKey": "LH_DE",
    "platformRestaurantId": "40788",
    "platformType": "DELIVERY_HERO"
  }
]
```

--------------------------------

### Catalog Validation Failure Example (YAML)

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

An example demonstrating a catalog structure that will fail validation because products and variants do not belong to any category. The 'expectedErrorMessages' field indicates the anticipated validation outcome.

```yaml
catalog:
  items:
    PRODUCT_1:
      id: PRODUCT_1
      type: Product
    title:
      default: My first product
    active: true
    isExpressItem: true
isPrepackedItem: true
excludeDishInformation: true
price: '1.50'
    variants:
      PRODUCT_VARIANT_1:
        id: PRODUCT_VARIANT_1
        type: Product
    PRODUCT_VARIANT_1:
      id: PRODUCT_VARIANT_1
      type: Product
      title:
        default: My first product variant
      active: true
      isExpressItem: true
isPrepackedItem: true
excludeDishInformation: true
price: '1.50'
      parent:
        id: PRODUCT_1
        type: Product
    CATEGORY_1:
      id: CATEGORY_1
      type: Category
      title:
        default: My first category
      products:
        ANOTHER_PRODUCT:
          id: ANOTHER_PRODUCT
          type: Product
      name: Invalid catalog with product and variant having no categories
      expectedErrorMessages:
          - Product or one or more of its variants does not belong to a category

```

--------------------------------

### Product and Variant in Same Category

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

A product and its variants cannot belong to the same category. This example shows an invalid configuration where PRODUCT_1 and PRODUCT_VARIANT_1 are both assigned to CATEGORY_1.

```yaml
catalog:
  items:
    PRODUCT_1:
      id: PRODUCT_1
      type: Product
      title:
        default: My first product
      active: true
      isExpressItem: true
      isPrepackedItem: true
      excludeDishInformation: true
      price: '1.50'
      variants:
        PRODUCT_VARIANT_1:
          id: PRODUCT_VARIANT_1
          type: Product
    PRODUCT_VARIANT_1:
      id: PRODUCT_VARIANT_1
      type: Product
      title:
        default: My first product variant
      active: true
      isExpressItem: true
      isPrepackedItem: true
      excludeDishInformation: true
      price: '1.50'
      parent:
        id: PRODUCT_1
        type: Product
    CATEGORY_1:
      id: CATEGORY_1
      type: Category
      title:
        default: My first category
      products:
        PRODUCT_1:
          id: PRODUCT_1
          type: Product
        PRODUCT_VARIANT_1:
          id: PRODUCT_VARIANT_1
          type: Product

```

--------------------------------

### Get Availability Status - Implementation Note

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api

Special handling is required for the '204 No Content' status code, which indicates acknowledgment but not yet available results. Retries are recommended.

```text
Implementation note: please take special care about response status code `204`. This means the request is acknowledged, but the result is not yet available. Please retry in a couple of seconds.
```

--------------------------------

### Get Unavailable Toppings & Items

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Get items and topping unavailable for all platforms for a given POS Vendor and Chain code combination. This endpoint is still in development.

```APIDOC
## GET /v2/chains/{chainCode}/vendors/{posVendorId}/catalog/items/unavailable

### Description
Get items and topping unavailable for all platforms for a given POS Vendor and Chain code combination. This endpoint is still in development and is only listed for completion.

### Method
GET

### Endpoint
`/v2/chains/{chainCode}/vendors/{posVendorId}/catalog/items/unavailable`

### Parameters
#### Path Parameters
- **chainCode** (string) - Required - The unique identifier of the chain that the vendor belongs to.
- **posVendorId** (string) - Required - The unique identifier of the vendor on the POS side. Example: pyhhud

### Response
#### Success Response (200)
- **platformVendorId** (string) - Description: The vendor ID on the platform.
- **globalEntityId** (string) - Description: The global entity ID.
- **status** (string) - Description: The status of the retrieval.
- **unavailableItems** (Array) - Description: A list of unavailable items and toppings.
  - **items** (Array) - Description: List of unavailable items.
    - **id** (string) - Description: The ID of the item.
    - **name** (string) - Description: The name of the item.
  - **toppings** (Array) - Description: List of unavailable toppings.
    - **id** (string) - Description: The ID of the topping.
    - **name** (string) - Description: The name of the topping.

#### Error Response (400)
Bad Request

#### Error Response (401)
Unauthorized

#### Error Response (500)
Internal Server Error
```

--------------------------------

### JSON Response Sample for Menu Import Logs

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api

This is a sample JSON response structure for menu import logs, detailing the status and details of import operations.

```json
{
  "menuImportLogs": {
    "pyhhud": [
      {
        "createdAt": "2016-01-02T16:56:00Z",
        "menuImportId": "n2cp-1449160200",
        "message": "",
        "status": "in_progress",
        "url": "",
        "version": 1
      },
      {
        "createdAt": "2016-01-02T16:56:05Z",
        "menuImportId": "n2cp-1449160200",
        "message": "Import successful",
        "version": 1
      }
    ]
  }
}
```

--------------------------------

### Create Regular Menu

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Creates a regular menu with various products and a weekly schedule. Products added here control which categories are shown to the customer.

```yaml
REGULAR_MENU:
  id: REGULAR_MENU
  type: Menu
  title:
    default: REGULAR_MENU
  description:
    default: Our Daily Menu
  images: {}
  products:
    PIZZA_CHEESE:
      id: PIZZA_CHEESE
      type: Product
    PIZZA_SALAMI:
      id: PIZZA_SALAMI
      type: Product
    PIZZA_BUNDLE:
      id: PIZZA_BUNDLE
      type: Product
    COKE:
      id: COKE
      type: Product
    FANTA:
      id: FANTA
      type: Product
    SPRITE:
      id: SPRITE
      type: Product
  schedule:
    WEEKLY_SCHEDULE:
      type: ScheduleEntry
      id: WEEKLY_SCHEDULE
  menuType: DELIVERY

```

--------------------------------

### Define Pizza Extras Topping

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

This snippet defines a 'PRODUCT_OPTION' topping for pizza extras. It allows customers to select up to two extras, with each option having a specified price. This enables add-on purchases for pizza customization.

```yaml
PIZZA_EXTRAS:
  id: PIZZA_EXTRAS
  type: Topping
  toppingType: PRODUCT_OPTION
  title:
    default: Extras for your pizza
  description:
    default: Extras for your pizza
  images: {}
  quantity:
    minimum: 0
    maximum: 2
  products:
    EXTRA_CHEESE:
      id: EXTRA_CHEESE
      type: Product
      price: '50'
    EXTRA_JALAPENOS:
      id: EXTRA_JALAPENOS
      type: Product
      price: '50'
    EXTRA_GARLIC:
      id: EXTRA_GARLIC
      type: Product
      price: '50'
```

--------------------------------

### Define Extra Product for Pizza

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

This snippet defines a basic product for 'Extra Cheese'. Use this structure for other pizza extras. Pricing and images are omitted here but can be added as needed.

```yaml
EXTRA_CHEESE:
  id: EXTRA_CHEESE
  type: Product
  parent: null
  title:
    default: Extra Cheese
  description:
    default: Extra Cheese
  images: {}
  variants: {}
  toppings: {}
```

--------------------------------

### GET /v2/chains/{chainCode}/vendors/{posVendorId}/platform-vendors

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Retrieve platform vendors for a given POS vendor ID. This endpoint is used to get metadata regarding platform vendors associated with a specific POS vendor.

```APIDOC
## GET /v2/chains/{chainCode}/vendors/{posVendorId}/platform-vendors

### Description
Retrieve platform vendors for a given POS vendor ID.

### Method
GET

### Endpoint
https://integration-middleware.stg.restaurant-partners.com/v2/chains/{chainCode}/vendors/{posVendorId}/platform-vendors

### Parameters
#### Path Parameters
- **chainCode** (string) - Required - It identifies the POS group of restaurants on the Middleware side.
- **posVendorId** (string) - Required - Combined with the chainCode, it identifies a restaurant from the POS plugin perspective.

### Response
#### Success Response (200)
- **platformVendorId** (string) - The ID of the platform vendor.
- **globalEntityId** (string) - The global entity ID.
- **posVendorId** (string) - The POS vendor ID.

#### Response Example
[
  {
    "platformVendorId": "string",
    "globalEntityId": "string",
    "posVendorId": "string"
  }
]
```

--------------------------------

### Response Sample for Menu Import Logs

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

This JSON structure represents the response when querying menu import logs, showing the status and details of import processes.

```json
{
  "menuImportLogs": {
    "pyhhud": [
      {
        "createdAt": "2016-01-02T16:56:00Z",
        "menuImportId": "n2cp-1449160200",
        "message": "",
        "status": "in_progress",
        "url": "",
        "version": 1
      },
      {
        "createdAt": "2016-01-02T16:56:05Z",
        "menuImportId": "n2cp-1449160200",
        "message": "Import successful",
        "version": 1
      }
    ]
  }

}
```

--------------------------------

### GET /v2/chains/{chainCode}/orders/{orderId}

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api

Retrieves detailed information for a specific order.

```APIDOC
## GET /v2/chains/{chainCode}/orders/{orderId}

### Description
Gets detailed information of an order, typically to be used together with the Get List of Order Ids endpoint.

### Method
GET

### Endpoint
/v2/chains/{chainCode}/orders/{orderId}

### Parameters
#### Path Parameters
- **orderId** (string) - Required - Unique identifier of an order.
- **chainCode** (string) - Required - The unique identifier of the chain that the order belongs to.

### Response
#### Success Response (200)
- Order details
```

--------------------------------

### Callbacks

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Provides information on how to set up callbacks for receiving status updates on catalog imports.

```APIDOC
### Callbacks

#### POST Callback

Use the `callbackUrl` field in the request body of the catalog import endpoint to receive status updates about the catalog import process.
```

--------------------------------

### Get Order Identifiers Response

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api

Successful response containing a list of order identifiers and the total count.

```json
{
  "orderIdentifiers": [
    "01f91115-bf85-4830-932d-7133e12665c6",
    "05K91115-bf85-4830-932d-7133e12665c6",
    "02J91115-bf85-4830-932d-7133e12665c6"
],
  "count": 3
}
```

--------------------------------

### POST /v2/orders/{orderToken}/preparation-completed

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Notifies the system that food is prepared and ready for pickup by the rider.

```APIDOC
## POST /v2/orders/{orderToken}/preparation-completed

### Description
This endpoint notifies the system that the food is prepared and the order can be picked up by the rider at the vendor location. It should only be used when the order is delivered by Delivery Hero riders and the URL is provided in the orderDispatch request payload.

### Method
POST

### Endpoint
/v2/orders/{orderToken}/preparation-completed

### Parameters
#### Path Parameters
- **orderToken** (string) - Required - Unique order identifier in Delivery Hero system.

### Response
#### Success Response (200)
- **code** (string) - Status code indicating success.

#### Response Example
{
  "code": "OK"
}
```

--------------------------------

### GET /v2/chains/{chainCode}/remoteVendors/{posVendorId}/availability

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Retrieves the current availability status and configuration for a specific restaurant.

```APIDOC
## GET /v2/chains/{chainCode}/remoteVendors/{posVendorId}/availability

### Description
Retrieves the current availability status of a restaurant. Use this to check if availability changes are allowed by verifying the 'changeable' property.

### Method
GET

### Endpoint
/v2/chains/{chainCode}/remoteVendors/{posVendorId}/availability

### Parameters
#### Path Parameters
- **chainCode** (string) - Required - Identifies the POS group of restaurants on the Middleware side.
- **posVendorId** (string) - Required - Identifies a restaurant from the POS plugin perspective (remoteId).

### Response
#### Success Response (200)
- **availabilityState** (string) - Current state of availability.
- **changeable** (boolean) - Indicates if the status can be modified.
- **platformKey** (string) - Unique platform identifier.
- **platformRestaurantId** (string) - Unique restaurant identifier on the platform.

#### Response Example
[
  {
    "availabilityState": "OPEN",
    "changeable": true,
    "platformKey": "LH_DE",
    "platformRestaurantId": "40788",
    "platformType": "DELIVERY_HERO"
  }
]
```

--------------------------------

### Catalog Request Payload

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api

A JSON payload example for the catalog endpoint, including product definitions, variants, and topping associations.

```json
{
  "callbackUrl": "https://example.com/callback",
  "catalog": {
    "items": {
      "prd00001|001": {
        "id": "prd00001|001",
        "title": {
          "default": "Pure yogurt, small",
          "de": "Natur Jogurt, klein"
},
        "type": "Product",
        "price": "3.50",
        "parent": {
          "id": "prd00001",
          "type": "Product"
},
        "active": true,
        "isPrepackedItem": false,
        "isExpressItem": false,
        "excludeDishInformation": false,
        "toppings": {
          "tt0001": {
            "id": "tt0001",
            "type": "Topping"
}
}
},
      "prd00001|002": {
        "id": "prd00001|002",
        "title": {
          "default": "Pure yogurt, medium",
          "de": "Natur Jogurt, mittel"
},
        "type": "Product",
        "price": "4.30",
        "parent": {
          "id": "prd00001",
          "type": "Product"
},
        "active": true,
        "isPrepackedItem": false,
        "isExpressItem": false,
        "excludeDishInformation": false,
        "toppings": {
          "tt0001": {
            "id": "tt0001",
            "type": "Topping"
},
          "tt0002": {
            "id": "tt0002",
            "type": "Topping"
}
}
},
      "prd00001|003": {
        "id": "prd00001|003",
        "title": {
          "default": "Pure yogurt, large",
          "de": "Natur Jogurt, groß"
},
        "type": "Product",
        "price": "4.99",
        "parent": {
          "id": "prd00001",
          "type": "Product"
},
        "active": true,
        "isPrepackedItem": false,
        "isExpressItem": false,
        "excludeDishInformation": false,
        "toppings": {
          "tt0001": {
            "id": "tt0001",
            "type": "Topping"
},
          "tt0002": {
            "id": "tt0002",
            "type": "Topping"
}
}
},
      "prd00001": {
        "id": "prd00001",
        "type": "Product",
        "title": {
          "default": "Pure yogurt",
          "de": "Natur Jogurt"
},
        "description": {
          "default": "Pure yogurt"
},
        "variants": {
          "prd00001|001": {
            "id": "prd00001|001",
            "type": "Product"
},
          "prd00001|002": {
            "id": "prd00001|002",
            "type": "Product"
},
          "prd00001|003": {
            "id": "prd00001|003",
            "type": "Product"
}
},
        "active": true,
        "isPrepackedItem": false,
        "isExpressItem": false,
        "excludeDishInformation": false
},
      "prd00002|001": {
        "id": "prd00002|001",
        "title": {
          "default": "Sporty yogurt, small",
          "de": "Fitness Jogurt, klein"
},
        "type": "Product",
        "price": "3.95",
        "parent": {
          "id": "prd00002",
          "type": "Product"
},
        "active": true,
        "isPrepackedItem": false,
        "isExpressItem": false,
        "excludeDishInformation": false,
        "toppings": {
          "tt0001": {
            "id": "tt0001",
            "type": "Topping"
}
}
},
      "prd00002|002": {
        "id": "prd00002|002",
        "title": {
          "default": "Sporty yogurt, medium",
          "de": "Fitness Jogurt, mittel"
},
        "type": "Product",
        "price": "4.95",
        "parent": {
          "id": "prd00002",
          "type": "Product"
},
        "active": true,
        "isPrepackedItem": false,
        "isExpressItem": false,
        "excludeDishInformation": false,
        "toppings": {
          "tt0001": {
            "id": "tt0001",
            "type": "Topping"
},
          "tt0002": {
            "id": "tt0002",
            "type": "Topping"
}
}
},
      "prd00002|003": {
        "id": "prd00002|003",
        "title": {
          "default": "Sporty yogurt, large",
          "de": "Fitness Jogurt, groß"
},
        "type": "Product",
        "price": "6.00",
        "parent": {
          "id": "prd00002",
          "type": "Product"
},
        "active": true,
        "isPrepackedItem": false,
        "isExpressItem": false,
        "excludeDishInformation": false,
        "toppings": {
          "tt0001": {
            "id": "tt0001",
            "type": "Topping"
}
}
},
      "prd00002": {
        "id": "prd00002",
        "type": "Product",
        "title": {
          "default": "Sporty yogurt",
          "de": "Fitness Jogurt"
},
        "description": {
          "default": "Sporty yogurt"
},
        "variants": {
          "prd00002|001": {
            "id": "prd00002|001",
            "type": "Product"
}
}
```

--------------------------------

### Update Restaurant Availability Request

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Example JSON payload for the PUT availability endpoint to change a restaurant's status.

```json
{
  "availabilityState": "OPEN",
  "platformKey": "TB",
  "platformRestaurantId": 123456789
}
```

--------------------------------

### Submit a menu (XML) - Deprecated

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api

This endpoint is used to import a menu as a response to a trigger request. It is now deprecated and will be replaced with the Catalog Import API. The parameters for this endpoint are sent to the plugin in the trigger request.

```APIDOC
## POST /api/menu/import

### Description
Submits a menu in XML format in response to a trigger import request. This endpoint is deprecated.

### Method
POST

### Endpoint
/api/menu/import

### Parameters

#### Request Body
- **menu.xml** (file) - Required - The XML file containing the menu data.

### Request Example
```xml
<Vendor>
    <ToppingTemplateProducts>
        <ToppingTemplateProduct>
            <Id>ttp1</Id>
            <Price>0.50</Price>
        </ToppingTemplateProduct>
    </ToppingTemplateProducts>
    <ProductVariationToppingTemplates>
        <ProductVariationToppingTemplate>
            <ProductVariationId>pv1</ProductVariationId>
            <ToppingTemplateId>tt1</ToppingTemplateId>
        </ProductVariationToppingTemplate>
    </ProductVariationToppingTemplates>
    <Translations>
        <Language>
            <Code>es</Code>
            <MenuCategoryTranslations>
                <MenuCategoryTranslation>
                    <Id>s2</Id>
                    <Title>Coberturas y opciones</Title>
                </MenuCategoryTranslation>
                <MenuCategoryTranslation>
                    <Id>s1</Id>
                    <Title>Sushi y sashimi</Title>
                    <Description>Sushi rico</Description>
                </MenuCategoryTranslation>
            </MenuCategoryTranslations>
            <ProductTranslations>
                <ProductTranslation>
                    <Id>ttp1</Id>
                    <Title>Wasabi negro</Title>
                </ProductTranslation>
                <ProductTranslation>
                    <Id>m36</Id>
                    <Title>Sushimi</Title>
                    <Description>Hecho de atún fresco</Description>
                </ProductTranslation>
                <ProductTranslation>
                    <Id>ttp6</Id>
                    <Title>Hojas de jengibre</Title>
                </ProductTranslation>
            </ProductTranslations>
        </Language>
        <Language>
            <Code>ru</Code>
            <MenuCategoryTranslations>
                <MenuCategoryTranslation>
                    <Id>s2</Id>
                    <Title>Выбор и начинок</Title>
                </MenuCategoryTranslation>
                <MenuCategoryTranslation>
                    <Id>s1</Id>
                    <Title>Суши и сашими</Title>
                    <Description>Yummi суши</Description>
                </MenuCategoryTranslation>
            </MenuCategoryTranslations>
            <ProductTranslations>
                <ProductTranslation>
                    <Id>ttp1</Id>
                    <Title>Васаби черный</Title>
                </ProductTranslation>
                <ProductTranslation>
                    <Id>m36</Id>
                    <Title>Суши вкус</Title>
                    <Description>Свежий Тунец факт</Description>
                </ProductTranslation>
                <ProductTranslation>
                    <Id>ttp6</Id>
                    <Title>имбирь листья</Title>
                </ProductTranslation>
            </ProductTranslations>
            <ProductVariationTranslations>
                <ProductVariationTranslation>
                    <Id>pv1</Id>
                    <Title>Product variation translation</Title>
                </ProductVariationTranslation>
            </ProductVariationTranslations>
        </Language>
        <Language>
            <Code>pl</Code>
            <ProductTranslations>
                <ProductTranslation>
                    <Id>ttp1</Id>
                    <Title>Wasabi czarny</Title>
                </ProductTranslation>
                <ProductTranslation>
                    <Id>m36</Id>
                    <Title>sushimi</Title>
                    <Description>Wykonane ze świeżego tuńczyka</Description>
                </ProductTranslation>
            </ProductTranslations>
            <ToppingTemplateTranslations>
                <ToppingTemplateTranslation>
                    <Id>tt1</Id>
                    <Title>Test template polish translation</Title>
                </ToppingTemplateTranslation>
            </ToppingTemplateTranslations>
        </Language>
    </Translations>
</Vendor>
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the submission status, e.g., "SUBMITTED".

#### Response Example
```json
{
  "status": "SUBMITTED"
}
```

### Error Handling
- **404**: Not Found
- **500**: Internal Server Error

### Image Requirements
- Minimum image size must be `640 x 270` (width x height).
- If plugin cannot provide images with those dimensions, the image element should be submitted as empty, otherwise menu import will be marked as failed.

### Products Order
- The order of menu elements displayed to customers matches the order in which they appear on the XML.
- Position of toppings or choices inside a topping template cannot be set.

### Authorizations
- BearerPluginAuth
```

--------------------------------

### POST /callback

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

Endpoint used by the system to send status updates regarding the catalog import process.

```APIDOC
## POST /callback

### Description
Callback endpoint to receive status updates about the catalog import process.

### Method
POST

### Request Body
- **catalogImportId** (string) - The ID of the import.
- **status** (string) - Current status of the import.
- **message** (string) - Status message.
- **details** (array) - List of status details per vendor.

### Request Example
{
  "catalogImportId": "string",
  "status": "in_progress",
  "message": "string",
  "details": [
    {
      "status": "in_progress",
      "posVendorId": "string",
      "platformVendorId": "string",
      "globalEntityId": "string"
    }
  ]
}
```

--------------------------------

### GET /v2/chains/{chainCode}/orders/ids

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api

Retrieves a list of order identifiers for a specific chain and status within a defined time frame.

```APIDOC
## GET /v2/chains/{chainCode}/orders/ids

### Description
Get a list of all order identifiers for the previous specified hours filtered by specific chain and order status.

### Method
GET

### Endpoint
/v2/chains/{chainCode}/orders/ids

### Parameters
#### Path Parameters
- **chainCode** (string) - Required - Unique identifier of a chain.

#### Query Parameters
- **status** (string) - Required - Enum: "cancelled", "accepted".
- **pastNumberOfHours** (number) - Optional - Default: 24 (Range: 1-24).
- **vendorId** (string) - Optional - Unique identifier of a vendor on the POS plugin side.

### Response
#### Success Response (200)
- **orderIdentifiers** (array) - List of order identifiers.
- **count** (number) - Total count of orders.

#### Response Example
{
  "orderIdentifiers": [
    "01f91115-bf85-4830-932d-7133e12665c6",
    "05K91115-bf85-4830-932d-7133e12665c6",
    "02J91115-bf85-4830-932d-7133e12665c6"
  ],
  "count": 3
}
```

--------------------------------

### Catalog Without Categories

Source: https://integration-middleware.stg.restaurant-partners.com/apidocs/pos-middleware-api#section/Authentication

A catalog must contain at least one category. This example demonstrates an invalid catalog structure because it lacks any categories.

```yaml
catalog:
  items:
    PRODUCT_1:
      id: PRODUCT_1
      type: Product
      title:
        default: My first product
      active: true
      isExpressItem: true
      isPrepackedItem: true
      excludeDishInformation: true
      price: '1.50'
      variants:
        PRODUCT_VARIANT_1:
          id: PRODUCT_VARIANT_1
          type: Product
    PRODUCT_VARIANT_1:
      id: PRODUCT_VARIANT_1
      type: Product
      title:
        default: My first product variant
      active: true
      isExpressItem: true
      isPrepackedItem: true
      excludeDishInformation: true
      price: '1.50'
      parent:
        id: PRODUCT_1
        type: Product

```
Tokens:
Raw