API de integração e-commerce
A API liga uma plataforma de e-commerce ao ERP Objetiva. Por ela a loja lê o que o ERP mantém, como grupos, marcas, produtos com grades e cores, estoque, tabelas de preço, promoções e clientes, e envia os pedidos fechados, que entram no ERP como pré-documentos prontos para faturar.
Toda chamada é feita em nome de uma credencial, e uma credencial vale para uma filial. É ela que define de qual filial vêm os dados e em qual filial o pedido entra; nenhum endpoint recebe filial como parâmetro.
Por onde começar
- Primeiros passos: credencial, ambiente e a primeira chamada.
- Convenções: o envelope de resposta, paginação, filtros e enums, que valem para tudo.
- Sincronizar o catálogo e Enviar um pedido: os dois fluxos de uma integração.
- Referência: cada endpoint com parâmetros, schema e exemplos.
O que esta documentação cobre
- Guias: o que nenhum endpoint explica sozinho. Convenções de resposta, paginação, limites, e os fluxos completos de sincronizar o catálogo e enviar um pedido.
- Referência: gerada a partir do contrato da API. O que está lá é o que o código faz, na versão indicada no topo da página.