EN
RESTful JSON API Ver. 1.4
rel. 1.4.0
Qapla' Spa SB   •   06492420481

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. Obbligatorio se non viene inviato il "boxCode"
length(float) Eventuali misure: lunghezza. Obbligatorio se non viene inviato il "boxCode"
width(float) Eventuali misure: profondità. Obbligatorio se non viene inviato il "boxCode"
height(float) Eventuali misure: altezza. Obbligatorio se non viene inviato il "boxCode"
boxCode(string) Eventuale codice scatola (se utilizzato le misure verranno prese dalla scatola con codice corrispondente)
originCountry(string) Nazione di origine del collo in formato ISO 3166-1 alpha-2 (Esempio: IT)
content(string) Eventuale descrizione del contenuto
parcelReference(string)

Eventuale codice personalizzato (massimo 25 caratteri) da poter assegnare a ciascun collo. Se indicato, il codice verrà salvato e successivamente stampato in etichetta per il collo corrispondente a condizione che la funzione sia stata abilitata in configurazione canale. Attualmente disponibile solo per i corrieri GLS-ITA, BRT, VIRTUAL e GENERIC.

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:

Codice Tipo di assicurazione
Se non viene specificato nessun parametro, non verrà indicato alcun tipo di assicurazione
AS01 FINO A EURO 258,23
AS02 FINO A EURO 516,46
AS03 FINO A EURO 1.549,37
AS04 FINO A EURO 2.582,28
ASPERC ASSICURATA PERCENTUALE
AS05 ASSICURATA INTERNAZIONALE FINO A EURO 1.500,00
AS12 ASSICURATA ROAD EUROPE
AS13 ASSICURATA EXPORT BOX

Per la generazione diretta con CRONO PTI, il valore va passato sotto forma di stringa, specificando uno dei seguenti codici:

Codice Tipo di assicurazione
Se non viene specificato nessun parametro, non verrà indicato alcun tipo di assicurazione
AS01 FINO A EURO 258,23
AS02 FINO A EURO 516,46
AS03 FINO A EURO 1.549,37
AS04 FINO A EURO 2.582,28
AS05 ASSICURATA INTERNAZIONALE FINO A EURO 1.500,00
AS12 ASSICURATA ROAD EUROPE
AS13 ASSICURATA EXPORT BOX
AS14 ASSICURATA CRONO INTERNAZIONALE
shippingDeliveryOptions(string | JSON)



In caso si vogliano utilizzare due valori, questi devono essere separati da virgola
Esempio: A,P oppure 22,07

Per il corriere PTI bisogna usare un JSON strutturato come i seguenti esempi


                                    



In caso si vogliano utilizzare due valori, questi devono essere separati da virgola
Esempio: A,P oppure A,FRESH_YYYY-MM-DD

Nel caso di servizio fresh la data è opzionale:
Esempio: FRESH_YYYY-MM-DD, FRESH
Fresh con data: La data di scadenza sarà pari a quella passata
Fresh senza data: La data di scadenza sarà pari alla data della creazione etichetta più gli eventuali giorni inseriti nella configurazione canale.

Nota: Il corriere non accetta date inferiori alla data di creazione etichetta più 5 giorni, quindi nel caso dai calcoli precedenti risulti una data precedente, la data di scadenza sarà uguale al quinto giorno successivo alla data di creazione.

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.

Attenzione
Se il mittente è gia stato creato sul Control Panel o già inviato precedentemente questo viene codificato e sarà sufficiente inviare il solo codice.
"sender": "codicedelsender"
code*(string) Il codice da assegnare al mittente per una migliore identificazione
businessName(string) Ragione sociale
street(string) Indirizzo
city(string) Città
state(string) Provincia
postCode(string) CAP
country(string) Nazione in formato ISO 3166-1 alpha-2 (Esempio: IT)
email(string) Email del mittente
telephone(string) Telefono del mittente
referent(string) Referente del mittente
isDefault(bool) È true se il mittente verrà salvato come default per tutte le altre spedizioni
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:
type(string) Il tipo del file, che varia a seconda del corriere (vedi tabella)
name(string) Il nome del file
content(string) Contenuto del file in codifica base64
  FEDEX DHL UPS
