← InícioFleetPay / API

Consultar fotos e comprovantes de entrega dos CT-e vinculados ao CIOT

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/fiscal/ciot/{ciot_uuid}/fotos
fotosOperacaoCiotBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Retorna todas as fotos e comprovantes de entrega capturados para os CT-e que compõem o CIOT (tanto CIOT central via pivô quanto CIOT ancorado 1:1). Cada foto inclui a sequencia e o cte_uuid. URLs assinadas com validade de 15 minutos.

Autenticação

Escopo Necessário
fiscal — Fiscal
Módulo
Fiscal, CT-e, MDF-e e CIOT
Perfis Aplicáveis
Gestor de Transporte · Agregado Empresarial · Transportador Frotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

ciot_uuidpath · stringObrigatório

UUID da operação de transporte.

Restrições
{
  "type": "string",
  "format": "uuid"
}
tipoquery · stringOpcional

Filtra as fotos por tipo:

  • P: Pacote
  • R: Recibo
  • C: Comprovante
  • O: Ocorrência
Restrições
{
  "type": "string",
  "enum": [
    "P",
    "R",
    "C",
    "O"
  ]
}

Respostas

200 Resposta HTTP

Lista de fotos e comprovantes dos CT-e da operação.

application/json

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

application/json

errorobjectOpcional
403 Resposta HTTP

Escopo não habilitado para esta credencial

application/json

errorobjectOpcional
404 Resposta HTTP

CIOT não encontrado (ciot_nao_encontrado).

application/json

errorobjectOpcional
422 Resposta HTTP

Parâmetro inválido (parametro_invalido).

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "tags": [
    "CIOT"
  ],
  "summary": "Consultar fotos e comprovantes de entrega dos CT-e vinculados ao CIOT",
  "operationId": "fotosOperacaoCiot",
  "description": "Retorna todas as fotos e comprovantes de entrega capturados para os CT-e que compõem o CIOT\n(tanto CIOT central via pivô quanto CIOT ancorado 1:1). Cada foto inclui a `sequencia`\ne o `cte_uuid`. URLs assinadas com validade de 15 minutos.\n",
  "parameters": [
    {
      "name": "ciot_uuid",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "UUID da operação de transporte."
    },
    {
      "name": "tipo",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "P",
          "R",
          "C",
          "O"
        ]
      },
      "description": "Filtra as fotos por tipo:\n- `P`: Pacote\n- `R`: Recibo\n- `C`: Comprovante\n- `O`: Ocorrência\n"
    }
  ],
  "responses": {
    "200": {
      "description": "Lista de fotos e comprovantes dos CT-e da operação.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/FotosCiotEnvelope"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "404": {
      "description": "CIOT não encontrado (`ciot_nao_encontrado`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "Parâmetro inválido (`parametro_invalido`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    }
  },
  "x-fleetpay-scope": "fiscal",
  "x-fleetpay-module": "fiscal-ciot",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/fiscal/ciot/{ciot_uuid}/fotos"
}