Webhook aggiornamento spedizioni

Configurazione del Webhook

Logivery consente di impostare dei webhook per inviare notifiche automatiche verso sistemi esterni ogni volta che si verificano aggiornamenti o variazioni relativi alle spedizioni (inclusi dettagli sugli ordini e sulle singole voci degli ordini).

Ogni webhook creato su Logivery include le seguenti impostazioni:

• Descrizione: una breve descrizione utile per identificare il webhook.
• URL di destinazione: indirizzo a cui Logivery invierà le notifiche.
• Evento di attivazione: attualmente l'unico evento supportato è "Cambio di stato della spedizione".
• Stati della spedizione: selezione specifica degli stati di spedizione e del tracciamento che attivano la notifica webhook.
• Dataset: determina la struttura e il contenuto dei dati inviati. Al momento è disponibile il dataset "Informazioni essenziali sulla spedizione".
• Filtri webhook: permette di definire dei filtri per limitare le spedizioni che attivano il webhook.
• Chiave Segreta: un codice di sicurezza che viene aggiunto all'URL per garantire autenticità e sicurezza nella trasmissione.

Formato delle notifiche

Logivery invia una notifica ogni volta che si verifica un cambiamento nello stato di una spedizione (identificata dal campo "reference").

Le notifiche vengono trasmesse tramite richieste POST.

La chiave segreta (secret) viene inclusa nell'header HTTP con il parametro X-WEBHOOK-KEY.

Ecco la richiesta di esempio:

{
    "reference": "Q",
    "orders": {
        "50444": {
            "items": [
                "12427A"
            ],
            "number": "50444",
            "secondary_id": 1532
        }
    },
    "courier": {
        "code": "BRTN",
        "reference": "BRT",
        "identifier": "BRTN_8"
    },

    "containers": [{
            "type": "BOX_STANDARD_1",
            "width": 40,
            "height": 25,
            "length": 35,
            "weight": 0.32,
            "identifier": "S",
            "weight_uom": "Kg",
            "tare_weight": 0.05,
            "total_weight": 0.37,
            "dimension_uom": "cm",
            "tracking_number": "",
            "external_identifier": "#0"
        }
    ],
    "identifier": null,
    "shipping_date": null,
    "shipping_state": "READY",
    "collection_state": "",
    "deadline_shipping_date": "13-02-2025 12:00:42"
}

Note

Nel messaggio webhook, la sezione orders indica gli ordini correlati alla specifica spedizione notificata.

Nel gruppo courier troviamo le informazioni sul servizio di spedizione utilizzato:

• "code": "BRTN": codice identificativo del corriere selezionato
• "reference": "BRT": riferimento alfanumerico personalizzato per il servizio di spedizione (scelto liberamente dal venditore tramite Logivery, ad esempio un nome descrittivo)
• "identifier": "BRTN_8": identificativo univoco del servizio di spedizione generato dalla combinazione di "code" e ID servizio

Il campo containers elenca i colli inclusi nella spedizione, indicando dimensioni, tipo (ad esempio scatola, busta o pallet), il tracking number e l’identificativo di ciascun collo.

Il campo identifier rappresenta un identificativo personalizzato della spedizione (generalmente opzionale).

Il campo shipping_date indica la data di spedizione (se disponibile).

Il campo shipping_state mostra lo stato attuale della spedizione.

Il campo collection_state indica lo stato della conferma di presa in carico della spedizione.

Il campo deadline_shipping_date rappresenta la data entro cui la spedizione deve essere obbligatoriamente effettuata.