API Reference - Deliveries

Questa sezione mostra come utilizzare l’API per consultare le consegne.

POST /api/deliveries

Descrizione

Recupera un elenco di consegne in base a filtri, paginazione e ordinamento.

---

Parametri

L’endpoint non richiede parametri nella query string.

---

Corpo della richiesta (Request Body)

Content-Type: application/json

{
  "pageNumber": 0,
  "pageSize": 0,
  "quickSearch": "string",
  "orderBy": {
    "key": "string",
    "order": "string"
  },
  "filters": {
    "insertFrom": "2025-09-15T08:13:37.201Z",
    "insertTo": "2025-09-15T08:13:37.201Z",
    "requestedFrom": "2025-09-15T08:13:37.201Z",
    "requestedTo": "2025-09-15T08:13:37.201Z",
    "status": [0],
    "deliveryIds": [0],
    "courierIds": [0],
    "customerIds": [0],
    "unitIds": [0],
    "warehouseIds": [0],
    "tags": ["string"],
    "advancedFilters": [
      {
        "selectedFiled": "string",
        "condition": 1,
        "operator": "string",
        "data": "string",
        "rowType": "string"
      }
    ]
  }
}

Descrizione dei campi principali

• pageNumber: Numero della pagina da recuperare (paginazione).
• pageSize: Numero di record per pagina.
• quickSearch: Ricerca rapida su codice consegna, cliente o altri campi.
• orderBy: Oggetto per ordinare i risultati.
  • key: Nome del campo su cui ordinare.
  • order: Direzione (asc o desc).
• filters: Oggetto contenente i filtri avanzati.
  • insertFrom / insertTo: Intervallo di date di inserimento.
  • requestedFrom / requestedTo: Intervallo di date richieste di consegna.
  • status: Lista di stati consegna.
  • deliveryIds, courierIds, customerIds, unitIds, warehouseIds: Liste di ID da filtrare.
  • tags: Lista di tag associati.
  • advancedFilters: Array di filtri complessi con campi specifici (selectedFiled, condition, operator, data, rowType).

Risposta

• Codice: 200 OK
• Restituisce un array di oggetti rappresentanti le consegne filtrate:

[
  {
    "code": "string",
    "tenantName": "string",
    "courierCode": "string",
    "warehouseName": "string",
    "customerBusinessPartnerName": "string",
    "duQty": 0,
    "palletQty": 0,
    "status": 0,
    "insertTime": "2025-09-15T08:13:37.201Z"
  }
]

Esempio di utilizzo

curl -X POST "https://api.loftapp.connecthub.com/api/deliveries" \
-H "Content-Type: application/json" \
-d '{
  "pageNumber": 0,
  "pageSize": 10,
  "quickSearch": "ABC123"
}'