Questo metodo genera una spedizione nel sistema BRT nella soluzione Disk B.
Il servizio esegue le seguenti operazioni:
-
Calcolo instradamento.
-
Stampa l'etichetta segnacolli nel formato richiesto(opzionale)
-
Creazione spedizione
La creazione delle spedizioni con Auto Conferma o Conferma Esplicita deve essere concordata in fase di analisi preliminare con il cliente, in base alla sua operatività. Tale modalità operativa vale per tutto il traffico del cliente e non può essere variato per singola spedizione.
The request body is of type createRequest.
Sommario
 |
createRequest
Struttura di input per l'invio di una nuova spedizione a BRT.
 |
account : account
Informazioni dell'account abilitato al servizio web.
Dato obbligatorio.
 |
userID : string
Codice utente per l'autenticazione al servizio.
Dato obbligatorio. |
|
password : string
Password utente.
Dato obbligatorio. | |
|
|
network : string
Network. [rif. BRT VABATB] [max length =1]
I valori possibili vengono comunicati da BRT. Se indicata stringa vuota viene utilizzato il network standard BRT.
In caso che il cliente possa scegliere più network, in ogni singola richiesta può essere indicato un solo valore.
Viene controllata l'esistenza del dato e l'appartenenza al cliente. |
|
departureDepot : number
Linea di partenza. [rif. BRT VABFGS] [precision =3 scale=0]
Dato obbligatorio.
Viene comunicato da BRT. In caso che il cliente abbia più punti di partenza, saranno comunicati più valori. In ogni singola richiesta può essere indicato un solo valore.
Viene controllata l'esistenza del dato. |
|
senderCustomerCode : number
Codice cliente mittente. [rif. BRT VABCCM] [precision =7 scale=0]
Dato obbligatorio.
Viene comunicato da BRT. In caso che il cliente abbia più codice cliente, saranno comunicati più valori. In ogni singola richiesta può essere indicato un solo valore.
Viene controllata l'esistenza del dato e l'appartenenza all'utente di collegamento (legame padre-figlio). |
|
deliveryFreightTypeCode : string
Tipo porto. [rif. BRT VABCBO] [max length =3]
Dato obbligatorio.
Può valere 'DAP' (porto franco) oppure 'EXW' (porto assegnato). |
|
consigneeCompanyName : string
Ragione sociale destinatario. [rif. BRT VABRSD VABRD2] [max length =70]
Dato obbligatorio se brtServiceCode non è B15. |
|
consigneeAddress : string
Indirizzo destinatario. [min length = 6; max length =35 per spedizioni domestiche (IT) oppure effettuate con Network non abilitati alla gestione dell’indirizzo esteso, max length =105 per spedizioni estere effettuate con Network abilitati alla gestione dell’indirizzo esteso]
Dato obbligatorio se brtServiceCode non è B15. |
|
consigneeZIPCode : string
CAP nel formato della nazione di destinazione. [rif. BRT VABCAD] [max length =9]
Dato obbligatorio se brtServiceCode non è B15.
Viene controllato che sia formalmente valido per la nazione indicata. |
|
consigneeCity : string
Località di destinazione. [rif. BRT VABLOD] [max length =35]
Dato obbligatorio se brtServiceCode non è B15. |
|
consigneeProvinceAbbreviation : string
Sigla della provincia di destinazione. [rif. BRT VABPRD] [max length =2]
Viene controllato che sia formalmente valido rispetto all'elenco sigle delle provincie italiane.
Dato facoltativo. |
|
consigneeCountryAbbreviationISOAlpha2 : string
Sigla della nazione di destinazione. [rif. BRT VABNZD] [max length =2]
Dato obbligatorio se brtServiceCode non è B15.
Deve essere indicata l'abbreviazione ISO 3166-1 alpha-2. |
|
consigneeClosingShift1_DayOfTheWeek : string
Giorno di chiusura 1. [rif. parte BRT VABGC1] [max length =3]
Dato facoltativo.
Può valere:
'MON' = Lunedì / 'TUE' = Martedì / 'WED' = Mercoledì / 'THU' = Giovedì / 'FRI' = Venerdì / 'SAT' = Sabato / 'SUN' = Domenica
se non passato, ma passato il dato consigneeClosingShift1_PeriodOfTheDay, è come indicare 'tutta la settimana' |
|
consigneeClosingShift1_PeriodOfTheDay : string
Periodo di chiusura nel giorno 1. [rif. parte BRT VABGC1] [max length =2]
Dato facoltativo.
Può valere:
'AM' = mattina
'PM' = pomeriggio
se non passato, ma passato il dato consigneeClosingShift1_DayOfTheWeek, è come indicare 'tutto il giorno' |
|
consigneeClosingShift2_DayOfTheWeek : string
Giorno di chiusura 2. [rif. parte BRT VABGC2] [max length =3]
Dato facoltativo.
Può valere:
'MON' = Lunedì / 'TUE' = Martedì / 'WED' = Mercoledì / 'THU' = Giovedì / 'FRI' = Venerdì / 'SAT' = Sabato / 'SUN' = Domenica
se non passato, ma passato il dato consigneeClosingShift2_PeriodOfTheDay, è come indicare 'tutta la settimana' |
|
consigneeClosingShift2_PeriodOfTheDay : string
Periodo di chiusura nel giorno 2. [rif. parte BRT VABGC2] [max length =2]
Dato facoltativo.
Può valere:
'AM' = mattina
'PM' = pomeriggio
se non passato, ma passato il dato consigneeClosingShift2_DayOfTheWeek, è come indicare 'tutto il giorno' |
|
consigneeContactName : string
Referente consegna. [rif. BRT VATNOT + VATTRC=A] [max length =35]
Dato facoltativo. |
|
consigneeTelephone : string
Telefono referente consegna. [rif. BRT VATNOT + VATTRC=B] [max length =16]
Dato facoltativo. |
|
consigneeEMail : string
EMail referente consegna. [rif. BRT VATNOT + VATTRC=I e J] [max length =70]
Dato facoltativo.
Se valorizzato a '1' il dato isAlertRequired, verrà mandato l'alert al destinatario via email a questo indirizzo (se previsto dal contratto con BRT).
Se si vogliono indicare più indirizzi, questi vanno separati dal carattere barra verticale o pipe (|). |
|
consigneeMobilePhoneNumber : string
Mobile referente consegna. [rif. BRT VATNOT + VATTRC=S] [max length =16]
Dato facoltativo.
Se valorizzato a '1' il dato isAlertRequired, verrà mandato l'alert al destinatario via SMS a questo numero (se previsto dal contratto con BRT). |
|
isAlertRequired : string
Richiesta Alert.
Può valere '0' o '1'. |
|
consigneeVATNumber : string
Numero partita IVA. [rif. parte BRT VATNOT + VATTRC=R] [max length =16]
Dato facoltativo. |
|
consigneeVATNumberCountryISOAlpha2 : string
Sigla nazione partita IVA. [rif. parte BRT VATNOT + VATTRC=A] [max length =2]
Dato facoltativo.
Se indicato, deve essere l'abbreviazione ISO 3166-1 alpha-2. |
|
consigneeItalianFiscalCode : string
Codice fiscale italiano. [rif. BRT VATNOT + VATTRC=Q] [max length =16]
Dato facoltativo. |
|
pricingConditionCode : string
Codice tariffa. [rif. BRT VABCTR] [precision =3 scale=0]
Viene comunicato da BRT. In caso che il cliente abbia più tariffe, saranno comunicati più valori. In ogni singola richiesta può essere indicato un solo valore.
Viene controllata l'esistenza del dato e l'appartenenza al cliente. |
|
serviceType : string
Tipo servizio. [rif. BRT VABTSP] [max length =1]
Il suo significato viene spiegato da BRT. Se indicata stringa vuota viene preso il default BRT
Può valere:
Default = servizio standard
'E' = servizio priority
'H' = servizio 10:30
|
|
insuranceAmount : number
Importo assicurazione sulla spedizione. [rif. BRT VABIAS] [precision =7 scale=2]
Dato facoltativo. |
|
insuranceAmountCurrency : string
Divisa dell'importo assicurazione sulla spedizione. [rif. BRT VABVAS] [max length=3]
Dato facoltativo.
Se omesso ma valorizzato insuranceAmount, viene impostato 'EUR' |
|
senderParcelType : string
Natura merce. [rif. BRT VABNAS] [max length=15]
Dato facoltativo. |
|
numberOfParcels : number
Numero di pacchi. [rif. BRT VABNCL] [precision =2 scale=0]
Dato obbligatorio.
Il numero massimo di colli richiedibili è 30 |
|
weightKG : number
Peso totale della spedizione in chilogrammi. [rif. BRT VABPKB] [precision =5 scale=1]
Dato obbligatorio. |
|
volumeM3 : number
Volume totale della spedizione in metri cubi. [rif. BRT VABVLB] [precision =5 scale=3]
Dato facoltativo. |
|
quantityToBeInvoiced : number
Quantità da fatturare. [rif. BRT VABQFT] [precision =7 scale=3]
Dato facoltativo. |
|
cashOnDelivery : number
Contrassegno. [rif. BRT VABCAS] [precision =7 scale=2]
Dato facoltativo.
Se valorizzato a '1' il dato isCODMandatory, questo dato deve essere valorizzato. |
|
isCODMandatory : string
Contrassegno obbligatorio.
Può valere '0' o '1'. |
|
codPaymentType : string
Tipo pagamento contrassegno. [rif. BRT VABTIC] [max length=2]
Dato facoltativo.
Se valorizzato a '1' il dato isCODMandatory, questo dato può essere valorizzato.
Se valorizzato, viene controllata l'esistenza del dato. |
|
codCurrency : string
Divisa contrassegno. [rif. BRT VABVCA] [max length=3]
Dato facoltativo.
Se valorizzato a '1' il dato isCODMandatory, questo dato può essere valorizzato.
Se valorizzato, viene controllata l'esistenza del dato. |
|
numericSenderReference : number
Riferimento mittente numerico. [rif. BRT VABRMN] [precision=15 scale=0]
Dato obbligatorio. |
|
alphanumericSenderReference : string
Riferimento mittente alfanumerico. [rif. BRT VABRMA] [max length=15]
Dato facoltativo. |
|
notes : string
Note. [rif. BRT VABNOT VABNT2] [max length=70]
Dato facoltativo. |
|
parcelsHandlingCode : string
Codice trattamento merce. [rif. BRT VABCTM] [max length=2]
Dato facoltativo
Viene comunicato da BRT, nel caso serva un valore specifico. In caso contrario lasciare vuoto |
|
deliveryDateRequired : string
Data consegna richiesta. [rif. BRT VABDCR] [max length=10]
Dato facoltativo.
Data in formato date *ISO [yyyy-MM-dd] |
|
deliveryType : string
Tipo di consegna rispetto alla data di consegna richiesta. [rif. BRT VABTCR] [max length=1]
Dato facoltativo. |
|
declaredParcelValue : number
Valore merce dichiarato. [rif. BRT VABVMD] [precision=7 scale=2]
Dato facoltativo. |
|
declaredParcelValueCurrency : string
Divisa valore merce dichiarato. [rif. BRT VABVAD] [max length=3]
Dato facoltativo.
Se omesso ma valorizzato declaredParcelValue, viene impostato 'EUR' |
|
particularitiesDeliveryManagementCode : string
Gestione particolarietà di consegna. [rif. BRT VABGMA] [max length=2]
Dato facoltativo.
Sono più valori, che vengono comunicati da BRT.
Viene controllata l'esistenza del dato. |
|
particularitiesHoldOnStockManagementCode : string
Gestione particolarietà di giacenza. [rif. BRT VABGCA] [max length=2]
Dato facoltativo.
Sono più valori, che vengono comunicati da BRT.
Viene controllata l'esistenza del dato. |
|
variousParticularitiesManagementCode : string
Gestione particolarietà varie. [rif. BRT VABGVA] [max length=2]
Dato facoltativo.
Sono più valori, che vengono comunicati da BRT.
Viene controllata l'esistenza del dato. |
|
particularDelivery1 : string
Particolarità di consegna 1. [rif. BRT VABTC1] [max length=1]
Dato facoltativo.
Sono più valori, che vengono comunicati da BRT.
Viene controllata l'esistenza del dato.
|
|
particularDelivery2 : string
Particolarità di consegna 2. [rif. BRT VABTC2] [max length=1]
Dato facoltativo.
Sono più valori, che vengono comunicati da BRT.
Viene controllata l'esistenza del dato.
|
|
palletType1 : string
Tipo pallet 1. [rif. parte BRT VABANT] [max length=4]
Dato facoltativo.
Può valere 'EPAL' o 'EUR' |
|
palletType1Number : number
Numero di pallet del tipo 1. [rif. parte BRT VABANT] [precision=2 scale=0]
Dato facoltativo.
Se valorizzato palletType1, diventa obbligatorio. |
|
palletType2 : string
Tipo pallet 2. [rif. parte BRT VABANT] [max length=4]
Dato facoltativo.
Può valere 'EPAL' o 'EUR' |
|
palletType2Number : number
Numero di pallet del tipo 2. [rif. parte BRT VABANT] [precision=2 scale=0]
Dato facoltativo.
Se valorizzato palletType2, diventa obbligatorio. |
|
originalSenderCompanyName : string
Ragione sociale mittente. [rif. BRT VABRMO] [max length=25]
Dato facoltativo. |
|
originalSenderZIPCode : string
CAP nel formato della nazione del mittente. [rif. BRT VABCMO] [max length=9]
Dato facoltativo.
Se indicato, viene controllato che sia formalmente valido per la nazione indicata. |
|
originalSenderCountryAbbreviationISOAlpha2 : string
Sigla della nazione del mittente. [rif. BRT VABNMO] [max length=2]
Dato facoltativo.
Deve essere indicata l'abbreviazione ISO 3166-1 alpha-2. |
|
cmrCode : string
Codice CMR. [rif. BRT VABCMR] [max length=35]
Campo obbligatorio se si passa dal accorpamento bolle, altrimenti può essere lasciato vuoto |
|
neighborNameMandatoryAuthorization : string
Nome vicino a cui consegnare in assenza del destinatario (obbligatoria autorizzazione). [rif. BRT VATNOT + VATTRC=V e W] [max length=70]
Dato facoltativo.
Se indicato, viene utilizzato solo previa autorizzazione BRT. |
|
pinCodeMandatoryAuthorization : string
PIN code (obbligatoria autorizzazione). [rif. BRT VATNOT + VATTRC=Y] [max length=15]
Dato facoltativo.
Se indicato, viene utilizzato solo previa autorizzazione BRT. |
|
packingListPDFName : string
Nome del packing list PDF. [rif. parte BRT VATNOT + VATTRC=P] [max length=33]
Dato facoltativo. |
|
packingListPDFFlagPrint : string
Flag 1 stampa del packing list PDF. [rif. parte BRT VATNOT + VATTRC=P] [max length=1]
Dato facoltativo.
Valore comunicato da BRT. |
|
packingListPDFFlagEmail : string
Flag 1 stampa del packing list PDF. [rif. parte BRT VATNOT + VATTRC=P] [max length=1]
Dato facoltativo.
Valore comunicato da BRT. |
|
pudoId : string
Identificativo del PUDO BRTfermopoint. [max length=20]
Dato facoltativo.
se valorizzato pudoId, nel caso in cui l'indirizzo di consegna sia diverso dall'indirizzo del PUDO presente nell'anagrafica di BRT, la spedizione viene creata correttamente al indirizzo del PUDO, ma l'esito del servizio restituisce un warning(code 5)
nel caso una spedizione sia consegnata a PUDO deve essere valorizzato almeno uno tra consegneeEMail e consegneeMobilePhoneNumber. |
|
brtServiceCode : string
BRT Service Code. [max length=3]
Dato facoltativo.
Default = servizio standard
'B11' = servizio Direct to Shop. Viene controllato che sia presente il pudoId, che sia formalmente valido e che le caratteristiche della spedizione siano compatibili con il BRT Service Code
‘B13’ = servizio Shop to Shop. Viene controllato che sia presente il pudoId, che sia formalmente valido e che le caratteristiche della spedizione siano compatibili con il BRT Service Code
‘B14’ = servizio Shop to Home. Viene controllato che la spedizione non sia diretta a un PUDO BRTfermopoint e che le caratteristiche della spedizione siano compatibili con il BRT Service Code
‘B15’ = servizio Return from Shop. Viene controllato che sia compilato correttamente il dato returnDepot. Non occorrono i dati del destinatario, se presenti verranno sostituiti con i dati del Deposito di reso.
'B20' = Servizio FRESH per spedizioni a temperatura controllata e garantita (0 °C - 4°C)
|
|
returnDepot : number
Deposito di reso [precision=10 scale=0]
Dato obbligatorio a seconda del tipo servizio.
Viene comunicato da BRT. In caso che il cliente abbia associati più depositi di reso, saranno comunicati più valori. In ogni singola richiesta può essere indicato un solo valore.
|
|
expiryDate : string
Data scadenza. [max length=10]
Dato obbligatorio per il servizio Fresh.
Data in formato date *ISO [yyyy-MM-dd] | |
|
isLabelRequired : string
Dato obbligatorio.
Se indicato '1' viene richiesta l'etichetta da applicare al pacco. |
|
labelParameters : labelParameters
Dato obbligatorio se indicato '1' in isLabelRequired.
Nel caso non sia indicato '1' in isLabelRequired il parametro non deve essere valorizzato (può essere omesso).
|
outputType : string
Dato obbligatorio se indicato isLabelRequired = '1'.
Viene generato uno stream dati in formato Base64; una volta ricevuto occorre effeturare la decodifica prima di stampare l'etichetta. Se sono stampate più etichette ne sarà presente una per pagina.
Deve valere:
'PDF' = Formato etichetta in PDF
'ZPL' = Formato ASCII dell'etichetta con codifica standard ZPL (Zebra Programming Language) |
|
offsetX : string
Dato obbligatorio se indicato isLabelRequired = '1'.
Nel caso il parametro venisse omesso oppure venisse passato un dato alfanumerico, viene forzato il valore 0 (zero).
Distanza orizzontale dal vertice in alto a sinistra. |
|
offsetY : string
Dato obbligatorio se indicato isLabelRequired = '1'.
Nel caso il parametro venisse omesso oppure venisse passato un dato alfanumerico, viene forzato il valore 0 (zero).
Distanza verticale dal vertice in alto a sinistra. |
|
isBorderRequired : string
Dato obbligatorio se indicato isLabelRequired = '1'.
Nel caso il parametro venisse omesso oppure venisse passato un dato diverso da '0' e '1', viene forzato il valore '0' (zero).
Se vale '1' viene creato un bordo all'etichetta. |
|
isLogoRequired : string
Dato obbligatorio se indicato isLabelRequired = '1'.
Nel caso il parametro venisse omesso oppure venisse passato un dato diverso da '0' e '1', viene forzato il valore '0' (zero).
Se vale '1' viene creato il logo BRT sull'etichetta. |
|
isBarcodeControlRowRequired : string
Dato obbligatorio se indicato isLabelRequired = '1'.
Nel caso il parametro venisse omesso oppure venisse passato un dato diverso da '0' e '1', viene forzato il valore '0' (zero).
Se vale '1' viene creata una riga di controllo sopra al barcode. |
|
labelFormat : string
Dato facoltativo.
Se valorizzato, indica il formato dell'etichetta che verrà restituita.
I valori possibili sono:
Se non passato oppure impostata stringa vuota, sarà restituita l'etichetta BRT - Formato 95 mm * 65 mm
'DP5': etichetta DPD solo per clienti abilitati al Direct Infeed - Formato 100 mm * 150 mm, l'OutputType in questo caso è solo ZPL.
'DPH': etichetta "ibrida" DPD/BRT solo per clienti abilitati - Formato 100 mm * 150 mm, l'OutputType in questo caso è solo ZPL.
| |
|
|
actualSenderName : string
Nome del mittente reale. [Maxlegth=70]
Dato obbligatorio. |
|
actualSenderCity : string
Località del mittente reale. [Maxlegth=35]
Dato Facoltativo. |
|
actualSenderAddress : string
Indirizzo del mittente reale. [Maxlegth=35]
Dato Facoltativo. |
|
actualSenderZIPCode : string
CAP nel formato della nazione del mittente reale. [Maxlegth=9]
Dato Facoltativo.
Viene controllato che sia formalmente valido per la nazione indicata |
|
actualSenderProvince : string
Sigla della provincia del mittente reale. [Maxlegth=2]
Dato Facoltativo.
Viene controllato che sia formalmente valido rispetto all'elenco sigle delle provincie italiane |
|
actualSenderCountry : string
Sigla della nazione del mittente reale. [Maxlegth=3]
Dato Facoltativo.
Deve essere indicata l'abbreviazione ISO 3166-1 alpha-2 |
|
actualSenderEmail : string
Email del mittente reale. [Maxlegth=70]
Dato obbligatorio.
deve essere valorizzato almeno uno dei due campi tra actualSenderEmail e actualSenderMobilePhoneNumber |
|
actualSenderMobilePhoneNumber : string
Mobile del mittente reale. [Maxlegth=16]
Dato obbligatorio.
deve essere valorizzato almeno uno dei due campi tra actualSenderEmail e actualSenderMobilePhoneNumber |
|
actualSenderPudoId : string
Id pudo del mittente reale. [Maxlegth=20]
Dato facoltativo.
Se valorizzato actualSenderPudoId, nel caso in cui l'indirizzo di consegna sia diverso dall'indirizzo del PUDO presente nell'anagrafica di BRT, la spedizione viene creata correttamente al indirizzo del PUDO, ma l'esito del servizio restituisce un warning (5)
| |
|
|
returnShipmentConsigneeName : string
Nome del destinatario del reso. [Maxlegth=70]
Dato obbligatorio. |
|
returnShipmentConsigneeCity : string
Località del destinatario del reso. [Maxlegth=35]
Dato obbligatorio. |
|
returnShipmentConsigneeAddress : string
Indirizzo del destinatario del reso. [Maxlegth=35]
Dato obbligatorio. |
|
returnShipmentConsigneeZIPCode : string
CAP nel formato della nazione del destinatario del reso. [Maxlegth=9]
Dato obbligatorio.
Viene controllato che sia formalmente valido per la nazione indicata |
|
returnShipmentConsigneeProvince : string
Sigla della provincia del destinatario del reso. [Maxlegth=2]
Dato Opzionale.
Viene controllato che sia formalmente valido rispetto all'elenco sigle delle provincie italiane |
|
returnShipmentConsigneeCountry : string
Sigla della nazione del destinatario del reso. [Maxlegth=3]
Dato obbligatorio.
Deve essere indicata l'abbreviazione ISO 3166-1 alpha-2 |
|
returnShipmentConsigneeEmail : string
Email del destinatario del reso. [Maxlegth=70]
Dato obbligatorio.
deve essere valorizzato almeno uno dei due campi tra returnShipmentConsigneeEmail e returnShipmentConsigneeMobilePhoneNumber |
|
returnShipmentConsigneeMobilePhoneNumber : string
Mobile del destinatario del reso. [Maxlegth=16]
Dato obbligatorio.
deve essere valorizzato almeno uno dei due campi tra returnShipmentConsigneeEmail e returnShipmentConsigneeMobilePhoneNumber |
|
returnShipmentConsigneePudoId : string
Id pudo del destinatario del reso. [Maxlegth=20]
Dato facoltativo.
Se valorizzato returnShipmentConsigneePudoId, nel caso in cui l'indirizzo di consegna sia diverso dall'indirizzo del PUDO presente nell'anagrafica di BRT, la spedizione di reso viene creata correttamente al indirizzo del PUDO, ma l'esito del servizio restituisce un warning (5) | | |
Sample Data
{
"account": {
"userID": 1020100,
"password": "*****"
},
"createData": {
"network": " ",
"departureDepot": 102,
"senderCustomerCode": 1020100,
"deliveryFreightTypeCode": "DAP",
"consigneeCompanyName": "TEST UFFICIO VAS",
"consigneeAddress": "VIA DEL PODERE FIUME 55",
"consigneeCountryAbbreviationISOAlpha2": "IT",
"consigneeClosingShift1_DayOfTheWeek": "MON",
"consigneeClosingShift1_PeriodOfTheDay": "PM",
"consigneeClosingShift2_DayOfTheWeek": "",
"consigneeClosingShift2_PeriodOfTheDay": "",
"consigneeContactName": "RAIMONDI SCANU",
"consigneeTelephone": "66144217",
"consigneeEMail": "",
"consigneeMobilePhoneNumber": "",
"isAlertRequired": 0,
"consigneeVATNumber": "",
"consigneeVATNumberCountryISOAlpha2": "",
"consigneeItalianFiscalCode": "",
"pricingConditionCode": "000",
"serviceType": "",
"insuranceAmount": 0,
"insuranceAmountCurrency": "EUR",
"senderParcelType": "",
"quantityToBeInvoiced": 0.0,
"cashOnDelivery": 0,
"isCODMandatory": "0",
"codPaymentType": " ",
"codCurrency": "EUR",
"notes": "",
"parcelsHandlingCode": "2",
"deliveryDateRequired": "",
"deliveryType": "",
"declaredParcelValue": 0,
"declaredParcelValueCurrency": "EUR",
"particularitiesDeliveryManagementCode": "",
"particularitiesHoldOnStockManagementCode": "",
"variousParticularitiesManagementCode": "B",
"particularDelivery1": "",
"particularDelivery2": "",
"palletType1": "EUR",
"palletType1Number": 10,
"palletType2": "",
"palletType2Number": 0,
"originalSenderCompanyName": "",
"originalSenderZIPCode": "",
"originalSenderCountryAbbreviationISOAlpha2": " ",
"cmrCode": "",
"neighborNameMandatoryAuthorization": "",
"pinCodeMandatoryAuthorization": "",
"packingListPDFName": "",
"packingListPDFFlagPrint": "",
"packingListPDFFlagEmail": "",
"numericSenderReference": 55,
"alphanumericSenderReference": "aaa",
"numberOfParcels": 1,
"weightKG": 81.0,
"volumeM3": 0.451,
"consigneeZIPCode": "55047 ",
"consigneeCity": "QUERCETA",
"consigneeProvinceAbbreviation": "LU"
},
"isLabelRequired": 1,
"labelParameters": {
"outputType": "ZPL",
"offsetX": 0,
"offsetY": 0,
"isBorderRequired": "0",
"isLogoRequired": "0",
"isBarcodeControlRowRequired": "0"
}
}The response body is of type createResult.
Successful operation
Sommario
|
createResult
Contiene la struttura di ritorno dati con HTTP code = 200
|
|
currentTimeUTC : string
Data e ora in formato UTC con offset rispetto alla localizzazione del server di riposta. |
|
executionMessage : executionMessage
Struttura contenente il messaggio di risposta.
|
code : integer
Codice esito richiesta.
I messaggi sono codificati con questa logica:
- code>0 esito postivo, viene comunque segnalato un warning
- code=0 esito positivo
- code<0 esito negativo
-
da -1 a -60 sono errori comuni a tutti i metodi.
-
da -61 a -99 sono errori dedicati alla scrittura spedizione
-
da -100 a -160 sono errori dedicati alla conferma / cancellazione di una spedizione. |
|
codeDesc : string
Descrizione del messaggio |
|
message : string
Dettaglio del messaggio. | |
|
arrivalTerminal : string
Terminal di arrivo.
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
arrivalDepot : string
Filiale di arrivo. [rif. BRT VABLNA]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
deliveryZone : string
Zona di consegna. [rif. BRT VABZNC]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
parcelNumberFrom : string
Numero (segnacollo) assegnato al primo pacco della spedizione. [rif. BRT VABNCD]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
parcelNumberTo : string
Numero (segnacollo) assegnato all'ultimo pacco della spedizione. [rif. BRT VABNCA] I segnacolli sono consecutivi.
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
departureDepot : number
Filiale di partenza. [rif. BRT VABLNP]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
seriesNumber : number
Numero serie assegnata al cliente. [rif. BRT VABNRS]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
serviceType : string
Tipo servizio. [rif. BRT VABTPS]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
consigneeCompanyName : string
Ragione sociale destinatario. [rif. BRT VABRSD]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
consigneeAddress : string
Indirizzo destinatario. [min length = 6; max length =35 per spedizioni domestiche (IT) oppure effettuate con Network non abilitati alla gestione dell’indirizzo esteso, max length =105 per spedizioni estere affettuate con Network abilitati alla gestione dell’indirizzo esteso]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
consigneeZIPCode : string
CAP nel formato della nazione di destinazione. [rif. BRT VABCAD]
Il dato potrebbe essere stato normalizzato.
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
consigneeCity : string
Località destinatario. [rif. BRT VABLOD]
Il dato potrebbe essere stato normalizzato.
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
consigneeProvinceAbbreviation : string
Sigla della provincia del destinatario. [rif. BRT VABPRD]
Il dato potrebbe essere stato normalizzato.
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
consigneeCountryAbbreviationBRT : string
Sigla BRT della nazione del destinatario. [rif. BRT VABNZD]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
numberOfParcels : number
Numero di pacchi della spedizione. [rif. BRT VABNCL]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
weightKG : number
Peso totale della spedizione. [rif. BRT VABPKB]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
volumeM3 : number
Volume totale della spedizione. [rif. BRT VABVLB]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
alphanumericSenderReference : string
Riferimento mittente alfanumerico. [rif. BRT VABRMA]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
senderCompanyName : string
Ragione sociale mittente. [rif. BRT VABRMO]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
senderProvinceAbbreviation : string
Sigla della provincia del mittente. [rif. BRT VABNMO]
Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta. |
|
labels : labels
Contiene le etichette e il relativo barcode BRT della spedizione.
 |
