← HomeFleetPay / API

Get a transport operation

Parameters, data structure and responses from the versioned contract.

GET/fiscal/ciot/{ciot_uuid}

consultarOperacaoCiotSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

The declared operation's state, without contacting the provider.

This is a read-only request: call it after a 202, or to retrieve an outcome you did not save. It also works for rejected operations — precisely the case in which a CIOT number never existed.

Authentication

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

ciot_uuidpath · stringRequired

The id returned by the declaration.

Constraints

{
  "type": "string",
  "format": "uuid"
}

Responses

200 HTTP Response

The operation.

`application/json`

RespostaCiot ↗

dataobjectRequired

OperacaoCiot ↗

environmentobjectRequired

Environment ↗

401 HTTP Response

Unauthenticated (autenticacao): missing, invalid or expired credentials, including an API key used in the wrong environment. A sandbox key is not valid in production, nor a production key in the sandbox; the error message indicates the expected environment.

`application/json`

Erro ↗

errorobjectOptional

403 HTTP Response

Scope not enabled for these credentials

`application/json`

Erro ↗

errorobjectOptional

404 HTTP Response

ciot_nao_encontrado — no operation with this ID exists in this company. An operation belonging to another tenant deliberately returns the same response.

`application/json`

Erro ↗

errorobjectOptional

Complete Operation Definition

{
  "tags": [
    "CIOT"
  ],
  "summary": "Consultar uma operação de transporte",
  "operationId": "consultarOperacaoCiot",
  "description": "O estado da operação declarada, **sem** falar com o provedor.\n\nÉ leitura pura: é o que você chama depois de um `202`, ou para reler um desfecho que\nnão guardou. Funciona inclusive para operações recusadas — que é justamente o caso em\nque o número do CIOT nunca existiu.\n",
  "parameters": [
    {
      "name": "ciot_uuid",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "O `id` devolvido pela declaração."
    }
  ],
  "responses": {
    "200": {
      "description": "A operação.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaCiot"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "404": {
      "description": "`ciot_nao_encontrado` — não existe operação com esse id **nesta empresa**. Operação\nde outro tenant responde igual, de propósito.\n",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    }
  },
  "method": "GET",
  "path": "/fiscal/ciot/{ciot_uuid}"
}