ecommerce.tiktok_shop.shop.products

POST

ops

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

curl --request POST \
  --url https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id_or_url": "<string>",
  "cursor": "<string>",
  "fields": [
    "<string>"
  ],
  "include_raw": false,
  "limit": 20,
  "provider": "<string>",
  "region": "US",
  "routing": {
    "allow_fallbacks": true,
    "only": [
      "<string>"
    ],
    "order": [
      "<string>"
    ],
    "strategy": "auto"
  },
  "sort": "general"
}
'

import requests

url = "https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products"

payload = {
    "id_or_url": "<string>",
    "cursor": "<string>",
    "fields": ["<string>"],
    "include_raw": False,
    "limit": 20,
    "provider": "<string>",
    "region": "US",
    "routing": {
        "allow_fallbacks": True,
        "only": ["<string>"],
        "order": ["<string>"],
        "strategy": "auto"
    },
    "sort": "general"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id_or_url: '<string>',
    cursor: '<string>',
    fields: ['<string>'],
    include_raw: false,
    limit: 20,
    provider: '<string>',
    region: 'US',
    routing: {
      allow_fallbacks: true,
      only: ['<string>'],
      order: ['<string>'],
      strategy: 'auto'
    },
    sort: 'general'
  })
};

fetch('https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id_or_url' => '<string>',
    'cursor' => '<string>',
    'fields' => [
        '<string>'
    ],
    'include_raw' => false,
    'limit' => 20,
    'provider' => '<string>',
    'region' => 'US',
    'routing' => [
        'allow_fallbacks' => true,
        'only' => [
                '<string>'
        ],
        'order' => [
                '<string>'
        ],
        'strategy' => 'auto'
    ],
    'sort' => 'general'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products"

	payload := strings.NewReader("{\n  \"id_or_url\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"limit\": 20,\n  \"provider\": \"<string>\",\n  \"region\": \"US\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"sort\": \"general\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id_or_url\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"limit\": 20,\n  \"provider\": \"<string>\",\n  \"region\": \"US\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"sort\": \"general\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id_or_url\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"limit\": 20,\n  \"provider\": \"<string>\",\n  \"region\": \"US\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"sort\": \"general\"\n}"

response = http.request(request)
puts response.read_body

{
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "credits_charged": 123,
  "data": {
    "items": [
      {
        "brand": "<string>",
        "category": "<string>",
        "description": "<string>",
        "id": "<string>",
        "image_url": "<string>",
        "images": [
          "<string>"
        ],
        "in_stock": true,
        "monthly_sales_count": 123,
        "platform": "<string>",
        "price": {
          "amount": 123,
          "currency": "<string>",
          "original_amount": 123
        },
        "rating": {
          "count": 123,
          "score": 123
        },
        "sales_count": 123,
        "sales_text": "<string>",
        "shop": {
          "id": "<string>",
          "name": "<string>",
          "url": "<string>"
        },
        "title": "<string>",
        "url": "<string>"
      }
    ],
    "next_cursor": "<string>"
  },
  "op": "<string>",
  "op_version": 123,
  "provider": "<string>",
  "request_id": "<string>",
  "took_ms": 123,
  "unsupported_fields": [
    "<string>"
  ],
  "raw": "<unknown>",
  "raw_truncated": true
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

AgentKey API key (ak_…).

Body

application/json

id_or_url

string

required

Numeric TikTok Shop seller id (seller_id of a product card) or the store page URL shop.tiktok.com//store//<seller_id>.

cursor

string

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

fields

string[]

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

include_raw

boolean

default:false

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

limit

integer

default:20

Maximum number of products to return.

Required range: 1 <= x <= 20

provider

string

Shorthand for routing.only = [provider].

region

enum<string>

default:US

TikTok Shop market of the seller (ISO 3166-1 alpha-2).

Available options:

US,

GB,

SG,

MY,

PH,

TH,

VN,

ID

routing

object

Provider routing override. order: try these providers first; only: restrict to these (equivalent to pinning); allow_fallbacks: false tries only the first eligible provider.

Show child attributes

sort

enum<string>

default:general

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

Available options:

general,

latest,

sales,

price_asc,

price_desc

Response

Success envelope

Success envelope whose data is a ProductPage.

attempts

object[]

required

Show child attributes

credits_charged

number

required

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

data

object

required

One page of products.

Show child attributes

string

required

Method name.

op_version

integer

required

Method version that served the call.

provider

string

required

Provider that actually served the call.

request_id

string

required

Correlation id; quote it in support requests.

took_ms

integer

required

unsupported_fields

string[]

required

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

raw

any

Upstream payload, only with include_raw=true. Not a stable contract.

raw_truncated

boolean

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

curl --request POST \
  --url https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id_or_url": "<string>",
  "cursor": "<string>",
  "fields": [
    "<string>"
  ],
  "include_raw": false,
  "limit": 20,
  "provider": "<string>",
  "region": "US",
  "routing": {
    "allow_fallbacks": true,
    "only": [
      "<string>"
    ],
    "order": [
      "<string>"
    ],
    "strategy": "auto"
  },
  "sort": "general"
}
'

import requests

url = "https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products"

payload = {
    "id_or_url": "<string>",
    "cursor": "<string>",
    "fields": ["<string>"],
    "include_raw": False,
    "limit": 20,
    "provider": "<string>",
    "region": "US",
    "routing": {
        "allow_fallbacks": True,
        "only": ["<string>"],
        "order": ["<string>"],
        "strategy": "auto"
    },
    "sort": "general"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id_or_url: '<string>',
    cursor: '<string>',
    fields: ['<string>'],
    include_raw: false,
    limit: 20,
    provider: '<string>',
    region: 'US',
    routing: {
      allow_fallbacks: true,
      only: ['<string>'],
      order: ['<string>'],
      strategy: 'auto'
    },
    sort: 'general'
  })
};

