Contrato histórico: GET get-extras
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 extras de producto
Este endpoint de la API se utiliza para obtener todos los grupos de opciones de producto de un negocio.
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\": 49,\n \"business_id\": 0,\n \"name\": \"<redacted-personal>\",\n \"description\": null,\n \"enabled\": true,\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}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": false,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 49,
"default": 0
},
"business_id": {
"type": "integer",
"example": 0,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"description": {},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 53,
"default": 0
},
"extra_id": {
"type": "integer",
"example": 49,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"conditioned": {
"type": "boolean",
"example": false,
"default": true
},
"respect_to": {},
"min": {
"type": "integer",
"example": 1,
"default": 0
},
"max": {
"type": "integer",
"example": 1,
"default": 0
},
"rank": {
"type": "integer",
"example": 1,
"default": 0
},
"suboptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 172,
"default": 0
},
"extra_option_id": {
"type": "integer",
"example": 53,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"price": {
"type": "integer",
"example": 1,
"default": 0
},
"image": {},
"sku": {},
"rank": {
"type": "integer",
"example": 1,
"default": 0
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": true,\n \"result\": [\n \"ERROR_EXTRA_FINDALL\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": true,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "string",
"example": "ERROR_EXTRA_FINDALL"
}
}
}
}
}
}
},
"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."
}
}
}
}
}
}
}
}