Desarrolladores API v1

Endpoints de la API. Especificación exacta de cada operación de la API v1 (parámetros, cuerpo, respuestas y ejemplos), generada del documento OpenAPI con el que se valida cada respuesta real. Los procedimientos completos están en Guías.

GET /exit-documents

Listar documentos de salida

Los documentos de salida con su avance por línea (open_qty, picked_qty).

Alcance (cliente de integración)
pickings:read
Permiso (token de usuario)
Token válido
Idempotency-Key
No aplica

Parámetros de consulta

  • page integer valor por omisión: 1

    Número de página, desde 1.

  • per_page integer valor por omisión: 25

    Elementos por página, de 1 a 100. Un valor mayor se toma como 100.

  • sort string valor por omisión: -created_at

    Campo de orden; antepón - para descendente.

    Valores: created_at, -created_at, updated_at, -updated_at, doc_date, -doc_date
  • updated_since string (date-time)

    Solo lo que cambió desde esta fecha (ISO 8601), para sincronización incremental.

  • external_ref string

    Referencia externa del documento.

  • type string

    Tipo interno (sale_order, delivery_note, goods_issue, dispatch_good).

  • card_code string

    Código del cliente.

  • status string

    Estado del documento.

  • source string

    Origen (api, import, web, sap).

Respuestas

200 Página de documentos de salida.
  • data array de objetos obligatorio
    16 campos de data
    • id integer obligatorio
    • doc_num string | null obligatorio
    • type string obligatorio
    • external_ref string | null
    • source string | null

      api, import, web o sap.

    • status string | null obligatorio
    • card_code string | null
    • card_name string | null
    • doc_date string (date) | null
    • due_date string (date) | null
    • comments string | null
    • created_at string (date-time) | null
    • updated_at string (date-time) | null
    • priority integer | null
    • ship_to string | null
    • lines array de objetos obligatorio
      7 campos de lines
      • line_num integer | null
      • item_code string | null obligatorio
      • qty number obligatorio
      • open_qty number obligatorio

        Lo que falta por surtir.

      • picked_qty number obligatorio
      • whs_code string | null
      • status string | null
  • links objeto obligatorio
    4 campos de links
    • first string (uri) | null obligatorio
    • last string (uri) | null obligatorio
    • prev string (uri) | null obligatorio

      Página anterior; null en la primera.

    • next string (uri) | null obligatorio

      Página siguiente; null en la última.

  • meta objeto obligatorio
    8 campos de meta
    • current_page integer obligatorio
    • from integer | null

      Posición del primer elemento de la página.

    • last_page integer obligatorio
    • links array de objetos

      Enlaces de página para interfaces; no hace falta leerlos.

    • path string (uri)
    • per_page integer obligatorio
    • to integer | null
    • total integer obligatorio

      Total de elementos con los filtros aplicados.

401 Falta el token o no es válido.

Cuerpo: el sobre de error.

402 La función no está en el plan de la empresa, o la cuenta está suspendida o cancelada.

Cuerpo: el sobre de error.

403 Al cliente le falta el alcance (missing_scope), al usuario el permiso (forbidden), o el token de usuario no tiene acceso a la ruta (client_not_allowed: aplicación móvil o usuario con verificación en dos pasos).

Cuerpo: el sobre de error.

422 Datos no válidos (validation_failed), una llave de idempotencia reutilizada con otra solicitud (idempotency_key_reused) o una regla de negocio que bloquea la operación (rule_blocked).

Cuerpo: el sobre de error.

429 Se superó el límite por minuto. Reintente después de los segundos de Retry-After.

Cuerpo: el sobre de error.

Probar

Probar con una instancia

La solicitud sale del navegador hacia la instancia indicada; nada pasa por chainlink.mx. El token se conserva solo en esta pestaña.

Obtener un token con un cliente de integración

Credenciales de Configuración › Clientes API (grant client_credentials). El secreto se usa una vez y no se guarda. Los tokens de usuario se obtienen fuera de la consola; ver Autenticación.

Solicitud 
curl "https://empresa.chainlink.mx/api/v1/exit-documents?external_ref=PED-88121" \
  -H "Authorization: Bearer $CHAINLINK_TOKEN" \
  -H "Accept: application/json"
Respuesta 
{
    "data": [
        {
            "id": 1,
            "doc_num": "OV-000001",
            "type": "sale_order",
            "external_ref": "PED-88121",
            "source": "api",
            "status": "open",
            "card_code": "CLI-001",
            "card_name": null,
            "doc_date": "2026-10-06",
            "due_date": "2026-10-06",
            "comments": null,
            "priority": 50,
            "ship_to": null,
            "lines": [
                {
                    "line_num": 0,
                    "item_code": "P-1001",
                    "qty": 6,
                    "open_qty": 6,
                    "picked_qty": 0,
                    "whs_code": "CEDIS-GDL",
                    "status": "open"
                }
            ],
            "created_at": "2026-10-06T16:20:11.000000Z",
            "updated_at": "2026-10-06T16:20:11.000000Z"
        }
    ],
    "links": {
        "first": "https://empresa.chainlink.mx/api/v1/exit-documents?external_ref=PED-88121&page=1",
        "last": "https://empresa.chainlink.mx/api/v1/exit-documents?external_ref=PED-88121&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [],
        "path": "https://empresa.chainlink.mx/api/v1/exit-documents",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}