Plataforma Inove Commerce

Pensando em você, desenvolvedor, construímos essa integração de serviços online com o foco em uma API simples para que você tenha o melhor processo de integração e comece a transacionar rapidamente.

Dentre suas funcionalidades destacam-se:

Gerenciamento de categorias
Gerenciamento de marcas
Gerenciamento de produtos
Gerenciamento de clientes
Gerenciamento de pedidos
Gerenciamento de variações
Gerenciamento de estoques

Comunicação/Autenticação

Nossa API está de cara nova, agora ela é RESTful!

Para acessar nossos endpoints é obrigatório o envio de suas credenciais (username e password) do cabeçalho (header) da requisição utilizando o formato Basic Auth. Além disso, é necessário inserir nos campos Content-type e Accept o texto application/json para especificar que o formato é JSON tanto para a requisição enviada quanto para a resposta recebida.

Authentication Basic base64(API_Login:API_Password)

Content-type: application/json

Accept: application/json

URL dos endpoints (Sandbox): https://sandbox.inovecommerce.com.br/api/v1

URL dos endpoints (Produção): https://app.inovecommerce.com.br/api/v1

Ambiente de teste

Para entrar no ambiente de teste, acesse o link sandbox.inovecommerce.com.br/register e cadastre-se na sandbox como um lojista. Após o fim do cadastro, a partir da barra de navegação superior, acesse Apps->Instalar e instale o primeiro App disponível para conseguir as credencias(API_Login e API_Password) a serem utilizadas nas requisições da sandbox.

Homologação

API logins e API passwords são fornecidas a clientes mediante pedidos em uma interface em nossa plataforma e cedida somente aos sistemas homologados.

Para homologar seu sistema em nossa plataforma mande um e-mail para [email protected] para agendarmos um horário para fazer e homologação. Mande no assunto do e- mail “HOMOLOGAÇÃO – nome da empresa”.

A Homologação é realizada via plataforma de bate-papo e via mensagens instantâneas, áudio e/ou vídeo e consiste em validar os métodos implementados.

Na data marcada para a homologação, será passado uma chave de API no qual simularemos um ambiente em produção, validando todos os dados enviados.

Importante

Recomenda-se em todas as requisições dos tipos POST e PUT o envio do campo CODE, para facilitar o gerenciamento dos elementos enviados pelo ERP e para facilitar a manutenção, visando possíveis mensagens de erro.

Nas requisições para PRODUTOS, o campo CODE é substítuido pelo campo SKU.

O upload das imagens não será feito no momento do envio da requisição, mas sim posteriomente, podendo levar até 2 horas para que elas estejam disponíveis na loja e na plataforma.

Para requisições que tenham sido processadas(integralmente ou parcialmente) pela nossa API, é retonado o código HTML 200/201. No caso de falha da requisição, retornamos o código HTML 400.

Categorias

POST Cadastrar nova categoria

Exemplo de cadasto de uma nova categoria

Atenção!Tenha certeza de enviar CODEs diferentes para categorias diferentes. Enviar um CODE de uma categoria já cadastrada somente a atualizará.

 {
	"categories": [
		{
			"code": "AABB",
			"name": "Categoria Teste",
			"parent": null,
			"image": null,
			"color": "#ED2222",
			"featured": true,
			"active": false,
			"seo": {
				"title": "Categoria Teste",
				"keywords": "categoria, teste",
				"description": "Categoria para teste."
			}
		}
	]
}

Parâmetros do corpo

