WS303 - Início de AWB

WS303 - Início do AWB

Esta integração tem por objetivo abrir a solicitação de início de um awb no Comprovei.

Clique aqui para ver histórico de versões

Data de atualização	Data de publicação do serviço	Alterações
09/02/2021	15/02/2021	Criação do webservice

Aviso

Esta é uma documentação de um serviço beta que está sujeito a alterações de campos e urls antes de sua publicação definitiva.

Pré-requisitos

Para se usar este serviço um usuário do tipo motorista deve estar pré-cadastrado na plataforma. Seu código deve ser awb. Os AWBs não podem se repetir. Se esse código não for único, haverá o risco de que a baixa dê erro caso haja 2 AWBs iguais cadastrados no sistema. O número máximo permitido de awbs baixados por vez é 10.

Autenticação

• As chamadas terão autenticação a nível de transporte (Basic Authentication);
• Solicite o user / password ao administrador da conta.

Características

• URL

  <https://entregas-api.comprovei.com/v1/awbs/start>

• Método:

PATCH

Warning

Todos os campos opcionais serão validados caso sejam enviados, ou seja não podem estar em branco, caso não deseje enviar as informações, não acrescente os campos.

• Exemplo de Request:
  

{
     "awbs" : [{
      "occurrence_date" : "2020-11-12 00:00:00",
      "awb" : "XXXXXXX"
   },{
       "occurrence_date" : "2020-11-12 00:00:00",
       "awb" : "XXXXXXX"
   }]
}

AWBs

Parâmetro	Tipo	Descrição
AWBs	Array de JSON	Conjunto de JSON. Deve possuir pelo menos um (1) objeto do tipo JSON com os campos da tabela AWB (Obrigatório)

AWB

Parâmetro	Tipo	Descrição
awb	Alfanumérico	Nome dado ao AWB no Comprovei (obrigatório)
awb_user	Alfanumérico	Usuário comprovei responsável pelo transporte (Opcional)
awb_date	Data	Data do AWB (Opcional)
occurrence_date	Data e hora	Data de início da rota (obrigatório)
latitude	Numérico	Latitude da coordenada onde foi finalizada a rota (opcional)
longitude	Numérico	Longitude da coordenada onde foi finalizada a rota (opcional)
device_id	Alfanumérico	Id do aparelho usado pelo motorista durante a rota (opcional)
device_model	Alfanumérico	Modelo do aparelho usado pelo motorista durante a rota (opcional)

• Sucesso:

• Código: 202
  Conteúdo:

    {
      "message" : "OK",
      "protocol" : "<protocol>"
    }
  

    {
      "message" : "Algumas rotas enviadas apresentaram erros. Consulte o protocolo para detalhes",
      "protocol" : "<protocol>" 
    }
  

• Erro:

• Código: 401
  Conteúdo:

      "Unauthorized"