AGagentkey
ecommerce/shopee

List the product listings of a Shopee shop. Returns a normalized Product page.

Listings of one storefront on Shopee, by shop ID / username or shop page URL. Normalized to the Product object; page with next_cursor.

Fixed price: 4.4 credits per successful call, whichever provider serves it.

post/v2/ops/ecommerce.shopee.shop.products

Request

  • Base URL
    https://api.agentkey.app
  • URL
    https://api.agentkey.app/v2/ops/ecommerce.shopee.shop.products
  • Auth
    HTTP bearer

Request body

cursorstring

Opaque pagination cursor from the previous response's next_cursor. Send the same parameters with it.

fieldsstring[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

id_or_urlstring required

Shop username (the shopee.<tld>/<username> page) or that page URL.

include_rawboolean

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

limitinteger

Maximum number of products to return.

providerstring

Shorthand for routing.only = [provider].

site'TW' | 'ID' | 'TH'

Shopee marketplace site of the shop: TW = Taiwan, ID = Indonesia, TH = Thailand.

sort'general' | 'latest' | 'sales' | 'price_asc' | 'price_desc'

general = the shop's default ordering; latest = newest listings first; sales = best selling first; price_asc / price_desc = by selling price.

Response

Success envelope

credits_chargednumber required

Credits charged for this call (the method's fixed price).

opstring required

Method name.

op_versioninteger required

Method version that served the call.

providerstring required

Provider that actually served the call.

rawunknown
raw_truncatedboolean
request_idstring required

Correlation id; quote it in support requests.

took_msinteger required
unsupported_fieldsstring[] required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

Changes

No recorded changes to this operation across all 1 revision of this API.