Ir para o conteúdo principal

(Desenvolvimento) Ideris

Documentação e suporte

  • https://apiv3.ideris.com.br/swagger/index.html
  • Normalmente o Suporte com a Ideris é via WhatsApp: 
    • +55 41 3405-4098
  • Tem ambiente de homologação?
    • Url: https://apiv3.ideris.com.br
    • Token: bhngohad6fbmsncvd8v4qacyd9g7w7qqatf4krhypfgiybwsddecix9wbrij6joju9ns32ozugxga93k5rw2shpk7yiwgrvr6eie
    • Loja: https://web.ideris.com.br/login
      • Usuário: jacke.venson@gmail.com
      • Senha: devideris123

Autenticação

  • URL API: Informado pelo cliente através da Ideris.

  • Token de acesso: Informado pelo cliente através da Ideris.

O que é sincronizado?

  • Envio de marcas;

  • Envio de departamentos (famílias);
  • Envio de NCM;

  • Envio de categorias (grupos ou catálogos);

  • Envio de itens (SKU);

  • Criação/Edição de modelo de anúncio por SKU;

  • Busca de pedidos;

  • Busca de clientes. 

  • Envio de nota fiscal de saída;
  • Atualização do status do pedido;

Envio de marcas

Resource Método
brand POST
brand PUT
Regras para envio

    • Somente marcas Ativas.

    • Somente marcas com o campo "Exporta para web" marcado.

    • Primeira sincronização ou alteração no cadastro da marca (Data de atualização do cadastro da marca for maior que a data da última sincronização da marca).

Opções na Configuração

    • Se o parâmetro "Exporta Marcas específicas" estiver marcado: 

      • Serão enviadas somente as marcas informadas na aba "Marcas". 

      • Permite fazer um De/Para das marcas específicas inserindo id da marca da Ideris na coluna "Cód. E-commerce". (Deve ser solicitado para a Ideris os IDs)

      • Antes de enviar uma marca nova, é realizada a busca pela descrição da marca na Ideris, se encontrar uma marca com a mesma descrição, são enviados os dados para atualização (PUT).
Dados enviados

Tag de envio

O que será enviado

id

Id da marca na Ideris

description 

Descrição da marca
Tratamento de retorno
Operação Dado Base de dados ERP
Tabela de controle   IntegracãoEcommerce_Marca
Grava no ERP o id da marca na Ideris Id retornado IntegracaoEcommerce_Marca.IdMarcaEcommerce
Grava/atualiza no ERP a data da ultima sincronização da marca data e hora atual IntegracaoEcommerce_Marca.DataHoraUltimaSinc

Envio de departamentos

Resource Método
department POST
department PUT
Regras para envio

    • Somente famílias Ativas.

    • Somente famílias com o campo "Exporta para web" marcado.

    • Primeira sincronização ou alteração no cadastro da família (Data de atualização do cadastro da família for maior que a data da última sincronização da família).

Opções na Configuração

    • Se o parâmetro "Exporta famílias específicas" estiver marcado: 

      • Serão enviadas somente as famílias informadas na aba "Famílias". 

      • Permite fazer um De/Para das famílias específicas inserindo id do departamento da Ideris na coluna "Cód. E-commerce". (Deve ser solicitado para a Ideris os IDs)

      • Antes de enviar uma familia nova, é realizada a busca pela descrição da família na Ideris, se encontrar um departamento com a mesma descrição, são enviados os dados para atualização (PUT).
Dados enviados

Tag de envio

O que será enviado

id

Id do departamento na Ideris

name 

Descrição da família no ERP
Tratamento de retorno
Operação Dado Base de dados ERP
Tabela de controle   IntegracãoEcommerce_Familia
Grava no ERP o id do departamento na Ideris Id retornado IntegracaoEcommerce_Familia.IdFamiliaEcommerce
Grava/atualiza no ERP a data da ultima sincronização da familia data e hora atual IntegracaoEcommerce_Familia.DataHoraUltimaSinc

Envio de NCM

