Categorías
Las categorías del market son las que te permiten segmentar los productos o servicios. Cada categoria tiene sus propias configuraciones y tipos de operaciones permitidos. A través de la API puedes consultar el listado de las categorias, buscar y obtener el detalle de cada una accediendo a los datos necesarios para luego poder gestionar los productos asociados a cada categoría.
URL Base: https://__URL_DE_TU_MARKET__/api/v1/categories/
Acciones
Listado de Categorias
URL: https://__URL_DE_TU_MARKET__/api/v1/categories/
Verbo: GET
Parametros a enviar
En la tabla que se muestra a continuación se listan los parametros recibidos por la API.
Parametro | Descripción | Condición |
|---|---|---|
search | Es el termino a buscar entre todas las categorias | Opcional |
Ejemplo de llamada GET
curl --location --request GET 'http://ingenio-market.loc/api/v1/categories/' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer 1|gcuLz11M0LapVax1kKsyi6T0RVOgJX4UXro0pSEf'
Ejemplo de respuesta
{
"data": [
{
"id": 1,
"name": "adipisci",
"selectable": 0,
"required_price": 0,
"link": "http://ingenio-market.loc/adipisci_5e179e2e23219",
"allow_variations": false,
"require_variations": false
},
{
"id": 2,
"name": "ea",
"selectable": 0,
"required_price": 0,
"link": "http://ingenio-market.loc/ea_5e179e2e23488",
"allow_variations": false,
"require_variations": false
}
.
.
.
],
"links": {
"first": "http://ingenio-market.loc/api/v1/categories?page=1",
"last": "http://ingenio-market.loc/api/v1/categories?page=13",
"prev": null,
"next": "http://ingenio-market.loc/api/v1/categories?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 13,
"path": "http://ingenio-market.loc/api/v1/categories",
"per_page": 15,
"to": 15,
"total": 182
}
}Detalle de una Categoría
URL: https://__URL_DE_TU_MARKET__/api/v1/categories/$ID_CATEGORY
Verbo: GET
Ejemplo de llamada
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -d 'https://__URL_DE_TU_MARKET__/api/v1/categories/130'
Ejemplo de respuesta
{
"data": {
"id": 52,
"name": "Remeras",
"selectable": 1,
"required_price": 0,
"link": "http://ingenio-market.loc/remera",
"allow_variations": true,
"require_variations": true,
"operation_types": [
{
"id": 1,
"name": "Compra / Venta",
"enabled_wholesale": 1
}
],
"features": [
{
"id": 1,
"name": "Modelo",
"type": "Opción Única Desplegable",
"options": [
{
"slug": "nuevo",
"text": "Nuevo"
},
{
"slug": "usado",
"text": "Usado"
}
],
"required": false
},
{
"id": 3,
"name": "Prueba Multiple",
"type": "Opción Multiple",
"options": [
{
"slug": "dsadsadsa",
"text": "dsadsadsa"
},
{
"slug": "sadsadsad",
"text": "sadsadsad"
},
{
"slug": "dsadsa",
"text": "dsadsa"
},
{
"slug": "dsa",
"text": "dsa"
},
{
"slug": "wwww",
"text": "wwww"
},
{
"slug": "eeee",
"text": "eeee"
},
{
"slug": "rrrr",
"text": "rrrr"
},
{
"slug": "tyyyyy",
"text": "tyyyyy"
},
{
"slug": "mmmm",
"text": "mmmm"
}
],
"required": false
},
{
"id": 4,
"name": "Decimal 2",
"type": "Número Decimal",
"required": false
}
],
"parent": null,
"children_categories": []
}
}Variaciones de una Categoría (Atributos)
URL: https://__URL_DE_TU_MARKET__/api/v1/categories/$ID_CATEGORY/attributes
Verbo: GET
Esta llamada te permite saber que atributos tiene disponible una categoria para a através de ellos generar las distintas variaciones de un item
Ejemplo de llamada
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -d 'https://__URL_DE_TU_MARKET__/api/v1/categories/130/attributes'
Ejemplo de respuesta
{
"data": [
{
"id": 2,
"name": "Color",
"required": false,
"type": "Opción Única Desplegable (con Estilo)",
"options": [
{
"id": 5,
"name": "Azul"
},
{
"id": 4,
"name": "Rojo"
}
]
},
{
"id": 3,
"name": "Talle",
"required": true,
"type": "Opción Única Desplegable (con Estilo)",
"options": [
{
"id": 6,
"name": "XS"
},
{
"id": 7,
"name": "S"
},
{
"id": 8,
"name": "M"
},
{
"id": 9,
"name": "L"
}
]
}
]
}Crear una Categoria
URL: https://__URL_DE_TU_MARKET__/api/v1/categories/
Verbo: POST
Esta llamada te permite crear una categoria
Cada categoria tiene los siguientes datos:
Dato | Tipo | Observaciones |
|---|---|---|
name | string | Es el nombre del item. Obligatorio |
operation_types_id | array de ids de tipos de operaciones Ejemplo : [15,34,23] | Es obligatorio en el caso de que exista mas de un tipo de operacion habilitado. En el caso de que haya solo 1 se vinuclará la categoria a ese tipo de operacion. |
category_id | integer | Es el identificador de la categoria a la que pertenece. Si no se envia será una categoría raiz |
slug | string | Es el path para crear la url de la categoria. Si no se pasa se le asigna uno automaticamente |
priority | integer | Es un numero que determina la prioridad |
tag_seo_title | string | Tag seo para el titulo |
tag_seo_description | string | Tag seo para la descripcion |
operation_type_id | integer | Es el identificador del tipo de operación del item. El tipo de operación debe ser permitido por la categoria del item |
image | string | Url de la imagen para la categoría |
tags | string con tags separados por comas o array de tag [ tag1, tag2, …. ] | |
restricted_to_minors | Booleano Por defecto: true | Determina si para ver productos de esta categoría se debe ser mayor de edad. |
hide_in_navigation | Booleano Por defecto: true | |
required_price | Booleano Por defecto: true | Determina si los productos de esta categoría tendrán que ingresar obligatoriamente el precio. |
enabled_discount_rate | Booleano Por defecto: true | |
enabled_reserve_percentage | Booleano Por defecto: true | Determina si los productos de esta categoría tendrán la posibilidad de cargar un porcentaje de reserva si lo desea el vendedor. |
has_shipping | Booleano Por defecto: true | Determina si los productos requieren ser enviados o entregados. Por ejemplo una remera requiere ser enviada sin embargo una reserva de hotel no. |
show_data_contact_store | Booleano Por defecto: false | |
features_id | array de ids de carecteristicas Ejemplo : [15,34,23] | |
attributes_id | array de ids de atributos Ejemplo : [15,34,23] |
Ejemplo de llamada