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.

Documentos y operación

Órdenes de transferencia

Traslados de mercancía entre almacenes, de la creación a la recepción en destino.

Operaciones

OperaciónMétodo y rutaAlcance
Listar órdenes de transferencia GET /transfer-orders transfers:read
Crear una orden de transferencia POST /transfer-orders transfers:write
Consultar una orden de transferencia GET /transfer-orders/{id} transfers:read
Rutas de órdenes de transferencia

Objeto orden de transferencia

  • 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
Objeto orden de transferencia 
{
    "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
}