Contrato histórico: GET get-offers
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 ofertas del negocio
Este endpoint de la API se utiliza para obtener todas las ofertas 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
}
]
Cuerpo de solicitud
null
Respuestas
{
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": false,\n \"result\": [\n {\n \"id\": 1,\n \"business_id\": 0,\n \"name\": \"<redacted-personal>\",\n \"type\": 1,\n \"minimum\": 1000,\n \"rate_type\": 1,\n \"rate\": 10,\n \"start\": \"2016-06-03 00:00:00\",\n \"end\": \"2017-07-08 00:00:00\",\n \"coupon\": null,\n \"limit\": 99999,\n \"enabled\": true,\n \"business\": {\n \"id\": 41,\n \"name\": \"<redacted-personal>\",\n \"email\": \"<redacted-email>\",\n \"slug\": \"mcbonalds\",\n \"schedule\": [\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n }\n ],\n \"description\": \"\",\n \"about\": \"\",\n \"logo\": \"https://example.com/ordering2/image/upload/v1539095959/crya6ibldlsz4hjyo03e.jpg\",\n \"header\": \"https://example.com/ordering/image/upload/v1534195141/zdtztjdsxw3pw6pnsxeb.jpg\",\n \"phone\": \"<redacted-personal>\",\n \"cellphone\": \"<redacted-personal>\",\n \"owner_id\": 3,\n \"city_id\": 1,\n \"address\": \"<redacted-personal>\",\n \"address_notes\": null,\n \"zipcode\": null,\n \"location\": {\n \"lat\": 40.74677350000001,\n \"lng\": -73.98595739999996,\n \"zipcode\": -1,\n \"zoom\": 15\n },\n \"featured\": false,\n \"timezone\": \"America/New_York\",\n \"currency\": \"USD\",\n \"food\": true,\n \"alcohol\": false,\n \"groceries\": false,\n \"laundry\": false,\n \"use_printer\": false,\n \"printer_id\": null,\n \"minimum\": 0,\n \"delivery_price\": 0,\n \"always_deliver\": false,\n \"tax_type\": 2,\n \"tax\": 10,\n \"delivery_time\": \"0:0\",\n \"pickup_time\": \"0:0\",\n \"service_fee\": 9,\n \"fixed_usage_fee\": 1,\n \"percentage_usage_fee\": 10,\n \"enabled\": true\n }\n },\n {\n \"id\": 23,\n \"business_id\": 0,\n \"name\": \"<redacted-personal>\",\n \"type\": 1,\n \"minimum\": 2000,\n \"rate_type\": 2,\n \"rate\": 5,\n \"start\": \"2016-06-03 00:00:00\",\n \"end\": \"2017-07-08 00:00:00\",\n \"coupon\": null,\n \"limit\": 99999,\n \"enabled\": true,\n \"business\": {\n \"id\": 41,\n \"name\": \"<redacted-personal>\",\n \"email\": \"<redacted-email>\",\n \"slug\": \"mcbonalds\",\n \"schedule\": [\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n }\n ],\n \"description\": \"\",\n \"about\": \"\",\n \"logo\": \"https://example.com/ordering2/image/upload/v1539095959/crya6ibldlsz4hjyo03e.jpg\",\n \"header\": \"https://example.com/ordering/image/upload/v1534195141/zdtztjdsxw3pw6pnsxeb.jpg\",\n \"phone\": \"<redacted-personal>\",\n \"cellphone\": \"<redacted-personal>\",\n \"owner_id\": 3,\n \"city_id\": 1,\n \"address\": \"<redacted-personal>\",\n \"address_notes\": null,\n \"zipcode\": null,\n \"location\": {\n \"lat\": 40.74677350000001,\n \"lng\": -73.98595739999996,\n \"zipcode\": -1,\n \"zoom\": 15\n },\n \"featured\": false,\n \"timezone\": \"America/New_York\",\n \"currency\": \"USD\",\n \"food\": true,\n \"alcohol\": false,\n \"groceries\": false,\n \"laundry\": false,\n \"use_printer\": false,\n \"printer_id\": null,\n \"minimum\": 0,\n \"delivery_price\": 0,\n \"always_deliver\": false,\n \"tax_type\": 2,\n \"tax\": 10,\n \"delivery_time\": \"0:0\",\n \"pickup_time\": \"0:0\",\n \"service_fee\": 9,\n \"fixed_usage_fee\": 1,\n \"percentage_usage_fee\": 10,\n \"enabled\": true\n }\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": 1,
"default": 0
},
"business_id": {
"type": "integer",
"example": 0,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"type": {
"type": "integer",
"example": 1,
"default": 0
},
"minimum": {
"type": "integer",
"example": 1000,
"default": 0
},
"rate_type": {
"type": "integer",
"example": 1,
"default": 0
},
"rate": {
"type": "integer",
"example": 10,
"default": 0
},
"start": {
"type": "string",
"example": "2016-06-03 00:00:00"
},
"end": {
"type": "string",
"example": "2017-07-08 00:00:00"
},
"coupon": {},
"limit": {
"type": "integer",
"example": 99999,
"default": 0
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"business": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 41,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"email": {
"type": "string",
"example": "<redacted-email>"
},
"slug": {
"type": "string",
"example": "mcbonalds"
},
"schedule": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"lapses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "object",
"properties": {
"hour": {
"type": "integer",
"example": 0,
"default": 0
},
"minute": {
"type": "integer",
"example": 0,
"default": 0
}
}
},
"close": {
"type": "object",
"properties": {
"hour": {
"type": "integer",
"example": 23,
"default": 0
},
"minute": {
"type": "integer",
"example": 59,
"default": 0
}
}
}
}
}
}
}
}
},
"description": {
"type": "string",
"example": ""
},
"about": {
"type": "string",
"example": ""
},
"logo": {
"type": "string",
"example": "https://example.com/ordering2/image/upload/v1539095959/crya6ibldlsz4hjyo03e.jpg"
},
"header": {
"type": "string",
"example": "https://example.com/ordering/image/upload/v1534195141/zdtztjdsxw3pw6pnsxeb.jpg"
},
"phone": {
"type": "string",
"example": "<redacted-personal>"
},
"cellphone": {
"type": "string",
"example": "<redacted-personal>"
},
"owner_id": {
"type": "integer",
"example": 3,
"default": 0
},
"city_id": {
"type": "integer",
"example": 1,
"default": 0
},
"address": {
"type": "string",
"example": "<redacted-personal>"
},
"address_notes": {},
"zipcode": {},
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"example": 40.74677350000001,
"default": 0
},
"lng": {
"type": "number",
"example": -73.98595739999996,
"default": 0
},
"zipcode": {
"type": "integer",
"example": -1,
"default": 0
},
"zoom": {
"type": "integer",
"example": 15,
"default": 0
}
}
},
"featured": {
"type": "boolean",
"example": false,
"default": true
},
"timezone": {
"type": "string",
"example": "America/New_York"
},
"currency": {
"type": "string",
"example": "USD"
},
"food": {
"type": "boolean",
"example": true,
"default": true
},
"alcohol": {
"type": "boolean",
"example": false,
"default": true
},
"groceries": {
"type": "boolean",
"example": false,
"default": true
},
"laundry": {
"type": "boolean",
"example": false,
"default": true
},
"use_printer": {
"type": "boolean",
"example": false,
"default": true
},
"printer_id": {},
"minimum": {
"type": "integer",
"example": 0,
"default": 0
},
"delivery_price": {
"type": "integer",
"example": 0,
"default": 0
},
"always_deliver": {
"type": "boolean",
"example": false,
"default": true
},
"tax_type": {
"type": "integer",
"example": 2,
"default": 0
},
"tax": {
"type": "integer",
"example": 10,
"default": 0
},
"delivery_time": {
"type": "string",
"example": "0:0"
},
"pickup_time": {
"type": "string",
"example": "0:0"
},
"service_fee": {
"type": "integer",
"example": 9,
"default": 0
},
"fixed_usage_fee": {
"type": "integer",
"example": 1,
"default": 0
},
"percentage_usage_fee": {
"type": "integer",
"example": 10,
"default": 0
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": true,\n \"result\": [\n \"Error when looking for business offers\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": true,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "string",
"example": "Error when looking for business offers"
}
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": true,\n \"result\": [\n \"You do not have permission.\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": true,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "string",
"example": "You do not have permission."
}
}
}
}
}
}
}
}