Organización

Paquetes

Exporta los paquetes de la empresa en JSON.

Requesthttp
GET /org-api/v1/packages

Permiso: packages:read. El listado trae como máximo 500 paquetes, del más reciente al más antiguo. No incluye comentarios internos de administración ni metadatos de IA.

Envoltorio

AtributoTipoDescripción
dataarrayPaquetes exportados.
totalnumberCantidad de objetos en data.
exportedAtstringFecha ISO 8601 de la exportación.

Atributos del paquete

AtributoTipoDescripción
idstringUUID del paquete.
packageTypestringPrefijo interno del recibo.
serialNumbernumber | nullSecuencia del recibo en la oficina de creación.
receiptPackageIndexnumberÍndice dentro del recibo. 1 es P1.
receiptNumberstring | nullCódigo de recibo. Secuencia WR o warehouse externo, por ejemplo WHR….
packageNumberstring | nullCódigo de paquete: recibo más P1, P2….
trackingNumberstring | nullNúmero de rastreo visible.
trackingNormalizedstring | nullRastreo en mayúsculas y sin espacios.
weightnumberPeso en la unidad del recibo.
weightUnitstring | nullkg o lb. Null usa la unidad de la empresa.
volumetricWeightnumberPeso volumétrico.
chargeableWeightnumberPeso cobrable.
declaredValuenumberValor declarado.
heightnumberAlto.
widthnumberAncho.
lengthnumberLargo.
dimensionUnitstring | nullcm o in.
piecesnumberCantidad de piezas.
commentsstringDescripción de la mercancía.
warehouseCommentsstring | nullComentario de bodega.
isConsolidatedbooleanTrue si el paquete está consolidado.
isGroupedbooleanTrue si entró en un lote de varios paquetes.
registrationDatestringFecha de registro, ISO 8601.
createdAtstringFecha de creación del registro, ISO 8601.
updatedAtstringFecha de la última actualización, ISO 8601.
itemStatusobject | nullEstado operativo del paquete.
customerobject | nullDestinatario.
shipperobject | nullRemitente.
locationobject | nullOficina o bodega actual.
warehouseobject | nullBodega asociada.

JSON de retorno

jsonjson
{
  "data": [
    {
      "id": "c3a1e8b2-6f40-4a11-9d22-1b0c7e5a44d8",
      "packageType": "WR",
      "serialNumber": 1204,
      "receiptPackageIndex": 1,
      "receiptNumber": "WR00001204",
      "packageNumber": "WR00001204P1",
      "trackingNumber": "1Z999AA10123456784",
      "trackingNormalized": "1Z999AA10123456784",
      "weight": 4.5,
      "weightUnit": "lb",
      "volumetricWeight": 5.1,
      "chargeableWeight": 5.1,
      "declaredValue": 80,
      "height": 20,
      "width": 15,
      "length": 30,
      "dimensionUnit": "cm",
      "pieces": 1,
      "comments": "Ropa",
      "warehouseComments": null,
      "isConsolidated": false,
      "isGrouped": false,
      "registrationDate": "2026-10-20T15:04:00.000Z",
      "createdAt": "2026-10-20T15:04:11.000Z",
      "updatedAt": "2026-10-24T12:10:00.000Z",
      "itemStatus": { "id": "st_recibido", "name": "Recibido" },
      "customer": null,
      "shipper": null,
      "location": null,
      "warehouse": null
    }
  ],
  "total": 1,
      "exportedAt": "2026-10-24T17:15:00.000Z"
}

Escritura

El alta, la lectura de uno, el cambio y el borrado están en Crear paquete y Un paquete. Una clave con packages:read puede listar. Escribir pide packages:write o organization:read.

Buscar en la documentación

Buscar páginas de la documentación