[categories]	Requerido	array	Lista de categorias
categories[code]		string/integer	Código que representa a categoria no ERP
categories[name]	Requerido	string	Nome da categoria
categories[color]		string	Cor em hexadecimal que representa a categoria (Ex. #000000)
categories[parent]		string	Código que representa a categoria pai na plataforma Inove Commerce.
categories[image]		string	Banner da categoria.
categories[featured]		boolean	Valor que indica se a categoria é destaque
categories[active]		boolean	Valor que indica se a categoria está ativa
categories[seo[title]		string	Metatag "title" para ser usada no SEO
categories[seo[description]		string	Metatag "description" para ser usada no SEO
categories[seo[keywords]		string	Metatags "keywords" para ser usada no SEO. Deve ser enviadas separadas por vírgula.

Definição

/api/v1/categories

Resultado

 {
	"errorReport": null,
	"categories": [
		{
			"id": "5b97a631bd64a",
			"code": 534543,
			"name": "Categoria 2",
			"parent": {
				"id": null,
				"code": null
			},
			"image": null,
			"color": "#01FF03",
			"featured": true,
			"active": true,
			"seo": {
				"title": "Categoria 2",
				"keywords": "categoria, teste",
				"description": "Categoria para teste da API do sistema."
			}
		}
	]
}

 {
	"errorReport": [
		{
			"code": "FIELD_MISSING",
			"message": "Campo NAME ausente na categoria. (Código: 1)."
		},
		{
			"code": "FIELD_INVALID",
			"message": "Campo ACTIVE não segue o especificado na documentação(Código: 1)."
		}
	],
	"categories": [
	]
}

GET Buscar categoria

Exemplo de busca de uma categoria

Definição

/api/v1/categories/{id}

Resultado

 {
	"errorReport": null,
	"category": {
		"id": "5bef77",
		"code": "15",
		"name": "Categoria 1",
		"parent": {
			"id": null,
			"code": null
		},
		"image": null,
		"color": "#000000",
		"featured": false,
		"active": true,
		"seo": {
			"title": null,
			"keywords": null,
			"description": null
		}
	}
}

 {
	"errorReport": {
		"code": "CATEGORY_NOT_FOUND",
		"message": "Categoria não encontrada."
	},
	"category": null
}

GET Buscar lista de categorias

Exemplo de busca de uma lista de categorias

Definição

/api/v1/categories

Resultado

 {
	"errorReport": null,
	"categories": [
		{
			"id": "5b7c2f3b",
			"code": null,
			"name": "Categoria Teste",
			"parent": {
				"id": null,
				"code": null
			},
			"image": null,
			"color": "#000000",
			"featured": true,
			"active": true,
			"seo": {
				"title": null,
				"keywords": null,
				"description": null
			}
		}
	]
}

PUT Atualizar categoria

Exemplo de atualização de uma categoria

 {
	"category": {
		"code": 534543,
		"name": "Categoria 2",
		"parent": null,
		"image": null,
		"color": "#01FF03",
		"featured": true,
		"active": true,
		"seo": {
			"title": "Categoria 2",
			"keywords": "categoria, teste",
			"description": "Categoria para teste da API do sistema."
		}
	}
}

Parâmetros do corpo

category[code]		string/integer	Código que representa a categoria no ERP
category[name]	Requerido	string	Nome da categoria
categories[parent]		string	Código que representa a categoria pai na plataforma Inove Commerce.
categories[image]		string	Banner da categoria.
category[color]		string	Cor em hexadecimal que representa a categoria
category[featured]		boolean	Valor que indica se a categoria é destaque
category[active]		boolean	Valor que indica se a categoria está ativa
category[seo[title]		string	Metatag "title" para ser usada no SEO
category[seo[description]		string	Metatag "description" para ser usada no SEO
category[seo[keywords]		string	Metatags "keywords" para ser usada no SEO. Deve ser enviadas separadas por vírgula.

Definição

/api/v1/categories/{id}

Resultado

 {
	"errorReport": null,
	"category": {
		"id": "5bef77",
		"code": "15",
		"name": "Categoria 1",
		"parent": {
			"id": null,
			"code": null
		},
		"image": null,
		"color": "#000000",
		"featured": false,
		"active": true,
		"seo": {
			"title": null,
			"keywords": null,
			"description": null
		}
	}
}

 {
	"errorReport": {
		"code": "CATEGORY_NOT_FOUND",
		"message": "Categoria não encontrada."
	},
	"category": null
}

DELETE Deletar categoria

Exemplo de remoção de uma categoria

Atenção! Tome cuidado ao deletar uma categoria, pois os produtos nela cadastrados; se não estiverem em outras categorias, ficarão sem categorização na loja.

Atenção! Só é possivel deletar UMA categoria por vez.

Atenção! NÃO é possivel deletar categorias que tenham filhas. Recomendamos que mova as categorias filhas para outras categorias ou mesmo as delete antes de apagar a catergoria pai.

Definição

/api/v1/categories/{id}

Resultado

 {
	"errorReport": null,
	"category": {
		"id": "5bef77",
		"code": "15",
		"name": "Categoria 1",
		"parent": {
			"id": null,
			"code": null
		},
		"image": null,
		"color": "#000000",
		"featured": false,
		"active": true,
		"seo": {
			"title": null,
			"keywords": null,
			"description": null
		}
	}
}

 {
	"errorReport": {
		"code": "CATEGORY_NOT_FOUND",
		"message": "Categoria não encontrada."
	},
	"category": null
}

Marcas

POST Cadastrar marca

Exemplo de cadastro de uma marca

Atenção! Tenha certeza de enviar CODEs diferentes para marcas diferentes. Enviar um CODE de uma marca já cadastrada somente a atualizará.

 {
	"brands": [
		{
			"code": "A1",
			"name": "Marca Teste 001",
			"icon": "Url da logo",
			"banner": "Url do banner",
			"active": true,
			"seo": {
				"title": "Marca Teste 001",
				"keywords": "marca, teste",
				"description": "Marca Teste 001"
			}
		}
	]
}

Parâmetros do corpo

[brands]	Requerido	array	Lista de marcas
brands[code]		string/integer	Código que representa a marca no ERP
brands[name]	Requerido	string	Nome da marca
brands[active]		boolean	Valor que indica se a marca está ativa
brands[icon]		string	URL da logo da marca
brands[banner]		string	URL do banner da marca
brands[seo[title]		string	Metatag "title" para ser usada no SEO
brands[seo[description]		string	Metatag "description" para ser usada no SEO
brands[seo[keywords]		string	Metatags "keywords" para ser usada no SEO. Deve ser enviadas separadas por vírgula.

Definição

/api/v1/brands/{id}

Resultado

 {
	"errorReport": null,
	"brands": [
		{
			"id": null,
			"code": null,
			"name": "Marca 3",
			"active": true,
			"icon": "Url do logo da marca",
			"banner": null,
			"seo": {
				"title": "MARCA TESTE 3",
				"keywords": "",
				"description": ""
			}
		}
	]
}

 {
	"errorReport": [
		{
			"code": "FIELD_MISSING",
			"message": "Campo NAME não encontrado(Código: )."
		}
	],
	"brands": [
	]
}

GET Buscar marca

Exemplo de busca de uma marca

Definição

/api/v1/brands

Resultado

 {
	"errorReport": null,
	"brand": {
		"id": "5b7dd7b6b",
		"code": "A1",
		"name": "Marca Teste 001",
		"active": true,
		"icon": null,
		"banner": null,
		"seo": {
			"title": "MARCA TESTE 001",
			"keywords": null,
			"description": null
		}
	}
}

 {
	"errorReport": {
		"code": "BRAND_NOT_FOUND",
		"message": "Marca não encontrada."
	},
	"brand": null
}

GET Buscar lista de marcas

Exemplo de busca de uma lista de marcas

Definição

/api/v1/brands/{id}

Resultado

 {
	"errorReport": null,
	"brands": [
		{
			"id": null,
			"code": null,
			"name": "Marca 1",
			"active": true,
			"icon": null,
			"banner": null,
			"seo": {
				"title": null,
				"keywords": null,
				"description": null
			}
		}
	]
}

PUT Atualizar marca

Exemplo de atualização de uma marca

 {
	"brand": {
		"code": "A1",
		"name": "Marca Teste 001",
		"icon": "Url da logo",
		"banner": "Url do banner",
		"active": true,
		"seo": {
			"title": "Marca Teste 001",
			"keywords": "marca, teste",
			"description": "Marca Teste 001"
		}
	}
}

Parâmetros do corpo

brand[code]		string/integer	Código que representa a marca no ERP
brand[name]	Requerido	string	Nome da marca
brand[active]		boolean	Valor que indica se a marca está ativa
brand[icon]		string	URL da logo da marca
brand[banner]		string	URL do banner da marca
brand[seo[title]		string	Metatag "title" para ser usada no SEO
brand[seo[description]		string	Metatag "description" para ser usada no SEO
brand[seo[keywords]		string	Metatags "keywords" para ser usada no SEO. Deve ser enviadas separadas por vírgula.

Definição

/api/v1/brands/{id}

Resultado

 {
	"errorReport": null,
	"brand": {
		"id": "5b7dd7b6b",
		"code": "A1",
		"name": "Marca Teste 001",
		"active": true,
		"icon": null,
		"banner": null,
		"seo": {
			"title": "MARCA TESTE 001",
			"keywords": null,
			"description": null
		}
	}
}

 {
	"errorReport": {
		"code": "BRAND_NOT_FOUND",
		"message": "Marca não encontrada."
	},
	"brand": null
}

DELETE Deletar marca

Exemplo de remoção de uma marca

Atenção! Tome cuidado ao deletar uma marca, pois os produtos nela cadastrados ficarão sem marca na loja.

Atenção! Só é possivel deletar UMA marca por vez.

Definição

Resultado

 {
	"errorReport": null,
	"brand": {
		"id": "5b7dd7b6b",
		"code": "A1",
		"name": "Marca Teste 001",
		"active": true,
		"icon": null,
		"banner": null,
		"seo": {
			"title": "MARCA TESTE 001",
			"keywords": null,
			"description": null
		}
	}
}

 {
	"errorReport": {
		"code": "BRAND_NOT_FOUND",
		"message": "Marca não encontrada."
	},
	"brand": null
}

Produtos

POST Cadastrar novo produto base

Exemplo de cadasto de um novo produto base

Atenção! Tenha certeza de enviar SKUs diferentes para produtos diferentes. Enviar um SKU de uma produto já cadastrado somente o atualizará.

Atenção! Quando enviar um produto base, se ele tiver variações envie pelo menos uma varição em "products". Caso contrário nosso sistema interpreta o produto base como um produto simples e não permitirá adições de variações posteriores.

 {
	"base": {
		"name": "Camiseta Casas de Hogwarts",
		"description": "Lindas camisetas das casas de hogwarts",
		"url_sufix": null,
		"sku": "HPHOG001",
		"icms": 0.03,
		"ncm": null,
		"free_shipping": true,
		"condition": "NEW",
		"featured": false,
		"video": null,
		"dimension": {
			"height": 15,
			"width": 15,
			"length": null,
			"weight": 10.69
		},
		"seo": {
			"title": null,
			"description": null,
			"keywords": "placa,vegas,novo,colar"
		},
		"brand": {
			"id": "5ba0e250263f2"
		},
		"categories": [
			{
				"id": "5b9ff1a42632e"
			}
		],
		"images": [
			{
				"code": "IMGCAMSONSERINA",
				"url": "https://img.elo7.com.br/product/zoom/EEDFE7/camiseta-harry-potter-sonserina-camisetas-de-filme.jpg"
			},
			{
				"code": "IMGCAMLUFALUFA",
				"url": "https://img.elo7.com.br/product/original/EEE016/camiseta-harry-potter-lufa-lufa-lufa-lufa.jpg"
			}
		],
		"variations": [
			{
				"id": "5ba108f1d6e55"
			},
			{
				"id": "5ba109807b608"
			}
		],
		"products": [
			{
				"sku": "HPHOG001GRIFINORIAP",
				"reference": "123456",
				"ean": null,
				"mpn": null,
				"monitor_stock": false,
				"minimum_stock": null,
				"cost_price": 19.9,
				"sale_price": 29.9,
				"price_on_request": false,
				"availability": 0,
				"active": true,
				"showcase": false,
				"images": [
					{
						"code": "IMGCAMFGRIFINORIA"
					}
				],
				"options": [
					{
						"id": "5ba109808b2cd"
					},
					{
						"id": "5ba108f1e5881"
					}
				]
			},
			{
				"sku": "HPHOG001GRIFINORIAG",
				"reference": "123456",
				"ean": null,
				"mpn": null,
				"monitor_stock": false,
				"minimum_stock": null,
				"cost_price": 19.9,
				"sale_price": 29.9,
				"price_on_request": false,
				"availability": 0,
				"active": true,
				"showcase": false,
				"images": [
					{
						"code": "IMGCAMFGRIFINORIA"
					}
				],
				"options": [
					{
						"id": "5ba109808b2cd"
					},
					{
						"id": "5ba108f21cdda"
					}
				]
			}
		]
	}
}

Parâmetros do corpo

base[name]	Requerido	string	Nome do produto.
base[description]		string	Descrição do produto.
base[url_sufix]		string	Url para a página do produto.
base[sku]	Requerido	string	Sku do produto base.
base[icms]		decimal	ICMS do produto.
base[ncm]		string	NCM do produto.
base[free_shipping]		boolean	Valor que indica se o produto tem frete grátis.
base[condition]		string	Condição do produto. Valores aceitos: "NEW", "USED" ou "REFORMED".
base[video]		string	Url do vídeo do produto.
base[dimension[height]		decimal	Altura do produto em centímetros.
base[dimension[width]		decimal	Largura do produto em centímetros.
base[dimension[length]		decimal	Comprimento do produto em centímetros.
base[dimension[weight]		decimal	Peso do produto em gramas.
base[seo[title]		string	Metatag "title" para ser usada no SEO
base[seo[description]		string	Metatag "description" para ser usada no SEO
base[seo[keywords]		string	Metatags "keywords" para ser usada no SEO. Deve ser enviadas separadas por vírgula.
base[categories]		array	Lista de categorias do produto.
base[categories[id]		string	Id da categoria do produto
base[images]		array	Lista de imagens do produto.
base[images[code]		string/integer	Código da imagem.
base[images[url]		string	Url da imagem.
base[variations]		array	Lista das variações do produto
base[variations[id]	Requerido	string	Código que representa a variação na plataforma Inove Commerce
base[products]	Requerido	array	Lista de produtos variação
base[products[sku]		string	Sku do produto variação.
base[products[reference]		string	Código de referência do produto variação.
base[products[name]		string	Nome do produto variação.
base[products[ean]		string	EAN do produto variação.
base[products[mpn]		string	MPN do produto variação.
base[products[monitor_stock]		boolean	Valor que indica se o estoque do produto deve ser monitorado.
base[products[minimum_stock]		integer	Estoque mínimo do produto.
base[products[cost_price]		decimal	Preço de custo do produto.
base[products[sale_price]		decimal	Preço de venda do produto.
base[products[price_on_request]		boolean	Valor que indica se o preço deve ser exibido na loja.
base[products[availability]		integer	Prazo em dias de disponibilidade do produto. 0 - para imediato.
base[products[active]		string	Valor que indica se o produto está ativo.
base[products[showcase]		boolean	Valor que indica se o produto deve ser exibido nas vitrines da loja.
base[products[images]		array	Lista de imagens do produto variação
base[products[images[code]		string	Código que representa a imagem na plataforma Inove Commerce.
bases[products[options]		array	Lista de opções variação do produto
bases[products[options[id]		string	Código da opção variação.

Definição

/api/v1/bases

Resultado

 {
	"errorReport": null,
	"base": {
		"name": "Camiseta Casas de Hogwarts",
		"description": "Lindas camisetas das casas de hogwarts>",
		"sku": "HPHOG001",
		"icms": "0.03",
		"ncm": "",
		"free_shipping": false,
		"condition": "NEW",
		"featured": false,
		"video": "",
		"dimension": {
			"height": "15.00",
			"width": "15.00",
			"length": null,
			"weight": "10.69"
		},
		"seo": {
			"title": "",
			"description": "",
			"keywords": "placa,vegas,novo,colar"
		},
		"images": [
			{
				"code": "IMGCAMSONSERINA",
				"url": "https://sandboximg.inovecommerce.com.br/inove/produtos/lg/camiseta-casas-de-hogwarts-API-2a39d"
			},
			{
				"code": "IMGCAMFGRIFINORIA",
				"url": "https://sandboximg.inovecommerce.com.br/inove/produtos/lg/camiseta-casas-de-hogwarts-API-e5185"
			}
		],
		"brand": "5ba0e250263f2",
		"categories": [
			{
				"id": "5b9ff1a42632e",
				"main": true
			}
		],
		"variations": [
			{
				"id": "5ba109807b608"
			},
			{
				"id": "5ba108f1d6e55"
			}
		],
		"products_count": 1,
		"products": [
			{
				"active": true,
				"showcase": false,
				"sku": "HPHOG001GRIFINORIAP",
				"reference": "123456",
				"name": "Camiseta Casas de Hogwarts Grifinória P",
				"gtin": null,
				"mpn": null,
				"monitor_stock": false,
				"minimum_stock": null,
				"cost_price": null,
				"sale_price": null,
				"availability": null,
				"price_on_request": false,
				"options": [
					{
						"id": "5ba109808b2cd"
					},
					{
						"id": "5ba108f1e5881"
					}
				],
				"images": [
					{
						"code": "IMGCAMFGRIFINORIA"
					}
				]
			}
		]
	}
}

 {
	"errorReport": {
		"code": "FIELD_MISSING",
		"message": "Objeto BASE não segue o especificado na documentação."
	},
	"product": null
}

GET Buscar produto base

Exemplo de busca de um produto base

Definição

/api/v1/bases/{sku}

Resultado

 {
	"errorReport": null,
	"base": {
		"name": "Camiseta Casas de Hogwarts",
		"description": "Lindas camisetas das casas de hogwarts>",
		"sku": "HPHOG001",
		"icms": "0.03",
		"ncm": "",
		"free_shipping": false,
		"condition": "NEW",
		"featured": false,
		"video": "",
		"dimension": {
			"height": "15.00",
			"width": "15.00",
			"length": null,
			"weight": "10.69"
		},
		"seo": {
			"title": "",
			"description": "",
			"keywords": "placa,vegas,novo,colar"
		},
		"images": [
			{
				"code": "IMGCAMSONSERINA",
				"url": "https://sandboximg.inovecommerce.com.br/inove/produtos/lg/camiseta-casas-de-hogwarts-API-2a39d"
			},
			{
				"code": "IMGCAMFGRIFINORIA",
				"url": "https://sandboximg.inovecommerce.com.br/inove/produtos/lg/camiseta-casas-de-hogwarts-API-e5185"
			}
		],
		"brand": "5ba0e250263f2",
		"categories": [
			{
				"id": "5b9ff1a42632e",
				"main": true
			}
		],
		"variations": [
			{
				"id": "5ba109807b608"
			},
			{
				"id": "5ba108f1d6e55"
			}
		],
		"products_count": 1,
		"products": [
			{
				"active": true,
				"showcase": false,
				"sku": "HPHOG001GRIFINORIAP",
				"reference": "123456",
				"name": "Camiseta Casas de Hogwarts Grifinória P",
				"gtin": null,
				"mpn": null,
				"monitor_stock": false,
				"minimum_stock": null,
				"cost_price": null,
				"sale_price": null,
				"availability": null,
				"price_on_request": false,
				"options": [
					{
						"id": "5ba109808b2cd"
					},
					{
						"id": "5ba108f1e5881"
					}
				],
				"images": [
					{
						"code": "IMGCAMFGRIFINORIA"
					}
				]
			}
		]
	}
}

 {
	"errorReport": {
		"code": "PRODUCT_NOT_FOUND",
		"message": "Produto não encontrado."
	},
	"product": null
}

GET Buscar lista de produtos base

Exemplo de busca de uma lista de produtos base

Definição

/api/v1/bases

Resultado

{ "errorReport": null, "bases": [ { "name": "Colar Reliquias da Morte Update", "description": "

Colar do Harry Potter

", "sku": "98K31822AE", "icms": "0.00", "ncm": "5407.90.00", "free_shipping": false, "condition": "NEW", "featured": false, "video": null, "dimension": { "height": "16.00", "width": "16.00", "length": null }, "seo": { "title": null, "description": null, "keywords": "colar,reliquias,morte,novo" }, "images": [ "Url da imagem" ], "brand": { "id": null, "code": null, "name": "Marca 1", "active": true, "icon": "Url do logo da marca", "banner": null, "seo": { "title": null, "keywords": null, "description": null } }, "categories": [ { "id": "5b7c2rrdaf", "code": null, "name": "Cat 1", "parent": { "id": null, "code": null }, "color": "#000000", "featured": true, "active": true, "seo": { "title": null, "keywords": null, "description": null } } ], "products_count": 1, "products": [ { "active": true, "showcase": true, "sku": "98K31811158", "reference": "123456781", "name": "Colar Reliquias da Morte Update", "gtin": null, "mpn": null, "monitor_stock": false, "minimum_stock": 1, "cost_price": null, "sale_price": null, "availability": null, "price_on_request": false } ] } ] }

PUT Atualizar produto base

Exemplo de atualização de um produto base

Definição

/api/v1/bases/{sku}

Resultado

 {
	"errorReport": null,
	"base": {
		"name": "Camiseta Casas de Hogwarts",
		"description": "Lindas camisetas das casas de hogwarts>",
		"sku": "HPHOG001",
		"icms": "0.03",
		"ncm": "",
		"free_shipping": false,
		"condition": "NEW",
		"featured": false,
		"video": "",
		"dimension": {
			"height": "15.00",
			"width": "15.00",
			"length": null,
			"weight": "10.69"
		},
		"seo": {
			"title": "",
			"description": "",
			"keywords": "placa,vegas,novo,colar"
		},
		"images": [
			{
				"code": "IMGCAMSONSERINA",
				"url": "https://sandboximg.inovecommerce.com.br/inove/produtos/lg/camiseta-casas-de-hogwarts-API-2a39d"
			},
			{
				"code": "IMGCAMFGRIFINORIA",
				"url": "https://sandboximg.inovecommerce.com.br/inove/produtos/lg/camiseta-casas-de-hogwarts-API-e5185"
			}
		],
		"brand": "5ba0e250263f2",
		"categories": [
			{
				"id": "5b9ff1a42632e",
				"main": true
			}
		],
		"variations": [
			{
				"id": "5ba109807b608"
			},
			{
				"id": "5ba108f1d6e55"
			}
		],
		"products_count": 1,
		"products": [
			{
				"active": true,
				"showcase": false,
				"sku": "HPHOG001GRIFINORIAP",
				"reference": "123456",
				"name": "Camiseta Casas de Hogwarts Grifinória P",
				"gtin": null,
				"mpn": null,
				"monitor_stock": false,
				"minimum_stock": null,
				"cost_price": null,
				"sale_price": null,
				"availability": null,
				"price_on_request": false,
				"options": [
					{
						"id": "5ba109808b2cd"
					},
					{
						"id": "5ba108f1e5881"
					}
				],
				"images": [
					{
						"code": "IMGCAMFGRIFINORIA"
					}
				]
			}
		]
	}
}

 {
	"errorReport": [
		{
			"code": "PRODUCT_NOT_FOUND",
			"message": "Produto não encontrado."
		}
	],
	"product": null
}

DELETE Deletar produto base

Exemplo de remoção de um produto base

Atenção! Só é possivel deletar UM produto por vez.

Definição

/api/v1/bases/{sku}

Resultado

 {
	"errorReport": null,
	"base": {
		"name": "Camiseta Casas de Hogwarts",
		"description": "Lindas camisetas das casas de hogwarts>",
		"sku": "HPHOG001",
		"icms": "0.03",
		"ncm": "",
		"free_shipping": false,
		"condition": "NEW",
		"featured": false,
		"video": "",
		"dimension": {
			"height": "15.00",
			"width": "15.00",
			"length": null,
			"weight": "10.69"
		},
		"seo": {
			"title": "",
			"description": "",
			"keywords": "placa,vegas,novo,colar"
		},
		"images": [
			{
				"code": "IMGCAMSONSERINA",
				"url": "https://sandboximg.inovecommerce.com.br/inove/produtos/lg/camiseta-casas-de-hogwarts-API-2a39d"
			},
			{
				"code": "IMGCAMFGRIFINORIA",
				"url": "https://sandboximg.inovecommerce.com.br/inove/produtos/lg/camiseta-casas-de-hogwarts-API-e5185"
			}
		],
		"brand": "5ba0e250263f2",
		"categories": [
			{
				"id": "5b9ff1a42632e",
				"main": true
			}
		],
		"variations": [
			{
				"id": "5ba109807b608"
			},
			{
				"id": "5ba108f1d6e55"
			}
		],
		"products_count": 1,
		"products": [
			{
				"active": true,
				"showcase": false,
				"sku": "HPHOG001GRIFINORIAP",
				"reference": "123456",
				"name": "Camiseta Casas de Hogwarts Grifinória P",
				"gtin": null,
				"mpn": null,
				"monitor_stock": false,
				"minimum_stock": null,
				"cost_price": null,
				"sale_price": null,
				"availability": null,
				"price_on_request": false,
				"options": [
					{
						"id": "5ba109808b2cd"
					},
					{
						"id": "5ba108f1e5881"
					}
				],
				"images": [
					{
						"code": "IMGCAMFGRIFINORIA"
					}
				]
			}
		]
	}
}

 {
	"errorReport": [
		{
			"code": "PRODUCT_NOT_FOUND",
			"message": "Produto não encontrado."
		}
	],
	"product": null
}

POST Cadastrar novo produto variação

Exemplo de cadasto de um novo produto variação

 {
	"products": [
		{
			"active": true,
			"showcase": true,
			"sku": "HPHOG001GRIFINORIAM",
			"reference": "123456",
			"name": "Camiseta Casas de Hogwarts Grifinória M",
			"gtin": null,
			"mpn": null,
			"monitor_stock": false,
			"minimum_stock": null,
			"cost_price": null,
			"sale_price": null,
			"availability": null,
			"price_on_request": false,
			"options": [
				{
					"id": "5ba109808b2cd"
				},
				{
					"id": "5ba108f1f4063"
				}
			],
			"images": [
				{
					"code": "IMGCAMFGRIFINORIA"
				}
			]
		}
	]
}

Parâmetros do corpo

product[sku]	string	Sku do produto variação.
product[reference]	string	Código de referência do produto variação.
product[name]	string	Nome do produto variação.
product[ean]	string	EAN do produto variação.
product[mpn]	string	MPN do produto variação.
product[monitor_stock]	boolean	Valor que indica se o estoque do produto deve ser monitorado.
product[minimum_stock]	integer	Estoque mínimo do produto.
product[cost_price]	decimal	Preço de custo do produto.
product[sale_price]	decimal	Preço de venda do produto.
product[price_on_request]	boolean	Valor que indica se o preço deve ser exibido na loja.
product[availability]	integer	Prazo em dias de disponibilidade do produto. 0 - para imediato.
product[active]	string	Valor que indica se o produto está ativo.
product[showcase]	boolean	Valor que indica se o produto deve ser exibido nas vitrines da loja.
product[options[id]	string	Código da opção variação.
product[categories]	array	Lista de categorias do produto.
product[images]	array	Lista de imagens do produto.
product[options]	array	Lista de opções variação do produto

Definição

/api/v1/bases/{sku_base}/products

Resultado

 {
	"errorReport": null,
	"products": [
		{
			"active": true,
			"showcase": true,
			"sku": "HPHOG001GRIFINORIAM",
			"reference": "123456",
			"name": "Camiseta Casas de Hogwarts Grifinória M",
			"gtin": null,
			"mpn": null,
			"monitor_stock": false,
			"minimum_stock": null,
			"cost_price": null,
			"sale_price": null,
			"availability": null,
			"price_on_request": false,
			"options": [
				{
					"id": "5ba109808b2cd"
				},
				{
					"id": "5ba108f1f4063"
				}
			],
			"images": [
				{
					"code": "IMGCAMFGRIFINORIA"
				}
			]
		}
	]
}

 {
	"errorReport": {
		"code": "FIELD_INVALID",
		"message": "Campo SKU não segue o especificado na documentação.(Código: )."
	},
	"base": null
}

GET Buscar produto variação

Exemplo de busca de um produto variação

Definição

/api/v1/bases/{sku_base}/products/{sku}

Resultado

 {
	"errorReport": null,
	"product": {
		"active": true,
		"showcase": false,
		"sku": "HPHOG001GRIFINORIAP",
		"reference": "123456",
		"name": "Camiseta Casas de Hogwarts Grifinória P",
		"gtin": null,
		"mpn": null,
		"monitor_stock": false,
		"minimum_stock": null,
		"cost_price": null,
		"sale_price": null,
		"availability": null,
		"price_on_request": false,
		"options": [
			{
				"id": "5ba109808b2cd"
			},
			{
				"id": "5ba108f1e5881"
			}
		],
		"images": [
			{
				"code": "IMGCAMFGRIFINORIA"
			}
		]
	}
}

 {
	"errorReport": {
		"code": "BASE_NOT_FOUND",
		"message": "Produto Base não encontrado. (Código: )"
	},
	"product": null
}

PUT Atualizar produto variação

Exemplo de atualização de um produto base

Definição

/api/v1/bases/{sku_base}/products/{sku}

Resultado

 {
	"errorReport": null,
	"product": {
		"active": true,
		"showcase": false,
		"sku": "HPHOG001GRIFINORIAP",
		"reference": "123456",
		"name": "Camiseta Casas de Hogwarts Grifinória P",
		"gtin": null,
		"mpn": null,
		"monitor_stock": false,
		"minimum_stock": null,
		"cost_price": null,
		"sale_price": null,
		"availability": null,
		"price_on_request": false,
		"options": [
			{
				"id": "5ba109808b2cd"
			},
			{
				"id": "5ba108f1e5881"
			}
		],
		"images": [
			{
				"code": "IMGCAMFGRIFINORIA"
			}
		]
	}
}

 {
	"errorReport": [
		{
			"code": "PRODUCT_NOT_FOUND",
			"message": "Produto não encontrado."
		}
	],
	"product": null
}

DELETE Deletar produto variação

Exemplo de remoção de um produto variação

Definição

/api/v1/bases/{sku_base}/products/{sku}

Resultado

 {
	"errorReport": null,
	"product": {
		"active": true,
		"showcase": false,
		"sku": "HPHOG001GRIFINORIAP",
		"reference": "123456",
		"name": "Camiseta Casas de Hogwarts Grifinória P",
		"gtin": null,
		"mpn": null,
		"monitor_stock": false,
		"minimum_stock": null,
		"cost_price": null,
		"sale_price": null,
		"availability": null,
		"price_on_request": false,
		"options": [
			{
				"id": "5ba109808b2cd"
			},
			{
				"id": "5ba108f1e5881"
			}
		],
		"images": [
			{
				"code": "IMGCAMFGRIFINORIA"
			}
		]
	}
}

 {
	"errorReport": [
		{
			"code": "PRODUCT_NOT_FOUND",
			"message": "Produto não encontrado."
		}
	],
	"product": null
}

Clientes

POST Cadastrar cliente

Exemplo de cadastro de um cliente

Atenção! Se o CPF/CNPJ do cliente já estiver cadastrado em nosso sistema, será apenas feito o vínculo com a loja correspondente. Nenhum dado poderá ser atualizado via API.

 {
	"clients": [
		{
			"code": null,
			"type": "PF",
			"email": "[email protected]",
			"first_name": "Willin",
			"last_name": "Smith",
			"corporate_name": null,
			"cpf": "000.000.000-00",
			"cnpj": null,
			"state_registration": null,
			"telephone_number": "(19) 6589-7854",
			"cellphone_number": "(19) 66669-9999",
			"birthdate": "1992-07-09",
			"gender": "MALE",
			"addresses": [
				{
					"zipcode": "13502-140",
					"street": "Rua 9 JP",
					"number": "965",
					"district": "Jardim Residencial das Palmeiras",
					"city": "Rio Claro",
					"complement": null,
					"state": "SP",
					"country": "BRA"
				}
			]
		}
	]
}

Parâmetros do corpo

[clients]	array	Lista de clientes.
clients[id]	string	Código que representa o cliente na plataforma Inove.
clients[code]	string	Código que representa o cliente no ERP.
clients[email]	array	E-Mail do cliente.
clients[first_name]	string/integer	Nome do cliente(Pessoa Física).
clients[last_name]	string/integer	Sobrenome do cliente(Pessoa Física).
clients[corporate_name]	string	Razão social(Pessoa Jurídica).
clients[cpf]	string	CPF do cliente(Pessoa Física).
clients[cnpj]	string	CNPJ do cliente(Pessoa Jurídica).
clients[state_registration]	string	Inscrição Estadual(Pessoa Jurídica).
clients[telephone_number]	string	Telefone do cliente.
clients[cellphone_number]	string	Celular do cliente.
clients[birthdate]	string	Data de nascimento do cliente(Pessoa Física).
clients[gender]	string	Gênero do cliente(Pessoa Física). Valores aceitos: "Male" ou "Female".
clients[addresses]	array	Lista de endereços do cliente.
clients[addresses[id]	string	Código que representa o endereço na plataforma Inove.
clients[addresses[code]	string	Código que representa o endereço no ERP.
clients[addresses[zipcode]	string	CEP do endereço.
clients[addresses[street]	string	Logradouro do endereço.
clients[addresses[number]	integer	Número do endereço.
clients[addresses[district]	string	Bairro do endereço.
clients[addresses[city]	string	Cidade do endereço.
clients[addresses[complement]	string	Complemento do endereço.
clients[addresses[state]	string	Sigla do estado do endereço.
clients[addresses[country]	string	País do endereço.

Definição

/api/v1/clients/{id}

Resultado

 {
	"errorReport": null,
	"clients": [
		{
			"id": null,
			"code": null,
			"type": "PF",
			"email": "[email protected]",
			"first_name": "Willin",
			"last_name": "Smith",
			"corporate_name": null,
			"cpf": "000.000.000-00",
			"cnpj": null,
			"state_registration": null,
			"telephone_number": "(19) 6589-7854",
			"cellphone_number": "(19) 66669-9999",
			"birthdate": "1992-07-09",
			"gender": "MALE",
			"addresses": [
				{
					"zipcode": "13502-140",
					"street": "Rua 9 JP",
					"number": "965",
					"district": "Jardim Residencial das Palmeiras",
					"city": "Rio Claro",
					"complement": null,
					"state": "SP",
					"country": "BRA"
				}
			]
		}
	]
}

 {
	"errorReport": [
		{
			"code": "FIELD_MISSING",
			"message": "Campo CPF ou CNPJ ausente em um cliente."
		},
		{
			"code": "FIELD_MISSING",
			"message": "Campo NAME ausente em um cliente."
		}
	],
	"clients": [
	]
}

GET Buscar cliente

Exemplo de busca de um cliente

Definição

/api/v1/clients/{id}

Resultado

 {
	"errorReport": null,
	"client": {
		"id": 7747,
		"code": null,
		"email": "[email protected]",
		"first_name": "Willin",
		"last_name": "Smith",
		"corporate_name": null,
		"cpf": "000.000.000-00",
		"cnpj": null,
		"state_registration": null,
		"telephone_number": "(19) 6589-7854",
		"cellphone_number": "(19) 66669-9999",
		"birthdate": "1992-07-09",
		"gender": "Male",
		"addresses": [
			{
				"id": 6731,
				"zipcode": "13502-140",
				"street": "Rua 9 JP",
				"number": "965",
				"district": "Jardim Residencial das Palmeiras",
				"city": "Rio Claro",
				"complement": null,
				"state": "SP",
				"country": "BRA"
			}
		]
	}
}

 {
	"errorReport": {
		"code": "CLIENT_NOT_FOUND",
		"message": "Cliente não encontrado."
	},
	"client": null
}

GET Buscar lista de clientes

Exemplo de busca de uma lista de clientes

Definição

Resultado

 {
	"errorReport": null,
	"clients": [
		{
			"id": 7747,
			"code": null,
			"email": "[email protected]",
			"first_name": "Willin",
			"last_name": "Smith",
			"corporate_name": null,
			"cpf": "000.000.000-00",
			"cnpj": null,
			"state_registration": null,
			"telephone_number": "(19) 6589-7854",
			"cellphone_number": "(19) 66669-9999",
			"birthdate": "1992-07-09",
			"gender": "Male",
			"addresses": [
				{
					"id": 6731,
					"zipcode": "13502-140",
					"street": "Rua 9 JP",
					"number": "965",
					"district": "Jardim Residencial das Palmeiras",
					"city": "Rio Claro",
					"complement": null,
					"state": "SP",
					"country": "BRA"
				}
			]
		}
	]
}

Pedidos

GET Buscar pedido

Exemplo de busca de um pedido

Parâmetros do corpo

order[id]	string	Código que representa o pedido na plataforma Inove Commerce.
order[status]	string	Status atual do pedido.
order[prices[total]	decimal	Valor total do pedido.
order[prices[shipping]	decimal	Valor do frete do pedido.
order[prices[discount]	decimal	Valor do desconto do pedido.
order[prices[coupon]	decimal	Valor do cupom desconto do pedido.
order[buyer[type]	string	Tipo do comprador.
order[buyer[email]	string	E-Mail do comprador.
order[buyer[name]	string	Nome do comprador.
order[buyer[last_name]	string	Sobrenome do comprador.
order[buyer[corporate_name]	string	Razão social do comprador.
order[buyer[corporate_contact]	string	Responsável da empresa compradora.
order[buyer[cpf]	string	CPF do comprador.
order[buyer[cnpj]	string	CNPJ do comprador.
order[buyer[state_registration]	string	Inscrição estadual do comprador.
order[buyer[telephone_number]	string	Telefone do comprador.
order[buyer[cellphone_number]	string	Celular do comprador.
order[buyer[birthdate]	string	Data de nascimento do comprador.
order[buyer[gender]	string	Gênero do comprador.
order[payment[company]	string	Empresa utilizada no pagamento.
order[payment[method]	string	Método de pagamento.
order[shipping[method]	string	Método de envio/entrega.
order[shipping[address[zipcode]	string	CEP do endereço de entrega.
order[shipping[address[street]	string	Endereço de entrega.
order[shipping[address[number]	integer	Número do endereço de entrega.
order[shipping[address[city]	string	Cidade do endereço de entrega.
order[shipping[address[complement]	string	Complemento do endereço de entrega.
order[shipping[address[district]	string	Bairro do endereço de entrega
order[shipping[address[state]	string	Estado do endereço de entrega.
order[shipping[address[country]	string	País do endereço de entrega.
order[shipping[tracking_code]	string	Código de rastreamento do pedido.
order[products]	array	Lista de itens do pedido.
order[products[sku]	string	SKU do item.
order[products[name]	string	Nome do item.
order[products[price]	decimal	Preço do item.
order[products[quantity]	integer	Quantidade do item.
order[products[free_shipping]	boolean	Valor que indica que o item teve frete grátis.
order[products[gift[is_gift]	boolean	Valor que indica se o item era presente.
order[products[gift[price]	string	Valor do embrulho presente.
order[coupon]	string	Cupom desconto utilizado no pedido.
order[notes]	string	Observações do pedido.

Definição

/api/v1/orders

Resultado

 {
	"errorReport": null,
	"order": {
		"id": null,
		"code": null,
		"status": "Aprovado",
		"prices": {
			"total": "97.51",
			"shipping": "0.00",
			"discount": "0.00",
			"coupon": "0.00",
			"ticket_discount": "1.99"
		},
		"buyer": {
			"type": "PF",
			"email": "[email protected]",
			"name": "Willin",
			"last_name": "Smith",
			"corporate_name": null,
			"corporate_contact": null,
			"cpf": "976.903.790-79",
			"cnpj": null,
			"state_registration": null,
			"telephone_number": "(19) 6589-7854",
			"cellphone_number": "(19) 66669-9999",
			"birthdate": "1992-07-09",
			"gender": "MALE"
		},
		"payment": {
			"company": "",
			"method": ""
		},
		"shipping": {
			"method": "",
			"address": {
				"zipcode": "13502-140",
				"street": "Rua 9 JP",
				"number": "965",
				"city": "Rio Claro",
				"complement": null,
				"district": "Jardim Residencial das Palmeiras",
				"state": "SÃO PAULO",
				"country": "BRA"
			},
			"tracking_code": null
		},
		"products": [
			{
				"sku": "1IMFMR96UIWI",
				"name": "Camisa Grifinória 3 ",
				"price": "52.00",
				"quantity": 1,
				"free_shipping": false,
				"gift": {
					"is_gift": false,
					"price": "0.00"
				}
			},
			{
				"sku": "98K318AEO358",
				"name": "Colar Reliquias da Morte Update",
				"price": "47.50",
				"quantity": 1,
				"free_shipping": false,
				"gift": {
					"is_gift": false,
					"price": "0.00"
				}
			}
		],
		"coupon": "",
		"notes": null
	}
}

 {
	"errorReport": {
		"code": "ORDER_NOT_FOUND",
		"message": "Pedido não encontrado."
	},
	"order": null
}

GET Buscar lista de pedidos

Exemplo de busca de uma lista de pedidos

Para buscar pedidos alguns filtros estão disponiveis. Para utilizá-los passe-os na url da seguinte forma: https://app.inovecommerce.com.br/api/v1/orders?start=01-11-2018&end=21-11-2018&status=APROVED

start: datas inicial das vendas retornadas. Formato: dia-mes-ano
start: datas finaldas vendas retornadas. Formato: dia-mes-ano
status: status das vendas retornadas. Utilize as constantes da seção de Enumeradores -> Status de pedidos

Definição

/api/v1/orders

Resultado

 {
	"errorReport": null,
	"orders": [
		{
			"id": null,
			"code": null,
			"status": "Pendente",
			"prices": {
				"total": "27.44",
				"shipping": "0.00",
				"discount": "0.00",
				"coupon": "0.00",
				"ticket_discount": "0.56"
			},
			"buyer": {
				"type": "PF",
				"email": "[email protected]",
				"name": "Dinho",
				"last_name": "do Mamonas Assassinas",
				"corporate_name": null,
				"corporate_contact": null,
				"cpf": "695.636.068-33",
				"cnpj": null,
				"state_registration": null,
				"telephone_number": "(12) 3132-1321",
				"cellphone_number": "(12) 12121-2121",
				"birthdate": "1988-12-12",
				"gender": "MALE"
			},
			"payment": {
				"company": "",
				"method": ""
			},
			"shipping": {
				"method": "",
				"address": {
					"zipcode": "13501-190",
					"street": "Avenida 41",
					"number": "700",
					"city": "Rio Claro",
					"complement": null,
					"district": "Vila Santo Antônio",
					"state": "SÃO PAULO",
					"country": "BRA"
				},
				"tracking_code": null
			},
			"products": [
				{
					"sku": "Y0WWNR9GXUSK",
					"name": "Caneca Simples Preta ",
					"price": "28.00",
					"quantity": 1,
					"free_shipping": false,
					"gift": {
						"is_gift": false,
						"price": "0.00"
					}
				}
			],
			"coupon": "",
			"notes": null
		}
	]
}

Variações

POST Cadastrar variação

Exemplo de cadastro de uma variação

 {
	"variations": [
		{
			"code": "VAR003",
			"name": "Teste API - Variação 002",
			"type": "TEXT",
			"prefix": "Test",
			"options": [
				{
					"code": "OP01VAR003",
					"value": "G1",
					"hexcolor": null
				}
			]
		}
	]
}

Parâmetros do corpo

[variations]	Requerido	array	Lista de variações
variations[code]		string/integer	Código que representa a variação no ERP
variations[name]	Requerido	string	Nome da variação
variations[type]	Requerido	string	Tipo da variação. Valores aceitos: "TEXT ou COLOR".
variations[prefix]		string	Prefixo para a variação.
variations[options]		array	Lista contendo as opções da variação.
variations[options[code]		string/integer	Código que representa a opção variação no ERP.
variations[options[value]	Requerido	string/integer	Valor da opção variação.

Definição

/api/v1/variations

Resultado

 {
	"errorReport": null,
	"variations": [
		{
			"id": "5b98fbf14ac17",
			"code": "VAR003",
			"name": "Teste API - Variação 002",
			"prefix": "Test",
			"type": "TEXT",
			"options": [
				{
					"id": "5b98fbf14ddb4",
					"code": "OP01VAR003",
					"value": "G1",
					"hexcolor": "#FFFFFF|#FFFFFF"
				}
			]
		}
	]
}

 {
	"errorReport": [
		{
			"code": "FIELD_INVALID",
			"message": "Campo CODE não segue o especificado na documentação(Código: 1)."
		}
	],
	"variations": [
	]
}

GET Buscar variação

Exemplo de busca de uma variação

Definição

/api/v1/variations

Resultado

 {
	"errorReport": null,
	"variation": {
		"id": "KO12122355",
		"code": null,
		"name": "Variação A",
		"prefix": "VA",
		"type": "TEXT",
		"options": [
			{
				"id": null,
				"code": null,
				"value": "1",
				"hexcolor": null
			}
		]
	}
}

 {
	"errorReport": {
		"code": "VARIATION_NOT_FOUND",
		"message": "Variação não encontrada."
	},
	"variation": null
}

GET Buscar lista de variações

Exemplo de busca de uma lista de variações

Definição

/api/v1/variations/{id}

Resultado

 {
	"errorReport": null,
	"variations": [
		{
			"id": "123ABC",
			"code": "LKHH36",
			"name": "Tamanho",
			"prefix": "Tam",
			"type": "TEXT",
			"options": [
				{
					"id": "POB78",
					"code": "XSJKK2",
					"value": "1",
					"hexcolor": null
				}
			]
		}
	]
}

PUT Atualizar variação

Exemplo de atualização de uma variação

Definição

/api/v1/variations/{id}

Resultado

 {
	"errorReport": null,
	"variation": {
		"id": "KO12122355",
		"code": null,
		"name": "Variação A",
		"prefix": "VA",
		"type": "TEXT",
		"options": [
			{
				"id": null,
				"code": null,
				"value": "1",
				"hexcolor": null
			}
		]
	}
}

 {
	"errorReport": {
		"code": "VARIATION_NOT_FOUND",
		"message": "Variação não encontrada."
	},
	"variation": null
}

Estoques

POST Atualizar o estoque de produtos

Exemplo de atualização de estoque de produtos

Atenção! O metodo simplesmente ajusta o estoque para a quantidade enviada. Caso queira adicionar/subtrair itens do estoque atual use a rota /api/v1/stocks/add mandando o mesmo corpo.

 {
	"products": [
		{
			"sku": "7BR3T1MNNAAB01",
			"stock": 1
		}
	]
}

Parâmetros do corpo

[products]	Requerido	array	Lista de produtos.
products[sku]	Requerido	string	SKU do produto.
products[stock]	Requerido	integer	Estoque a ser inserido.

Definição

/api/v1/stocks

Resultado

 {
	"errorReport": null,
	"products": [
		{
			"sku": "7BR3T1MNNAAB01",
			"stock": 2
		}
	]
}

 {
	"errorReport": [
		{
			"code": "FIELD_MISSING",
			"message": "Lista de produtos ausente."
		}
	],
	"products": null
}

POST Adicionar/remover estoque de produtos

Exemplo de adição/remoção de estoque de produtos

Atenção! O metodo simplesmente adiciona ou remove a quantidade do estoque atual. Caso queira sobrescrever a quantidade do estoque atual use a rota /api/v1/stocks mandando o mesmo corpo.

 {
	"products": [
		{
			"sku": "7BR3T1MNNAAB01",
			"stock": 1
		}
	]
}

Parâmetros do corpo

[products]	Requerido	array	Lista de produtos.
products[sku]	Requerido	string	SKU do produto.
products[stock]	Requerido	integer	Estoque a ser inserido.

Definição

/api/v1/stocks/add

Resultado

 {
	"errorReport": null,
	"products": [
		{
			"sku": "7BR3T1MNNAAB01",
			"stock": 2
		}
	]
}

 {
	"errorReport": [
		{
			"code": "FIELD_MISSING",
			"message": "Lista de produtos ausente."
		}
	],
	"products": null
}

POST Buscar o estoque de um produto

Exemplo de busca de estoque de um produto

Definição

/api/v1/stocks/{sku}

Resultado

 {
	"errorReport": null,
	"product": {
		"sku": "5RLHEC6FQQDI",
		"stock": 99999
	}
}

 {
	"errorReport": {
		"code": "PRODUCT_NOT_FOUND",
		"message": "Produto não encontrado."
	},
	"product": null
}

Enumerações

Condição do produto

Valor	Descrição
NEW	Produto Novo
USED	Produto Usado
REFORMED	Produto Reformado

Tipos de variação

Valor	Descrição
TEXT	Variação do tipo texto
COLOR	Variação do tipo cor

Status de pedido

Valor	Descrição
PENDING	Pedido pendente
AWAITING_PAYMENT	Pedido aguardando pagamento
APPROVED	Pedido aprovado
CANCELED	Pedido cancelado
REFUSED	Pedido recusado
READY_FOR_SHIPPING	Pedido pronto para envio
SENT	Pedido enviado
SENT_PARTIALLY	Pedido pendente
WAITING_FOR_WITHDRAWAL	Pedido enviado parcialmente
COMPLETE'	Pedido completo
REFUNDED'	Pedido reembolsado
IN_DISPUTE'	Pedido em dispuita
DISPUTE_WINS'	Pedido com disputa ganha

Códigos de Retorno

Código	Mensagem	HTTP Code
AUTENTICATION_FAIL	Erro na autenticação.	401
CATEGORY_NOT_FOUND	Categoria não encontrada.	400
FIELD_INVALID	Campo CATEGORY não segue o especificado na documentação	400
FIELD_MISSING	Campo CODE ausente em uma categoria.	400
FIELD_MISSING	Campo NAME ausente na categoria.	400
FIELD_MISSING	Lista de categorias ausente.	400
CATEGORY_NOT_FOUND	Categoria pai não encontrada para categoria.	400
CATEGORY_NOT_EMPTY	Não é possivel deletar uma categoria não vazia	400
CATEGORY_NOT_DELETED	Não foi possível deletar a categoria	400
CATEGORY_CICLIC_PARENT	O campo PARENT é o mesmo do campo ID da categoria.	400
BRAND_NOT_FOUND	Marca não encontrada.	400
FIELD_MISSING	Lista de marcas ausente.	400
FIELD_INVALID	Objeto BRAND não segue o especificado na documentação.	400
FIELD_MISSING	Não foi encontrado o objeto BRAND.	400
FIELD_MISSING	Campo CODE não encontrado.	400
FIELD_MISSING	Campo NAME não encontrado.	400
BRAND_NOT_DELETED	Não foi possível deletar a marca	400
BRAND_NOT_SAVED	Não foi possível salvar a marca	400
BRAND_CODE_NOT_MATCH	CODE enviado e codigo já cadastrado não combinam.	400
CLIENT_NOT_FOUND	Cliente não encontrado.	400
CLIENT_API_NOT_FOUND	Não foi encontrado um cadastro desse cliente via API.	400
CLIENT_INOVE_NOT_FOUND	Não foi encontrado um cadastro desse cliente na plataforma Inove Commerce.	400
CLIENT_NOT_DELETED	Não foi possível deletar o cliente.	400
FIELD_MISSING	Campo TYPE ausente em um cliente.	400
FIELD_MISSING	Campo CPF ou CNPJ ausente em um cliente.	400
FIELD_MISSING	Campo NAME ausente em um cliente.	400
FIELD_MISSING	Campo LAST NAME ausente em um cliente.	400
FIELD_MISSING	Campo CORPORATE NAME ausente em um cliente.	400
FIELD_MISSING	Campo EMAIL ausente em um cliente.	400
FIELD_INVALID	Campo TYPE não segue o especificado na documentação.	400
FIELD_INVALID	Campo EMAIL não segue o especificado na documentação.	400
FIELD_INVALID	Campo NAME não segue o especificado na documentação.	400
FIELD_INVALID	Campo LAST NAME não segue o especificado na documentação.	400
FIELD_INVALID	Campo CORPORATE NAME não segue o especificado na documentação.	400
FIELD_INVALID	Campo CORPORATE CONTACT não segue o especificado na documentação.	400
FIELD_INVALID	Campo CPF não segue o especificado na documentação.	400
FIELD_INVALID	Campo CNPJ não segue o especificado na documentação.	400
FIELD_INVALID	Campo TELEPHONE NUMBER não segue o especificado na documentação.	400
FIELD_INVALID	Campo CELLPHONE NUMBER não segue o especificado na documentação.	400
FIELD_INVALID	Campo BIRTHDATE não segue o especificado na documentação.	400
FIELD_INVALID	Campo GENDER não segue o especificado na documentação.	400
FIELD_INVALID	Campo STATE REGISTRATION não segue o especificado na documentação.	400
FIELD_INVALID	Campo ADDRESSES não segue o especificado na documentação.	400
FIELD_MISSING	Campo ZIPCODE ausente em um endereço.	400
FIELD_MISSING	Campo STREET ausente em um endereço.	400
FIELD_MISSING	Campo NUMBER ausente em um endereço.	400
FIELD_MISSING	Campo DISTRICT ausente em um endereço.	400
FIELD_MISSING	Campo CITY ausente em um endereço.	400
FIELD_MISSING	Campo STATE ausente em um endereço.	400
FIELD_INVALID	Campo ZIPCODE não segue o especificado na documentação.	400
FIELD_INVALID	Campo STREET não segue o especificado na documentação.	400
FIELD_INVALID	Campo NUMBER não segue o especificado na documentação.	400
FIELD_INVALID	Campo DISTRICT não segue o especificado na documentação.	400
FIELD_INVALID	Campo CITY não segue o especificado na documentação.	400
FIELD_INVALID	Campo COMPLEMENT não segue o especificado na documentação.	400
FIELD_INVALID	Campo STATE não segue o especificado na documentação.	400
ORDER_NOT_FOUND	Pedido não encontrado.	400
VARIATION_NOT_FOUND	Variação não encontrada.	400
FIELD_MISSING	Não foi encontrado o obejto VARIATION.	400
FIELD_MISSING	Campo CODE ausente em uma variação.	400
FIELD_MISSING	Campo NAME ausente na variação.	400
FIELD_MISSING	Campo TYPE ausente na variação.	400
FIELD_MISSING	Lista de variações ausente.	400
FIELD_MISSING	Campo CODE ausente em uma opção variação.	400
FIELD_MISSING	Campo VALUE ausente na opção variação.	400
VARIATION_CODE_NOT_MATCH	CODE enviado e codigo já cadastrado não combinam.	400
VARIATION_NOT_SAVED	Não foi possível salvar variaçao.	400
OPTION_NOT_SAVED	Não foi possível salvar opção.	400
OPTION_CODE_NOT_MATCH	CODE enviado e codigo já cadastrado não combinam.	400
VARIATION_NOT_FOUND	Variação não encontrada	400
OPTION_NOT_FOUND	Opção não encontrada ou não combina com as variações previamente declaradas.	400
BASE_NOT_FOUND	Produto Base não encontrdado. (Código: )	400
PRODUCT_NOT_FOUND	Produto não encontrado.	400
FIELD_MISSING	Objeto BASE não encontrada.	400
FIELD_MISSING	Lista de produtos não encontrada.	400
FIELD_MISSING	Lista de produtos não encontrada.	400
FIELD_MISSING	Objeto PRODUCT não segue o especificado na documentação.	400
FIELD_MISSING	Objeto PRODUCT não segue o especificado na documentação.	400
FIELD_MISSING	SKU não encontrado.	400
FIELD_MISSING	Marca não encontrada.	400
FIELD_MISSING	Lista de categorias não encontrada no obejeto.	400
FIELD_MISSING	Categoria não encontrada.	400
FIELD_MISSING	Lista de imagens não encontrada.	400
FIELD_MISSING	CODE da imagem inválido.	400
FIELD_MISSING	Lista de produtos não encontrada.	400
OPTION_NOT_FOUND	Opção de variação não encontrd.	400
FIELD_MISSING	O campo SALE PRICE na variação não foi encontrdo.	400
FIELD_MISSING	O campo SALE PRICE ou campo PRICE ON REQUEST não foi encontrdo.	400
FIELD_MISSING	O campo BRAND ou campo PRICE ON REQUEST não foi encontrdo.	400
IMAGE_NOT_EXISTS	Arquivo de imagem não existe.	400
IMAGE_NOT_OBJECT	O Objeto de imagem não segue o especificado na documentação.	400
PRODUCT_OPTIONS_MATCH	Já existe um produto base com essas opções mas o SKU não corresponde..	400
FIELD_MISSING	Não foi encontrada o campo de categorias	400
FIELD_INVALID	Campo VALUE não segue o especificado na documentação.	400
FIELD_INVALID	Campo TYPE não segue o especificado na documentação.	400
FIELD_INVALID	Campo OPTIONS não segue o especificado na documentação.	400
FIELD_INVALID	Campo CODE não segue o especificado na documentação.	400
FIELD_INVALID	Campo NAME não segue o especificado na documentação.	400
FIELD_INVALID	Campo COLOR não segue o especificado na documentação.	400
FIELD_INVALID	Campo FEATURED não segue o especificado na documentação.	400
FIELD_INVALID	Campo ACTIVE não segue o especificado na documentação.	400
FIELD_INVALID	Campo TITLE não segue o especificado na documentação.	400
FIELD_INVALID	Campo DESCRIPTION não segue o especificado na documentação.	400
FIELD_INVALID	Campo KEYWORDS não segue o especificado na documentação.	400
FIELD_INVALID	Campo SKU não segue o especificado na documentação.	400
FIELD_INVALID	Campo URL_SUFIX não segue o especificado na documentação.	400
FIELD_INVALID	Campo VIDEO não segue o especificado na documentação.	400
FIELD_INVALID	Campo NCM não segue o especificado na documentação.	400
FIELD_INVALID	Campo FREE_SHIPPING não segue o especificado na documentação.	400
FIELD_INVALID	Campo ICMS não segue o especificado na documentação.	400
FIELD_INVALID	Campo WIDTH não segue o especificado na documentação.	400
FIELD_INVALID	Campo HEIGHT não segue o especificado na documentação.	400
FIELD_INVALID	Campo LENGTH não segue o especificado na documentação.	400
FIELD_INVALID	Campo CONDITION não segue o especificado na documentação.	400
FIELD_INVALID	Campo REFERNCE não segue o especificado na documentação.	400
FIELD_INVALID	Campo PRICE_ON_REQUEST não segue o especificado na documentação.	400
FIELD_INVALID	Campo COST_PRICE não segue o especificado na documentação.	400
FIELD_INVALID	Campo SALE_PRICE não segue o especificado na documentação.	400
FIELD_INVALID	Campo MINIMUM_STOCK não segue o especificado na documentação.	400
FIELD_INVALID	Campo AVAILABILITY não segue o especificado na documentação.	400
FIELD_INVALID	Campo SHOWCASE não segue o especificado na documentação.	400
FIELD_INVALID	Campo BRAND não segue o especificado na documentação.	400
FIELD_INVALID	Campo PARENT não segue o especificado na documentação.	400
FIELD_INVALID	Campo ICON não segue o especificado na documentação.	400
FIELD_INVALID	Campo BANNER não segue o especificado na documentação.	400
COPY_IMAGE_FAIL	Não foi possivel copiar a imagem.	400
COPY_IMAGE_FAIL	Não foi possivel copiar a imagem.	400
DELETE_BASE_FAIL	Falha ao deletar BASE	400
DELETE_CATEGORY_FAIL	Falha ao deletar CATEGORIA	400
DELETE_IMAGE_FAIL	Falha ao deletar IMAGEM	400
DELETE_EVALUATION_FAIL	Falha ao deletar AVALIAÇÃO	400
DELETE_UNION_FAIL	Falha ao deletar COMBO	400
DELETE_INDICATION_FAIL	Falha ao deletar INDICAÇÃO	400
DELETE_FAVORITE_FAIL	Falha ao deletar FAVORITO	400
DELETE_PRODUCT_FAIL	Falha ao deletar PRODUTO	400
DELETE_PRODUCT_PRICE_FAIL	Falha ao deletar PREÇO no produto	400
DELETE_PRODUCT_OPTIONS_FAIL	Falha ao deletar OPÇÕES no produto	400
DELETE_PRODUCT_PROMOTION_FAIL	Falha ao deletar PROMOÇÃO no produto	400
DELETE_PRODUCT_WARN_ME_FAIL	Falha ao deletar AVISE-ME no produto	400
DELETE_PRODUCT_CART_FAIL	Falha ao deletar CARRINHO no produto	400
DELETE_PRODUCT_DISCOUNT_FAIL	Falha ao deletar DESCONTO no produto	400
DELETE_PRODUCT_STOCK_FAIL	Falha ao deletar ESTOQUE no produto	400
DELETE_PRODUCT_UNION_FAIL	Falha ao deletar COMBO no produto	400
DELETE_PRODUCT_INDICATION_FAIL	Falha ao deletar INDICAÇÃO no produto	400
DELETE_PRODUCT_RECOMMENDATION_FAIL	Falha ao deletar RECOMENDAÇÃO no produto	400
DELETE_PRODUCT_AD_FAIL	Falha ao deletar ANUNCIO no produto	400
FIELD_MISSING	Estoque não encontrado..	400
FIELD_INVALID	Campo STOCK não segue o especificado na documentação.	400
FIELD_MISSING	Lista de produtos ausente.	400
STOCK_IS_ILIMITED	Estoque não inserido, pois o estoque desse produto não está sendo monitorado.	400
STOCK_NOT_UPDATED	Não houve alteração de estoque.	400
ORDER_STATUS_INVALID	Status inválido	400