Saltar a contenido

API: Categorías

M: Consultar categorías

HTTP GET:
https://<hostname>/api/order-entry/category[/<id>]
URL PARAMETERS:
Nombre Tipo Requerido Descripción
id Id de Categoría Numérico no Si se incluye, permite consultar una categoría específica.
OUTPUT:

Json con los campos:

EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/order-entry/category
RESPUESTA:
{
    "success": true,
    "data": [
        {
            "id": "2",
            "client_id": "22",
            "catalog_id": "1",
            "name": "Smartphones",
            "description": "Modern Smartphones",
            "picture": "",
            "creation_date": "2017-09-07 18:13:10.742+00",
            "changed_date": "2017-09-07 18:13:12.499+00"
        },
        {
            "id": "3",
            "client_id": "22",
            "catalog_id": "1",
            "name": "Cars",
            "description": "Modern Cars",
            "picture": "",
            "creation_date": "2017-09-07 22:45:24+00",
            "changed_date": "2017-09-07 22:45:24+00"
        }
    ]
}

M: Crear nueva categoría

HTTP POST:
https://<hostname>/api/order-entry/category
BODY PARAMETERS:
Campo Nombre Tipo Formato Requerido Descripción
catalog_id Id del Catálogo Numérico sí Debe ser un id existente.
name Nombre Texto no
description Descripción Texto no
picture Foto Foto Base 64 no
OUTPUT:

Json con los campos:

  • success: boolean
  • data: json El Category Object creado.
  • errors: json Lista de campos que contienen errores.
  • errorMsg: string Mensaje de error.
EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X POST
     https://<hostname>/api/vehicles/category
     -d "catalog_id=1&name=TV%20Sets&description=Modern%20TV%20Sets"
RESPUESTA:
{
    "success": true,
    "data": {
        "id": "5",
        "client_id": "22",
        "catalog_id": "1",
        "name": "TV Sets",
        "description": "Modern TV Sets",
        "picture": null,
        "creation_date": "2017-09-07 22:45:24+00",
        "changed_date": "2017-09-07 22:45:24+00"
    }
}

M: Editar categoría existente

HTTP PUT:
https://<hostname>/api/order-entry/category/<id>
URL PARAMETERS:
Nombre Tipo Requerido
id Id de Categoría Numérico sí
BODY PARAMETERS:
Campo Nombre Tipo Formato Descripción
catalog_id Id del Catálogo Numérico Debe ser un id existente.
name Nombre Texto
description Descripción Texto
picture Foto Foto Base 64
OUTPUT:

Json con los campos:

  • success: boolean
  • data: json El Category Object luego de ser editado.
  • errors: json Lista de campos que contienen errores.
  • errorMsg: string Mensaje de error.
EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X PUT
     https://<hostname>/api/vehicles/category/5
     -d "catalog_id=2"
RESPUESTA:
{
    "success": true,
    "data": {
        "id": "5",
        "client_id": "22",
        "catalog_id": "2",
        "name": "TV Sets",
        "description": "Modern TV Sets",
        "picture": null,
        "creation_date": "2017-09-07 22:45:24+00",
        "changed_date": "2017-11-07 03:15:52+00"
    }
}

M: Eliminar categoría existente

HTTP DELETE:
https://<hostname>/api/order-entry/category/<id>
URL PARAMETERS:
Nombre Tipo Requerido
id Id de Categoría Numérico sí
OUTPUT:

Json con los campos:

  • success: boolean
  • errorMsg: string Mensaje de error.
EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X DELETE
     https://<hostname>/api/vehicles/category/5
RESPUESTA:
{
    "success": true
}

M: Consultar productos por categoría

Ver documentación en Productos

O: Category Object

Campo Nombre Tipo Descripción
id Id Numérico Identificador único del Categoría en la base de datos.
client_id Id de la Compañía Numérico Identificador único de la Compañía.
catalog_id Id del Catálogo Numérico Identificador único del Catálogo de esta Categoría.
name Nombre Texto Máximo 255 caracteres
description Descripción Texto
picture Foto Foto
creation_date Fecha de creación Fecha
changed_date Fecha de última modificación Fecha