Categorías
🔹 Crear categorías
Consulta: POST /v1/{marketplace_code}/categories
Deben ser enviadas dentro de un Array<Object>.
Campos de cada categoría:
| Nombre | Descripción | Tipo de dato | Obligatorio | Valores permitidos |
|---|---|---|---|---|
code | Código | String | X | Ver abajo |
name | Nombre | String | X | |
deprecated | Si la categoría está deprecada | Boolean | ||
parent_code | Código de la categoría padre | String | ||
* features | Atributos de la categoría | Array<Object> |
Aclaraciones:
- Formato del código (
code): Debe cumplir con la siguiente regex:/^[a-zA-Z0-9\-_]+$/. Es decir que sólo puede contener números, letras del alfabeto latino, guiones bajos y guiones medios. - Una categoría deprecada (
deprecated=true) no podrá ser usada por el seller. - El campo
featuresfunciona como atajo al endpoint para crear atributos. Se le imponen las mismas reglas que en dicho endpoint.
Ejemplo de payload para la consulta:
[
{
"code": "tv",
"name": "Televisores",
"parent_code": null
},
{
"code": "smart_tv",
"name": "Smart TV",
"parent_code": "tv"
},
{
"code": "laptops",
"name": "Laptops",
"parent_code": null,
"features": [
{
"code": "brand",
"name": "Marca",
"type": "textbox",
"required": true,
"options": []
}
]
}
]
Respuesta:
Código HTTP: 201
Devuelve las entidades creadas.
🔹 Índice de categorías
Consulta: GET /v1/{marketplace_code}/categories
Parámetros:
| Nombre | Descripción | Valores permitidos | Comentarios |
|---|---|---|---|
deprecated | Categorías deprecadas | true | false | deprecated = true: Muestra sólo deprecadas. deprecated = false: Muestra sólo no deprecadas. Si no se envía se devuelven todas las categorías |
Respuesta:
Código HTTP: 200
[
{
"code": "tv",
"name": "Televisores",
"deprecated": false,
"parent_code": null,
"features": [
{
"code": "brand",
"name": "Marca",
"type": "textbox",
"required": true,
"options": []
}
]
},
{
"code": "smart_tv",
"name": "Smart TV",
"deprecated": false,
"parent_code": "tv",
"features": [
{
"code": "brand",
"name": "Marca",
"type": "textbox",
"required": true,
"options": []
}
]
}
]
🔹 Obtener una categoría
Consulta: GET /v1/{marketplace_code}/categories/{code}
Respuesta:
Código HTTP: 200
{
"code": "tv",
"name": "Televisores",
"deprecated": false,
"parent_code": null,
"features": [
{
"code": "brand",
"name": "Marca",
"type": "textbox",
"required": true,
"options": []
}
]
}
🔹 Actualizar una categoría
Consulta: PATCH /v1/{marketplace_code}/categories/{code}
Campos actualizables:
| Nombre | Descripción | Tipo de dato | Obligatorio |
|---|---|---|---|
name | Nombre | String | |
parent_code | Código | String | |
deprecated | Si la categoría está deprecada | Boolean | |
* features | Atributos de la categoría | Array<Object> |
Aclaraciones:
- Una categoría deprecada no podrá ser usada por el vendedor.
- El campo
featuresfunciona como atajo al endpoint para actualizar atributos. Se le imponen las mismas reglas que en dicho endpoint.
Ejemplo de payload para la consulta:
{
"name": "Laptops",
"parent_code": null,
"features": [
{
"code": "brand",
"name": "Marca",
"type": "textbox",
"required": true,
"options": []
}
]
}
Respuesta:
Código HTTP: 200
Devuelve la entidad actualizada.
🔹 Upsert de categorías
Consulta: PUT /v1/{marketplace_code}/categories
Si se envía una categoría que ya existe se actualiza, si no existe se crea. Se imponen las mismas reglas que al crear una categoría.