Pesquisa de lojas

Introdução

Recupere informações de lojas por palavras-chave ou condições de filtro, com os seguintes recursos:

• Oferece suporte à pesquisa difusa
• Oferece suporte a parâmetros de filtro
• Oferece suporte à ordenação personalizada dos resultados

Endpoint da API

POST /shop/v1/search

Corpo da solicitação

Campo	Tipo	Obrigatório	Descrição
keywords	string	Não	Palavras-chave de pesquisa
filter	object	Não	Parâmetros de filtro
orderby	array	Não	Parâmetros de ordenação
page	integer	Não	Número da página, padrão: 1
pagesize	integer	Não	Itens por página, padrão: 10

page * pagesize <= 5000

Intervalo de pagesize [10, 100]

Valores opcionais de filter

Campo	Tipo	Obrigatório	Descrição
seller_name	string	Não	Nome da loja
seller_id	string	Não	ID da loja
creator_uid	string	Não	uid do criador
creator_unique_id	string	Não	id exclusivo do criador : @xxxxxx
brand_name	string	Não	Nome da marca
rating_range	object	Não	Intervalo de avaliação da loja, por exemplo {'min': 1, 'max': 5}
creator_range	object	Não	Intervalo do número de criadores, por exemplo {'min': 1, 'max': 123}
is_sshop	boolean	Não	Se é uma loja gerenciada integralmente
is_local	boolean	Não	Se é uma loja local
category_id	integer	Não	Categoria principal
region	string	Não	Código da região

códigos de região disponíveis: ['US','GB','MX','ES','DE','IT','FR','PT','NL','BE','AT','PL','ID','VN','MY','TH','PH','BR','JP','SG']

Valores opcionais de orderby

Campo	Obrigatório	Descrição
day7_units_sold	Não	Volume de vendas em 7 dias (decrescente)
day7_gmv	Não	Receita em 7 dias (decrescente)
total_units_sold	Não	Volume total de vendas (decrescente)
total_gmv	Não	Receita total (decrescente)

Exemplo de solicitação

curl 'https://openapi.fastmoss.com/shop/v1/search'' ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxxx' \
--data '{
    "keywords":"",
    "filter": {
        "region": "US",
        "seller_name": "xxxxx",
    },
    "orderby": [{
        "field": "day7_units_sold",
        "order": "desc"
    }],
    "page": 1,
    "pagesize": 10,
}'

Corpo da resposta

data.total

• Tipo: integer
• Descrição: Número total de resultados

data.list

Campo	Tipo	Descrição
seller_id	string	ID da loja
category_id	array	Categorias de produtos
uid	string	UID
region	string	Região
name	string	Nome da loja
brand	string	Marca
shop_rating	integer	Avaliação da loja
total_units_sold	integer	Volume total de vendas
total_gmv	integer	Receita total
day7_units_sold	integer	Volume de vendas em 7 dias
day7_total_gmv	integer	Receita em 7 dias
is_local	integer	Se é uma loja local
is_sshop	integer	Se é uma loja gerenciada integralmente
on_sale_product_count	integer	Número de produtos à venda
affiliate_creator_count	integer	Número de criadores afiliados

data.list.creator

Campo	Tipo	Descrição
uid	string	uid do criador
avatar	string	avatar do criador
region	string	região do criador
nickname	string	apelido do criador
unique_id	string	id exclusivo do criador
follower_count	integer	número de seguidores do criador
category_id	integer	id da categoria do criador
category_name	string	nome da categoria do criador

Exemplo de resposta

{
  "code": 0,
  "data": {
    "list": [
      {
        "seller_id": "7496169538916026807",
        "category_id": ["3", "839944"],
        "uid": "7502001270334194734",
        "region": "US",
        "name": "YOUNG",
        "brand": "",
        "shop_rating": 37,
        "total_units_sold": 0,
        "total_gmv": 0,
        "day7_units_sold": 0,
        "day7_total_gmv": 0,
        "is_local": 0,
        "is_sshop": 0,
        "on_sale_product_count": 1573,
        "affiliate_creator_count": 0,
        "creator": {
          "uid": "",
          "avatar": "",
          "region": "",
          "nickname": "",
          "unique_id": "",
          "follower_count": 0,
          "category_id": 0,
          "category_name": ""
        }
      }
    ],
    "total": 1
  },
  "message": "",
  "timestamp": 1744797551,
  "request_id": "6f12def3-6946-8c55-ef98-2c2b37af867e"
}