Documentation

Items

Represents the entire catalog offered by the store. There are two types:

ITEM MODIFIER_GROUP Only items of type ITEM can belong to a category, and they can only be related to items of different types: ITEM → MODIFIER_GROUP / MODIFIER_GROUP → ITEM.

Conceptually, an item of type ITEM can be a product or a modifier, while an item of type MODIFIER_GROUP is a group of modifiers.

The following table outlines the available Items resources:

Items ResourceEndpoint description
GET v1/stores/{store_id}/itemsRetrieves the items of a store by Store ID.
POST v1/stores/{store_id}/itemsCreate or Update the items by store ID.
DELETE v1/stores/{store_id}/itemsDelete the specified items by store ID.
GET v1/stores/{store_id}/items/{item_id}Retrieves the specified item with all relations of information by store ID.

GET Items By Store ID

This endpoint retrieves the list of items available in a specific store.

Endpoint URL

Use this URL to make a request with this endpoint:

https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{store_id}/items

{NEW_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameter

This endpoint has the following parameters:

ParameterTypeRequiredDescription
store_idintYesThe unique identifier of the store whose menu is being requested.

This parameter is used to specify which store's menu should be retrieved. The store_id should be a valid integer representing a store registered in the system.

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

GET https://api.dev.rappi.com/restaurants/menu/v1/stores/{store_id}/items

This is an example of the request:




String storeId = "232";
String urlString = "https://api.dev.rappi.com/restaurants/menu/v1/stores/" + storeId + "/items";
URL url = new URL(urlString);
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

int responseCode = connection.getResponseCode();
System.out.println("Response Code: " + responseCode);
try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}








Sample Response "Success 200"




This is an example of the response "Success 200":




