API Integração X-Commerce
API Endpoint
https://api.minhaloja.com.brDocumentação para integração com a loja virtual X-Commerce
Introdução
Esta documentação visa auxiliar o desenvolvedor na integração com loja virtual X-Commerce.
Através desta API será possível realizar as seguintes ações:
-
Gerenciar as categorias
-
Gerenciar as marcas
-
Gerenciar os produtos
-
Gerenciar as caracteristicas
-
Consumir e atualizar os pedidos
-
Gerar e utilizar cash back
Os dados enviados para a API devem ser no formato JSON, o conteudo das respostas também será nesse mesmo formato.
Autenticação
Para realizar a comunicação com a API da loja devem ser informados no cabeçalho da requisição o e-mail e token de acesso, seguindo o seguinte modelo:
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brOs dados de acesso serão fornecidos pela Arco ao disponibilizar o ambiente de homologaçao.
Códigos de resposta
A API utiliza os códigos de status HTTP para informar o tipo de retorno (sucesso ou erro) de cada ação.
-
2xx: Esta classe de código de status indica que a requisição foi recebida, entendida e processada com sucesso.
-
4xx: Esta classe de código de status indica que algum erro ocorreu durante o processamento dos dados da requisição.
-
5xx: Esta classe de código de status indica que o servidor encontrou algum problema ao tentar processar a requisição.
TABELA DE CÓDIGOS
| Código | Tipo | Descrição |
|---|---|---|
| 200 | SUCCESS | A requisição foi processada com sucesso e retornará alguma informação extra sobre o resultado. |
| 201 | SUCCESS | A requisição foi processada com sucesso e uma nova entidade foi criada, retornando algum dado da nova entidade criada, por exemplo o ID da mesma. |
| 204 | SUCCESS | A requisição foi processada com sucesso porém não retornará nenhum coteudo na resposta. |
| 401 | UNAUTHORIZED | Falha na autenticação. Não foi possível realizar a autenticação, verifique se as credenciais de acesso estão corretas. |
| 404 | NOT FOUND | Entidade não encontrada. Nenhuma entidade foi encontrada com os dados fornecidos. |
| 405 | METHOD NOT ALLOWED | O metodo que você esta tentando executar não foi encontrado, verifique se a URL e o tipo de requisição (GET, POST, PUT, DELETE) estão corretos. |
| 422 | UNPROCESSABLE ENTITY | Falha ao processar a entidade. O servidor recebeu a sua requisição porém algum erro ocorreu ao processar as informações enviadas, por exemplo o formato incorreto de uma data. |
Outras informações
Caso necessite de alguma informação que não esteja presente nesta documentação, ou tenha dificuldade em algum dos processos, basta entrar em contato com a Arco através do telefone +55 28 3511-2855, ou pelo e-mail coordenacao2@arcoinformatica.com.br.
Caso tenha alguma dúvida de como consumir as rotas da API, basta clicar no botão abaixo:
Ou utilize a seguinte URL: https://documenter.getpostman.com/view/16736215/TzsWtV9h
Categorias ¶
É possível criar, editar e excluir as categorias da loja virtual.
Seguindo um modelo de Categoria Pai >> Categoria Filha é possível criar quantas sub-categorias forem necessárias.
Por exemplo caso tenhamos a seguinte estrutura de categorias Eletrônicos >> TV >> Smart TV, a categoria Eletrônicos é pai da categoria TV, que por sua vêz é pai da categoria Smart TV.
OBSERVAÇÃO:
Ao cadastrar o produto, basta informar a categoria mais específica do mesmo e a loja se encarregara de aloca-lo nas categorias pai automaticamente.
Categoria ¶
GET https://api.minhaloja.com.br/categorias?per_page=10&?page=0&?sort=id,desc
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"total": 10,
"per_page": 10,
"current_page": 0,
"last_page": 5,
"data": [
{
"codigo_referencia": "C002",
"nome": "Categoria de Teste",
"url": "categoria-de-teste",
"categoria_pai": "C001",
"menu_principal": true,
"cor_fundo": "#000000",
"descricao": "Categoria de teste",
"marketplace": {
"skyhub": true
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total de categorias cadastrados,"
},
"per_page": {
"type": "number",
"description": "Quantidade de registros retornados na consulta atual,"
},
"current_page": {
"type": "number",
"description": "Página atual,"
},
"last_page": {
"type": "number",
"description": "Última página,"
},
"data": {
"type": "array",
"description": "Lista de categorias selecionados"
}
},
"required": [
"total",
"per_page",
"current_page",
"last_page",
"data"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Listar CategoriasGET/categorias{?per_page}&{?page}&{?sort}
Recupera uma lista de categorias cadastrados na loja.
URI Parameters
- per_page
number(optional) Example: 10Quantidade de registros a serem retornados por página (Obs.: máximo de 50 registros)
- page
number(optional) Example: 0Página a ser retornada
- sort
string(optional) Example: id,descOrdenação dos dados a serem retornados
GET https://api.minhaloja.com.br/categorias/C001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"codigo_referencia": "C002",
"nome": "Categoria de Teste",
"url": "categoria-de-teste",
"categoria_pai": "C001",
"menu_principal": true,
"cor_fundo": "#000000",
"descricao": "Categoria de teste",
"marketplace": {
"skyhub": true
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"codigo_referencia": {
"type": "string",
"description": "Código de referência da categoria. Será usado para criar o vinculo entre a categoria na loja e o seu sistema."
},
"nome": {
"type": "string",
"description": "Nome da categoria."
},
"url": {
"type": "string",
"description": "URL da categoria."
},
"categoria_pai": {
"type": "string",
"description": "Código de referência da categoria pai."
},
"menu_principal": {
"type": "boolean",
"description": "Informa se a categoria ficará visível no menu principal"
},
"cor_fundo": {
"type": "string",
"description": "Cor de fundo da categoria."
},
"descricao": {
"type": "string",
"description": "Descrição da categoria."
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
}
},
"required": [
"codigo_referencia",
"nome"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Receber categoriaGET/categorias/{codigo_referencia}
Recupera uma categoria cadastrada na loja com base no código de referência.
URI Parameters
- codigo_referencia
string(required) Example: C001Código de referência da categoria
POST https://api.minhaloja.com.br/categorias
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"codigo_referencia": "C002",
"nome": "Categoria de Teste",
"url": "categoria-de-teste",
"categoria_pai": "C001",
"menu_principal": true,
"cor_fundo": "#000000",
"descricao": "Categoria de teste",
"marketplace": {
"skyhub": true
}
}Schema
{
"type": "object",
"properties": {
"codigo_referencia": {
"type": "string",
"description": "Código de referência da categoria. Será usado para criar o vinculo entre a categoria na loja e o seu sistema."
},
"nome": {
"type": "string",
"description": "Nome da categoria."
},
"url": {
"type": "string",
"description": "URL da categoria."
},
"categoria_pai": {
"type": "string",
"description": "Código de referência da categoria pai."
},
"menu_principal": {
"type": "boolean",
"description": "Informa se a categoria ficará visível no menu principal"
},
"cor_fundo": {
"type": "string",
"description": "Cor de fundo da categoria."
},
"descricao": {
"type": "string",
"description": "Descrição da categoria."
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
}
},
"required": [
"codigo_referencia",
"nome"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Criar categoriaPOST/categorias
Cria uma nova categoria na loja. Caso seja uma sub-categoria, basta informar o código da categoria pai no campo categoria_pai.
PUT https://api.minhaloja.com.br/categorias/C001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"nome": "Eletrônicos",
"url": "categoria-de-teste",
"categoria_pai": "C001",
"menu_principal": true,
"cor_fundo": "#000000",
"descricao": "Eletrônicos",
"marketplace": {
"skyhub": true
}
}Schema
{
"type": "object",
"properties": {
"nome": {
"type": "string",
"description": "Nome da categoria."
},
"url": {
"type": "string",
"description": "URL da categoria."
},
"categoria_pai": {
"type": "string",
"description": "Código de referência da categoria pai."
},
"menu_principal": {
"type": "boolean",
"description": "Informa se a categoria ficará visível no menu principal"
},
"cor_fundo": {
"type": "string",
"description": "Cor de fundo da categoria."
},
"descricao": {
"type": "string",
"description": "Descrição da categoria."
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar categoriaPUT/categorias/{codigo_referencia}
Atualiza uma categoria ja cadastrada na loja.
URI Parameters
- codigo_referencia
string(required) Example: C001Código de referência da categoria
DELETE https://api.minhaloja.com.br/categorias/C001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Excluir categoriaDELETE/categorias/{codigo_referencia}
Exclui uma categoria da loja.
URI Parameters
- codigo_referencia
string(required) Example: C001Código de referência da categoria
Marcas ¶
É possível criar, editar e excluir as marcas cadastradas na loja.
Cada marca deve possuir no mínimo um nome e um código de referência, e opcionalmente uma URL com a imagem da logo da marca.
OBSERVAÇÃO:
As imagens devem estar no formato .JPG ou .PNG, e possuir dimensao máxima de 800x800 ou inferior porém na mesma proporção (Ex: 400x400, 600x600).
O servidor onde essas imagens estarão hospedadas, deve estar com as permissões de leitura ativadas, para que o sistema possa realizar o download das imagens.
Marca ¶
GET https://api.minhaloja.com.br/marcas/M001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"codigo_referencia": "M001",
"nome": "Marca de Teste"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"codigo_referencia": {
"type": "string",
"description": "Código de referência da marca."
},
"nome": {
"type": "string",
"description": "Nome da marca."
}
},
"required": [
"codigo_referencia",
"nome"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Receber marcaGET/marcas/{codigo_referencia}
Recupera uma marca cadastrada na loja com base no código de referência.
URI Parameters
- codigo_referencia
string(required) Example: M001Código de referência da marca
POST https://api.minhaloja.com.br/marcas
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"codigo_referencia": "M001",
"nome": "Marca de Teste",
"imagem": "http://imagem.com.br/marca.jpg"
}Schema
{
"type": "object",
"properties": {
"codigo_referencia": {
"type": "string",
"description": "Código de referência da marca. Será usado para criar o vinculo entre a marca na loja e o seu sistema."
},
"nome": {
"type": "string",
"description": "Nome da marca."
},
"imagem": {
"type": "string",
"description": "URL da com a imagem da marca."
}
},
"required": [
"codigo_referencia",
"nome"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Criar marcaPOST/marcas
Cria uma nova marca na loja.
PUT https://api.minhaloja.com.br/marcas/M001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"nome": "Marca de Teste",
"imagem": "http://imagem.com.br/marca.jpg"
}Schema
{
"type": "object",
"properties": {
"nome": {
"type": "string",
"description": "Nome da marca."
},
"imagem": {
"type": "string",
"description": "URL da com a imagem da marca."
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar marcaPUT/marcas/{codigo_referencia}
Atualiza uma marca ja cadastrada na loja.
URI Parameters
- codigo_referencia
string(required) Example: M001Código de referência da marca
DELETE https://api.minhaloja.com.br/marcas/M001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Excluir marcaDELETE/marcas/{codigo_referencia}
Exclui uma marca da loja.
URI Parameters
- codigo_referencia
string(required) Example: M001Código de referência da marca
Caracteristicas ¶
As caracteristicas são utilizadas para distinguir variações de um mesmo produto, e são separadas em dois grupos:
-
Caracteristica Vertical: Caracteristica de maior impacto no produto, por exemplo Cor, Sabor.
-
Caracteristica Horizontal: Caracteristica de menor impacto no produto, por exemplo Tamanho, Voltagem.
Uma vez que a caracteristica é cadastrada, não é possível alterar o grupo ao qual ela pertence.
Cada caracteristica é composta de um ou mais valores, por exemplo Cor (Vermelha, Azul, Amarela, etc).
Tabela de tipos de caracteristicas
| Valor | Descrição |
|---|---|
| 1 | Caracteristica Vertical |
| 2 | Caracteristica Horizontal |
| 3 | Caracteristica Simples |
Tabela de status dos marketplaces
| Valor | Descrição |
|---|---|
| true | Integração com marketplace habilitada |
| false | Integração com marketplace desabilitada |
Caracteristica ¶
GET https://api.minhaloja.com.br/caracteristicas/C001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"codigo_referencia": "C001",
"nome": "Cor",
"tipo": 1,
"exibir_menu_lateral": true,
"exibir_ficha_tecnica": true,
"valores": [
"Azul",
"Amarelo",
"Vermelho"
],
"marketplace": {
"skyhub": true
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"codigo_referencia": {
"type": "string",
"description": "Código de referência da caracteristica"
},
"nome": {
"type": "string",
"description": "Nome da caracteristica"
},
"tipo": {
"type": "number",
"description": "Informa se é uma caracteristica vertical ou horizontal"
},
"exibir_menu_lateral": {
"type": "boolean",
"description": "Informa se a característica será exibida no menu lateral na página de busca"
},
"exibir_ficha_tecnica": {
"type": "boolean",
"description": "Informa se a característica será exibida na ficha técnica do produto"
},
"valores": {
"type": "array",
"description": "Conjunto de possiveis valores da caracteristica"
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
}
},
"required": [
"codigo_referencia",
"nome",
"tipo",
"valores"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Receber caracteristicaGET/caracteristicas/{codigo_referencia}
Recupera uma caracteristica cadastrada na loja com base no código de referência.
URI Parameters
- codigo_referencia
string(required) Example: C001Código de referência da caracteristica
POST https://api.minhaloja.com.br/caracteristicas
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"codigo_referencia": "C001",
"nome": "Cor",
"tipo": 1,
"exibir_menu_lateral": true,
"exibir_ficha_tecnica": true,
"valores": [
"Azul",
"Amarelo",
"Vermelho"
],
"marketplace": {
"skyhub": true
}
}Schema
{
"type": "object",
"properties": {
"codigo_referencia": {
"type": "string",
"description": "Código de referência da caracteristica"
},
"nome": {
"type": "string",
"description": "Nome da caracteristica"
},
"tipo": {
"type": "number",
"description": "Informa se é uma caracteristica vertical ou horizontal"
},
"exibir_menu_lateral": {
"type": "boolean",
"description": "Informa se a característica será exibida no menu lateral na página de busca"
},
"exibir_ficha_tecnica": {
"type": "boolean",
"description": "Informa se a característica será exibida na ficha técnica do produto"
},
"valores": {
"type": "array",
"items": {
"type": "string"
},
"description": "Conjunto de possiveis valores da caracteristica"
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
}
},
"required": [
"codigo_referencia",
"nome",
"tipo",
"valores"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Criar caracteristicaPOST/caracteristicas
Cria uma nova caracteristica de produto na loja.
PUT https://api.minhaloja.com.br/caracteristicas/C001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"nome": "Cor",
"exibir_menu_lateral": true,
"exibir_ficha_tecnica": true,
"valores": [
"Azul",
"Amarelo",
"Vermelho"
],
"marketplace": {
"skyhub": true
}
}Schema
{
"type": "object",
"properties": {
"nome": {
"type": "string",
"description": "Nome da caracteristica"
},
"exibir_menu_lateral": {
"type": "boolean",
"description": "Informa se a característica será exibida no menu lateral na página de busca"
},
"exibir_ficha_tecnica": {
"type": "boolean",
"description": "Informa se a característica será exibida na ficha técnica do produto"
},
"valores": {
"type": "array",
"items": {
"type": "string"
},
"description": "Conjunto de possiveis valores da caracteristica"
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar caracteristicaPUT/caracteristicas/{codigo_referencia}
Atualiza uma caracteristica ja cadastrada na loja.
URI Parameters
- codigo_referencia
string(required) Example: C001Código de referência da caracteristica
DELETE https://api.minhaloja.com.br/caracteristicas/C001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Excluir caracteristicaDELETE/caracteristicas/{codigo_referencia}
Exclui uma caracteristica da loja.
URI Parameters
- codigo_referencia
string(required) Example: C001Código de referência da caracteristica
Produtos ¶
A loja atualmente trabalha com dois tipos de produtos:
-
Produto Simples: Não possui variação. Pode ou não possuir caracteristicas e especificacoes.
-
Produto Composto: Possui uma ou mais variações. Obrigatóriamente deve possuir caracteristicas.
O produto pode ou não possuir caracteristicas, estas são utilizadas em diversas etapas, como nas opções de filtragem da busca e nas integrações com os marketplaces. É possível cadastrar um produto sem nenhuma caracteristica, porém isto impactará diretamante as áreas citadas acima.
ATENÇÃO
Uma vez que o produto seja cadastrado como Produto Simples, não sera possível vincular variações no mesmo posteriormente, sendo assim recomendamos que o mesmo seja cadastrado como Produto Composto sempre que possuir caracteristicas.
Caso o produto possua variações, e estas variações possuam caracteristicas verticais, é possivel criar uma galeria individual para essa característica. Por exemplo, caso o produto possua variação de Cor, é possivel ter uma galeria para a cor Azul e outra para a cor Vermelha, porém esta funcionalidade não esta disponível para uma caracteristica horizontal, por exemplo caso o produto possua variação de Tamanho, os tamanhos não possuiram galeria individual. Um exemplo prático seria um produto que possui variação de Cor e Tamanho, desta forma o produto Vermelho-G tera a mesma galeria que o produto Vermelho-M.
Tabela de Tipos do Produto
| Valor | Descrição |
|---|---|
| SIMPLES | Produto que não possui variações |
| COMPOSTO | Produto que possui uma ou mais variações |
Tabela de Status do Produto
| Valor | Descrição |
|---|---|
| ATIVO | Produto ativo na loja |
| INATIVO | Produto inativo na loja |
Produto ¶
GET https://api.minhaloja.com.br/produtos?per_page=10&?page=0&?sort=id,desc
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"total": 10,
"per_page": 10,
"current_page": 0,
"last_page": 5,
"data": [
{
"sku": "P001",
"tipo": "COMPOSTO",
"status": "ATIVO",
"entrega_digital": "ATIVA",
"exibir_preco": "ATIVO",
"sob_consulta": false,
"tempo_preparacao": 2,
"garantia": 30,
"nome": "Produto de exemplo",
"seo_descricao": "Descrição de teste do produto",
"seo_keywords": "Palavras chave utilizadas na busca interna do site e na busca orgânica dos buscadores.",
"informacoes_importantes": "Informações importantes sobre o produto.",
"marca": "M001",
"categorias": [
"C001",
"C002"
],
"quantidade_estoque": 100,
"quantidade_minima_estoque": 5,
"codigo_ean": "000000",
"codigo_nbm": "000000",
"codigo_ncm": "000000",
"codigo_isbn": "000000",
"peso_unidade": "500g por unidade",
"genero": "Masculino",
"faixa_etaria": "Infantil",
"descricao": "Descrição de teste",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"caracteristica_vertical": "C001",
"caracteristica_horizontal": "C002",
"especificacoes": [
{
"caracteristica": "C001",
"valor": "Azul"
}
],
"caracteristica_simples": [
{
"caracteristica": "garantia-em-meses",
"valor": "3 Meses"
}
],
"ficha_tecnica": [
{
"caracteristica": "Fabricante",
"valor": "Ambev"
}
],
"imagens": [
"http://imagem.com.br/produto1.jpg",
"http://imagem.com.br/produto2.jpg",
"http://imagem.com.br/produto3.jpg"
],
"variacoes": [
{
"sku": "P0002",
"nome_personalizado": "Produto de exemplo",
"tempo_preparacao": 2,
"garantia": 30,
"quantidade_estoque": 100,
"codigo_ean": "00000",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"especificacoes": [
{
"caracteristica": "C001",
"valor": "Azul"
}
],
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
}
}
],
"imagens_caracteristica": [
{
"caracteristica": "C001",
"valor": "Azul",
"imagens": [
"http://imagem.com.br/produto-azul1.jpg",
"http://imagem.com.br/produto-azul2.jpg",
"http://imagem.com.br/produto-azuls3.jpg"
]
}
],
"marketplace": {
"skyhub": true
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
},
"configuracoes": {
"medicamento": true,
"tarjaPreta": true,
"tarjaVermelha": true,
"sedacao": true,
"prescricaoMedica": false,
"generico": true,
"controleEspecial": true,
"acidoAcetilsalicilico": true,
"acidoAscorbico": true,
"bicarbonatoSodio": false,
"bisacodil": true,
"canfora": true,
"carbonatoCalcio": true,
"carvaoVegetal": true,
"cloridratoAmbroxol": false,
"cloridratoFenilefrina": true,
"dipironaSodica": true,
"dropropizina": true,
"hidroxidoAluminio": true,
"hidroxidoMagnesio": false,
"ibuprofeno": true,
"mebendazol": true,
"naproxeno": true,
"nicotina": false,
"paracetamol": false,
"picossulfatoSodio": true,
"plantagoOvataForsk": true,
"sulfatoFerroso": false,
"manipulado": false,
"codigoAuxiliar": "124654"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total de produtos cadastrados"
},
"per_page": {
"type": "number",
"description": "Quantidade de registros retornados na consulta atual"
},
"current_page": {
"type": "number",
"description": "Página atual"
},
"last_page": {
"type": "number",
"description": "Última página"
},
"data": {
"type": "array",
"description": "Lista de produtos selecionados"
}
},
"required": [
"total",
"per_page",
"current_page",
"last_page",
"data"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Listar produtosGET/produtos{?per_page}&{?page}&{?sort}
Recupera uma lista de produtos cadastrados na loja.
URI Parameters
- per_page
number(optional) Example: 10Quantidade de registros a serem retornados por página (Obs.: máximo de 50 registros)
- page
number(optional) Example: 0Página a ser retornada
- sort
string(optional) Example: id,descOrdenação dos dados a serem retornados
GET https://api.minhaloja.com.br/produtos/P0001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"sku": "P001",
"tipo": "COMPOSTO",
"status": "ATIVO",
"entrega_digital": "ATIVA",
"exibir_preco": "ATIVO",
"sob_consulta": false,
"tempo_preparacao": 2,
"garantia": 30,
"nome": "Produto de exemplo",
"seo_descricao": "Descrição de teste do produto",
"seo_keywords": "Palavras chave utilizadas na busca interna do site e na busca orgânica dos buscadores.",
"informacoes_importantes": "Informações importantes sobre o produto.",
"marca": "M001",
"categorias": [
"C001",
"C002"
],
"quantidade_estoque": 100,
"quantidade_minima_estoque": 5,
"codigo_ean": "000000",
"codigo_nbm": "000000",
"codigo_ncm": "000000",
"codigo_isbn": "000000",
"peso_unidade": "500g por unidade",
"genero": "Masculino",
"faixa_etaria": "Infantil",
"descricao": "Descrição de teste",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"caracteristica_vertical": "C001",
"caracteristica_horizontal": "C002",
"especificacoes": [
{
"caracteristica": "C001",
"valor": "Azul"
}
],
"caracteristica_simples": [
{
"caracteristica": "garantia-em-meses",
"valor": "3 Meses"
}
],
"ficha_tecnica": [
{
"caracteristica": "Fabricante",
"valor": "Ambev"
}
],
"imagens": [
"http://imagem.com.br/produto1.jpg",
"http://imagem.com.br/produto2.jpg",
"http://imagem.com.br/produto3.jpg"
],
"variacoes": [
{
"sku": "P0002",
"nome_personalizado": "Produto de exemplo",
"tempo_preparacao": 2,
"garantia": 30,
"quantidade_estoque": 100,
"codigo_ean": "00000",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"especificacoes": [
{
"caracteristica": "C001",
"valor": "Azul"
}
],
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
}
}
],
"imagens_caracteristica": [
{
"caracteristica": "C001",
"valor": "Azul",
"imagens": [
"http://imagem.com.br/produto-azul1.jpg",
"http://imagem.com.br/produto-azul2.jpg",
"http://imagem.com.br/produto-azuls3.jpg"
]
}
],
"marketplace": {
"skyhub": true
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
},
"configuracoes": {
"medicamento": true,
"tarjaPreta": true,
"tarjaVermelha": true,
"sedacao": true,
"prescricaoMedica": false,
"generico": true,
"controleEspecial": true,
"acidoAcetilsalicilico": true,
"acidoAscorbico": true,
"bicarbonatoSodio": false,
"bisacodil": true,
"canfora": true,
"carbonatoCalcio": true,
"carvaoVegetal": true,
"cloridratoAmbroxol": false,
"cloridratoFenilefrina": true,
"dipironaSodica": true,
"dropropizina": true,
"hidroxidoAluminio": true,
"hidroxidoMagnesio": false,
"ibuprofeno": true,
"mebendazol": true,
"naproxeno": true,
"nicotina": false,
"paracetamol": false,
"picossulfatoSodio": true,
"plantagoOvataForsk": true,
"sulfatoFerroso": false,
"manipulado": false,
"codigoAuxiliar": "124654"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU do produto."
},
"tipo": {
"type": "string",
"description": "Código do tipo de produto."
},
"status": {
"type": "string",
"description": "Informa se o produto estará ativo ou não."
},
"entrega_digital": {
"type": "string",
"description": "Informa se a entrega será combinada com o comprador."
},
"exibir_preco": {
"type": "string",
"description": "Informa se a precificação do produto será exibida no e-commerce."
},
"sob_consulta": {
"type": "boolean",
"description": "Informa se o produto estará disponível no e-commerce apenas sob consulta."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"nome": {
"type": "string",
"description": "Nome do produto."
},
"seo_descricao": {
"type": "string",
"description": "Descrição do produto otimizada para SEO."
},
"seo_keywords": {
"type": "string"
},
"informacoes_importantes": {
"type": "string"
},
"marca": {
"type": "string",
"description": "Código de referência da marca do produto."
},
"categorias": {
"type": "array",
"description": "Categorias do produto."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque do produto."
},
"quantidade_minima_estoque": {
"type": "number",
"description": "Quantidade minima que o estoque deve possuir. Quando o estoque atingir esta quantidade, um alerta sera enviado para o administrador."
},
"codigo_ean": {
"type": "string",
"description": "Código EAN do produto"
},
"codigo_nbm": {
"type": "string",
"description": "Código NBM do produto"
},
"codigo_ncm": {
"type": "string",
"description": "Código NCM do produto"
},
"codigo_isbn": {
"type": "string",
"description": "Código ISBN do produto"
},
"peso_unidade": {
"type": "string",
"description": "Informação de peso por unidade"
},
"genero": {
"type": "string",
"description": "Gênero do público do produto (Masculino, Feminino ou Unissex)"
},
"faixa_etaria": {
"type": "string",
"description": "Faixa etária do público do produto (Recém-nascido, 3 a 12 meses, 1 a 5 anos, Infantil, Para adultos)"
},
"descricao": {
"type": "string",
"description": "Descrição detalhada do produto. Este campo aceita tags HTML"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) do produto"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto para marketplaces"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) do produto"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) do produto"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) do produto"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) do produto"
}
},
"required": [
"peso",
"altura",
"largura",
"comprimento"
],
"description": "Dimensões e peso do produto, esses dados seram utilizados para calculo do frete"
},
"caracteristica_vertical": {
"type": "string",
"description": "Código de referência da caracteristica vertical do produto (Ex: Cor, Sabor)"
},
"caracteristica_horizontal": {
"type": "string",
"description": "Código de referência da caracteristica horizontal do produto (Ex: Tamanho, Voltagem)"
},
"especificacoes": {
"type": "array",
"description": "Especificações do produto com as caracteristicas e valores"
},
"caracteristica_simples": {
"type": "array",
"description": "Característica Simples do produto com as caracteristicas e valores"
},
"ficha_tecnica": {
"type": "array",
"description": "Itens da ficha técnica do produto"
},
"imagens": {
"type": "array",
"description": "Imagens da galeria do produto. A primeira imagem será considerada como a imagem principal do produto."
},
"variacoes": {
"type": "array",
"description": "Variações do produto. Atributo obrigatório caso seja um produto composto."
},
"imagens_caracteristica": {
"type": "array",
"description": "Galeria de imagens da caracteristica vertical do produto"
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto\n\nRegraQuantidadeMaxima"
},
"configuracoes": {
"type": "object",
"properties": {
"medicamento": {
"type": "boolean",
"description": "É medicamento?"
},
"tarjaPreta": {
"type": "boolean",
"description": "É tarja preta?"
},
"tarjaVermelha": {
"type": "boolean",
"description": "É tarja vermelha?"
},
"sedacao": {
"type": "boolean",
"description": "É medicamento que apresentar efeitos de sedação e/ou sonolência?"
},
"prescricaoMedica": {
"type": "boolean",
"description": "É vendido sob prescrição médica?"
},
"generico": {
"type": "boolean",
"description": "É medicamento genérico?"
},
"controleEspecial": {
"type": "boolean",
"description": "Controle especial (psicotrópicos e antimicrobianos)?"
},
"acidoAcetilsalicilico": {
"type": "boolean",
"description": "Ácido Acetilsalicílico?"
},
"acidoAscorbico": {
"type": "boolean",
"description": "Ácido Ascórbico (vitamina C)?"
},
"bicarbonatoSodio": {
"type": "boolean",
"description": "Bicarbonato de Sódio?"
},
"bisacodil": {
"type": "boolean",
"description": "Bisacodil?"
},
"canfora": {
"type": "boolean",
"description": "Cânfora?"
},
"carbonatoCalcio": {
"type": "boolean",
"description": "Carbonato de Cálcio?"
},
"carvaoVegetal": {
"type": "boolean",
"description": "Carvão Vegetal?"
},
"cloridratoAmbroxol": {
"type": "boolean",
"description": "Cloridrato de Ambroxol?"
},
"cloridratoFenilefrina": {
"type": "boolean",
"description": "Cloridrato de Fenilefrina?"
},
"dipironaSodica": {
"type": "boolean",
"description": "Dipirona Sódica?"
},
"dropropizina": {
"type": "boolean",
"description": "Dropropizina?"
},
"hidroxidoAluminio": {
"type": "boolean",
"description": "Hidróxido de Alumínio?"
},
"hidroxidoMagnesio": {
"type": "boolean",
"description": "Hidróxido de Magnésio?"
},
"ibuprofeno": {
"type": "boolean",
"description": "Ibuprofeno?"
},
"mebendazol": {
"type": "boolean",
"description": "Mebendazol?"
},
"naproxeno": {
"type": "boolean",
"description": "Naproxeno?"
},
"nicotina": {
"type": "boolean",
"description": "Nicotina?"
},
"paracetamol": {
"type": "boolean",
"description": "Paracetamol?"
},
"picossulfatoSodio": {
"type": "boolean",
"description": "Picossulfato de Sódio?"
},
"plantagoOvataForsk": {
"type": "boolean",
"description": "Plantago Ovata Forsk?"
},
"sulfatoFerroso": {
"type": "boolean",
"description": "Sulfato Ferroso?"
},
"manipulado": {
"type": "boolean",
"description": "É manipulado?"
},
"codigoAuxiliar": {
"type": "string",
"description": "Código Auxiliar"
}
},
"required": [
"medicamento",
"tarjaPreta",
"tarjaVermelha",
"sedacao",
"prescricaoMedica",
"generico",
"controleEspecial",
"acidoAcetilsalicilico",
"acidoAscorbico",
"bicarbonatoSodio",
"bisacodil",
"canfora",
"carbonatoCalcio",
"carvaoVegetal",
"cloridratoAmbroxol",
"cloridratoFenilefrina",
"dipironaSodica",
"dropropizina",
"hidroxidoAluminio",
"hidroxidoMagnesio",
"ibuprofeno",
"mebendazol",
"naproxeno",
"nicotina",
"paracetamol",
"picossulfatoSodio",
"plantagoOvataForsk",
"sulfatoFerroso",
"manipulado",
"codigoAuxiliar"
],
"description": "Configurações para medicamento"
}
},
"required": [
"sku",
"tipo",
"status",
"nome",
"precificacao"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Receber produtoGET/produtos/{sku}
Recupera um produto cadastrado na loja com base no sku.
URI Parameters
- sku
string(required) Example: P0001Código SKU do produto
POST https://api.minhaloja.com.br/produtos
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"sku": "P001",
"tipo": "SIMPLES",
"status": "ATIVO",
"entrega_digital": "ATIVA",
"exibir_preco": "ATIVO",
"sob_consulta": false,
"tempo_preparacao": 2,
"garantia": 30,
"nome": "Produto de exemplo",
"seo_descricao": "Descrição de teste do produto",
"seo_keywords": "Palavras chave utilizadas na busca interna do site e na busca orgânica dos buscadores.",
"informacoes_importantes": "Informações importantes sobre o produto.",
"marca": "M001",
"categorias": [
"C001",
"C002"
],
"quantidade_estoque": 100,
"quantidade_minima_estoque": 5,
"codigo_ean": "000000",
"codigo_nbm": "000000",
"codigo_ncm": "000000",
"codigo_isbn": "000000",
"peso_unidade": "500g por unidade",
"genero": "Masculino",
"faixa_etaria": "Infantil",
"descricao": "Descrição de teste",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"caracteristica_vertical": "C001",
"caracteristica_horizontal": "C002",
"especificacoes": [
{
"caracteristica": "C001",
"valor": "Azul"
}
],
"caracteristica_simples": [
{
"caracteristica": "garantia-em-meses",
"valor": "3 Meses"
}
],
"ficha_tecnica": [
{
"caracteristica": "Fabricante",
"valor": "Ambev"
}
],
"imagens": [
"http://imagem.com.br/produto1.jpg",
"http://imagem.com.br/produto2.jpg",
"http://imagem.com.br/produto3.jpg"
],
"marketplace": {
"skyhub": true
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
},
"configuracoes": {
"medicamento": true,
"tarjaPreta": true,
"tarjaVermelha": true,
"sedacao": true,
"prescricaoMedica": false,
"generico": true,
"controleEspecial": true,
"acidoAcetilsalicilico": true,
"acidoAscorbico": true,
"bicarbonatoSodio": false,
"bisacodil": true,
"canfora": true,
"carbonatoCalcio": true,
"carvaoVegetal": true,
"cloridratoAmbroxol": false,
"cloridratoFenilefrina": true,
"dipironaSodica": true,
"dropropizina": true,
"hidroxidoAluminio": true,
"hidroxidoMagnesio": false,
"ibuprofeno": true,
"mebendazol": true,
"naproxeno": true,
"nicotina": false,
"paracetamol": false,
"picossulfatoSodio": true,
"plantagoOvataForsk": true,
"sulfatoFerroso": false,
"manipulado": false,
"codigoAuxiliar": "124654"
}
}Schema
{
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU do produto."
},
"tipo": {
"type": "string",
"description": "Código do tipo de produto."
},
"status": {
"type": "string",
"description": "Informa se o produto estará ativo ou não."
},
"entrega_digital": {
"type": "string",
"description": "Informa se a entrega será combinada com o comprador."
},
"exibir_preco": {
"type": "string",
"description": "Informa se a precificação do produto será exibida no e-commerce."
},
"sob_consulta": {
"type": "boolean",
"description": "Informa se o produto estará disponível no e-commerce apenas sob consulta."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"nome": {
"type": "string",
"description": "Nome do produto."
},
"seo_descricao": {
"type": "string",
"description": "Descrição do produto otimizada para SEO."
},
"seo_keywords": {
"type": "string"
},
"informacoes_importantes": {
"type": "string"
},
"marca": {
"type": "string",
"description": "Código de referência da marca do produto."
},
"categorias": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categorias do produto."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque do produto."
},
"quantidade_minima_estoque": {
"type": "number",
"description": "Quantidade minima que o estoque deve possuir. Quando o estoque atingir esta quantidade, um alerta sera enviado para o administrador."
},
"codigo_ean": {
"type": "string",
"description": "Código EAN do produto"
},
"codigo_nbm": {
"type": "string",
"description": "Código NBM do produto"
},
"codigo_ncm": {
"type": "string",
"description": "Código NCM do produto"
},
"codigo_isbn": {
"type": "string",
"description": "Código ISBN do produto"
},
"peso_unidade": {
"type": "string",
"description": "Informação de peso por unidade"
},
"genero": {
"type": "string",
"description": "Gênero do público do produto (Masculino, Feminino ou Unissex)"
},
"faixa_etaria": {
"type": "string",
"description": "Faixa etária do público do produto (Recém-nascido, 3 a 12 meses, 1 a 5 anos, Infantil, Para adultos)"
},
"descricao": {
"type": "string",
"description": "Descrição detalhada do produto. Este campo aceita tags HTML"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) do produto"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto para marketplaces"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) do produto"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) do produto"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) do produto"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) do produto"
}
},
"required": [
"peso",
"altura",
"largura",
"comprimento"
],
"description": "Dimensões e peso do produto, esses dados seram utilizados para calculo do frete"
},
"caracteristica_vertical": {
"type": "string",
"description": "Código de referência da caracteristica vertical do produto (Ex: Cor, Sabor)"
},
"caracteristica_horizontal": {
"type": "string",
"description": "Código de referência da caracteristica horizontal do produto (Ex: Tamanho, Voltagem)"
},
"especificacoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Código de referência do tipo de caracteristica da especificação"
},
"valor": {
"type": "string",
"description": "Valor da caracteristica do produto"
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Especificações do produto com as caracteristicas e valores"
},
"caracteristica_simples": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Código de referência do tipo de caracteristica da especificação"
},
"valor": {
"type": "string",
"description": "Valor da caracteristica do produto"
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Característica Simples do produto com as caracteristicas e valores"
},
"ficha_tecnica": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Título do item da ficha técnica"
},
"valor": {
"type": "string",
"description": "Valor do item da ficha técnica"
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Itens da ficha técnica do produto"
},
"imagens": {
"type": "array",
"items": {
"type": "string"
},
"description": "Imagens da galeria do produto. A primeira imagem será considerada como a imagem principal do produto."
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
},
"configuracoes": {
"type": "object",
"properties": {
"medicamento": {
"type": "boolean",
"description": "É medicamento?"
},
"tarjaPreta": {
"type": "boolean",
"description": "É tarja preta?"
},
"tarjaVermelha": {
"type": "boolean",
"description": "É tarja vermelha?"
},
"sedacao": {
"type": "boolean",
"description": "É medicamento que apresentar efeitos de sedação e/ou sonolência?"
},
"prescricaoMedica": {
"type": "boolean",
"description": "É vendido sob prescrição médica?"
},
"generico": {
"type": "boolean",
"description": "É medicamento genérico?"
},
"controleEspecial": {
"type": "boolean",
"description": "Controle especial (psicotrópicos e antimicrobianos)?"
},
"acidoAcetilsalicilico": {
"type": "boolean",
"description": "Ácido Acetilsalicílico?"
},
"acidoAscorbico": {
"type": "boolean",
"description": "Ácido Ascórbico (vitamina C)?"
},
"bicarbonatoSodio": {
"type": "boolean",
"description": "Bicarbonato de Sódio?"
},
"bisacodil": {
"type": "boolean",
"description": "Bisacodil?"
},
"canfora": {
"type": "boolean",
"description": "Cânfora?"
},
"carbonatoCalcio": {
"type": "boolean",
"description": "Carbonato de Cálcio?"
},
"carvaoVegetal": {
"type": "boolean",
"description": "Carvão Vegetal?"
},
"cloridratoAmbroxol": {
"type": "boolean",
"description": "Cloridrato de Ambroxol?"
},
"cloridratoFenilefrina": {
"type": "boolean",
"description": "Cloridrato de Fenilefrina?"
},
"dipironaSodica": {
"type": "boolean",
"description": "Dipirona Sódica?"
},
"dropropizina": {
"type": "boolean",
"description": "Dropropizina?"
},
"hidroxidoAluminio": {
"type": "boolean",
"description": "Hidróxido de Alumínio?"
},
"hidroxidoMagnesio": {
"type": "boolean",
"description": "Hidróxido de Magnésio?"
},
"ibuprofeno": {
"type": "boolean",
"description": "Ibuprofeno?"
},
"mebendazol": {
"type": "boolean",
"description": "Mebendazol?"
},
"naproxeno": {
"type": "boolean",
"description": "Naproxeno?"
},
"nicotina": {
"type": "boolean",
"description": "Nicotina?"
},
"paracetamol": {
"type": "boolean",
"description": "Paracetamol?"
},
"picossulfatoSodio": {
"type": "boolean",
"description": "Picossulfato de Sódio?"
},
"plantagoOvataForsk": {
"type": "boolean",
"description": "Plantago Ovata Forsk?"
},
"sulfatoFerroso": {
"type": "boolean",
"description": "Sulfato Ferroso?"
},
"manipulado": {
"type": "boolean",
"description": "É manipulado?"
},
"codigoAuxiliar": {
"type": "string",
"description": "Código Auxiliar"
}
},
"required": [
"medicamento",
"tarjaPreta",
"tarjaVermelha",
"sedacao",
"prescricaoMedica",
"generico",
"controleEspecial",
"acidoAcetilsalicilico",
"acidoAscorbico",
"bicarbonatoSodio",
"bisacodil",
"canfora",
"carbonatoCalcio",
"carvaoVegetal",
"cloridratoAmbroxol",
"cloridratoFenilefrina",
"dipironaSodica",
"dropropizina",
"hidroxidoAluminio",
"hidroxidoMagnesio",
"ibuprofeno",
"mebendazol",
"naproxeno",
"nicotina",
"paracetamol",
"picossulfatoSodio",
"plantagoOvataForsk",
"sulfatoFerroso",
"manipulado",
"codigoAuxiliar"
],
"description": "Configurações para medicamento"
}
},
"required": [
"sku",
"tipo",
"nome",
"precificacao"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"sku": "P001",
"tipo": "COMPOSTO",
"status": "ATIVO",
"entrega_digital": "ATIVA",
"exibir_preco": "ATIVO",
"sob_consulta": false,
"tempo_preparacao": 2,
"garantia": 30,
"nome": "Produto de exemplo",
"seo_descricao": "Descrição de teste do produto",
"seo_keywords": "Palavras chave utilizadas na busca interna do site e na busca orgânica dos buscadores.",
"informacoes_importantes": "Informações importantes sobre o produto.",
"marca": "M001",
"categorias": [
"C001",
"C002"
],
"quantidade_minima_estoque": 5,
"codigo_nbm": "000000",
"codigo_ncm": "000000",
"codigo_isbn": "000000",
"genero": "Masculino",
"faixa_etaria": "Infantil",
"descricao": "Descrição de teste",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"caracteristica_horizontal": "C002",
"imagens": [
"http://imagem.com.br/produto1.jpg",
"http://imagem.com.br/produto2.jpg",
"http://imagem.com.br/produto3.jpg"
],
"variacoes": [
{
"sku": "P0002",
"nome_personalizado": "Produto de exemplo",
"tempo_preparacao": 2,
"garantia": 30,
"quantidade_estoque": 100,
"codigo_ean": "00000",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"especificacoes": [
{
"caracteristica": "C001",
"valor": "Azul"
}
],
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
}
}
],
"marketplace": {
"skyhub": true
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
},
"configuracoes": {
"medicamento": true,
"tarjaPreta": true,
"tarjaVermelha": true,
"sedacao": true,
"prescricaoMedica": false,
"generico": true,
"controleEspecial": true,
"acidoAcetilsalicilico": true,
"acidoAscorbico": true,
"bicarbonatoSodio": false,
"bisacodil": true,
"canfora": true,
"carbonatoCalcio": true,
"carvaoVegetal": true,
"cloridratoAmbroxol": false,
"cloridratoFenilefrina": true,
"dipironaSodica": true,
"dropropizina": true,
"hidroxidoAluminio": true,
"hidroxidoMagnesio": false,
"ibuprofeno": true,
"mebendazol": true,
"naproxeno": true,
"nicotina": false,
"paracetamol": false,
"picossulfatoSodio": true,
"plantagoOvataForsk": true,
"sulfatoFerroso": false,
"manipulado": false,
"codigoAuxiliar": "124654"
}
}Schema
{
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU do produto."
},
"tipo": {
"type": "string",
"description": "Código do tipo de produto."
},
"status": {
"type": "string",
"description": "Informa se o produto estará ativo ou não."
},
"entrega_digital": {
"type": "string",
"description": "Informa se a entrega será combinada com o comprador."
},
"exibir_preco": {
"type": "string",
"description": "Informa se a precificação do produto será exibida no e-commerce."
},
"sob_consulta": {
"type": "boolean",
"description": "Informa se o produto estará disponível no e-commerce apenas sob consulta."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"nome": {
"type": "string",
"description": "Nome do produto."
},
"seo_descricao": {
"type": "string",
"description": "Descrição do produto otimizada para SEO."
},
"seo_keywords": {
"type": "string"
},
"informacoes_importantes": {
"type": "string"
},
"marca": {
"type": "string",
"description": "Código de referência da marca do produto."
},
"categorias": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categorias do produto."
},
"quantidade_minima_estoque": {
"type": "number",
"description": "Quantidade minima que o estoque deve possuir. Quando o estoque atingir esta quantidade, um alerta sera enviado para o administrador."
},
"codigo_nbm": {
"type": "string",
"description": "Código NBM do produto"
},
"codigo_ncm": {
"type": "string",
"description": "Código NCM do produto"
},
"codigo_isbn": {
"type": "string",
"description": "Código ISBN do produto"
},
"genero": {
"type": "string",
"description": "Gênero do público do produto (Masculino, Feminino ou Unissex)"
},
"faixa_etaria": {
"type": "string",
"description": "Faixa etária do público do produto (Recém-nascido, 3 a 12 meses, 1 a 5 anos, Infantil, Para adultos)"
},
"descricao": {
"type": "string",
"description": "Descrição detalhada do produto. Este campo aceita tags HTML"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) do produto"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto para marketplaces"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) do produto"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) do produto"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) do produto"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) do produto"
}
},
"required": [
"peso",
"altura",
"largura",
"comprimento"
],
"description": "Dimensões e peso do produto, esses dados seram utilizados para calculo do frete"
},
"caracteristica_horizontal": {
"type": "string",
"description": "Código de referência da caracteristica horizontal do produto (Ex: Tamanho, Voltagem)"
},
"imagens": {
"type": "array",
"items": {
"type": "string"
},
"description": "Imagens da galeria do produto. A primeira imagem será considerada como a imagem principal do produto."
},
"variacoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU da variação da variação"
},
"nome_personalizado": {
"type": "string",
"description": "Nome da variação (só está disponível para característica do tipo Vertical)."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque da variação"
},
"codigo_ean": {
"type": "string",
"description": "Código EAN da variação"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) da variação"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação para marketplaces"
},
"especificacoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Código de referência do tipo de caracteristica da especificação"
},
"valor": {
"type": "string",
"description": "Valor da caracteristica do produto"
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Especificações do produto com as caracteristicas e valores"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) da variação"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) da variação"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) da variação"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) da variação"
}
},
"description": "Dimensões e peso da variacao, esses dados seram utilizados para calculo do frete"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
}
},
"required": [
"sku",
"quantidade_estoque",
"especificacoes"
]
},
"description": "Variações do produto. Atributo obrigatório caso seja um produto composto."
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
},
"configuracoes": {
"type": "object",
"properties": {
"medicamento": {
"type": "boolean",
"description": "É medicamento?"
},
"tarjaPreta": {
"type": "boolean",
"description": "É tarja preta?"
},
"tarjaVermelha": {
"type": "boolean",
"description": "É tarja vermelha?"
},
"sedacao": {
"type": "boolean",
"description": "É medicamento que apresentar efeitos de sedação e/ou sonolência?"
},
"prescricaoMedica": {
"type": "boolean",
"description": "É vendido sob prescrição médica?"
},
"generico": {
"type": "boolean",
"description": "É medicamento genérico?"
},
"controleEspecial": {
"type": "boolean",
"description": "Controle especial (psicotrópicos e antimicrobianos)?"
},
"acidoAcetilsalicilico": {
"type": "boolean",
"description": "Ácido Acetilsalicílico?"
},
"acidoAscorbico": {
"type": "boolean",
"description": "Ácido Ascórbico (vitamina C)?"
},
"bicarbonatoSodio": {
"type": "boolean",
"description": "Bicarbonato de Sódio?"
},
"bisacodil": {
"type": "boolean",
"description": "Bisacodil?"
},
"canfora": {
"type": "boolean",
"description": "Cânfora?"
},
"carbonatoCalcio": {
"type": "boolean",
"description": "Carbonato de Cálcio?"
},
"carvaoVegetal": {
"type": "boolean",
"description": "Carvão Vegetal?"
},
"cloridratoAmbroxol": {
"type": "boolean",
"description": "Cloridrato de Ambroxol?"
},
"cloridratoFenilefrina": {
"type": "boolean",
"description": "Cloridrato de Fenilefrina?"
},
"dipironaSodica": {
"type": "boolean",
"description": "Dipirona Sódica?"
},
"dropropizina": {
"type": "boolean",
"description": "Dropropizina?"
},
"hidroxidoAluminio": {
"type": "boolean",
"description": "Hidróxido de Alumínio?"
},
"hidroxidoMagnesio": {
"type": "boolean",
"description": "Hidróxido de Magnésio?"
},
"ibuprofeno": {
"type": "boolean",
"description": "Ibuprofeno?"
},
"mebendazol": {
"type": "boolean",
"description": "Mebendazol?"
},
"naproxeno": {
"type": "boolean",
"description": "Naproxeno?"
},
"nicotina": {
"type": "boolean",
"description": "Nicotina?"
},
"paracetamol": {
"type": "boolean",
"description": "Paracetamol?"
},
"picossulfatoSodio": {
"type": "boolean",
"description": "Picossulfato de Sódio?"
},
"plantagoOvataForsk": {
"type": "boolean",
"description": "Plantago Ovata Forsk?"
},
"sulfatoFerroso": {
"type": "boolean",
"description": "Sulfato Ferroso?"
},
"manipulado": {
"type": "boolean",
"description": "É manipulado?"
},
"codigoAuxiliar": {
"type": "string",
"description": "Código Auxiliar"
}
},
"required": [
"medicamento",
"tarjaPreta",
"tarjaVermelha",
"sedacao",
"prescricaoMedica",
"generico",
"controleEspecial",
"acidoAcetilsalicilico",
"acidoAscorbico",
"bicarbonatoSodio",
"bisacodil",
"canfora",
"carbonatoCalcio",
"carvaoVegetal",
"cloridratoAmbroxol",
"cloridratoFenilefrina",
"dipironaSodica",
"dropropizina",
"hidroxidoAluminio",
"hidroxidoMagnesio",
"ibuprofeno",
"mebendazol",
"naproxeno",
"nicotina",
"paracetamol",
"picossulfatoSodio",
"plantagoOvataForsk",
"sulfatoFerroso",
"manipulado",
"codigoAuxiliar"
],
"description": "Configurações para medicamento"
}
},
"required": [
"sku",
"tipo",
"nome",
"precificacao"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"sku": "P001",
"tipo": "COMPOSTO",
"status": "ATIVO",
"entrega_digital": "ATIVA",
"exibir_preco": "ATIVO",
"sob_consulta": false,
"tempo_preparacao": 2,
"garantia": 30,
"nome": "Produto de exemplo",
"seo_descricao": "Descrição de teste do produto",
"seo_keywords": "Palavras chave utilizadas na busca interna do site e na busca orgânica dos buscadores.",
"informacoes_importantes": "Informações importantes sobre o produto.",
"marca": "M001",
"categorias": [
"C001",
"C002"
],
"quantidade_minima_estoque": 5,
"codigo_nbm": "000000",
"codigo_ncm": "000000",
"codigo_isbn": "000000",
"genero": "Masculino",
"faixa_etaria": "Infantil",
"descricao": "Descrição de teste",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"caracteristica_vertical": "C001",
"caracteristica_horizontal": "C002",
"variacoes": [
{
"sku": "P0002",
"nome_personalizado": "Produto de exemplo",
"tempo_preparacao": 2,
"garantia": 30,
"quantidade_estoque": 100,
"codigo_ean": "00000",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"especificacoes": [
{
"caracteristica": "C001",
"valor": "Azul"
}
],
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
}
}
],
"imagens_caracteristica": [
{
"caracteristica": "C001",
"valor": "Azul",
"imagens": [
"http://imagem.com.br/produto-azul1.jpg",
"http://imagem.com.br/produto-azul2.jpg",
"http://imagem.com.br/produto-azuls3.jpg"
]
}
],
"marketplace": {
"skyhub": true
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
},
"configuracoes": {
"medicamento": true,
"tarjaPreta": true,
"tarjaVermelha": true,
"sedacao": true,
"prescricaoMedica": false,
"generico": true,
"controleEspecial": true,
"acidoAcetilsalicilico": true,
"acidoAscorbico": true,
"bicarbonatoSodio": false,
"bisacodil": true,
"canfora": true,
"carbonatoCalcio": true,
"carvaoVegetal": true,
"cloridratoAmbroxol": false,
"cloridratoFenilefrina": true,
"dipironaSodica": true,
"dropropizina": true,
"hidroxidoAluminio": true,
"hidroxidoMagnesio": false,
"ibuprofeno": true,
"mebendazol": true,
"naproxeno": true,
"nicotina": false,
"paracetamol": false,
"picossulfatoSodio": true,
"plantagoOvataForsk": true,
"sulfatoFerroso": false,
"manipulado": false,
"codigoAuxiliar": "124654"
}
}Schema
{
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU do produto."
},
"tipo": {
"type": "string",
"description": "Código do tipo de produto."
},
"status": {
"type": "string",
"description": "Informa se o produto estará ativo ou não."
},
"entrega_digital": {
"type": "string",
"description": "Informa se a entrega será combinada com o comprador."
},
"exibir_preco": {
"type": "string",
"description": "Informa se a precificação do produto será exibida no e-commerce."
},
"sob_consulta": {
"type": "boolean",
"description": "Informa se o produto estará disponível no e-commerce apenas sob consulta."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"nome": {
"type": "string",
"description": "Nome do produto."
},
"seo_descricao": {
"type": "string",
"description": "Descrição do produto otimizada para SEO."
},
"seo_keywords": {
"type": "string"
},
"informacoes_importantes": {
"type": "string"
},
"marca": {
"type": "string",
"description": "Código de referência da marca do produto."
},
"categorias": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categorias do produto."
},
"quantidade_minima_estoque": {
"type": "number",
"description": "Quantidade minima que o estoque deve possuir. Quando o estoque atingir esta quantidade, um alerta sera enviado para o administrador."
},
"codigo_nbm": {
"type": "string",
"description": "Código NBM do produto"
},
"codigo_ncm": {
"type": "string",
"description": "Código NCM do produto"
},
"codigo_isbn": {
"type": "string",
"description": "Código ISBN do produto"
},
"genero": {
"type": "string",
"description": "Gênero do público do produto (Masculino, Feminino ou Unissex)"
},
"faixa_etaria": {
"type": "string",
"description": "Faixa etária do público do produto (Recém-nascido, 3 a 12 meses, 1 a 5 anos, Infantil, Para adultos)"
},
"descricao": {
"type": "string",
"description": "Descrição detalhada do produto. Este campo aceita tags HTML"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) do produto"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto para marketplaces"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) do produto"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) do produto"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) do produto"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) do produto"
}
},
"required": [
"peso",
"altura",
"largura",
"comprimento"
],
"description": "Dimensões e peso do produto, esses dados seram utilizados para calculo do frete"
},
"caracteristica_vertical": {
"type": "string",
"description": "Código de referência da caracteristica vertical do produto (Ex: Cor, Sabor)"
},
"caracteristica_horizontal": {
"type": "string",
"description": "Código de referência da caracteristica horizontal do produto (Ex: Tamanho, Voltagem)"
},
"variacoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU da variação da variação"
},
"nome_personalizado": {
"type": "string",
"description": "Nome da variação (só está disponível para característica do tipo Vertical)."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque da variação"
},
"codigo_ean": {
"type": "string",
"description": "Código EAN da variação"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) da variação"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação para marketplaces"
},
"especificacoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Código de referência do tipo de caracteristica da especificação"
},
"valor": {
"type": "string",
"description": "Valor da caracteristica do produto"
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Especificações do produto com as caracteristicas e valores"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) da variação"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) da variação"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) da variação"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) da variação"
}
},
"description": "Dimensões e peso da variacao, esses dados seram utilizados para calculo do frete"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
}
},
"required": [
"sku",
"quantidade_estoque",
"especificacoes"
]
},
"description": "Variações do produto. Atributo obrigatório caso seja um produto composto."
},
"imagens_caracteristica": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Código de referência da caracteristica vertifcal"
},
"valor": {
"type": "string",
"description": "Valor da caracteristica do produto"
},
"imagens": {
"type": "array",
"items": {
"type": "string"
},
"description": "Imagens da galeria do produto. A primeira imagem será considerada como a imagem principal do produto."
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Galeria de imagens da caracteristica vertical do produto"
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
},
"configuracoes": {
"type": "object",
"properties": {
"medicamento": {
"type": "boolean",
"description": "É medicamento?"
},
"tarjaPreta": {
"type": "boolean",
"description": "É tarja preta?"
},
"tarjaVermelha": {
"type": "boolean",
"description": "É tarja vermelha?"
},
"sedacao": {
"type": "boolean",
"description": "É medicamento que apresentar efeitos de sedação e/ou sonolência?"
},
"prescricaoMedica": {
"type": "boolean",
"description": "É vendido sob prescrição médica?"
},
"generico": {
"type": "boolean",
"description": "É medicamento genérico?"
},
"controleEspecial": {
"type": "boolean",
"description": "Controle especial (psicotrópicos e antimicrobianos)?"
},
"acidoAcetilsalicilico": {
"type": "boolean",
"description": "Ácido Acetilsalicílico?"
},
"acidoAscorbico": {
"type": "boolean",
"description": "Ácido Ascórbico (vitamina C)?"
},
"bicarbonatoSodio": {
"type": "boolean",
"description": "Bicarbonato de Sódio?"
},
"bisacodil": {
"type": "boolean",
"description": "Bisacodil?"
},
"canfora": {
"type": "boolean",
"description": "Cânfora?"
},
"carbonatoCalcio": {
"type": "boolean",
"description": "Carbonato de Cálcio?"
},
"carvaoVegetal": {
"type": "boolean",
"description": "Carvão Vegetal?"
},
"cloridratoAmbroxol": {
"type": "boolean",
"description": "Cloridrato de Ambroxol?"
},
"cloridratoFenilefrina": {
"type": "boolean",
"description": "Cloridrato de Fenilefrina?"
},
"dipironaSodica": {
"type": "boolean",
"description": "Dipirona Sódica?"
},
"dropropizina": {
"type": "boolean",
"description": "Dropropizina?"
},
"hidroxidoAluminio": {
"type": "boolean",
"description": "Hidróxido de Alumínio?"
},
"hidroxidoMagnesio": {
"type": "boolean",
"description": "Hidróxido de Magnésio?"
},
"ibuprofeno": {
"type": "boolean",
"description": "Ibuprofeno?"
},
"mebendazol": {
"type": "boolean",
"description": "Mebendazol?"
},
"naproxeno": {
"type": "boolean",
"description": "Naproxeno?"
},
"nicotina": {
"type": "boolean",
"description": "Nicotina?"
},
"paracetamol": {
"type": "boolean",
"description": "Paracetamol?"
},
"picossulfatoSodio": {
"type": "boolean",
"description": "Picossulfato de Sódio?"
},
"plantagoOvataForsk": {
"type": "boolean",
"description": "Plantago Ovata Forsk?"
},
"sulfatoFerroso": {
"type": "boolean",
"description": "Sulfato Ferroso?"
},
"manipulado": {
"type": "boolean",
"description": "É manipulado?"
},
"codigoAuxiliar": {
"type": "string",
"description": "Código Auxiliar"
}
},
"required": [
"medicamento",
"tarjaPreta",
"tarjaVermelha",
"sedacao",
"prescricaoMedica",
"generico",
"controleEspecial",
"acidoAcetilsalicilico",
"acidoAscorbico",
"bicarbonatoSodio",
"bisacodil",
"canfora",
"carbonatoCalcio",
"carvaoVegetal",
"cloridratoAmbroxol",
"cloridratoFenilefrina",
"dipironaSodica",
"dropropizina",
"hidroxidoAluminio",
"hidroxidoMagnesio",
"ibuprofeno",
"mebendazol",
"naproxeno",
"nicotina",
"paracetamol",
"picossulfatoSodio",
"plantagoOvataForsk",
"sulfatoFerroso",
"manipulado",
"codigoAuxiliar"
],
"description": "Configurações para medicamento"
}
},
"required": [
"sku",
"tipo",
"nome",
"precificacao"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Criar produtoPOST/produtos
Cria um novo produto na loja.
PUT https://api.minhaloja.com.br/produtos
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"status": "ATIVO",
"entrega_digital": "ATIVA",
"exibir_preco": "ATIVO",
"sob_consulta": false,
"tempo_preparacao": 2,
"garantia": 30,
"nome": "Produto de exemplo",
"seo_descricao": "Descrição de teste do produto",
"seo_keywords": "Palavras chave utilizadas na busca interna do site e na busca orgânica dos buscadores.",
"informacoes_importantes": "Informações importantes sobre o produto.",
"marca": "M001",
"categorias": [
"C001",
"C002"
],
"quantidade_estoque": 100,
"quantidade_minima_estoque": 5,
"codigo_ean": "000000",
"codigo_nbm": "000000",
"codigo_ncm": "000000",
"codigo_isbn": "000000",
"peso_unidade": "500g por unidade",
"genero": "Masculino",
"faixa_etaria": "Infantil",
"descricao": "Descrição de teste",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"imagens": [
"http://imagem.com.br/produto1.jpg",
"http://imagem.com.br/produto2.jpg",
"http://imagem.com.br/produto3.jpg"
],
"marketplace": {
"skyhub": true
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
},
"caracteristica_simples": [
{
"caracteristica": "garantia-em-meses",
"valor": "3 Meses"
}
],
"ficha_tecnica": [
{
"caracteristica": "Fabricante",
"valor": "Ambev"
}
],
"configuracoes": {
"medicamento": true,
"tarjaPreta": true,
"tarjaVermelha": true,
"sedacao": true,
"prescricaoMedica": false,
"generico": true,
"controleEspecial": true,
"acidoAcetilsalicilico": true,
"acidoAscorbico": true,
"bicarbonatoSodio": false,
"bisacodil": true,
"canfora": true,
"carbonatoCalcio": true,
"carvaoVegetal": true,
"cloridratoAmbroxol": false,
"cloridratoFenilefrina": true,
"dipironaSodica": true,
"dropropizina": true,
"hidroxidoAluminio": true,
"hidroxidoMagnesio": false,
"ibuprofeno": true,
"mebendazol": true,
"naproxeno": true,
"nicotina": false,
"paracetamol": false,
"picossulfatoSodio": true,
"plantagoOvataForsk": true,
"sulfatoFerroso": false,
"manipulado": false,
"codigoAuxiliar": "124654"
}
}Schema
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Informa se o produto estará ativo ou não."
},
"entrega_digital": {
"type": "string",
"description": "Informa se a entrega será combinada com o comprador."
},
"exibir_preco": {
"type": "string",
"description": "Informa se a precificação do produto será exibida no e-commerce."
},
"sob_consulta": {
"type": "boolean",
"description": "Informa se o produto estará disponível no e-commerce apenas sob consulta."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"nome": {
"type": "string",
"description": "Nome do produto."
},
"seo_descricao": {
"type": "string",
"description": "Descrição do produto otimizada para SEO."
},
"seo_keywords": {
"type": "string"
},
"informacoes_importantes": {
"type": "string"
},
"marca": {
"type": "string",
"description": "Código de referência da marca do produto."
},
"categorias": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categorias do produto."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque do produto."
},
"quantidade_minima_estoque": {
"type": "number",
"description": "Quantidade minima que o estoque deve possuir. Quando o estoque atingir esta quantidade, um alerta sera enviado para o administrador."
},
"codigo_ean": {
"type": "string",
"description": "Código EAN do produto"
},
"codigo_nbm": {
"type": "string",
"description": "Código NBM do produto"
},
"codigo_ncm": {
"type": "string",
"description": "Código NCM do produto"
},
"codigo_isbn": {
"type": "string",
"description": "Código ISBN do produto"
},
"peso_unidade": {
"type": "string",
"description": "Informação de peso por unidade"
},
"genero": {
"type": "string",
"description": "Gênero do público do produto (Masculino, Feminino ou Unissex)"
},
"faixa_etaria": {
"type": "string",
"description": "Faixa etária do público do produto (Recém-nascido, 3 a 12 meses, 1 a 5 anos, Infantil, Para adultos)"
},
"descricao": {
"type": "string",
"description": "Descrição detalhada do produto. Este campo aceita tags HTML"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) do produto"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto para marketplaces"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) do produto"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) do produto"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) do produto"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) do produto"
}
},
"required": [
"peso",
"altura",
"largura",
"comprimento"
],
"description": "Dimensões e peso do produto, esses dados seram utilizados para calculo do frete"
},
"imagens": {
"type": "array",
"items": {
"type": "string"
},
"description": "Imagens da galeria do produto. A primeira imagem será considerada como a imagem principal do produto."
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
},
"caracteristica_simples": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Código de referência do tipo de caracteristica da especificação"
},
"valor": {
"type": "string",
"description": "Valor da caracteristica do produto"
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Característica Simples do produto com as caracteristicas e valores"
},
"ficha_tecnica": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Título do item da ficha técnica"
},
"valor": {
"type": "string",
"description": "Valor do item da ficha técnica"
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Itens da ficha técnica do produto"
},
"configuracoes": {
"type": "object",
"properties": {
"medicamento": {
"type": "boolean",
"description": "É medicamento?"
},
"tarjaPreta": {
"type": "boolean",
"description": "É tarja preta?"
},
"tarjaVermelha": {
"type": "boolean",
"description": "É tarja vermelha?"
},
"sedacao": {
"type": "boolean",
"description": "É medicamento que apresentar efeitos de sedação e/ou sonolência?"
},
"prescricaoMedica": {
"type": "boolean",
"description": "É vendido sob prescrição médica?"
},
"generico": {
"type": "boolean",
"description": "É medicamento genérico?"
},
"controleEspecial": {
"type": "boolean",
"description": "Controle especial (psicotrópicos e antimicrobianos)?"
},
"acidoAcetilsalicilico": {
"type": "boolean",
"description": "Ácido Acetilsalicílico?"
},
"acidoAscorbico": {
"type": "boolean",
"description": "Ácido Ascórbico (vitamina C)?"
},
"bicarbonatoSodio": {
"type": "boolean",
"description": "Bicarbonato de Sódio?"
},
"bisacodil": {
"type": "boolean",
"description": "Bisacodil?"
},
"canfora": {
"type": "boolean",
"description": "Cânfora?"
},
"carbonatoCalcio": {
"type": "boolean",
"description": "Carbonato de Cálcio?"
},
"carvaoVegetal": {
"type": "boolean",
"description": "Carvão Vegetal?"
},
"cloridratoAmbroxol": {
"type": "boolean",
"description": "Cloridrato de Ambroxol?"
},
"cloridratoFenilefrina": {
"type": "boolean",
"description": "Cloridrato de Fenilefrina?"
},
"dipironaSodica": {
"type": "boolean",
"description": "Dipirona Sódica?"
},
"dropropizina": {
"type": "boolean",
"description": "Dropropizina?"
},
"hidroxidoAluminio": {
"type": "boolean",
"description": "Hidróxido de Alumínio?"
},
"hidroxidoMagnesio": {
"type": "boolean",
"description": "Hidróxido de Magnésio?"
},
"ibuprofeno": {
"type": "boolean",
"description": "Ibuprofeno?"
},
"mebendazol": {
"type": "boolean",
"description": "Mebendazol?"
},
"naproxeno": {
"type": "boolean",
"description": "Naproxeno?"
},
"nicotina": {
"type": "boolean",
"description": "Nicotina?"
},
"paracetamol": {
"type": "boolean",
"description": "Paracetamol?"
},
"picossulfatoSodio": {
"type": "boolean",
"description": "Picossulfato de Sódio?"
},
"plantagoOvataForsk": {
"type": "boolean",
"description": "Plantago Ovata Forsk?"
},
"sulfatoFerroso": {
"type": "boolean",
"description": "Sulfato Ferroso?"
},
"manipulado": {
"type": "boolean",
"description": "É manipulado?"
},
"codigoAuxiliar": {
"type": "string",
"description": "Código Auxiliar"
}
},
"required": [
"medicamento",
"tarjaPreta",
"tarjaVermelha",
"sedacao",
"prescricaoMedica",
"generico",
"controleEspecial",
"acidoAcetilsalicilico",
"acidoAscorbico",
"bicarbonatoSodio",
"bisacodil",
"canfora",
"carbonatoCalcio",
"carvaoVegetal",
"cloridratoAmbroxol",
"cloridratoFenilefrina",
"dipironaSodica",
"dropropizina",
"hidroxidoAluminio",
"hidroxidoMagnesio",
"ibuprofeno",
"mebendazol",
"naproxeno",
"nicotina",
"paracetamol",
"picossulfatoSodio",
"plantagoOvataForsk",
"sulfatoFerroso",
"manipulado",
"codigoAuxiliar"
],
"description": "Configurações para medicamento"
}
},
"required": [
"nome",
"precificacao"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"status": "ATIVO",
"entrega_digital": "ATIVA",
"exibir_preco": "ATIVO",
"sob_consulta": false,
"tempo_preparacao": 2,
"garantia": 30,
"nome": "Produto de exemplo",
"seo_descricao": "Descrição de teste do produto",
"seo_keywords": "Palavras chave utilizadas na busca interna do site e na busca orgânica dos buscadores.",
"informacoes_importantes": "Informações importantes sobre o produto.",
"marca": "M001",
"categorias": [
"C001",
"C002"
],
"quantidade_minima_estoque": 5,
"codigo_nbm": "000000",
"codigo_ncm": "000000",
"codigo_isbn": "000000",
"genero": "Masculino",
"faixa_etaria": "Infantil",
"descricao": "Descrição de teste",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"variacoes": [
{
"sku": "P0002",
"nome_personalizado": "Produto de exemplo",
"tempo_preparacao": 2,
"garantia": 30,
"quantidade_estoque": 100,
"codigo_ean": "00000",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"especificacoes": [
{
"caracteristica": "C001",
"valor": "Azul"
}
],
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
}
}
],
"imagens_caracteristica": [
{
"caracteristica": "C001",
"valor": "Azul",
"imagens": [
"http://imagem.com.br/produto-azul1.jpg",
"http://imagem.com.br/produto-azul2.jpg",
"http://imagem.com.br/produto-azuls3.jpg"
]
}
],
"marketplace": {
"skyhub": true
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
},
"configuracoes": {
"medicamento": true,
"tarjaPreta": true,
"tarjaVermelha": true,
"sedacao": true,
"prescricaoMedica": false,
"generico": true,
"controleEspecial": true,
"acidoAcetilsalicilico": true,
"acidoAscorbico": true,
"bicarbonatoSodio": false,
"bisacodil": true,
"canfora": true,
"carbonatoCalcio": true,
"carvaoVegetal": true,
"cloridratoAmbroxol": false,
"cloridratoFenilefrina": true,
"dipironaSodica": true,
"dropropizina": true,
"hidroxidoAluminio": true,
"hidroxidoMagnesio": false,
"ibuprofeno": true,
"mebendazol": true,
"naproxeno": true,
"nicotina": false,
"paracetamol": false,
"picossulfatoSodio": true,
"plantagoOvataForsk": true,
"sulfatoFerroso": false,
"manipulado": false,
"codigoAuxiliar": "124654"
}
}Schema
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Informa se o produto estará ativo ou não."
},
"entrega_digital": {
"type": "string",
"description": "Informa se a entrega será combinada com o comprador."
},
"exibir_preco": {
"type": "string",
"description": "Informa se a precificação do produto será exibida no e-commerce."
},
"sob_consulta": {
"type": "boolean",
"description": "Informa se o produto estará disponível no e-commerce apenas sob consulta."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"nome": {
"type": "string",
"description": "Nome do produto."
},
"seo_descricao": {
"type": "string",
"description": "Descrição do produto otimizada para SEO."
},
"seo_keywords": {
"type": "string"
},
"informacoes_importantes": {
"type": "string"
},
"marca": {
"type": "string",
"description": "Código de referência da marca do produto."
},
"categorias": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categorias do produto."
},
"quantidade_minima_estoque": {
"type": "number",
"description": "Quantidade minima que o estoque deve possuir. Quando o estoque atingir esta quantidade, um alerta sera enviado para o administrador."
},
"codigo_nbm": {
"type": "string",
"description": "Código NBM do produto"
},
"codigo_ncm": {
"type": "string",
"description": "Código NCM do produto"
},
"codigo_isbn": {
"type": "string",
"description": "Código ISBN do produto"
},
"genero": {
"type": "string",
"description": "Gênero do público do produto (Masculino, Feminino ou Unissex)"
},
"faixa_etaria": {
"type": "string",
"description": "Faixa etária do público do produto (Recém-nascido, 3 a 12 meses, 1 a 5 anos, Infantil, Para adultos)"
},
"descricao": {
"type": "string",
"description": "Descrição detalhada do produto. Este campo aceita tags HTML"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) do produto"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação do produto para marketplaces"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) do produto"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) do produto"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) do produto"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) do produto"
}
},
"required": [
"peso",
"altura",
"largura",
"comprimento"
],
"description": "Dimensões e peso do produto, esses dados seram utilizados para calculo do frete"
},
"variacoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU da variação da variação"
},
"nome_personalizado": {
"type": "string",
"description": "Nome da variação (só está disponível para característica do tipo Vertical)."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque da variação"
},
"codigo_ean": {
"type": "string",
"description": "Código EAN da variação"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) da variação"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação para marketplaces"
},
"especificacoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Código de referência do tipo de caracteristica da especificação"
},
"valor": {
"type": "string",
"description": "Valor da caracteristica do produto"
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Especificações do produto com as caracteristicas e valores"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) da variação"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) da variação"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) da variação"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) da variação"
}
},
"description": "Dimensões e peso da variacao, esses dados seram utilizados para calculo do frete"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
}
},
"required": [
"sku",
"quantidade_estoque",
"especificacoes"
]
},
"description": "Variações do produto. Atributo obrigatório caso seja um produto composto."
},
"imagens_caracteristica": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Código de referência da caracteristica vertifcal"
},
"valor": {
"type": "string",
"description": "Valor da caracteristica do produto"
},
"imagens": {
"type": "array",
"items": {
"type": "string"
},
"description": "Imagens da galeria do produto. A primeira imagem será considerada como a imagem principal do produto."
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Galeria de imagens da caracteristica vertical do produto"
},
"marketplace": {
"type": "object",
"properties": {
"skyhub": {
"type": "boolean",
"description": "Informa se a entidade sera enviada para Skyhub"
}
},
"description": "Configurações dos marketplaces"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
},
"configuracoes": {
"type": "object",
"properties": {
"medicamento": {
"type": "boolean",
"description": "É medicamento?"
},
"tarjaPreta": {
"type": "boolean",
"description": "É tarja preta?"
},
"tarjaVermelha": {
"type": "boolean",
"description": "É tarja vermelha?"
},
"sedacao": {
"type": "boolean",
"description": "É medicamento que apresentar efeitos de sedação e/ou sonolência?"
},
"prescricaoMedica": {
"type": "boolean",
"description": "É vendido sob prescrição médica?"
},
"generico": {
"type": "boolean",
"description": "É medicamento genérico?"
},
"controleEspecial": {
"type": "boolean",
"description": "Controle especial (psicotrópicos e antimicrobianos)?"
},
"acidoAcetilsalicilico": {
"type": "boolean",
"description": "Ácido Acetilsalicílico?"
},
"acidoAscorbico": {
"type": "boolean",
"description": "Ácido Ascórbico (vitamina C)?"
},
"bicarbonatoSodio": {
"type": "boolean",
"description": "Bicarbonato de Sódio?"
},
"bisacodil": {
"type": "boolean",
"description": "Bisacodil?"
},
"canfora": {
"type": "boolean",
"description": "Cânfora?"
},
"carbonatoCalcio": {
"type": "boolean",
"description": "Carbonato de Cálcio?"
},
"carvaoVegetal": {
"type": "boolean",
"description": "Carvão Vegetal?"
},
"cloridratoAmbroxol": {
"type": "boolean",
"description": "Cloridrato de Ambroxol?"
},
"cloridratoFenilefrina": {
"type": "boolean",
"description": "Cloridrato de Fenilefrina?"
},
"dipironaSodica": {
"type": "boolean",
"description": "Dipirona Sódica?"
},
"dropropizina": {
"type": "boolean",
"description": "Dropropizina?"
},
"hidroxidoAluminio": {
"type": "boolean",
"description": "Hidróxido de Alumínio?"
},
"hidroxidoMagnesio": {
"type": "boolean",
"description": "Hidróxido de Magnésio?"
},
"ibuprofeno": {
"type": "boolean",
"description": "Ibuprofeno?"
},
"mebendazol": {
"type": "boolean",
"description": "Mebendazol?"
},
"naproxeno": {
"type": "boolean",
"description": "Naproxeno?"
},
"nicotina": {
"type": "boolean",
"description": "Nicotina?"
},
"paracetamol": {
"type": "boolean",
"description": "Paracetamol?"
},
"picossulfatoSodio": {
"type": "boolean",
"description": "Picossulfato de Sódio?"
},
"plantagoOvataForsk": {
"type": "boolean",
"description": "Plantago Ovata Forsk?"
},
"sulfatoFerroso": {
"type": "boolean",
"description": "Sulfato Ferroso?"
},
"manipulado": {
"type": "boolean",
"description": "É manipulado?"
},
"codigoAuxiliar": {
"type": "string",
"description": "Código Auxiliar"
}
},
"required": [
"medicamento",
"tarjaPreta",
"tarjaVermelha",
"sedacao",
"prescricaoMedica",
"generico",
"controleEspecial",
"acidoAcetilsalicilico",
"acidoAscorbico",
"bicarbonatoSodio",
"bisacodil",
"canfora",
"carbonatoCalcio",
"carvaoVegetal",
"cloridratoAmbroxol",
"cloridratoFenilefrina",
"dipironaSodica",
"dropropizina",
"hidroxidoAluminio",
"hidroxidoMagnesio",
"ibuprofeno",
"mebendazol",
"naproxeno",
"nicotina",
"paracetamol",
"picossulfatoSodio",
"plantagoOvataForsk",
"sulfatoFerroso",
"manipulado",
"codigoAuxiliar"
],
"description": "Configurações para medicamento"
}
},
"required": [
"nome",
"precificacao"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar produtoPUT/produtos
Atualizar dados do produto
PUT https://api.minhaloja.com.br/produtos/lote/estoque
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"dados": [
{
"sku": "P001",
"quantidade_estoque": 2
}
]
}Schema
{
"type": "object",
"properties": {
"dados": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU do produto."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque do produto."
}
},
"required": [
"sku",
"quantidade_estoque"
]
},
"description": "Dados do estoque dos produtos a serem atualizados em lote."
}
},
"required": [
"dados"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar estoque dos produtos em lotePUT/produtos/lote/estoque
Atualizar o estoque dos produtos em lote
PUT https://api.minhaloja.com.br/produtos/lote/precificacao
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"dados": [
{
"sku": "P001",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
}
}
]
}Schema
{
"type": "object",
"properties": {
"dados": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU do produto."
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) da variação"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação para marketplaces"
}
},
"required": [
"sku"
]
},
"description": "Dados da precificação dos produtos a serem atualizados em lote."
}
},
"required": [
"dados"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar precificação dos produtos em lotePUT/produtos/lote/precificacao
Atualizar a precificação dos produtos em lote
DELETE https://api.minhaloja.com.br/produtos
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Excluir produtoDELETE/produtos
Exclui um produto da loja.
Variação ¶
GET https://api.minhaloja.com.br/produtos/P0001/variacoes/P0002
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"sku": "P0002",
"nome_personalizado": "Produto de exemplo",
"tempo_preparacao": 2,
"garantia": 30,
"quantidade_estoque": 100,
"codigo_ean": "00000",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"especificacoes": [
{
"caracteristica": "C001",
"valor": "Azul"
}
],
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU da variação da variação"
},
"nome_personalizado": {
"type": "string",
"description": "Nome da variação (só está disponível para característica do tipo Vertical)."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque da variação"
},
"codigo_ean": {
"type": "string",
"description": "Código EAN da variação"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) da variação"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação para marketplaces"
},
"especificacoes": {
"type": "array",
"description": "Especificações do produto com as caracteristicas e valores"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) da variação"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) da variação"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) da variação"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) da variação"
}
},
"description": "Dimensões e peso da variacao, esses dados seram utilizados para calculo do frete"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
}
},
"required": [
"sku",
"quantidade_estoque",
"especificacoes"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Receber variaçãoGET/produtos/{sku}/variacoes/{sku_variacao}
Recupera uma variação cadastrada na loja com base no sku.
URI Parameters
- sku
string(required) Example: P0001Código SKU do produto
- sku_variacao
string(required) Example: P0002Código SKU da variação
POST https://api.minhaloja.com.br/produtos/P0001/variacoes
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"sku": "P0002",
"nome_personalizado": "Produto de exemplo",
"tempo_preparacao": 2,
"garantia": 30,
"quantidade_estoque": 100,
"codigo_ean": "00000",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"especificacoes": [
{
"caracteristica": "C001",
"valor": "Azul"
}
],
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
}
}Schema
{
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU da variação da variação"
},
"nome_personalizado": {
"type": "string",
"description": "Nome da variação (só está disponível para característica do tipo Vertical)."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque da variação"
},
"codigo_ean": {
"type": "string",
"description": "Código EAN da variação"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) da variação"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação para marketplaces"
},
"especificacoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"caracteristica": {
"type": "string",
"description": "Código de referência do tipo de caracteristica da especificação"
},
"valor": {
"type": "string",
"description": "Valor da caracteristica do produto"
}
},
"required": [
"caracteristica",
"valor"
]
},
"description": "Especificações do produto com as caracteristicas e valores"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) da variação"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) da variação"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) da variação"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) da variação"
}
},
"description": "Dimensões e peso da variacao, esses dados seram utilizados para calculo do frete"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
}
},
"required": [
"sku",
"quantidade_estoque",
"especificacoes"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Criar variação do produtoPOST/produtos/{sku}/variacoes
Cria uma nova variação no produto.
URI Parameters
- sku
string(required) Example: P0001Código SKU do produto
PUT https://api.minhaloja.com.br/produtos/P0001/variacoes/P0002
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"nome_personalizado": "Produto de exemplo",
"tempo_preparacao": 2,
"garantia": 30,
"quantidade_estoque": 100,
"codigo_ean": "00000",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
},
"dimensoes": {
"peso": 1.5,
"altura": 2.3,
"largura": 3.1,
"comprimento": 15
},
"regra_compra_minima": {
"ativa": true,
"quantidade": 10
},
"regra_compra_maxima": {
"ativa": true,
"quantidade": 10
}
}Schema
{
"type": "object",
"properties": {
"nome_personalizado": {
"type": "string",
"description": "Nome da variação (só está disponível para característica do tipo Vertical)."
},
"tempo_preparacao": {
"type": "number",
"description": "Informa qual será o tempo de preparação do produto em dias."
},
"garantia": {
"type": "number",
"description": "Informa qual será o tempo de garantia do produto em dias (utilizado para alguns marketplaces)."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque da variação"
},
"codigo_ean": {
"type": "string",
"description": "Código EAN da variação"
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) da variação"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação para marketplaces"
},
"dimensoes": {
"type": "object",
"properties": {
"peso": {
"type": "number",
"description": "Peso (em Kilos) da variação"
},
"altura": {
"type": "number",
"description": "Altura (em Centímetros) da variação"
},
"largura": {
"type": "number",
"description": "Largura (em Centímetros) da variação"
},
"comprimento": {
"type": "number",
"description": "Comprimento (em Centímetros) da variação"
}
},
"description": "Dimensões e peso da variacao, esses dados seram utilizados para calculo do frete"
},
"regra_compra_minima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade mínima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade mínima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade mínima de aquisição do produto"
},
"regra_compra_maxima": {
"type": "object",
"properties": {
"ativa": {
"type": "boolean",
"description": "Informa se a regra de quantidade máxima do produto está ativa"
},
"quantidade": {
"type": "number",
"description": "Informa a quantidade máxima do produto poderá ser adquirida"
}
},
"required": [
"ativa",
"quantidade"
],
"description": "Configuração da regra de quantidade máxima de aquisição do produto"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar variação do produtoPUT/produtos/{sku}/variacoes/{sku_variacao}
Atualiza uma variação do produto.
URI Parameters
- sku
string(required) Example: P0001Código SKU do produto
- sku_variacao
string(required) Example: P0002Código SKU da variação
PUT https://api.minhaloja.com.br/produtos/variacoes/lote/estoque
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"dados": [
{
"sku": "P001",
"quantidade_estoque": 2
}
]
}Schema
{
"type": "object",
"properties": {
"dados": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU da variação."
},
"quantidade_estoque": {
"type": "number",
"description": "Quantidade em estoque da variação."
}
},
"required": [
"sku",
"quantidade_estoque"
]
},
"description": "Dados do estoque das variações a serem atualizadas em lote."
}
},
"required": [
"dados"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar estoque das variações em lotePUT/produtos/variacoes/lote/estoque
Atualizar o estoque das variações em lote
PUT https://api.minhaloja.com.br/produtos/variacoes/lote/precificacao
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"dados": [
{
"sku": "P001",
"precificacao": {
"preco_listagem": 200,
"preco_venda": 150,
"parcelamento_maximo_sem_juros": 4,
"desconto_avista": 10,
"cpv": 75
},
"precificacao_promocional": {
"preco_promocional": 150,
"data_inicio": "2018-12-30 00:00",
"data_fim": "2018-12-30 23:59"
},
"precificacao_marketplace": {
"preco_venda": 200,
"preco_promocional": 150,
"preco_mercadolivre": 130
}
}
]
}Schema
{
"type": "object",
"properties": {
"dados": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Código SKU da variação."
},
"precificacao": {
"type": "object",
"properties": {
"preco_listagem": {
"type": "number",
"description": "Preço de listagem do produto, utilizado apenas para quesitos cosméticos"
},
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"parcelamento_maximo_sem_juros": {
"type": "number",
"description": "Parcelamento máximo na venda do produto."
},
"desconto_avista": {
"type": "number",
"description": "Desconto máximo na venda do produto."
},
"cpv": {
"type": "number",
"description": "Custo do Produto Vendido."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação"
},
"precificacao_promocional": {
"type": "object",
"properties": {
"preco_promocional": {
"type": "number",
"description": "Preço de venda do produto."
},
"data_inicio": {
"type": "string",
"description": "Data e hora de inicio da validade do preço promocional."
},
"data_fim": {
"type": "string",
"description": "Data e hora de fim da validade do preço promocional, caso não seja informada uma data de fim, o preço promocional ficara valido por tempo indeterminado."
}
},
"required": [
"preco_promocional",
"data_inicio"
],
"description": "Precificação promocional(agendada) da variação"
},
"precificacao_marketplace": {
"type": "object",
"properties": {
"preco_venda": {
"type": "number",
"description": "Preço de venda do produto."
},
"preco_promocional": {
"type": "number",
"description": "Preço promocional do produto."
},
"preco_mercadolivre": {
"type": "number",
"description": "Preço do produto no Mercado Livre (não se aplica em variações)."
}
},
"required": [
"preco_venda"
],
"description": "Precificação da variação para marketplaces"
}
},
"required": [
"sku"
]
},
"description": "Dados da precificação das variações a serem atualizadas em lote."
}
},
"required": [
"dados"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar precificação das variações em lotePUT/produtos/variacoes/lote/precificacao
Atualizar a precificação das variações em lote
DELETE https://api.minhaloja.com.br/produtos/P0001/variacoes/P0002
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Excluir variação do produtoDELETE/produtos/{sku}/variacoes/{sku_variacao}
Atualiza uma variação do produto.
URI Parameters
- sku
string(required) Example: P0001Código SKU do produto
- sku_variacao
string(required) Example: P0002Código SKU da variação
Pedidos ¶
Através da API é possível consumir e atualizar as informações do pedido.
O ciclo de vida do pedido pode ser observado através dos eventos que ja ocorreram, estes eventos deverão ser utilizados para identificar em qual fase o pedido está.
Segue abaixo uma tabela com os detalhes de cada evento.
Tipos de evento
| Evento | Codigo | Descrição |
|---|---|---|
| Pedido Recebido | pedido_recebido | Pedido foi recebido com sucesso pela loja. |
| Aguardando Pagamento | aguardando_pagamento | Aguardando confirmação do pagamento. |
| Pagamento Recebido | pagamento_recebido | Pagamento foi confirmado com sucesso. |
| Pagamento Cancelado | pagamento_cancelado | Pagamento do pedido foi cancelado. |
| Pedido em Análise | pedido_analise | Pedido esta em análise pela administração da loja. |
| Pedido em Produção | pedido_producao | Pedido foi submetido para produção. |
| Pedido em Separação | pedido_separacao | Pedido foi enviado para separação de produtos. |
| Pedido Faturado | pedido_faturado | Pedido teve a Nota Fiscal gerada e esta pronto para envio. |
| Pedido Enviado | pedido_enviado | Pedido foi enviado para transportadora e os dados de rastreio foram disponibilizados. |
| Pedido Entregue | pedido_entregue | Entrega do pedido foi realizada com sucesso. |
| Pedido Cancelado | pedido_cancelado | Pedido foi cancelado. |
| Pedido Devolvido | pedido_devolvido | Pedido foi devolvido para loja após recebimento do cliente. |
| Exceção de Transporte | excecao_transporte | Durante a entrega do pedido alguma exceção foi relatada. |
| Boleto Vencido | boleto_vencido | Boleto de pagamento do pedido esta vencido. |
| Cancelamento Solicitado | cancelamento_solicitado | Cancelamento do pedido solicitado pelo cliente. |
| Liberado para Retirada | liberado_retirada | Pedido liberado para retirada no endereço escolhido. |
Tipos de status de sincronização
Afim de facilitar o gerenciamento da sincronização dos pedidos, adicionamos o campo status_sincronizacao responsável por informar se o pedido ja foi sincronizado ou não em sua ultima versão. Para saber quais valores este campo pode assumir, consulte a tabela abaixo:
| Valor | Descrição |
|---|---|
| SYNCED | Pedido sincronizado com sucesso |
| NOT_SYNCED | Pedido não sincronizado |
| ERROR | Falha na sincronização do pedido |
Tipos de métodos de pagamento
Além dos métodos descritos abaixo o sistema poderá apresentar outros métodos que foram criados via área administrativa do e-commerce.
| Valor | Descrição |
|---|---|
| boleto | Boleto |
| credit_card | Cartão de Crédito |
| debit_card | Cartão de Débito |
| online_debit | Débito Online |
Eventos do pedido
Afim de facilitar o gerenciamento da sincronização dos pedidos, é possível filtrar a fila de pedidos por status. Para saber quais são os eventos do pedido, consulte a tabela abaixo:
| Valor | Descrição |
|---|---|
| pedido_recebido | Pedido Recebido |
| aguardando_pagamento | Aguardando Pagamento |
| pedido_faturado | Pedido Faturado |
| pedido_enviado | Pedido Enviado |
| pedido_entregue | Pedido Entregue |
| pagamento_recebido | Pagamento Recebido |
| pagamento_cancelado | Pagamento Cancelado |
| pedido_cancelado | Pedido Cancelado |
| excecao_transporte | Exceção de Transporte |
| pedido_analise | Pedido em Análise |
| pedido_devolvido | Pedido Devolvido |
| boleto_vencido | Boleto Vencido |
| pedido_separacao | Pedido em Separação |
| cancelamento_solicitado | Cancelamento Solicitado |
| liberado_retirada | Liberado para Retirada |
| pedido_producao | Pedido em Produção |
Fila de pedidos ¶
Sempre que um pedido sofrer alguma atualização o mesmo será adicionado a fila de sincronização, para que assim seus dados possam ser consumidos.
Para recuperar os dados do pedido o sistema deverá realizar uma chamada para a API, a mesma verificará se existe algum pedido na fila de sincronização, caso exista os dados atualizados do pedido serão retornados. Após consumir os dados do pedido é necessário confirmar a sua sincronização para que o próximo pedido esteja disponível na fila.
ATENÇÃO
Recomendamos que a consulta a fila de pedidos seja feita constantemente, desta forma evitando a incoerência dos dados e vendas de produtos sem estoque.
GET https://api.minhaloja.com.br/pedidos/fila?page=0&?per_page=10&?status=pagamento_recebido
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
[
{
"codigo": "0001",
"data_sincronizacao": "2018-03-04 09:25:24",
"data_cadastro": "2018-03-04 09:25:24",
"data_atualizacao": "2018-03-04 09:25:24",
"status_sincronizacao": "NOT_SYNCED",
"canal": "LOJA",
"codigo_referencia": "Meli-1236789",
"valor_total": 205.93,
"valor_frete": 10.82,
"valor_desconto": 20.01,
"valor_cash_back": 10.5,
"juros": 5.99,
"ultimo_evento": "aguardando_pagamento",
"data_entrega": "2018-04-10",
"observacoes": "Entregar após às 18h",
"cliente": {
"codigo_referencia": "015AB",
"nome": "Cliente de Teste",
"telefone": "(28) 99999-9999",
"email": "cliente@email.com.br",
"cpf": "000.000.000-00",
"data_nascimento": "1990-10-20",
"razao_social": "Empresa de Teste LTDA",
"cnpj": "00.000.000/0000-00",
"inscricao_estadual": "0000.0000"
},
"endereco_entrega": {
"cep": "29315-322",
"rua": "Rua Otaviano Prado",
"numero": "245",
"bairro": "IBC",
"cidade": "Cachoeiro de Itapemirim",
"estado": "ES",
"complemento": "foo",
"referencia": "bar"
},
"endereco_cobranca": {
"cep": "29315-322",
"rua": "Rua Otaviano Prado",
"numero": "245",
"bairro": "IBC",
"cidade": "Cachoeiro de Itapemirim",
"estado": "ES",
"complemento": "foo",
"referencia": "bar"
},
"itens": [
{
"sku": "P001",
"nome": "Produto de exemplo",
"quantidade": 2,
"preco": 98.76,
"codigo_auxiliar": "124654",
"opcionais": [
{
"id": 1,
"descricao": "Garantia Estendida 03 meses",
"valor": 10.5,
"grupo": {
"id": 1
}
}
]
}
],
"transporte": {
"servico": "Correios PAC",
"codigo_rastreio": "KK90912121BR",
"url_rastreio": "www.urldeexemplo.com.br",
"transportadora": "Correios",
"metodo": "PAC",
"endereco_retirada": {
"empresa": "Arco Informática",
"logradouro": "Rua Otaviano Prado",
"numero": "245",
"bairro": "IBC",
"cidade": "Cachoeiro de Itapemirim",
"uf": "ES",
"cep": "29315-322"
}
},
"pagamento": {
"metodo_codigo": "boleto",
"metodo_descricao": "Boleto",
"referencia_forma_pagamento": "cartao_credito_12",
"nsu": "000000",
"url": "www.urlexemplo.com.br",
"boleto_numero": "000-000",
"boleto_linha_digitavel": "00000-00000-00000",
"boleto_vencimento": "2018-10-29",
"parcelas_quantidade": 2,
"parcelas_valor": 48.75,
"cartao_bandeira": "VISA",
"cartao_titular": "Nome de exemplo",
"cartao_numero": "4111",
"cartao_expiracao_mes": 12,
"cartao_expiracao_ano": 2018,
"codigo_transacao": "AAAAA-AB12546-ARC5475",
"troco": "10,00",
"gateway": "PagSeguro"
},
"historico_evento": [
{
"evento_codigo: `pedido_recebido`": "",
"evento_descricao": "Pedido recebido",
"data": "2018-02-15 20:00:00"
}
],
"vendedor": {
"nome": "Vendedor de Teste",
"email": "vendedor@email.com.br",
"cpf": "000.000.000-00",
"telefone": "(28) 99999-9999",
"matricula": "VEND001"
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Receber pedido da filaGET/pedidos/fila{?page}&{?per_page}&{?status}
Recupera o primeiro pedido disponivel na fila de sincronização.
Opcionalmente é possivel enviar o atributo per_page para retornar uma quantidade maior de registros, até um limite máximo de 50 por requisição.
Opcionalmente é possivel enviar o atributo status para retornar os pedidos por evento.
Após o processamento do pedido, a sincronização deve ser confirmada para que o próximo pedido esteja disponível na fila.
ATENÇÃO
Caso não exista nenhum pedido na fila de sincronização, sera retornada o código 204 com o corpo vazio.
URI Parameters
- page
number(optional) Example: 0Página a ser retornada (Valor default: 0)
- per_page
number(optional) Example: 10Quantidade de registros a serem retornados
- status
string(optional) Example: pagamento_recebidoStatus dos pedidos a serem retornados
POST https://api.minhaloja.com.br/pedidos/fila/0001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"data_sincronizacao": "2018-10-18 20:10:01"
}Schema
{
"type": "object",
"properties": {
"data_sincronizacao": {
"type": "string",
"description": "Data do ultimo registro do pedido na fila de sincronização"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Confirmar sincronização do pedidoPOST/pedidos/fila/{codigo}
Confirma a sincronização de um pedido, removendo-o da fila de sincronização.
Opcionalmente é possível enviar a data de sincronização do pedido, desta forma garantindo que os dados consumidos correspondem a ultima versão do pedido, o valor a ser enviado deve ser capturado ao receber o pedido da fila de sincronização através do atributo data_sincronizacao.
Esta funcionalidade garante que caso o pedido seja atualizado durante a sincronização, o mesmo continue na fila até que a ultima versão seja sincronizada, evitando a inconsistencia dos dados.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
Pedidos ¶
GET https://api.minhaloja.com.br/pedidos/0001
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"codigo": "0001",
"data_sincronizacao": "2018-03-04 09:25:24",
"data_cadastro": "2018-03-04 09:25:24",
"data_atualizacao": "2018-03-04 09:25:24",
"status_sincronizacao": "NOT_SYNCED",
"canal": "LOJA",
"codigo_referencia": "Meli-1236789",
"valor_total": 205.93,
"valor_frete": 10.82,
"valor_desconto": 20.01,
"valor_cash_back": 10.5,
"juros": 5.99,
"ultimo_evento": "aguardando_pagamento",
"data_entrega": "2018-04-10",
"observacoes": "Entregar após às 18h",
"cliente": {
"codigo_referencia": "015AB",
"nome": "Cliente de Teste",
"telefone": "(28) 99999-9999",
"email": "cliente@email.com.br",
"cpf": "000.000.000-00",
"data_nascimento": "1990-10-20",
"razao_social": "Empresa de Teste LTDA",
"cnpj": "00.000.000/0000-00",
"inscricao_estadual": "0000.0000"
},
"endereco_entrega": {
"cep": "29315-322",
"rua": "Rua Otaviano Prado",
"numero": "245",
"bairro": "IBC",
"cidade": "Cachoeiro de Itapemirim",
"estado": "ES",
"complemento": "foo",
"referencia": "bar"
},
"endereco_cobranca": {
"cep": "29315-322",
"rua": "Rua Otaviano Prado",
"numero": "245",
"bairro": "IBC",
"cidade": "Cachoeiro de Itapemirim",
"estado": "ES",
"complemento": "foo",
"referencia": "bar"
},
"itens": [
{
"sku": "P001",
"nome": "Produto de exemplo",
"quantidade": 2,
"preco": 98.76,
"codigo_auxiliar": "124654",
"opcionais": [
{
"id": 1,
"descricao": "Garantia Estendida 03 meses",
"valor": 10.5,
"grupo": {
"id": 1
}
}
]
}
],
"transporte": {
"servico": "Correios PAC",
"codigo_rastreio": "KK90912121BR",
"url_rastreio": "www.urldeexemplo.com.br",
"transportadora": "Correios",
"metodo": "PAC",
"endereco_retirada": {
"empresa": "Arco Informática",
"logradouro": "Rua Otaviano Prado",
"numero": "245",
"bairro": "IBC",
"cidade": "Cachoeiro de Itapemirim",
"uf": "ES",
"cep": "29315-322"
}
},
"pagamento": {
"metodo_codigo": "boleto",
"metodo_descricao": "Boleto",
"referencia_forma_pagamento": "cartao_credito_12",
"nsu": "000000",
"url": "www.urlexemplo.com.br",
"boleto_numero": "000-000",
"boleto_linha_digitavel": "00000-00000-00000",
"boleto_vencimento": "2018-10-29",
"parcelas_quantidade": 2,
"parcelas_valor": 48.75,
"cartao_bandeira": "VISA",
"cartao_titular": "Nome de exemplo",
"cartao_numero": "4111",
"cartao_expiracao_mes": 12,
"cartao_expiracao_ano": 2018,
"codigo_transacao": "AAAAA-AB12546-ARC5475",
"troco": "10,00",
"gateway": "PagSeguro"
},
"historico_evento": [
{
"evento_codigo: `pedido_recebido`": "",
"evento_descricao": "Pedido recebido",
"data": "2018-02-15 20:00:00"
}
],
"vendedor": {
"nome": "Vendedor de Teste",
"email": "vendedor@email.com.br",
"cpf": "000.000.000-00",
"telefone": "(28) 99999-9999",
"matricula": "VEND001"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código do pedido"
},
"data_sincronizacao": {
"type": "string",
"description": "Data e hora em que o pedido foi adicionado a fila de sincronização"
},
"data_cadastro": {
"type": "string",
"description": "Data e hora de criação do pedido"
},
"data_atualizacao": {
"type": "string",
"description": "Data e hora de atualização do pedido"
},
"status_sincronizacao": {
"type": "string",
"description": "Status da sincronização do pedido"
},
"canal": {
"type": "string",
"description": "Canal de venda onde o pedido foi originado"
},
"codigo_referencia": {
"type": "string",
"description": "Código de referência do pedido no canal de venda onde o pedido foi originado"
},
"valor_total": {
"type": "number",
"description": "Valor total do pedido"
},
"valor_frete": {
"type": "number",
"description": "Valor do frete"
},
"valor_desconto": {
"type": "number",
"description": "Valor do desconto do pedido"
},
"valor_cash_back": {
"type": "number",
"description": "Valor do cash back utilizado no pedido"
},
"juros": {
"type": "number",
"description": "Valor do juros"
},
"ultimo_evento": {
"type": "string",
"description": "Codigo do ultimo evento registrado"
},
"data_entrega": {
"type": "string",
"description": "Data de entrega estimada"
},
"observacoes": {
"type": "string",
"description": "Observações do pedido"
},
"cliente": {
"type": "object",
"properties": {
"codigo_referencia": {
"type": "string",
"description": "Código de referência do cliente"
},
"nome": {
"type": "string",
"description": "Nome do cliente"
},
"telefone": {
"type": "string",
"description": "Telefone do cliente"
},
"email": {
"type": "string",
"description": "E-mail do cliente"
},
"cpf": {
"type": "string",
"description": "CPF do cliente"
},
"data_nascimento": {
"type": "string",
"description": "Data de nascimento do cliente"
},
"razao_social": {
"type": "string",
"description": "Razão Social da empresa do cliente"
},
"cnpj": {
"type": "string",
"description": "CNPJ da empresa do cliente"
},
"inscricao_estadual": {
"type": "string",
"description": "Inscrição Estadual da empresa do cliente"
}
},
"required": [
"nome",
"telefone",
"email",
"cpf",
"data_nascimento"
],
"description": "Dados do cliente"
},
"endereco_entrega": {
"type": "object",
"properties": {
"cep": {
"type": "string",
"description": "CEP"
},
"rua": {
"type": "string",
"description": "Rua/Avenida"
},
"numero": {
"type": "string",
"description": "Numero"
},
"bairro": {
"type": "string",
"description": "Bairro"
},
"cidade": {
"type": "string",
"description": "Cidade"
},
"estado": {
"type": "string",
"description": "Estado (sigla da UF)"
},
"complemento": {
"type": "string",
"description": "Complemento"
},
"referencia": {
"type": "string",
"description": "Referência"
}
},
"required": [
"cep",
"rua",
"bairro",
"cidade",
"estado"
],
"description": "Endereço de entrega do pedido"
},
"endereco_cobranca": {
"type": "object",
"properties": {
"cep": {
"type": "string",
"description": "CEP"
},
"rua": {
"type": "string",
"description": "Rua/Avenida"
},
"numero": {
"type": "string",
"description": "Numero"
},
"bairro": {
"type": "string",
"description": "Bairro"
},
"cidade": {
"type": "string",
"description": "Cidade"
},
"estado": {
"type": "string",
"description": "Estado (sigla da UF)"
},
"complemento": {
"type": "string",
"description": "Complemento"
},
"referencia": {
"type": "string",
"description": "Referência"
}
},
"required": [
"cep",
"rua",
"bairro",
"cidade",
"estado"
],
"description": "Endereço de cobranca do pedido"
},
"itens": {
"type": "array",
"description": "Dados dos itens do pedido"
},
"transporte": {
"type": "object",
"properties": {
"servico": {
"type": "string",
"description": "Serviço de transporte utilizado"
},
"codigo_rastreio": {
"type": "string",
"description": "Código de rastreamento da transportadora"
},
"url_rastreio": {
"type": "string",
"description": "URL de rastreio do pedido"
},
"transportadora": {
"type": "string",
"description": "Transportadora"
},
"metodo": {
"type": "string",
"description": "Método de envio"
},
"endereco_retirada": {
"type": "object",
"properties": {
"empresa": {
"type": "string",
"description": "CEP"
},
"logradouro": {
"type": "string",
"description": "Rua/Avenida"
},
"numero": {
"type": "string",
"description": "Numero"
},
"bairro": {
"type": "string",
"description": "Bairro"
},
"cidade": {
"type": "string",
"description": "Cidade"
},
"uf": {
"type": "string",
"description": "UF"
},
"cep": {
"type": "string",
"description": "CEP"
}
},
"required": [
"empresa",
"logradouro",
"bairro",
"cidade",
"uf",
"cep"
],
"description": "Endereço de retirada para pedidos com retirada na loja"
}
},
"required": [
"servico"
],
"description": "Dados do frete e da transportadora"
},
"pagamento": {
"type": "object",
"properties": {
"metodo_codigo": {
"type": "string",
"description": "Código do método de pagamento"
},
"metodo_descricao": {
"type": "string",
"description": "Descrição do método de pagamento"
},
"referencia_forma_pagamento": {
"type": "string",
"description": "Código de referência da forma de pagamento utilizada"
},
"nsu": {
"type": "string",
"description": "NSU do pagamento no cartão"
},
"url": {
"type": "string",
"description": "URL de pagamento do pedido"
},
"boleto_numero": {
"type": "string",
"description": "\"Nosso numero\" do boleto"
},
"boleto_linha_digitavel": {
"type": "string",
"description": "Linha digitavel do boleto"
},
"boleto_vencimento": {
"type": "string",
"description": "Data de vencimento do boleto"
},
"parcelas_quantidade": {
"type": "number",
"description": "Quantidade de parcelas do pagamento no cartão"
},
"parcelas_valor": {
"type": "number",
"description": "Valor das parcelas"
},
"cartao_bandeira": {
"type": "string",
"description": "Bandeira do cartão utilizado"
},
"cartao_titular": {
"type": "string",
"description": "Nome do titular do cartão"
},
"cartao_numero": {
"type": "string",
"description": "4 ultimos digitos do cartão utilizado"
},
"cartao_expiracao_mes": {
"type": "number",
"description": "Mês de expiração da validade do cartão"
},
"cartao_expiracao_ano": {
"type": "number",
"description": "Ano de expiração da validade do cartão"
},
"codigo_transacao": {
"type": "string",
"description": "Código da transação no gateway de pagamento"
},
"troco": {
"type": "string",
"description": "Troco que o cliente informou no pedido"
},
"gateway": {
"type": "string",
"description": "Nome do gateway de pagamento do pedido"
}
},
"required": [
"metodo_codigo",
"metodo_descricao"
],
"description": "Dados do pagamento do pedido"
},
"historico_evento": {
"type": "array",
"description": "Histórico de eventos do pedido"
},
"vendedor": {
"type": "object",
"properties": {
"nome": {
"type": "string",
"description": "Nome do vendedor"
},
"email": {
"type": "string",
"description": "E-mail do vendedor"
},
"cpf": {
"type": "string",
"description": "CPF do vendedor"
},
"telefone": {
"type": "string",
"description": "Telefone do vendedor"
},
"matricula": {
"type": "string",
"description": "Matrícula do vendedor"
}
},
"description": "Dados do vendedor vinculado ao pedido"
}
},
"required": [
"codigo",
"data_cadastro",
"data_atualizacao",
"status_sincronizacao",
"canal",
"valor_total",
"valor_frete",
"valor_desconto",
"valor_cash_back",
"ultimo_evento",
"data_entrega",
"cliente",
"itens",
"pagamento",
"historico_evento"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Receber um pedidoGET/pedidos/{codigo}
Recupera um pedido a partir do código especificado.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/separacao
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "pedido_separacao",
"data": "2018-06-10 13:10:00"
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
}
},
"required": [
"evento"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Pedido em separaçãoPOST/pedidos/{codigo}/separacao
Informa que o pedido esta na fase de separação de produtos.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/fatura
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "pedido_faturado",
"data": "2018-06-10 13:10:00",
"fatura": {
"chave": "1234567890000000000000",
"data_emissao": "2018-10-12 12:30:30",
"valor_itens": 200.45,
"valor_total": 250.45,
"codigo_cfop": "5.000"
}
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
},
"fatura": {
"type": "object",
"properties": {
"chave": {
"type": "string",
"description": "Chave da NFe"
},
"data_emissao": {
"type": "string",
"description": "Data e hora de emisssão da NFe"
},
"valor_itens": {
"type": "number",
"description": "Valor total dos itens da NFe"
},
"valor_total": {
"type": "number",
"description": "Valor total da NFe"
},
"codigo_cfop": {
"type": "string",
"description": "Código CFOP da NFe"
}
},
"required": [
"chave"
],
"description": "Informações da NFe"
}
},
"required": [
"evento",
"fatura"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Faturar um pedidoPOST/pedidos/{codigo}/fatura
Atualiza o pedido com os dados da Nota Fiscal e altera o status.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/transporte
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "pedido_enviado",
"data": "2018-06-10 13:10:00",
"rastreio": {
"codigo": "BR123123123DD",
"url": "www.correios.com.br",
"transportadora": "Correios",
"metodo": "PAC"
}
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
},
"rastreio": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código de rastreio do pedido na transportadora"
},
"url": {
"type": "string",
"description": "URL da página de rastreio da transportadora"
},
"transportadora": {
"type": "string",
"description": "Empresa responsável pelo transporte do pedido"
},
"metodo": {
"type": "string",
"description": "Método de envio utilizado"
}
},
"required": [
"codigo"
],
"description": "Informações de rastreio do pedido"
}
},
"required": [
"evento"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Enviar dados de transportePOST/pedidos/{codigo}/transporte
Atualiza o pedido com os dados de rastreio e do envio, e altera o status.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/entrega
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "pedido_entregue",
"data": "2018-06-10 13:10:00"
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
}
},
"required": [
"evento"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Confirmar entregaPOST/pedidos/{codigo}/entrega
Atualiza o pedido como entregue e finaliza o mesmo.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/excecao_transporte
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "excecao_transporte",
"data": "2018-06-10 13:10:00",
"observacao": "Exemplo de obervação"
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
},
"observacao": {
"type": "string",
"description": "Observação da exceção ocorrida"
}
},
"required": [
"evento"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Exceção de transportePOST/pedidos/{codigo}/excecao_transporte
Informa que um problema ocorreu durante o transporte do pedido.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/cancelamento
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "pedido_cancelado",
"data": "2018-06-10 13:10:00"
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
}
},
"required": [
"evento"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Cancelar pedidoPOST/pedidos/{codigo}/cancelamento
Atualiza o pedido com os dados de cancelamento.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/analise
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "pedido_analise",
"data": "2018-06-10 13:10:00"
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
}
},
"required": [
"evento"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Pedido em analisePOST/pedidos/{codigo}/analise
Informa que o pedido esta em análise.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/devolucao
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "pedido_devolvido",
"data": "2018-06-10 13:10:00"
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
}
},
"required": [
"evento"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Pedido devolvidoPOST/pedidos/{codigo}/devolucao
Informa que o pedido foi devolvido para a loja.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/pagamento
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "pagamento_recebido",
"data": "2018-06-10 13:10:00"
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
}
},
"required": [
"evento"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Pedido PagoPOST/pedidos/{codigo}/pagamento
Atualiza o pedido com os dados de pagamento.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/liberado-retirada
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "liberado_retirada",
"data": "2018-06-10 13:10:00"
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
}
},
"required": [
"evento"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Pedido Liberado para RetiradaPOST/pedidos/{codigo}/liberado-retirada
Informa que o pedido esta liberado para retirada.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
POST https://api.minhaloja.com.br/pedidos/0001/producao
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"evento": "pedido_producao",
"data": "2021-04-23 11:30:00"
}Schema
{
"type": "object",
"properties": {
"evento": {
"type": "string",
"description": "Código do evento do pedido"
},
"data": {
"type": "string",
"description": "Data de registro do evento"
}
},
"required": [
"evento"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Pedido em ProduçãoPOST/pedidos/{codigo}/producao
Informa que o pedido está na fase de produção.
URI Parameters
- codigo
string(required) Example: 0001Código do pedido
Cash back ¶
É possível gerar e utilizar cash back na loja.
Cada cash back deve possuir o CPF, nome e e-mail do cliente, além também do valor para geração ou utilização.
OBSERVAÇÃO:
Na geração do cash back, caso o cliente não tenha cadastro no e-commerce, o cliente será cadastrado e posteriormente completará seu cadastro para ter acesso ao cash back gerado.
Cash back ¶
POST https://api.minhaloja.com.br/cash-back/gerar
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"cpf": "000.000.000-00",
"nome": "Cliente de Teste",
"email": "cliente@email.com.br",
"valor_pedido": 10
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"cpf": {
"type": "string",
"description": "CPF do cliente"
},
"nome": {
"type": "string",
"description": "Nome do cliente"
},
"email": {
"type": "string",
"description": "E-mail do cliente"
},
"valor_pedido": {
"type": "number",
"description": "Valor total do pedido para geração do cash back"
}
},
"required": [
"cpf",
"nome",
"email",
"valor_pedido"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Gerar cash backPOST/cash-back/gerar
Gerar um novo cash back.
POST https://api.minhaloja.com.br/cash-back/utilizar
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"cpf": "000.000.000-00",
"nome": "Cliente de Teste",
"email": "cliente@email.com.br",
"valor": 10
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"cpf": {
"type": "string",
"description": "CPF do cliente"
},
"nome": {
"type": "string",
"description": "Nome do cliente"
},
"email": {
"type": "string",
"description": "E-mail do cliente"
},
"valor": {
"type": "number",
"description": "Valor total a ser utilizado"
}
},
"required": [
"cpf",
"nome",
"email",
"valor"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Utilizar cash backPOST/cash-back/utilizar
Utilizar um novo cash back.
GET https://api.minhaloja.com.br/cash-back/consultar
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"cpf": "000.000.000-00"
}Schema
{
"type": "object",
"properties": {
"cpf": {
"type": "string",
"description": "CPF do cliente"
}
},
"required": [
"cpf"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"cpf": "000.000.000-00"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"cpf": {
"type": "string",
"description": "CPF do cliente"
}
},
"required": [
"cpf"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Consultar cash backGET/cash-back/consultar
Consultar o cash back do cliente.
Clientes ¶
É possível visualizar, criar e editar os clientes cadastrados na loja.
OBSERVAÇÃO:
No momento da criação dos clientes é possível definir qual será sua senha inicial, porém, a alteração da mesma deverá ser feita dentro da loja.
Clientes ¶
GET https://api.minhaloja.com.br/clientes/015AB
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"codigo_referencia": "015AB",
"nome": "Nome do Cliente",
"razao_social": "Razão Social Ltda.",
"cpf": "322.165.310-73",
"cnpj": "14.290.052/0001-54",
"inscricao_estadual": "16109552-6",
"email": "cliente@email.com.br",
"telefone": "(27) 3522-3213",
"telefone_secundario": "(27) 9142-3213",
"endereco": {
"cep": "29315-322",
"rua": "Rua Otaviano Prado",
"numero": "245",
"bairro": "IBC",
"cidade": "Cachoeiro de Itapemirim",
"uf": "ES",
"complemento": "foo",
"referencia": "bar"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"codigo_referencia": {
"type": "string",
"description": "Código de referência do cliente"
},
"nome": {
"type": "string",
"description": "Nome do cliente"
},
"razao_social": {
"type": "string",
"description": "Razão Social do cliente"
},
"cpf": {
"type": "string",
"description": "CPF do cliente"
},
"cnpj": {
"type": "string",
"description": "CNPJ do cliente"
},
"inscricao_estadual": {
"type": "string",
"description": "Inscrição estadual do cliente"
},
"email": {
"type": "string",
"description": "Email do cliente"
},
"telefone": {
"type": "string",
"description": "Telefone do cliente"
},
"telefone_secundario": {
"type": "string",
"description": "Telefone secundário do cliente"
},
"endereco": {
"type": "object",
"properties": {
"cep": {
"type": "string",
"description": "CEP no formato: xxxxx-xxx"
},
"rua": {
"type": "string",
"description": "Rua/Avenida"
},
"numero": {
"type": "string",
"description": "Numero"
},
"bairro": {
"type": "string",
"description": "Bairro"
},
"cidade": {
"type": "string",
"description": "Cidade"
},
"uf": {
"type": "string",
"description": "Estado (sigla da UF)"
},
"complemento": {
"type": "string",
"description": "Complemento"
},
"referencia": {
"type": "string",
"description": "Referência"
}
},
"required": [
"cep",
"rua",
"numero",
"bairro",
"cidade",
"uf"
],
"description": "Dados de endereço do cliente"
}
},
"required": [
"endereco"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Receber clienteGET/clientes/{codigo_referencia}
URI Parameters
- codigo_referencia
string(required) Example: 015ABCódigo de referência do cliente ou CPF (somente números)
POST https://api.minhaloja.com.br/clientes
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"codigo_referencia": "015AB",
"nome": "Nome do Cliente",
"razao_social": "Razão Social Ltda.",
"cpf": "322.165.310-73",
"cnpj": "14.290.052/0001-54",
"inscricao_estadual": "16109552-6",
"email": "cliente@email.com.br",
"telefone": "(27) 3522-3213",
"telefone_secundario": "(27) 9142-3213",
"endereco": {
"cep": "29315-322",
"rua": "Rua Otaviano Prado",
"numero": "245",
"bairro": "IBC",
"cidade": "Cachoeiro de Itapemirim",
"uf": "ES",
"complemento": "foo",
"referencia": "bar"
}
}Schema
{
"type": "object",
"properties": {
"codigo_referencia": {
"type": "string",
"description": "Código de referência do cliente"
},
"nome": {
"type": "string",
"description": "Nome do cliente"
},
"razao_social": {
"type": "string",
"description": "Razão Social do cliente"
},
"cpf": {
"type": "string",
"description": "CPF do cliente no formato: xxx.xxx.xxx-xx"
},
"cnpj": {
"type": "string",
"description": "CNPJ do cliente no formato: xx.xxx.xxx/xxxx-xx"
},
"inscricao_estadual": {
"type": "string",
"description": "Inscrição estadual do cliente"
},
"email": {
"type": "string",
"description": "Email do cliente"
},
"telefone": {
"type": "string",
"description": "Telefone do cliente no formato (xx) xxxx-xxxx ou (xx) xxxxx-xxxx"
},
"telefone_secundario": {
"type": "string",
"description": "Telefone secundário do cliente no formato (xx) xxxx-xxxx ou (xx) xxxxx-xxxx"
},
"endereco": {
"type": "object",
"properties": {
"cep": {
"type": "string",
"description": "CEP no formato: xxxxx-xxx"
},
"rua": {
"type": "string",
"description": "Rua/Avenida"
},
"numero": {
"type": "string",
"description": "Numero"
},
"bairro": {
"type": "string",
"description": "Bairro"
},
"cidade": {
"type": "string",
"description": "Cidade"
},
"uf": {
"type": "string",
"description": "Estado (sigla da UF)"
},
"complemento": {
"type": "string",
"description": "Complemento"
},
"referencia": {
"type": "string",
"description": "Referência"
}
},
"required": [
"cep",
"rua",
"numero",
"bairro",
"cidade",
"uf"
],
"description": "Dados de endereço do cliente"
}
},
"required": [
"nome",
"cpf",
"email",
"telefone",
"endereco"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID da entidade que foi criada"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Criar clientePOST/clientes
PUT https://api.minhaloja.com.br/clientes/015AB
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"nome": "Nome do Cliente",
"razao_social": "Razão Social Ltda.",
"cpf": "322.165.310-73",
"cnpj": "14.290.052/0001-54",
"inscricao_estadual": "16109552-6",
"email": "cliente@email.com.br",
"telefone": "(27) 3522-3213",
"telefone_secundario": "(27) 9142-3213",
"endereco": {
"cep": "29315-322",
"rua": "Rua Otaviano Prado",
"numero": "245",
"bairro": "IBC",
"cidade": "Cachoeiro de Itapemirim",
"uf": "ES",
"complemento": "foo",
"referencia": "bar"
}
}Schema
{
"type": "object",
"properties": {
"nome": {
"type": "string",
"description": "Nome do cliente"
},
"razao_social": {
"type": "string",
"description": "Razão Social do cliente"
},
"cpf": {
"type": "string",
"description": "CPF do cliente no formato: xxx.xxx.xxx-xx"
},
"cnpj": {
"type": "string",
"description": "CNPJ do cliente no formato: xx.xxx.xxx/xxxx-xx"
},
"inscricao_estadual": {
"type": "string",
"description": "Inscrição estadual do cliente"
},
"email": {
"type": "string",
"description": "Email do cliente"
},
"telefone": {
"type": "string",
"description": "Telefone do cliente no formato (xx) xxxx-xxxx ou (xx) xxxxx-xxxx"
},
"telefone_secundario": {
"type": "string",
"description": "Telefone secundário do cliente no formato (xx) xxxx-xxxx ou (xx) xxxxx-xxxx"
},
"endereco": {
"type": "object",
"properties": {
"cep": {
"type": "string",
"description": "CEP no formato: xxxxx-xxx"
},
"rua": {
"type": "string",
"description": "Rua/Avenida"
},
"numero": {
"type": "string",
"description": "Numero"
},
"bairro": {
"type": "string",
"description": "Bairro"
},
"cidade": {
"type": "string",
"description": "Cidade"
},
"uf": {
"type": "string",
"description": "Estado (sigla da UF)"
},
"complemento": {
"type": "string",
"description": "Complemento"
},
"referencia": {
"type": "string",
"description": "Referência"
}
},
"required": [
"cep",
"rua",
"numero",
"bairro",
"cidade",
"uf"
],
"description": "Dados de endereço do cliente"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"codigo_referencia": "015AB",
"nome": "Nome do Cliente",
"razao_social": "Razão Social Ltda.",
"cpf": "322.165.310-73",
"cnpj": "14.290.052/0001-54",
"inscricao_estadual": "16109552-6",
"email": "cliente@email.com.br",
"telefone": "(27) 3522-3213",
"telefone_secundario": "(27) 9142-3213",
"endereco": {
"cep": "29315-322",
"rua": "Rua Otaviano Prado",
"numero": "245",
"bairro": "IBC",
"cidade": "Cachoeiro de Itapemirim",
"uf": "ES",
"complemento": "foo",
"referencia": "bar"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"codigo_referencia": {
"type": "string",
"description": "Código de referência do cliente"
},
"nome": {
"type": "string",
"description": "Nome do cliente"
},
"razao_social": {
"type": "string",
"description": "Razão Social do cliente"
},
"cpf": {
"type": "string",
"description": "CPF do cliente"
},
"cnpj": {
"type": "string",
"description": "CNPJ do cliente"
},
"inscricao_estadual": {
"type": "string",
"description": "Inscrição estadual do cliente"
},
"email": {
"type": "string",
"description": "Email do cliente"
},
"telefone": {
"type": "string",
"description": "Telefone do cliente"
},
"telefone_secundario": {
"type": "string",
"description": "Telefone secundário do cliente"
},
"endereco": {
"type": "object",
"properties": {
"cep": {
"type": "string",
"description": "CEP no formato: xxxxx-xxx"
},
"rua": {
"type": "string",
"description": "Rua/Avenida"
},
"numero": {
"type": "string",
"description": "Numero"
},
"bairro": {
"type": "string",
"description": "Bairro"
},
"cidade": {
"type": "string",
"description": "Cidade"
},
"uf": {
"type": "string",
"description": "Estado (sigla da UF)"
},
"complemento": {
"type": "string",
"description": "Complemento"
},
"referencia": {
"type": "string",
"description": "Referência"
}
},
"required": [
"cep",
"rua",
"numero",
"bairro",
"cidade",
"uf"
],
"description": "Dados de endereço do cliente"
}
},
"required": [
"endereco"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar clientePUT/clientes/{codigo_referencia}
URI Parameters
- codigo_referencia
string(required) Example: 015ABCódigo de referência do cliente ou CPF (somente números)
Opcionais de Produto ¶
É possível visualizar, criar e editar os grupos de opcionais cadastrados na loja para um produto.
Grupos de Opcionais ¶
POST https://api.minhaloja.com.br/produtos/P0001/grupos
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"descricao": "Garantia Estendida",
"multiselecao": true,
"acessoriosGrupo": [
{
"descricao": "Garantia Estendida 03 meses",
"valor": 10.5
}
]
}Schema
{
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do Grupo de Opcionais"
},
"multiselecao": {
"type": "boolean",
"description": "Indica se o cliente pode selecionar ao mesmo tempo mais de um opcional do Grupo"
},
"acessoriosGrupo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do Opcional"
},
"valor": {
"type": "number",
"description": "Valor do Opcional"
}
},
"required": [
"descricao",
"valor"
]
},
"description": "Acessórios Opcionais do Grupo"
}
},
"required": [
"descricao",
"multiselecao"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1,
"descricao": "Garantia Estendida",
"multiselecao": true,
"acessoriosGrupo": [
{
"id": 1,
"descricao": "Garantia Estendida 03 meses",
"valor": 10.5
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Código do Grupo"
},
"descricao": {
"type": "string",
"description": "Descrição do Grupo de Opcionais"
},
"multiselecao": {
"type": "boolean",
"description": "Indica se o cliente pode selecionar ao mesmo tempo mais de um opcional do Grupo"
},
"acessoriosGrupo": {
"type": "array",
"description": "Acessórios Opcionais do Grupo"
}
},
"required": [
"id",
"descricao",
"multiselecao"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Criar Grupo de OpcionaisPOST/produtos/{sku}/grupos
OBSERVAÇÃO: Ao criar um novo grupo de opcionais, é possível adicionar opcionais ao grupo, bastando enviá-los no atributo “acessoriosGrupo”.
URI Parameters
- sku
string(required) Example: P0001Código SKU do produto
PUT https://api.minhaloja.com.br/produtos/P0001/grupos
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brBody
{
"id": 1,
"descricao": "Garantia Estendida",
"multiselecao": true,
"acessoriosGrupo": [
{
"id": 1,
"descricao": "Garantia Estendida 03 meses",
"valor": 10.5
}
]
}Schema
{
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Código do Grupo"
},
"descricao": {
"type": "string",
"description": "Descrição do Grupo de Opcionais"
},
"multiselecao": {
"type": "boolean",
"description": "Indica se o cliente pode selecionar ao mesmo tempo mais de um opcional do Grupo"
},
"acessoriosGrupo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Código do Opcional"
},
"descricao": {
"type": "string",
"description": "Descrição do Opcional"
},
"valor": {
"type": "number",
"description": "Valor do Opcional"
}
},
"required": [
"descricao",
"valor"
]
},
"description": "Acessórios Opcionais do Grupo"
}
},
"required": [
"id",
"descricao",
"multiselecao"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Headers
Content-Type: application/jsonBody
{
"id": 1,
"descricao": "Garantia Estendida",
"multiselecao": true,
"acessoriosGrupo": [
{
"id": 1,
"descricao": "Garantia Estendida 03 meses",
"valor": 10.5
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Código do Grupo"
},
"descricao": {
"type": "string",
"description": "Descrição do Grupo de Opcionais"
},
"multiselecao": {
"type": "boolean",
"description": "Indica se o cliente pode selecionar ao mesmo tempo mais de um opcional do Grupo"
},
"acessoriosGrupo": {
"type": "array",
"description": "Acessórios Opcionais do Grupo"
}
},
"required": [
"id",
"descricao",
"multiselecao"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Atualizar Grupo de OpcionaisPUT/produtos/{sku}/grupos
OBSERVAÇÃO: Ao alterar um novo grupo de opcionais, é possível realizar a adição, alteração e remoção de opcionais.
-
Para adicionar um novo opcional, basta não enviar a propriedade id no novo opcional;
-
Para alterar um opcional basta enviá-lo com o respectivo id e propriedades;
-
Todos os opcionais que não forem enviados serão excluidos automaticamente;
URI Parameters
- sku
string(required) Example: P0001Código SKU do produto
DELETE https://api.minhaloja.com.br/produtos/P0001/grupos/1
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Excluir Grupo de OpcionaisDELETE/produtos/{sku}/grupos/{id}
URI Parameters
- sku
string(required) Example: P0001Código SKU do produto
- id
number(required) Example: 1id do grupo de opcionais
GET https://api.minhaloja.com.br/produtos/P0001/grupos/1
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
{
"id": 1,
"descricao": "Garantia Estendida",
"multiselecao": true,
"acessoriosGrupo": [
{
"id": 1,
"descricao": "Garantia Estendida 03 meses",
"valor": 10.5
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Código do Grupo"
},
"descricao": {
"type": "string",
"description": "Descrição do Grupo de Opcionais"
},
"multiselecao": {
"type": "boolean",
"description": "Indica se o cliente pode selecionar ao mesmo tempo mais de um opcional do Grupo"
},
"acessoriosGrupo": {
"type": "array",
"description": "Acessórios Opcionais do Grupo"
}
},
"required": [
"id",
"descricao",
"multiselecao"
]
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Receber Grupo de OpcionaisGET/produtos/{sku}/grupos/{id}
URI Parameters
- sku
string(required) Example: P0001Código SKU do produto
- id
number(required) Example: 1id do grupo de opcionais
GET https://api.minhaloja.com.br/produtos/P0001/grupos
Requests
Headers
Accept: application/json
Content-type: application/json
X-Api-Key: sTcMJKsK0IvJB914QsLmc-
X-User-Email: api@minhaloja.com.brResponses
Headers
Content-Type: application/jsonBody
[
{
"id": 1,
"descricao": "Garantia Estendida",
"multiselecao": true,
"acessoriosGrupo": [
{
"id": 1,
"descricao": "Garantia Estendida 03 meses",
"valor": 10.5
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Headers
Content-Type: application/jsonBody
{
"descricao": "Falha na autenticação."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Não foi possível encontrar a entidade: foo"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"descricao": "Servidor não conseguiu processar a entidade. Ex: Campo nome deve ser uma String"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do erro"
}
}
}Receber Grupos de Opcionais por ProdutoGET/produtos/{sku}/grupos
URI Parameters
- sku
string(required) Example: P0001Código SKU do produto
Generated by aglio on 31 May 2023