Etichette
createLabel
createLabel permette di creare una etichetta in formato PDF o ZPL (impostazioni da configurare sul Control Panel).POSThttps://api.qapla.it/1.4/createLabel/
Test
È possibile ottenere una "dummy label" di test utilizzando il corriere avente codice GENERIC.Request
Parametri
*Parametro obbligatorio
| Parametro | Descrizione | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| apiKey*(string) | La API Key del canale | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sandbox(boolean) | È true se si vuole utilizzare la sandbox (modalità test) Attenzione: questo parametro funziona se il corriere è già stato correttamente impostato sul canale. Rivolgersi al Customer Care di Qapla'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| includeExtShipmentID(boolean) | Se true aggiunge al body della response l'eventuale ID spedizione aggiuntivo fornito dal corriere (es. codice prenotazione DHL Express).Default: false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| costCenterCode(string) | Consente di specificare facoltativamente un codice relativo ad un determinato centro di costo che verrà utilizzato in fase di generazione etichette per l' ordine interessato. Questo parametro è attivo solo per il corriere PTI. Attenzione: nel caso in cui non venga specificato alcun codice, oppure nel caso in cui il codice specificato non sia fra quelli configurati per il canale, verrà utilizzato automaticamente il centro di costo configurato come default. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| origin(string) | Origine della spedizione, valori ammessi:
ahlens, aliexpress, allegro, alltricks, amazon, animalis, anthropologie, asos, atlasformen, auchan, bandq, beerwulf, bestsecret,
bhv, bigcommerce, bild, blackredwhite, blokker, boots, brandalley, bricobravo, bricodepot, bricomarche, bricoprive, bulevip, but, carrefour_es,
carrefour_fr, casadellibro, castorama, cdiscount, commercelayer, conforama, creavea, cultura, darty, debenhams, decathlon, douglas, ebay, ecwid,
elcorteingles, elkjop, ellos, empik, eprice, etsy, fanatics, feelunique, fnac, fonq, freepeople, fressnapf, gifi, greenweez_fr, handm, home24, ibs,
incomedia, lafayette, laredoute, leroyMerlin_it, magento, magento2, maisonDuMonde_es, maisonDuMonde_it, manomano, manomano_de, manomano_es, manomano_fr,
manomano_gb, manomano_it, matalan, mathon, maty, maykers, mediaMarkt_at, mediaMarkt_de, mediaMarkt_es, mediaMarkt_it, mediaMarkt_nl, miravia_es, modivo_pl,
mountainwh, natureetdeco, newcart, nocibe, obelink, pandacola, pccomponentes, perfumesclub, phonehouse, pixmania, placedestend, planetahuerto, pourdebon,
prestashop, printemps, privalia, privalia_es, privalia_it, privsportshop, public, quirumed, redcarepharmacy, rueducommerce, sarenza, shopapotheke, shopify,
shopware6, showroomprive, slood, spartoo, spartoo_be, spartoo_bg, spartoo_cn, spartoo_com, spartoo_comhr, spartoo_couk, spartoo_cz, spartoo_de, spartoo_dk,
spartoo_es, spartoo_fi, spartoo_fr, spartoo_gb, spartoo_gr, spartoo_hu, spartoo_it, spartoo_nl, spartoo_pl, spartoo_pt, spartoo_ro, spartoo_se, spartoo_si, spartoo_sk, sprinter_es,
stadium, storeden¤, superdrug, teamsystemcommerce¤tiendanimal, tradeinn, truffaut, twil, ubaldi, urbanoutfitters, venca, venteunique, vivino, vtex, watchfinder,
winesitting, woocommerce, wook, worten_es, worten_pt, yoox
¤storeden e teamsystemcommerce possono essere usati come sinonimi
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| reference*(string) | Il riferimento alfanumerico dell'ordine | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| orderID(string) | Eventuale riferimento numerico dell'ordine | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| courier*(string) | Il codice corriere di Qapla' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| courierService*(string) | Eventuale tipo del servizio del corriere; per esempio può essere il codice contratto di GLS Italy. Se il campo è vuoto o non viene inviato il default è '0'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name*(string) | Nome del destinatario | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| address*(string) | Indirizzo del destinatario | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| city*(string) | Città del destinatario | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| state*(string) | Provincia del destinatario | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| postCode*(string) | CAP del destinatario | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| country*(string) | La nazione del destinatario in formato ISO 3166-1 alpha-2 (Esempio: IT) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| email(string) | Email del destinatario | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| telephone(string) | Telefono del destinatario | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| amount(float) | Importo della spedizione. Specificare solo un separatore (il punto) per indicare i decimali, e non utilizzare separatori per indicare le migliaia. Indicare al massimo due cifre decimali. Esempio: 2340.23 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingCost(float) | Costo della spedizione. Specificare solo un separatore (il punto) per indicare i decimali, e non utilizzare separatori per indicare le migliaia. Indicare al massimo due cifre decimali. Esempio: 9.35 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| currencyCode(string) | Codice valuta ISO 4217 (default: EUR) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isCOD(boolean) | È true se il pagamento è in contrassegno | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| payment(string) | Eventuale metodo di pagamento dell'ordine. Può essere impostato su CONTRASSEGNO solo se anche isCOD è impostato a true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| notes(string) | Eventuali note dell'ordine | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| parcels(int|array) |
Eventuali colli dell'ordine. Può anche essere definito come array indicando le informazioni di ogni singolo collo:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| weight(float) | Eventuale peso dell'ordine (non valido se "parcels" è un array) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| length(float) | Eventuali misure: lunghezza (non valido se "parcels" è un array) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| width(float) | Eventuali misure: profondità (non valido se "parcels" è un array) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| height(float) | Eventuali misure: altezza (non valido se "parcels" è un array) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingCODPaymentOption(string) | La modalità di pagamento dell'eventuale contrassegno se diversa dalle impostazioni di default (da concordarsi) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingInsurance(float | string) |
Eventuale importo assicurato ALL-IN: valorizzare il campo "shippingDeliveryOptions" inserendo la stringa: ALLIN Per la generazione diretta con SDA, il valore va passato sotto forma di stringa, specificando uno dei seguenti codici:
Per la generazione diretta con CRONO PTI, il valore va passato sotto forma di stringa, specificando uno dei seguenti codici:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingDeliveryOptions(string | JSON) |
Per il corriere PTI bisogna usare un JSON strutturato come i seguenti esempi
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingRequiredDeliveryDate(YYYY-MM-DD) | La data in formato YYYY-MM-DD di richiesta consegna (obbligatorio per il corriere PAACK) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingRequiredDeliveryTimeSlot(HS-HE) |
Finestra temporale di consegna prevista per l'ordine in formato stringa HS-HE (attualmente utilizzato solo dal corriere PAACK). E' un parametro obbligatorio che indica la finestra temporale di consegna prevista per l'ordine, ciascun valore relativo all' ora di inizio (HS) e di fine (HE) dovrà essere compreso fra 0 e 23. Esempio di utilizzo: "shippingRequiredDeliveryDate": "2026-01-20" "shippingRequiredDeliveryTimeSlot": "8-21" In questo caso, la finestra temporale di consegna prevista, sarà compresa fra le 08:00:00 e le 21:00:00 del 20/01/2026. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| latestShipDate(string) | Spedizione entro questa data in formato YYYY-MM-DD | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| latestDeliveryDate(string) | Consegna entro questa data in formato YYYY-MM-DD | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tag(string) | Tag colorato, valori ammessi: green, yellow, orange, blue, cyan, red | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| pickupDate(YYYY-MM-DD) | La data in formato YYYY-MM-DD di ritiro richiesta al corriere
Per il corriere SDA, se questo campo non viene specificato in fase di creazione dell'etichetta, in fase di trasmissione verrà automaticamente assegnato il giorno lavorativo successivo a quello della trasmissione |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| printNodePrinterID(int | string) | Eventuale id o nome della stampante da utilizzare con PrintNode (da concordarsi) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| forceReprint(int) | Se impostato a 1 forza nuovamente la stampa dell'etichetta tramite PrintNode; valido se utilizzato con "printNodePrinterID" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content(string) | Il contenuto della merce che potrà essere presente sull'etichetta(dipende dal corriere) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| custom1(string) | Campo personalizzato | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| custom2(string) | Campo personalizzato | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| custom3(string) | Campo personalizzato | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sender |
È il mittente della spedizione se diverso dall'intestatario del contratto. AttenzioneSe il mittente è gia stato creato sul Control Panel o già inviato precedentemente questo viene codificato e sarà sufficiente inviare il solo codice. "sender": "codicedelsender"
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tradeDocuments(array) |
Documenti elettronici da trasmettere al corriere. È possibile caricare più di un file per spedizione. Il peso massimo di ogni file è 5 MB. Per il momento disponibile solo per i corrieri DHL, FedEx e UPS. Trasmesso come un array di oggetti, con tre elementi obbligatori ciascuno:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rows(array) |
È un array di "righe ordine". Non è obbligatorio, ma se popolato ha alcuni dati che lo sono. Quando i dati obbligatori non sono compilati, l'elemento della riga può essere ignorato e non inserito. Per aggiornare o rimuovere tutte le righe da un ordine, utilizzare "forceRowsUpdate". Tenere presente che gli ordini vengono modificati solo quando non ci sono etichette per l'ordine.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| assemblyTypes(array) |
Eventuale elenco di tipologie di montaggio, una per prodotto, per i corrieri che supportano questa informazioni
Disponibile per il "courierService" 20 (HD). Deve essere specificato un elemento per ogni elemento di rows. I valori disponibili per "code":
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PUDO(object) |
Permette di impostare un punto di Pick-up o Drop-off del ritiro della merce. Ogni campo va compilato in base alla necessità del corriere. Far riferimento alle tabelle poco sotto name, address, city, state, country e postalCode sono necessari se si desidera includere l'indirizzo del PUDO nelle email transazionali
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| invoice(object) |
Permette di impostare le informazioni relative alla fattura associata alla spedizione, utile per le spedizioni che devono passare la dogana.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dangerousGoods(JSON) |
Per il corriere FEDEX bisogna usare un JSON strutturato come segue parcel: rappresenta il numero del parcel che contiene i dangerous good (nell'esempio una spedizione con 3 parcels di cui solo il primo e il terzo contengono dangerous goods)
type: battery
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| forceLabelsOutput(int) | Se impostato a 1, la api "createLabel" restituirà le etichette generate anche quando viene stampata con PrintNode. Utilizzabile solo se "printNodePrinterID" è a sua volta impostato. Valore di default: 0 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| goodsCode(string) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| forceRowsUpdate(int) | Se impostato a 1, l'API "createLabel" riscriverà tutte le righe degli articoli nell'ordine esistente quando si tenta di aggiornare l'ordine stesso. Bisogna tenere presente che quando ci sono già etichette disponibili per l'ordine, l'ordine non verrà modificato. Se le righe (rows) sono vuote, gli articoli dell'ordine verranno eliminati. Valore di default: 0 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| recipientTin(string) | Tax Identification number del destinatario | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| recipientTinType(string) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingCharge(string) |
Indica a quale soggetto saranno addebitate le spese di spedizione. Se diverso da SENDER occorre specificare anche shippingChargeAccount. Valori ammessi: SENDER,RECIPIENT,THIRD_PARTY. Disponibile per il corriere FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingChargeAccount(string) |
Account a cui effettuare l'addebito delle spese di spedizione. Disponibile per il corriere FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| pickupType(string) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| signatureRequired | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customCharges(string) |
Indica a quale soggetto saranno addebitate le spese doganali. Se diverso da SENDER occorre specificare anche customChargesAccount. Valori ammessi: SENDER,RECIPIENT,THIRD_PARTY. Disponibile per il corriere FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customChargesAccount(string) |
Account a cui effettuare l'addebito delle spese doganali. Disponibile per il corriere FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customsChargesBroker(string) | Codice di riferimento del Broker a cui affidare lo sdoganamento. Attenzione: contattare il customer support per inserire i dati del broker e assegnare il codice. Disponibile per il corriere FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customsRecipientIDType(string) | Tipo di documento identificativo del destinatario, utile per lo sdoganamento. Valori ammessi:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customsRecipientID(string) |
Identificativo del documento del destinatario, da specificare se è specificato customsRecipientIDType Disponibile per il corriere Fedex. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| totalCustomsValue(float) | Valore totale dichiarato per lo sdoganamento. Disponibile per il corriere FedEx. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response Body200
| Parametro | Descrizione |
|---|---|
| isShipped(boolean) | È true se l'ordine è già stato etichettato e restituisce l'etichetta già creata. |
| id(int) | L'id della spedizione. Importante per invocare altre API. |
| courier(string) | Il codice corriere di Qapla' con cui l'etichetta è stata creata: è lo stesso inviato nella richiesta, oppure — se il corriere è stato scelto dalle regole di canale — il codice del corriere eletto dalle regole. |
| trackingNumber(string) | Il tracking number della spedizione. |
| returnTrackingNumber(string) | Se richiesta etichetta di reso contestuale |
| format(string) | Il formato dell'etichetta
|
| labels(array) | Un array con il base64 delle etichette ottenute (potrebbero esserci più etichette per più colli o resi, ecc.).
Oppure Lo ZPL per la stampa su Zebra, come configurato sul Control Panel. |
| extShipmentID(string) | Eventuale ID alternativo fornito dal corriere. Viene aggiunto al body solo se "includeExtShipmentID" è true nella richiesta. |
| parcelsTracking(array|null) | Array di oggetti con il tracking number di ogni singolo collo della spedizione. Presente solo se il corriere restituisce tracking number distinti per collo (es. GLS, BRT, UPS, SDA, DHL, FedEx). Ogni elemento ha la struttura: {"trackingNumber": "..."}. Il campo è null se il corriere non supporta il tracking per singolo collo. |