AUTHORIZATION_FORM  
CERTIFICATE_OF_ORIGIN
COMMERCIAL_INVOICE
DECLARATION  
EXPORT_ACCOMPANYING_DOCUMENT  
EXPORT_LICENSE  
IMPORT_PERMIT  
NAFTA_CERTIFICATE_OF_ORIGIN  
ONE_TIME_NAFTA  
OTHER
OTHER_DOCUMENT  
PACKING_LIST  
POWER_OF_ATTORNEY  
PRO_FORMA_INVOICE  
SED_DOCUMENT  
SHIPPER_LETTER_OF_INSTRUCTION  
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.

sku*(string) Codice articolo
name*(string) Descrizione articolo
qty*(int) Quantità
price*(float) Prezzo
total(float) Prezzo totale
weight(float) Eventuale peso dell'articolo
url(string) La url specifica del prodotto
imageUrl(string) La url dell'immagine del prodotto
notes(string) Eventuale note prodotto
isReturnable(bool) Prodotto abilitato per il reso. Se non impostato è true
customsCode(string) Eventuale Codice Doganale (HSCode, Taric, ecc.)
originCountry(string) Nazione di origine del prodotto in formato ISO 3166-1 alpha-2 (Esempio: IT)
netWeight(float) Eventuale peso netto del prodotto
unitOfMeasurement(string)

Eventuale unità di misura

Codice Descrizione
BOXBoxes
2GMCentimeters
2M3Cubic Centimeters
3M3Cubic Feet
M3Cubic Meters
DPRDozen Pairs
DOZDozen
2NOEach
PCSPieces
GMGrams
GRSGross
KGKilograms
LLiters
MMeters
3GMMilligrams
3LMilliliters
XNo Unit Required
NONumber
2KGOunces
PRSPairs
2LGallons
3KGPounds
CM2Square Centimeters
2M2Square Feet
3M2Square Inches
M2Square Meters
4M2Square Yards
3MYards
CMCentimeters
CONECone
CTCarat
EAEach
LBSPounds
RILLRill
ROLLRoll
SETSet
TUTime Unit
YDSYard
parcelID(int) Eventuale numero progressivo, identificativo del numero collo in cui viene spedito il prodotto
transparencyCodes(string[]) Array di Transparency Code
custom1(string) Valore custom 1
custom2(string) Valore custom 2
custom3(string) Valore custom 3
custom4(string) Valore custom 4
custom5(string) Valore custom 5
assemblyTypes(array)

Eventuale elenco di tipologie di montaggio, una per prodotto, per i corrieri che supportano questa informazioni

code*(string) Il codice della tipologia di montaggio scelta

Disponibile per il "courierService" 20 (HD). Deve essere specificato un elemento per ogni elemento di rows.

I valori disponibili per "code":

Code Descrizione
5 Attivazione Elettrodomestici
09 Incasso forni/piano cottura con dichiaraz. Conf.
08 Incasso frigoriferi
07 Incasso lavastoviglie e lavatrici
11 Install. Clima DUAL con tubazione da predisporre
14 Install. Clima DUAL con tubazione già predisposta
10 Install. Clima MONO con tubazione da predisporre
13 Install. Clima MONO con tubazione già predisposta
12 Install. Clima TRIAL con tubazione da predisporre
15 Install. Clima TRIAL con tubazione già predisposta
K Installazione base HD
Z Installazione complessa HD
Y Installazione media HD
W Installazione semplice HD
06 Installazione TV a muro
20 Montaggio 30
17 Montaggio Cyclette
18 Montaggio Ellittica
4 Montaggio Strutture Multifunzione
16 Montaggio Tapis Roulant
1 Montaggio Tapis-Cyclette-Ellittica
2 Montaggio Tavoli Ping-Pong
3 Montaggio Vogatori
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

id*(string) Identificativo del PUDO
type(string) Tipologia Servizio
name(string) Nome del servizio
address(string) Indirizzo del punto di Pick-up o Drop-off
city(string) Città del punto Pick-up o Drop-off
state(string) Provincia del punto di Pick-up o Drop-off
country(string) Nazione del punto di Pick-up o Drop-off
postalCode(string) CAP del punto di Pick-up o Drop-off
description(string) Descrizione
harmonisedId(string) Id numerico aggiuntivo del punto di Pick-up o Drop-off, ricavabile dalla getPudos. Es. 104
keyword(string) Keyword del punto di Pick-up o Drop-off, ricavabile dalla getPudos. Es 'DHL Servicepoint'
psfKey(string) PsfKey del punto di Pick-up o Drop-off, ricavabile dalla getPudos. Es 'ES-0004240'
postnumber(string) Postnumber del punto di Pick-up o Drop-off, se di tipo 'packstation'. E' un codice che il cliente finale possiede personalmente
DHL / BRT / INPOST / FEDEX / MRW / SENDING / MONDIALRELAY
Attributo Valore
id*(string) Codice o identificativo del PUDO
TNT ITA / GLS-ITA / LICCARDI
Attributo Valore
id*(string) Valori possibili:
  • TNT: Codice identificativo del TNT point/Locker;
  • GLS-IT: Codice identificativo chiamato SHOP_ID;
  • LICCARDI: Codice identificativo del Punto di Ritiro
