Proteside Referência de endpointsRelatórios PCI
Agendar relatórios PCI recorrentes para uma loja
POST
Persistido em organizations.partner_settings.report_schedule[store_id]; o cron de relatórios o usa para definir a cadência e o idioma.
bearerAuthheader
AutorizaçãoBearer <token>Token de API criado em Configurações → API. Os escopos ficam vinculados ao token; cada operação lista o escopo exigido em x-scope.
org_id?stringSomente parceiros (orgs:manage): atua sobre esta organização filha. Também pode ser enviado como org_id em corpos JSON.
Formato
uuidIdempotency-Key?stringReproduz a resposta original por 24 h
Tamanho
1 <= length <= 255application/json- body
store_id*stringFormato
uuidcadence*stringValor em
"weekly""monthly"locale?stringPadrão
"pt-BR"Valor em
"pt-BR""en"active?booleanPadrão
trueAgendamento
application/json- response
store_id?stringFormato
uuidcadence?stringValor em
"weekly""monthly"locale?stringValor em
"pt-BR""en"active?booleanupdated_at?|Formato
date-timeupdated_by?string|nullcurl -X POST "https://example.com/reports/pci/schedule" \ -H "Content-Type: application/json" \ -d '{ "store_id": "0c1d2e3f-1111-4222-8333-444455556666", "cadence": "monthly", "locale": "pt-BR" }'{ "store_id": "0c1d2e3f-1111-4222-8333-444455556666", "cadence": "monthly", "locale": "pt-BR", "active": true, "updated_at": "2026-09-27T10:15:00.000Z", "updated_by": "api:ps_live_AbCdEfGhIjKlMnOpQrStUvWx"}