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

Recepciones, surtidos y traspasos

El trabajo que el almacén hizo sobre los documentos, con su operador, sus tiempos y sus líneas.

Operaciones

OperaciónMétodo y rutaAlcance
Listar recepciones GET /receipts receipts:read
Consultar una recepción GET /receipts/{id} receipts:read
Listar surtidos GET /pickings pickings:read
Consultar un surtido GET /pickings/{id} pickings:read
Listar traspasos GET /transfers transfers:read
Consultar un traspaso GET /transfers/{id} transfers:read
Rutas de recepciones, surtidos y traspasos

Objeto recepción

  • 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
Objeto recepción 
{
    "id": 1,
    "uuid": "6c1f0b8e-3d2a-4f5b-9e7c-2a4d8b1c0f93",
    "concept": "delivery_good",
    "status": "finalized",
    "comments": null,
    "user_id": 2,
    "operator": {
        "id": 2,
        "name": "Juan Pérez"
    },
    "document": {
        "id": 2,
        "type": "delivery_good",
        "doc_num": "ED-740259",
        "card_code": null,
        "external_ref": null
    },
    "started_at": null,
    "finalized_at": null,
    "created_at": "2026-10-06T16:20:11.000000Z",
    "updated_at": "2026-10-06T16:20:11.000000Z"
}

Objeto surtido

  • id integer obligatorio
  • code string obligatorio

    PKG-{id}.

  • 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
  • priority integer | null
  • has_shortage boolean

    Se surtió con faltante.

  • 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
Objeto surtido 
{
    "id": 5,
    "code": "PKG-5",
    "uuid": "6c1f0b8e-3d2a-4f5b-9e7c-2a4d8b1c0f93",
    "concept": "dispatch_good",
    "status": "pending",
    "priority": 50,
    "has_shortage": false,
    "comments": null,
    "user_id": 2,
    "operator": {
        "id": 2,
        "name": "Juan Pérez"
    },
    "document": {
        "id": 6,
        "type": "dispatch_good",
        "doc_num": "SD-627227",
        "card_code": null,
        "external_ref": null
    },
    "started_at": null,
    "finalized_at": null,
    "created_at": "2026-10-06T16:20:11.000000Z",
    "updated_at": "2026-10-06T16:20:11.000000Z"
}

Objeto traspaso

  • id integer obligatorio
  • status string obligatorio

    Igual a wms_status.

    Valores: pending, transferred, error
  • wms_status string
  • sap_status string | null

    Estado del envío al ERP.

  • from_whs_code string | null
  • to_whs_code string | null
  • doc_entry integer | string | null

    Número del documento en el ERP.

  • message string | null

    Respuesta del ERP cuando hubo error.

  • user_id integer | null
  • operator objeto | null

    La persona que hizo el trabajo.

    2 campos de operator
    • id integer obligatorio
    • name string | null obligatorio
  • created_at string (date-time) | null
  • updated_at string (date-time) | null
Objeto traspaso 
{
    "id": 1,
    "status": "pending",
    "wms_status": "pending",
    "sap_status": "pending",
    "from_whs_code": "CEDIS-GDL",
    "to_whs_code": "TDA-MTY",
    "doc_entry": null,
    "message": null,
    "user_id": 2,
    "operator": {
        "id": 2,
        "name": "Juan Pérez"
    },
    "created_at": "2026-10-06T16:20:11.000000Z",
    "updated_at": "2026-10-06T16:20:11.000000Z"
}