CloseDoc

Generalità

La CloseDoc è un endpoint custom che usato in alcune situazioni particolari

ATTENZIONE! NON sostituisce la shipmentConfirm (che rimane necessaria) e va fatta PRIMA della shipmentConfirm per aggiornare i dati sul nostro sistema prima che vengano trasmessi al corriere con la conferma della spedizione.

È valido solamente sui corrieri della tabella seguente

ID Corriere Gsped	Corriere	Note
1	BRT	Solo soluzione B o B2
70-79	Corrieri Dummy
90	Italsempione
91	Logisticando
101	GLS
105	SDA	Solo se soluzione InvioSystem
131	Fercam
144	Dimotrans
151	Malga
164	Ceva
165	Bianchi Trasporti
172	Nippon Express
174	Aldieri
179	Liccardi
186	Susa

La CloseDoc consente di impostare lo stesso valore di ddt_alpha (riferimento mittente alfanumerico) su tutte le spedizioni con lo stesso ddt_num, di impostare il contrassegno e il valore doganale sulla spedizione complessiva raggruppata usando i meccanismi di accorpamento del corriere.

Tipico caso d'uso: etichettatura dei singoli colli con una chiamata alla shipment per ogni collo con ddt_num sempre uguale per ogni collo, dopo la stampa dell'etichetta del singolo collo il sistema del magazzino genera il numero di DDT, determina se la spedizione deve essere in contrassegno ed esegue la chiamata alla CloseDoc passando il numero di DDT e l'eventuale contrassegno da impostare sulla spedizione raggruppata.

Prerequisiti

Prerequisito per l'uso della CloseDoc è il passaggio dello stesso valore di ddt_num (riferimento mittente numerico) per tutte le spedizioni create con la POST all'endpoint shipment, questo valore consentirà al nostro sistema di identificare le spedizioni da aggiornare quando riceve la chiamata alla CloseDoc.

Funzionamento

Aggionamento spedizione dato un ddt_num

POST https://api.gsped.it/[istanza]/closeDoc

Body in JSON.

Request Body

Name	Type	Description
client_id*	Int	ID client fornito da Gsped
ddt_alpha*	String	Riferimento alfanumerico della spedizione
valore_doganale	Float	Valore doganale
modalita_incasso	Int	Tipo incasso contrassegno
contrassegno	Float	Valore del contrassegno
ddt_num*	String	Riferimento numerico della spedizione
corriere	Int	Eventuale indicazione del corriere per una ricerca più precisa (Obbligatorio se si riutilizzano i ddt_num su corrieri diversi)

200: OK Aggiornamento avvenuto con successo

{
    "id_collo": 2,
    "id_sped": "123456789",
    "labels": {
        "jpg": "Stringa base64",
        "pdf": "Stringa base64",
        "zpl": "Stringa ZPL"
    },
    "tracking_collo": "JJD01111111111"
}

400: Bad Request Payload errato

{
  "error": "Dati spedizione non presenti o in formato sbagliato"
}