Integração de produtos

Como consultar, criar, alterar e excluir produtos e suas variações via integração de API.

A integração de produtos permite que a loja adicione, exclua e consulte itens no catálogo via API. Para integrar os produtos da sua loja com seu ERP, você pode:

  • Consultar os produtos da loja: utilizando os métodos GET /api/v2/products/{id} e GET /api/v2/products ` para consultar todos os produtos ou um produto específico do catálogo da loja.
  • Criar novos produtos: utilizando o método POST /api/v2/products você cria novos produtos para o catálogo. Para utilizar a API de produtos e adicionar novos itens ao catálogo atente-se que:
    • Depois de criar um novo produto você deve criar também as variantes do mesmo, pois é a partir delas que os produtos terão características, disponibilidade em estoque e preço cadastrado. Saiba mais como manipular as variantes de ações em variantes que virá a seguir.
    • Durante a criação de um produto não há agrupadores, como por exemplo categoria ou marca. A plataforma Vnda utiliza a funcionalidade de tags, e durante a criação do produto você pode utilizar o campo tag_list para vincular um produto em tags que devem ser criadas previamente. Saiba mais em Integração de tags (categorias).
  • Atualizar produtos: utilizando o método PATCH /api/v2/products/{id}
  • Excluir produtos: utilizando o método DELETE /api/v2/products/{id}
  • Tratar as variantes de um produto: para adicionar, consultar e deletar o segundo nível de informações de um produto. Com as variantes você adiciona características como cor ou tamanho de um mesmo produto. Veja como manipular as variantes na tabela a seguir.
Ação Como fazer
Leitura de Variantes Utilize o método GET /api/v2/products/{product_id}/variants para consultar todas variantes de um produto, com a opção de refinar a busca por algum parâmetro desejado. É possível também buscar uma variante específica GET /api/v2/products/{product_id}/variants/{sku}.
Criação de Variantes Crie variantes através do método POST /api/v2/products/{product_id}/variants.
Atualização de Variantes A atualização de variantes pode ser feita através do método PATCH /api/v2/products/{product_id}/variants/{sku}.
Exclusão de Variantes A exclusão de variantes pode ser feita através de um DELETE /api/v2/products/{product_id}/variants/sku.

Nestes métodos o {id} é o código identificador retornado nas buscas ou na resposta do cadastro de produtos.


Did this page help you?