WS307 - Finish AWB

WS307 - AWBs Finalization

This integration aims to allow the completion of AWBs. The route must be of the transshipment type.

Click here to see version history

Update date	Service publication date	Changes
02/09/2021	02/15/2021	Creation of the webservice

Warning

This is documentation of a beta service that is subject to field and url changes before its final publication.

Prerequisites

To use this service, a driver type user must be pre-registered on the platform. Your code should be awb. AWBs cannot be repeated. If this code is not unique, there will be a risk that the registration will be incorrect if there are 2 identical AWBs registered in the system.

Authentication

Calls will have transport-level authentication (Basic Authentication); Request the username/password from the account administrator.

Features

• URL

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

• Method:

PATCH

Warning

This integration returns a protocol for monitoring - WS301

Parameters

Example

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

AWBs

Parameter	Type	Description
AWBs	JSON Array	Set of JSON. Must have at least one (1) JSON object with the fields from the AWB table (Required)

AWB

Parameter	Type	Description
awb	Alphanumeric	AWB number (required)
awb_user	Alphanumeric	User has proven responsible for transportation (Optional)
awb_date	Date	AWB Date (Optional)
occurrence_date	Date and time	Date and time of the start of the occurrence (required)

Warning

All optional fields will be validated if sent, that is, they cannot be blank, if you do not wish to send the information, do not add the fields.

• Success:

  • Code: 202
    Content:

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

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

• Error:

  • Code: 400
    Content:

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

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