Documentação oficial das rotas: https://neomode.readme.io/reference/

Postman Collection & Environment

Como baixar, importar arquivos e utilizar o postman

• Collection, Download:

• Environment, Download:

Resumo

A Neomode possui uma estrutura de APIS REST para parceiros. Abaixo, deixamos algumas dicas para facilitar a implementação.

Conectar como ERP ou Canal de Venda?

É possível utilizar as API’s de gerenciamento da Neomode como um ERP ou um Canal de venda. Cada parte tem responsabilidade 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 a API 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 dem 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.

Com sucesso na resposta (200 OK):

{"access_token":"your_token_will_be_here","expires_in":3600,"token_type":"Bearer"}

O valor de "access_token" será usado no Header em todas as requisições, dessa forma:

--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

3. Skus

4. Preços

5. Saldo de estoque.

6. Loja(s)

1. Árvore de categorias

A Lori possui um sistema de categorias em níveios. É possível ter listas de categorias e essas categorias estarem vinculadas a outros níveis.

A categoria de nível superior é atrelada a categoria de nível inferior através de um campo identificador parentId na Categoria

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

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

Vamos entender na prática:

{
    "id": "00000000-0000-0000-0000-000000000000" <- Este é o campo identificador para os próximos níveis.
	"code": "11",
	"name": "Alimentos",
	"isActive": true,
	"children": [
		{
			"parentId": "00000000-0000-0000-0000-000000000000"
			"id": "11111111-1111-1111-1111-111111111111"
			"code": "21",
			"name": "Frutas",
			"isActive": true,
			"children": [
				{
					"parentId":""id": "11111111-1111-1111-1111-111111111111"
					"id": "00000000-0000-0000-0000-000000000000"
					"code": "31",
					"name": "Doces",
					"isActive": true
				},
				{
					"parentId":""id": "11111111-1111-1111-1111-111111111111"
					"id": "00000000-0000-0000-0000-000000000000"
					"code": "32",
					"name": "Amargas",
					"isActive": true
				}
			]
		}
	]
}

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

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

2. Produtos & Skus

Para construção do catálogo, existem duas formas de preenchimento dos produtos através do seguinte:

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

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

Passo a passo: Como criar os produtos & skus

 Forma 1: Produto único ou preço por variação

Forma 1: Produto único ou preço por variação

“Um produto para um sku”

1. Criar 1 produto (https://neomode.readme.io/reference/create-product )

2. 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) 

 Forma 2. Produto com grade ou preço tabelado

Forma 2: Produto com grade ou preço tabelado

“Um produto para muitos skus”

1. Criar 1 produto (https://neomode.readme.io/reference/create-product )

2. 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). 

Objeto para criação de seller

{
    "pointSaleId": "Identificador ÚNICO (pode usar o CNPJ se não houver um melhor) da loja - string - required",
    "whatsappPhoneNumber": "419999999999",
    "phoneNumber": "419999999999",
    "companyName": "string - required",
    "fullName": "string - required",
    "email": "emailnuncausadoantes@email.com",
    "password": "AtenderAosCritérios@!#123",
    "cnpj": "41231231231231",
    "currentCluster": null,
    "isEcommerce": false,
    "isActive": true
}

Estrutura dos pedidos

A estrutura de pedidos varia sendo ERP ou Canal de Venda. Durante a vida de um pedido nós podemos separar em fases.

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.

Identificadores do pedido