API: Productos

M: Consultar productos

HTTP GET:

https://<hostname>/api/order-entry/product[/<id>]

URL PARAMETERS:

	Nombre	Tipo	Requerido	Descripción
id	Id de Producto	Numérico	no	Si se incluye, permite consultar un producto específico.

OUTPUT:

Json con los campos:

• success: boolean
• data: json Contiene una lista de Product Objects

EJEMPLO CON CURL:

$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/order-entry/product

RESPUESTA:

{
    "success": true,
    "data": [
        {
            "id": "9",
            "client_id": "22",
            "category_id": "2",
            "code": "2345",
            "name": "iPhone 7 Plus",
            "price": "769.00",
            "description": "The brightest, most colorful iPhone display...",
            "picture": "",
            "creation_date": "2017-09-07 21:03:14+00",
            "changed_date": "2017-09-07 21:03:14+00"
        },
        {
            "id": "10",
            "client_id": "22",
            "category_id": "2",
            "code": "3456",
            "name": "Samsung S8+",
            "price": "799.99",
            "description": "It's the biggest screen on a Galaxy smartphone...",
            "picture": "",
            "creation_date": "2017-09-07 21:47:02+00",
            "changed_date": "2017-09-07 21:47:02+00"
        }
    ]
}

M: Crear nuevo producto

HTTP POST:

https://<hostname>/api/order-entry/product

BODY PARAMETERS:

Campo	Nombre	Tipo	Formato	Requerido	Descripción
category_id	Id de Categoría	Numérico		sí	Debe ser un id existente.
code	Código	Texto		no
name	Nombre	Texto		no
price	Precio	Punto flotante		sí
description	Descripción	Texto		no
picture	Foto	Foto	Base 64	no

OUTPUT:

Json con los campos:

• success: boolean
• data: json El Product 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/product
     -d "category_id=2&name=Producto&price=100.50&code=M-123479832-P
         &description=Herramienta%20%C3%BAtil%20para%20trabajar."

RESPUESTA:

{
    "success": true,
    "data": {
        "id": "13",
        "client_id": "22",
        "category_id": "2",
        "code": "M-123479832-P",
        "name": "Producto",
        "price": "100.50",
        "description": "Herramienta útil para trabajar.",
        "picture": null,
        "creation_date": "2017-09-07 21:47:02+00",
        "changed_date": "2017-09-07 21:47:02+00"
    }
}

M: Editar producto existente

HTTP PUT:

https://<hostname>/api/order-entry/product/<id>

URL PARAMETERS:

	Nombre	Tipo	Requerido
id	Id de Producto	Numérico	sí

BODY PARAMETERS:

Campo	Nombre	Tipo	Formato	Descripción
category_id	Id de Categoría	Numérico		Debe ser un id existente.
code	Código	Texto
name	Nombre	Texto
price	Precio	Punto flotante
description	Descripción	Texto
picture	Foto	Foto	Base 64

OUTPUT:

Json con los campos:

• success: boolean
• data: json El Product 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/product/13
     -d "price=256.75"

RESPUESTA:

{
    "success": true,
    "data": {
        "id": "13",
        "client_id": "22",
        "category_id": "2",
        "code": "M-123479832-P",
        "name": "Producto",
        "price": "256.75",
        "description": "Herramienta útil para trabajar.",
        "picture": null,
        "creation_date": "2017-09-07 21:47:02+00",
        "changed_date": "2017-11-02 18:25:33+00"
    }
}

M: Eliminar producto existente

HTTP DELETE:

https://<hostname>/api/order-entry/product/<id>

URL PARAMETERS:

	Nombre	Tipo	Requerido
id	Id de Producto	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/product/13

RESPUESTA:

{
    "success": true
}

M: Consultar productos por categoría

HTTP GET:

https://<hostname>/api/order-entry/category/<id>/product

URL PARAMETERS:

	Nombre	Tipo	Requerido
id	Id de Categoría	Numérico	sí

OUTPUT:

Json con los campos:

• success: boolean
• data: json Contiene una lista de Product Objects

EJEMPLO CON CURL:

$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/order-entry/category/2/product

RESPUESTA:

{
    "success": true,
    "data": [
        {
            "id": "9",
            "client_id": "22",
            "category_id": "2",
            "code": "2345",
            "name": "iPhone 7 Plus",
            "price": "769.00",
            "description": "The brightest, most colorful iPhone display...",
            "picture": "",
            "creation_date": "2017-09-07 21:03:14+00",
            "changed_date": "2017-09-07 21:03:14+00"
        },
        {
            "id": "10",
            "client_id": "22",
            "category_id": "2",
            "code": "3456",
            "name": "Samsung S8+",
            "price": "799.99",
            "description": "It's the most immersive screen on a Galaxy smartphone...",
            "picture": "",
            "creation_date": "2017-09-07 21:47:02+00",
            "changed_date": "2017-09-07 21:47:02+00"
        }
    ]
}

M: Consultar productos por catálogo

HTTP GET:

https://<hostname>/api/order-entry/catalog/<id>/product

URL PARAMETERS:

	Nombre	Tipo	Requerido
id	Id de Catálogo	Numérico	sí

OUTPUT:

Json con los campos:

• success: boolean
• data: json Contiene listas de Product Objects agrupados por Categorías que pertenecen al Catálogo consultado.

EJEMPLO CON CURL:

$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/order-entry/category/2/product

RESPUESTA:

{
    "success": true,
    "data": {
        "Smartphones": [
            {
                "id": "9",
                "client_id": "22",
                "category_id": "2",
                "code": "2345",
                "name": "iPhone 7 Plus",
                "price": "769.00",
                "description": "The brightest, most colorful iPhone display...",
                "picture": null,
                "creation_date": "2017-09-07 21:03:14+00",
                "changed_date": "2017-09-07 21:03:14+00"
            },
            {
                "id": "10",
                "client_id": "22",
                "category_id": "2",
                "code": "3456",
                "name": "Samsung S8+",
                "price": "799.99",
                "description": "It's the most immersive screen on a Galaxy smartphone...",
                "picture": null,
                "creation_date": "2017-09-07 21:47:02+00",
                "changed_date": "2017-09-07 21:47:02+00"
            }
        ],
        "Cars": [
            {
                "id": "11",
                "client_id": "22",
                "category_id": "3",
                "code": "5678",
                "name": "Mazda 3",
                "price": "9999.99",
                "description": "Great performance, handling, styling and interior.",
                "picture": null,
                "creation_date": "2017-09-08 16:45:23+00",
                "changed_date": "2017-09-08 16:45:23+00"
            }
        ]
    }
}

O: Product Object

Campo	Nombre	Tipo	Descripción
id	Id	Numérico	Identificador único del Producto en la base de datos.
client_id	Id de la Compañía	Numérico	Identificador único de la Compañía.
category_id	Id de Categoría	Numérico	Identificador único de la Categoría de este Producto.
code	Código	Texto	Código personalizable para el Producto. (máximo 30 caracteres)
name	Nombre	Texto	Máximo 255 caracteres
price	Precio	Numérico	Precio con precisión de 2 decimales.
description	Descripción	Texto
picture	Foto	Foto
creation_date	Fecha de creación	Fecha
changed_date	Fecha de última modificación	Fecha