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.
/transfer-orders
Listar órdenes de transferencia
Requiere el módulo de órdenes de transferencia; apagado, responde 404 transfer_orders_disabled.
- 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 consulta
-
pageinteger valor por omisión:1Número de página, desde 1.
-
per_pageinteger valor por omisión:25Elementos por página, de 1 a 100. Un valor mayor se toma como 100.
-
sortstring valor por omisión:-idCampo de orden; antepón
-para descendente.Valores:id,-id,created_at,-created_at,updated_at,-updated_at,due_at,-due_at,priority,-priority -
updated_sincestring (date-time)Solo lo que cambió desde esta fecha (ISO 8601), para sincronización incremental.
-
statusstringEstado de la orden.
Valores:draft,released,picking,picked,in_transit,receiving,received,closed,cancelled -
from_warehousestringCódigo del almacén de origen.
-
to_warehousestringCódigo del almacén de destino.
-
external_refstringReferencia externa de la orden.
Respuestas
200 Página de órdenes (sin líneas; el detalle de cada orden las incluye).
-
dataarray de objetos obligatorio26 campos de
data-
objectstring «transfer_order» obligatorio -
idinteger obligatorio -
codestring obligatorio -
statusstring obligatorioValores:draft,released,picking,picked,in_transit,receiving,received,closed,cancelled -
status_labelstring -
headlinestring | null -
has_discrepancybooleanLo recibido no coincide con lo despachado.
-
fromobjeto obligatorio3 campos de
from-
idinteger | null -
codestring | null -
namestring | null
-
-
toobjeto obligatorio3 campos de
to-
idinteger | null -
codestring | null -
namestring | null
-
-
priorityinteger -
reasonstring | null -
due_atstring (date-time) | null -
lines_countinteger -
unitsobjeto obligatorio4 campos de
units-
requestednumber -
pickednumber -
dispatchednumber -
receivednumber
-
-
dispatched_atstring (date-time) | null -
received_atstring (date-time) | null -
closed_atstring (date-time) | null -
seal_numberstring | null -
vehicle_platestring | null -
carrier_idinteger | null -
external_refstring | null -
sourcestringValores:web,api,import,sap -
picking_idinteger | null -
receipt_idinteger | null -
sapobjeto | nullEstado del envío al ERP cuando aplica.
-
linesarray de objetos | nullnullen el listado; en el detalle, las líneas.11 campos de
lines-
idinteger -
line_numinteger -
product_idinteger | null -
item_codestring | null -
qtynumber -
picked_qtynumber -
dispatched_qtynumber -
received_qtynumber -
batch_numstring | null -
serial_numbersarray de textos -
statusstring
-
-
-
linksobjeto obligatorio4 campos de
links-
firststring (uri) | null obligatorio -
laststring (uri) | null obligatorio -
prevstring (uri) | null obligatorioPágina anterior;
nullen la primera. -
nextstring (uri) | null obligatorioPágina siguiente;
nullen la última.
-
-
metaobjeto obligatorio8 campos de
meta-
current_pageinteger obligatorio -
frominteger | nullPosición del primer elemento de la página.
-
last_pageinteger obligatorio -
linksarray de objetosEnlaces de página para interfaces; no hace falta leerlos.
-
pathstring (uri) -
per_pageinteger obligatorio -
tointeger | null -
totalinteger obligatorioTotal 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.
404 El módulo no está activo en la empresa.
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
curl "https://empresa.chainlink.mx/api/v1/transfer-orders" \
-H "Authorization: Bearer $CHAINLINK_TOKEN" \
-H "Accept: application/json"
<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://empresa.chainlink.mx/api/v1/transfer-orders', [
'headers' => [
'Authorization' => 'Bearer ' . getenv('CHAINLINK_TOKEN'),
'Accept' => 'application/json',
],
]);
$data = json_decode((string) $response->getBody(), true);
const response = await fetch('https://empresa.chainlink.mx/api/v1/transfer-orders', {
headers: {
Authorization: `Bearer ${process.env.CHAINLINK_TOKEN}`,
Accept: 'application/json',
},
});
const data = await response.json();
import os
import requests
response = requests.get(
"https://empresa.chainlink.mx/api/v1/transfer-orders",
headers={
"Authorization": f"Bearer {os.environ['CHAINLINK_TOKEN']}",
"Accept": "application/json",
},
)
data = response.json()
{
"data": [
{
"object": "transfer_order",
"id": 1,
"code": "TR-000001",
"status": "draft",
"status_label": "Borrador",
"headline": "TR-000001 · De CEDIS-GDL a TDA-MTY · Borrador",
"has_discrepancy": false,
"from": {
"id": 1,
"code": "CEDIS-GDL",
"name": "CEDIS Guadalajara"
},
"to": {
"id": 2,
"code": "TDA-MTY",
"name": "Tienda Monterrey"
},
"priority": 0,
"reason": null,
"due_at": null,
"lines_count": 1,
"units": {
"requested": 24,
"picked": 0,
"dispatched": 0,
"received": 0
},
"dispatched_at": null,
"received_at": null,
"closed_at": null,
"seal_number": null,
"vehicle_plate": null,
"carrier_id": null,
"external_ref": "TR-2026-0107",
"source": "api",
"picking_id": null,
"receipt_id": null,
"sap": {
"dispatch": null,
"receipt": null
},
"lines": null
}
],
"links": {
"first": "https://empresa.chainlink.mx/api/v1/transfer-orders?page=1",
"last": "https://empresa.chainlink.mx/api/v1/transfer-orders?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [],
"path": "https://empresa.chainlink.mx/api/v1/transfer-orders",
"per_page": 25,
"to": 1,
"total": 1
}
}
{
"error": {
"code": "unauthenticated",
"message": "Falta el token de acceso o ya no es válido.",
"doc_url": "https://chainlink.mx/developers/errores#unauthenticated",
"request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
},
"errors": [],
"message": "Falta el token de acceso o ya no es válido."
}
{
"error": {
"code": "feature_not_in_plan",
"message": "Función no disponible en tu plan actual.",
"feature": "webhooks.enabled",
"upgrade_url": "/billing/plans",
"doc_url": "https://chainlink.mx/developers/errores#feature_not_in_plan",
"request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
},
"errors": [],
"message": "Función no disponible en tu plan actual."
}
{
"error": {
"code": "missing_scope",
"message": "El cliente no tiene el alcance products:write.",
"scope": "products:write",
"doc_url": "https://chainlink.mx/developers/errores#missing_scope",
"request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
},
"errors": [],
"message": "El cliente no tiene el alcance products:write."
}
{
"error": {
"code": "transfer_orders_disabled",
"message": "Las órdenes de transferencia no están activas en tu empresa.",
"doc_url": "https://chainlink.mx/developers/errores#transfer_orders_disabled",
"request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
},
"errors": [],
"message": "Las órdenes de transferencia no están activas en tu empresa."
}
{
"error": {
"code": "validation_failed",
"message": "El campo name es obligatorio.",
"field": "name",
"doc_url": "https://chainlink.mx/developers/errores#validation_failed",
"request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
},
"errors": [
{
"field": "name",
"message": "El campo name es obligatorio."
}
],
"message": "El campo name es obligatorio."
}
{
"error": {
"code": "rate_limited",
"message": "Superaste el límite de solicitudes por minuto. Espera los segundos que indica Retry-After.",
"doc_url": "https://chainlink.mx/developers/errores#rate_limited",
"request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
},
"errors": [],
"message": "Superaste el límite de solicitudes por minuto. Espera los segundos que indica Retry-After."
}