Skip to main content
GET
1688: Search listings

Request contract

  • Method and path: GET /apis/v1/commerce/alibaba-1688/listings
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/commerce/alibaba-1688/listings
  • country: query; required
  • q: query; required
  • period: query; optional
  • sort_by: query; optional
  • sort_order: query; optional
  • min_price: query; optional
  • max_price: query; optional
  • cursor: query; optional
  • page_size: query; optional
  • fields: query; optional
  • provenance: query; optional
  • Runtime facts: e4ea23246d148272326d4d18f79f43b8fa99cd58edd96f4f3759a860c1c99cf8
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

country
enum<string> | null
required

Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.

Available options:
CN
q
string | null
required

Search keywords. Chinese keywords, at most 50 characters.

period
enum<string> | null

Reporting window. 1d, 7d, 30d, and 90d are rolling windows ending at the latest update; calendar_month and calendar_week select the calendar period identified by date. See the enum for supported values. 7d or 30d; default 30d unless inferred from a window-specific sort key.

Available options:
30d,
7d
sort_by
enum<string> | null

Sort key. Usually an output field name; operation-specific notes explain keys that do not correspond to an output field.

Available options:
dropship_price,
gmv_30d,
gmv_7d,
launch_date,
order_count_30d,
order_count_7d,
price,
sales_count_30d,
sales_count_7d
sort_order
enum<string> | null

Sort direction: asc or desc. Requires sort_by.

Available options:
asc,
desc
min_price
string | null

Price in marketplace currency: inclusive lower bound. Wholesale price in CNY.

max_price
string | null

Price in marketplace currency: inclusive upper bound; must be at least the lower bound when both are supplied. Wholesale price in CNY.

cursor
string | null

Pass the previous response's next_cursor unchanged. Omit for the first page. A null next_cursor indicates the end of pagination. Page number starting at 1.

page_size
string | null

Number of items per page. 10-100; default 20.

fields
enum<string>[] | null

Comma-separated business field paths to return. Omit to use this operation's default field selection. The enum includes all fields of the shared item type. Some are populated only by other operations on the same platform; selecting them here does not supply missing data. Field selection trims output only and does not reduce source calls or charges.

Available options:
affiliate.commission_rate,
attributes.list,
badges,
brand,
category.native_id,
category.path_raw,
description.blocks,
dimensions.height_mm,
dimensions.length_mm,
dimensions.width_mm,
identifiers.ean,
identifiers.gtin,
identifiers.upc,
image.cover_url,
images,
lifecycle.launch_date,
metrics.ad_cost_reported,
metrics.ad_gmv_reported,
metrics.gmv,
metrics.gmv_15d,
metrics.gmv_1d,
metrics.gmv_30d,
metrics.gmv_60d,
metrics.gmv_7d,
metrics.gmv_90d,
metrics.gmv_total,
metrics.gmv_trend,
metrics.offer_count,
metrics.order_count,
metrics.order_count_30d,
metrics.order_count_7d,
metrics.repurchase_rate,
metrics.sales_count,
metrics.sales_count_15d,
metrics.sales_count_1d,
metrics.sales_count_30d,
metrics.sales_count_60d,
metrics.sales_count_7d,
metrics.sales_count_90d,
option_groups,
packaging.height_mm,
packaging.length_mm,
packaging.quantity,
packaging.weight_g,
packaging.width_mm,
rating.count,
rating.distribution,
rating.score,
related.bundle_listings,
related.categories,
related.child_listings,
related.frequently_bought_together_listings,
related.offers,
related.parent_listings,
related.variant_listings,
related.variants,
relation.shop_id,
review.count,
review.summary,
status.availability,
supplier.name,
supplier.native_id,
supplier.repurchase_rate,
supplier.service_score,
supplier.ship_from,
supplier.ships_within_hours,
supplier.url,
title,
unit_count.quantity,
unit_count.unit,
url,
weight_g,
wholesale.dropship_price,
wholesale.minimum_order_quantity,
wholesale.price,
wholesale.price_tiers,
wholesale.unit
provenance
enum<string> | null
default:compact

compact (default) returns value and source per field. Shared collection time, license, origin, and value_type are grouped in meta.sources; differing values retain their own metadata. full returns complete per-value provenance, including precision and confidence.

Available options:
compact,
full

Response

Success

items
(object | null)[] | null
meta
object | null
missing
(object | null)[] | null
next_cursor
string | null