/product/search

Buscar produtos

📘

Pesquisa de Produtos

É possível consultar produtos através dos seguintes parâmetros: "sku", "name", "status", "ean", "manufacturer" e "categories".

Dicionário de Dados | Resposta


{
    "status": true,
    "message": "Success",
    "data": {
        "total_products": 1,
        "products": [
            {
                "id": 125,
                "brand_id": 1744,
                "sku": "TESTE",
                "ean": "9795450563300",
                "name": "Refrigerante",
                "description": "100% Algodão",
                "unit_measurement": "Litros",
                "manufacturer": "Fabricante 1",
                "value_of": 10.5,
                "value_per": 7.2,
                "currency": "BRL",
                "status": true,
                "created": "2024-09-10 16:56:28",
                "modified": "2024-09-30 19:45:32",
                "categories": {
                    "category_1": "Bebidas"
                },
                "metadata": {
                    "custom_field": "custom_value"
                }
            }
        ]
    }
}
CampoDescrição
[data] total_productsQuantidade total de produtos.
[products] crm_idIdentificador do produto na CRMBonus.
[products] brand_idId da marca ao qual o produto está vinculado.
[products] skuIdentificador do produto.
[products] eanEuropean article number.
[products] nameNome do produto.
[products] descriptionDescrição do produto.
[products] unit_measurementUnidade de medida.
[products] manufacturerFabricante.
[products] value_ofValor base de referência do produto.
[products] value_perValor do produto com desconto.
[products] currencyMoeda.
[products] statusStatus do produto (Ativo ou Inativo).
[products] createdData de criação do produto.
[products] modifiedData de modificação do produto.
[products] categoriesCategorias do produto.
[products] metadataMetadados do produto.
Path Params
string
required
Defaults to ABC-12345-S-BL
Headers
string
required
Defaults to {pdvSystemName}

Nome do sistema PDV que está enviando a requisição

string
required
Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json