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

Consultar una recepción

La recepción con sus líneas recibidas (producto, cantidad, lote y series).

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

Parámetros de ruta

  • id integer obligatorio

    Identificador numérico del recurso.

Respuestas

200 La recepción con sus líneas.
  • data objeto obligatorio
    13 campos de data
    • id integer obligatorio
    • uuid string | null
    • concept string | null
    • status string obligatorio

      pending (por iniciar), started, finalized (terminado en el almacén), synchronized (enviado al ERP), cancelled, reverted.

      Valores: pending, started, finalized, synchronized, cancelled, reverted
    • comments string | null
    • user_id integer | null
    • operator objeto | null

      La persona que hizo el trabajo.

      2 campos de operator
      • id integer obligatorio
      • name string | null obligatorio
    • document objeto | null

      El documento sobre el que se trabajó.

      5 campos de document
      • id integer obligatorio
      • type string obligatorio

        Tipo interno del documento (purchase_order, sale_order, transfer_order…).

      • doc_num string | integer | null obligatorio
      • card_code string | null

        Código del proveedor o del cliente.

      • external_ref string | null

        La referencia externa que envió el sistema de origen.

    • started_at string (date-time) | null
    • finalized_at string (date-time) | null
    • created_at string (date-time) | null
    • updated_at string (date-time) | null
    • lines array de objetos obligatorio
      5 campos de lines
      • product_id integer obligatorio
      • item_code string | null obligatorio
      • qty number obligatorio
      • batch_num string | null
      • serials array de textos
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/receipts/101" \
  -H "Authorization: Bearer $CHAINLINK_TOKEN" \
  -H "Accept: application/json"
Respuesta
{
    "data": {
        "id": 5531,
        "uuid": "0f8e0c1e-6a7b-4b1e-9a51-3d0b7f2b8c11",
        "concept": "purchase_order",
        "status": "finalized",
        "comments": null,
        "user_id": 12,
        "operator": {
            "id": 12,
            "name": "Juan Pérez"
        },
        "document": {
            "id": 318,
            "type": "purchase_order",
            "doc_num": "OC-000318",
            "card_code": "PRV-001",
            "external_ref": "OC-2026-0042"
        },
        "started_at": "2026-10-06T17:01:00.000000Z",
        "finalized_at": "2026-10-06T17:12:44.000000Z",
        "created_at": "2026-10-06T16:20:12.000000Z",
        "updated_at": "2026-10-06T17:12:44.000000Z",
        "lines": [
            {
                "product_id": 101,
                "item_code": "P-1001",
                "qty": 48,
                "batch_num": "L2610",
                "serials": []
            }
        ]
    }
}