Help Roi Commerce

PRODUTO – API ROI COMMERCE

Nesse artigo, você terá informações sobre os recursos da API para tratamento de produto.

Ednpoint: /api/produto

Padrões

Para incluir um produto simples ou variação, deve-se seguir um padrão, o qual é aplicado para os produtos cadastrados manualmente no sistema.

Produto Simples

Enviar a tag ‘formato’ = ‘S’ e não enviar ou deixar em branco as tags ‘codigo_variacao’ e ‘fk_variacao_id’. Assim o sistema entenderá que trata-se de um produto SIMPLES

Produto Variação

Primeiramente, será necessário cadastrar o produto PAI. Para isso, envie a tag ‘formato’ = ‘V’, informe a tag ‘codigo’ e não envie ou deixe em branco as tags ‘codigo_variacao’ e ‘fk_variacao_id’. Assim o sistema entenderá que trata-se de um produto PAI VARIAÇÃO

Para cadastrar os produtos filhos, envie a tag ‘formato’ = ‘V’, informe a tag ‘codigo’ e preencha as tags ‘codigo_variacao’ e ‘fk_variacao_id’. Assim o sistema entenderá que trata-se de um produto FILHO VARIAÇÃO

Tabela de campos

Tabela de campos do PRODUTO

CAMPOINFORMAÇÃOTIPOOPCIONAL
codigoCódigo do produto
STRING(20)Obrigatório
codigo_variacaoCódigo do produto
variacao
STRING(20)Opcional -> SIMPLES
Obrigatório->FILHO
VARIAÇÃO
formatoFormato do produtoSTRING(1)Obrigatório
fk_variacao_idID da Variação que
será associada ao
produto filho
INTEGER(11)Opcional -> SIMPLES
Obrigatório->FILHO
VARIAÇÃO
tipoTipo de produtoSTRING(5)Opcional
descricaoNome do produtoSTRING(200)Obrigatório
alturaAltura do produto
em centímetros
DECIMAL(10,2)Opcional
larguraLargura do produto
em centímetros
DECIMAL(10,2)Opcional
comprimentoComprimento do
produto em
centímetros
DECIMAL(10,2)Opcional
peso_liquidoPeso líquido do
produto em kilos
DECIMAL(10,2)Opcional
sku_fornecedorReferencia do
produto no fornecedor
STRING(15)Opcional
codigo_barrasGTIN / EAN do produtoSTRING(20)Opcional
peso_brutoPeso bruto do
produto em kilos
DECIMAL(10,2)Opcional
preco_custoPreço de custo
do produto
DECIMAL(10,2)Opcional
ncmNCM do produtoSTRING(10)Opcional
prazo_cross_dockingPrazo de manuseio
do produto
INTEGER(3)Opcional
preco_vendaPreço de Venda
do produto
DECIMAL(10,2)Opcional
preco_venda_
promocional
Preço de Venda
Promocional
do produto
DECIMAL(10,2)Opcional
preco_adc_integraValor a ser observado
na integração Magalu
STRING(20)Opcional
preco_adc_skyhubValor a ser observado
na integração B2W
STRING(20)Opcional
preco_adc_via_varejoValor a ser observado
na integração
Via Varejo
STRING(20)Opcional
preco_adc_amazonValor a ser observado
na integração Amazon
STRING(20)Opcional
preco_adc_madeira_
madeira
Valor a ser observado
na integração Madeira
STRING(20)Opcional
preco_adc_carrefourValor a ser observado
na integração Carrefour
STRING(20)Opcional
preco_adc_dafitiValor a ser observado
na integração Dafiti
STRING(20)Opcional
preco_adc_leroyValor a ser observado
na integração Leroy
STRING(20)Opcional
preco_adc_opencartValor a ser observado
na integração
Opencart ROI
COMMERCE
STRING(20)Opcional
prazo_garantiaPrazo de garantia
do produto em
meses
INTEGER(5)Opcional
msg_garantiaMensagem de garantia STRING(100)Opcional
produto_bloqueadoStatus do produtoINTEGER(1)Opcional
fk_marca_idID da marca do
produto
INTEGER(11)Obrigatório
seo_urlURL encurtada
do produto
STRING(300)Opcional
descricao_comple
mentar_texto
Descrição detalhada
do produto
STRING(4000)Opcional
meta_tituloMeta título do
produto
STRING(200)Opcional
meta_descricaoMeta descrição
do produto
STRING(320)Opcional
tagsTags do produtoSTRING(300)Opcional
kitSe é Kit ou Não.
0 – NÃO ou 1 – SIM
INTEGER(1)Opcional
minimo_vendaQuantidade mínima
para fechar pedido
(OPENCART)
INTEGER(11)Opcional
atributosAtributos do produtoSTRINGOpcional
categoriasCategorias do produtoSTRINGOpcional
imagensImagens do produtoSTRINGOpcional

Observações sobre os campos:

imagens: Informar o nome do arquivo das imagens que serão utilizadas no sistema separadas por vírgula (,).
Ex.: imagem1.jpg, imagem2.jpg, imagem3.jpg
Não utilizar caracteres especiais no mome das fotos. Enviar sempre arquivos .jpg

categorias: Informar o id de todas as categorias que seão vinculadas ao produto separadas por vírgula (,).
Ex.: 25654,2644,264,262
Para acessar o id das categorias, basta acessar Menu->Gestão de Produtos->Categorias

atributos: Informar o id do atributo e o valor que representará esse atributo. Para separar o id do valor, utilizar dois pontos (:) e para separar um grupo de atributos (id:valor) do outro, utilizar vírgula (,).
Ex: 245:VERDE,5446:INOX, 545:ELÉTRICO

tags: Informar as tags que serão associadas ao produto separadas por vírgula:
Ex.: azul,inox,eletrico

fk_marca_id: ID da marca que será associada ao produto. Inserir apenas 1 ID.

fk_variacao_id: ID da variação que será associada ao produto filho. Inserir apenas 1 ID.

descricao_complementar_texto: Para enviar a descrição detalhada do produto, enviar uma string sem quebra de linhas. Caso necessite formatar o texto com quebras de linhas, utilizar somente a tag <br />. Todas as outras tags enviadas serão removidas.

preco_adc_…: Essas tags são utilizadas para ativar o recurso de precificação dinâmica do ROI COMMERCE. O valor informado nessas tags serão levado em consideração ao enviar preço para cada integração. Para conhecer mais sobre o recurso, acessar o link abaixo:

https://help.roicommerce.com.br/index.php/2021/07/05/precificacao-dinamica-roi-commerce/

Enviar uma string com o valor. Pode ser adicionado ao valor o sinal de negativo (-) que irá deduzir do valor padrão do produto e/ou o sinal de percentual (%) que irá aplicar um percentual ao valor do produto.

Ex.: “-20.65%” -> Será deduzido 20,65% do valor do produto ao passar para integração.
“20.65” -> Será adicionado 20,65 reais ao valor do produto ao passar para integração.

Documentação completa dos recursos da API ROI COMMERCE

https://app.swaggerhub.com/apis-docs/wjr-digital/roi-commerce/1.0.0


Adicionar comentário