Resource Método
ncm POST
ncm PUT
Regras para envio

    • Somente classificações fiscais Ativas.

    • Somente classificações fiscais com o campo "Exporta para web" marcado.

    • Primeira sincronização ou alteração no cadastro da classificação fiscal (Data de atualização do cadastro da classificação fiscal for maior que a data da última sincronização da classificação fiscal).

Opções na Configuração

    • Se o parâmetro "Exporta NCM's específicos" estiver marcado: 

      • Serão enviadas somente as classificações fiscais informadas na aba "NCM". 

      • Permite fazer um De/Para das classificações fiscais específicas inserindo id do NCM da Ideris na coluna "Cód. E-commerce". (Deve ser solicitado para a Ideris os IDs)

      • Antes de enviar um NCM novo, é realizada a busca pelo NCM na Ideris, se encontrar um NCM igual, são enviados os dados para atualização (PUT).
Dados enviados

Tag de envio

O que será enviado

id

Id do NCM na Ideris

name 

Descrição da classificação fiscal no ERP

code

Classificação fiscal no ERP
Tratamento de retorno
Operação Dado Base de dados ERP
Tabela de controle   IntegracãoEcommerce_NCM
Grava no ERP o id do NCN na Ideris Id retornado IntegracaoEcommerce_NCM.IdNCMEcommerce
Grava/atualiza no ERP a data da ultima sincronização do NCM data e hora atual IntegracaoEcommerce_NCM.DataHoraUltimaSinc

Envio de categorias

Resource Método
category POST
category PUT
Regras para envio

    • Somente grupos ou catálogos Ativos.

    • Somente grupos ou catálogos com o campo "Exporta terceiros" ou "Exporta para Ideris" marcado.

    • Primeira sincronização ou alteração no cadastro do grupo ou catálogo (Data de atualização do cadastro do grupo ou catálogo for maior que a data da última sincronização do grupos ou catálogos).

Opções na Configuração
    • O parâmetro "Tipo exportação categoria" decide se serão enviados os Grupos ou Catálogos do ERP.

    • Se o parâmetro "Exporta Grupos específicos" estiver marcado: 

      • Serão enviadas somente os grupos informados na aba "Grupos". 

    • Se o parâmetro "Exporta Catálogos específicos" estiver marcado: 

        • Serão enviadas somente os catálogos informados na aba "Catálogos". 

    • Permite fazer um De/Para de grupo ou catálogos específicos inserindo id da categoria da Ideris na coluna "Cód. E-commerce".  (Deve ser solicitado para a Ideris os IDs)

Dados enviados

Tags de envio

O que será enviado

id

Id da categoria na Climba

name

descrição do grupo ou catálogo

parentCategoryId

Id do grupo ou catalogo pai no ERP
Tratamento de Retorno
Operação Dado Base de dados ERP
Tabela de controle   IntegracaoEcommerce_Grupo/IntegracaoEcommerce_Catalogo
Grava no ERP o id da categoria na Ideris Id retornado IntegracaoEcommerce_Grupo.IdGrupoEcommerce/ IntegracaoEcommerce_Catalogo.IdCatalogoEcommerce
Grava/atualiza no ERP a data da ultima sincronização do grupo ou catálogo data e hora atual IntegracaoEcommerce_Grupo.DataHoraUltimaSinc/ IntegracaoEcommerce_Catalogo.DataHoraUltimaSinc

 

Envio de itens (SKU)

Resource Método
sku POST
sku PUT
Regras para envio
    • Somente itens ativos.

    • Somente itens com o campo "Exporta para terceiros" marcado.

    • Somente itens vinculados a marcas com o campo "Exporta para web" marcado.

    • Primeira sincronização ou, alteração no estoque do item ou, alteração no preço do item, ou qualquer alteração no cadastro do item (Data de atualização do cadastro do item for maior que a data da última sincronização do item).

    • Antes de enviar um item novo, é realizada a busca por esse item na Ideris, se encontrar um SKU na Ideris com o mesmo SKU que está sendo enviado, são enviados os dados para atualização (PUT).
