Delete (Put)

Put

Delete

In questo argomento

Resource Path: /rest/v1/shipments/delete

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

Descrizione

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.

Request

The request body is of type deleteRequest.

Sommario

deleteRequest

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.

deleteData : deleteData

Dati relativi al destinatario della spedizione.

Dato obbligatorio.

senderCustomerCode : number

Codice cliente mittente. [rif. BRT VABCCM]

Dato obbligatorio.

Assieme a numericSenderReference e alphabeticSenderReference individua la spedizione da cancellare.

numericSenderReference : number

Riferimento numerico mittente. [rif. BRT VABRMN]

Dato obbligatorio.

Assieme a senderCustomerCode e alphabeticSenderReference individua la spedizione da cancellare.

alphanumericSenderReference : string

Riferimento alfanumerico mittente. [rif. BRT VABRMA]

Se specificato in fase di creazione, assieme a senderCustomerCode e numericSenderReference individua la spedizione da cancellare.

Sample Data

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

Response

The response body is of type deleteResult.

Successful operation

Sommario

deleteResult

deleteResponse : deleteResponse

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

Shipment API | Brt Rest API Shipment

Send comments on this topic.