API: Pedidos

M: Consultar pedidos

HTTP GET:

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

URL PARAMETERS

Nombre Tipo Requerido Descripción
id Id de Pedido Numérico no Si se incluye, permite consultar una pedido específico.

OUTPUT:

Json con los campos:

EJEMPLO CON CURL:

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

RESPUESTA:

{
    "success": true,
    "data": {
        "count": "4",
        "orders": [
            {
                "id": "34",
                "client_id": "22",
                "user_id": "69",
                "refpoint_id": "482",
                "order_type": "0",
                "timestamp": "1542030874341",
                "total": "89999.91",
                "creation_date": "2018-11-12 13:55:04+00",
                "changed_date": "2018-11-12 13:55:04+00",
                "deactivated": "0"
            },
            {
                "id": "33",
                "client_id": "22",
                "user_id": "69",
                "refpoint_id": "9935",
                "order_type": "1",
                "timestamp": "1541797796930",
                "total": "7999.90",
                "creation_date": "2018-11-09 21:10:06+00",
                "changed_date": "2018-11-09 21:10:06+00",
                "deactivated": "0"
            },
            {
                "id": "32",
                "client_id": "22",
                "user_id": "69",
                "refpoint_id": "9229",
                "order_type": "0",
                "timestamp": "1541794695289",
                "total": "7999.90",
                "creation_date": "2018-11-09 20:18:31+00",
                "changed_date": "2018-11-09 20:18:31+00",
                "deactivated": "0"
            },
            {
                "id": "31",
                "client_id": "22",
                "user_id": "69",
                "refpoint_id": "9256",
                "order_type": "1",
                "timestamp": "1541622764120",
                "total": "100000.00",
                "creation_date": "2018-11-09 18:48:17+00",
                "changed_date": "2018-11-09 18:48:17+00",
                "deactivated": "0"
            }
        ]
    }
}

M: Crear nuevo pedido

HTTP POST:

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

POST BODY:

Campo Nombre Tipo Formato Requerido
refpoint_id Nombre Numérico
order_type Nombre Numérico
timestamp Nombre
products Nombre Arreglo del Order Product Object

OUTPUT:

Json con los campos:

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     -X POST
     https://<hostname>/api/order-entry/order
     -d 'refpoint_id= 132&timestamp=1541777682&order_type=0&products=[{ "product_id": "17", "qty": "12", "price": "799.99" }, { "product_id": "18", "qty": "100", "price": "55.00" }]'

RESPUESTA:

{
    "success": true,
    "data":   {
        "refpoint_id": 2088304,
        "timestamp": 1541622764120,
        "order_type": 0,
        "products": [{
                "product_id": 17,
                "qty": 12,
                "price": 799.99
            },
            {
                "product_id": 18,
                "qty": 100,
                "price": 55.00
            }
        ]
    }
}

M: Eliminar pedido existente

HTTP DELETE:

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

URL PARAMETERS

Nombre Tipo Requerido
id Id del pedido Numérico

OUTPUT:

Json con los campos:

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     -X DELETE
     https://<hostname>/api/order-entry/order/3

RESPUESTA:

{
    "success": true
}

O: Order Object

Campo Nombre Tipo Descripción
id Id Numérico Identificador único del pedido en la base de datos.
client_id Id de la Compañía Numérico Identificador único de la Compañía.
user_id Id del usuario Numérico Identificador único del usuario.
refpoint_id Geocerca Numérico Identificador único de la geocerca.
order_type Tipo de pedido Numérico 0 => Orden, 1 => Inventario
timestamp Timestamp
total Total Numérico
creation_date Fecha de creación Fecha
changed_date Fecha de última modificación Fecha

O: Order Product Object

Campo Nombre Tipo Descripción
id Id Numérico Identificador único del producto pedido en la base de datos.
order_id Id del pedido Numérico Identificador único del pedido.
product_id Id del producto Numérico Identificador único del producto.
qty Cantidad Numérico Cantidad de productos.
price Precio Numérico Precio unitario del producto