fetch('https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id_or_url' => '<string>',
    'cursor' => '<string>',
    'fields' => [
        '<string>'
    ],
    'include_raw' => false,
    'limit' => 20,
    'provider' => '<string>',
    'region' => 'US',
    'routing' => [
        'allow_fallbacks' => true,
        'only' => [
                '<string>'
        ],
        'order' => [
                '<string>'
        ],
        'strategy' => 'auto'
    ],
    'sort' => 'general'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products"

	payload := strings.NewReader("{\n  \"id_or_url\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"limit\": 20,\n  \"provider\": \"<string>\",\n  \"region\": \"US\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"sort\": \"general\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id_or_url\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"limit\": 20,\n  \"provider\": \"<string>\",\n  \"region\": \"US\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"sort\": \"general\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.shop.products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id_or_url\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"limit\": 20,\n  \"provider\": \"<string>\",\n  \"region\": \"US\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"sort\": \"general\"\n}"

response = http.request(request)
puts response.read_body

{
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "credits_charged": 123,
  "data": {
    "items": [
      {
        "brand": "<string>",
        "category": "<string>",
        "description": "<string>",
        "id": "<string>",
        "image_url": "<string>",
        "images": [
          "<string>"
        ],
        "in_stock": true,
        "monthly_sales_count": 123,
        "platform": "<string>",
        "price": {
          "amount": 123,
          "currency": "<string>",
          "original_amount": 123
        },
        "rating": {
          "count": 123,
          "score": 123
        },
        "sales_count": 123,
        "sales_text": "<string>",
        "shop": {
          "id": "<string>",
          "name": "<string>",
          "url": "<string>"
        },
        "title": "<string>",
        "url": "<string>"
      }
    ],
    "next_cursor": "<string>"
  },
  "op": "<string>",
  "op_version": 123,
  "provider": "<string>",
  "request_id": "<string>",
  "took_ms": 123,
  "unsupported_fields": [
    "<string>"
  ],
  "raw": "<unknown>",
  "raw_truncated": true
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

Overview

Scenario Methods

Catalog & Describe

Methods

Tool Catalog (MCP)

ecommerce.tiktok_shop.shop.products

Authorizations

Body

Response