A Interface de conexão da Neomode

A Neomode possui uma estrutura de APIS REST para parceiros. Este artigo traz algumas dicas e esclarecimentos de regras de negócio e responsabilidades para facilitar a implementação.

Documentação API Oficial

...

Arquivos para Download

Coleção do Postman + Environment

Como baixar e importar no Postman https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-and-exporting-overview/

• Collection (coleção) Download:

  View file
  name NEOMODE - Lori APIs.postman_collection.json

• Environment (variáveis de automação) Download:

  View file
  name LORI API-production.postman_environment.json

Atribuições de Integração: ERP vs Canal de Venda

É possível utilizar as API’s de gerenciamento da Neomode como um ERP ou um Canal de venda. Cada parte tem responsabilidades diferentes e isso reflete na utilização das rotas.

Responsabilidades conectando como um ERP

...

Ações em Catálogo

1. Cadastrar a árvore de categorias.

2. Cadastrar os produtos & skus.

3. Inserir preço nos produtos da loja.

4. Inserir estoque nos skus da loja.

Ações em Pedidos

1. Adquirir os novos pedidos.

2. Aprovar os novos pedidos.

3. Faturar os pedidos aprovados (inserindo os dados da nota fiscal).

4. Inserir os dados de transporte ou confirmar retirada dos pedidos faturados.

...

Responsabilidades conectando como um Canal de Venda

...

Ações em Pedidos

1. Criar pedido.

2. Aprovar pagamento.

3. Consumir dados de faturamento.

4. Consumir dados de entrega ou retirada do pedido.

Ações em Catálogo

1. Consumir árvore de categorias.

2. Consumir produtos & skus.

3. Consumir movimentações de estoque.

4. Consumir movimentações de preço.

...

Autenticação https://neomode.readme.io/reference/gerar-anonymous-token

A autenticação é feita via Bearer Token, que expira em 1 hora. É preciso gerar um novo a cada expiração.
Os dados necessários: clientId, clientSecret & scope serão disponibilizados pelo time de implantação.

...

--header 'Authorization: Bearer put_token_here' \

...

Estrutura de catálogo

Para entender como replicar um catálogo na Neomode, vamos dividir os elementos principais.

1. Categorias

2. Produtos (Agrupador)

3. Skus (Variações)

4. Preços

5. Saldos de estoque.

6. Loja(s)

...

1. Árvore de categorias

...

• A identificação de uma categoria PAI é a falta do parentId.

• A identificação de uma SUBcategoria é a presença do parentId.

  • Esta mesma SUBcategoria pode ser PAI de outra categoria através do parentId.

...

Vamos entender na prático com o pasos a passo.

Passo a passo: Como criar a árvore de categorias

[
  {
		"code": "11",
		"name": "Alimentos"
  }
]

[
    {
        "parentId": "e2690e5c-d54d-4aea-9c9f-d3fd89869ad2",
        "code": "21",
        "name": "Frutas"
    }
]

Consultando as categorias criadas

Endpoint: https://neomode.readme.io/reference/consultar-categorias

...

2. Produtos & Skus

...

1. Produto único ou com preço por única variação (ex: perfume, valor diferente por frasco)

2. Produto com grade com variação de cor ou tamanho.

Passo a passo: Como criar os produtos & skus

Expand
title Forma 1: Produto único ou preço por variação
Info Forma 1: Produto único ou preço por variação “Um produto para um sku” Criar 1 produto (https://neomode.readme.io/reference/create-product ) Criar 1 Sku a partir do Guid do produto (https://neomode.readme.io/reference/create-sku) Este cenário é utilizado para produtos que são tamanho único, não possuem grade ou não estão agrupados devidamente em sua grade. Também é utilizado para necessidade de Preço por variação ("ml" de frascos de perfumes por exemplo)

Expand
title Forma 2: Produto com grade ou preço tabelado
Info Forma 2: Produto com grade ou preço tabelado “Um produto para muitos skus” Criar 1 produto (https://neomode.readme.io/reference/create-product ) Criar os Skus a partir do Guid do produto (https://neomode.readme.io/reference/create-sku) Este cenário é utilizado para produtos que tem variação de tamanho ou cor (ou ambos) e são agrupados a um produto pai (ou código agrupador).

...

Ambiente Multi-loja

Nesse cenário, cada NeoProductPrice ou NeoSkuStock precisa ser relacionado a uma única loja ( ao NeoSeller). 

Gerenciamento de seller via API

• Consultando a lista de sellers: https://neomode.readme.io/reference/get-sellers-list

• Criando um novo seller: https://neomode.readme.io/reference/post-create-seller

• Editando um seller existente: https://neomode.readme.io/reference/put-update-seller

Estrutura dos pedidos

...

1. Criação do pedido pelo canal de venda.

2. Reserva pelo ERP. (opcional)

3. Aprovação do pagamento pelo canal de venda.

4. Confirmação do pedido pelo ERP. (obrigatória)

5. Faturamento do pedido pelo ERP.

6. Dados de transporte preenchidos pelo ERP.

7. Consumo das atualizações pelo canal de venda.

8. Finalização do pedido.

...

...

Implementando um fluxo de pedido Neomode via API como um ERP

Este modelo utiliza a API de pedidos v1 da Neomode.

...

Status de pedidos na API:

1. Buscar um pedido na Lori

Um pedido está pronto para coleta do ERP quando estiver no status