Guia
Convenções
Padrões adotados em toda a API. Conhecê-los acelera a integração e reduz erros.
Formato de dados
- Todas as requisições e respostas usam
application/jsoncodificado em UTF-8. - Nomes de campos seguem PascalCase (ex.:
ProductID,StatusID). - Coleções são retornadas como arrays de objetos envelope (ex.:
[{ "Product": { ... } }]).
IDs
- Identificadores são strings opacas. Não faça suposições sobre seu formato interno.
- Sempre trate IDs como case-sensitive.
Datas e horários
- Datas seguem
YYYY-MM-DD; data + hora seguem ISO-8601 (YYYY-MM-DDTHH:mm:ss). - Salvo indicação contrária, horários são tratados no fuso da loja (
America/Sao_Paulo).
Valores monetários
- Valores são números decimais com duas casas (ex.:
12.90). - Moeda padrão: BRL.
Versionamento
A versão atual é v3 e faz parte da URL base. Alterações incompatíveis serão lançadas em uma nova versão (v4, etc.) sem quebrar integrações existentes.
Limites e taxa
Há limites de requisições por janela de tempo. Ao ultrapassá-los você recebe 429 Too Many Requests. Implemente backoff exponencial em seus clientes.
