Documentação da API de Produtos
Visão Geral
A API de Produtos permite a consulta de produtos com diversos filtros e opções de ordenação.
A solicitação deve obrigatoriamente conter o parâmetro _url.
Endpoint
GET /products
Parâmetros de Query
Obrigatório
- _url (string) - URL de referência para a requisição.
Opcionais
- _page (int) - Define a página de resultados (paginação).
- _limit (int) - Define a quantidade de resultados por página.
- _category_id (int) - Filtra produtos por ID da categoria.
- _name_like (string) - Filtra produtos por nome exato.
- _contains_name (string) - Filtra produtos contendo parte do nome especificado.
- _code (string) - Filtra produtos por código específico.
- _active (bool) - Filtra produtos ativos (
1para ativos,0para inativos). - _categories (string) - Filtra produtos por múltiplas categorias (separadas por vírgula).
- _variations (bool) - Se
1, inclui variações do produto. - _variation_items (bool) - Se
1, inclui itens das variações. - _order_by (string) - Define a ordenação dos resultados (ex:
price_asc,name_desc). - _maxprice (float) - Filtra produtos com preço máximo especificado.
- _product_price (float) - Filtra produtos com preço exato.
- _product_type (string) - Filtra produtos por tipo.
- _category_name (string) - Filtra produtos pelo nome da categoria.
- _variation_name (string) - Filtra produtos pelo nome da variação.
- _item_name (string) - Filtra produtos pelo nome do item.
Exemplo de Requisição
http
GET /products?_url=zatinni&_page=1&_limit=8Exemplo de Resposta (JSON)
json
[
{
"id": "46",
"variation_item_id": "46",
"id_store": "1",
"uri": "vestido-longo-lemise-floral-babado-feminino-preto",
"code": "4294967295",
"uniqid": "5ffcddd9dba70",
"ean": "2062115692",
"name": "Vestido Longo Lemise Floral Babado Feminino - Preto",
"price": "59.00",
"price_promo": "22.22",
"image": "uploads/1/4f145c2faef992b910f0d2d5b9cffee2.jpg",
"category": "Vestidos",
"category_id": "26",
"description_small": "1UN",
"description": {
"title": "Vestido Longo Lemise Floral Babado Feminino - Preto",
"image": "assets/img/product-default.png",
"text": "Marque presença nessa estação com o Vestido Longo Lemise Floral Babado Feminino, perfeito para todos os momentos."
},
"active": "1",
"variation": "1",
"stock": "1",
"idItem": "129591",
"imgUrl": "https://static.nuzap.com.br/uploads/1/4f145c2faef992b910f0d2d5b9cffee2.jpg"
},
{
"id": "11479",
"variation_item_id": "11479",
"id_store": "1",
"uri": "novo-produto-rapidao",
"code": "12311",
"uniqid": "6397321dc64d0",
"name": "Prancha de surf",
"price": "399.00",
"price_promo": "297.00",
"image": "uploads/1/f00825c4593785e2d3a4bf41cad3046a.jpg",
"category": "Outros",
"category_id": "22",
"description_small": "Prancha de surf",
"description": {
"title": "Prancha de surf",
"image": "assets/img/product-default.png",
"text": "Lorem Ipsum is simply dummy text of the printing and typesetting industry."
},
"active": "1",
"variation": "0",
"stock": "1",
"imgUrl": "https://static.nuzap.com.br/uploads/1/f00825c4593785e2d3a4bf41cad3046a.jpg"
}
]Exemplo de Consumo da API
Node.js (Axios)
javascript
const axios = require('axios');
axios.get('/products?_url=zatinni&_page=1&_limit=8')
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error('Erro ao buscar produtos:', error);
});PHP (cURL)
php
<?php
$url = "/products?_url=zatinni&_page=1&_limit=8";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>Códigos de Resposta
- 200 - Sucesso
- 400 - Parâmetro
_urlausente ou inválido - 500 - Erro interno no servidor
