bindShipping permette di configurare dei webhook per notificare ad un sistema esterno il verificarsi di variazioni sulle spedizioni (contiene le informazioni sugli ordini e le righe ordine).

Configurazione

Ogni Webhook prevede le seguenti configurazioni:

• Descrizione: sintetica descrizione che identifica il Webhook stesso
• URL: indirizzo ove il webhook deve notificare i messaggi
• Evento di attivazione: oggi l’unica possibilità che è possibile scegliere è “Shipment status change”
• Stati spedizione: selezionare gli stati della spedizione e del tracciamento per i quali attivare il webhook
• Dataset: definisce il formato del messaggio ed il suo contenuto. Oggi è disponibile il dataset “Basic shipping information”
• Webhook filters: è possibile impostare filtri sulle spedizioni da considerare
• Secret: codice segreto che viene appeso all’url

Formato dei messaggi

Chiamata

Viene mandato un messaggio per ogni variazione di stato di una spedizione (identificata con il campo reference).

La chiamata viene fatta in POST

Il parametro secret viene trasmesso tramite header http X-WEBHOOK-KEY

Dataset “Basic shipping information”

Ecco la richiesta di esempio:

{

"reference": "Q",

"orders": {

"50444": {

"items": [

"12427A"

],

"number": "50444",

"secondary_id": 1532

}

},

"courier": {

"code": "GLSN",

"reference": "GLS",

"identifier": "GLSN_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-2024 12:00:42"

}

All’interno del messaggio, nella sezione orders, vengono segnalati gli ordini coinvolti dalla spedizione relativa a quel messaggio.

Nel gruppo courier osserviamo i dettagli relativi al servizio di spedizione relativo alla spedizione:

• "code": "GLSN": codice identificativo del corriere utilizzato
• "reference": "GLS": riferimento alfanumerico del servizio di spedizione (scelto liberamente dal venditore sulla piattaforma bindShipping; potrebbe ad esempio essere il nome)
• "identifier": "GLSN_8": identificativo univoco del servizio di spedizione (concatena code e l’id del servizio)
• Il tag containers contiene l’array dei colli che costituiscono la spedizione (uno o più di uno), i relativi dettagli dimensionali, il tipo (dice ad esempio se è una scatola, una busta, un pallet, e di che tipo), tracking number e l’identificativo del collo.

Il tag identifier è un identificativo personalizzato della spedizione (che normalmente sarà vuoto).

Il tag shipping_date contiene la data di spedizione (se presente).

Il tag shipping_state definisce lo stato della spedizione.

Il tag collection_state definisce lo stato della conferma di ritiro della spedizione.

Il tag deadline_shipping_date dice la data limite entro la quale la spedizione deve avvenire.

Grazie per aver valutato questo contenuto.