Instancia, URL base y formato

URL base por empresa, formato de solicitudes y respuestas, fechas, cantidades e identificadores.

En esta página

Una API por empresa

Cada empresa tiene su propia instancia de Chainlink y su propia API. La URL base usa el subdominio de la empresa; en los ejemplos, empresa se sustituye por ese subdominio.

Si la empresa usa un dominio propio, la API también responde en ese dominio (https://wms.dominio-propio.com/api/v1). Los datos de una instancia no se comparten con otra, y un token emitido por una instancia no es válido en otra. El token se solicita en la misma instancia: https://empresa.chainlink.mx/oauth/token.

URL base
https://empresa.chainlink.mx/api/v1

Formato de solicitudes

  • Solo HTTPS. Envíe Accept: application/json; la API siempre responde JSON.
  • Los cuerpos van en JSON con Content-Type: application/json, salvo la carga masiva, que usa multipart/form-data.
  • Texto en UTF-8. Los mensajes de la API están en español.
  • PATCH cambia solo los campos enviados; PUT se conserva por compatibilidad y tiene el mismo efecto.

Formato de respuestas

Un recurso llega en data; un listado, en data con links y meta (ver paginación). Una creación responde 201 con la cabecera Location; una eliminación, 204 sin cuerpo.

Un recurso
{
  "data": {
    "id": 101,
    "item_code": "P-1001",
    "name": "Aceite comestible 1 L",
    "updated_at": "2026-10-05T18:40:03.000000Z"
  }
}

Fechas, cantidades e identificadores

  • Fechas y horas en ISO 8601. Las de recursos van en UTC (2026-10-05T18:40:03.000000Z); las de órdenes de transferencia y olas llevan el desfase horario de la empresa (2026-10-05T12:40:03-06:00). Las fechas de calendario van como AAAA-MM-DD.
  • Cantidades como números JSON con decimales (48, 2.5).
  • Identificadores: id es numérico y lo asigna Chainlink. Para relacionar registros con otro sistema se usan los códigos (item_code, whs_code, bin_code) y la referencia externa (external_ref) de documentos y órdenes.
  • Un campo sin valor llega como null; la API no omite campos documentados.

Identificador de solicitud

Toda respuesta trae la cabecera X-Request-Id (req_ seguido de 26 caracteres). En un error también llega en error.request_id. Regístrelo en las bitácoras del sistema integrado: con él, soporte localiza la solicitud exacta.

Llamadas desde un navegador

La API admite CORS sin cookies, de modo que una página web puede llamarla con un token. Aun así, las credenciales no deben publicarse en código que llegue al navegador de terceros: la integración debe ejecutarse en un servidor.