Brt Rest API Shipment
Brt Rest API Shipment / Shipment API / Confirm (Put)
In questo argomento
    PutConfirm
    In questo argomento

    Resource Path: /rest/v1/shipments/shipment

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

    Descrizione
    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

    Request

    The request body is of type confirmRequest.

    Sommario

    confirmRequest
    Struttura di input per la conferma di una spedizione già inviata 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.

    confirmData : confirmData

    Dati relativi alla spedizione che si vuole confermare.

    Dato obbligatorio.

    senderCustomerCode : number

    Codice cliente mittente. [rif. BRT VABCCM]

    Dato obbligatorio.

    Assieme a numericSenderReference e alphabeticSenderReference individua la spedizione da confermare.

    numericSenderReference : number

    Riferimento numerico mittente. [rif. BRT VABRMN]

    Dato obbligatorio.

    Assieme a senderCustomerCode e alphabeticSenderReference individua la spedizione da confermare.

    alphanumericSenderReference : string

    Riferimento alfanumerico mittente. [rif. BRT VABRMA]

    Dati obbligatori (lasciare la stringa vuota se non è stato passato un valore nella precedente chiamata di creazione).

    Assieme a senderCustomerCode e numericSenderReference individua la spedizione da confermare.

    cmrCode : string

    Codice CMR [rif. BRT VABCMR]

    Se indicato viene utilizzato come numero di CMR per l'accorpamento / conferma delle bolle

    Sample Data

    {
      "account": {
        "userID": 1020100,
        "password": "***"
      },
      "confirmData": {
        "senderCustomerCode": 1020100,
        "numericSenderReference": 55,
        "alphanumericSenderReference": "aaa"
      }
    }
    Response

    The response body is of type confirmResult.

    Successful operation

    Sommario

    confirmResult
    Contiene la struttura di ritorno dati con HTTP code = 200
    confirmResponse : confirmResponse
    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.
    Note
    L'invocazione del servizio deve essere eseguita dopo almeno 5 minuti dalla ricezione della response positiva del servizio create

     

    Vedi Anche