type*(string) Valori possibili:
  • TNT: 3 (TNT point) o 5 (TNT Locker);
  • GLS-IT: Codice identificativo chiamato PARTNER_SHOP_ID;
  • LICCARDI: Codice del network, opzionale. Default: GEL
PTI(Poste Italiane)
Attributo Valore
id*(string) Codice o identificativo del PUDO
type*(string) Valori possibili:
  • ConsegnaPuntoPoste
  • ConsegnaUfficioPostale
  • ConsegnaLocker
  • ConsegnaPUDOUPS
name*(string) Nome del Punto di Ritiro
address*(string) Indirizzo del Punto di Ritiro
postalCode*(string) CAP del Punto di Ritiro
city*(string) Città/Località del Punto di Ritiro
province*(string) Provincia del Punto di Ritiro
country*(string) Nazione del Punto di Ritiro
UPS
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
country*(string) Nazione
name*(string) Name
postalCode*(string) CAP
state*(string) Provincia
SDA
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
name*(string) Nome
postalCode*(string) CAP
state*(string) Provincia
DHL-PAKET
Attributo Valore
id*(string) Codice o identificativo
type*(string) Tipo di PUDO ("locker" o "postoffice")
city*(string) Città
name*(string) Nome del PUDO
country*(string) Nazione
postalCode*(string) CAP
postnumber(string) PostNumber. Obbligatorio per il type "postoffice"
DHLPARCEL-ES
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
country*(string) Nazione
postalCode*(string) CAP
harmonisedId*(string) Harmonized Id
keyword*(string) Keyword
psfKey*(string) PsfKey
postnumber(string) PostNumber
GLS-SPAIN
Attributo Valore
id*(string) Codice o identificativo
name*(string) Nome del PUDO
address*(string) Indirizzo
city*(string) Città
country*(string) Nazione
postalCode*(string) CAP
CORREOS-EXPRESS
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
country*(string) Nazione
postalCode*(string) CAP
SEUR
Attributo Valore
id*(string) Codice o identificativo
TIPSA
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
name*(string) Nome del PUDO
postalCode*(string) CAP
invoice(object)

Permette di impostare le informazioni relative alla fattura associata alla spedizione, utile per le spedizioni che devono passare la dogana.
Obbligatorio per DHL

number*(string) Numero della fattura
date(string) Data della fattura (formato YYYY-MM-DD)
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

batteryPackingType: può assumere 2 valori

  • CONTAINED_IN_EQUIPMENT
  • PACKED_WITH_EQUIPMENT
batteryMaterialType: può assumere 2 valori
  • LITHIUM_METAL
  • LITHIUM_ION

                                    
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)

Eventuale codice merce

Codici specifici per legare tariffazioni diverse legate alla tipologia di merce (da concordare con FERCAM).

Codice Valore
Se non viene specificato nessun parametro, non verrà impostato alcun codice merce.
BANC Utilizzo del listino a bancale.
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)
Tipologia del Tax Identification number del destinatario.
I valori possibili cambiano a seconda del corriere.
Valori ammessi:
  • PERSONAL_NATIONAL
  • PERSONAL_STATE
  • FEDERAL
  • BUSINESS_NATIONAL
  • BUSINESS_STATE
  • BUSINESS_UNION
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)
Indica il tipo di pickup da effettuare da parte del corriere. I valori possono variare a seconda del corriere.
Valori ammessi:
  • USE_SCHEDULED_PICKUP
  • CONTACT_FEDEX_TO_SCHEDULE
  • DROPOFF_AT_FEDEX_LOCATION
signatureRequired
Indica se è necessaria una firma da parte del destinatario alla consegna. I valori cambiano a seconda del corriere.
Valori ammessi:
  • ADULT
  • DIRECT
  • INDIRECT
  • NO_SIGNATURE_REQUIRED
  • SERVICE_DEFAULT
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:
  • COMPANY
  • INDIVIDUAL
  • PASSPORT
