API docs by Redocly

Supply Tracking API (v1)

Download OpenAPI specification:

License: MIT

Documentation about the endpoints of Supply Tracking API. Supply Tracking API is responsible for get all the trackings information from the mains transportation company that Arco work with.

trackings

Everything about your Trackings

Find out more

Receive tracking events (Lambda)

Endpoint for carriers to POST tracking events protected by Lambda authorizer.

Authorizations:
lambda_authorizer
Request Body schema: application/json
required
data_geracao_evento
required
string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d...

Event generation date

transportadora
string

Carrier's name

cnpj_transportadora
required
string

Carrier's CNPJ

nota_fiscal
required
string

Invoice number

emissao_conhecimento
required
string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d...

Date of issue of the bill of lading

required
object

Sender information

previsao_de_entrega
required
string or null^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d...

Estimated deliveryssss

data_de_entrega
required
string or null^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d...

Effective delivery date

status
required
string

Delivery status

codigo_status
required
string

Status code

required
Array of objects non-empty

Tracking's events list

Responses

Request samples

Content type
application/json
{
  • "data_geracao_evento": "2024-09-19T12:34:56Z",
  • "transportadora": "Gbex",
  • "cnpj_transportadora": "12345678901234",
  • "nota_fiscal": "123456",
  • "emissao_conhecimento": "2024-09-18T10:20:30Z",
  • "remetente": {
    },
  • "previsao_de_entrega": "2024-03-26T16:15:27Z",
  • "data_de_entrega": "2024-03-27T16:15:27Z",
  • "status": "ENTREGA REALIZADA NORMALMENTE",
  • "codigo_status": "1",
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Tracking event received successfully"
}