← HomeFleetPay / API

Query delivery photos and receipts for CT-es linked to the CIOT

Parameters, data structure and responses from the versioned contract.

GET/fiscal/ciot/{ciot_uuid}/fotos
fotosOperacaoCiotSandbox Base: https://api.fleetpay.site/v1

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

Returns all delivery photos and receipts captured for the CT-es belonging to the CIOT (both central pivot CIOT and 1:1 anchored CIOT). Each photo includes sequencia and cte_uuid. Signed URLs valid for 15 minutes.

Authentication

Required Scope
fiscal — Tax & Fiscal
Module
Tax, CT-e, MDF-e & CIOT
Target Profiles
Transport Manager · Dedicated Fleet Contractor · Fleet Carrier
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

ciot_uuidpath · stringRequired

Transport operation UUID.

Constraints
{
  "type": "string",
  "format": "uuid"
}
tipoquery · stringOptional

Filters photos by type:

  • P: Package
  • R: Receipt
  • C: Proof of delivery
  • O: Occurrence
Constraints
{
  "type": "string",
  "enum": [
    "P",
    "R",
    "C",
    "O"
  ]
}

Responses

200 HTTP Response

List of photos and receipts from the operation CT-es.

application/json

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

errorobjectOptional
403 HTTP Response

Scope not enabled for these credentials

application/json

errorobjectOptional
404 HTTP Response

CIOT not found (ciot_nao_encontrado).

application/json

errorobjectOptional
422 HTTP Response

Invalid parameter (parametro_invalido).

application/json

errorobjectOptional
Complete Operation Definition
{
  "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"
}