Ottieni i metodi di spedizione in base all'indirizzo e ai parametri del pacco.
Restituisce l'elenco dei metodi di reso per un determinato partner con parametri aggiuntivi come la disponibilità.
POST /v1/shipping-methods/quote
Esempio di richiesta
{ "orderReferenceId": "EXMPL0001234", "currency": "EUR", "options": { "weightUnit": "g", "dimensionUnit": "mm", "label": { "format": "pdf" } }, "partner": { "clientName": "ExampleCustomer" }, "receiver": { "person": { "firstName": "Foo", "lastName": "Bar", "company": "", "email": "[email protected]", "phone": "01273552886" }, "address": { "country": "GB", "state": "East Sussex", "city": "Brighton", "postcode": "BN1 8YQ", "addressLine1": "11 London Rd", "addressLine2": "", "addressLine3": "", "street": "London Rd", "houseNumber": "11", "suburb": null }, "customs": { "vatNumber": null } }, "sender": { "person": { "firstName": "", "lastName": "", "company": "Example Company", "email": "[email protected]", "phone": "01666 123456" }, "address": { "country": "DE", "state": "", "city": "Donauwörth", "postcode": "86609", "addressLine1": "Am Wassergraben 11", "addressLine2": null, "addressLine3": null, "street": "Am Wassergraben", "houseNumber": "11", "suburb": null }, "customs": { "vatNumber": "DE123456789000", "iossNumber": null, "eoriNumber": "GB987654321000", "pcccNumber": null, "australianBusinessNumber": null } }, "packages": [ { "packageReferenceId": "EXMPL0001234-0-1", "grossWeight": 810, "netWeight": 760, "length": 229, "width": 200, "height": 36, "boxType": "rectangle", "volumetricWeight": 700, "items": [ { "itemReferenceId": "EXMPL0001234-0-1-ITEM1", "description": "Mug", "value": 48, "quantity": 4, "weight": 760, "hsCode": "44199090", "countryOfOrigin": "DE" } ] } ]}Esempio di risposta di successo
{ "items": [ { "carrier": { "name": "DHL", "uid": "dhl" }, "method": { "name": "DHL Global Parcel", "uid": "dhl_global_parcel", "price": 3.32, "maxShipmentDays": 5, "minShipmentDays": 2, "deliveryPaddingDays": 0 } }, { "carrier": { "name": "UPS", "uid": "ups" }, "method": { "name": "UPS Standard Tariff", "uid": "ups_standard_tariff", "price": 5.25, "maxShipmentDays": 5, "minShipmentDays": 2, "deliveryPaddingDays": 0 } } ], "count": 2}Esempio di risposta di errore
{ "orderReferenceId": "EXMPL0001234", "code": "VALIDATION_ERROR", "message": "There are errors in submitted data", "errors": [ { "code": "NO_SUCH_CHOICE_ERROR", "reference": "options.label.format", "message": "The value you selected is not a valid choice." }, { "code": "IS_BLANK_ERROR", "reference": "receiver.address.country", "message": "This value should not be blank." } ]}Richiesta
Parametro | Tipologia | Descrizione |
orderReferenceId (obbligatorio) | string | ID univoco per l'ordine di spedizione. ID fornito da te. |
valuta (obbligatorio) | string | Valuta dell'ordine di spedizione in formato a 3 lettere. |
opzioni (opzionale) | Opzioni | Parametri opzionali. |
partner (facoltativo) | Compagno | Dettagli del partner. |
destinatario (obbligatorio) | Destinatario | Dettagli del destinatario. |
mittente (obbligatorio) | Mittente | Dettagli del mittente. |
pacchetti (obbligatorio) | Pacchetto[] | Dettagli del pacchetto. |
Opzioni
Parametro | Tipologia | Descrizione |
unità di peso (opzionale) | string | Unità di peso. Scelte disponibili: g, kg, oz, lb. Impostazione predefinita: g. |
dimensionUnit (opzionale) | string | Unità di lunghezza. Scelte disponibili: mm, cm, in. Impostazione predefinita: mm. |
etichetta (opzionale) | Etichetta | Impostazioni del formato dell'etichetta. |
Etichetta
Parametro | Tipologia | Descrizione |
formato (opzionale) | string | Formato dell'etichetta. Scelte disponibili: pdf, zpl (*). Predefinito: pdf. |
Nota: Alcuni formati diversi dal PDF potrebbero non essere abilitati per determinati corrieri.
Compagno
Parametro | Tipologia | Descrizione |
Nome del cliente (opzionale) | string | Profilo di spedizione del cliente. |
Destinatario
Parametro | Tipologia | Descrizione |
persona (obbligatorio) | ReceiverPerson | Dati personali del destinatario. |
indirizzo (obbligatorio) | Indirizzo | Dettagli dell'indirizzo del destinatario. |
Personalizzazioni (opzionale) | ReceiverCustoms | Dettagli doganali del destinatario. |
Mittente
Parametro | Tipologia | Descrizione |
persona (obbligatorio) | MittentePersona | Dati personali del mittente. |
indirizzo (obbligatorio) | Indirizzo | Dettagli dell'indirizzo del mittente. |
Dogana (necessaria per la spedizione internazionale) | MittenteDogana | Dettagli doganali del mittente. |
ReceiverPerson
Parametro | Tipologia | Descrizione |
Nome (obbligatorio) | string | Nome della persona destinataria. |
Cognome (obbligatorio) | string | Cognome della persona destinataria. |
azienda (opzionale) | string | Il titolo dell'azienda. |
Email (opzionale*) | string | Indirizzo e-mail della persona. Può essere utilizzato per le notifiche di spedizione. |
Telefono (opzionale*) | string | Numero di telefono della persona. Può essere utilizzato per le notifiche di spedizione. |
Nota: *Email e telefono possono essere campi obbligatori a seconda del corriere scelto
MittentePersona
Parametro | Tipologia | Descrizione |
Nome (opzionale) | string | Nome della persona mittente. |
Cognome (opzionale) | string | Cognome della persona mittente. |
azienda (obbligatorio) | string | Il titolo dell'azienda mittente. |
email (opzionale*) | string | Indirizzo e-mail della persona/azienda mittente. |
telefono (opzionale*) | string | Numero di telefono della persona/azienda mittente. |
Nota: *Email e telefono possono essere campi obbligatori a seconda del corriere scelto
Indirizzo
Parametro | Tipologia | Descrizione |
paese (obbligatorio) | string | Codice paese in formato a 2 lettere. |
Stato (opzionale*) | string | Stato/contea/regione. |
città (obbligatorio) | string | Città. |
codice postale (obbligatorio) | string | Codice postale. |
addressLine1 (obbligatorio) | string | Prima riga dell'indirizzo postale. Dovrebbe includere via e numero civico. |
addressLine2 (opzionale) | string | Seconda riga dell'indirizzo postale. Numero di appartamento/ufficio/piano. |
addressLine3 (opzionale) | string | Terza riga dell'indirizzo postale. |
via (opzionale*) | string | Via (obbligatorio per indirizzi in Germania). |
Numero civico (opzionale*) | string | Numero civico (obbligatorio per indirizzi in Germania). |
sobborgo (opzionale*) | string | Sobborgo (obbligatorio per indirizzi AU/NZ). |
Nota: *Questi campi facoltativi sono obbligatori per alcuni Paesi e corrieri.
DoganaDestinatario
Parametro | Tipologia | Descrizione |
Partita IVA (opzionale) | string | Numero di partita IVA del destinatario. |
MittenteDogana
Parametro | Tipologia | Descrizione |
vatNumber (opzionale*) | string | Numero di partita IVA del mittente. |
iossNumber (opzionale*) | string | Numero IOSS del mittente. |
Numero EORI (opzionale*) | string | Numero EORI del mittente. |
pcccNumber (opzionale*) | string | Numero PCCC del mittente. |
australianBusinessNumber (opzionale*) | string | Numero aziendale australiano del mittente. |
Nota: *A seconda del paese di invio e di ricezione, questi campi possono essere obbligatori.
Pacchetto
Parametro | Tipologia | Descrizione |
packageReferenceId (obbligatorio) | string | ID del pacco fornito dal partner. |
Peso lordo (obbligatorio) | numero | Peso dell'imballaggio + peso degli articoli (in grammi per impostazione predefinita). |
Peso netto (opzionale) | numero | Peso degli articoli (in grammi per impostazione predefinita). |
lunghezza (obbligatorio) | numero | Lunghezza del pacco (in mm per impostazione predefinita). |
Larghezza (obbligatorio) | numero | Larghezza della confezione (in mm per impostazione predefinita). |
altezza (obbligatorio) | numero | Altezza del pacco (in mm per impostazione predefinita). |
volumetricWeight (opzionale) | numero | Peso calcolato in base alle dimensioni del pacco (in grammi per impostazione predefinita). |
Tipo di scatola (opzionale) | string | Forma della scatola (ad esempio, rettangolo, tubo). |
valore (necessario per la spedizione internazionale) | numero | Valore totale di tutti gli articoli nel pacco (nella valuta selezionata). |
articoli (necessari per la spedizione internazionale) | Articolo[] | Elenco degli articoli nel pacco. |
Articolo*
Parametro | Tipologia | Descrizione |
itemReferenceId (obbligatorio) | string | ID dell'articolo del pacco fornito dal partner. |
descrizione (obbligatorio) | string | Descrizione dell'articolo. |
quantità (obbligatorio) | numero | Quantità dell'articolo. |
valore (obbligatorio) | numero | Valore dell'articolo (nella valuta selezionata). |
peso (obbligatorio) | numero | Peso dell'articolo (in grammi per impostazione predefinita). |
hsCode (obbligatorio) | string | Codice del Sistema Armonizzato (Wiki). |
countryOfOrigin (obbligatorio) | string | Codice paese in formato a 2 lettere in cui è stato prodotto l'articolo. |
Nota: *Tutti i parametri dell'articolo sono richiesti solo per la spedizione internazionale.
Risposta riuscita
Parametro | Tipologia | Descrizione |
conteggio | numero | Numero di risultati trovati. |
elementi | ResponseItems | Un array di preventivi |
ResponseItems
Parametro | Tipologia | Descrizione |
corriere | ResponseItemsCarrier | Dettagli del corriere di spedizione. |
metodo | ResponseItemsMethod | Dettagli del metodo di spedizione. |
ResponseItemsCarrier
Parametro | Tipologia | Descrizione |
corriere | string | Corriere utilizzato per l'ordine. |
uid | string | Metodo di spedizione utilizzato per l'ordine. |
ResponseItemsMethod
Parametro | Tipologia | Descrizione |
nome | string | Nome del metodo di spedizione. |
uid | string | UID del metodo di spedizione. |
prezzo | numero | Prezzo stimato del metodo di spedizione per il partner. |
maxShipmentDays | numero | Giorni massimi di spedizione del metodo di spedizione. |
minShipmentDays | numero | Metodo di spedizione: giorni minimi di spedizione. |
deliveryPaddingDays (opzionale) | numero | Giorni di consegna aggiuntivi per il metodo di spedizione. |
Risposta di errore
Parametro | Tipologia | Descrizione |
ID riferimento ordine | string | ID univoco per l'ordine di spedizione fornito da te. |
codice | string | Codice di errore. |
messaggio | string | Messaggio di errore. |
dettagli (opzionale) | oggetto | Messaggio di errore dettagliato (oggetto JSON di una struttura arbitraria ). |
errori (facoltativo) | ResponseErrorDetails[] | Elenco di errori. |
ResponseErrorDetails
Parametro | Tipologia | Descrizione |
codice | string | Codice di errore. |
messaggio | string | Messaggio di errore |
riferimento (facoltativo) | string | ID di riferimento. |
Passaggio successivo: 🔗[GCL] API di logistica - Tracking
📝 Non era quello che cercavi?
Aiutaci a migliorare questo articolo, inviaci un'email a [email protected] — ricordati di includere il titolo dell'articolo.