[
  {
    "id": 100,
    "sku": "pastel_de_fresa",
    "store_id": 232,
    "last_updated": "2025-03-27T22:01:41.647471Z",
    "item_type": "ITEM",
    "title_info": {
      "title": "Pastel de fresa",
      "overrides": [
        {
          "override_id": 641,
          "override_sku": "",
          "override_type": "STORE",
          "title": "Pastel de fresa deluxe"
        },
        {
          "override_id": 714,
          "override_sku": "1248187953",
          "override_type": "ITEM",
          "title": "Acompañamiento: Pastel de fresa"
        }
      ]
    },
    "description_info": {
      "description": "Delicioso pastel de fresa",
      "overrides": [
        {
          "override_id": 641,
          "override_type": "STORE",
          "description": "Delicioso pastel de fresa deluxe",
          "override_sku": ""
        },
        {
          "override_id": 714,
          "override_type": "ITEM",
          "description": "Delicioso acompañamiento: Pastel de fresa",
          "override_sku": "1248187953"
        }
      ]
    },
    "images_info": {
      "images": [
        {
          "id": 34,
          "path": "my/path/to/my/image.jpg",
          "index": 1,
          "host": "https://my.cdn.com"
        }
      ],
      "overrides": [
        {
          "override_id": 641,
          "override_type": "STORE",
          "images": [
            {
              "id": 43,
              "path": "my/path/to/my/image.jpg",
              "index": 1,
              "host": "https://my.cdn.com"
            }
          ],
          "override_sku": ""
        },
        {
          "override_id": 714,
          "override_type": "ITEM",
          "images": [
            {
              "id": 43544,
              "path": "my/path/to/my/image.jpg",
              "index": 1,
              "host": "https://my.cdn.com"
            }
          ],
          "override_sku": "1248187953"
        }
      ]
    },
    "items_info": {
      "items": [
        {
          "id": 11743,
          "sku": "1248187964",
          "index": 1
        }
      ],
      "overrides": [
        {
          "override_id": 714,
          "override_type": "ITEM",
          "items": [
            {
              "id": 11720,
              "sku": "1248187730",
              "index": 1
            }
          ],
          "override_sku": "1248187953"
        },
        {
          "override_id": 641,
          "override_type": "STORE",
          "items": [
            {
              "id": 11716,
              "sku": "1248187776",
              "index": 1
            }
          ],
          "override_sku": ""
        }
      ]
    },
    "price_info": {
      "price": 179,
      "overrides": [
        {
          "override_id": 641,
          "override_type": "STORE",
          "price": 200,
          "override_sku": ""
        },
        {
          "override_id": 714,
          "override_type": "ITEM",
          "price": 0,
          "override_sku": "1248187953"
        }
      ]
    },
    "quantity_info": {
      "min_permitted": 0,
      "max_permitted": 5,
      "modifiers_type": null,
      "overrides": [
        {
          "override_id": 641,
          "override_type": "STORE",
          "min_permitted": 0,
          "max_permitted": 2,
          "modifiers_type": null,
          "override_sku": ""
        },
        {
          "override_id": 714,
          "override_type": "ITEM",
          "min_permitted": 0,
          "max_permitted": 1,
          "modifiers_type": null,
          "override_sku": "1248187953"
        }
      ]
    },
    "suspension_info": {
      "suspend_until": null,
      "suspend_reason": null,
      "overrides": [
        {
          "override_id": 641,
          "override_type": "STORE",
          "suspend_until": "2025-03-30T00:00:00Z",
          "suspend_reason": "Is stocked out",
          "created_at": "2025-03-27T22:01:41.647376Z",
          "override_sku": ""
        },
        {
          "override_id": 714,
          "override_type": "ITEM",
          "suspend_until": "2025-03-30T00:00:00Z",
          "suspend_reason": "Is stocked out",
          "created_at": "2025-03-27T22:01:41.647376Z",
          "override_sku": "1248187953"
        }
      ],
      "is_available": true
    },
    "schedules_info": {
      "schedules": [
        {
          "days_of_week": "mon,tue,wed,thu,fri",
          "time_periods": [
            {
              "start_time": "16:00",
              "end_time": "22:00"
            }
          ]
        }
      ],
      "overrides": [
        {
          "id": 26,
          "override_id": 641,
          "override_sku": "",
          "override_type": "STORE",
          "schedules": [
            {
              "days_of_week": "mon,tue,wed,thu,fri",
              "time_periods": [
                {
                  "start_time": "16:00",
                  "end_time": "23:00"
                }
              ]
            }
          ]
        },
        {
          "id": 27,
          "override_id": 714,
          "override_sku": "1248187953",
          "override_type": "ITEM",
          "schedules": [
            {
              "days_of_week": "mon,tue,wed,thu,fri",
              "time_periods": [
                {
                  "start_time": "16:00",
                  "end_time": "20:00"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  {
    "id": 11,
    "sku": "1abc",
    "store_id": 232,
    "last_updated": "2024-12-18T14:58:24.552489Z",
    "item_type": "MODIFIER_GROUP",
    "title_info": {
      "title": "Eleccion cubiertos",
      "overrides": []
    },
    "description_info": {
      "description": "Eleccion cubiertos",
      "overrides": []
    },
    "images_info": {
      "images": [],
      "overrides": []
    },
    "items_info": {
      "items": [],
      "overrides": []
    },
    "price_info": {
      "price": 0,
      "overrides": []
    },
    "quantity_info": {
      "min_permitted": 0,
      "max_permitted": 1,
      "modifiers_type": "exclusive",
      "overrides": []
    },
    "suspension_info": {
      "suspend_until": null,
      "suspend_reason": null,
      "overrides": [],
      "is_available": true
    },
    "schedules_info": {
      "schedules": [],
      "overrides": []
    }
  }
]


POST Upsert Items By Store ID


This endpoint allows creating or updating items in a specific store.


Endpoint URL


Use this URL to make a request with this endpoint:


https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{store_id}/items


{NEW_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.



Endpoint Properties


This resource has the following properties:



















Response formatsJSON
Authentication requirementsToken


Parameters


This endpoint has the following parameters:



















ParameterTypeRequiredDescription
store_idintYesThe unique identifier of the store whose menu is being requested.


Important Notes



Request Fields Description






















































































































































































































































































































































FieldTypeDescription
idintIdentifier of the item.
skustringStock Keeping Unit (SKU) identifier of the item. It's required unless the ID is sent.
store_idintIdentifier of the store in the application.
last_updatedstringTimestamp of the last update in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
item_typestringType of the item (ITEM or MODIFIER_GROUP).
title_info.titlestringTitle of the item.
title_info.overridesarrayList of title overrides for specific conditions.
title_info.overrides[].override_idintIdentifier of the title override.
title_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
title_info.overrides[].override_typestringType of override (STORE or ITEM).
title_info.overrides[].titlestringOverride title.
description_info.descriptionstringDescription of the item.
description_info.overridesarrayList of description overrides for specific conditions.
description_info.overrides[].override_idintIdentifier of the description override.
description_info.overrides[].override_typestringType of override (STORE or ITEM).
description_info.overrides[].descriptionstringOverride description.
description_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
images_info.imagesarrayList of images associated with the item.
images_info.images[].idintIdentifier of the image.
images_info.images[].pathstringThe path where the image is in the CDN
images_info.images[].indexintThe position where that image should be positioned.
images_info.images[].hoststringThe image CDN host
images_info.overridesarrayList of image overrides for specific conditions.
images_info.overrides[].override_idintIdentifier of the image override.
images_info.overrides[].override_typestringType of override (STORE or ITEM).
images_info.overrides[].imagesarrayList of overridden images.
images_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
items_info.itemsarrayList of related items.
items_info.items[].idintIdentifier of the related item.
items_info.items[].skustringSKU of the related item. It’s required unless the ID is sent.
items_info.items[].indexintOrder index of the related item.
items_info.overridesarrayList of item overrides for specific conditions.
items_info.overrides[].override_idintIdentifier of the item override.
items_info.overrides[].override_typestringType of override (STORE or ITEM).
items_info.overrides[].itemsarrayList of overridden items.
items_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
price_info.pricefloatPrice of the item.
price_info.overridesarrayList of price overrides for specific conditions.
price_info.overrides[].override_idintIdentifier of the price override.
price_info.overrides[].override_typestringType of override (STORE or ITEM).
price_info.overrides[].pricefloatThe price that should be applied when the override complies.
price_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
quantity_info.min_permittedintThe minimum amount of items permitted of this item when the item is ITEM type. And the minimum amount of items inside permitted when the item is MODIFIER_GROUP type. This field is required when the item is MODIFIER_GROUP.
quantity_info.max_permittedintThe maximum amount of items permitted of this item when the item is ITEM type. And the maximum amount of items inside permitted when the item is MODIFIER_GROUP type. This field is required when the item is MODIFIER_GROUP.
quantity_info.modifiers_typestringType of modifier (nullable).
quantity_info.overridesarrayList of quantity overrides for specific conditions.
quantity_info.overrides[].override_idintIdentifier of the quantity override.
quantity_info.overrides[].override_typestringType of override (STORE or ITEM).
quantity_info.overrides[].min_permittedintThe minimum amount of items permitted of this item when the item is ITEM type. And the minimum amount of items inside permitted when the item is MODIFIER_GROUP type. This field is required when the item is MODIFIER_GROUP.
quantity_info.overrides[].max_permittedintThe maximum amount of items permitted of this item when the item is ITEM type. And the maximum amount of items inside permitted when the item is MODIFIER_GROUP type. This field is required when the item is MODIFIER_GROUP.
quantity_info.overrides[].modifiers_typestringOverridden type of modifier (nullable).
quantity_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
suspension_info.suspend_untilstringDate when the item is supposed to turn on. If null then is suspended permanently.
suspension_info.suspend_reasonstringReason why the item is suspended.
suspension_info.is_availableboolAvailability status of the item.
suspension_info.overridesarrayList of suspension overrides for specific conditions.
schedules_info.schedulesarrayList of schedules defining availability.
schedules_info.schedules[].days_of_weekstringDays of the week when the schedule is active.
schedules_info.schedules[].time_periodsarrayTime periods within the schedule.
schedules_info.schedules[].time_periods[].start_timestringStart time in HH:MM format.
schedules_info.schedules[].time_periods[].end_timestringEnd time in HH:MM format.
schedules_info.overridesarrayList of schedule overrides for specific conditions.
schedules_info.overrides[].override_idintIdentifier of the schedules override.
schedules_info.overrides[].override_typestringType of override (STORE CATEGORY or ITEM).
schedules_info.overrides[].schedulesarrayList of overridden schedules.
schedules_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.


Status Codes


These are the possible status codes of the response for this endpoint:






Sample Request


This is an example of an API request using this endpoint:


POST https://api.dev.rappi.com/restaurants/menu/v1/stores/232/items




This is an example of the request:






import okhttp3.*;

public class Main {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        String json = """
        {
            "id": 100,
            "sku": "pastel_de_fresa",
            "store_id": 232,
            "item_type": "ITEM",
            "title_info": {
                "title": "Pastel de fresa",
                "overrides": [
                    {"override_id": 641, "override_sku": "", "override_type": "STORE", "title": "Pastel de fresa deluxe"},
                    {"override_id": 714, "override_sku": "1248187953", "override_type": "ITEM", "title": "Acompañamiento: Pastel de fresa"}
                ]
            },
            "description_info": {
                "description": "Delicioso pastel de fresa",
                "overrides": [
                    {"override_id": 641, "override_type": "STORE", "description": "Delicioso pastel de fresa deluxe", "override_sku": ""},
                    {"override_id": 714, "override_type": "ITEM", "description": "Delicioso acompañamiento: Pastel de fresa", "override_sku": "1248187953"}
                ]
            },
            "images_info": {
                "images": [
                    {"id": 34, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com"}
                ],
                "overrides": [
                    {"override_id": 641, "override_type": "STORE", "images": [{"id": 43, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com"}], "override_sku": ""},
                    {"override_id": 714, "override_type": "ITEM", "images": [{"id": 43544, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com"}], "override_sku": "1248187953"}
                ]
            },
            "items_info": {
                "items": [{"id": 11743, "sku": "1248187964", "index": 1}],
                "overrides": [
                    {"override_id": 714, "override_type": "ITEM", "items": [{"id": 11720, "sku": "1248187730", "index": 1}], "override_sku": "1248187953"},
                    {"override_id": 641, "override_type": "STORE", "items": [{"id": 11716, "sku": "1248187776", "index": 1}], "override_sku": ""}
                ]
            },
            "price_info": {
                "price": 179,
                "overrides": [
                    {"override_id": 641, "override_type": "STORE", "price": 200, "override_sku": ""},
                    {"override_id": 714, "override_type": "ITEM", "price": 0, "override_sku": "1248187953"}
                ]
            },
            "quantity_info": {
                "min_permitted": 0,
                "max_permitted": 5,
                "overrides": [
                    {"override_id": 641, "override_type": "STORE", "min_permitted": 0, "max_permitted": 2, "override_sku": ""},
                    {"override_id": 714, "override_type": "ITEM", "min_permitted": 0, "max_permitted": 1, "override_sku": "1248187953"}
                ]
            },
            "suspension_info": {
                "suspend_until": null,
                "suspend_reason": null,
                "overrides": [
                    {"override_id": 641, "override_type": "STORE", "suspend_until": "2025-03-30T00:00:00Z", "suspend_reason": "Is stocked out", "created_at": "2025-03-27T22:01:41.647376Z", "override_sku": ""},
                    {"override_id": 714, "override_type": "ITEM", "suspend_until": "2025-03-30T00:00:00Z", "suspend_reason": "Is stocked out", "created_at": "2025-03-27T22:01:41.647376Z", "override_sku": "1248187953"}
                ]
            },
            "schedules_info": {
                "schedules": [
                    {"days_of_week": "mon,tue,wed,thu,fri", "time_periods": [{"start_time": "16:00", "end_time": "22:00"}]}
                ],
                "overrides": [
                    {"id": 26, "override_id": 641, "override_sku": "", "override_type": "STORE", "schedules": [{"days_of_week": "mon,tue,wed,thu,fri", "time_periods": [{"start_time": "16:00", "end_time": "23:00"}]}]},
                    {"id": 27, "override_id": 714, "override_sku": "1248187953", "override_type": "ITEM", "schedules": [{"days_of_week": "mon,tue,wed,thu,fri", "time_periods": [{"start_time": "16:00", "end_time": "20:00"}]}]}
                ]
            }
        }
        """;

        RequestBody body = RequestBody.create(json, MediaType.get("application/json"));
        Request request = new Request.Builder()
                .url("https://api.dev.rappi.com/restaurants/menu/v1/stores/232/items")
                .addHeader("Content-Type", "application/json")
                .addHeader("x-authorization", "Bearer YOUR_TOKEN")
                .post(body)
                .build();

        try (Response response = client.newCall(request).execute()) {
            System.out.println(response.body().string());
        }
    }
}








Sample Response 'Success 200'




This is an example of the response "Success 200":




{
  "message": "Your request has been accepted."
}


DELETE Items By Store ID


Use this endpoint allows you to delete multiple items from a store by providing their IDs.


Endpoint URL


Use this URL to make a request with this endpoint:


https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{store_id}/items


{NEW_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.



Endpoint Properties


This resource has the following properties:



















Response formatsJSON
Authentication requirementsToken


Parameters


This endpoint has the following parameters:



















ParameterTypeRequiredDescription
store_idintYesThe unique identifier of the store whose menu is being requested.


Status Codes


These are the possible status codes of the response for this endpoint:







Sample Request


The request must be sent in JSON format with an array of items IDs to be deleted. This is an example of an API request using this endpoint:


DELETE https://api.dev.rappi.com/restaurants/menu/v1/stores/232/items




This is an example of the request:






import okhttp3.*;

public class Main {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        String json = "[1,2]";

        RequestBody body = RequestBody.create(json, MediaType.get("application/json"));
        Request request = new Request.Builder()
                .url("https://api.dev.rappi.com/restaurants/menu/v1/stores/232/items")
                .delete(body)
                .addHeader("Content-Type", "application/json")
                .addHeader("x-authorization", "Bearer YOUR_TOKEN")
                .build();

        try (Response response = client.newCall(request).execute()) {
            System.out.println(response.body().string());
        }
    }
}









GET Item By Store ID


Use this endpoint to retrieve the details of a specific item from a store.


Endpoint URL


Use this URL to make a request with this endpoint:


https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{store_id}/items/{item_id}


{NEW_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.



Endpoint Properties


This resource has the following properties:



















Response formatsJSON
Authentication requirementsToken


Path Parameter

























ParameterTypeRequiredDescription
store_idintYesThe unique identifier of the store whose menu is being requested.
item_idintYesThe unique identifier of the item that is requested.


This parameter is used to specify which store's menu should be retrieved. The store_id should be a valid integer representing a store registered in the system.


Status Codes


These are the possible status codes of the response for this endpoint:







Sample Request


This is an example of an API request using this endpoint:


GET https://api.dev.rappi.com/restaurants/menu/v1/stores/{store_id}/items/{item_id}




This is an example of the request:







String storeId = "232";
String ItemId = "10"
String urlString = "https://api.dev.rappi.com/restaurants/menu/v1/stores/" + storeId + "/items/" + ItemId};
URL url = new URL(urlString);
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

int responseCode = connection.getResponseCode();
System.out.println("Response Code: " + responseCode);
try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}








Sample Response "Success 200"




This is an example of the response "Success 200":




{
  "id": 100,
  "sku": "pastel_de_fresa",
  "store_id": 232,
  "last_updated": "2025-03-27T22:01:41.647471Z",
  "item_type": "ITEM",
  "title_info": {
    "title": "Pastel de fresa",
    "overrides": [
      {
        "override_id": 641,
        "override_sku": "",
        "override_type": "STORE",
        "title": "Pastel de fresa deluxe"
      },
      {
        "override_id": 714,
        "override_sku": "1248187953",
        "override_type": "ITEM",
        "title": "Acompañamiento: Pastel de fresa"
      }
    ]
  },
  "description_info": {
    "description": "Delicioso pastel de fresa",
    "overrides": [
      {
        "override_id": 641,
        "override_type": "STORE",
        "description": "Delicioso pastel de fresa deluxe",
        "override_sku": ""
      },
      {
        "override_id": 714,
        "override_type": "ITEM",
        "description": "Delicioso acompañamiento: Pastel de fresa",
        "override_sku": "1248187953"
      }
    ]
  },
  "images_info": {
    "images": [
      {
        "id": 34,
        "path": "my/path/to/my/image.jpg",
        "index": 1,
        "host": "https://my.cdn.com"
      }
    ],
    "overrides": [
      {
        "override_id": 641,
        "override_type": "STORE",
        "images": [
          {
            "id": 43,
            "path": "my/path/to/my/image.jpg",
            "index": 1,
            "host": "https://my.cdn.com"
          }
        ],
        "override_sku": ""
      },
      {
        "override_id": 714,
        "override_type": "ITEM",
        "images": [
          {
            "id": 43544,
            "path": "my/path/to/my/image.jpg",
            "index": 1,
            "host": "https://my.cdn.com"
          }
        ],
        "override_sku": "1248187953"
      }
    ]
  },
  "items_info": {
    "items": [
      {
        "id": 11743,
        "sku": "1248187964",
        "index": 1
      }
    ],
    "overrides": [
      {
        "override_id": 714,
        "override_type": "ITEM",
        "items": [
          {
            "id": 11720,
            "sku": "1248187730",
            "index": 1
          }
        ],
        "override_sku": "1248187953"
      },
      {
        "override_id": 641,
        "override_type": "STORE",
        "items": [
          {
            "id": 11716,
            "sku": "1248187776",
            "index": 1
          }
        ],
        "override_sku": ""
      }
    ]
  },
  "price_info": {
    "price": 179,
    "overrides": [
      {
        "override_id": 641,
        "override_type": "STORE",
        "price": 200,
        "override_sku": ""
      },
      {
        "override_id": 714,
        "override_type": "ITEM",
        "price": 0,
        "override_sku": "1248187953"
      }
    ]
  },
  "quantity_info": {
    "min_permitted": 0,
    "max_permitted": 5,
    "modifiers_type": null,
    "overrides": [
      {
        "override_id": 641,
        "override_type": "STORE",
        "min_permitted": 0,
        "max_permitted": 2,
        "modifiers_type": null,
        "override_sku": ""
      },
      {
        "override_id": 714,
        "override_type": "ITEM",
        "min_permitted": 0,
        "max_permitted": 1,
        "modifiers_type": null,
        "override_sku": "1248187953"
      }
    ]
  },
  "suspension_info": {
    "suspend_until": null,
    "suspend_reason": null,
    "overrides": [
      {
        "override_id": 641,
        "override_type": "STORE",
        "suspend_until": "2025-03-30T00:00:00Z",
        "suspend_reason": "Is stocked out",
        "created_at": "2025-03-27T22:01:41.647376Z",
        "override_sku": ""
      },
      {
        "override_id": 714,
        "override_type": "ITEM",
        "suspend_until": "2025-03-30T00:00:00Z",
        "suspend_reason": "Is stocked out",
        "created_at": "2025-03-27T22:01:41.647376Z",
        "override_sku": "1248187953"
      }
    ],
    "is_available": true
  },
  "schedules_info": {
    "schedules": [
      {
        "days_of_week": "mon,tue,wed,thu,fri",
        "time_periods": [
          {
            "start_time": "16:00",
            "end_time": "22:00"
          }
        ]
      }
    ],
    "overrides": [
      {
        "id": 26,
        "override_id": 641,
        "override_sku": "",
        "override_type": "STORE",
        "schedules": [
          {
            "days_of_week": "mon,tue,wed,thu,fri",
            "time_periods": [
              {
                "start_time": "16:00",
                "end_time": "23:00"
              }
            ]
          }
        ]
      },
      {
        "id": 27,
        "override_id": 714,
        "override_sku": "1248187953",
        "override_type": "ITEM",
        "schedules": [
          {
            "days_of_week": "mon,tue,wed,thu,fri",
            "time_periods": [
              {
                "start_time": "16:00",
                "end_time": "20:00"
              }
            ]
          }
        ]
      }
    ]
  }
}


Response Fields Description


This table describes the objects contained in the response example:






















































































































































































































































































































































FieldTypeDescription
idintIdentifier of the item.
skustringStock Keeping Unit (SKU) identifier of the item. It’s required unless the ID is sent.
store_idintIdentifier of the store in the application.
last_updatedstringTimestamp of the last update in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
item_typestringType of the item (ITEM or MODIFIER_GROUP).
title_info.titlestringTitle of the item.
title_info.overridesarrayList of title overrides for specific conditions.
title_info.overrides[].override_idintIdentifier of the title override.
title_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
title_info.overrides[].override_typestringType of override (STORE or ITEM).
title_info.overrides[].titlestringOverride title.
description_info.descriptionstringDescription of the item.
description_info.overridesarrayList of description overrides for specific conditions.
description_info.overrides[].override_idintIdentifier of the description override.
description_info.overrides[].override_typestringType of override (STORE or ITEM).
description_info.overrides[].descriptionstringOverride description.
description_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
images_info.imagesarrayList of images associated with the item.
images_info.images[].idintIdentifier of the image.
images_info.images[].pathstringThe path where the image is in the CDN
images_info.images[].indexintThe position where that image should be positioned.
images_info.images[].hoststringThe image CDN host
images_info.overridesarrayList of image overrides for specific conditions.
images_info.overrides[].override_idintIdentifier of the image override.
images_info.overrides[].override_typestringType of override (STORE or ITEM).
images_info.overrides[].imagesarrayList of overridden images.
images_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
items_info.itemsarrayList of related items.
items_info.items[].idintIdentifier of the related item.
items_info.items[].skustringSKU of the related item. It’s required unless the ID is sent.
items_info.items[].indexintOrder index of the related item.
items_info.overridesarrayList of item overrides for specific conditions.
items_info.overrides[].override_idintIdentifier of the item override.
items_info.overrides[].override_typestringType of override (STORE or ITEM).
items_info.overrides[].itemsarrayList of overridden items.
items_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
price_info.pricefloatPrice of the item.
price_info.overridesarrayList of price overrides for specific conditions.
price_info.overrides[].override_idintIdentifier of the price override.
price_info.overrides[].override_typestringType of override (STORE or ITEM).
price_info.overrides[].pricefloatThe price that should be applied when the override complies.
price_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
quantity_info.min_permittedintThe minimum amount of items permitted of this item when the item is ITEM type. And the minimum amount of items inside permitted when the item is MODIFIER_GROUP type. This field is required when the item is MODIFIER_GROUP.
quantity_info.max_permittedintThe maximum amount of items permitted of this item when the item is ITEM type. And the maximum amount of items inside permitted when the item is MODIFIER_GROUP type. This field is required when the item is MODIFIER_GROUP.
quantity_info.modifiers_typestringType of modifier (nullable).
quantity_info.overridesarrayList of quantity overrides for specific conditions.
quantity_info.overrides[].override_idintIdentifier of the quantity override.
quantity_info.overrides[].override_typestringType of override (STORE or ITEM).
quantity_info.overrides[].min_permittedintThe minimum amount of items permitted of this item when the item is ITEM type. And the minimum amount of items inside permitted when the item is MODIFIER_GROUP type. This field is required when the item is MODIFIER_GROUP.
quantity_info.overrides[].max_permittedintThe maximum amount of items permitted of this item when the item is ITEM type. And the maximum amount of items inside permitted when the item is MODIFIER_GROUP type. This field is required when the item is MODIFIER_GROUP.
quantity_info.overrides[].modifiers_typestringOverridden type of modifier (nullable).
quantity_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.
suspension_info.suspend_untilstringDate when the item is supposed to turn on. If null then is suspended permanently.
suspension_info.suspend_reasonstringReason why the item is suspended.
suspension_info.is_availableboolAvailability status of the item.
suspension_info.overridesarrayList of suspension overrides for specific conditions.
schedules_info.schedulesarrayList of schedules defining availability.
schedules_info.schedules[].days_of_weekstringDays of the week when the schedule is active.
schedules_info.schedules[].time_periodsarrayTime periods within the schedule.
schedules_info.schedules[].time_periods[].start_timestringStart time in HH:MM format.
schedules_info.schedules[].time_periods[].end_timestringEnd time in HH:MM format.
schedules_info.overridesarrayList of schedule overrides for specific conditions.
schedules_info.overrides[].override_idintIdentifier of the schedules override.
schedules_info.overrides[].override_typestringType of override (STORE CATEGORY or ITEM).
schedules_info.overrides[].schedulesarrayList of overridden schedules.
schedules_info.overrides[].override_skustringThe SKU of the override entity, it’s required unless the override_id is sent.