label : Array[label]
La struttura contiene l'etichetta e il relativo barcode BRT del pacco.
|
dataLength : integer
Lunghezza in byte dello stream etichetta. |
|
parcelID : string
E' il Barcode BRT presente sul etichetta, in codifica code 128 - lungo 18. |
|
trackingByParcelID : string
E' il dato con cui eseguire la ricerca spedizione mediante l'API REST trackingByParcelID - lungo 15. |
|
parcelNumberGeoPost : string
E' il numero di collo GeoPost. |
|
stream : string
Lo stream dati è ANSI in formato Base64; una volta ricevuto occorre effeturare la decodifica prima di stampare l'etichetta. |
|
streamDigitalLabel : string
Lo stream dati è ANSI in formato Base64; una volta ricevuto occorre effettuare la decodifica per avere immagine del 2DCode in formato PNG. | | | | |
Creazione di una spedizione con la generazione automatica delle etichette da applicare sui pacchi.
I parametri del tipo etichetta sono passati attraverso labelParameters Json Schema, nel nostro caso abbiamo scelto come formato di output etichetta ZPL (se necessario solo per questa modalità è possibile anche centrare l'etichetta sul proprio formato "label" attraverso i parametri offsetX e "offsetY), lo stream dati ritornato è codificato in base64 sarà quindi necessario decodificare lo stream prima di inviarlo all'etichettatrice.
Nel esempio l'etichetta tornata è la seguente:
BASE64
AF5YQQ0KXlBPSQ0KXkxIMTMwLDIwDQpeUFJDXkZTDQpeRk8wNjAsMDAwXkdCMTMwLDEyMCwwMDNeRlMNCl5GTzA3MCwwMTBeQTBOLDEzNSw3Ml5GUl5GRE9PMV5GUw0KXkZPMjA1LDAzMF5BME4sMDkwLDQ4XkZET08xXkZTDQpeRk81NDEsMDAwXkdCMDg4LDExMCwwM15GUw0KXkZPNTQ4LDAxMF5BME4sMTI1LDc1XkZSXkZEMk9eRlMNCl5GTzAwMCwzMjBeQUNOLDU0LDIwXkZEMTAyXkZTDQpeRk8xMTAsMTMwXkdCTzQwMiwwMDUsMDA1DQpeRlMNCl5CWTMsMywwDQpeRk8xMTAsMTMwXkJDTiwyMDAsTixOLE5eRkQ+OzEwMjAwMTAzMDAyMzI3MDIwMF5GUw0KXkZPMTEwLDMzMF5HQk80MDIsMDA1LDAwNV5GUw0KXkZPMDIwLDM3MF5BME4sMDkwLDYwXkZETzMtXkZTDQpeRk8xMzAsMzcwXkEwTiwwOTAsMDg0XkZET08yM15GUw0KXkZPMzIwLDM0MF5BME4sMTQ1LDEwOF5GRDI3T15GUw0KXkZPMDAwLDQ2MF5BQ04sMTgsMTBeRkRSaWYuOiA2ICAgICAgICAgICAgICBeRlMNCl5GTzMzMCw0NjBeQUNOLDE4LDEwXkZEMDYvMDIvMjAyMF5GUw0KXkZPNDYwLDQ2MF5BQ04sMTgsMTBeRkQgXkZTDQpeRk81MTAsNDQ1XkFDTiwzNiwyMF5GRCBeRlMNCl5GVDU5Miw0ODBeQTBCLDI1LDIyXkZEICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIF5GUw0KXkZUNTk1LDQ4MF5BMEIsMjUsMjJeR0IwLDM1MCwzXkZTDQpeRlQ2MjUsNDgwXkEwQiwyNSwyMl5GRFNQRURJWklPTkUgREkgUFJPVkEgQ0VEVkFTIEJPICAgICAgICBeRlMNCl5GVDY1NSw0ODBeQTBCLDI1LDIyXkZEVklBIEVOUklDTyBNQVRURUksIDU0ICBCT0xPR05BICAgICAgIF5GUw0KXkZUNjkwLDQ4MF5BMEIsMjUsMjFeRkRNQy4gMCwwMDAgICBeRlMNCl5GVDY5MCwzMjBeQTBCLDI1LDIyXkZEICAgIDEtMiAgICBeRlMNCl5GVDY5MCwxNjBeQTBCLDI1LDIyXkZES0cuICAxLDAgICAgXkZTDQpeRk8wMDAsMjQwXkdCMDY1LDA2NSw2MF5GUw0KXkZPMDIwLDI1MF5BME4sMDYwLDA0OF5GUl5GREVeRlMNDF5YWg0KDQw=
DECODE BASE64
^XA
^POI
^LH130,20
^PRC^FS
^FO060,000^GB130,120,003^FS
^FO070,010^A0N,135,72^FR^FDOO1^FS
^FO205,030^A0N,090,48^FDOO1^FS
^FO541,000^GB088,110,03^FS
^FO548,010^A0N,125,75^FR^FD2O^FS
^FO000,320^ACN,54,20^FD102^FS
^FO110,130^GBO402,005,005
^FS
^BY3,3,0
^FO110,130^BCN,200,N,N,N^FD>;102001030023270200^FS
^FO110,330^GBO402,005,005^FS
^FO020,370^A0N,090,60^FDO3-^FS
^FO130,370^A0N,090,084^FDOO23^FS
^FO320,340^A0N,145,108^FD27O^FS
^FO000,460^ACN,18,10^FDRif.: 6 ^FS
^FO330,460^ACN,18,10^FD06/02/2020^FS
^FO460,460^ACN,18,10^FD ^FS
^FO510,445^ACN,36,20^FD ^FS
^FT592,480^A0B,25,22^FD ^FS
^FT595,480^A0B,25,22^GB0,350,3^FS
^FT625,480^A0B,25,22^FDSPEDIZIONE DI PROVA CEDVAS BO ^FS
^FT655,480^A0B,25,22^FDVIA ENRICO MATTEI, 54 BOLOGNA ^FS
^FT690,480^A0B,25,21^FDMC. 0,000 ^FS
^FT690,320^A0B,25,22^FD 1-2 ^FS
^FT690,160^A0B,25,22^FDKG. 1,0 ^FS
^FO000,240^GB065,065,60^FS
^FO020,250^A0N,060,048^FR^FDE^FS
^XZ
//METHOD POST /shipment
//INPUT BODY
{
"account": {
"userID": "1020100",
"password": "brt1447st"
},
"createData": {
"network": " ",
"departureDepot": "102",
"senderCustomerCode": "1020100",
"deliveryFreightTypeCode": "DAP",
"consigneeCompanyName": "TEST UFFICIO VAS",
"consigneeAddress": "VIA DEL PODERE FIUME 55",
"consigneeCountryAbbreviationISOAlpha2": "IT",
"consigneeClosingShift1_DayOfTheWeek": "MON",
"consigneeClosingShift1_PeriodOfTheDay": "PM",
"consigneeClosingShift2_DayOfTheWeek": "",
"consigneeClosingShift2_PeriodOfTheDay": "",
"consigneeContactName": "RAIMONDI SCANU",
"consigneeTelephone": "66144217",
"consigneeEMail": "",
"consigneeMobilePhoneNumber": "",
"isAlertRequired": 0,
"consigneeVATNumber": "",
"consigneeVATNumberCountryISOAlpha2": "",
"consigneeItalianFiscalCode": "",
"pricingConditionCode": "000",
"serviceType": "",
"insuranceAmount": 0,
"insuranceAmountCurrency": "EUR",
"senderParcelType": "",
"quantityToBeInvoiced": 0.0,
"cashOnDelivery": 0,
"isCODMandatory": "0",
"codPaymentType": " ",
"codCurrency": "EUR",
"notes": "",
"parcelsHandlingCode": "",
"deliveryDateRequired": "",
"deliveryType": "",
"declaredParcelValue": 0,
"declaredParcelValueCurrency": "EUR",
"particularitiesDeliveryManagementCode": "",
"particularitiesHoldOnStockManagementCode": "",
"variousParticularitiesManagementCode": "B",
"particularDelivery1": "",
"particularDelivery2": "",
"palletType1": "EUR",
"palletType1Number": 10,
"palletType2": "",
"palletType2Number": 0,
"originalSenderCompanyName": "",
"originalSenderZIPCode": "",
"originalSenderCountryAbbreviationISOAlpha2": " ",
"cmrCode": "",
"neighborNameMandatoryAuthorization": "",
"pinCodeMandatoryAuthorization": "",
"packingListPDFName": "",
"packingListPDFFlagPrint": "",
"packingListPDFFlagEmail": "",
"numericSenderReference": 55,
"alphanumericSenderReference": "aaa1",
"numberOfParcels":1,
"weightKG": 81.0,
"volumeM3": 0.451,
"consigneeZIPCode": "55047 ",
"consigneeCity": "QUERCETA",
"consigneeProvinceAbbreviation": "LU"
},
"isLabelRequired": 1,
"labelParameters": {
"outputType": "ZPL",
"offsetX": 0,
"offsetY": 0,
"isBorderRequired": "N",
"isLogoRequired": "N",
"isBarcodeControlRowRequired": "N"
}
}
//OUTPUT Body
//
{"createResponse": {
"currentTimeUTC": "2020-06-17-14.10.32.726000+02:00",
"executionMessage": {
"code": 0,
"severity": "INFO",
"codeDesc": "SHIPMENT DATA RECEIVED",
"message": "BRT has received shipment information properly"
},
"arrivalTerminal": "099",
"arrivalDepot": "099",
"deliveryZone": "72",
"parcelNumberFrom": "0321962",
"parcelNumberTo": "0321962",
"departureDepot": 102,
"seriesNumber": 4,
"serviceType": "C",
"consigneeCompanyName": "TEST UFFICIO VAS",
"consigneeAddress": "VIA DEL PODERE FIUME 55",
"consigneeZIPCode": "55047",
"consigneeCity": "QUERCETA",
"consigneeProvinceAbbreviation": "LU",
"consigneeCountryAbbreviationBRT": "",
"numberOfParcels": 1,
"weightKG": 81,
"volumeM3": 0.451,
"alphanumericSenderReference": "AAA1",
"senderCompanyName": "BRT TEST 0",
"senderProvinceAbbreviation": "BO",
"labels": {"label": [ {
"dataLength": 1196,
"parcelID": "102099040321962724",
"stream": "XlhBDV5MSDExMCwyMA1eUE9JDV5QUkNeRlMNXkZPMDYwLDAwMF5HQjEzMCwxMjAsMDAzXkZTDV5GTzA3MCwwMTBeQTBOLDEzNSw3Ml5GUl5GRE85OV5GUw1eRk8yMDUsMDMwXkEwTiwwOTAsNDheRkRPOTleRlMNXkZPNTQxLDAwMF5HQjA4OCwxMTAsMDNeRlMNXkZPNTQ4LDAxMF5BME4sMTI1LDc1XkZSXkZENzJeRlMNXkZPMDAwLDMyMF5BQ04sNTQsMjBeRkQxMDJeRlMNXkZPMTEwLDEzMF5HQk80MDIsMDA1LDAwNV5GUw1eQlkzLDMsMF5GUw1eRk8xMTAsMTMwXkJDTiwyMDAsTixOLE5eRkQ+OzEwMjA5OTA0MDMyMTk2MjcyNF5GUw1eRk8xMTAsMzMwXkdCTzQwMiwwMDUsMDA1XkZTDV5GTzAyMCwzNzBeQTBOLDA5MCw2MF5GRE80LV5GUw1eRk8xMzAsMzcwXkEwTiwwOTAsMDg0XkZETzMyMV5GUw1eRk8zMjAsMzQwXkEwTiwxNDUsMTA4XkZEOTYyXkZTDV5GTzAzMCw0NjBeQUNOLDE4LDEwXkZEUmlmLjogQUFBMV5GUw1eRk8zMzAsNDYwXkFDTiwxOCwxMF5GRDE3LzA2LzIwMjBeRlMNXkZPNDYwLDQ2MF5BQ04sMTgsMTBeRkReRlMNXkZPNTEwLDQ0NV5BQ04sMzYsMjBeRkReRlMNXkZUNTkyLDQ4MF5BMEIsMjUsMjJeRkReRlMNXkZUNTk1LDQ4MF5BMEIsMjUsMjJeR0IwLDM1MCwzXkZTDV5GVDYyNSw0ODBeQTBCLDI1LDIyXkZEVEVTVCBVRkZJQ0lPIFZBUyAgICAgICAgICAgTFVeRlMNXkZUNjU1LDQ4MF5BMEIsMjUsMjJeRkRWSUEgREVMIFBPREVSRSBGSVVNRSA1IFFVRVJDRVRBXkZTDV5GVDY5MCw0ODBeQTBCLDI1LDIxXkZETUMuIDAsNDUxXkZTDV5GVDY5MCwzMjBeQTBCLDI1LDIyXkZEICAgIDEtMV5GUw1eRlQ2OTAsMTYwXkEwQiwyNSwyMl5GREtHLiAgODEsMF5GUw1eRk8wMDAsMjQwXkdCMDY1LDA2NSwwM15GUw1eRk8wMjAsMjUwXkEwTiwwNjAsMDQ4XkZEQ15GUw1eWFoN"
}]},
"disclaimer": ""
}}
