Get shipments list

GET

/api/shipments

Returns a paginated list of shipments.
Use limit to control pagination.

Solicitud

Autorización

API Key

Agregar parámetro en header

x-api-key

Ejemplo:

x-api-key: ********************

Parámetros de consulta

Respuestas

🟢200

application/json

Successful response with shipment list

Body

Ejemplo de Solicitud

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/shipments?limit' \
--header 'x-api-key: <api-key>'

Ejemplo de Respuesta

[
    {
        "summary": {
            "description": "Successful response with shipment list"
        },
        "value": {
            "_id": "676767676767676767676767",
            "idFinan": "1234567890_3df2g",
            "client": "Client 1",
            "company": "Company 1",
            "shipments": [
                {
                    "id": "ID123",
                    "shipment": "123456",
                    "date": 1708262400000,
                    "loadDate": 1708262400000,
                    "unloadDate": 1708262400000,
                    "region": "Region 1"
                }
            ],
            "origin": {
                "id": "ID123",
                "nif": "12345678",
                "address": {
                    "street": "Street 1",
                    "city": "City 1",
                    "province": "Province 1",
                    "country": "Country 1",
                    "zip": "12345"
                }
            },
            "destination": {
                "id": "ID123",
                "nif": "12345678",
                "address": {
                    "street": "Street 1",
                    "city": "City 1",
                    "province": "Province 1",
                    "country": "Country 1",
                    "zip": "12345"
                }
            }
        }
    }
]

Modificado en 2026-02-23 05:58:43

Retrieve financial documents list

Initialize SSE Stream