Desenvolvedores
API da Get Commerce para integrar a sua loja virtual.
Conecte ERP, marketplace, CRM ou qualquer sistema à loja pela API REST. Produtos, estoque, clientes, pedidos e categorias, com documentação completa e exemplos de requisição.
Como funciona
API REST, no endereço da própria loja.
Cada entidade tem o seu endpoint, as requisições usam os métodos HTTP padrão e as respostas vêm em JSON.
Endereço da loja
As requisições vão para o domínio da loja, no caminho /rest seguido da entidade, como sualoja.com.br/rest/{entidade}.
Métodos padrão
GET para listar com filtros, POST para criar, PUT para atualizar e DELETE para excluir pelo entity_id.
Token de acesso
Cada requisição leva um Bearer Token no header Authorization. Para usar, peça ao nosso suporte a ativação da API, e enviamos o token da loja.
Paginação
As listagens aceitam limit, de 1 a 100 itens, e page. A resposta traz a página atual e o total_pages.
As respostas vêm em JSON, com http_code, result e errors. Os códigos mais comuns são 200 para sucesso, 400 para requisição mal formada e 401 para token inválido.
O que dá para integrar
As entidades da API.
A versão atual é a 2.0. Nem todas as entidades têm todos os métodos, e a documentação mostra os campos de cada uma.
Produtos
Listar, criar, atualizar e excluir produtos. Estoque e atributos têm endpoints próprios, para atualizar só o que mudou.
Pedidos
Listar pedidos com filtros, consultar status, métodos de pagamento e de envio, e registrar comentários no pedido.
Clientes
Listar, criar, atualizar e excluir clientes, com grupos de clientes e endereços.
Categorias
Listar, criar, atualizar e excluir categorias da loja.
Carrinhos abandonados
Listar os carrinhos abandonados para ações de recuperação no CRM ou na automação de marketing.
Formulários
Listar os formulários da loja e as submissões recebidas.
Na prática
O que as lojas integram pela API.
- Sincronizar preço e estoque com o ERP
- Levar os pedidos para faturamento e expedição
- Cadastrar e atualizar o catálogo a partir de outro sistema
- Enviar clientes e carrinhos abandonados para o CRM
- Alimentar relatórios e painéis de BI
Outras formas de integração
A integração por FTP, com arquivos de preço, estoque e pedidos, e a API SOAP seguem disponíveis para quem já usa. Para projetos novos, use a API REST.
Perguntas frequentes
Sobre a API.
A Get Commerce tem API?
Sim. A plataforma tem uma API REST, na versão 2.0, para integrar produtos, estoque, clientes, pedidos, categorias, carrinhos abandonados e formulários com outros sistemas.
Onde fica a documentação da API?
A documentação completa, com os campos de cada entidade e exemplos de requisição, fica em getcommerce.readme.io.
Como ativar a API e conseguir o token?
A API é ativada pelo suporte da Get Commerce. Escreva para [email protected] informando a loja que vai ser integrada, e enviamos o token de acesso. Se você é desenvolvedor de um cliente, faça o pedido junto com o responsável pela loja.
A Get Commerce faz a integração por mim?
Sim. Integramos a loja com os principais sistemas de gestão e fazemos integrações sob medida. Veja a página de integrações ou fale com um especialista.
Precisa de uma integração sob medida?
Integramos a loja com o seu sistema de gestão e com outras ferramentas da operação. Conte para a gente o que você precisa.