Central Fox Tecnologia LTDA Retail Sync API
The retail-sync API from Central Fox Tecnologia LTDA — 2 operation(s) for retail-sync.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/foxnfe-com-br:foxnfe-com-br-retail-sync-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: FOX NF-e Retail Sync API
version: '1.20260923'
description: Contrato derivado das rotas, regras Laravel e respostas estáticas. Condições de validação são descritas nos campos. x-source identifica a evidência. Valores dinâmicos sem tipo comprovado não recebem tipos inventados.
servers:
- url: https://www.foxnfe.com.br
tags:
- name: retail-sync
paths:
/api/v1/retail-sync/events:
post:
operationId: post_api_v1_retail_sync_events
tags:
- retail-sync
summary: RetailSync ingestEvent
x-source: app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:17
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- plan.limits
- throttle:60,60
- ability:nfes:emit
responses:
'201':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: integer
client_event_id:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:31
status:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:32
result:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:33
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
data:
id: 1
client_event_id: null
status: null
result: null
x-source:
- app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:29
'422':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: retail_sync_failed
message:
type: string
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: retail_sync_failed
message: EXEMPLO_FICTICIO
x-source:
- app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:36
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/post_api_v1_retail_sync_eventsRequest'
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
client_event_id: EXEMPLO_FICTICIO
event_type: EXEMPLO_FICTICIO
payload:
- null
/api/v1/retail-sync/manifest:
get:
operationId: get_api_v1_retail_sync_manifest
tags:
- retail-sync
summary: RetailSync manifest
x-source: app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:40
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- plan.limits
- ability:nfes:emit
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
data:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:45
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
data: null
x-source:
- app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:45
security:
- bearerAuth: []
components:
schemas:
post_api_v1_retail_sync_eventsRequest:
type: object
properties:
client_event_id:
x-laravel-rules:
- required
- string
- max:120
type: string
maxLength: 120
event_type:
x-laravel-rules:
- required
- string
- max:40
type: string
maxLength: 40
payload:
x-laravel-rules:
- required
- array
type:
- array
- object
items: {}
additionalProperties: true
required:
- client_event_id
- event_type
- payload
x-source:
- app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:19
securitySchemes:
bearerAuth:
type: http
scheme: bearer