Shop
commerce.shopUnifiedSoonA seller account on one marketplace.
key marketplace + seller ID4 planned calls2 Direct endpoints today
4 calls plannedSoon
Calls from commerce API design 0.1.0-draft, written as REST paths. Each call returns this entity in one shape on the platforms it lists, and none is deployed yet.
- GET
/One shop's public profile and metricsTikTok Shop · AmazonDesignedv1/ e-commerce/ shops/ {shopId} - GET
/The listings of one shopTikTok ShopDesignedv1/ e-commerce/ shops/ {shopId}/ listings - GET
/Filter shops by category and cross-border statusTikTok ShopDesignedv1/ e-commerce/ tiktok-shop/ shops/ search - GET
/Shop rankings by day, week or monthTikTok ShopDesignedv1/ e-commerce/ tiktok-shop/ shops/ rankings
85 fields in the field contractDesign 0.1.0-draft · listing-contract-v3.2
Field keys and how each value is written, as the design defines them. Only fields a source actually returned come back.
Identity5
AIsa's ID, the platform, the site and the platform's own IDentity.iduuidentity.kindstringentity.platformstringentity.scopestringshop.seller_idstring
Profile12
Details the platform publishes about itshop.namestringshop.urlurlshop.location_rawstringshop.type_rawstringshop.identity_label_rawstringshop.business_infostring[]shop.business_type_rawstringshop.managed_type_rawjsonshop.primary_sales_channel_rawstringshop.sales_trend_rawstringshop.rating_count_reporteddecimalshop.is_cross_borderboolean
Page1
Title, link, images and what the page showsimage.cover_urlurl
Price2
Numeric strings, in the currency under contextprice.display_mindecimalprice.display_maxdecimal
Ratings1
Rating and review counts, kept apartrating.scoredecimal
Metrics59
Sales, GMV and engagement, each over its source's periodmetrics.sales_countdecimalmetrics.gmvdecimalmetrics.follower_count_totaldecimalmetrics.gmv_totaldecimalmetrics.sales_count_1ddecimalmetrics.gmv_1ddecimalmetrics.sales_count_7ddecimalmetrics.gmv_7ddecimalmetrics.sales_count_30ddecimal
Show 50 more fieldsShow fewer
metrics.gmv_30ddecimalmetrics.sales_count_90ddecimalmetrics.gmv_90ddecimalmetrics.gmv_reporteddecimalmetrics.positive_feedback_rate_reporteddecimalmetrics.response_rate_reporteddecimalmetrics.delivery_rate_reporteddecimalmetrics.product_count_totaldecimalmetrics.product_count_currentdecimalmetrics.product_count_on_saledecimalmetrics.creator_count_totaldecimalmetrics.video_count_totaldecimalmetrics.live_count_totaldecimalmetrics.creator_count_reporteddecimalmetrics.video_count_reporteddecimalmetrics.live_count_reporteddecimalmetrics.live_creator_count_totaldecimalmetrics.video_creator_count_totaldecimalmetrics.shop_creator_count_totaldecimalmetrics.self_promotion_gmv_7ddecimalmetrics.affiliate_gmv_7ddecimalmetrics.shopping_mall_gmv_7ddecimalmetrics.gmv_growth_rate_7ddecimalmetrics.self_promotion_gmv_30ddecimalmetrics.affiliate_gmv_30ddecimalmetrics.shopping_mall_gmv_30ddecimalmetrics.gmv_growth_rate_30ddecimalmetrics.self_promotion_gmv_reporteddecimalmetrics.affiliate_gmv_reporteddecimalmetrics.shopping_mall_gmv_reporteddecimalmetrics.gmv_growth_rate_reporteddecimalmetrics.video_sales_count_30ddecimalmetrics.video_gmv_30ddecimalmetrics.live_sales_count_30ddecimalmetrics.live_gmv_30ddecimalmetrics.product_card_sales_count_30ddecimalmetrics.product_card_gmv_30ddecimalmetrics.personal_creator_sales_count_30ddecimalmetrics.personal_creator_gmv_30ddecimalmetrics.seller_creator_sales_count_30ddecimalmetrics.seller_creator_gmv_30ddecimalmetrics.interval_related_creator_count_reporteddecimalmetrics.interval_total_related_creator_count_reporteddecimalmetrics.interval_total_related_video_creator_count_reporteddecimalmetrics.interval_total_related_shop_creator_count_reporteddecimalmetrics.interval_total_related_videos_count_reporteddecimalmetrics.interval_sold_count_reporteddecimalmetrics.interval_total_sold_count_reporteddecimalmetrics.interval_sold_count_growth_rate_reporteddecimalmetrics.interval_gmv_pop_growth_rate_reporteddecimal
Links4
AIsa IDs of the entities it points atrelated.categoriesuuid[]related.listingsuuid[]related.creatorsuuid[]related.product_categoriesuuid[]
Context1
The currency every money field usescontext.currencystring
decimal and integer values arrive as strings to keep precision. A key ending in _reported is the source's own figure, method unconfirmed; _raw keeps the source's raw code. uuid fields point at other AIsa entities.
Fields AIsa adds on topDraft · not in the design
Estimates, checks and risk lists from other sources, planned to come back in the same response.
Verifiable
One source at a time, until an answer passes a checkorganizationOrganizationObservedMatched by credit code or D-U-N-S
Lists and risk
Several sources, pooled and de-duplicated; one risk hit is enough to flagtro_casesCase[]ObservedSchedule A cases that name the shop
Call it today through DirectLive
Vendor endpoints that already return this kind of object, in the vendor's own format. Your code names the vendor, so switching vendors means changing it.
2 endpoints from 1 API · from $0.001
Next to Shop
Each link is a field you can ask for in the same call.
Listing
marketplace + listing IDOne product page on one marketplace: price, rank, reviews and sales.
Offer
listing + shopOne shop's price, stock and delivery on a listing.
Creator
platform + creator IDA creator who sells through affiliate links.
Organization
credit code · D-U-N-S · domainThe company behind shops, factories, brands and patents. Seller, supplier and rights holder are roles it plays.
Case
court + docket no.An IP lawsuit, including Schedule A cases and the TROs that freeze shop funds.