Consultas
Consulta de Produtos
GET
Consulta de produtos
https://localhost:3000/api/loja/codigo-loja
Consulta de todos produtos da sua loja.
Onde encontro minha chave?
Acesse sua conta, cadastro vendedor, chave.
Chave | Tipo | Length |
---|---|---|
minha-chave-de-seguranca | string | 50 |
Onde encontro o código da minha loja?
Acesse sua conta, cadastro vendedor, código do vendedor.
Código | Tipo | Length |
---|---|---|
codigo-da-minha-loja | string | 50 |
BODY raw
{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "minha-senha-123"
}
Example Request
Lista de produtos
curl --location --request GET 'https://localhost:3000/api/loja/codigo-loja' \
--data-raw '{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "minha-senha-123"
}'
Example Response
200 OK
[
{
"idProduto": 0,
"disponivel": true,
"embalagemOriginal": true,
"venda": true,
"desconto": true,
"precoDesconto": 60,
"ativo": true,
"preco": 80,
"decada": 20,
"altura": 5,
"largura": 5,
"comprimento": 5,
"peso": 50,
"garantiaDias": 90,
"quantidade": 71,
"estadoProduto": 0,
"estadoEmabalagem": 1,
"faixaEtaria": 0,
"resumo": "Novo boneco para a sua coleção de UpPup",
"codigoProduto": "1",
"titulo": "UpPup - Os Justiceiros - Aranha humana",
"fabricante": "Nome do Fabricante",
"video": "https://brinquedolivre.com.br/blcodigo/0/meu-video.mp4",
"codigoBarras": "ABC123456",
"codigoML": null,
"codigoBL": "BL-00000000001",
"itensInclusos": "1- Boneco",
"composicao": null,
"certificado": null,
"avisoImportante": "Sem pilhas",
"subcategoria": 1,
"fotos": [
{
"urlArquivo": "https://brinquedolivre.com.br/blcodigo/0/imagem-produto-1.jpg",
"principal": true
}
]
},
{
"idProduto": 0,
"disponivel": true,
"embalagemOriginal": true,
"venda": true,
"desconto": false,
"precoDesconto": 0,
"ativo": true,
"preco": 130,
"decada": 20,
"altura": 5,
"largura": 5,
"comprimento": 5,
"peso": 100,
"garantiaDias": 90,
"quantidade": 5,
"estadoProduto": 0,
"estadoEmabalagem": 1,
"faixaEtaria": 0,
"resumo": "Lançamento- Armadura dourada e azul. ",
"codigoProduto": "1",
"titulo": "UpPup - Os Justiceiros - Gavião de ferro",
"fabricante": "Nome do Fabricante",
"video": "https://brinquedolivre.com.br/blcodigo/0/meu-video.mp4",
"codigoBarras": "XYZ123456",
"codigoML": null,
"codigoBL": "BL-00000000002",
"itensInclusos": "1- Boneco",
"composicao": null,
"certificado": null,
"avisoImportante": "Com pilhas",
"subcategoria": 1,
"fotos": [
{
"urlArquivo": "https://brinquedolivre.com.br/blcodigo/0/imagem-produto-1.jpg",
"principal": true
}
]
}
]
Content-Length: 33575
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/10.0
X-Powered-By: ASP.NET
Date: Wed, 28 Apr 2021 17:48:37 GMT
GET
Não autorizado
https://localhost:3000/api/loja/codigo-loja
Acesso não autorizado
Importante: Preencha todos os campos corretamente com os seus dados de vendedor
Os campos CHAVE, E-MAIL, SENHA e o CÓDIGO DA LOJA são obrigatórios para obter o retorno da sua requisição.
BODY raw
{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "minha-senha-123"
}
Example Request
Não autorizado
curl --location --request GET 'https://localhost:3000/api/loja/codigo-loja' \
--data-raw '{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "123-minha-senha"
}'
Example Response
401 Unauthorized
{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"traceId": "|73ee374e-48589c991bb4b56e."
}
Content-Length: 134
Content-Type: application/problem+json; charset=utf-8
Server: Microsoft-IIS/10.0
X-Powered-By: ASP.NET
Date: Wed, 28 Apr 2021 21:51:02 GMT
GET
Consulta de um único produto
https://localhost:3000/api/loja/codigo-loja/codigo-produto-brinquedo-livre
Utilize o parâmetro código do produto para retornar os dados
BODY raw
{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "minha-senha-123"
}
Example Request
Consulta de um único produto
curl --location --request GET 'https://localhost:3000/api/loja/codigo-loja/codigo-produto-brinquedo-livre' \
--data-raw '{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "minha-senha-123"
}'
Example Response
200 OK
{
{
"idProduto": 141,
"disponivel": true,
"embalagemOriginal": true,
"venda": true,
"desconto": false,
"precoDesconto": 0,
"ativo": true,
"preco": 111,
"decada": 20,
"altura": 1,
"largura": 1,
"comprimento": 1,
"peso": 500,
"garantiaDias": 90,
"quantidade": 1,
"estadoProduto": 3,
"estadoEmabalagem": 1,
"faixaEtaria": 0,
"resumo": null,
"codigoProduto": null,
"titulo": "1",
"fabricante": null,
"video": "uploads/bRxtsm22/141/sample_640x360.mp4",
"codigoBarras": null,
"codigoML": null,
"codigoBL": "BL-70789141497",
"itensInclusos": "teste",
"composicao": null,
"certificado": null,
"avisoImportante": null,
"subcategoria": null,
"fotos": [
{
"urlArquivo": "uploads/bRxtsm22/141/",
"principal": true
}
]
}
Content-Length: 639
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/10.0
X-Powered-By: ASP.NET
Date: Wed, 28 Apr 2021 21:45:41 GMT
Importação
Campo | Formato |
---|---|
disponivel
Obrigatório
|
bool (true ou false) |
embalagemOriginal
Obrigatório
|
bool (true ou false) |
venda
Obrigatório
|
bool (true ou false) |
desconto
Obrigatório
|
bool (true ou false) |
preco
Obrigatório
|
decimal (valor deve ser maior que 0) |
precoDesconto | decimal (valor deve ser maior que 0) |
Decada
Obrigatório
|
int
|
altura
Obrigatório
|
int (valor deve ser maior que 0) |
largura
Obrigatório
|
int (valor deve ser maior que 0) |
largura
Obrigatório
|
int (valor deve ser maior que 0) |
comprimento
Obrigatório
|
int (valor deve ser maior que 0) |
peso
Obrigatório
|
int (valor deve ser maior que 0) |
garantia em dias
Obrigatório
|
int (valor deve ser maior que 0) |
quantidade
Obrigatório
|
int (valor deve ser maior que 0) |
idSubcategoria
Obrigatório
|
int (valor deve ser maior que 0) |
estadoProduto
Obrigatório
|
enum
|
estadoEmbalagem
Obrigatório
|
enum
|
estadoEmbalagem
Obrigatório
|
enum
|
resumo (descrição do produto)
Obrigatório
|
string length[500] |
codigoProduto
Obrigatório
|
string length[350] |
titulo
Obrigatório
|
string length[350] |
fabricante | string length[100] |
video | string length[500] |
codigoBarras | string length[20] |
codigoML | string length[20] |
itensInclusos
Obrigatório
|
string length[5000] |
composicao
Obrigatório
|
string length[5000] |
certificado
Obrigatório
|
string length[100] |
avisoImportante
Obrigatório
|
string length[255] |
fotos[]
Apenas uma foto pode ser a principal.
|
array[] máximo de 4 fotos
|
POST
Importação do Produto
https://localhost:3000/api/loja/codigo-loja/importar
BODY raw
{
{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "minha-senha-123",
"Produtos":
{
"disponivel": true,
"embalagemOriginal": true,
"venda": true,
"desconto": true,
"precoDesconto": 10.00,
"ativo": true,
"preco": 15.00,
"decada": 2020,
"altura": 1,
"largura": 2,
"comprimento": 3,
"peso": 5,
"garantiaDias": 90,
"quantidade": 1,
"estadoProduto": 1,
"estadoEmabalagem": 0,
"faixaEtaria": 0,
"resumo": null,
"codigoProduto": "COD123",
"titulo": "Produto API teste 2000",
"fabricante": "Fabricante",
"video": "https://player.vimeo.com/external/507417765.sd.mp4?s=463546a640a2007e2cf5c143fcd306469900b8a0&profile_id=139&oauth2_token_id=57447761",
"codigoBarras": "Código de barras",
"codigoML": null,
"codigoBL": "BL-77453235998",
"itensInclusos": "Itens inclusos",
"composicao": "Composição",
"certificado": "Certificado",
"avisoImportante": null,
"subcategoria": "2",
"fotos": [
{
"urlArquivo": "https://images.pexels.com/photos/1767434/img.jpg",
"principal": true
},
{
"urlArquivo": "https://images.pexels.com/photos/1037995/img.jpg",
"principal": false
},
{
"urlArquivo": "https://images.pexels.com/photos/207891/img.jpg",
"principal": false
},
{
"urlArquivo": "https://images.pexels.com/photos/163036/img.jpg",
"principal": false
}
]
}
}
Example Request
Inserir
curl --location --request POST 'https://localhost:3000/api/loja/importar' \
curl --location --request POST 'https://localhost:3000/api/loja/importar' \
--data-raw '{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "minha-senha-123",
"Produtos":
{
"disponivel": true,
"embalagemOriginal": true,
"venda": true,
"desconto": true,
"precoDesconto": 10.00,
"ativo": true,
"preco": 15.00,
"decada": 2020,
"altura": 1,
"largura": 2,
"comprimento": 3,
"peso": 5,
"garantiaDias": 90,
"quantidade": 1,
"estadoProduto": 1,
"estadoEmabalagem": 0,
"faixaEtaria": 0,
"resumo": null,
"codigoProduto": "COD123",
"titulo": "Produto API teste 2000",
"fabricante": "Fabricante",
"video": "https://player.vimeo.com/external/507417765.sd.mp4?s=463546a640a2007e2cf5c143fcd306469900b8a0&profile_id=139&oauth2_token_id=57447761",
"codigoBarras": "Código de barras",
"codigoML": null,
"codigoBL": "BL-77453235998",
"itensInclusos": "Itens inclusos",
"composicao": "Composição",
"certificado": "Certificado",
"avisoImportante": null,
"subcategoria": "2",
"fotos": [
{
"urlArquivo": "https://images.pexels.com/photos/1767434/img.jpg",
"principal": true
},
{
"urlArquivo": "https://images.pexels.com/photos/1037995/img.jpg",
"principal": false
},
{
"urlArquivo": "https://images.pexels.com/photos/207891/img.jpg",
"principal": false
},
{
"urlArquivo": "https://images.pexels.com/photos/163036/img.jpg",
"principal": false
}
]
}
}'
Example Response
200 OK
[
{
"codigoBL": "BL-0000000008",
"codigoProduto": "COD123",
"titulo": "Produto API teste 2000"
}
]
Content-Length: 90
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/10.0
X-Powered-By: ASP.NET
Date: Wed, 28 Apr 2021 23:31:46 GMT
Atualização
PUT
Atualizar produto
https://localhost:3000/api/loja/codigo-loja/codigo-produto-brinquedo-livre
BODY raw
{
{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "minha-senha-123",
"Produtos": {
"disponivel": true,
"embalagemOriginal": true,
"venda": true,
"desconto": true,
"precoDesconto": 10.00,
"ativo": true,
"preco": 150.00,
"decada": 2020,
"altura": 1,
"largura": 2,
"comprimento": 3,
"peso": 5,
"garantiaDias": 90,
"quantidade": 1,
"estadoProduto": 1,
"estadoEmabalagem": 0,
"faixaEtaria": 0,
"resumo": null,
"codigoProduto": "COD123",
"titulo": "Produto API teste 200122",
"fabricante": "Fabricante",
"video": "",
"codigoBarras": "Código de barras",
"codigoML": null,
"codigoBL": "BL-70455237296",
"itensInclusos": "Itens inclusos",
"composicao": "Composição",
"certificado": "Certificado",
"avisoImportante": null,
"subcategoria": "2"
}
}
Example Request
Atualização do produto
curl --location --request PUT 'https://localhost:3000/api/loja/codigo-loja/codigo-produto-brinquedo-livre' \
curl --location --request PUT 'https://localhost:3000/api/loja/codigo-loja/codigo-produto-brinquedo-livre' \
--data-raw '{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "minha-senha-123",
"Produtos": {
"disponivel": true,
"embalagemOriginal": true,
"venda": true,
"desconto": true,
"precoDesconto": 10.00,
"ativo": true,
"preco": 150.00,
"decada": 2020,
"altura": 1,
"largura": 2,
"comprimento": 3,
"peso": 5,
"garantiaDias": 90,
"quantidade": 1,
"estadoProduto": 1,
"estadoEmabalagem": 0,
"faixaEtaria": 0,
"resumo": null,
"codigoProduto": "COD123",
"titulo": "Produto API teste 3",
"fabricante": "Fabricante",
"video": "",
"codigoBarras": "Código de barras",
"codigoML": null,
"codigoBL": "BL-70455237296",
"itensInclusos": "Itens inclusos",
"composicao": "Composição",
"certificado": "Certificado",
"avisoImportante": null,
"subcategoria": "2"
}
}'
Example Response
200 OK
Item atualizado
Content-Length: 1056
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/10.0
X-Powered-By: ASP.NET
Date: Thu, 29 Apr 2021 13:08:18 GMT
Deletar
DEL
New Request
https://localhost:3000/api/loja/codigo-loja/codigo-produto-brinquedo-livre
BODY raw
{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "123-minha-senha"
}
Example Request
New Request
curl --location --request DELETE 'https://localhost:3000/api/loja/codigo-loja/codigo-produto-brinquedo-livre' \
--data-raw '{
"Chave": "minha-chave-de-seguranca",
"Email": "seu-email@brinquedolivre.com.br",
"Senha": "123-minha-senha"
}'
Example Response
200 OK
Item inativado
Content-Length: 1056
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/10.0
X-Powered-By: ASP.NET
Date: Thu, 29 Apr 2021 13:08:18 GMT
Departamentos
Retorno dos 3 níveis de departamentos:
- Departamentos
- -Categorias
- --Subcategorias
GET
Departamentos
https://localhost:3000/api/loja/departamentos/
Retorno de todos os departamentos com sues subniveis.
Example Request
Retorno de departamentos
curl --location --request GET 'https://localhost:3000/api/loja/departamentos/'
Example Response
200 OK
[
{
"idDepartamento": 4,
"departamento": "Artes e Atividades Lúdicas",
"categoriasApi": [
{
"idCategoria": 8,
"categoria": "Fantoches e Marionetes",
"subCategoriaApi": [
{
"idSubcategoria": 3,
"subcategoria": "Fantoches de Dedo"
},
{
"idSubcategoria": 4,
"subcategoria": "Fantoches de mão"
},
{
"idSubcategoria": 5,
"subcategoria": "Fantoches Artesanais"
},
{
"idSubcategoria": 6,
"subcategoria": "Marionetes de corda"
},
{
"idSubcategoria": 7,
"subcategoria": "Marionetes de palito"
},
{
"idSubcategoria": 8,
"subcategoria": "Outros Fantoches"
},
{
"idSubcategoria": 9,
"subcategoria": "Outros Marionetes"
},
{
"idSubcategoria": 222,
"subcategoria": "1"
}
]
},
{
"idCategoria": 9,
"categoria": "Kit Artesanato",
"subCategoriaApi": [
{
"idSubcategoria": 10,
"subcategoria": "Tintas"
},
{
"idSubcategoria": 11,
"subcategoria": "Pincéis"
},
{
"idSubcategoria": 12,
"subcategoria": "Telas"
},
{
"idSubcategoria": 13,
"subcategoria": "Colas para Artesanato"
},
{
"idSubcategoria": 14,
"subcategoria": "Itens em MDF"
},
{
"idSubcategoria": 15,
"subcategoria": "Kits prontos para artesanato"
},
{
"idSubcategoria": 16,
"subcategoria": "Armarinho"
}
]
},
{
"idCategoria": 10,
"categoria": "Materiais para Desenho",
"subCategoriaApi": [
{
"idSubcategoria": 17,
"subcategoria": "Cadernos de Desenho"
},
{
"idSubcategoria": 18,
"subcategoria": "Folhas para Desenho"
},
{
"idSubcategoria": 19,
"subcategoria": "Telas"
},
{
"idSubcategoria": 20,
"subcategoria": "Lápis especiais"
}
]
},
{
"idCategoria": 11,
"categoria": "Materiais para Pintura",
"subCategoriaApi": [
{
"idSubcategoria": 21,
"subcategoria": "Pincéis"
},
{
"idSubcategoria": 22,
"subcategoria": "Tintas"
},
{
"idSubcategoria": 23,
"subcategoria": "Telas"
},
{
"idSubcategoria": 24,
"subcategoria": "Lápis de cor"
},
{
"idSubcategoria": 25,
"subcategoria": "Acessórios"
}
]
}
]
},
{
"idDepartamento": 5,
"departamento": "Blocos de Montar e Empilhar",
"categoriasApi": [
{
"idCategoria": 12,
"categoria": "Brinquedos de Montar",
"subCategoriaApi": [
{
"idSubcategoria": 26,
"subcategoria": "Blocos de Montar Kre-o"
},
{
"idSubcategoria": 27,
"subcategoria": "Lego"
},
{
"idSubcategoria": 33,
"subcategoria": "Outros"
}
]
},
{
"idCategoria": 13,
"categoria": "Brinquedos de Empilhar",
"subCategoriaApi": [
{
"idSubcategoria": 28,
"subcategoria": "Mega Bloks"
},
{
"idSubcategoria": 32,
"subcategoria": "Outros"
}
]
},
{
"idCategoria": 14,
"categoria": "Brinquedos de Encaixar",
"subCategoriaApi": [
{
"idSubcategoria": 29,
"subcategoria": "Cubos"
},
{
"idSubcategoria": 30,
"subcategoria": "Caixas"
},
{
"idSubcategoria": 31,
"subcategoria": "Outros"
}
]
}
]
}
]
Content-Length: 24167
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/10.0
X-Powered-By: ASP.NET
Date: Tue, 04 May 2021 00:59:44 GMT
GET
Retorno por departamento
https://localhost:3000/api/loja/departamentos/3
Utilize o ID do departamento para retornar apenas os subniveis.
Example Request
Retorno por departamento
curl --location --request GET 'https://localhost:3000/api/loja/departamentos/3'
Example Response
200 OK
[
{
"idDepartamento": 3,
"departamento": "Brinquedos para Bebês",
"categoriasApi": [
{
"idCategoria": 142,
"categoria": "Andadores e Primeiros Passos",
"subCategoriaApi": []
},
{
Content-Length: 781
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/10.0
X-Powered-By: ASP.NET
Date: Tue, 04 May 2021 01:04:37 GMT
GET
Categorias
https://localhost:3000/api/loja/categorias/
Example Request
Categorias
curl --location --request GET 'https://localhost:3000/api/loja/categorias/'
GET
Retorno por categorias
https://localhost:3000/api/loja/categorias/8
Example Request
Retorno por categorias
curl --location --request GET 'https://localhost:3000/api/loja/categorias/8'