API Reference

Listado de ordenes de compra

Este endpoint obtiene el listado de las ordenes de compra

HTTP Request

GET https://admin.cmmshere.com/api/v1/purchaseOrders

Parámetros de consulta

Estos parámetros son opcionales y utilizados para filtrar e interactuar con la información obtenida. Los parámetros de filtrado (si se utilizan) se usan para buscar resultados que contengan dicho texto.

ParámetroTipoDefaultDescripción
codStringNo definido
titleStringNo definidoSi se utiliza, el resultado solo incluirá el listado de ordenes de compra que contengan ese titulo
offsetIntNo definido
limitIntNo definido
orderByArray["created_at", "desc"]Ordenamiento. El primer valor es el campo y el segundo la direccion ASC o DESC

Ejemplo de petición

curl --location --request GET 'https://admin.cmmshere.com/api/v1/purchaseOrders' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 804|fCkDcz43egLAubMzPinRCIVUIjPUsGkvbVJ864IP' \
--header 'Cookie: XSRF-TOKEN=eyJpdiI6IktwckY2VTNIOU5UYVZvUjg5eUxXV2c9PSIsInZhbHVlIjoiOTlpVEZIVGRnZEJoRnN3RnpVK3lLMjZZQnBHVGFrc2VNZU5XVUplamswTjl1RC8yVk1JY0lUWGVSVDlIN0YxZnEzQldLQjRyUUFmTEQ2WWFhbDNDNXVVSTZ2QVg2aEkxTTNaZWI3NzlvZVJGV3dmRlFXUU5qVWhhelFCOFpRaTgiLCJtYWMiOiIwMzU2Y2YyNTk5YjE2ZmYyN2Y4MmJkMzQyNjg4MTU2MGJjZjY1MWZjYTAxMDdjNjlkYTkxYjIzZTkwZjZlMmZhIn0%3D; laravel_session=eyJpdiI6IkpMOHR1c3pYOHpXem9vZmhUa0RqUXc9PSIsInZhbHVlIjoiWGY3RGlUV3A3WGJyQ3JvZ29nWVdYWFRtbFA5U0VmU3RLdmVuMVZQcEMwa3B4VGlYb1M2SG5TYTA5U1hxclJNT2tyRDdoanhqWVFITHB3SEdENzZzaTl5RlBZR3hOc2VJNGQzczVxZDdTNC9pMVRobXBTckM4emlzTWtNNjFGS1kiLCJtYWMiOiIyZGZkODQ2YjI2YmU0NGUyYmU0YTAwNTBiNDk3ODU2MTMwMjEyOGUyOGE0YzIzOTMzZjAxZGQzMGY0MGVkOGU1In0%3D' \
--data '{
    "offset" : 0,
    "limit" : 10,
    "orderBy" : ["cod", "asc"]
}'

La petición de arriba devuelve un JSON estructurado de la siguiente manera

{
    "success": true,
    "code": 200,
    "results": [
        {
            "id": 6,
            "cod": "OC000001",
            "creator_id": 21,
            "provider_id": 0,
            "associate": "H",
            "title": "Orden de compra postman mod",
            "authorizer_id": null,
            "observation": "Observacion opcional mod",
            "status": "1",
            "created_at": "2023-09-11T20:56:15.000000Z",
            "details": []
        },
        {
            "id": 7,
            "cod": "OC000002",
            "creator_id": 30,
            "provider_id": 0,
            "associate": "F",
            "title": "Orden de compra postman mod",
            "authorizer_id": null,
            "observation": "Observacion opcional mod",
            "status": "1",
            "created_at": "2023-09-18T15:31:36.000000Z",
            "details": [
                {
                    "id": 8,
                    "purchase_id": 7,
                    "item_id": 8,
                    "quantity": "5.00",
                    "location": null,
                    "observation": "5 items por favor y del segundo 7",
                    "creator_id": 30,
                    "created_at": "2023-09-18T15:31:36.000000Z"
                },
                {
                    "id": 9,
                    "purchase_id": 7,
                    "item_id": 9,
                    "quantity": "7.00",
                    "location": null,
                    "observation": "",
                    "creator_id": 30,
                    "created_at": "2023-09-18T15:31:36.000000Z"
                }
            ]
        }
    ]
}