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 /transfer-orders/{id}

Consultar una orden de transferencia

Alcance (cliente de integración)
transfers:read
Permiso (token de usuario)
Token válido
Idempotency-Key
No aplica
Requisitos
Órdenes de transferencia activas

Parámetros de ruta

  • id integer obligatorio

    Identificador numérico del recurso.

Respuestas

200 La orden con sus líneas y unidades pedidas, surtidas, despachadas y recibidas.
  • data objeto obligatorio
    26 campos de data
    • object string «transfer_order» obligatorio
    • id integer obligatorio
    • code string obligatorio
    • status string obligatorio
      Valores: draft, released, picking, picked, in_transit, receiving, received, closed, cancelled
    • status_label string
    • headline string | null
    • has_discrepancy boolean

      Lo recibido no coincide con lo despachado.

    • from objeto obligatorio
      3 campos de from
      • id integer | null
      • code string | null
      • name string | null
    • to objeto obligatorio
      3 campos de to
      • id integer | null
      • code string | null
      • name string | null
    • priority integer
    • reason string | null
    • due_at string (date-time) | null
    • lines_count integer
    • units objeto obligatorio
      4 campos de units
      • requested number
      • picked number
      • dispatched number
      • received number
    • dispatched_at string (date-time) | null
    • received_at string (date-time) | null
    • closed_at string (date-time) | null
    • seal_number string | null
    • vehicle_plate string | null
    • carrier_id integer | null
    • external_ref string | null
    • source string
      Valores: web, api, import, sap
    • picking_id integer | null
    • receipt_id integer | null
    • sap objeto | null

      Estado del envío al ERP cuando aplica.

    • lines array de objetos | null

      null en el listado; en el detalle, las líneas.

      11 campos de lines
      • id integer
      • line_num integer
      • product_id integer | null
      • item_code string | null
      • qty number
      • picked_qty number
      • dispatched_qty number
      • received_qty number
      • batch_num string | null
      • serial_numbers array de textos
      • status string
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.

404 El recurso no existe.

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/transfer-orders/101" \
  -H "Authorization: Bearer $CHAINLINK_TOKEN" \
  -H "Accept: application/json"
Respuesta 
{
    "data": {
        "object": "transfer_order",
        "id": 41,
        "code": "TR-000041",
        "status": "in_transit",
        "status_label": "En tránsito",
        "headline": "CEDIS-GDL → TDA-MTY",
        "has_discrepancy": false,
        "from": {
            "id": 1,
            "code": "CEDIS-GDL",
            "name": "CEDIS Guadalajara"
        },
        "to": {
            "id": 2,
            "code": "TDA-MTY",
            "name": "Tienda Monterrey"
        },
        "priority": 50,
        "reason": "Reabasto semanal",
        "due_at": "2026-10-08T18:00:00-06:00",
        "lines_count": 1,
        "units": {
            "requested": 24,
            "picked": 24,
            "dispatched": 24,
            "received": 0
        },
        "dispatched_at": "2026-10-07T09:30:00-06:00",
        "received_at": null,
        "closed_at": null,
        "seal_number": "S-99812",
        "vehicle_plate": "JAL-123-A",
        "carrier_id": 3,
        "external_ref": "TR-2026-0107",
        "source": "api",
        "picking_id": 6120,
        "receipt_id": null,
        "sap": {
            "dispatch": null,
            "receipt": null
        },
        "lines": [
            {
                "id": 77,
                "line_num": 0,
                "product_id": 101,
                "item_code": "P-1001",
                "qty": 24,
                "picked_qty": 24,
                "dispatched_qty": 24,
                "received_qty": 0,
                "batch_num": null,
                "serial_numbers": [],
                "status": "dispatched"
            }
        ]
    }
}