Opções na Configuração

    • SKU: o campo "SKU do produto" define se o SKU será  o iditem ou referencia.

    • Nome: o campo "Descrição do item" define o campo do item que será enviado. "Não aplicavel na Ideris"
      • Descrição, descrição técnica, observação ou complemento: "Não aplicavel na Ideris"
    • Estoque: o campo "Depósito" indica os depósitos que serão somados para enviar a quantidade em estoque.
      • O campo "Abate quantidade reservada do saldo disponível", se marcado, será descontado o saldo já reservado no ERP.
      • O campo "% Envio estoque", indica o percentual do estoque que será enviado. "Não aplicavel na Ideris"
      • Respeita o campo "Qt. Múltiplo" do cadastro do item. "Não aplicavel na Ideris"
Dados enviados

Tags de envio

O que será enviado

id

Id do item na Ideris

sku

Id do item ou referencia no ERP

title

Descrição do item no ERP

type

"SIMPLES"

updateStockListings

"True"

updateStockKit

"True"

ean

Código de barras do item

ncmId

Id da Ideris vinculado ao NCM do item

originId

Origem do item

stocks

tag do estoque

  currentStock

Quantidade em estoque do item
Tratamento de Retorno
Operação Dado Base de dados ERP
Tabela de controle   IntegracaoEcommerce_Item
Grava no ERP o id do item na Ideris Id retornado IntegracaoEcommerce_Item.IdItemEcommerce
Grava/atualiza no ERP a data da ultima sincronização do item data e hora atual IntegracaoEcommerce_Item.DataHoraUltimaSinc

Criação\Edição de modelo de anúncio por SKU

Resource Método
ListingModel POST
ListingModel PUT
Regras para criação\edição
    • Mesma regra dos itens, pois esta rotina será executada exatamente após o retorno com sucesso do envio do item para a Ideris.
Opções na Configuração

    • SKU: o campo "SKU do produto" define se o SKU será  o iditem ou referencia.

    • Preço: o campo "Utilizar" define qual o preço que será enviado:
      • Preço de pauta da filial: deve ser informada a "Filial".
      • Tabela de preço específica: deve ser informada a Tabela de preço" .
Dados enviados

Tags de envio

O que será enviado

id

Id do modelo do anuncio do item na Ideris

title

Descrição do item no ERP

brandId

Id da Ideris vinculado a marca do item

categoryId

 Id da Ideris vinculado ao grupo ou catalogo do item

departmentId

Id da Ideris vinculado a familia do item

statusId

"1" - Ativo

type

"SIMPLES"

SKUId

Id do SKU inserido na Ideris

SKU

Id do item ou referencia no ERP

quantity

Quantidade em estoque do item

longDescription

Descrição técnica do item

weight

Peso líquido do item

length

Comprimento da embalagem do item

width

Largura da embalagem do item

height

Altura da embalagem do item

weightPackage

Peso bruto do item

lengthPackage

Comprimento da embalagem do item

widthPackage

Largura da embalagem do item

heightPackage

Altura da embalagem do item

cost

Valor do custo médio unitário do item

value

Preço do item

listingModelImage

Tag de imagens

  Base64

Imagens do item em base 64
Tratamento de Retorno
Operação Dado Base de dados ERP
Tabela de controle   IntegracaoEcommerce_Item
Grava no ERP o id do item na Ideris Id retornado IntegracaoEcommerce_Item.IdItemEcommerce
Grava/atualiza no ERP a data da ultima sincronização do item data e hora atual IntegracaoEcommerce_Item.DataHoraUltimaSinc
 

Busca de pedidos

Regras
    • Busca somente pedidos na Ideris com:
      • Status em aberto (statusid = 1007).
      • Pagamento aprovado na Ideris (payments = approved).
