Shipment Confirm

Operazione di conferma spedizioni

Con questa operazione si conferma che le spedizioni generate sono corrette e sono in processo di affido al corriere / corrieri.

Sull'interfaccia di Gsped le spedizioni confermate vengono spostate dalla sezione Spedizioni in partenza alla sezione Spedizioni partite.

L'operazione di conferma può essere eseguita in due modalità :

  • Indicando l'anagrafica di bollettazione ( client_id ) : In questo caso verranno confermate tutte le spedizioni del client_id indicato.

  • Indicando l'elenco di spedizioni ( ID spedizioni ) : In questo caso verranno confermate le singole spedizioni specificate.

ATTENZIONE : Nell'operazione di conferma vi viene restituito codice HTTP 200 anche quando le spedizioni non vengono effettivamente confermate nei seguenti casi :

  • Si tenta di confermare spedizioni già confermate

  • Si tenta di confermare spedizioni in errore e/o ancora in fase di elaborazione

Fare attenzione al messaggio restituito nel campo status, in quanto qui verranno indicate quante spedizioni sono state confermate e quante no, Esempio : "10 spedizioni confermate, 2 errori"

Nel caso vi siano spedizioni che non siamo stato in grado di confermare, nel array errors verranno indicate le spedizioni che non sono state conferma.

Nota : In questa operazione è possibile richiedere che venga generato il borderò (manifest) da presentare al corriere all'atto del ritiro della merce.

Conferma delle spedizioni e generazione del borderò (opzionale)

POST https://api.gsped.it/[ISTANZA]/shipmentConfirm

Headers

NameTypeDescription

Content-Type*

String

application/json

x-api-key*

String

Api Key fornita da Gsped

Request Body

NameTypeDescription

client_id*

Integer

Valore comunicato da Gsped (In alternativa al parametro id)

id*

Array

Elenco di IDs numerici delle spedizioni da confermare (In alternativa a client_id)

create_manifest

String

Valori ammissibili Y o N. Se Y nella risposta verrà incluso il campo manifest che conterrà il PDF del manifest delle spedizioni confermate.

{
  "status": "25 spedizioni confermate, 0 errori",
  "errors": [],
  "manifest": "JVBERi0xLjMKM......UVPRgo=",
  "manifest_id": 10006
}

Snippets codice di esempio :

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://api.gsped.it/sandbox/shipmentConfirm',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
  "create_manifest" : "Y",
  "id": [
    "12345",
    "12346",
    "12347"
  ]
}',
    CURLOPT_HTTPHEADER => array(
        'Content-Type: application/json',
        'x-api-key: YOUR-API-KEY'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;php

Last updated