Tracking API

Endpoint

POST /v1/tracking/events

QA — supply-api-gw.qa.arcocv.co STAGE — supply-api-gw.stage.arcocv.co PROD — tracking.arcoeducacao.com.br

Authentication

🔑 API Key required Send your key via header: Authorization: Bearer <api_key>

Request Body application/json

All datetime fields must be ISO 8601 with an explicit timezone: UTC suffix Z (e.g. 2024-09-19T15:34:56Z) or offset ±HH:MM (e.g. 2024-09-19T12:34:56-03:00). Values without Z or offset are rejected by the API.

Field	Type	Description
data_geracao_eventorequired	string	Event generation datetime in ISO 8601 format (must include `Z` or offset). e.g. `2024-09-19T12:34:56-03:00`
transportadora	string	Carrier's trade name. Optional but recommended. e.g. `Gbex`
cnpj_transportadorarequired	string	Carrier's CNPJ (14 digits, numbers only). e.g. `12345678901234`
nota_fiscalrequired	string	Invoice (Nota Fiscal) number related to the shipment. e.g. `123456`
emissao_conhecimentorequired	string	Issue date of the bill of lading (Conhecimento de Transporte), in ISO 8601 (must include `Z` or offset). e.g. `2024-09-18T10:20:30-03:00`
remetenterequired	object	Sender information. See nested fields below.
↳ remetente fields
nomerequired	string	Sender's name. e.g. `SAE`
cnpjrequired	string	Sender's CNPJ (14 digits). e.g. `98765432000100`
previsao_de_entrega	string \| null	Estimated delivery datetime in ISO 8601 (must include `Z` or offset). Omit the field or send `null` if not available. e.g. `2024-03-26T16:15:27-03:00`
data_de_entrega	string \| null	Effective delivery datetime in ISO 8601 (must include `Z` or offset) when the delivery is completed. If there is no delivery yet, send `null` or omit this field — both are accepted. e.g. `2024-03-27T16:15:27-03:00`
statusrequired	string	Human-readable delivery status description. e.g. `ENTREGA REALIZADA NORMALMENTE`
codigo_statusrequired	string	Carrier's internal status code. e.g. `1`
eventsrequired	array of objects	List of all tracking events for this shipment. See nested fields below.
↳ events[ ] fields
data_horarequired	string	Datetime of the event in ISO 8601 (must include `Z` or offset). e.g. `2024-03-20T17:38:36-03:00`
codigorequired	string	Carrier's internal event code. e.g. `40`
descricao_codigorequired	string	Short label for the event code. e.g. `EM ROTA`
descricaorequired	string	Full human-readable description of the event. e.g. `Mercadoria saiu para entrega - Placa CLF9G72`

Request Example

{
  "data_geracao_evento": "2024-09-19T12:34:56-03:00",
  "transportadora": "Gbex",
  "cnpj_transportadora": "12345678901234",
  "nota_fiscal": "123456",
  "emissao_conhecimento": "2024-09-18T10:20:30-03:00",
  "remetente": {
    "nome": "SAE",
    "cnpj": "98765432000100"
  },
  "previsao_de_entrega": "2024-03-26T16:15:27-03:00",
  "data_de_entrega": "2024-03-27T16:15:27-03:00",
  "status": "ENTREGA REALIZADA NORMALMENTE",
  "codigo_status": "1",
  "events": [
    {
      "data_hora": "2024-03-20T17:38:36-03:00",
      "codigo": "40",
      "descricao_codigo": "EM ROTA",
      "descricao": "Mercadoria saiu para entrega - Placa CLF9G72"
    },
    {
      "data_hora": "2024-03-26T16:15:27-03:00",
      "codigo": "1",
      "descricao_codigo": "ENTREGA REALIZADA NORMALMENTE",
      "descricao": "Entrega efetuada com sucesso"
    }
  ]
}

Responses

202

Accepted — Request received successfully and will be processed asynchronously.

401

Unauthorized — Missing or invalid API key.

422

Unprocessable Entity — One or more required fields are missing or have invalid values.

500

Internal Server Error — An unexpected error occurred on the server side.