Brt Rest API Shipment
In questo argomento
    Brt Rest API Shipment
    In questo argomento

    Uri: https://api.brt.it/rest/v1/shipments

    Descrizione

    In questa pagina vengono riportate le specifiche tecniche dei servizi esposti da BRT

    Sicurezza Autenticazione

    Ad ogni cliente BRT, in fase di attivazione del servizio viene fornito un userID e password che devono essere sempre utilizzati come parametri di input dei servizi nel campo account

    Request Encoding

    Le chiamate al rest vanno effetuate con encoding UTF8

    Account Example
    Copy Code 
    "account": {
    "userID": "XXXXXX",
    "password": "******"
  }

    Esempi

    Scaricare il seguente file xml contenente un progetto SoapUi con alcuni esempi di invocazione ai vari servizi Rest.

    Brt Rest API Shipment
    PutConfirm
    Servizio necessario per confermare una spedizione precedentemente creata con il servizio Create (Post) non autocofermata.

    L'utilizzo di questa operazione è dedicato ai clienti che decidono di lavorare in modalità Conferma Esplicita delle spedizioni e tale decisione deve essere concordata in fase di attivazione con il personale BRT

    Se un cliente configurato in modalità AutoConfema invoca questa operazione, viene restituito il codice excecutionCode -101

    PostCreate

    Questo metodo genera una spedizione nel sistema BRT nella soluzione Disk B.

    Il servizio esegue le seguenti operazioni:

    1. Calcolo instradamento.       
    2. Stampa l'etichetta segnacolli nel formato richiesto(opzionale)       
    3. 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.

    PutDelete

    Questo servizio esegue la cancellazione di una spedizione precedente creata o confermata. Un spedizione è cancellabile, indipendetemente dalla modalità operativa AutoConferma/ConfermaEsplicita, fino a quando la spedizione viene presa in gestione dalla filiale BRT.

    PutRouting

    Calcolo delle coordinate instradamento BRT. Questo servizio rest NON è necessario per i clienti che decidono di utilizzare servizi Create e Confirm. Rappresenta un'alternativa per quei clienti che non vogliono implementare l'algoritmo del cappario BRT per produrre internamente le proprie etichette continuando ad affidarci i dati delle spedizioni nei modi tradizionali e NON utilizzare questi servizi rest

     

    Json Schemas
    deleteResponse 
    deleteData 
    deleteRequest 
    routingResponse

    In caso di elaborazione terminata con successo, il risultato conterrà alcuni dati delle richiesta "normalizzati", ovvero, corretti secondo gli standard BRT e campi necessari per l'instradamento di una spedizione in formato Disk B:

    • arrivalTerminal
    • arrivalDepot
    • deliveryZone

     

    routingDataDati relativi al destinatario della spedizione.
    routingRequestStruttura di input contenente i dati relativi al destinatario della spedizione.
    confirmResponseContiene il risultato della chiamata
    confirmData

    Dati relativi alla spedizione che si vuole confermare.

    L'auto conferma o conferma esplicita è un accordo con il cliente  stabilito in fase di attivazione. Vale per tutte le spedizioni di quel codice cliente.

    confirmRequestStruttura di input per la conferma di una spedizione già inviata a BRT.
    labelLa struttura contiene l'etichetta e il relativo barcode BRT del pacco.
    labelsContiene le etichette e i relativi barcode BRT della spedizione.
    executionMessage

    Elenco codici di errore che hanno bloccato la creazione della spedizione:

    • -1 = Errore generico
    • -5 = Parametro non valido
    • -7 = Login fallito
    • -57 = Parametro mancante per il login
    • -63 = Errore in calcolo instradamento
    • -64 = Errore in numerazione pacco
    • -65 = Errore in stampa etichetta
    • -67 = Errore su User/Account, il codice impostato come senderCostomerCode deve essere collegato a codice cliente utilizzato per l'autenticazione (account.userId)
    • -68 = Dato errato o inconsistente
      • controllare i messaggi di dettaglio che possono contenere il nome del dato in errore, ma anche il motivo della sua inconsistenza. Ad esempio:
        • GB Shipments: at least one of ConsigneeEMail or consigneeMobilePhoneNumber is mandatory
          • al momento in cui la Brexit sarà attiva, le spedizioni in Gran Bretagna dovranno avere o l'email o il numero di telefono mobile
        • Invalid Return Depot
          • In caso di reso, il deposito di reso indicato non esiste o il mittente non ne è abilitato
        • For shipments to Italy or with this network, The maximum length of ConsigneeAddress is 35 characters - The maximum length of ConsigneeAddress is 105 characters
          • La lunghezza di ConsigneeAddress è diversa a seconda se la spedizione è domestica o estera, e a seconda del network
        • deliveryDateRequired must be <= expiryDate
          • la data consegna richiesta deve essere minore o uguale alla data scadenza (si sta parlando di servizio Fresh)
    • -69 = pudoId non valido o non esistente
    • -70 = problemi in richiesta servizio Fresh, es.: expiryDate (data scadenza) non valida o brtServiceCode non consentito al cliente
    • -71 = Fallita generazione QR Code
    • -101 = Spedizione non confermabile
    • -102 = Spedizione già confermata
    • -151 = Spedizione mai creata oppure creata oltre 40 giorni prima
    • -152 = Spedizione già in presa in gestione dalla filiale
    • -153 = Spedizione in elaborazione, ritentare
    • -154 = Sono state trovate più spedizioni con gli stessi riferimenti
    • -155 = Record allocato in fase di cancellazione

    Elenco codici di warning che NON hanno bloccato la creazione della spedizione:

    • 4 = Normalizzazione CAP/Località/Provincia avvenuta
    • 5 = Indirizzo del destinatario modificato con l'indirizzo del pudo BRTfermopoint
    • 6 = Impostati i dati del destinatario con i dati del deposito di reso
    • 7 = Fallita generazione QR Code (per motivi tecnici la spedizione è stata creata ma non è stato restituito il QR Code)
    createResponse

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

    labelParametersParametri per la costruzione dell'etichetta da applicare al pacco. Indicare sempre questo dato anche se non richiesta l'etichetta.
    actualSender

    Dati del mittente reale della spedizione, da utilizzare nel caso in cui brtServiceCode assuma il valore B13 (Shop to Shop) e B14 (Shop to Home).

    Dato facoltativo.

    returnShipmentConsignee

    Dati del destinatario del reso della spedizione, da utilizzare nel caso in cui brtServiceCode assuma il valore B13 (Shop to Shop)  e B14 (Shop to Home). In caso assuma il valore B15 (Return from Shop) non è obbligatorio in quanto non è previsto di rendere al mittente reale.

    Dato facoltativo.  

    createDataDati relativi alla spedizione che si vuole richiedere.
    accountIndicare l'utente e la password fornite da BRT, per le quelli è stata richiesta la ablitazione al servizio web.
    createRequestStruttura di input per l'invio di una nuova spedizione a BRT.
    deleteResult 
    routingResultContiene la struttura di ritorno dati con HTTP code = 200
    confirmResultContiene la struttura di ritorno dati con HTTP code = 200
    createResultContiene la struttura di ritorno dati con HTTP code = 200

     

     

    BRT SpA © 2024 All Rights Reserved.

    Send comments on this topic.