Contrato histórico: GET get-all-business-products
Contrato histórico de API. Esta página describe un contrato anterior. Los métodos, las rutas y las respuestas pueden diferir de la API vigente.
Significado histórico
Obtener todos los productos del negocio
Este endpoint de la API se utiliza para obtener todos los productos de un negocio específico.
API vigente
Para desarrollar una integración nueva, consulta la referencia o guía vigente enlazada.
Ver la referencia de la API vigenteParámetros
[
{
"name": "language",
"in": "path",
"schema": {
"type": "string",
"default": "en"
},
"required": true
},
{
"name": "project",
"in": "path",
"schema": {
"type": "string",
"default": "<redacted-personal>"
},
"required": true
},
{
"name": "business_id",
"in": "path",
"schema": {
"type": "integer",
"format": "int32"
},
"required": true
},
{
"name": "params",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api_version",
"in": "path",
"schema": {
"type": "string",
"default": "v400"
},
"required": true
},
{
"name": "menu_id",
"in": "query",
"description": "El ID del menú",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "timestamp",
"in": "query",
"description": "El tiempo para buscar productos disponibles en ese momento",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "type",
"in": "query",
"description": "Tipo de pedido, puede ser entrega (1) o recogida (2)",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "where",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
]
Cuerpo de solicitud
null
Respuestas
{
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": false,\n \"result\": [\n {\n \"id\": 1292,\n \"name\": \"<redacted-personal>\",\n \"price\": 3,\n \"description\": \"\",\n \"images\": \"https://example.com/ordering/image/upload/v1534195638/sp1iv1xmacqfnwyhbvkr.jpg\",\n \"sku\": null,\n \"category_id\": 248,\n \"inventoried\": false,\n \"quantity\": 0,\n \"featured\": false,\n \"enabled\": true,\n \"category\": null,\n \"extras\": [],\n \"gallery\": []\n },\n {\n \"id\": 1306,\n \"name\": \"<redacted-personal>\",\n \"price\": 15,\n \"description\": \"\",\n \"images\": \"https://example.com/ordering/image/upload/v1534195646/eqxguxf64ndnbzrqogpa.jpg\",\n \"sku\": null,\n \"category_id\": 248,\n \"inventoried\": false,\n \"quantity\": 0,\n \"featured\": false,\n \"enabled\": true,\n \"category\": null,\n \"extras\": [],\n \"gallery\": []\n },\n {\n \"id\": 1307,\n \"name\": \"<redacted-personal>\",\n \"price\": 25,\n \"description\": \"\",\n \"images\": \"https://example.com/ordering/image/upload/v1534195695/ghaoll9rp3rrd7fsfbnh.jpg\",\n \"sku\": null,\n \"category_id\": 248,\n \"inventoried\": false,\n \"quantity\": 0,\n \"featured\": false,\n \"enabled\": true,\n \"category\": null,\n \"extras\": [\n {\n \"id\": 49,\n \"business_id\": 0,\n \"name\": \"<redacted-personal>\",\n \"description\": null,\n \"enabled\": true,\n \"pivot\": {\n \"product_id\": 1307,\n \"extra_id\": 49\n },\n \"options\": [\n {\n \"id\": 53,\n \"extra_id\": 49,\n \"name\": \"<redacted-personal>\",\n \"conditioned\": false,\n \"respect_to\": null,\n \"min\": 1,\n \"max\": 1,\n \"rank\": 1,\n \"suboptions\": [\n {\n \"id\": 172,\n \"extra_option_id\": 53,\n \"name\": \"<redacted-personal>\",\n \"price\": 1,\n \"image\": null,\n \"sku\": null,\n \"rank\": 1\n },\n {\n \"id\": 173,\n \"extra_option_id\": 53,\n \"name\": \"<redacted-personal>\",\n \"price\": 3,\n \"image\": null,\n \"sku\": null,\n \"rank\": 1\n },\n {\n \"id\": 174,\n \"extra_option_id\": 53,\n \"name\": \"<redacted-personal>\",\n \"price\": 2,\n \"image\": null,\n \"sku\": null,\n \"rank\": 1\n }\n ]\n },\n {\n \"id\": 54,\n \"extra_id\": 49,\n \"name\": \"<redacted-personal>\",\n \"conditioned\": false,\n \"respect_to\": null,\n \"min\": 0,\n \"max\": 2,\n \"rank\": 2,\n \"suboptions\": [\n {\n \"id\": 175,\n \"extra_option_id\": 54,\n \"name\": \"<redacted-personal>\",\n \"price\": 0,\n \"image\": null,\n \"sku\": null,\n \"rank\": 2\n },\n {\n \"id\": 176,\n \"extra_option_id\": 54,\n \"name\": \"<redacted-personal>\",\n \"price\": 2,\n \"image\": null,\n \"sku\": null,\n \"rank\": 2\n }\n ]\n },\n {\n \"id\": 55,\n \"extra_id\": 49,\n \"name\": \"<redacted-personal>\",\n \"conditioned\": false,\n \"respect_to\": null,\n \"min\": 1,\n \"max\": 1,\n \"rank\": 3,\n \"suboptions\": [\n {\n \"id\": 177,\n \"extra_option_id\": 55,\n \"name\": \"<redacted-personal>\",\n \"price\": 0,\n \"image\": null,\n \"sku\": null,\n \"rank\": 3\n },\n {\n \"id\": 178,\n \"extra_option_id\": 55,\n \"name\": \"<redacted-personal>\",\n \"price\": 1,\n \"image\": null,\n \"sku\": null,\n \"rank\": 3\n }\n ]\n },\n {\n \"id\": 71,\n \"extra_id\": 49,\n \"name\": \"<redacted-personal>\",\n \"conditioned\": true,\n \"respect_to\": 178,\n \"min\": 1,\n \"max\": 1,\n \"rank\": 4,\n \"suboptions\": [\n {\n \"id\": 236,\n \"extra_option_id\": 71,\n \"name\": \"<redacted-personal>\",\n \"price\": 0,\n \"image\": null,\n \"sku\": null,\n \"rank\": 4\n },\n {\n \"id\": 237,\n \"extra_option_id\": 71,\n \"name\": \"<redacted-personal>\",\n \"price\": 0,\n \"image\": null,\n \"sku\": null,\n \"rank\": 4\n },\n {\n \"id\": 238,\n \"extra_option_id\": 71,\n \"name\": \"<redacted-personal>\",\n \"price\": 0,\n \"image\": null,\n \"sku\": null,\n \"rank\": 4\n }\n ]\n }\n ]\n }\n ],\n \"gallery\": []\n },\n {\n \"id\": 1311,\n \"name\": \"<redacted-personal>\",\n \"price\": 6,\n \"description\": \"\",\n \"images\": \"https://example.com/ordering/image/upload/v1534195653/emwcksavbdjsbx5wxtoe.jpg\",\n \"sku\": null,\n \"category_id\": 248,\n \"inventoried\": false,\n \"quantity\": 0,\n \"featured\": false,\n \"enabled\": true,\n \"category\": null,\n \"extras\": [\n {\n \"id\": 49,\n \"business_id\": 0,\n \"name\": \"<redacted-personal>\",\n \"description\": null,\n \"enabled\": true,\n \"pivot\": {\n \"product_id\": 1311,\n \"extra_id\": 49\n },\n \"options\": [\n {\n \"id\": 53,\n \"extra_id\": 49,\n \"name\": \"<redacted-personal>\",\n \"conditioned\": false,\n \"respect_to\": null,\n \"min\": 1,\n \"max\": 1,\n \"rank\": 1,\n \"suboptions\": [\n {\n \"id\": 172,\n \"extra_option_id\": 53,\n \"name\": \"<redacted-personal>\",\n \"price\": 1,\n \"image\": null,\n \"sku\": null,\n \"rank\": 1\n },\n {\n \"id\": 173,\n \"extra_option_id\": 53,\n \"name\": \"<redacted-personal>\",\n \"price\": 3,\n \"image\": null,\n \"sku\": null,\n \"rank\": 1\n },\n {\n \"id\": 174,\n \"extra_option_id\": 53,\n \"name\": \"<redacted-personal>\",\n \"price\": 2,\n \"image\": null,\n \"sku\": null,\n \"rank\": 1\n }\n ]\n },\n {\n \"id\": 54,\n \"extra_id\": 49,\n \"name\": \"<redacted-personal>\",\n \"conditioned\": false,\n \"respect_to\": null,\n \"min\": 0,\n \"max\": 2,\n \"rank\": 2,\n \"suboptions\": [\n {\n \"id\": 175,\n \"extra_option_id\": 54,\n \"name\": \"<redacted-personal>\",\n \"price\": 0,\n \"image\": null,\n \"sku\": null,\n \"rank\": 2\n },\n {\n \"id\": 176,\n \"extra_option_id\": 54,\n \"name\": \"<redacted-personal>\",\n \"price\": 2,\n \"image\": null,\n \"sku\": null,\n \"rank\": 2\n }\n ]\n },\n {\n \"id\": 55,\n \"extra_id\": 49,\n \"name\": \"<redacted-personal>\",\n \"conditioned\": false,\n \"respect_to\": null,\n \"min\": 1,\n \"max\": 1,\n \"rank\": 3,\n \"suboptions\": [\n {\n \"id\": 177,\n \"extra_option_id\": 55,\n \"name\": \"<redacted-personal>\",\n \"price\": 0,\n \"image\": null,\n \"sku\": null,\n \"rank\": 3\n },\n {\n \"id\": 178,\n \"extra_option_id\": 55,\n \"name\": \"<redacted-personal>\",\n \"price\": 1,\n \"image\": null,\n \"sku\": null,\n \"rank\": 3\n }\n ]\n },\n {\n \"id\": 71,\n \"extra_id\": 49,\n \"name\": \"<redacted-personal>\",\n \"conditioned\": true,\n \"respect_to\": 178,\n \"min\": 1,\n \"max\": 1,\n \"rank\": 4,\n \"suboptions\": [\n {\n \"id\": 236,\n \"extra_option_id\": 71,\n \"name\": \"<redacted-personal>\",\n \"price\": 0,\n \"image\": null,\n \"sku\": null,\n \"rank\": 4\n },\n {\n \"id\": 237,\n \"extra_option_id\": 71,\n \"name\": \"<redacted-personal>\",\n \"price\": 0,\n \"image\": null,\n \"sku\": null,\n \"rank\": 4\n },\n {\n \"id\": 238,\n \"extra_option_id\": 71,\n \"name\": \"<redacted-personal>\",\n \"price\": 0,\n \"image\": null,\n \"sku\": null,\n \"rank\": 4\n }\n ]\n }\n ]\n }\n ],\n \"gallery\": []\n },\n {\n \"id\": 1313,\n \"name\": \"<redacted-personal>\",\n \"price\": 9,\n \"description\": \"\",\n \"images\": \"https://example.com/ordering/image/upload/v1534195678/rwhjbwtyeoovuxpnc2ji.jpg\",\n \"sku\": null,\n \"category_id\": 248,\n \"inventoried\": false,\n \"quantity\": 0,\n \"featured\": false,\n \"enabled\": true,\n \"category\": null,\n \"extras\": [],\n \"gallery\": []\n },\n {\n \"id\": 1317,\n \"name\": \"<redacted-personal>\",\n \"price\": 12,\n \"description\": \"\",\n \"images\": \"https://example.com/ordering/image/upload/v1534195712/m9sjhctswve0lg3uvk7n.jpg\",\n \"sku\": null,\n \"category_id\": 248,\n \"inventoried\": false,\n \"quantity\": 0,\n \"featured\": false,\n \"enabled\": true,\n \"category\": null,\n \"extras\": [],\n \"gallery\": []\n },\n {\n \"id\": 1323,\n \"name\": \"<redacted-personal>\",\n \"price\": 4.56,\n \"description\": \"\",\n \"images\": \"https://example.com/ordering/image/upload/v1534195661/wkj7g333edl9zhyvtqcn.jpg\",\n \"sku\": null,\n \"category_id\": 248,\n \"inventoried\": false,\n \"quantity\": 0,\n \"featured\": false,\n \"enabled\": true,\n \"category\": null,\n \"extras\": [],\n \"gallery\": []\n },\n {\n \"id\": 1327,\n \"name\": \"<redacted-personal>\",\n \"price\": 32,\n \"description\": \"\",\n \"images\": \"https://example.com/ordering/image/upload/v1534195705/unqv1kt3udpxzetzfjac.jpg\",\n \"sku\": null,\n \"category_id\": 248,\n \"inventoried\": false,\n \"quantity\": 0,\n \"featured\": false,\n \"enabled\": true,\n \"category\": null,\n \"extras\": [],\n \"gallery\": []\n }\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": false,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1292,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"price": {
"type": "integer",
"example": 3,
"default": 0
},
"description": {
"type": "string",
"example": ""
},
"images": {
"type": "string",
"example": "https://example.com/ordering/image/upload/v1534195638/sp1iv1xmacqfnwyhbvkr.jpg"
},
"sku": {},
"category_id": {
"type": "integer",
"example": 248,
"default": 0
},
"inventoried": {
"type": "boolean",
"example": false,
"default": true
},
"quantity": {
"type": "integer",
"example": 0,
"default": 0
},
"featured": {
"type": "boolean",
"example": false,
"default": true
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"category": {},
"extras": {
"type": "array"
},
"gallery": {
"type": "array"
}
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": true,\n \"result\": [\n \"Could not get the products.\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": true,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "string",
"example": "Could not get the products."
}
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": ""
}
}
}
}
}
}