Routing (Put)

Put

Routing

In questo argomento

Resource Path: /rest/v1/shipments/routing

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

Descrizione

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

Request

The request body is of type routingRequest.

Sommario

routingRequest

Struttura di input contenente i dati relativi al destinatario della spedizione.

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.

routingData : routingData

Dati relativi al destinatario della spedizione.

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

Filiale 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 e l'appartenenza al cliente.

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.

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.

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 obbligatorio.

consigneeZIPCode : string

CAP nel formato della nazione di destinazione. [rif. BRT VABCAD] [max length =9]

Dato obbligatorio.

Viene controllato che sia formalmente valido per la nazione indicata.

consigneeCity : string

Località di destinazione. [rif. BRT VABLOD] [max length =35]

Dato obbligatorio.

consigneeProvinceAbbreviation : string

Sigla della provincia di destinazione. [rif. BRT VABPRD] [max length =2]

Dato obbligatorio se la nazione è Italia.

Viene controllato che sia formalmente valido rispetto all'elenco sigle delle provincie italiane.

consigneeCountryAbbreviationISOAlpha2 : string

Sigla della nazione di destinazione. [rif. BRT VABNZD] [max length =2]

Dato obbligatorio.

Deve essere indicata l'abbreviazione ISO 3166-1 alpha-2.

serviceType : string

Tipo servizio. [rif. BRT VABTPS] [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

numberOfParcels : number

Numero dei pacchi della spedizione. [rif. BRT VABNCL] [precision =2 scale=0]

Dato obbligatorio.

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 =2 scale=3]

Dato facoltativo.

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.

Sample Data

{
  "account": {
    "userID": 1020100,
    "password": "brt1447st"
  },
  "routingData": {
    "network": "",
    "departureDepot": 102,
    "senderCustomerCode": 1020100,
    "deliveryFreightTypeCode": "DAP",
    "consigneeCompanyName": "Spedizione di prova CEDVAS",
    "consigneeAddress": "via montirone 37",
    "consigneeZIPCode": "40050",
    "consigneeCity": "MINERBIO                           ",
    "consigneeProvinceAbbreviation": "BO",
    "consigneeCountryAbbreviationISOAlpha2": "IT",
    "serviceType": "E",
    "numberOfParcels": 2,
    "weightKG": 1.0,
    "volumeM3": 0.0,
    "variousParticularitiesManagementCode": "",
    "particularDelivery1": "",
    "particularDelivery2": ""
  }
}

Response

The response body is of type routingResult.

Successful operation

Sommario

routingResult

Contiene la struttura di ritorno dati con HTTP code = 200

routingResponse : routingResponse

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.

arrivalDepot : string

Filiale di arrivo. [rif. BRT VABLNA]

deliveryZone : string

Zona di consegna. [rif. BRT VABZNC]

consigneeZIPCode : string

CAP nel formato della nazione di destinazione. [rif. BRT VABCAD]

Il dato potrebbe essere stato normalizzato.

consigneeCity : string

Località. [rif. BRT VABLOD]

Il dato potrebbe essere stato normalizzato.

consigneeProvinceAbbreviation : string

Sigla della provincia. [rif. BRT VABPRD]

Il dato potrebbe essere stato normalizzato.

Example

Esempio di calcolo di instramento di una spedizione utilizzando il cappario BRT

Json

// body request

{
        "account":  {
    "userID": 1020100,
    "password": "brt1447st"
      },
        "routingData": {
        "network": "",
        "departureDepot": 102,
    "senderCustomerCode": 1020100,
        "deliveryFreightTypeCode": "DAP",
        "consigneeCompanyName": "Spedizione di prova CEDVAS",
        "consigneeAddress": "via montirone 37",
 "consigneeZIPCode": "40050",
    "consigneeCity": "MINERBIO                           ",
    "consigneeProvinceAbbreviation": "BO",
        "consigneeCountryAbbreviationISOAlpha2": "IT",
        "serviceType": "E",
        "numberOfParcels": 2,
        "weightKG": 1.0,
        "volumeM3": 0.0,
        "variousParticularitiesManagementCode": "",
        "particularDelivery1": "",
        "particularDelivery2": ""
    }
}


// body response

{"routingResponse": {
   "currentTimeUTC": "2020-06-17-14.12.26.639000+02:00",
   "executionMessage":    {
      "code": 4,
      "severity": "WARNING",
      "codeDesc": "DATA NORMALIZATION DONE",
      "message": "BRT has modified Consignee City or ZIP code or Province Abbreviation"
   },
   "arrivalTerminal": "001",
   "arrivalDepot": "001",
   "deliveryZone": "10",
   "consigneeZIPCode": "40061",
   "consigneeCity": "MINERBIO",
   "consigneeProvinceAbbreviation": "BO"
}}

Note

Vedi Anche

Shipment API | Brt Rest API Shipment

Send comments on this topic.