Disponibile per il corriere Fedex.
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
  • PDF (base64)
  • JPG (base64)
  • ZPL
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.
Errori
In caso di errore il campo "result" conterrà "KO" ed il campo "error" la descrizione dell'errore.
Default
Default 0
ARCO
Arco standard 0
Arco urgente 1
Arco espresso 2
A.D.R. 3
Sponda idraulica 4
NON SBANCALARE 5
ASENDIA
e-PAQ Plus 31
e-PAQ Select 32
BRT
Express 0
Priority 1
10:30 2
Circuito DPD 6
Circuito Euroexpress 7
Circuito Fedex 8
DPD Direct Infeed 9
CORREOS
Domestic
PAQ Estándar DOMICILIO 22
PAQ Estándar OFICINA 23
PAQ RETORNO PREMIUM CON Envío ASOCIADO 25
S0148 PAQ RETORNO 26
PAQ PREMIUM DOMICILIO 27
PAQ PREMIUM EN OFICINA 28
PAQ PREMIUM ENTREGA EN CITYPAQ 32
PAQ Estándar ENTREGA EN CITYPAQ 34
International
PAQ STANDARD INTERNACIONAL (I) 24
PAQ PREMIUM INTERNACIONAL (I) 29
PAQ INTERNACIONAL LIGH 35
CORREOS-EXPRESS
Domestic
Paq 10 20
Paq 14 21
Paq 24 22
Baleares Express 23
Canarias Express 24
Canarias Aéreo 25
Canarias Marítimo 26
Paq Empresa 14 29
ePaq 24 30
54 Entrega Plus 31
Express Islands 32
International
Paq 24 22
Internacional Estándar 27
Internacional Express 28
Paq Empresa 14 29
ePaq 24 30
54 Entrega Plus 31
CTT-EXPRESS
Domestic
CTT 10 C10
CTT 14 C14
CTT 24 C24
CTT 48 C48
CTT BALEARES ECONOMY CBA48
CTT BALEARES EXPRESS CBA24
CTT CANARIAS AEREO CCA24
CTT CANARIAS DOCUMENTACIÓN CCAE
CTT CANARIAS MARÍTIMO CCAM
International
CTT INTERNACIONAL ECONOMY CIES
CTT INTERNACIONAL EXPRESS CIEX
Crono
Domestic
Express 2
Economy 3
Crono 1
CRONOPLUS 5
ROAD EUROPE - EURODIS 6
Circuito Euroexpress 7
International
Internazionale 8
DHL PARCEL CONNECT
Domestic
DHL Parcel Connect connect
DHL Parcel Connect PLUS connectPlus
International
DHL Parcel International international
DHL-PAKET
Domestic
Paket 0
International
WeltPaket 6
Dhl
Domestic
Domestic Express 0
Domestic Express 10:30 2
Domestic Express 12:00 1
Domestic Express 9:00 4
Express Easy 21
International
La dicitura "doc" indica i servizi senza dogana, "non-doc" quelli con dogana.
Se presenti entrambi la scelta è fatta a livello di codice.
Economy Select (doc / non-doc) 8
Medical Express (doc / non-doc) 20
Parcel Product (doc / non-doc) 22
Express Worldwide H12 (doc / non-doc) 7
International Express Worldwide (doc / non-doc) 9
International Express 9:00 (doc / non-doc) 10
Air Capacity Sales (doc / non-doc) 70
ECONOMY BREAKBULK (doc) 71
EXPRESS 10:30 (doc / non-doc) 72
EXPRESS BREAKBULK (doc) 73
EXPRESS ENVELOPE (doc) 74
GLOBALMAIL (doc) 75
Placeholder (doc) 76
SAME DAY (doc) 77
SAMEDAY SPRINTLINE (doc) 78
EXPRESS EASY (non doc) 79
FREIGHT WORLDWIDE (non doc) 80
SAMEDAY JETLINE (non doc) 81
FERCAM
BOOK BOOK
FLEX 2
FIX 1
SPEED 3
Private 5
HD (check "assemblyTypes") 20
FedEx
Domestic
FedEx First 12
FedEx Priority Express 13
FedEx Priority 14
FedEx Economy 15
FedEx Priority Express Freight 16
FedEx Priority Freight 17
International
Priority 6
First 7
Economy 8
Connect plus 10
Regional Economy 11
GLS-AT
PARCEL PARCEL
EXPRESS EXPRESS
FREIGHT FREIGHT
GLS-ES
CO1 - COURIER 14:00 Service 20
CO2 - COURIER BusinessParcel 21
CO3 - COURIER 10:00 Service 22
CO4 - COURIER SaturdayService 23
CO5 - COURIER MASIVO 24
CO6 - COURIER REC. EN NAVE 25
EC1 - EconomyParcel EconomyParcel 26
CA1 - CARGA MARITIMO 27
CO7 - COURIER ParcelShop 28
EC2 - EconomyParcel ParcelShop 29
EU1 - EUROBUSINESS PARCEL EBP 30
EU2 - EUROBUSINESS SMALL PARCEL EBP 31
AS1 - ASM TRAVELLERS ASM TRAVELLERS 32
Express 19:00 37
INPOST
InPost Locker Standard 1
A2L - InPost Locker Standard 4
Liccardi
Bancale B
Dedicato DE
Espresso E
Reso R
Store ZS
MONDIALRELAY
Merchant collection to Point Relais® S01
Point Relais® collection to Point Relais® S02
Merchant collection to Point Relais® S03
Point Relais® collection to Point Relais® S04
Merchant collection to Home delivery S05
MRW-ES
Urgente 10 0000
Urgente Hoy - Frecuencia 1 0005_1
Urgente Hoy - Frecuencia 2 0005_2
Promociones 0010
Urgente 10 Expedición 0015
Urgente 12 0100
Urgente 12 Expedición 0105
Urgente 14 0110
Urgente 14 Expedición 0115
Urgente 19 0200
Urgente 19 Expedicion 0205
Urgente 19 Portugal 0220
Bag 19 0230
Bag 14 0235
Economico 0300
Economico Interinsular 0350
Marítimo Baleares 0370
Marítimo Canarias 0385
Marítimo Interinsular 0390
Express Documentos 0400
Express 2 Kilos 0450
Caja Express 3 Kilos 0480
Documentos 14 0490
Ecommerce 0800
Tramo Orario 08-14 0800_tramo_1
Tramo Orario 16-19 0800_tramo_2
Ecommerce Ultrarrápido - Frecuencia 1 0800_1
Ecommerce Ultrarrápido - Frecuencia 2 0800_2
Ecommerce Canje 810
Milkman
Standard 0
Premium 1
NACEX ES
NACEX 10:00H 20
NACEX 12:00H 21
INTERDIA mañana 22
INTERDIA tarde 23
INTERDIA aéreo 24
PLUS BAG 1 25
PLUS BAG 2 26
VALIJA 27
VALIJA IDA Y VUELTA 28
NACEX 19:00H 29
PUENTE URBANO mañana 30
PUENTE URBANO tarde 31
PUENTE URBANO nocturno. 32
DEVOLUCION ALBARAN CLIENTE 33
NACEX 08:30H 34
DEVOLUCION TALON 35
DEVOLUCION PLUS BAG 1 36
DEVOLUCION PLUS BAG 2 37
DEVOLUCION E-NACEX 38
NACEX SABADO 39
CANARIAS MARITIMO 40
CANARIAS 24H 41
PLUS PACK 42
E-NACEX 43
PREMIUM 44
NX-SHOP VERDE 45
NX-SHOP NARANJA 46
E-NACEX SHOP 47
C@MBIO 48
CANARIAS 48H 49
INMEDIATO 50
NACEX.SHOP 51
SWAP 52
RETORNO SWAP 53
DEV. ORIGEN 54
EURONACEX TERRESTRE 55
SERVICIO AEREO 56
EURONACEX ECONOMY 57
PLUSPACK EUROPA 58
BALEARES MARITIMO 59
NEXIVE
Sistema Completo 0
Sistema Economy 2
Sistema Slim 1
Sistema Espresso 3
PAACK
ST2 - Same day delivery - Timeslot available - 2 hours ST2
PT2 - Precise day delivery - Timeslot available - 2 hours PT2
CT2 - Two-day delivery - Timeslot available - 2 hours CT2
WT2 - Any day delivery - Timeslot available - 2 hours WT2
ST3 - Same day delivery - Timeslot available - 3 hours ST3
ST4 - Same day delivery - Timeslot available - 4 hours ST4
NT4 - Next day delivery - Timeslot available - 4 hours NT4
PT4 - Precise day delivery - Timeslot available - 4 hours PT4
CT4 - Two-day delivery - Timeslot available - 4 hours CT4
WT4 - Any day delivery - Timeslot available - 4 hours WT4
STH - Same day delivery - Timeslot available - morning or evening slots STH
NTH - Next day delivery - Timeslot available - morning or evening slots NTH
PTH - Precise day delivery - Timeslot available - morning or evening slots PTH
CTH - Two-day delivery - Timeslot available - morning or evening slots CTH
WTH - Any day delivery - Timeslot available - morning or evening slots WTH
PTA - Precise day delivery - Timeslot available - All day PTA
STZ - Same day delivery - Timeslot available - Other STZ
NTZ - Next day delivery - Timeslot available - Other NTZ
PTZ - Precise day delivery - Timeslot available - Other PTZ
CTZ - Two-day delivery - Timeslot available - Other CTZ
WTZ - Any day delivery - Timeslot available - Other WTZ
XTZ - Same day / express delivery - Timeslot available - Other XTZ
SF2 - Same day delivery - Fixed timeslot - 2 hours SF2
NF2 - Next day delivery - Fixed timeslot - 2 hours NF2
PF2 - Precise day delivery - Fixed timeslot - 2 hours PF2
CF2 - Two-day delivery - Fixed timeslot - 2 hours CF2
WF2 - Any day delivery - Fixed timeslot - 2 hours WF2
XF2 - Same day / express delivery - Fixed timeslot - 2 hours XF2
SF4 - Same day delivery - Fixed timeslot - 4 hours SF4
NF4 - Next day delivery - Fixed timeslot - 4 hours NF4
PF4 - Precise day delivery - Fixed timeslot - 4 hours PF4
CF4 - Two-day delivery - Fixed timeslot - 4 hours CF4
WF4 - Any day delivery - Fixed timeslot - 4 hours WF4
XF4 - Same day / express delivery - Fixed timeslot - 4 hours XF4
NFA - Next day delivery - Fixed timeslot - All day NFA
PFA - Precise day delivery - Fixed timeslot - All day PFA
CFA - Two-day delivery - Fixed timeslot - All day CFA
WFA - Any day delivery - Fixed timeslot - All day WFA
NFZ - Next day delivery - Fixed timeslot - Other NFZ
PFZ - Precise day delivery - Fixed timeslot - Other PFZ
CFZ - Two-day delivery - Fixed timeslot - Other CFZ
WFZ - Any day delivery - Fixed timeslot - Other WFZ
XFZ - Same day / express delivery - Fixed timeslot - Other XFZ
PS2 - Precise day delivery - Fixed timeslot - 2 hours (custom) PS2
Poste Delivery Business
Domestic
Standard nazionale 0
Espresso nazionale 1
International
Standard internazionale APT000904
Espresso internazionale APT000903
International Plus APT001013
SDA
Extralarge 0
Internazionale 8
Economy 3
Road Europe 7
Export Box 6
Crono Internazionale P48
SEUR
Domestic
SEUR 24 20
SEUR 10 21
SEUR 13:30 22
SEUR FRIO 10 27
SEUR FRIO 13:30 28
Seur FRIO 48 (Baleares) 29
Seur 13 Saturday 30
Seur 24 PICKUP 31
International
Seur Internacional NON EU 23
Seur Classic (DPD) Internacional Terrestre 24
Seur Classic (DPD) Predict Crossborder 25
Seur NetExpress (SEUR) Internacional Terrestre 26
Seur Classic 2SHOP 32
SMM-IT
AT_DPD_PRIME_GEN 20
AT_POST_0584 21
AT_POST_B2C 46
BE_G3_STA 22
BE_TOO_BP 47
CH_SWP_PPECO 23
DE_490_WINE 24
DE_DHL_STA_POST 25
DE_DPD_B2C 26
DE_HERM_DROPOFF 27
DE_HERM_STA 28
DE_HERM_WINE 29
DE_DHL_PAKET_WEBSERVICE 43
ES_CORR_DROPOFF 30
ES_CORR_STA 31
FR_COL_SFS 44
FR_GLS_ADO 32
FR_GLS_STA 33
FR_GLS_WINE 34
FR_LPF_OTH 35
FR_MONDIAL_DROPOFF 36
INT_DHL_ECO 37
INT_DHL_EXPMB 38
IT_GLS_LIGHT 39
IT_SDA_MULTI 40
NL_G3_STA 41
PT_CORR_RAN 42
ES_PAA_STA 45
SkyNet Worldwide Express
Domestic
Domestic Express 0
Domestic Express 1/5000 1
Express Documents 6
Express Non Documents 7
SKYSAVER 8
International
USA Deferred 9
USA Economy Service 10
Spring GDS
TRCK - TRACKED 20
SIGN - SIGNATURED 21
PPTT - PostNL Packet Tracked 30
PPTR - PostNL Packet Registered 31
PPNT - PostNL Packet Non Tracked 32
CLLCT - Spring Collect Service 33
TRPL - Tracked Plus 34
SIPL - SIGNATURED 35
TIPSA
20 - DELEGATION 20
48 - ECONOMY 21
25 - FARMA 22
96 - MARITIMA 23
24 - PREMIUM 24
06 - TIPSA 06 25
10 - TIPSA 10 26
14 - TIPSA 14 27
MV - TIPSA, 28
50 - YUPICK 29
TNT ES
Domestic
Express 40
10:00 Express 42
12:00 Express 44
Express Plus 46
International
Economy Express 20
12:00 Economy Express 21
Express 22
9:00 Express 24
10:00 Express 26
12:00 Express 28
TNT IT
Domestic
Nazionale Express 0
Nazionale 12:00 Express 1
Nazionale 10:00 Express 2
Nazionale Economy Express 3
International
Internazionale Express 6
Internazionale 12:00 Express 7
Internazionale Economy Express 8
Internazionale 12:00 Economy Express 9
TWS
ESPRESSO ESPRESSO
CAMIONISTICO CAMIONISTICO
TWSPACKETEXP TWSPACKETEXP
TWSPACKETCAM TWSPACKETCAM
TWSPACKETDOC TWSPACKETDOC
ESPRESSOGLS ESPRESSOGLS
UPS
Domestic
Nazionale Express Saver 0
Nazionale Express 1
Nazionale Express Plus 2
Nazionale Standard 3
International
Internazionale Express 6
Internazionale Express Plus 7
Internazionale Standard 8
Internazionale Saver 9
Expedited 10
USA Next day air 21
USA 2nd day air 22
USA Ground 23
ARCO
Preavviso telefonico S
Sponda idraulica X
A.D.R. R
ALLA CONS.RIT.MERC. B6
CONS. CON FURGONE B8
CON. CON TRASPALLET 65
CONS. CON MEZZO PICC RK
CONS. MEZZO APERTURA LATERALE Y
CONSEGNA AL PIANO Z|A6
CONSEGNA IN CANTINA Q|A7
FACCHINAGGIO 6|A3
FERMO DEPOSITO F
FRAGILE 28
MERCE SUI BANCALI C
NON SBANCALARE B
NON SOVRAPPORRE N
ASENDIA
Economy ECO
Signature SIG
PUDO PUDO
Mailbox MBX
Predict next day PND
Predict two days P2D
Saturday SAT
Evening delivery ED
Timed delivery by 10.00 1000
Timed delivery by 12.00 1200
Dangerous Goods DG
Address correction AC
POD POD
Flex FLX
Enhanced liability 500 € EL500
Enhanced liability 45 € EL45
Enhanced liability 150 € EL150
Sea SEA
Personal Delivery PD
BRT
su appuntamento A
consegna al piano P
servizio fresh FRESH_YYYY-MM-DD
CORREOS
Código Oficina (máximo 7 caracteres)
CORREOS EXPRESS
Entrega el sábado sabato
FERCAM
Al piano alPiano
Sponda sponda
Prenotazione telefonica appuntamento
GLS AT
08:00 Service 0800Service
09:00 Service 0900Service
10:00 Service 1000Service
12:00 Service 1200Service
Saturday 10:00 Service Saturday1000Service
Saturday 12:00 Service Saturday1200Service
Saturday Service SaturdayService
GLS-ITA
EXPRESS 12 22
FLEX DELIVERY PARCEL 31
SMART DELIVERY SERVICE 39
EXCHANGE 24
CONSEGNA AL PIANO 05
PREAVVISO TELEFONICO 25
SERVIZIO AL SABATO 07
SERVIZIO AL SABATO AFTERNOON 29
ENTRO ORE 12 01
ORA FISSA 02
SATURDAY EXPRESS 36
MEZZO IDONEO 06
LICCARDI
Preavviso telefonico preavvisoTelefonico
MRW_ES
Entrega el sábado sabato
Entrega urgente 8:30 entrega830
Entrega Partir De (de 00:00 a 23:00) ejemplo 10:00
Sin gestión N_gestion
Gestión en origen O_gestion
Gestión en destino D_gestion
Sin retorno N_retorno
Retorno de albarán cobro en destino D_retorno
Retorno de mercancia S_retorno
Sin confirmación inmediata de entrega/recogida N_confirm
Confirmación inmediata de recogida R_confirm
Confirmación inmediata de entrega E_confirm
PTI
Al piano alPiano
Sabato sabato
Su appuntamento appuntamento
Poste Delivery Now PDBnow
SDA / CRONO-PTI
consegna al piano alPiano
consegna al sabato sabato
consegna alla sera sera
su appuntamento appuntamento
Ore 09:00 T09
Ore 10:00 T10
Ore 12:00 T12
SEUR
Entrega el sábado sabato
TWS
Consegna entro le 09:00 AM - spedizione monocollo T09
Consegna entro le 10:00 AM T10
Consegna entro le 12:00 AM T12
Consegna Al Piano PIA
Consegna Di Sabato SAB
Consegna Su Appuntamento APP
Consegna Di Sera SER
Combinazione Consegna Al Piano/Di Sabato PSA
Combinazione Consegna Al Piano/Su Appuntamento PAP
Combinazione Consegna Al Piano/Di Sera PSE
Combinazione Consegna Al Piano/Ore 9 PI0
Combinazione Consegna Al Piano/Ore 10 PI1
Combinazione Consegna Al Piano/Ore 12 PI2
Combinazione Consegna Di Sabato/Su Appuntamento SAP
Combinazione Consegna Su Appuntamento/Di Sera ASE
Combinazione Consegna Al Piano/Su Appuntamento/Di Sera APS
Combinazione Al Piano/Di Sabato/Su Appuntamento ASP
UPS
Direct Delivery Only directDeliveryOnly
ARCO
CONTANTE A
ASSEGNO BANCARIO INTESTATO AL MITTENTE 1
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE 2
ACCETTARE EFFETTO COME EMESSO DA DESTINATARIO 9
BRT - DISK B – WS REST
CONTANTE 12
ASSEGNO INTESTATO AL MITTENTE [BP] 17
ASSEGNO CIRCOLARE INTESTATO ALLA MITTENTE [CM] 18
ASSEGNO BANCARIO INTESTATO ALLA MITTENTE [BM] 15
ASSEGNO CIRCOLARE INTESTATO AL CORRIERE 6
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE ORIGINALE [OC] 10
ASSEGNO INTESTATO AL MITTENTE ORIGINALE [OM] 11
ASSEGNO BANCARIO INTESTATO CORRIERE CON MANLEVA [BB] 3
ACCETTARE ASSEGNO BANCARIO INTESTATO ALLA MITTENTE COSI COME RILASCIATO [TM] 19
DHL
CASH, POS YYY
CONTANTE 12
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE ORIGINALE 10
ASSEGNO BANCARIO INTESTATO AL MITTENTE ORIGINALE 15
CONTANTI, POS, ASSEGNO O ASSEGNO POSTALE O ASSEGNO CIRCOLARE PAGABILE AL MITTENTE 0
ASSEGNO BANCARIO O ASSEGNO POSTALE INTESTATO CASA MANDANTE RRR
ASS. CIRC. INT CASA MANDANTE LLL
CASH, POS O ASSEGNO (BANC./POST./CIRCOLARE) INTESTATO CASA MANDANTE JJJ
FERCAM
CONTANTE 12
ASSEGNO INTESTATO AL MITTENTE ORIGINALE 15
GLS-ITA
CONTANTE CONT
ASSEGNO BANCARIO AB
ASSEGNO CIRCOLARE/BANCARIO (NO POSTALE) ABC
ASSEGNO BANCARIO/POSTALE (NO CIRCOLARE) ABP
ASSEGNO CIRCOLARE AC
ASSEGNO POSTALE AP
ASSEGNO CIRCOLARE/BANCARIO/POSTALE ASS
Ass. come rilasciato ASR
Ass. come rilasciato int. Mittente ARM
Ass. come rilasciato - no postale ASRP
Ass. come rilasciato int. Mittente – no postale ARMP
LICCARDI
SOLO CONTANTI CNT
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE ACM
ASSEGNO BANCARIO INTESTATO AL MITTENTE ABM
ASSEGNO A MITTENTE COME RILASCIATO 6
CONTANTI O ASSEGNO A MITTENTE COME RILASCIATO T
POSTE DELIVERY BUSINESS
CONTANTE 12
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE 10
ASSEGNO BANCARIO INTESTATO AL MITTENTE 11
ASSEGNO INTESTATO AL MITTENTE ORIGINALE 15
SDA
Tutti VAR
Contanti CON
Ass.Banc.Mittente ABM
Ass.Banc.SDA ABS
Ass.Circ.Mittente ACM
Ass.Circ.SDA ACS
TNT IT
CONTANTE 12
ASSEGNO INTESTATO AL MITTENTE ORIGINALE 15