Eventos em Lote

Consulta o status de um lote de eventos

Este endpoint retorna o status atual de um lote de eventos previamente submetido, incluindo o progresso do processamento e o resultado de cada item.

get/v1/event/batch/{id}

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/event/batch/{id}
  • Auth: none declared. Required headers: X-API-ID, X-API-KEY, X-Use-ApiGateway

Path parameters

idstring uuid required

Identificador único do lote de eventos (UUID). Exemplo: 3463ed52-f2ac-4eb0-8efa-47323a51dbdc

Headers

X-API-IDstring required

API ID usado para autenticação.

X-API-KEYstring required

API KEY usado para autenticação.

X-Use-ApiGatewaystring required

Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.

Response

Status do lote de eventos retornado com sucesso.

Example response

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "data": {
    "id": "903be0d9-97f0-4e3e-a19e-210cec23d173",
    "owner": "97548313000110",
    "tp_evento": "610110",
    "total_items": 10,
    "processed_items": 7,
    "status": "done",
    "items": [
      {
        "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "access_key": "35241297548313000110550010000123451234567890",
        "doc_type": "cte",
        "status": "done",
        "x_motivo": "Evento registrado e vinculado a CT-e",
        "c_stat": "135",
        "protocolo": "135240000012345",
        "n_seq_evento": "1"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.