WS307 - Finalizar AWB

WS307 - Finalização AWBs

Esta integração tem por objetivo permitir a finalização de AWBs. A rota tem que ser do tipo transbordo.

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.

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/finish>

• Método:

PATCH

Esta integração retorna um protocolo para acompanhamento - WS301

Parâmetros

Exemplo

{
    [{
        "AWB" : "XXXXX",
        "occurrence_date" : "2020-02-03 15:00:00"
    },
    {
        "AWB" : "XXXXX",
        "occurrence_date" : "2020-02-03 15:00:00"
    }]
}

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	Número do AWB (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 e hora do início da ocorrência (obrigatório)

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.

• Sucesso:

  • Código: 202
    Conteúdo:

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

    {
        "message" : "Alguns AWBs enviados apresentaram erros. Consulte o protocolo para detalhes",
        "protocol" : "<protocol>" 
    }
    

• Erro:

  • Código: 400
    Conteúdo:

    {
        "message": "Corpo da requisição está vazio"
    }
    

    {
        "message" : "Corpo da requisição não é um JSON válido" 
    }