Retornará os produtos que estão cadastrados na subcategoria da respectiva url.
http://api.ecommloja.com.br/product/findProductsbySubCategoryUrl
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| url | Url(nome) da categoria | Sim | String |
| offset | Responsavel pela paginação. Incrementar +1 cada requisição. | Sim | Number |
{
"success": true,
"errors": [],
"data": [
{
"id_variety": "334",
"sku": "182577",
"name": "Tinta Latex Acrilico Econômico 18L - Glasu - Branco Neve",
"price": "194.47",
"promotional_price": "0.00",
"stock": "3157",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "1",
"configurable_product_id": "14202",
"sku_parent": "1825771825776789",
"id_parent": "2311",
"url_variety": "latex-vinil-acrilico-economico-18l-glasurit-182577",
"product_images": [
{
"label": "",
"image": "devtintanorte.ecommercenet.com.br/uploads/devtintanorte/produtos_imagens/18L-Muda-Facil-metal16373280321996053908.jpg",
"main": "0",
"hover": "0",
"sort": "0",
"status": "1"
}
],
"varieties_info": [
{
"name": "Branco Neve",
"image": "devtintanorte.ecommercenet.com.br/uploads/devtintanorte/produtos_imagens/produtos_variacao/Sem-titulo8323740571587997264136241986.png",
"color1": "",
"color2": "",
"icon_type": "1",
"sort": "0",
"status": "1"
}
]
}
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| id_variety | Id da variação se for o caso. | String |
| sku | Identificador único do produto. | String |
| name | Nome do produto. | String |
| short_description | Descrição curta do produto. | String |
| price | Valor do produto. | String |
| promotional_price | Valor promocional do produto. | String |
| Stock | Estoque do produto. | String |
| weight | Peso do produto em kg com 3 casas decimais. | string |
| height | Altura do produto. | string |
| height | Altura do produto em cm. | Int |
| length | Comprimento do produto em cm. | Int |
| width | Largura do produto em cm. | Int |
| status | Status do produto. | Boolean |
| configurable_product_id | Id do produto tipo configuravel. | String |
| sku_parent | Identificador único do produto pai. | String |
| id_parente | Id do produto pai. | String |
| url_variety | Url da variação. | String |
| product_images(label) | . | String |
| product_images(image) | Caminho da imagem do produto | String |
| product_images(main) | . | String |
| product_images(hover) | . | String |
| product_images(sort) | . | String |
| product_images(status) | . | String |
| varieties_info(name) | Nome da variação do produto. | String |
| varieties_info(image) | Caminho da imagem da variação do produto. | String |
| varieties_info(color1) | . | String |
| varieties_info(color2) | . | String |
Retornará o produto com o sku igual ao que foi pesquisado através do campo sku.
http://api.ecommloja.com.br/product/findbysku
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | Identificador único do produto | Sim | String |
| min | Caso seja enviado como 1, serão retornadas as informações básicas do produto. Caso seja enviado como 0, todas as informações serão retornadas. | Não | Boolean |
{
"success": true,
"errors": [],
"data": {
"name": "Fone de Ouvidos Bluetooth",
"sku": "123123",
"barcode": "fasdaa45",
"price": "150.23",
"promotional_price": "0.00",
"stock": 2,
"weight": "0.200",
"height": "10",
"length": "20",
"width": "30",
"type": "1",
"status": "1",
"parent": [],
"children": []
}
}
{
"success": true,
"errors": [],
"data": {
"name": "Fone de Ouvidos Bluetooth",
"sku": "123123",
"barcode": "fasdaa45",
"short_description": "Fone de Ouvidos Bluetooth
",
"price": "150.23",
"promotional_price": "0.00",
"url": "produtos-simples",
"stock": "2",
"available": "1",
"budget": "0",
"hide_price": "0",
"weight": "0.200",
"height": "10",
"length": "20",
"width": "30",
"fitting_difference": "10",
"deadline": "2",
"unit_measurement": "",
"description": "Fone de Ouvidos Bluetooth
",
"specifications": "",
"warranty": "90 Dias
",
"manufacturer": "3",
"manufacturer_code": "",
"brand": "13",
"variety_title": "",
"grid_title": "",
"configurable_title": "",
"meta_description": "Meta Descrição do Produto Simples",
"meta_title": "Meta Título do Produto Simples",
"meta_keys": "Palavras Chaves do Produto Simples",
"type": "1",
"sort": "0",
"obs_box": "0",
"illustrative_picture": "0",
"multiple": "0",
"multiple_price": "0.00",
"status": "1",
"parent": [],
"children": []
}
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| name | Nome do produto. | String |
| sku | Identificador único do produto. | String |
| barcode | Código de barras do produto. | String |
| short_description | Descrição curta do produto. | String |
| price | Valor do produto. | Float |
| promotional_price | Valor promocional do produto. | Float |
| url | URL do produto. | String |
| stock | Estoque do produto. | Int |
| available | Disponibilidade do produto para a compra, independentemente do estoque. | Boolean |
| budget | Ativar produto por orçamento. | Boolean |
| hide_price | Esconder o preço do produto na apresentação. | Boolean |
| weight | Peso do produto em kg com 3 casas decimais. | Float |
| height | Altura do produto em cm. | Int |
| length | Comprimento do produto em cm. | Int |
| width | Largura do produto em cm. | Int |
| fitting_difference | Diferença no encaixe na cubagm dos mesmos produtos em cm. | Int |
| deadline | Prazo de postagem em dias. | Int |
| unit_measurement | Unidade de medida do produto. | String |
| description | Descrição do produto. | String |
| specifications | Especificações do produto. | String |
| warranty | Texto sobre a garantia do produto. | String |
| manufacturer | Fabricante do produto (código quando criado na plataforma). | Int |
| manufacturer_code | Código do fabricante para o produto. | Int |
| brand | Marca do produto (código quando criada na plataforma). | Int |
| variety_title | Título das variações apresentado na tela do produto, somente para produtos do tipo 3 (Grade) | String |
| grid_title | Título fas grades apresentado na tela do produto, somente para produtos do tipo 3 (Grade) | String |
| configurable_title | Título das variações apresentado na tela do produto, somente para produtos do tipo 4 (Variação). | String |
| meta_description | Meta descrição do produto. | String |
| meta_title | Meta título do produto. | String |
| meta_keys | Meta keys do produto. | String |
| type |
Tipo do produto.
|
Int |
| sort | Ordenação do produto na listagem. | Int |
| obs_box | Ativar caixa de observação na tela do produto. | Boolean |
| illustrative_picture | Ativar texto de imagem meramente ilustrativa na tela do produto. | Boolean |
| multiple | Ativar produto múltiplo. | Boolean |
| multiple_price | Valor do produto do tipo múltiplo (só é levado em conta caso o campo multiple esteja ativo). | Float |
| status | Status do produto dentro da plataforma (ativo ou inativo). | Boolean |
| parent | Dados do pai do produto, caso a busca tenha sido feita por uma variação ou grade de um produto. | Array |
| children | Dados do filho do produto, caso a busca tenha sido feita por um produto que seja variação ou grade. | Array |
Retornará o produto com o nome igual ao que foi pesquisado através do campo nome.
http://api.ecommloja.com.br/product/findbyname
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | Identificador único do produto | Sim | String |
| min | Caso seja enviado como 1, serão retornadas as informações básicas do produto. Caso seja enviado como 0, todas as informações serão retornadas. | Não | Boolean |
{
"success": true,
"errors": [],
"data": {
"name": "Fone de Ouvidos Bluetooth",
"sku": "123123",
"barcode": "fasdaa45",
"price": "150.23",
"promotional_price": "0.00",
"stock": 2,
"weight": "0.200",
"height": "10",
"length": "20",
"width": "30",
"type": "1",
"status": "1",
"parent": [],
"children": []
}
}
{
"success": true,
"errors": [],
"data": {
"name": "Fone de Ouvidos Bluetooth",
"sku": "123123",
"barcode": "fasdaa45",
"short_description": "Fone de Ouvidos Bluetooth
",
"price": "150.23",
"promotional_price": "0.00",
"url": "produtos-simples",
"stock": "2",
"available": "1",
"budget": "0",
"hide_price": "0",
"weight": "0.200",
"height": "10",
"length": "20",
"width": "30",
"fitting_difference": "10",
"deadline": "2",
"unit_measurement": "",
"description": "Fone de Ouvidos Bluetooth
",
"specifications": "",
"warranty": "90 Dias
",
"manufacturer": "3",
"manufacturer_code": "",
"brand": "13",
"variety_title": "",
"grid_title": "",
"configurable_title": "",
"meta_description": "Meta Descrição do Produto Simples",
"meta_title": "Meta Título do Produto Simples",
"meta_keys": "Palavras Chaves do Produto Simples",
"type": "1",
"sort": "0",
"obs_box": "0",
"illustrative_picture": "0",
"multiple": "0",
"multiple_price": "0.00",
"status": "1",
"parent": [],
"children": []
}
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| name | Nome do produto. | String |
| sku | Identificador único do produto. | String |
| barcode | Código de barras do produto. | String |
| short_description | Descrição curta do produto. | String |
| price | Valor do produto. | Float |
| promotional_price | Valor promocional do produto. | Float |
| url | URL do produto. | String |
| stock | Estoque do produto. | Int |
| available | Disponibilidade do produto para a compra, independentemente do estoque. | Boolean |
| budget | Ativar produto por orçamento. | Boolean |
| hide_price | Esconder o preço do produto na apresentação. | Boolean |
| weight | Peso do produto em kg com 3 casas decimais. | Float |
| height | Altura do produto em cm. | Int |
| length | Comprimento do produto em cm. | Int |
| width | Largura do produto em cm. | Int |
| fitting_difference | Diferença no encaixe na cubagm dos mesmos produtos em cm. | Int |
| deadline | Prazo de postagem em dias. | Int |
| unit_measurement | Unidade de medida do produto. | String |
| description | Descrição do produto. | String |
| specifications | Especificações do produto. | String |
| warranty | Texto sobre a garantia do produto. | String |
| manufacturer | Fabricante do produto (código quando criado na plataforma). | Int |
| manufacturer_code | Código do fabricante para o produto. | Int |
| brand | Marca do produto (código quando criada na plataforma). | Int |
| variety_title | Título das variações apresentado na tela do produto, somente para produtos do tipo 3 (Grade) | String |
| grid_title | Título fas grades apresentado na tela do produto, somente para produtos do tipo 3 (Grade) | String |
| configurable_title | Título das variações apresentado na tela do produto, somente para produtos do tipo 4 (Variação). | String |
| meta_description | Meta descrição do produto. | String |
| meta_title | Meta título do produto. | String |
| meta_keys | Meta keys do produto. | String |
| type |
Tipo do produto.
|
Int |
| sort | Ordenação do produto na listagem. | Int |
| obs_box | Ativar caixa de observação na tela do produto. | Boolean |
| illustrative_picture | Ativar texto de imagem meramente ilustrativa na tela do produto. | Boolean |
| multiple | Ativar produto múltiplo. | Boolean |
| multiple_price | Valor do produto do tipo múltiplo (só é levado em conta caso o campo multiple esteja ativo). | Float |
| status | Status do produto dentro da plataforma (ativo ou inativo). | Boolean |
| parent | Dados do pai do produto, caso a busca tenha sido feita por uma variação ou grade de um produto. | Array |
| children | Dados do filho do produto, caso a busca tenha sido feita por um produto que seja variação ou grade. | Array |
Retornará variações conforme o SKU do produto informado.
http://api.ecommloja.com.br/product/findvarietybyproductsku
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_name | Identificador único do produto. | Sim | String |
{
"success": true,
"errors": [],
"data": [
{
"sku": "124",
"name": "Marrom - 1",
"price": "100",
"promotional_price": "0.00",
"stock": "2",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "1"
},
{
"sku": "qw54",
"name": "Verde - 2",
"price": "100",
"promotional_price": "0.00",
"stock": "12",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "1"
},
{
"sku": "1531",
"name": "Verde - 3",
"price": "100",
"promotional_price": "0.00",
"stock": "0",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "1"
},
{
"sku": "35143",
"name": "Azul Claro",
"price": "100",
"promotional_price": "0.00",
"stock": "12",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "1"
},
{
"sku": "123-5",
"name": "Azul Claro",
"price": "60",
"promotional_price": "1.50",
"stock": "60",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "0"
}
]
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| sku | Identificador único da variação. | Int |
| name | Nome da variação. | String |
| price | Preço da variação. | Float |
| promotional_price | Preço promocional da variação. | Float |
| stock | Estoque da variação. | Int |
| weight | Peso da variação em kg com 3 casas decimais. | Float |
| height | Altura do produto em cm. | Int |
| length | Comprimento do produto em cm. | Int |
| width | Largura do produto em cm. | Int |
| status | Status do produto dentro da plataforma (ativo ou inativo). | Boolean |
Retornará variações conforme o nome pesquisado no campo name, caso não seja preenchido todas as variações serão retornadas.
http://api.ecommloja.com.br/product/findvariety
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome da Variação. Caso seja enviado vazio ou não enviado, retornará todas as variações. | Não | String |
{
"success": true,
"errors": [],
"data": [
{
"id": "1",
"name": "Azul",
"image": "azul.png",
"color1": "",
"color2": "",
"icon_type": "1",
"sort": "1",
"status": "1"
},
{
"id": "9",
"name": "Camiseta - Azul",
"image": "9634007253022512817097.jpg",
"color1": "",
"color2": "",
"icon_type": "1",
"sort": "0",
"status": "1"
}
]
}
{
"success": false,
"errors": [
"Varieties not found."
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| id | ID da variação. | Int |
| name | Nome da variação. | String |
| image | Imagem da variação, caso o tipo do ícone seja 1. | String |
| color1 | Cor primária da variação, caso o tipo do ícone seja 2 ou 3. | String |
| color2 | Cor secundária da variação, caso o tipo do ícone seja 3. | String |
| icon_type |
Tipo do ícone da variação.
|
Int |
| sort | Ordenação da variação na listagem. | Int |
| status | Status da variação dentro da plataforma (ativo ou inativo). | Boolean |
Retornará grades conforme o SKU do produto informado.
http://api.ecommloja.com.br/product/findgridbyproductsku
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_sku | Identificador único do produto. | Sim | String |
{
"success": true,
"errors": [],
"data": [
{
"sku": "490asfd9840afsadfasdf-2",
"variety_name": "Verde",
"grid_name": "M",
"price": "25.98",
"promotional_price": "12.78",
"stock": "0",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "1"
},
{
"sku": "490asfd9840afsadfasdf-3",
"variety_name": "Rosa",
"grid_name": "P",
"price": "0.00",
"promotional_price": "0.00",
"stock": "0",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "0"
},
{
"sku": "490asfd9840afsadfasdf-4",
"variety_name": "Rosa",
"grid_name": "M",
"price": "0.00",
"promotional_price": "0.00",
"stock": "0",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "0"
},
{
"sku": "490asfd9840afsadfasdf-5",
"variety_name": "Azul Claro",
"grid_name": "P",
"price": "41.98",
"promotional_price": "0.00",
"stock": "58",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "0"
}
]
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| sku | Identificador único da grade. | Int |
| variety_name | Nome da parte de variação da grade. | String |
| grid_name | Nome da grade. | String |
| price | Preço da variação. | Float |
| promotional_price | Preço promocional da variação. | Float |
| stock | Estoque da variação. | Int |
| weight | Peso da variação em kg com 3 casas decimais. | Float |
| height | Altura do produto em cm. | Int |
| length | Comprimento do produto em cm. | Int |
| width | Largura do produto em cm. | Int |
| status | Status do produto dentro da plataforma (ativo ou inativo). | Boolean |
Retornará grades conforme o nome pesquisado no campo name, caso não seja preenchido todas as grades serão retornadas.
http://api.ecommloja.com.br/product/findgrid
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome da Grade. Caso seja enviado vazio ou não enviado, retornará todas as grades. | Não | String |
{
"success": true,
"errors": [],
"data": [
{
"id": "1",
"name": "P",
"sort": "1",
"status": "1"
},
{
"id": "2",
"name": "M",
"sort": "2",
"status": "1"
},
{
"id": "3",
"name": "G",
"sort": "3",
"status": "1"
},
{
"id": "4",
"name": "38",
"sort": "4",
"status": "1"
},
{
"id": "5",
"name": "39",
"sort": "5",
"status": "1"
},
{
"id": "6",
"name": "40",
"sort": "6",
"status": "1"
},
{
"id": "10",
"name": "P",
"sort": "0",
"status": "1"
},
{
"id": "11",
"name": "M",
"sort": "0",
"status": "1"
},
{
"id": "12",
"name": "G",
"sort": "0",
"status": "1"
},
{
"id": "13",
"name": "300lt",
"sort": "0",
"status": "1"
}
]
}
{
"success": false,
"errors": [
"Grids not found."
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| id | ID da grade. | Int |
| name | Nome da grade. | String |
| sort | Ordenação da variação na listagem. | Int |
| status | Status da variação dentro da plataforma (ativo ou inativo). | Boolean |
Será inserido na loja o produto com as informações enviadas nos campos.
http://api.ecommloja.com.br/product/insert
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome do produto. | Sim | String |
| sku | Identificador único do produto. | Sim | String |
| barcode | Código de barras do produto. | Não (Padrão: "") |
String |
| short_description | Descrição curta do produto. | Não (Padrão: "") |
String |
| price | Valor do produto. | Não (Padrão: 0.00) |
Float |
| promotional_price | Valor promocional do produto. | Não (Padrão: 0.00) |
Float |
| stock | Estoque do produto. | Não (Padrão: 0) |
Int |
| available | Disponibilidade do produto para a compra, independentemente do estoque. | Não (Padrão: true) |
Boolean |
| budget | Ativar produto por orçamento. | Não (Padrão: false) |
Boolean |
| hide_price | Esconder o preço do produto na apresentação. | Não (Padrão: false) |
Boolean |
| weight | Peso do produto em kg com 3 casas decimais. | Não (Padrão: 0.000) |
Float |
| height | Altura do produto em cm. | Não (Padrão: 0) |
Int |
| length | Comprimento do produto em cm. | Não (Padrão: 0) |
Int |
| width | Largura do produto em cm. | Não (Padrão: 0) |
Int |
| fitting_difference | Diferença no encaixe na cubagm dos mesmos produtos em cm. | Não (Padrão: 0) |
Int |
| deadline | Prazo de postagem em dias. | Não (Padrão: 0) |
Int |
| unit_measurement | Unidade de medida do produto. | Não (Padrão: "") |
String |
| description | Descrição do produto. | Não (Padrão: "") |
String |
| specifications | Especificações do produto. | Não (Padrão: "") |
String |
| warranty | Texto sobre a garantia do produto. | Não (Padrão: "") |
String |
| manufacturer | Fabricante do produto (código quando criado na plataforma). | Não (Padrão: 0) |
Int |
| manufacturer_code | Código do fabricante para o produto. | Não (Padrão: 0) |
Int |
| brand | Marca do produto (código quando criada na plataforma). | Não (Padrão: 0) |
Int |
| variety_title | Título das variações apresentado na tela do produto, somente para produtos do tipo 3 (Grade) | Não (Padrão: "") |
String |
| grid_title | Título fas grades apresentado na tela do produto, somente para produtos do tipo 3 (Grade) | Não (Padrão: "") |
String |
| configurable_title | Título das variações apresentado na tela do produto, somente para produtos do tipo 4 (Variação). | Não (Padrão: "") |
String |
| meta_description | Meta descrição do produto. | Não (Padrão: "") |
String |
| meta_title | Meta título do produto. | Não (Padrão: "") |
String |
| meta_keys | Meta keys do produto. | Não (Padrão: "") |
String |
| type |
Tipo do produto.
|
Não (Padrão: 1) |
Int |
| sort | Ordenação do produto na listagem. | Não (Padrão: 0) |
Int |
| obs_box | Ativar caixa de observação na tela do produto. | Não (Padrão: false) |
Boolean |
| illustrative_picture | Ativar texto de imagem meramente ilustrativa na tela do produto. | Não (Padrão: false) |
Boolean |
| multiple | Ativar produto múltiplo. | Não (Padrão: false) |
Boolean |
| multiple_price | Valor do produto do tipo múltiplo (só é levado em conta caso o campo multiple esteja ativo). | Não (Padrão: 0.00) |
Float |
| status | Status do produto dentro da plataforma (ativo ou inativo). | Não (Padrão: false) |
Boolean |
| variety_data | Dados para cadastro de variações do produto do tipo 4 (Variação) | Não (Padrão: Vazio) |
Array |
| grid_data | Dados para cadastro de grades do produto do tipo 3 (Grade) | Não (Padrão: Vazio) |
Array |
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| id | Identificador único da variação a ser inserida (Adquirida através do método findvariety). | Sim | Int |
| sku | SKU da variação do produto (deve ser único). | Sim | String |
| price | Valor da variação do produto. | Não (Padrão: 0.00) |
Float |
| promotional_price | Valor promocional da variação do produto. | Não (Padrão: 0.00) |
Float |
| stock | Estoque da variação do produto. | Não (Padrão: 0) |
Int |
| weight | Peso da variação do produto em kg com 3 casas decimais. | Não (Padrão: 0.000) |
Float |
| height | Altura da variação do produto em cm. | Não (Padrão: 0) |
Int |
| length | Comprimento da variação do produto em cm. | Não (Padrão: 0) |
Int |
| width | Largura da variação do produto em cm. | Não (Padrão: 0) |
Int |
| sort | Ordenação das variações do produto na listagem. | Não (Padrão: 0) |
Int |
| status | Status da variação do produto dentro da plataforma (ativo ou inativo). | Não (Padrão: false) |
Boolean |
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| variety_id | Identificador único da variação a ser inserida (Adquirida através do método findvariety). | Sim | Int |
| grid_id | Identificador único da grade a ser inserida (Adquirida através do método findgrid). | Sim | Int |
| sku | SKU da grade do produto (deve ser único). | Sim | String |
| price | Valor da grade do produto. | Não (Padrão: 0.00) |
Float |
| promotional_price | Valor promocional da grade do produto. | Não (Padrão: 0.00) |
Float |
| stock | Estoque da grade do produto. | Não (Padrão: 0) |
Int |
| weight | Peso da grade do produto em kg com 3 casas decimais. | Não (Padrão: 0.000) |
Float |
| height | Altura da grade do produto em cm. | Não (Padrão: 0) |
Int |
| length | Comprimento da grade do produto em cm. | Não (Padrão: 0) |
Int |
| width | Largura da grade do produto em cm. | Não (Padrão: 0) |
Int |
| status | Status da variação do produto dentro da plataforma (ativo ou inativo). | Não (Padrão: false) |
Boolean |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"SKU already registered"
],
"data": []
}
Será atualizado na loja o produto com as informações enviadas nos campos.
Somente os campos enviados serão atualizados.
O SKU deve ser enviado por GET, ele será a busca de atualização do produto.
Somete será atualizado um produto por vez, para atualização de mais de um produto utilize a atualização em massa (Bulk Update).
http://api.ecommloja.com.br/product/update
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | Identificador único do produto. | Sim | String |
| name | Nome do produto. | Não | String |
| barcode | Código de barras do produto. | Não | String |
| short_description | Descrição curta do produto. | Não | String |
| price | Valor do produto. | Não | Float |
| promotional_price | Valor promocional do produto. | Não | Float |
| stock | Estoque do produto. | Não | Int |
| available | Disponibilidade do produto para a compra, independentemente do estoque. | Não | Boolean |
| budget | Ativar produto por orçamento. | Não | Boolean |
| hide_price | Esconder o preço do produto na apresentação. | Não | Boolean |
| weight | Peso do produto em kg com 3 casas decimais. | Não | Float |
| height | Altura do produto em cm. | Não | Int |
| length | Comprimento do produto em cm. | Não | Int |
| width | Largura do produto em cm. | Não | Int |
| fitting_difference | Diferença no encaixe na cubagm dos mesmos produtos em cm. | Não | Int |
| deadline | Prazo de postagem em dias. | Não | Int |
| unit_measurement | Unidade de medida do produto. | Não | String |
| description | Descrição do produto. | Não | String |
| specifications | Especificações do produto. | Não | String |
| warranty | Texto sobre a garantia do produto. | Não | String |
| manufacturer | Fabricante do produto (código quando criado na plataforma). | Não | Int |
| manufacturer_code | Código do fabricante para o produto. | Não | Int |
| brand | Marca do produto (código quando criada na plataforma). | Não | Int |
| variety_title | Título das variações apresentado na tela do produto, somente para produtos do tipo 3 (Grade) | Não | String |
| grid_title | Título fas grades apresentado na tela do produto, somente para produtos do tipo 3 (Grade) | Não | String |
| configurable_title | Título das variações apresentado na tela do produto, somente para produtos do tipo 4 (Variação). | Não | String |
| meta_description | Meta descrição do produto. | Não | String |
| meta_title | Meta título do produto. | Não | String |
| meta_keys | Meta keys do produto. | Não | String |
| sort | Ordenação do produto na listagem. | Não | Int |
| obs_box | Ativar caixa de observação na tela do produto. | Não | Boolean |
| illustrative_picture | Ativar texto de imagem meramente ilustrativa na tela do produto. | Não | Boolean |
| multiple | Ativar produto múltiplo. | Não | Boolean |
| multiple_price | Valor do produto do tipo múltiplo (só é levado em conta caso o campo multiple esteja ativo). | Não | Float |
| status | Status do produto dentro da plataforma (ativo ou inativo). | Não | Boolean |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
Inserção de variações em produto do tipo 4 (Variação) em produto já cadastrado.
http://api.ecommloja.com.br/product/insertvarietyproduct
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | Identificador único do produto. | Sim | String |
| variety_data | Dados para cadastro de variações do produto do tipo 4 (Variação) | Sim | Array |
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| id | Identificador único da variação a ser inserida (Adquirida através do método findvariety). | Sim | Int |
| sku | SKU da variação do produto (deve ser único). | Sim | String |
| price | Valor da variação do produto. | Não (Padrão: 0.00) |
Float |
| promotional_price | Valor promocional da variação do produto. | Não (Padrão: 0.00) |
Float |
| stock | Estoque da variação do produto. | Não (Padrão: 0) |
Int |
| weight | Peso da variação do produto em kg com 3 casas decimais. | Não (Padrão: 0.000) |
Float |
| height | Altura da variação do produto em cm. | Não (Padrão: 0) |
Int |
| length | Comprimento da variação do produto em cm. | Não (Padrão: 0) |
Int |
| width | Largura da variação do produto em cm. | Não (Padrão: 0) |
Int |
| sort | Ordenação das variações do produto na listagem. | Não (Padrão: 0) |
Int |
| status | Status da variação do produto dentro da plataforma (ativo ou inativo). | Não (Padrão: false) |
Boolean |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Product not found."
],
"data": []
}
Inserção de grades em produto do tipo 3 (Grade) em produto já cadastrado.
http://api.ecommloja.com.br/product/insertgridproduct
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | Identificador único do produto. | Sim | String |
| grid_data | Dados para cadastro de grade do produto do tipo 3 (Grade) | Sim | Array |
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| variety_id | Identificador único da variação a ser inserida (Adquirida através do método findvariety). | Sim | Int |
| grid_id | Identificador único da grade a ser inserida (Adquirida através do método findgrid). | Sim | Int |
| sku | SKU da grade do produto (deve ser único). | Sim | String |
| price | Valor da grade do produto. | Não (Padrão: 0.00) |
Float |
| promotional_price | Valor promocional da grade do produto. | Não (Padrão: 0.00) |
Float |
| stock | Estoque da grade do produto. | Não (Padrão: 0) |
Int |
| weight | Peso da grade do produto em kg com 3 casas decimais. | Não (Padrão: 0.000) |
Float |
| height | Altura da grade do produto em cm. | Não (Padrão: 0) |
Int |
| length | Comprimento da grade do produto em cm. | Não (Padrão: 0) |
Int |
| width | Largura da grade do produto em cm. | Não (Padrão: 0) |
Int |
| status | Status da variação do produto dentro da plataforma (ativo ou inativo). | Não (Padrão: false) |
Boolean |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
{
"variety_id": 0,
"grid_id": 0,
"grid_key": 0,
"errors":[
"SKU already registered"
]
}
],
"data": []
}
Retorna os dados das categorias as quais o produto está ligado.
http://api.ecommloja.com.br/product/findcategoriesbysku
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | Identificador único do produto. | Sim | String |
{
"success": true,
"errors": [],
"data": [
{
"category_id": "20",
"category_data": {
"id": "20",
"name": "Casamento",
"sort": "0",
"url": "casamento",
"description": "",
"view_menu": "1",
"visits": "0",
"meta_description": "",
"meta_title": "",
"meta_keys": "",
"hot_page": "1",
"page_id": "0",
"status": "1"
},
"category_type": 1
},
{
"category_id": "1",
"category_data": {
"id": "1",
"parent_id": "20",
"sub_parent_id": "0",
"name": "Milena e Thiago",
"sort": "0",
"url": "milena-e-thiago",
"status": "1"
},
"category_type": 2
},
{
"category_id": "13",
"category_data": {
"id": "13",
"name": "Pet",
"sort": "0",
"url": "pet",
"description": "",
"view_menu": "0",
"visits": "0",
"meta_description": "",
"meta_title": "",
"meta_keys": "",
"hot_page": "1",
"page_id": "0",
"status": "1"
},
"category_type": 1
},
{
"category_id": "3",
"category_data": {
"id": "3",
"parent_id": "0",
"sub_parent_id": "2",
"name": "Ração",
"sort": "0",
"url": "Racao",
"status": "1"
},
"category_type": 2
},
{
"category_id": "2",
"category_data": {
"id": "2",
"parent_id": "13",
"sub_parent_id": "0",
"name": "Cachorro",
"sort": "0",
"url": "Cachorro",
"status": "1"
},
"category_type": 2
}
]
}
{
"success": false,
"errors": [
"Invalid Product SKU"
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| category_id | ID da categoria. | Int |
| category_data | Dados da categoria. | Array |
| category_type |
Tipo da categoria.
|
Int |
| Campo | Significado | Tipo |
|---|---|---|
| id | ID da categoria. | Int |
| name | Nome da categoria. | String |
| sort | Ordenação da categoria na listagem. | Int |
| url | URL da categoria. | String |
| description | Descrição da categoria. | String |
| view_menu | Categoria poderá ser visualizada no menu da loja. | Boolean |
| visits | Visitas à categoria. | Int |
| meta_description | Meta descrição da categoria. | String |
| meta_title | Meta título da categoria. | String |
| meta_keys | Meta keys da categoria. | String |
| hot_page |
Estilo da Categoria (Somente para categorias do tipo 1 (Categoria)).
|
Int |
| page_id | Página referente a página institucional da categoria (Somente para categoria com estilo 2 (Institucional). | Int |
| status | Status da grade dentro da plataforma (ativo ou inativo). | Boolean |
Exclui o produto de SKU informado.
ATENÇÃO: Essa ação é irreversível!
http://api.ecommloja.com.br/product/deletebysku
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | Identificador único do produto. | Sim | String |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
Exclui a variação de SKU informado.
ATENÇÃO: Essa ação é irreversível!
http://api.ecommloja.com.br/product/deletevarietybysku
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | Identificador único da variação. | Sim | String |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Variety not found"
],
"data": []
}
Exclui a grade de SKU informado.
ATENÇÃO: Essa ação é irreversível!
http://api.ecommloja.com.br/product/deletegridbysku
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | Identificador único da grade. | Sim | String |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Grid not found"
],
"data": []
}
Retorna os dados da variação juntamente com o SKU do Produto ao qual pertence.
http://api.ecommloja.com.br/product/findvarietyandparentbyvariety
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| variety_sku | Identificador único da variação. | Sim | String |
{
"success": true,
"errors": [],
"data": {
"variety": {
"id": "8",
"name": "Cor",
"price": "1",
"promotional_price": "0.50",
"image": "",
"stock": "50",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "1"
},
"parent_sku": "123456"
}
}
{
"success": false,
"errors": [
"Variety not found"
],
"data": []
}
Retorna os dados da grade juntamente com o SKU do Produto ao qual pertence.
http://api.ecommloja.com.br/product/findgridandparentbygrid
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| grid_sku | Identificador único da grade. | Sim | String |
{
"success": true,
"errors": [],
"data": {
"grid": {
"id": "58",
"variety_name": "Estampa",
"grid_name": "Branco(a)",
"price": "20.00",
"promotional_price": "10.00",
"image": "",
"stock": "10",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "1"
},
"parent_sku": "316170"
}
}
{
"success": false,
"errors": [
"Grid not found!"
],
"data": []
}
Retorna a URL de variação de produto
http://api.ecommloja.com.br/product/constructUrlVariety
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| variety_sku | Identificador da variação. | Sim | String |
{
"success": true,
"errors": [],
"data": "product-variety-000000"
}
{
"success": false,
"errors": [
"Variety not found!"
],
"data": []
}
Retorna a URL de Grade de produto
http://api.ecommloja.com.br/product/constructUrlVariety
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| grid_sku | Identificador da Grade. | Sim | String |
{
"success": true,
"errors": [],
"data": "product-grid-000000"
}
{
"success": false,
"errors": [
"Grid not found!"
],
"data": []
}
Lista os comentários dos produtos
http://api.ecommloja.com.br/product/findCommentsBySku
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | Identificador único do produto. | Sim | String |
{
"success": true,
"errors": [],
"data": {
"id": "1",
"customer_name": "Lucas Duarte",
"customer_email": "clienteteste@ecommercenet.com.br",
"rating": "5",
"comment": "Produto muito bom e de alta qualidade. ",
"date": "2022-04-07 09:15:50"
}
}
{
"success": false,
"errors": [
"Invalid request - Needed: GET"
],
"data": []
}
{
"success": false,
"errors": [
"Comments not found."
],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}
Retornará os produtos com estoque retido aguardando alteração de status do pedido.
http://api.ecommloja.com.br/product/retainedstock
GET
{
"success": true,
"errors": [],
"data": [
{
"sku": "INTELBRAS-00",
"sku_variety": "0",
"sku_grid": "0",
"stock": "10",
"type": "1",
"data": "2023-07-12 11:54:19"
},
{
"sku": "POSJRD",
"sku_variety": "DPP",
"sku_grid": "0",
"stock": "5",
"type": "4",
"data": "2023-07-12 11:54:19"
},
{
"sku": "26785635",
"sku_variety": "0",
"sku_grid": "0000444",
"stock": "4",
"type": "3",
"data": "2023-07-12 11:54:19"
}
]
}
{
"success": false,
"errors": [
"Stock control disabled"
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| sku | Sku do produto | String |
| sku_variety | Sku da variação. | String |
| sku_grid | Sku da grade. | String |
| stock | Estoque retido. | Int |
| type | Tipo do produto.
|
Int |
| data | Data da criação do registro. | Datetime no formato AAAA-MM-DD HH:mm:SS |
Atualiza em massa o estoque, o valor e o valor promocional a partir do SKU do produto.
Máximo de registros: 50
http://api.ecommloja.com.br/product/bulkUpdate
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| inputs | Dados dos produtos para atualizar em massa. | Sim | Array |
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| sku | SKU do produto a ser atualizado. | Sim | String |
| stock | Novo estoque do produto. | Não | Int |
| price | Novo valor do produto. | Não | Float |
| promotional_price | Novo valor promocional do produto. | Não | Float |
{
"success": true,
"errors": [
{
"code": 404,
"product_key": 0,
"product_sku": "1234",
"errors": [
"Product not found"
]
},
{
"code": 400,
"product_key": 3,
"product_sku": "1434a",
"errors": [
"This product can NOT be updated!"
]
},
{
"code": 400,
"product_key": 4,
"product_sku": "14789",
"errors": [
"This product can NOT be updated!"
]
}
],
"data": [
{
"code": 200,
"product_key": 1,
"product_sku": "1434"
},
{
"code": 200,
"product_key": 2,
"product_sku": "1803"
},
{
"code": 200,
"product_key": 5,
"product_sku": "14789-2"
}
]
}
| Campo | Comentário |
|---|---|
| success | Indica se a requisição retornou com sucesso ou não. |
| errors | Array com os erros da requisição. |
| data | Array com os sucessos da rquisição. |
| Campo | Comentário |
|---|---|
| code | Código de retorno HTTP |
| product_key | Posição no array "inputs" enviado onde houve erro. |
| product_sku (caso exista) | SKU enviado pelo array "inputs" onde houve erro. |
| errors | Erros ocorridos nessa atualizaçãode produto. |
| Campo | Comentário |
|---|---|
| code | Código de retorno HTTP |
| product_key | Posição no array "inputs" enviado. |
| product_sku | SKU enviado pelo array "inputs". |
Retornará as imagens referentes ao produto de SKU informado.
http://api.ecommloja.com.br/image/findbyproductsku
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_sku | Identificador único do produto. | Sim | String |
{
"success": true,
"errors": [],
"data": [
{
"id": "20",
"label": "",
"image": "loja\/uploads\/loja\/produtos_imagens\/bermuda-camisa16159140551204779837.png",
"main": "0",
"hover": "0",
"sort": "0",
"status": "1"
},
{
"id": "21",
"label": "",
"image": "loja\/uploads\/loja\/produtos_imagens\/bermuda-camisa16159140692084957355.png",
"main": "0",
"hover": "0",
"sort": "0",
"status": "1"
}
]
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
Insere uma imagem no produto de SKU informado
http://api.ecommloja.com.br/image/insertbyproductsku
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_sku | Identificador único do produto. | Sim | String |
| image | Imagem a ser adicionada. | Sim | Imagem (Resource) |
| subtitle | Legenda da imagem.(*) | Não (Padrão: '') | String |
| main | Caso seja a imagem principal do produto.(*) | Não (Padrão: false) | Boolean |
| hover | Essa imagem aparecerá quando o mouse passar por cima do produto.(*) | Não (Padrão: false) | Boolean |
| sort | Ordem da imagem entre as imagens do produto.(*) | Não (Padrão: 0) | Int |
| status | Status da imagem do produto (Inativo ou ativo).(*) | Não (Padrão: false) | Boolean |
(*) Esses dados só serão enviados caso o produto seja o principal, ou seja, não seja a variação, nem a grade de algum produto.
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
Vai excluir a imagem referente ao ID informado e ao produto de SKU informado.
http://api.ecommloja.com.br/image/deleteByProductSku
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_sku | Identificador único do produto. | Sim | String |
| id | Identificador único da imagem a ser excluida.(*) | Não (Padrão: 0) | Int |
(*) Só é necessário caso o produto seja simples, como grades e variações têm somente uma imagem não é necessário enviar o ID da imagem.
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
Vai excluir a imagem com nome informado.
http://api.ecommloja.com.br/image/deleteImageByName
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| image_name | Nome da Imagem. | Sim | String |
| image_type |
Tipo de Imagem a ser Excluída
|
Sim | Int |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Image not found. Image Name: imagem-nao-existente.png"
],
"data": []
}
Retornará o pedido com o ID igual ao que foi pesquisado através do campo id.
http://api.ecommloja.com.br/order/findbyid
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| id | Identificador único do pedido. | Sim | String |
{
"success": true,
"errors": [],
"data": {
"value": "151.11",
"status": "1",
"payment_method": "102",
"payment_mode": "2",
"discount": "20.00",
"date": "2022-05-16 10:36:47",
"shipping": "51.11",
"estimated_delivery": "5 dia(s)",
"tracking_code": "",
"tracking_link": "",
"note": "",
"delivery_note": "",
"delivery_type": "Correios - PAC",
"installments": "0",
"value_installments": "0.00",
"currency": "BRL",
"currency_symbol": "R$",
"order_address": {
"cep": "99999-999",
"street": "Rua teste",
"number": "999",
"address_details": "",
"neighborhood": "Testes",
"city": "Montes Claros",
"state": "MG",
"country": "Brasil"
},
"customer": {
"name": "Cliente teste",
"type": "1",
"company_name": "Empresa teste",
"cpf": "999.999.999-99",
"rg": "",
"cnpj": "",
"gender": "gender teste",
"birth_date": "9999-99-99",
"establish_date": null,
"cellphone": "(99)99999-9999",
"telephone": "",
"email": "clientetesteecommercenet.com.br",
"cep": "99999-999",
"street": "Rua teste",
"number": "99",
"address_details": "",
"neighborhood": "Testes",
"city": "Montes Claros",
"state": "MG",
"country": "Brasil",
"note": "",
"status": "1"
},
"products": [
{
"product_name": "Game FIFA 19 - PS4 - teste",
"sku": "000260",
"price": "120.00",
"promotional_price": "120.00",
"stock": "0",
"weight": "4.000",
"height": "30",
"length": "58",
"width": "31",
"type": "1",
"quantity": "1",
"multiple": "0",
"multiple_price": "0.00"
}
],
"error": []
}
}
{
"success": false,
"errors": [
"Order not found[1]"
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| value | Valor do pedido. | Float |
| status |
|
Int |
| payment_method |
Método de pagamento.
|
Int |
| payment_mode |
Modo de pagamento.
|
Int |
| date | Data do pedido | Datetime no formato AAAA-MM-DD HH:mm:SS |
| shipping | Valor do frete. | Float |
| estimated_delivery | Prazo de entrega. | String |
| currency | Código da moeda utilizada<./td> | String |
| currency_symbol | Símbolo da moeda utilizada. | String |
| order_address | Dados do endereço de entrega. | Array |
| customer | Dados do cliente. | Array |
| products | Dados dos produtos no pedido. | Array |
| Campo | Significado | Tipo |
|---|---|---|
| cep | CEP do endereço de entrega. | String |
| street | Rua do endereço de entrega. | String |
| number | Número do endereço de entrega. | String |
| address_details | Complemento do endereço de entrega. | String |
| neighborhood | Bairro do endereço de entrega. | String |
| city | Cidade do endereço de entrega. | String |
| state | Estado do endereço de entrega. | String |
| country | País do endereço de entrega. | String |
| Campo | Significado | Tipo |
|---|---|---|
| name | Nome do cliente. | String |
| type |
Tipo do cliente.
|
Int |
| company_name | Razão social | Int |
| cpf | CPF do cliente | String |
| cnpj | CNPJ do cliente | String |
| phone | Telefone do cliente | String |
| E-mail do cliente | String | |
| cep | CEP do cliente | String |
| street | Rua do cliente | String |
| number | Número do cliente | String |
| address_details | Complemento do endereço do cliente | String |
| neighborhood | Bairro do cliente | String |
| city | Cidade do cliente | String |
| state | Estado do cliente | String |
| country | País do cliente | String |
| Campo | Significado | Tipo |
|---|---|---|
| product_name | Nome do produto. | String |
| sku | SKU do produto. | String |
| price | Valor do produto. | Float |
| promotional_price | Valor Promocional do produto. | Float |
| stock | Estoque do produto. | Int |
| weight | Peso do produto em kg com 3 casas decimais. | Float |
| height | Altura do produto em cm. | Int |
| length | Comprimento do produto em cm. | Int |
| width | Largura do produto em cm. | Int |
| type |
Tipo do produto.
|
Int |
| quantity | Quantidade do produto no pedido. | Int |
Retornará os pedidos conforme os filtros inseridos.
Caso nenhum filtro seja inserido, os últimos 50 pedidos serão retornados.
http://api.ecommloja.com.br/order/findbyfilter
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| date_start | Data a partir da qual os pedidos serão buscados, os pedidos feitos após essa data serão retornados. | Não | Datetime no formato AAAA-MM-DD |
| date_end | Data até a qual os pedidos serão buscados, os pedidos feitos antes dessa data serão retornados. | Não | String |
| status | Status do pedido. | Não | Int |
| payment_method | Método de pagamento do pedido. | Não | Int |
{
"success": true,
"errors": [],
"data": [
{
"value": "37.99",
"status": "9",
"payment_method": "7",
"payment_mode": "0",
"discount": "0.00",
"date": "2021-01-04 14:38:12",
"shipping": "0.00",
"estimated_delivery": "",
"tracking_code": "",
"tracking_link": "",
"note": "",
"delivery_note": "",
"delivery_type": "Frete Grátis",
"installments": "0",
"value_installments": "0.00",
"currency": "BRL",
"currency_symbol": "R$",
"order_address": {
"cep": "99999-999",
"street": "Rua teste",
"number": "000000000000",
"address_details": "0000000000000",
"neighborhood": "teste",
"city": "Montes Claros",
"state": "MG",
"country": ""
},
"customer": {
"name": "TESTE ECOMMERCENET",
"type": "1",
"company_name": "",
"cpf": "999.999.999-99",
"rg": "",
"cnpj": "",
"gender": "teste",
"birth_date": "2000-11-11",
"establish_date": "2019-11-12",
"cellphone": "(99) 99999-9999",
"telephone": "",
"email": "testes@ecommcenet.com.br",
"cep": "99999-999",
"street": "Rua teste",
"number": "000000000000",
"address_details": "0000000000000",
"neighborhood": "teste",
"city": "Montes Claros",
"state": "MG",
"country": "",
"note": "",
"status": "1"
},
"products": [
{
"product_name": "Blusa Básica Feminina Manga Curta Com Modelagem Regular",
"sku": "00100",
"price": "37.99",
"promotional_price": null,
"stock": "48",
"weight": "0.350",
"height": "20",
"length": "20",
"width": "20",
"type": "3",
"quantity": "1",
"multiple": "0",
"multiple_price": null,
"variety": "Azul",
"grid": "G",
"grid_sku": "0122"
}
],
"error": [],
"id": "102"
},
{
"value": "805.89",
"status": "4",
"payment_method": "12",
"payment_mode": "4",
"discount": "0.00",
"date": "2021-02-02 12:40:22",
"shipping": "0.00",
"estimated_delivery": "",
"tracking_code": "",
"tracking_link": "",
"note": "",
"delivery_note": "",
"delivery_type": null,
"installments": "12",
"value_installments": "67.16",
"currency": "BRL",
"currency_symbol": "R$",
"order_address": {
"cep": "99999-999",
"street": "Rua teste",
"number": "000000000000",
"address_details": "0000000000000",
"neighborhood": "teste",
"city": "Montes Claros",
"state": "MG",
"country": ""
},
"customer": {
"name": "TESTE ECOMMERCENET",
"type": "1",
"company_name": "",
"cpf": "999.999.999-99",
"rg": "",
"cnpj": "",
"gender": "teste",
"birth_date": "2000-11-11",
"establish_date": "2019-11-12",
"cellphone": "(99) 99999-9999",
"telephone": "",
"email": "testes@ecommcenet.com.br",
"cep": "99999-999",
"street": "Rua teste",
"number": "000000000000",
"address_details": "0000000000000",
"neighborhood": "teste",
"city": "Montes Claros",
"state": "MG",
"country": "",
"note": "",
"status": "1"
},
"products": [
{
"product_name": "Controle sem Fio Dualshock 4 Sony PS4 - Preto",
"sku": "1336746",
"price": "415.90",
"promotional_price": null,
"stock": "82",
"weight": "0.500",
"height": "10",
"length": "20",
"width": "15",
"type": "1",
"quantity": "1",
"multiple": "0",
"multiple_price": null
},
{
"product_name": "Sapatênis Marrom Couro Masculino - Jump (Modelo 2020)",
"sku": "108621940",
"price": "389.99",
"promotional_price": null,
"stock": "74",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"type": "3",
"quantity": "1",
"multiple": "0",
"multiple_price": null,
"variety": "Caramelo",
"grid": "40",
"grid_sku": "108600140"
}
],
"error": [],
"id": "103"
},
{
"value": "189.99",
"status": "7",
"payment_method": "6",
"payment_mode": "0",
"discount": "0.00",
"date": "2021-02-02 17:29:26",
"shipping": "0.00",
"estimated_delivery": "",
"tracking_code": "",
"tracking_link": "",
"note": "",
"delivery_note": "",
"delivery_type": "Frete Grátis",
"installments": "0",
"value_installments": "0.00",
"currency": "BRL",
"currency_symbol": "R$",
"order_address": {
"cep": "99999-999",
"street": "Rua teste",
"number": "000000000000",
"address_details": "0000000000000",
"neighborhood": "teste",
"city": "Montes Claros",
"state": "MG",
"country": ""
},
"customer": {
"name": "TESTE ECOMMERCENET",
"type": "1",
"company_name": "",
"cpf": "999.999.999-99",
"rg": "",
"cnpj": "",
"gender": "teste",
"birth_date": "2000-11-11",
"establish_date": "2019-11-12",
"cellphone": "(99) 99999-9999",
"telephone": "",
"email": "testes@ecommcenet.com.br",
"cep": "99999-999",
"street": "Rua teste",
"number": "000000000000",
"address_details": "0000000000000",
"neighborhood": "teste",
"city": "Montes Claros",
"state": "MG",
"country": "",
"note": "",
"status": "1"
},
"products": [
{
"product_name": "Floratta Red Desodorante Colônia",
"sku": "988937",
"price": "189.99",
"promotional_price": null,
"stock": "30",
"weight": "0.300",
"height": "15",
"length": "10",
"width": "10",
"type": "1",
"quantity": "1",
"multiple": "0",
"multiple_price": null
}
],
"error": [],
"id": "104"
},
{
"value": "35.991",
"status": "4",
"payment_method": "14",
"payment_mode": "2",
"discount": "4.00",
"date": "2021-02-03 16:42:38",
"shipping": "0.00",
"estimated_delivery": "0",
"tracking_code": "",
"tracking_link": "",
"note": "",
"delivery_note": "",
"delivery_type": "Frete Grátis",
"installments": "0",
"value_installments": "0.00",
"currency": "BRL",
"currency_symbol": "R$",
"order_address": {
"cep": "99999-999",
"street": "Rua teste",
"number": "999",
"address_details": "",
"neighborhood": "teste",
"city": "Montes Claros",
"state": "MG",
"country": "Brasil"
},
"customer": {
"name": "TESTE ECOMMERCENET",
"type": "1",
"company_name": "",
"cpf": "999.999.999-99",
"rg": "",
"cnpj": "",
"gender": "teste",
"birth_date": "2000-11-11",
"establish_date": "2019-11-12",
"cellphone": "(99) 99999-9999",
"telephone": "",
"email": "testes@ecommcenet.com.br",
"cep": "99999-999",
"street": "Rua teste",
"number": "000000000000",
"address_details": "0000000000000",
"neighborhood": "teste",
"city": "Montes Claros",
"state": "MG",
"country": "",
"note": "",
"status": "1"
},
"products": [
{
"product_name": "Blusa Básica Feminina Manga Curta Com Modelagem Regular",
"sku": "00100",
"price": "39.99",
"promotional_price": null,
"stock": "16",
"weight": "0.350",
"height": "20",
"length": "20",
"width": "20",
"type": "3",
"quantity": "1",
"multiple": "0",
"multiple_price": null,
"variety": "Azul",
"grid": "P",
"grid_sku": "0120"
}
]
}
]
}
{
"success": false,
"errors": [
"Products not found in order 30"
],
"data": []
}
| Campo | Significado | Tipo |
|---|---|---|
| value | Valor do pedido. | Float |
| status |
|
Int |
| payment_method |
Método de pagamento.
|
Int |
| payment_mode |
Modo de pagamento.
|
Int |
| id | ID do pedido. | Int |
| customer | Dados do cliente. | Array |
| products | Dados dos produtos no pedido. | Array |
| Campo | Significado | Tipo |
|---|---|---|
| name | Nome do cliente. | String |
| type |
Tipo do cliente.
|
Int |
| company_name | Razão social | Int |
| cpf | CPF do cliente | String |
| cnpj | CNPJ do cliente | String |
| phone | Telefone do cliente | String |
| E-mail do cliente | String | |
| cep | CEP do cliente | String |
| street | Rua do cliente | String |
| number | Número do cliente | String |
| address_details | Complemento do endereço do cliente | String |
| neighborhood | Bairro do cliente | String |
| city | Cidade do cliente | String |
| state | Estado do cliente | String |
| country | País do cliente | String |
| Campo | Significado | Tipo |
|---|---|---|
| product_name | Nome do produto. | String |
| sku | SKU do produto. | String |
| price | Valor do produto. | Float |
| promotional_price | Valor Promocional do produto. | Float |
| stock | Estoque do produto. | Int |
| weight | Peso do produto em kg com 3 casas decimais. | Float |
| height | Altura do produto em cm. | Int |
| length | Comprimento do produto em cm. | Int |
| width | Largura do produto em cm. | Int |
| type |
Tipo do produto.
|
Int |
| quantity | Quantidade do produto no pedido. | Int |
Modificará o Status do pedido que tiver o ID igual ao informado no campo id.
http://api.ecommloja.com.br/order/changestatus
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| id | Identificador único do pedido. | Sim | String |
| new_status |
|
Sim | Int |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Order not Found!"
],
"data": []
}
Retornará as categorias conforme o nome pesquisado através do campo name.
Caso não envie o nome, todas as categorias e subcategorias serão retornadas.
http://api.ecommloja.com.br/category/findbyname
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome da categoria | Não | String |
{
"success": true,
"errors": [],
"data": [
{
"id": "4",
"name": "Pet Shop",
"sort": "14",
"url": "loja-virtual-de-pet-shop",
"description": "",
"view_menu": "0",
"visits": "0",
"meta_description": "",
"meta_title": "",
"meta_keys": "",
"hot_page": "1",
"page_id": "0",
"status": "1",
"children": [],
"parent": []
}
]
}
{
"success": false,
"errors": [
"Category not found"
],
"data": []
}
Ligará a Categoria ao Produto para mostrar o Produto na página da Categoria
http://api.ecommloja.com.br/category/linkproduct
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_sku | SKU do produto a ser ligado | Sim | String |
| category_id | ID da Categoria a ser ligada, retornada do método findbyname | Sim | Int |
| type |
Tipo da categoria.
|
Não (Padrão: 1) | Int |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
Retira a ligação que foi feita entre Produto e Categoria
http://api.ecommloja.com.br/category/unlinkproduct
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_sku | SKU do produto a ser ligado | Sim | String |
| category_id | ID da Categoria a ser ligada, retornada do método findbyname | Sim | Int |
| type |
Tipo da categoria.
|
Não (Padrão: 1) | Int |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Product not found"
],
"data": []
}
Vai inserir a Categoria na loja.
http://api.ecommloja.com.br/category/insert
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome da categoria | Sim | String |
| type |
Tipo da categoria.
|
Não (Padrão: 1) | Int |
| parent_id | ID da Categoria pai, caso seja do tipo 2 (Subcategoria). | Não (Padrão: 0) | Int |
| parent_type |
Tipo do pai da categoria.
|
Não (Padrão: 1) | Int |
| sort | Ordenação da Categoria na listagem | Não (Padrão: 0) | Int |
| description | Descrição da Categoria | Não (Padrão: "") | String |
| view_menu | Categoria poderá ser visualizada no menu da loja. | Não (Padrão: false) | Boolean |
| meta_description | Meta descrição da categoria. | Não (Padrão: "") | String |
| meta_title | Meta título da categoria. | Não (Padrão: "") | String |
| meta_keys | Meta keys da categoria. | Não (Padrão: "") | String |
| hot_page |
Estilo da Categoria (Somente para categorias do tipo 1 (Categoria)).
|
Não (Padrão: 1) | Int |
| page_id | Página referente a página institucional da categoria (SOmente para categoria com estilo 2 (Institucional). | Não (Padrão: 0) | Int |
| status | Status da categoria dentro da plataforma (ativo ou inativo). | Não (Padrão: false) | Boolean |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Parent Category not found"
],
"data": []
}
Vai atualizar a Categoria na loja.
Os valores não enviados não serão atualizados.
http://api.ecommloja.com.br/category/update
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| category_id | Identificador único da categoria | Sim | Int |
| name | Nome da categoria | Não | String |
| type |
Tipo da categoria.
|
Não (Padrão: 1) | Int |
| sort | Ordenação da Categoria na listagem | Não | Int |
| description | Descrição da Categoria | Não | String |
| view_menu | Categoria poderá ser visualizada no menu da loja. | Não | Boolean |
| meta_description | Meta descrição da categoria. | Não | String |
| meta_title | Meta título da categoria. | Não | String |
| meta_keys | Meta keys da categoria. | Não | String |
| hot_page |
Estilo da Categoria (Somente para categorias do tipo 1 (Categoria)).
|
Não | Int |
| page_id | Página referente a página institucional da categoria (SOmente para categoria com estilo 2 (Institucional). | Não | Int |
| status | Status da categoria dentro da plataforma (ativo ou inativo). | Não | Boolean |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Category not found"
],
"data": []
}
Essta função irá encontrar promoções cadastradas atraves do id categoria.
http://api.ecommloja.com.br/category/findSaleByCategory
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| category_id | Identificador da categoria | Sim | Int |
{
"success": true,
"errors": [],
"data": [
"id": "1",
"name": "Nome da promoção aqui",
"url": "url-da-promocao",
"category_id": "0",
"subcategory_id": "0",
"category_name": "Todas",
"aplication": "2",
"sale_type": "1",
"sale_value": "3.80",
"product_amount": "1",
"minimum_value_order": "0.00",
"start_date": "2021-11-22 19:23:00",
"end_date": "2021-12-31 23:59:00",
"comments": "",
"date_register": "2021-11-22 11:03:59",
"last_update": "2021-11-22 19:37:09",
"status": "1"
]
}
{
"success": false,
"errors": [
"Sale not found"
],
"data": []
}
Vai inserir o Fabricante na loja.
http://api.ecommloja.com.br/manufacturer/insert
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome do fabricante. | Sim | String |
| url | URL do fabricante. | não | String |
| code | Código do fabricante. | não | String |
| description | Descrição do fabricante. | não | String |
| meta_title | Meta título do fabricante. | não | String |
| meta_description | Meta descrição do fabricante. | não | String |
| keywords | Palavras chaves sobre o fabricante. | não | String |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Invalid Name"
],
"data": []
}
Vai excluir o fabricante com nome informado.
http://api.ecommloja.com.br/manufacturer/deleteByName
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome do fabricante. | Sim | String |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Manufacturer not found"
],
"data": []
}
Vai encontrar o fabricante com nome informado.
http://api.ecommloja.com.br/manufacturer/findByName
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome do fabricante. | Não | String |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Manufacturer not found"
],
"data": []
}
Vai listar os fabricantes.
http://api.ecommloja.com.br/manufacturer/list
GET
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Manufacturers not found"
],
"data": []
}
Vai listar o fabricante com nome informado.
http://api.ecommloja.com.br/manufacturer/findbyname
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome do fabricante. | Sim | String |
{
"success": true,
"errors": [],
"data":
{
"id": "7",
"name": "Casas Bahia",
"url": "casas-bahia",
"code": "",
"description": "",
"meta_description": "",
"meta_title": "",
"meta_keys": "",
"insert_date": "2021-04-29 10:18:01",
"last_update": "2021-04-29 10:18:01",
"status": "1"
}
}
{
"success": false,
"errors": [
"Manufacturer not found"
],
"data": []
}
Será atualizado na loja o fabricante com as informações enviadas nos campos.
http://api.ecommloja.com.br/manufacturer/update
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome do fabricante. | Sim | String |
| url | URL do fabricante. | não | String |
| code | Código do fabricante. | não | String |
| description | Descrição do fabricante. | não | String |
| meta_title | Meta título do fabricante. | não | String |
| meta_description | Meta descrição do fabricante. | não | String |
| keywords | Palavras chaves sobre o fabricante. | não | String |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}
Ligará o Fabricante ao Produto para mostrar o Fabricante na página do Produto.
http://api.ecommloja.com.br/manufacturer/linkProduct
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_sku | SKU do produto. | Sim | String |
| manufacturer_id | ID do fabricante. | Sim | Integer |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}
Retira a ligação que foi feita entre Fabricante e Categoria.
http://api.ecommloja.com.br/manufacturer/unlinkproduct
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_sku | SKU do produto. | Sim | String |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}
Excluir uma marca pelo ID.
http://api.ecommloja.com.br/brand/deletebyid
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| id | Identificador único da marca. | Sim | Int |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Brand not found"
],
"data": []
}
Excluir uma marca pelo nome.
http://api.ecommloja.com.br/brand/deletebyname
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome da marca. | Sim | String |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Brand not found"
],
"data": []
}
http://api.ecommloja.com.br/brand/insert
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome da Marca. | Sim | String |
| url | URL da Marca. | Não | String |
| description | Descrição | Não | String |
| sort | Ordem da Marca | Não | Int |
| view_menu | Visualizar no menu | Não | Int |
| meta_description | Meta descrição da Marca | Não | String |
| meta_title | Meta título da Marca | Não | String |
| meta_keys | Meta chaves da Marca | Não | String |
| status | Indica se a Marca está ativa ou inativa | Não | Boolean |
{
"name": "Logitech",
"url":"logitech",
"description":"marca de perifericos",
"sort":0,
"view_menu":0,
"meta_description":"logitech",
"meta_title":"logitech",
"meta_keys":"logitech",
"status":1
}
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": "brand not found",
"data": []
}
Busca uma Marca pelo ID
http://api.ecommloja.com.br/brand/findbyid
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| id | Identificador único da marca. | Sim | Int |
{
"success": true,
"errors": [],
"data": {
"id": "3",
"name": "marca",
"url": "marca",
"description": "marca",
"sort": "0",
"view_menu": "0",
"meta_description": "marca",
"meta_title": "marca",
"meta_keys": "marca",
"date_register": "2021-12-16 17:47:58",
"last_upload": "2021-12-16 17:47:58",
"status": "1"
}
}
{
"success": false,
"errors": [
"Brand not found"
],
"data": []
}
Busca uma Marca pelo Nome
Caso não envie o nome, todas as marcas serão retornadas.
http://api.ecommloja.com.br/brand/findbyname
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome da marca. | Não | String |
{
"success": true,
"errors": [],
"data": {
"id": "3",
"name": "marca",
"url": "marca",
"description": "marca",
"sort": "0",
"view_menu": "0",
"meta_description": "marca",
"meta_title": "marca",
"meta_keys": "marca",
"date_register": "2021-12-16 17:47:58",
"last_upload": "2021-12-16 17:47:58",
"status": "1"
}
}
{
"success": false,
"errors": [
"Brand not found"
],
"data": []
}
Ligará a Marca ao Produto para mostrar a Marca na página do Produto.
http://api.ecommloja.com.br/brand/linkProduct
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_sku | SKU do produto. | Sim | String |
| brand_id | ID da marca. | Sim | Integer |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}
Retira a ligação que foi feita entre Marca e Produto.
http://api.ecommloja.com.br/brand/unlinkproduct
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| product_sku | SKU do produto. | Sim | String |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}
Será atualizado na loja a marca com as informações enviadas nos campos.
Somente os campos enviados serão atualizados.
O ID deve ser enviado por POST, ele será a busca de atualização do produto.
http://api.ecommloja.com.br/Brand/update
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| brand_id | Identificador único da marca, através do ID. | Sim | String |
| name | Nome da marca. | Sim | String |
| url | Url da marca produto. | Não | String |
| view_menu | Visualização da marca no menu. | Não | Boolean |
| description | Descrição da marca | Não | Strig |
| image | Imagem da marca. | Não | String |
| menu_icon | Icone da marca no menu | Não | String |
| order | Ordem de exibição da marca | Não | Int |
| meta_description | Meta descrição da maraca. | Não | Str |
| meta_title | Meta titulo da marca | Não | String |
| meta_keys | Meta chaves da marca. | Não | strig |
| status | Status de exibição ativo ou inativo | nao | Boolean |
| desktop_image | Imagem para dispositivo desktop. | Não | string |
| mobile_image | Imagem para dispositivo mobile | Não | string |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": [
"Brand not found"
],
"data": []
}
Cadastra uma nova tag
http://api.ecommloja.com.br/tag/insert
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome da tag | Sim | String |
| tag_type |
Tipo da tag:
|
Sim | Int |
| category_id | Id da categoria | Não* | Int |
| bg_color | Cor de fundo da tag | Não | String |
| txt_color | Cor do texto da tag | Não | String |
| days | Dias que a tag deve ficar habilitada | Não | Int |
| minimum_value | Valor mínimo para habilitar a tag | Não | float |
| status | Status da tag | Não | Boolean |
* - Obrigatório caso a tag seja do tipo 6.
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": ['Error. Tag Name and Tag Type Nedded'],
"data": []
}
Atualiza a tag pelo ID.
http://api.ecommloja.com.br/tag/update
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| tag_id | Identificador da tag | Sim | Int |
| category_id | Id da categoria | Não | Int |
| bg_color | Cor de fundo da tag | Não | String |
| txt_color | Cor do texto da tag | Não | String |
| days | Dias que a tag deve ficar habilitada | Não | Int |
| minimum_value | Valor mínimo para habilitar a tag | Não | float |
| status | Status da tag | Não | Boolean |
Não é possível alterar o tipo de uma tag após o cadastro.
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": ['Tag not Found'],
"data": []
}
Consulta a tag pelo id da categoria.
http://api.ecommloja.com.br/tag/findbycategory
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| category_id | Id da categoria de referência. | Sim | Int |
{
"success": true,
"errors": [],
"data": [
{
"id": "34",
"name": "tag categoria",
"url": "tag-categoria-h3b",
"bg_color": "#000000",
"txt_color": "#eeeeec",
"tag_type": "6",
"category_id": "57",
"days": "0",
"minimum_price": "0.00",
"register_date": "2023-08-17 14:47:22",
"last_update": "2023-08-17 16:02:25",
"status": "1"
},
{
"id": "35",
"name": "tage desconto",
"url": "tage-desconto",
"bg_color": "#cc0000",
"txt_color": "#e9b96e",
"tag_type": "6",
"category_id": "57",
"days": "0",
"minimum_price": "0.00",
"register_date": "2023-08-17 16:06:14",
"last_update": "2023-08-17 16:06:14",
"status": "1"
}
]
}
{
"success": false,
"errors": ['Invalid Category'],
"data": []
}
Consulta a tag pelo nome.
http://api.ecommloja.com.br/tag/findbyname
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| name | Nome da tag | Sim | String |
{
"success": true,
"errors": [],
"data": [
{
"id": "4",
"name": "NOVIDADES",
"url": "NOVIDADES",
"bg_color": "#000000",
"txt_color": "#ffffff",
"tag_type": "2",
"days": "9000",
"minimum_price": "0.00",
"register_date": "2021-02-02 15:45:34",
"last_update": "2021-02-02 15:45:34",
"status": "1"
},
{
"id": "33",
"name": "Novidade",
"url": "novidade-55i",
"bg_color": "#12de45",
"txt_color": "#ffffff",
"tag_type": "2",
"days": "10",
"minimum_price": "0.00",
"register_date": "2022-06-13 08:51:50",
"last_update": "2022-06-13 08:51:50",
"status": "1"
}
]
}
{
"success": false,
"errors": ['Invalid Tag Name'],
"data": []
}
Consulta a tag pela url.
http://api.ecommloja.com.br/tag/findbyurl
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| url | Url da tag | Sim | String |
{
"success": true,
"errors": [],
"data": [
{
"id": "33",
"name": "Novidade",
"url": "novidade-55i",
"bg_color": "#12de45",
"txt_color": "#ffffff",
"tag_type": "2",
"days": "10",
"minimum_price": "0.00",
"register_date": "2022-06-13 08:51:50",
"last_update": "2022-06-13 08:51:50",
"status": "1"
}
]
}
{
"success": false,
"errors": ['Invalid Tag Url'],
"data": []
}
Consulta a tag pelo ID.
http://api.ecommloja.com.br/tag/findbyid
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| tag_id | Id da tag | Sim | Int |
{
"success": true,
"errors": [],
"data": [
{
"id": "33",
"name": "Novidade",
"url": "novidade-55i",
"bg_color": "#12de45",
"txt_color": "#ffffff",
"tag_type": "2",
"days": "10",
"minimum_price": "0.00",
"register_date": "2022-06-13 08:51:50",
"last_update": "2022-06-13 08:51:50",
"status": "1"
}
]
}
{
"success": false,
"errors": ['Invalid Tag Id'],
"data": []
}
Excluir uma tag
http://api.ecommloja.com.br/tag/delete
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| tag_id | Id da tag | Sim | Int |
{
"success": true,
"errors": [],
"data": []
}
{
"success": false,
"errors": ['Invalid ID'],
"data": []
}
Busca configurações de design para a página de Produtos.
http://api.ecommloja.com.br/design/getDesignforProducts
GET
{
"success": true,
"errors": [],
"data": {
"mostrar_marca": "0",
"redirect_cart": "1",
"view_botao_comprar": "1",
"checkout_orcamento": "0",
"mostrar_lista_desejos": "0",
"ocultar_sku": "0",
"view_preco_logado": "0",
"oculta_preco": "0",
"preco_produtos_sem_estoque": "0",
"info_pagamento": "",
"mostrar_grafico_produtos": "0",
"orcamento": "0",
"text_botao_comprar": "Comprar",
"orcamento_titulo": "",
"orcamento_subtitulo": "",
"caixa_obs": "",
"agendamento": "",
"hover_btn_comprar": "0",
"ocultar_cep_produto": "0",
"modelo_preco": "1",
"view_preco_parcelado": "0"
}
}
{
"success": false,
"errors": [
"Design not found"
],
"data": []
}
{
"success": false,
"errors": [
"Invalid request - Needed: GET",
],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}
Retornará os banners conforme os filtros inseridos.
Caso nenhum filtro seja inserido, os últimos 6 banners cadastros ativos serão retornados.
https://api.ecommloja.com.br/banner/findBannerByFilter
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| date_start | Data a partir da qual os banners serão buscados, os banners iniciados após essa data serão retornados. | Não | Datetime no formato AAAA-MM-DD |
| date_end | Data até a qual os banners serão buscados, os banners com vencimento dentro desse limite serão retornados. | Não | Datetime no formato AAAA-MM-DD |
| status | Status do banner. | Não | Int |
| device | Caso seja enviado SM, serão retornados os banners somente para mobile. Caso seja enviado M, serão retornados os banners para mobile e desktop. Caso seja enviado SD, serão retornados os banners somente para desktop. Caso seja enviado SD, serão retornados os banners somente para desktop e mobile. Caso não seja enviado nada, serão retornados os banners para mobile e desktop. | Não | String |
{
"success": true,
"errors": [],
"data": {
"id": "60",
"name": "NOME-IMAGEM-BANNER.jpg",
"extension": ".jpg",
"mobile_name": "NOME-IMAGEM-MOBILE.png",
"mobile_extension": ".png",
"link": "https://plataforma.ecommloja.com.br/categoria/pet",
"subtitle": "",
"type": "1",
"main": "0",
"sort": "7",
"date_start": "2020-10-08 09:55:47",
"date_end": "3000-12-31 23:59:59",
"search_category_flag": "0",
"status": "1",
"url_image_mobile": "loja/uploads/loja/banners/NOME-IMAGEM-MOBILE.png",
"url_image_desktop": "loja/uploads/loja/banners/NOME-IMAGEM-BANNER.jpg"
}
}
{
"success": false,
"errors": [
"Banner not found"
],
"data": []
}
{
"success": false,
"errors": [
"Invalid request - Needed: GET",
],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}
Função responsavel por retornar o carrinho e respectivos produtos atraves da hash.
Obs: É necessário o envio do token JWT no com o header Authorization.
https://api.ecommloja.com.br/cart/findcartbyhash
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| ip_cliente | O IP do cliente. | Sim | String |
| Tipo de pagamento | 2-Retirada; 3-Entrega. | Sim | Number |
| situacao_pagamento | Situação do pagamento. | Number | |
| modo_pagamento | String | ||
| bandeira_cartao | Bandeira do cartão em caso de pagamento por cartao. | Nao | String |
| numero_cartao | Numero do cartão caso o pagamento seja por cartão. | Não | String |
| nome_cartao | Nome do cartao caso pagamento seja por cartao. | Nao | String |
| validade_cartao | Validade do cartao. | Sim | String |
| parcelas_cartao | Parcelados da compra no cartao. | Sim | String |
| tipo_entrega | Tipo da entrega. | Sim | String |
| codigo_frete | Codigo do frete. | String | |
| prazo_frete | Prazo para entrega do produto. | Sim | String |
| link_boleto | Link do boleto, se for o caso. | Sim | String |
| link_pix | Link do pix se for o caso. | Sim | String |
| troco | Sim | String | |
| codigo_rastreio | Codigo de rastreio da compra. | Sim | String |
| lista_casamento_ativa | . | Sim | String |
{
"success": true,
"errors": [],
"data": { "message": "Pedido finalizado com sucesso!",
"order": {
"id": "2735",
"customer_id": "735",
"date": "2022-12-30 18:56:33",
"value": "1309.37", "status": "1",
"payment_method": "3",
"payment_mode": "0",
"discount": "0.00", "installments": "0",
"cep": "39400-170",
"street": "Rua João Paculdino", "number": "132",
"address_details": "",
"neighborhood": "Edgar Pereira",
"city": "Montes Claros", "state": "MG",
"country": "Brasil",
"note": "Pedido feito pelo Aplicativo", "delivery_note":
"shipping":"0.00",
"estimated delivery": "e",
"tracking_code":"", "tracking_link": "",
"delivery_type": "3", "delivery_code": "8"
}
}
| Campo | Significado | Tipo |
|---|---|---|
| message | Mensagem de sucesso. | String |
| id | Id do pedido. | String |
| costumer_id | Id do usuário. | String |
| date | Data da compra. | String |
| Value | Valor da compra. | String |
| status | . | String |
| payment_method | Método de pagamento. | String |
| payment_mode | . | string |
| discount | Eventual desconto. | string |
| installments | . | String |
| cep | Cep de entrega do produto. | String |
| street | Endereço de entrega do produto. | String |
| address_detail | Endereço de entrega do produto. | String |
| neighborhood | Endereço de entrega do produto. | String |
| city | Cidade de entrega do produto. | String |
| countruy | Pais de entrega do produto. | String |
| note | Eventual observação. | String |
| shipping | . | String |
| estimated_delivery | . | String |
| tracking_code | . | String |
| delivery_type | Tipo de entrega. | String |
{
"success": false,
"errors": [
"Cart not found"
],
"data": []
}
{
"success": false,
"errors": [
"Invalid request - Needed: GET",
],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}
Função responsavel por retornar o carrinho e respectivos produtos atraves da hash.
Obs: É necessário o envio do token JWT no com o header Authorization.
https://api.ecommloja.com.br/cart/findcartbyhash
GET
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| hash | Hash do carrinho de compras. | Sim | String |
{
"success": true,
"errors": [],
"data": {
"id": "1929",
"hash": "45cd08b12c69f9b89b6d8da1",
"user_id": "732",
"date_register": "2022-12-29 11:59:34",
"products": [
{
"id": "2311",
"cart_p_id": "30234",
"name": "Tinta Latex Acrilico Econômico 18L - Glasu",
"type": "4",
"status": "1",
"quantity": "15",
"variety": {
"variety_id": "334",
"sku": "182577",
"name": "Branco Neve",
"price": "194.47",
"promotional_price": "0.00",
"stock": "10",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "1",
"product_id": "2311",
"configurable_product_id": "14202"
},
"product_images": "devtintanorte.ecommercenet.com.br/uploads/devtintanorte/produtos_imagens/18L-Muda-Facil-metal16373280321996053908.jpg",
"stipulated_price": 2917.0500000000001818989403545856475830078125
}
],
"price": 2917.0500000000001818989403545856475830078125
}
}
| Campo | Significado | Tipo |
|---|---|---|
| id | Id do carrinho de compras. | String |
| hash | Hash do carrinho de compras. | String |
| user_id | Id do usuário dono do carrinho. | String |
| date | Data em que o carrinho de compras foi gerado. | String |
| Products(id) | Id do produto no carrinho. | String |
| cart_p_id | . | String |
| name | Nome do produto no carrinho. | String |
| type | Tipo do produto no carrinho. | string |
| status | Status do produto no carrinho. | string |
| quantity | Quantidade do produto no carrinho. | String |
| variety_id | Id da variação do produto no carrinho. | String |
| sku | Sku da variação do produto no carrinho. | String |
| name | Nome do produto no carrinho. | String |
| Stock | Estoque da variação do produto no carrinho. | String |
{
"success": false,
"errors": [
"Cart not found"
],
"data": []
}
{
"success": false,
"errors": [
"Invalid request - Needed: GET",
],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}
Função responsavel pela autenticação de um cliente final na loja.
https://api.ecommloja.com.br/client/clientlogin
POST
| Campo | Comentário | Obrigatório | Tipo |
|---|---|---|---|
| E-mail do cliente. | Sim | String | |
| pass | Senha do cliente. | Sim | String |
| Min | Booleano que irá configurar a opção por um retorno completo ou apenas com informações básicas. | Não | Int/Booleano |
{
"success": true,
"errors": [],
"data": {
"id": "732",
"name": "Hugo Desenvolvedor",
"email": "hugodev@email.com",
"token": "eyJhbGciOi76ed5g76e5d7IkpXVCJ9.eyJpc3MiOiJzci7457634g5763g54654d3zIiLCJpYXQiOiIyMDIzLTAxLTAzIDE1OjI5OjM2In0=.M3rYL9Erk2d8O5c4IP/YLGfWrbb5BLNt71lDPAbO5WM=",
"cep": "39400-160",
"street": "Rua Ouro Fino",
"number": "09",
"address_details": "",
"neighborhood": "Bairro Um de Abril",
"city": "Montes Claros",
"state": "MG",
"country": "Brasil",
"cellphone": "(38)98989-8989",
"telephone": "(38)98989-8989",
"hash_cart": "476e83ee9d0e951b72a8d2f415",
"products_cart": [
{
"id": "789",
"cart_p_id": "30307",
"name": "Esmalte 3,6L Brilhante Cores - Glasurit",
"type": "4",
"status": "1",
"quantity": "1",
"variety": {
"variety_id": "379",
"sku": "183236",
"name": "TABACO",
"price": "94.59",
"promotional_price": "0.00",
"stock": "131",
"weight": "0.000",
"height": "0",
"length": "0",
"width": "0",
"status": "1",
"product_id": "789",
"configurable_product_id": "13412"
},
"product_images": "devtintanorte.ecommercenet.com.br/uploads/devtintanorte/produtos_imagens/ESM-GLASURIT-3-6L1455.jpg",
"stipulated_price": 94.590000000000003410605131648480892181396484375
}
],
"total_quantity": 1,
"price": 94.590000000000003410605131648480892181396484375
}
}
| Campo | Significado | Tipo |
|---|---|---|
| id | Id de usuário. | String |
| name | Nome do usuário. | String |
| E-mail do usuário. | String | |
| token | Token no formato JWT para armazenamento, há necessidade do token para algumas funções do ambito de cliente final. | String |
| cep | CEP do usuário. | String |
| street | Rua do usuário. | String |
| number | Número do endereço do usuário. | String |
| address_details | Complemento do endereço do usuário. | string |
| neighborhood | Bairro do usuário. | string |
| city | Cidade do usuário. | String |
| state | Estado do usuário. | String |
| country | País do usuário. | String |
| cellphone | Celular do usuário. | String |
| telephone | Telefone fixo o usuário. | String |
| hash_cart | Hash do carrinho de compras, se houver. | String |
| products_cart(id) | . | String |
| products_cart(cart_d_id) | Url da variação. | String |
| products_cart(name) | Nome do produto. | String |
| products_cart(type) | Tipo de produto, se configurável ou variação | String |
| products_cart(status) | Status do produto no cart. | String |
| products_cart(quantity) | Quantidade do produto no cart. | String |
| products_cart(variety(variety_id)) | Id da variação do produto. | String |
| products_cart(variety(sku)) | SKU da variação do produto. | String |
| products_cart(variety(name)) | Nome da variação do produto. | String |
| products_cart(variety(price)) | Preço da variação do produto. | String |
| products_cart(variety(promotional_price)) | Preço promocional da variação do produto. | String |
| products_cart(variety(stock)) | Estoque da variação do produto. | String |
| product_image | Caminho/url da imagem do produto. | String |
| stipulated_price | Preço total do cart. | String |
| total_quantity | Quantidade itens no cart | String |
| price | Preço do cart. | String |
{
"success": false,
"errors": [
"Usar and password does not found"
],
"data": []
}
{
"success": false,
"errors": [
"Invalid request - Needed: GET",
],
"data": []
}
{
"success": false,
"errors": [],
"data": []
}