Skip to main content
A loja que já vende pela Onbeef tem produtos com foto e cortes, mas sem o código do seu PDV. Antes do primeiro envio, vincule o que já existe ou comece do zero.

Quando usar

Loja sem produtos vai direto para Sincronizar catálogo. Loja que já tem catálogo escolhe:
  • Vincular pelo código (recomendado). A loja preenche o Código de integração com PDV em cada produto e categoria. O envio atualiza o que tem código e cria o que falta. Fotos, cortes e nomes ficam.
  • Começar do zero. A loja exclui as categorias e o PDV envia tudo. Fotos e cortes são refeitos.

Como funciona

  1. A Onbeef procura o produto pelo Código de integração com PDV, comparado com o id ou itemId que você envia.
  2. A categoria é procurada pelo código dela, comparado com categories[].id.
  3. Achou: atualiza. Não achou: o MERCHANT cria outro, e ITEM e ITEM_OFFER falham.
O código é a única ligação: a Onbeef não compara nome, código de barras, código de balança nem o id (UUID) de GET /v1/merchant.

O que acontece sem vínculo

  • Produto e categoria sem código, MERCHANT: nasce outra categoria com o mesmo nome e outro produto dentro dela. Catálogo duplicado.
  • Produto com código em categoria sem código, MERCHANT: o produto recebe o preço e fica onde está. A categoria do PDV nasce sem ele: ele só entra na categoria enviada se já estiver em alguma com código.
  • Produto sem código, ITEM ou ITEM_OFFER: FAIL com “Itens não encontrados: …”.

Categorias da loja diferentes das do PDV

Decida com o lojista o que fazer com a categoria que não existe no PDV, como “Churrasco”:
  • Manter as categorias dela. O lojista põe o código da categoria do PDV na categoria da loja. “Churrasco” com o código 15 passa a ser a categoria 15, com o nome do painel.
  • Usar as categorias do PDV. As da loja ficam sem código. O envio cria as do PDV, e o lojista move os produtos.

Regras

  • Produto e categoria têm código próprio. Vincule os dois.
  • Um código, um lugar. O mesmo código não pode estar em dois produtos nem em duas categorias. O painel recusa: “Já existe outra categoria com o código de integração com PDV informado”. Exclua a categoria criada por um envio anterior e ponha o código na que a loja mantém.
  • O código é digitado no painel, com a lista que você passa. Não há preenchimento por API, e a importação de arquivo da tela Códigos & Balança preenche só o Código da balança.
  • externalCode não vincula. Ele é o código de balança.
  • Envie só o que a loja vende online. Tudo o que é novo no envio entra no catálogo.

Passo a passo

1

Entregue a lista de códigos ao lojista

Gere no PDV a lista com código e nome de cada produto e categoria: o valor de items[].id e de categories[].id.
2

O lojista preenche os códigos no painel

  • Produtos: no catálogo, botão Códigos & Balança, coluna Código de integração com PDV.
  • Categorias: na edição da categoria, em Vincular esta categoria ao seu sistema de PDV.
Envie ao lojista o passo a passo com as telas.
3

Confira o vínculo

Ambiente de teste
pdv_external_id: null é item sem código, como “Churrasco” e “Costela”. Compare os códigos com a lista do PDV antes de enviar.Compare também o unit. Se o painel vende por unidade e o PDV envia KG, o preço do quilo vira preço da unidade: deixe o produto fora do envio até os dois venderem do mesmo jeito.O código preenchido leva até 10 minutos para aparecer nesta consulta, mas o envio já usa assim que o lojista salva.
4

Faça a primeira carga

Envie em merchantStatus o status lido no passo anterior. A leitura pode estar até 10 minutos atrasada: evite a primeira carga logo depois de a loja abrir ou fechar.
  • Sem status nas ofertas e nas categorias. O que já existe fica como o lojista deixou, e o que é novo nasce ativo. Com "status": "AVAILABLE", todo produto desativado no painel voltaria a vender.
  • Produto que já existe: recebe o preço do PDV. Nome, fotos, cortes e tipo ficam. A descrição só é preenchida se estiver vazia.
  • onlyAddProducts: true: nada sai da loja. "LOJA-01" é o código da loja no seu PDV.
5

Confira o resultado

Espere o SUCCESS em GET /v1/merchantStatus e procure produto repetido ou categoria vazia.

Depois do vínculo

No dia a dia, siga Sincronizar catálogo, com dois cuidados:
  • ITEM sempre grava o name enviado. Para manter o nome do lojista, envie o nome lido em GET /v1/merchant.
  • Não use o envio completo. Ele remove o que tem código do PDV e não veio, e tira da categoria o produto com código que o lojista pôs nela pelo painel. Produto sem código fica onde está.

Começar do zero

  1. Combine com o lojista antes: fotos e cortes do painel se perdem.
  2. O lojista exclui as categorias. O produto que só estava nelas sai junto.
  3. Você envia o catálogo inteiro com MERCHANT, com o merchantStatus lido em GET /v1/merchant.

O que orientar o lojista

  • Não cadastrar pelo painel um produto que existe no PDV sem pôr o código: no próximo envio ele duplica.
  • Preço muda no PDV, e produto desativado no painel volta quando o PDV envia como disponível. Veja o que cada envio sobrescreve.
Catálogo já duplicou: o lojista exclui a categoria criada pelo envio (os produtos que só estavam nela saem junto) e preenche o código no que fica. Você envia de novo com onlyAddProducts: true.

Teste

No ambiente de teste (sandbox), desative um produto no painel, envie a primeira carga sem status e confira que ele continua desativado. Para ver a duplicação, envie um MERCHANT com o nome de um produto sem código.

Perguntas frequentes

O produto vendido não tem código do PDV, inclusive item dentro de kit. Peça ao lojista para preencher.

Sincronizar catálogo

O que enviar em cada situação.

Para o lojista: vincular produtos

O passo a passo das telas.