Brt Rest API Shipment
Brt Rest API Shipment / createResponse
In questo argomento
    createResponse
    In questo argomento
    Descrizione

    Se la chiamata ha esito positivo vengono ritornati i dati del calcolo instradamento e le eventuali etichette della spedizione se richieste

    Sommario
    createResponse

    Se la chiamata ha esito positivo vengono ritornati i dati del calcolo instradamento e le eventuali etichette della spedizione se richieste

    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.

    severity : string

    Vale:

    WARNING

    ERROR

    INFO

    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.

    Proprietà
    NomeDescrizioneData Type
    Data e ora in formato UTC con offset rispetto alla localizzazione del server di riposta.string
    Struttura contenente il messaggio di risposta.executionMessage

    Terminal di arrivo.

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    string

    Filiale di arrivo. [rif. BRT VABLNA]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    string

    Zona di consegna. [rif. BRT VABZNC]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    string

    Numero (segnacollo) assegnato al primo pacco della spedizione. [rif. BRT VABNCD]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    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.

    string

    Filiale di partenza. [rif. BRT VABLNP]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    number

    Numero serie assegnata al cliente. [rif. BRT VABNRS]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    number

    Tipo servizio. [rif. BRT VABTPS]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    string

    Ragione sociale destinatario. [rif. BRT VABRSD]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    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.

    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.

    string

    Località destinatario. [rif. BRT VABLOD]

    Il dato potrebbe essere stato normalizzato.

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    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.

    string

    Sigla BRT della nazione del destinatario. [rif. BRT VABNZD]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    string

    Numero di pacchi della spedizione. [rif. BRT VABNCL]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    number

    Peso totale della spedizione. [rif. BRT VABPKB]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    number

    Volume totale della spedizione. [rif. BRT VABVLB]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    number

    Riferimento mittente alfanumerico. [rif. BRT VABRMA]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    string

    Ragione sociale mittente. [rif. BRT VABRMO]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    string

    Sigla della provincia del mittente.  [rif. BRT VABNMO]

    Dato utile nel caso il cliente voglia costruirsi autonomamente l'etichetta.

    string
    Contiene le etichette e il relativo barcode BRT della spedizione.labels
    Sample Data
    {
      "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": ""
      }
    }
    Vedi Anche