Opções na Configuração
    • Transação: 
      • Informado no cadastro de E-commerce conforme imagem Clique aqui!
    • Filial:
      • Informado no cadastro de Filial conforme imagem Clique aqui!
    • Responsável Notificação:
      • Informa usuário padrão que irá receber notificações dos pedidos criados no ERP.
    • Método e condições de pagamento:
      • Fazer De/para marcando o parâmetro "Informa Vendedor/Representante específico para cada marketplace" e inserindo o vendedor conforme marketplace igual a tag "originName" da Ideris;
      • Irá pegar metodos e condicoes do vendedor selecionado na aba "Vendedores" para o marketplace do pedido;
      • Se não tiver nenhum de/para pega do padrão.
      • Se não tiver nenhum acima informado pega do cliente.
    • Vendedor:
      • Fazer De/para marcando o parâmetro "Informa Vendedor/Representante específico para cada marketplace" e inserindo o vendedor conforme marketplace igual a tag "originName" da Ideris;
      • Irá pegar o vendedor selecionado na aba "Vendedores" para o marketplace do pedido;
      • Se não tiver nenhum de/para pega do padrão.
      • Se não tiver nenhum acima pega do cliente.
      • Tipo do vendedor será o tipo do vendedor do De/para, senão tiver de/para será o tipo 1.
    • Transportadora:
Dados usados para criar o pedido

Tag de retorno

Campo correspondente

id

Id do pedido pda

originName

nome do marketplace

totalAmount

Valor total do pedido

totalAmount

Valor total dos itens

discount

Valor do desconto

feeShipment

Valor do frete
feeShipment

Tarifa envio Ideris
feeOrder

Tarifa venda Ideris

Item do pedido

Regras
    • Somente Itens com SKU correspondente no ERP (iditem ou referencia).
Dados usados para criar os itens

Tag de retorno

Campo correspondente

Base de dados

id

id do pedido na Ideris

pedido_item.idpedidopda

codeProduct

 Sku do item na Ideris

iditem ou referencia

quantity

 Quantidade do item

pedido_item.qt

unitPrice

Valor unitario do item

pedido_item.valor

unitPrice

Valor de pauta

pedido_item.valorpauta

unitPrice

Valor sugerido

pedido_item.valorsugerido

quantity * unitPrice

Valor total do item

pedido_item.valortotal

discount

Valor do desconto  rateado nos itens

pedido_item.valordesconto

discount/quantity * unitPrice

Percentual do desconto

pedido_item.perc_desconto

Cliente do pedido

Regras 
    • Insere novo cliente no ERP;
    • Se existir cliente no ERP com o mesmo CPF ou CNPJ somente altera os dados.

    • Procura Cidade + UF sem acentos, se não achar, procura Cidade + UF igual o retorno, se não achar, cria uma nova cidade no ERP. 

Opções na Configuração
    • Tipo do cliente pode ser padronizado nas configurações pelo campo "Tipo Cliente".
Dados usados para criar o cliente

Tag de retorno

Campo correspondente

"Cadastrado via Ideris"

 Observação

documentType

 CPF ou CNPJ

ie

 "ISENTO"

im

 "ISENTO"

customerFirstName + customerLastName

 Fantasia

customerLastName

 Razão

customerEmail

 e-mail

customerEmail

 e-mail de nfe

phoneAreaCode + phoneNumber

 Fone

addressStreet

 Endereço

addressNumber

 Número

addressComment

 Complemento
districtName Bairro

stateAbbreviation

 UF

addressZipCode

 CEP

cityName

 Nome da Cidade

Envio de Nota fiscal

Resource Método
order/<id do pedido pda>/invoice POST
Regras 
    • Busca somente as notas fiscais de saída de pedidos sincronizados (origem = 3).
    • Somente Notas fiscais de saída finalizadas (status = 2).
Opções na Configuração
    • Permite fazer De/para do operador logístico da transportadora.
Dados enviados

Tag de envio

O que será enviado

orderId

Id do pedido na Ideris 

number

Número da Nota

key

Chave eletrônica da nota

serie

Série da nota

xml

XML da Nota - base 64

issueAt

Data de emissão da nota
statusId

"1021" - Nota autorizada
cfop

Envia código CFOP somente se o marketplace for "Shopee"
MoveToInTransit

"False"

Atualiza status do pedido na Ideris

Resource Método
order PUT
Regras 
    • Atualiza o status do pedido após o envio da nota fiscal na Ideris;
  •  
Dados enviados

Tag de envio

O que será enviado

orderId

Id do pedido na Ideris

statusId

1009 - Expedição

 

 



Voltar ao topo