(Desenvolvimento) NuvemShop
Documentação e suporte
- https://www.climba.dev/documentacao-api-v1/
- Normalmente o Suporte com a NuvemShop via WhatsApp:
- +55 11 4020-7216
- Tem ambiente de homologação?
- Colocar a Url de teste
- Colocar o Token de teste
- Colocar site
- Colocar usuario
- Colocar senha
Autenticação
-
URL API: Informado pelo cliente através da Nuvem shop.
-
Token de acesso: Informado pelo cliente através da Nuvem Shop.
O que é sincronizado?
-
Envio de categorias (grupos ou catálogos);
-
Envio de itens;
-
Envio de itens com variação (agrupamento);
-
Busca de pedidos;
-
Busca de clientes.
Envio de categorias
| Resource | Método |
| categories | POST |
| categories/<Id da categoria na Climba> | PUT |
Regras para envio
-
-
Somente grupos ou catálogos Ativos.
-
Somente grupos ou catálogos com o campo "Exporta para Climba" 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 dos catálogos específicos inserindo id da categoria da Climba na coluna "Cód. E-commerce". (Deve ser solicitado para a Climba os IDs)
Dados enviados
|
Tags de envio |
O que será enviado |
|
id |
Id da categoria na Climba |
|
parentId |
Id do grupo ou catalogo pai no ERP |
|
name |
descrição do grupo ou catálogo |
|
order |
Classificacao do grupo ou catalogo |
|
description |
Null |
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 Climba | 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 simples
| Resource | Método |
| products | POST |
| products/<Id do item no ERP> | PUT |
Regras para envio
-
-
Somente itens com o campo "Exporta para Climba" marcado.
- Somente itens vinculados a marcas com o campo "Exporta para Climba" 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 Clima, se encontrar um <SKU> na climba com o mesmo <Id do item no ERP>, 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.
- Descrição, descrição técnica, observação ou complemento
- 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" .
- 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.
- Respeita o campo "Qt. Múltiplo" do cadastro do item.
-
Dados enviados
|
Tags de envio |
O que será enviado |
|
id |
Id do item no ERP |
|
status |
Status do item no ERP: 1-Atuvo/0-Inativo |
|
categories |
Id da climba vinculado ao grupo/catalogo do item |
|
brandId |
Id da climba vinculado a marca do item |
|
name |
Descrição, descrição técnica, observação ou complemento |
|
description |
Observação do item |
|
productVariants |
- |
|
sku |
Id do item ou referencia |
|
internalCode |
Id do item no ERP |
|
quantity |
Quantidade em estoque do item |
|
description |
Observação do item |
|
grossWeight |
Peso bruto do item |
|
netWeight |
Peso liquido do item |
|
height |
Altura do item |
|
width |
Largura do item |
|
length |
Comprimento do item |
| prices |
- |
| priceListId |
"1" |
| price |
Preço do item |
| priceFrom |
"0" |
| attributes |
- |
| id |
"1" |
| name |
"U" |
| attributeGroupId |
"1" |
| id |
"1" |
| name |
"U" |
| attributeGroupId |
"2" |
| barCode |
Código de barra 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 Climba | Id retornado | IntegracaoEcommerce_Item.IdItemEcommerce |
| Grava/atualiza no ERP a data da ultima sincronização do item | data e hora atual | IntegracaoEcommerce_Item.DataHoraUltimaSinc |
Envio das fotos do itens simples
| Resource | Método |
| products/<Id do item no ERP>/pictures | DELETE |
| products/<id do item do ERP>/pictures/base64 | POST |
Regras para envio
-
- Envia fotos de itens com o campo "Exporta para Climba" marcado e vinculados a uma marca também marcada para enviar.
- Parâmetro "Sincroniza fotos" marcado.
- Primeira sincronização de fotos do item ou alteração nas fotos do item (Data de atualização de fotos maior que a data da última sincronização das fotos).
- Deleta todas as fotos do item na Climba e envia todas as fotos do item no ERP.
|
Tags de envio |
O que será enviado |
| image | Foto do item em base64 |
| position | Id da foto do item no ERP |
Tratamento de Retorno
| Operação | Dado | Base de dados ERP |
| Grava/atualiza no ERP a data da ultima sincronização do item | data e hora atual | Item.DataHoraUltimaSincClimbaFoto |
Envio de itens com variação
| Resource | Método |
| products | POST |
| products/A<id do agrupamento no ERP> | PUT |
Regras para envio
-
-
Somente agrupamentos com o campo "Exporta para Climba" marcado.
- Somente itens do agrupamento com o campo "Exporta para Climba" 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 Climba, se encontrar um <SKU> na climba com o mesmo <"A"+Id do agrupamento no ERP>, são enviados os dados para atualização (PUT).
- Na Climba os agrupamento serão os produtos principais e os itens dos agrupamentos serão as variações.
- Atributos da variação são COR e TAMANHO.
-
Opções na Configuração
-
- Campo "Exporta itens agrupados" deve estar marcado.
-
Sku: o campo "SKU do produto" define se o SKU do item de variação será o iditem ou referencia.
- Preço: o campo "Utilizar" define qual o preço de cada item de variacao 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" .
- 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.
- Respeita o campo "Qt.Múltiplo" do cadastro do item.
Dados enviados
|
Tags de envio |
O que será enviado |
|
id |
"A" + Id do agrupamento no ERP |
|
status |
Status do agrupamento no ERP: 1-Atuvo/0-Inativo |
|
categories |
Id da climba vinculado ao grupo de um item do agrupamento |
|
brandId |
Id da climba vinculado a marca de um item do agrupamento |
|
name |
Descrição do agrupamento |
|
description |
Observação de um item do agrupamento |
|
productVariants |
<as tags abaixo serão enviadas pra cada item do agrupamento> |
|
sku |
Id do item ou referencia |
|
internalCode |
Id do item no ERP |
|
quantity |
Quantidade em estoque do item |
|
description |
Observação do item |
|
grossWeight |
Peso bruto do item |
|
netWeight |
Peso liquido do item |
|
height |
Altura do item |
|
width |
Largura do item |
|
length |
Comprimento do item |
| prices |
- |
| priceListId |
"1" |
| price |
Preço do item |
| priceFrom |
"0" |
| attributes |
- |
| id |
Id da cor do item |
| name |
Descrição da cor |
| attributeGroupId |
"1" |
| id |
Id do tamanho do item |
| name |
Descrição do tamanho |
| attributeGroupId |
"2" |
| barCode |
Código de barra 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 Climba | Id retornado | IntegracaoEcommerce_Item.IdItemEcommerce |
| Grava/atualiza no ERP a data da ultima sincronização do item | data e hora atual | IntegracaoEcommerce_Item.DataHoraUltimaSinc |
Envio das fotos do itens agrupados
| Resource | Método |
| products/<Id do item no ERP>/pictures | DELETE |
| products/<id do item do ERP>/pictures/base64 | POST |
Regras para envio
-
- Envia fotos de itens com o campo "Exporta para Climba" marcado e vinculados a uma marca também marcada para enviar.
- Parâmetro "Sincroniza fotos" marcado.
- Primeira sincronização de fotos do item ou alteração nas fotos do item (Data de atualização de fotos maior que a data da última sincronização das fotos).
- Deleta todas as fotos do item na Climba e envia todas as fotos do item no ERP.
|
Tags de envio |
O que será enviado |
| image | Foto do item em base64 |
| position | Id da foto do item no ERP |
Tratamento de Retorno
| Operação | Dado | Base de dados ERP |
| Grava/atualiza no ERP a data da ultima sincronização do item | data e hora atual | Item.DataHoraUltimaSincClimbaFoto |
Envio de variações
Cores
| Resource | Método |
| attributes | POST |
| attributes/1/<Id da cor no ERP> | PUT |
Regras para envio
-
- Somente cores Ativas.
- Somente cores com o campo "Exporta para Climba" marcado.
- Primeira sincronização ou alteração no cadastro da cor. (Data de atualização do cadastro da cor maior que a data da ultima sincronização da cor)
Dados enviados
|
Tag de envio |
O que será enviado |
|
id |
Id da cor no ERP |
|
name |
Descrição da cor |
|
attributeGroupId |
"1" |
Tratamento de Retorno
| Operação | Dado | Base de dados ERP |
| Grava/atualiza no ERP a data da ultima sincronização da Cor | data e hora atual |
Cor.DatahoraultimaSincClimba |
Tamanhos
| Resource | Método |
| attributes | POST |
| attributes/2/<Id do tamanho no ERP> | PUT |
Regras para envio
-
- Somente tamanhos Ativos.
- Somente tamanhos com o campo "Exporta para Climba" marcado.
- Primeira sincronização ou alteração no cadastro de tamanho. (Data de atualização do cadastro do tamanho maior que a data da ultima sincronização do tamanho)
Dados enviados
|
Tag de envio |
O que será enviado |
|
id |
Id do tamanho no ERP |
|
name |
Descrição do tamanho |
|
attributeGroupId |
"2" |
Tratamento de Retorno
| Operação | Dado | Base de dados ERP |
| Grava/atualiza no ERP a data da ultima sincronização do tamanho | data e hora atual |
Tamanho.DatahoraultimaSincClimba |
Busca de pedidos
Regras
-
- Busca somente pedidos em aberto na Climba. (status = 2)
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 dos metodos/condicoes e parcelas da Climba.
- Informar padrão.
- Se não tiver nenhum acima informado pega do cliente.
- Vendedor:
- Informa padrão.
- Se não tiver nenhum acima pega do cliente.
- Transportadora:
- Fazer De/para das transportadoras da Climba.
- Informa padrão.
- Transação:
Dados usados para criar o pedido
|
Tag de retorno |
Campo correspondente |
|
id |
Id do pedido pda |
|
id |
Numero do pedido |
|
customerComment |
Observação |
|
shippingAddress/state |
UF de destino |
|
name |
nome do cliente |
|
sourceId |
id marketplace |
|
totalValue |
Valor total do pedido |
|
totalValue |
Valor total dos itens |
|
discountValue |
Valor do desconto |
|
additionValue |
Valor do acréscimo |
|
shippingValue |
Valor do frete |
|
payment/id |
Id do método de pagto |
| payment/installmentQuantity |
Parcela do método |
| shipping/id |
Id da transportadora |
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 |
|
sequence |
sequencial do item no pedido |
pedido_item.sequencial |
|
sequence |
sequencial do item no pedido |
pedido_item.idpedidoitem |
|
id |
id do pedido na climba |
pedido_item.idpedidopda |
|
sku |
Sku do item na climba |
|
|
productId |
Id do item no ERP |
|
|
quantity |
Quantidade do item |
pedido_item.qt |
|
sellingPrice |
Valor unitario do item |
pedido_item.valor |
|
sellingPrice |
Valor de pauta |
pedido_item.valorpauta |
|
sellingPrice |
Valor sugerido |
pedido_item.valorsugerido |
|
quantity * sellingPrice |
Valor total do item |
pedido_item.valortotal |
|
discountValue |
Valor do desconto |
pedido_item.valordesconto |
|
discountValue/quantity * sellingPrice |
Percentual do desconto |
pedido_item.perc_desconto |
|
additionValue |
Valor de acrescimo |
pedido.valoracrescimo |
| additionValue/quantity * sellingPrice |
Percentual de acrescimo |
pedido_item.perc_acrescimo |
Cliente do pedido
Regras
-
- Insere novo cliente no ERP;
- Se existir cliente no ERP com o campo "Cód Climba" igual ao "id" retornado pela Climba, 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.
- Se não retornar tag IE, o IE e IM no ERP será "ISENTO".
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 Climba" |
Observação |
|
birthDate |
Data de nascimento |
|
id |
Id do cliente na Climba |
|
name |
Fantasia |
|
name |
Razão |
|
gender = "m" ou "f" |
Sexo |
|
|
|
|
|
e-mail NF-e |
|
documents/ type |
- |
|
type = "cpf" |
- |
|
number |
CPF |
|
type = "cnpj" |
- |
|
number |
CNPJ |
|
type = "ie" |
- |
|
number |
IE |
|
type = "rg" |
|
|
number |
RG |
|
phones |
|
|
type = "primary" |
|
|
number |
Fone |
|
type = "secundary" |
|
|
number |
Fone 2 |
|
type = "others" |
|
|
number |
Fax |
|
shippingAddress |
|
|
street |
Endereço |
|
streetNumber |
Número |
|
complement |
Complemento |
|
district |
Bairro |
|
state |
UF |
|
zipCode |
CEP |
|
city |
Nome da Cidade |