Entrar

Buscar produtos por nome

GET https://{organization}.myguper.com/api/order/product/search

Substituído por GET /api/register/event/search (register). O audience builder agora casa o nome do produto direto via o filtro genérico event (type=buy_product) — sem o passo nome→SKU. Este endpoint ainda funciona, mas o caminho boughtSku / person_order_item é legado (sai no cutover).

Resolve termos de texto livre do nome do produto no conjunto de SKUs (skuRefId) que foram vendidos com nomes que casam. Alimenta o audience builder: os SKUs retornados vão para o filtro de audiência boughtSku no register.

terms é texto livre — termos separados por espaço são combinados com AND (aceita string terms=a b ou repetido terms[]=a&terms[]=b). sandalia salto retorna só SKUs cujo nome contém ambas as palavras (na mesma string). A busca é insensível a caixa e acento (collation utf8mb4_general_ci), então tenis casa TÊNIS.

O nome vem de order_item.productName (um snapshot por linha — a Guper não tem catálogo de produtos separado). O resultado é agrupado por skuRefId; cada item traz um name representativo e a contagem de linhas que casaram (hits), ordenado por hits desc. Sem escopo de interface — skuRefId é a referência canônica de SKU da organização.

Auth: signature RSA serviço-a-serviço (ver Internal › Integração › Signature). A organização vem do contexto da requisição.

Exemplo na prática

1. Buscar — achar os SKUs chamados "sandalia salto":

GET /api/order/product/search?terms=sandalia%20salto
{
    "terms": ["sandalia", "salto"],
    "total": 1,
    "products": [
        { "sku": "47142", "name": "Sandalia Salto Alto 38", "hits": 14 }
    ]
}

2. Montar a audiência — usar os sku retornados no filtro boughtSku da query de audiência do register (aqui: comprou nos últimos 3 meses):

[
    ["boughtSku", "in", { "list": ["47142"] }, { "int": 3 }]
]

Combine com outros filtros via AND — ex.: homens que compraram: coloque antes ["gender","equals",{"string":"male"}], "AND",. Referência completa do boughtSku em Internal › Services › Register › Audiência por produto.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parâmetros de query

Name Type Description
terms * string Termos de texto livre. Termos separados por espaço são combinados com AND no nome do produto. Também aceita array (`terms[]=sandalia&terms[]=salto`). `terms` vazio retorna resultado vazio.
limit integer Máximo de SKUs retornados (1..2000, default 500). Termos amplos podem bater o teto — refine (resultado grande também vira um `boughtSku IN (...)` grande).

Respostas

{
    "terms": ["sandalia", "salto"],
    "total": 1,
    "products": [
        { "sku": "47142", "name": "Sandalia Salto Alto 38", "hits": 14 }
    ]
}
Copied to clipboard