List Shipments

Listar Embarques

Obtiene listado de embarques en base a los parámetros enviados.

Nombre	Tipo y longitud o rango de dato	Descripción	Requerido	Default
HOST	URL	Se indicará de acuerdo el ambiente donde será consumido el servicio: Producción: https://api.next-cloud.mx Staging: https://stg-api.next-cloud.mx	Sí	N/A

Resource URL

GET HOST/v1/shipments/?created_at_after=(date: created_at_after)&created_at_before=(date: created_at_before)&status=(string: status)

Parámetros:

• created_at_after (date) – (opcional) Fecha inicial del rango de creación (formato YYYY-MM-DD).

• created_at_before (date) – (opcional) Fecha final del rango de creación (formato YYYY-MM-DD).

• status (string) – (opcional) Estado del envío a filtrar. Ej: CF.

• page (int) – (opcional) Identificador de la pagina consultada.

• page_size (int) – (opcional) Total de resultados por pagina (por defecto son 100).

Encabezados de solicitud:

• Authorization – Token del usuario.

• Content-Type – Define el formato en el que se envian los datos por el body.

Objeto JSON de respuesta:

• count (int) – Total de resultados obtenidos por la consulta.

• next (string) – Página siguiente de resultados.

• previous (string) – Página anterior de resultados.

• result (obj) – Objeto con resultados de la consulta.

Códigos de Status:

• 200 OK – Ningún error.

• 400 Bad Request – Algún parámetro es incorrecto.

• 401 Unauthorized – Token no válido o no enviado.

• 404 Not Found – El recurso no existe.

result object:

Objeto JSON de respuesta:

• folio (int) – Folio del embarque.

• reference_document (string) – Documento de referencia.

• reference_folio (int) – Folio del documento de referencia.

• reference_serie (string) – Serie del documento de referencia.

• status (string) – Clave de estado del embarque.

• created_at (date) – Fecha de emisión del embarque.

Example request

GET /v1/shipments/?created_at_after=2025-01-01&created_at_before=2025-05-30&status=CF HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Content-Type: application/json
Authorization: Token ( token del usuario )

Example Response

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET

{
    "count": 1317,
    "next": "http://localhost:8000/v1/shipments/?created_at_after=2025-07-30&created_at_before=2025-07-31&page=2",
    "previous": null,
    "results": [
        {
            "folio": 2356770,
            "reference_document": "FACTC",
            "reference_folio": 4776,
            "reference_serie": "E",
            "status": "EA",
            "created_at": "2025-07-31T12:55:38.843000Z"
        },
        {
            "folio": 2356769,
            "reference_document": "FACTC",
            "reference_folio": 989,
            "reference_serie": "X",
            "status": "S ",
            "created_at": "2025-07-31T12:33:17.423000Z"
        },
        {
            "folio": 2356768,
            "reference_document": "FACTC",
            "reference_folio": 988,
            "reference_serie": "X",
            "status": "S ",
            "created_at": "2025-07-31T12:08:49.597000Z"
        },
        {
            "folio": 2356767,
            "reference_document": "FACTC",
            "reference_folio": 987,
            "reference_serie": "X",
            "status": "S ",
            "created_at": "2025-07-31T12:08:02.160000Z"
        },
        {
            "folio": 2356766,
            "reference_document": "FACTC",
            "reference_folio": 986,
            "reference_serie": "X",
            "status": "S ",
            "created_at": "2025-07-31T11:56:58.883000Z"
        }
	]
}