{ "name": "TikTok Shop Open API Mock (Tokopedia)", "description": "Mock of the TikTok Shop Partner / Open API (the platform powering Tokopedia in Indonesia).", "version": "202405", "status": "running", "base_url": "https://open-api.tiktokglobalshop.com (mocked at this host)", "auth_base_url": "https://auth.tiktok-shops.com (mocked at this host)", "documentation": "https://partner.tiktokshop.com/docv2/page/tts-developer-guide", "reference_ui": "/docs", "swagger_ui": "/swagger", "openapi_spec": "/openapi.json", "mock_credentials": { "app_key": "mock_app_key", "app_secret": "mock_app_secret_for_testing", "access_tokens": [ "TTS_mock_access_token_001", "TTS_mock_access_token_002" ], "shop_ciphers": [ "TTS_CIPHER_TOKO_ID01", "TTS_CIPHER_TOKO_ID02" ], "access_token_header": "x-tts-access-token" }, "authentication": { "description": "Open-API requests need app_key + timestamp + sign query params and the x-tts-access-token header (access_token query param also accepted in this mock). Shop-scoped requests also need shop_cipher. Token endpoints use app_key + app_secret. Signatures are validated only when strict_sign=1 is added.", "required_query_params": [ "app_key", "timestamp", "sign" ], "required_header": "x-tts-access-token", "shop_scoped_param": "shop_cipher", "sign_algorithm": "HMAC-SHA256( app_secret + path + sorted(key+value for query params except sign/access_token) + body + app_secret )", "skip_auth_paths": [ "/api/v2/token/get", "/api/v2/token/refresh", "/api/v2/utils/generate_sign" ] }, "endpoints": { "authorization": [ { "method": "GET", "path": "/api/v2/token/get", "description": "Exchange an authorization code for an access token + refresh token. Mirrors auth.tiktok-shops.com.", "query_params": { "app_key": "string (required)", "app_secret": "string (required)", "auth_code": "string (required)", "grant_type": "string (required: authorized_code)" }, "response_fields": [ "access_token", "access_token_expire_in", "refresh_token", "refresh_token_expire_in", "open_id", "seller_name", "seller_base_region", "granted_scopes" ] }, { "method": "GET", "path": "/api/v2/token/refresh", "description": "Refresh an access token using a refresh token. Mirrors auth.tiktok-shops.com.", "query_params": { "app_key": "string (required)", "app_secret": "string (required)", "refresh_token": "string (required)", "grant_type": "string (required: refresh_token)" }, "response_fields": [ "access_token", "access_token_expire_in", "refresh_token", "refresh_token_expire_in", "open_id", "seller_name", "granted_scopes" ] }, { "method": "GET", "path": "/authorization/202309/shops", "description": "Get the shop(s) authorized to the app for this access_token, including each shop's cipher.", "response_fields": [ "shops" ] }, { "method": "GET", "path": "/authorization/202405/category_assets", "description": "Get Authorized Category Assets — brands, size charts, and certifications the seller is authorized to use, grouped by category.", "query_params": { "category_asset_types": "string (comma-separated: BRAND,SIZE_CHART,CERTIFICATION)" }, "response_fields": [ "category_assets" ] } ], "seller": [ { "method": "GET", "path": "/seller/202309/shops", "description": "Get Active Shops — the active (authorized) shops for the seller (cipher not required).", "response_fields": [ "shops" ] }, { "method": "GET", "path": "/seller/202309/permissions", "description": "Get the API permission scopes granted to the app for the authorized seller.", "response_fields": [ "permissions" ] } ], "product": [ { "method": "POST", "path": "/product/202309/products/search", "description": "Search the shop's products by status, keyword, category, SKU, and time range. page_token pagination.", "query_params": { "page_size": "number (required)", "page_token": "string" }, "body_params": { "status": "string", "listing_platform": "string (ID market: TIKTOK_SHOP|TOKOPEDIA)", "category_id": "string", "seller_skus": "array of string", "create_time_ge": "number", "create_time_le": "number" }, "response_fields": [ "total_count", "next_page_token", "products" ] }, { "method": "POST", "path": "/product/202502/products/search", "description": "Search products (v202502) — latest product search with extended filters.", "query_params": { "page_size": "number (required)", "page_token": "string" }, "body_params": { "status": "string", "listing_platform": "string (ID market: TIKTOK_SHOP|TOKOPEDIA)", "category_id": "string", "seller_skus": "array of string" }, "response_fields": [ "total_count", "next_page_token", "products" ] }, { "method": "GET", "path": "/product/202309/products/{product_id}", "description": "Get the full detail of a single product: SKUs, images, attributes, dimensions, weight, and status.", "response_fields": [ "id", "status", "title", "category_id", "brand", "integrated_platform_statuses", "main_images", "skus", "package_weight", "package_dimensions", "description", "product_attributes" ] }, { "method": "GET", "path": "/product/202309/categories", "description": "Get the full product category tree. In the ID market pass listing_platform (TIKTOK_SHOP|TOKOPEDIA) — the two storefronts have different category trees.", "query_params": { "keyword": "string", "category_version": "string (e.g. v1)", "listing_platform": "string (ID market: TIKTOK_SHOP|TOKOPEDIA)", "include_prohibited_categories": "boolean (default false)", "locale": "string (e.g. en-US)" }, "response_fields": [ "categories" ] }, { "method": "GET", "path": "/product/202309/categories/{category_id}/attributes", "description": "Get the product and sales attributes (with allowed values) for a leaf category.", "query_params": { "locale": "string", "category_version": "string" }, "response_fields": [ "attributes" ] }, { "method": "GET", "path": "/product/202309/brands", "description": "Get a paginated list of brands available for a category, including authorization status.", "query_params": { "page_size": "number (required)", "page_token": "string", "category_id": "string", "is_authorized": "boolean", "brand_name": "string" }, "response_fields": [ "brands", "next_page_token", "total_count" ] }, { "method": "POST", "path": "/product/202309/products/{product_id}/inventory/update", "description": "Update SKU inventory quantities for a product across warehouses.", "body_params": { "skus": "array of { id, inventory: [{ warehouse_id, quantity }] } (required)" }, "response_fields": [ "errors" ] }, { "method": "POST", "path": "/product/202309/products/{product_id}/prices/update", "description": "Update SKU prices for a product.", "body_params": { "skus": "array of { id, price: { amount, currency, sale_price } } (required)" }, "response_fields": [ "errors" ] }, { "method": "POST", "path": "/product/202309/products/activate", "description": "Activate (list) one or more deactivated products.", "body_params": { "product_ids": "array of string (required)", "listing_platforms": "array (ID market: TIKTOK_SHOP|TOKOPEDIA)" }, "response_fields": [ "errors" ] }, { "method": "POST", "path": "/product/202309/products/deactivate", "description": "Deactivate (unlist) one or more products.", "body_params": { "product_ids": "array of string (required)", "listing_platforms": "array (ID market: TIKTOK_SHOP|TOKOPEDIA)" }, "response_fields": [ "errors" ] }, { "method": "POST", "path": "/product/202309/categories/recommend", "description": "Recommend the most relevant leaf category for a product based on its title/description.", "body_params": { "product_title": "string (required)", "description": "string" }, "response_fields": [ "leaf_category_id", "categories" ] }, { "method": "GET", "path": "/product/202309/categories/{category_id}/global_attributes", "description": "Get Global Attributes", "query_params": { "locale": "optional (string)", "category_version": "optional (string)" }, "response_fields": [ "attributes" ] }, { "method": "GET", "path": "/product/202309/categories/{category_id}/global_rules", "description": "Get Global Category Rules", "query_params": { "category_version": "optional (string)", "locale": "optional (string)" }, "response_fields": [ "product_certifications", "size_chart", "responsible_person", "manufacturer" ] }, { "method": "GET", "path": "/product/202309/categories/{category_id}/rules", "description": "Get Category Rules", "query_params": { "category_version": "optional (string)", "locale": "optional (string)" }, "response_fields": [ "product_certifications", "size_chart", "cod", "package_dimension", "epr", "responsible_person", "manufacturer", "allowed_special_product_types", "fees" ] }, { "method": "GET", "path": "/product/202309/global_categories", "description": "Get Global Categories", "query_params": { "locale": "optional (string)", "keyword": "optional (string)", "category_version": "optional (string)" }, "response_fields": [ "categories" ] }, { "method": "POST", "path": "/product/202309/global_categories/recommend", "description": "Recommend Global Categories", "body_params": { "product_title": "required (string)", "description": "optional (string)", "images": "optional ([]object)", "^uri": "optional (string)", "category_version": "optional (string)" }, "response_fields": [ "leaf_category_id", "categories" ] }, { "method": "POST", "path": "/product/202309/global_products", "description": "Create Global Product", "body_params": { "title": "required (string)", "description": "required (string)", "category_id": "required (string)", "brand_id": "optional (string)", "main_images": "required ([]object)", "^uri": "required (string)", "skus": "required ([]object)", "^global_quantity": "optional (int)", "^sales_attributes": "optional ([]object)", "^^id": "required (string)", "^^name": "optional (string)", "^^value_id": "optional (string)", "^^value_name": "optional (string)", "^^sku_img": "optional (object)", "^^^uri": "required (string)", "^seller_sku": "optional (string)", "^price": "required (object)", "^^amount": "required (string)", "^^currency": "required (string)", "^identifier_code": "optional (object)", "^^code": "optional (string)", "^^type": "optional (string)", "^inventory": "optional ([]object)", "^^global_warehouse_id": "required (string)", "^^quantity": "required (int)", "^sku_unit_count": "optional (string)", "^extra_identifier_codes": "optional ([]string)", "^external_global_sku_id": "optional (string)", "package_weight": "required (object)", "^value": "required (string)", "^unit": "required (string)", "certifications": "optional ([]object)", "^id": "required (string)", "^images": "optional ([]object)", "^^uri": "required (string)", "^files": "optional ([]object)", "^^format": "required (string)", "package_dimensions": "optional (object)", "^length": "required (string)", "^width": "required (string)", "^height": "required (string)", "product_attributes": "optional ([]object)", "^values": "required ([]object)", "size_chart": "optional (object)", "^image": "optional (object)", "^template": "optional (object)", "video": "optional (object)", "manufacturer": "optional (object)", "^name": "optional (string)", "^address": "optional (string)", "^phone_number": "optional (string)", "^email": "optional (string)", "category_version": "optional (string)", "responsible_person_ids": "optional ([]string)", "manufacturer_ids": "optional ([]string)", "source_locale": "optional (string)", "external_global_product_id": "optional (string)" }, "response_fields": [ "global_product_id", "global_skus" ] }, { "method": "DELETE", "path": "/product/202309/global_products", "description": "Delete Global Products", "body_params": { "global_product_ids": "required ([]string)" }, "response_fields": [ "errors" ] }, { "method": "PUT", "path": "/product/202309/global_products/{global_product_id}", "description": "Edit Global Product", "body_params": { "title": "required (string)", "description": "required (string)", "category_id": "required (string)", "brand_id": "optional (string)", "main_images": "required ([]object)", "^uri": "required (string)", "skus": "required ([]object)", "^id": "required (string)", "^global_quantity": "optional (int)", "^seller_sku": "optional (string)", "^price": "required (object)", "^^amount": "required (string)", "^^currency": "required (string)", "^sales_attributes": "optional ([]object)", "^^id": "required (string)", "^^name": "optional (string)", "^^value_id": "optional (string)", "^^value_name": "optional (string)", "^^sku_img": "optional (object)", "^^^uri": "required (string)", "^inventory": "optional ([]object)", "^^global_warehouse_id": "required (string)", "^^quantity": "required (int)", "^identifier_code": "optional (object)", "^^code": "optional (string)", "^^type": "optional (string)", "^sku_unit_count": "optional (string)", "^extra_identifier_codes": "optional ([]string)", "^external_global_sku_id": "optional (string)", "^sale_prices": "optional ([]object)", "^^region": "required (string)", "package_weight": "required (object)", "^value": "required (string)", "^unit": "required (string)", "certifications": "optional ([]object)", "^images": "optional ([]object)", "^^uri": "required (string)", "^files": "optional ([]object)", "^^format": "required (string)", "package_dimensions": "optional (object)", "^length": "required (string)", "^width": "required (string)", "^height": "required (string)", "product_attributes": "optional ([]object)", "^values": "required ([]object)", "size_chart": "optional (object)", "^image": "optional (object)", "^template": "optional (object)", "video": "optional (object)", "manufacturer": "optional (object)", "^name": "optional (string)", "^address": "optional (string)", "^phone_number": "optional (string)", "^email": "optional (string)", "manufacturer_ids": "optional ([]string)", "responsible_person_ids": "optional ([]string)", "category_version": "optional (string)", "external_global_product_id": "optional (string)" }, "response_fields": [ "global_skus", "publish_results" ] }, { "method": "GET", "path": "/product/202309/global_products/{global_product_id}", "description": "Get Global Product", "response_fields": [ "id", "title", "main_images", "video", "description", "package_dimensions", "package_weight", "certifications", "skus", "update_time", "create_time", "product_attributes", "size_chart", "products", "global_seller_id", "brand", "category", "manufacturer", "responsible_person_ids", "manufacturer_ids", "source_locale", "external_global_product_id" ] }, { "method": "POST", "path": "/product/202309/global_products/{global_product_id}/inventory/update", "description": "Update Global Inventory", "body_params": { "global_skus": "required ([]object)", "^id": "required (string)", "^inventory": "required ([]object)", "^^global_warehouse_id": "required (string)", "^^quantity": "required (int)" } }, { "method": "POST", "path": "/product/202309/global_products/{global_product_id}/publish", "description": "Publish Global Product", "body_params": { "publish_target": "required ([]object)", "^region": "required (string)", "^responsible_person_ids": "optional ([]string)", "^manufacturer_ids": "optional ([]string)", "^skus": "required ([]object)", "^^related_global_sku_id": "required (string)", "^^price": "optional (object)", "^^^amount": "optional (string)", "^^^currency": "required (string)", "^^^sale_price": "optional (string)", "^^inventory": "optional (object)", "^^^warehouse_id": "optional (string)", "^^^quantity": "optional (int)", "^^fees": "optional ([]object)", "^^^type": "optional (string)", "^^^additional_attribute": "optional (string)" }, "response_fields": [ "products", "publish_result" ] }, { "method": "POST", "path": "/product/202309/inventory/search", "description": "Inventory Search", "body_params": { "product_ids": "optional ([]string)", "sku_ids": "optional ([]string)" }, "response_fields": [ "inventory" ] }, { "method": "POST", "path": "/product/202309/products", "description": "Create Product", "body_params": { "save_mode": "optional (string)", "description": "required (string)", "category_id": "required (string)", "brand_id": "optional (string)", "main_images": "required ([]object)", "^uri": "required (string)", "skus": "required ([]object)", "^sales_attributes": "optional ([]object)", "^^id": "required (string)", "^^value_id": "optional (string)", "^^value_name": "optional (string)", "^^sku_img": "optional (object)", "^^^uri": "required (string)", "^^name": "optional (string)", "^^supplementary_sku_images": "optional ([]object)", "^inventory": "required ([]object)", "^^warehouse_id": "required (string)", "^^quantity": "optional (int)", "^^backorder_quantity": "optional (int)", "^^handling_time": "optional (int)", "^seller_sku": "optional (string)", "^price": "required (object)", "^^amount": "optional (string)", "^^currency": "required (string)", "^^sale_price": "optional (string)", "^external_sku_id": "optional (string)", "^identifier_code": "optional (object)", "^^code": "optional (string)", "^^type": "optional (string)", "^combined_skus": "optional ([]object)", "^^product_id": "required (string)", "^^sku_id": "required (string)", "^^sku_count": "required (int)", "^sku_unit_count": "optional (string)", "^external_urls": "optional ([]string)", "^extra_identifier_codes": "optional ([]string)", "^pre_sale": "optional (object)", "^^fulfillment_type": "optional (object)", "^^^handling_duration_days": "optional (int)", "^^^release_date": "optional (int)", "^list_price": "optional (object)", "^external_list_prices": "optional ([]object)", "^^source": "required (string)", "^fees": "optional ([]object)", "^^additional_attribute": "optional (string)", "^sku_dimensions": "optional (object)", "^^length": "required (string)", "^^width": "required (string)", "^^height": "required (string)", "^^unit": "required (string)", "^sku_weight": "optional (object)", "^^value": "required (string)", "title": "required (string)", "is_cod_allowed": "optional (bool)", "certifications": "optional ([]object)", "^id": "required (string)", "^images": "optional ([]object)", "^^uri": "required (string)", "^files": "optional ([]object)", "^^format": "required (string)", "^expiration_date": "optional (int)", "package_dimensions": "optional (object)", "^length": "required (string)", "^width": "required (string)", "^height": "required (string)", "^unit": "required (string)", "product_attributes": "optional ([]object)", "^values": "required ([]object)", "package_weight": "optional (object)", "^value": "required (string)", "video": "optional (object)", "external_product_id": "optional (string)", "delivery_option_ids": "optional ([]string)", "size_chart": "optional (object)", "^image": "optional (object)", "^template": "optional (object)", "primary_combined_product_id": "optional (string)", "is_not_for_sale": "optional (bool)", "category_version": "optional (string)", "manufacturer_ids": "optional ([]string)", "responsible_person_ids": "optional ([]string)", "listing_platforms": "optional ([]string)", "shipping_insurance_requirement": "optional (string)", "minimum_order_quantity": "optional (int)", "is_pre_owned": "optional (bool)", "idempotency_key": "optional (string)", "shipping_template_id": "optional (string)", "scheduled_sale": "optional (object)", "^is_enabled_scheduled_sale": "required (bool)", "^schedule_sale_time": "required (int)", "locale": "optional (string)", "auto_translate_enabled": "optional (bool)", "search_terms": "optional ([]string)", "key_product_features": "optional ([]string)" }, "response_fields": [ "product_id", "skus", "warnings" ] }, { "method": "DELETE", "path": "/product/202309/products", "description": "Delete Products", "body_params": { "product_ids": "required ([]string)" }, "response_fields": [ "errors" ] }, { "method": "POST", "path": "/product/202309/products/recover", "description": "Recover Products", "body_params": { "product_ids": "required ([]string)" }, "response_fields": [ "errors" ] }, { "method": "POST", "path": "/product/202312/global_products/search", "description": "Search Global Products", "query_params": { "page_size": "required (int)", "page_token": "optional (string)" }, "body_params": { "status": "optional (string)", "seller_skus": "optional ([]string)", "create_time_ge": "optional (int)", "create_time_le": "optional (int)", "update_time_ge": "optional (int)", "update_time_le": "optional (int)" }, "response_fields": [ "next_page_token", "total_count", "global_products" ] }, { "method": "GET", "path": "/product/202507/global_listing_rules", "description": "Get Global Listing Rules", "response_fields": [ "listing_methods", "inventory_rules" ] }, { "method": "POST", "path": "/product/202507/products/{product_id}/global_replicate", "description": "Replicate Product", "body_params": { "replicate_target": "optional ([]object)", "^region": "optional (string)", "^skus": "optional ([]object)", "^^source_sku_id": "optional (string)", "^^price": "optional (object)", "^^^currency": "optional (string)", "^^^sale_price": "required (string)", "^^inventory": "optional ([]object)", "^^^warehouse_id": "optional (string)", "^^^quantity": "optional (int)", "^inventory_mode": "optional (string)", "inventory_mode": "optional (string)" }, "response_fields": [ "errors" ] }, { "method": "GET", "path": "/product/202507/products/{product_id}/replicated_products", "description": "Get Global Replicated Products", "response_fields": [ "replicated_products" ] }, { "method": "PUT", "path": "/product/202509/global_products/{global_product_id}/partial_edit", "description": "Partial Edit Global Product", "body_params": { "title": "optional (string)", "description": "optional (string)", "category_id": "optional (string)", "brand_id": "optional (string)", "main_images": "optional ([]object)", "^uri": "required (string)", "skus": "optional ([]object)", "^id": "required (string)", "^global_quantity": "optional (int)", "^seller_sku": "optional (string)", "^price": "optional (object)", "^^amount": "required (string)", "^^currency": "required (string)", "^sales_attributes": "optional ([]object)", "^^id": "required (string)", "^^name": "optional (string)", "^^value_id": "optional (string)", "^^value_name": "optional (string)", "^^sku_img": "optional (object)", "^^^uri": "required (string)", "^inventory": "optional ([]object)", "^^global_warehouse_id": "required (string)", "^^quantity": "required (int)", "^identifier_code": "optional (object)", "^^code": "optional (string)", "^^type": "optional (string)", "^sku_unit_count": "optional (string)", "^extra_identifier_codes": "optional ([]string)", "^external_global_sku_id": "optional (string)", "^sale_prices": "optional ([]object)", "^^region": "required (string)", "package_weight": "optional (object)", "^value": "required (string)", "^unit": "required (string)", "certifications": "optional ([]object)", "^images": "optional ([]object)", "^^uri": "required (string)", "^files": "optional ([]object)", "^^format": "required (string)", "package_dimensions": "optional (object)", "^length": "required (string)", "^width": "required (string)", "^height": "required (string)", "product_attributes": "optional ([]object)", "^values": "required ([]object)", "size_chart": "optional (object)", "^image": "optional (object)", "^template": "optional (object)", "video": "optional (object)", "manufacturer": "optional (object)", "^name": "optional (string)", "^address": "optional (string)", "^phone_number": "optional (string)", "^email": "optional (string)", "manufacturer_ids": "optional ([]string)", "responsible_person_ids": "optional ([]string)", "category_version": "optional (string)", "external_global_product_id": "optional (string)" }, "response_fields": [ "global_skus", "publish_results" ] }, { "method": "PUT", "path": "/product/202509/products/{product_id}", "description": "Edit Product", "body_params": { "save_mode": "optional (string)", "description": "required (string)", "category_id": "required (string)", "brand_id": "optional (string)", "main_images": "required ([]object)", "^uri": "required (string)", "skus": "required ([]object)", "^id": "required (string)", "^sales_attributes": "optional ([]object)", "^^id": "optional (string)", "^^name": "optional (string)", "^^value_id": "optional (string)", "^^value_name": "optional (string)", "^^sku_img": "optional (object)", "^^^uri": "required (string)", "^^supplementary_sku_images": "optional ([]object)", "^seller_sku": "optional (string)", "^price": "optional (object)", "^^amount": "optional (string)", "^^currency": "required (string)", "^^sale_price": "optional (string)", "^external_sku_id": "optional (string)", "^identifier_code": "optional (object)", "^^code": "optional (string)", "^^type": "optional (string)", "^inventory": "optional ([]object)", "^^warehouse_id": "required (string)", "^^quantity": "optional (int)", "^^backorder_quantity": "optional (int)", "^^handling_time": "optional (int)", "^combined_skus": "optional ([]object)", "^^product_id": "required (string)", "^^sku_id": "required (string)", "^^sku_count": "required (int)", "^sku_unit_count": "optional (string)", "^external_urls": "optional ([]string)", "^extra_identifier_codes": "optional ([]string)", "^pre_sale": "optional (object)", "^^fulfillment_type": "optional (object)", "^^^handling_duration_days": "optional (int)", "^^^release_date": "optional (int)", "^list_price": "optional (object)", "^external_list_prices": "optional ([]object)", "^^source": "required (string)", "^fees": "optional ([]object)", "^^additional_attribute": "optional (string)", "^sku_dimensions": "optional (object)", "^^length": "required (string)", "^^width": "required (string)", "^^height": "required (string)", "^^unit": "required (string)", "^sku_weight": "optional (object)", "^^value": "required (string)", "title": "required (string)", "is_cod_allowed": "optional (bool)", "certifications": "optional ([]object)", "^images": "optional ([]object)", "^^uri": "required (string)", "^files": "optional ([]object)", "^^format": "required (string)", "^expiration_date": "optional (int)", "package_weight": "optional (object)", "^value": "required (string)", "^unit": "required (string)", "product_attributes": "optional ([]object)", "^values": "required ([]object)", "size_chart": "optional (object)", "^image": "optional (object)", "^template": "optional (object)", "package_dimensions": "optional (object)", "^length": "required (string)", "^width": "required (string)", "^height": "required (string)", "external_product_id": "optional (string)", "delivery_option_ids": "optional ([]string)", "video": "optional (object)", "category_version": "optional (string)", "manufacturer_ids": "optional ([]string)", "responsible_person_ids": "optional ([]string)", "listing_platforms": "optional ([]string)", "shipping_insurance_requirement": "optional (string)", "is_pre_owned": "optional (bool)", "minimum_order_quantity": "optional (int)", "replicated_products": "optional ([]object)", "^region": "required (string)", "^skus": "optional ([]object)", "^^seller_sku": "optional (string)", "^^price": "required (object)", "^^^currency": "required (string)", "^^^sale_price": "required (string)", "^^inventory": "optional ([]object)", "^^^warehouse_id": "optional (string)", "^^^quantity": "optional (int)", "^inventory_mode": "optional (string)", "subscribe_info_edit": "optional (object)", "^subscribe_status": "optional (string)", "^discount_details": "optional ([]object)", "^^discount_level": "optional (string)", "^^discount_value": "optional (int)", "shipping_template_id": "optional (string)", "scheduled_sale": "optional (object)", "^is_enabled_scheduled_sale": "required (bool)", "^schedule_sale_time": "required (int)", "locale": "optional (string)", "auto_translate_enabled": "optional (bool)", "search_terms": "optional ([]string)", "key_product_features": "optional ([]string)", "inventory_mode": "optional (string)" }, "response_fields": [ "product_id", "skus", "warnings", "audit" ] }, { "method": "POST", "path": "/product/202509/products/{product_id}/partial_edit", "description": "Partial Edit Product", "body_params": { "save_mode": "optional (string)", "description": "optional (string)", "brand_id": "optional (string)", "main_images": "optional ([]object)", "^uri": "required (string)", "skus": "optional ([]object)", "^id": "required (string)", "^sales_attributes": "optional ([]object)", "^^id": "optional (string)", "^^name": "optional (string)", "^^value_id": "optional (string)", "^^value_name": "optional (string)", "^^sku_img": "optional (object)", "^^^uri": "required (string)", "^^supplementary_sku_images": "optional ([]object)", "^seller_sku": "optional (string)", "^price": "optional (object)", "^^amount": "optional (string)", "^^currency": "required (string)", "^^sale_price": "optional (string)", "^identifier_code": "optional (object)", "^^code": "optional (string)", "^^type": "optional (string)", "^inventory": "optional ([]object)", "^^warehouse_id": "required (string)", "^^quantity": "required (int)", "^^backorder_quantity": "optional (int)", "^^handling_time": "optional (int)", "^external_sku_id": "optional (string)", "^sku_unit_count": "optional (string)", "^extra_identifier_codes": "optional ([]string)", "^list_price": "optional (object)", "^external_list_prices": "optional ([]object)", "^^source": "required (string)", "^pre_sale": "optional (object)", "^^fulfillment_type": "optional (object)", "^^^handling_duration_days": "optional (int)", "^^^release_date": "optional (int)", "^external_urls": "optional ([]string)", "^fees": "optional ([]object)", "^^additional_attribute": "optional (string)", "^sku_dimensions": "optional (object)", "^^length": "required (string)", "^^width": "required (string)", "^^height": "required (string)", "^^unit": "required (string)", "^sku_weight": "optional (object)", "^^value": "required (string)", "title": "optional (string)", "is_cod_allowed": "optional (bool)", "certifications": "optional ([]object)", "^images": "optional ([]object)", "^^uri": "required (string)", "^files": "optional ([]object)", "^^format": "required (string)", "^expiration_date": "optional (int)", "package_weight": "optional (object)", "^value": "required (string)", "^unit": "required (string)", "product_attributes": "optional ([]object)", "^values": "required ([]object)", "size_chart": "optional (object)", "^image": "optional (object)", "^template": "optional (object)", "package_dimensions": "optional (object)", "^length": "required (string)", "^width": "required (string)", "^height": "required (string)", "video": "optional (object)", "external_product_id": "optional (string)", "manufacturer_ids": "optional ([]string)", "responsible_person_ids": "optional ([]string)", "listing_platforms": "optional ([]string)", "replicated_products": "optional ([]object)", "^region": "required (string)", "^skus": "optional ([]object)", "^^seller_sku": "optional (string)", "^^price": "required (object)", "^^^currency": "required (string)", "^^^sale_price": "required (string)", "^^inventory": "optional ([]object)", "^^^warehouse_id": "optional (string)", "^^^quantity": "optional (int)", "^^external_sku_id": "optional (string)", "^inventory_mode": "optional (string)", "subscribe_info_edit": "optional (object)", "^subscribe_status": "optional (string)", "^discount_details": "optional ([]object)", "^^discount_level": "optional (string)", "^^discount_value": "optional (int)", "scheduled_sale": "optional (object)", "^is_enabled_scheduled_sale": "required (bool)", "^schedule_sale_time": "required (int)", "locale": "optional (string)", "auto_translate_enabled": "optional (bool)", "search_terms": "optional ([]string)", "key_product_features": "optional ([]string)", "inventory_mode": "optional (string)" }, "response_fields": [ "product_id", "skus", "audit" ] } ], "order": [ { "method": "POST", "path": "/order/202309/orders/search", "description": "Search orders by status, time range, buyer, and SKU. page_token pagination.", "query_params": { "page_size": "number (required)", "page_token": "string", "sort_field": "string", "sort_order": "string" }, "body_params": { "order_status": "string", "commerce_platform": "string (ID market: TIKTOK_SHOP|TOKOPEDIA storefront)", "create_time_ge": "number", "create_time_lt": "number", "shipping_type": "string" }, "response_fields": [ "orders", "next_page_token", "total_count" ] }, { "method": "GET", "path": "/order/202507/orders", "description": "Get Order Detail — full detail for up to 50 orders by ids (line items, recipient address, payment, packages, commerce_platform).", "query_params": { "ids": "string (required, comma-separated order ids)" }, "response_fields": [ "orders" ] }, { "method": "GET", "path": "/order/202407/orders/{order_id}/price_detail", "description": "Get Price Detail — detailed price / discount / fee breakdown for an order.", "response_fields": [ "currency", "line_items", "payment" ] } ], "fulfillment": [ { "method": "GET", "path": "/fulfillment/202309/packages/{package_id}", "description": "Get the detail of a package: orders, tracking number, shipping provider, dimensions, weight, status.", "response_fields": [ "package_id", "orders", "tracking_number", "shipping_provider_name", "dimension", "weight", "status" ] }, { "method": "POST", "path": "/fulfillment/202309/packages/{package_id}/ship", "description": "Ship a package: confirm handover to the carrier and assign/return the tracking number.", "body_params": { "handover_method": "string", "pickup_slot": "object { start_time, end_time }", "self_shipment": "object { tracking_number, shipping_provider_id } for SELLER shipping" }, "response_fields": [] }, { "method": "GET", "path": "/fulfillment/202309/packages/{package_id}/shipping_documents", "description": "Get Package Shipping Document — the shipping document (label / packing slip / AWB) URL for a package.", "query_params": { "document_type": "string (required: SHIPPING_LABEL|PACKING_SLIP|SHIPPING_LABEL_AND_PACKING_SLIP)", "document_size": "string", "document_format": "string (PDF|...)" }, "response_fields": [ "doc_url" ] }, { "method": "POST", "path": "/fulfillment/202309/orders/{order_id}/shipping_services/query", "description": "Get Eligible Shipping Service — the shipping services / delivery options available for an order before shipping.", "body_params": { "order_line_item_ids": "array", "weight": "object", "dimension": "object" }, "response_fields": [ "shipping_services" ] }, { "method": "POST", "path": "/fulfillment/202309/orders/{order_id}/packages", "description": "Mark Package As Shipped", "body_params": { "order_line_item_ids": "optional ([]string)", "tracking_number": "required (string)", "shipping_provider_id": "required (string)", "order_line_list": "optional ([]object)", "^order_line_id": "optional (string)", "^sub_item_id": "optional (string)" }, "response_fields": [ "order_id", "order_line_item_ids", "package_id", "warning" ] }, { "method": "POST", "path": "/fulfillment/202309/packages/{package_id}/uncombine", "description": "Uncombine Packages", "body_params": { "order_ids": "optional ([]string)" }, "response_fields": [ "packages" ] }, { "method": "POST", "path": "/fulfillment/202309/packages/combine", "description": "Combine Package", "body_params": { "combinable_packages": "required ([]object)", "^id": "required (string)", "^order_ids": "optional ([]string)" }, "response_fields": [ "packages", "errors" ] }, { "method": "POST", "path": "/fulfillment/202309/packages/search", "description": "Search Package", "query_params": { "page_size": "required (int)", "sort_field": "optional (string)", "sort_order": "optional (string)", "page_token": "optional (string)" }, "body_params": { "create_time_ge": "optional (int)", "create_time_lt": "optional (int)", "update_time_ge": "optional (int)", "update_time_lt": "optional (int)", "package_status": "optional (string)" }, "response_fields": [ "next_page_token", "total_count", "packages" ] }, { "method": "POST", "path": "/fulfillment/202309/packages/ship", "description": "Batch Ship Packages", "body_params": { "packages": "required ([]object)", "^id": "required (string)", "^handover_method": "optional (string)", "^pickup_slot": "optional (object)", "^^start_time": "optional (int)", "^^end_time": "optional (int)", "^self_shipment": "optional (object)", "^^tracking_number": "required (string)", "^^shipping_provider_id": "required (string)" }, "response_fields": [ "errors" ] }, { "method": "POST", "path": "/fulfillment/202512/packages", "description": "Create Packages", "body_params": { "ship_type": "required (string)", "order_id": "optional (string)", "order_line_item": "optional ([]object)", "^order_line_id": "optional (string)", "^sub_item_id": "optional (string)", "order_list_ids": "optional ([]string)", "dimension": "optional (object)", "^length": "required (string)", "^width": "required (string)", "^height": "required (string)", "^unit": "required (string)", "shipping_service_id": "optional (string)", "weight": "optional (object)", "^value": "required (string)" }, "response_fields": [ "dimension", "shipping_service_info", "package_id", "weight", "create_time" ] } ], "logistics": [ { "method": "GET", "path": "/logistics/202309/warehouses", "description": "Get the seller's warehouses (sales and return) with addresses and effect status.", "response_fields": [ "warehouses" ] }, { "method": "GET", "path": "/logistics/202309/warehouses/{warehouse_id}/delivery_options", "description": "Get the delivery options enabled for a warehouse.", "response_fields": [ "delivery_options" ] }, { "method": "GET", "path": "/logistics/202309/delivery_options/{delivery_option_id}/shipping_providers", "description": "Get the shipping providers (carriers) available for a delivery option.", "response_fields": [ "shipping_providers" ] }, { "method": "GET", "path": "/logistics/202309/global_warehouses", "description": "Get Global Seller Warehouse", "response_fields": [ "global_warehouses" ] } ], "finance": [ { "method": "GET", "path": "/finance/202309/statements", "description": "Get the seller's settlement statements with settlement amount, revenue, fees, and payment status.", "query_params": { "page_size": "number (required)", "page_token": "string", "payment_status": "string", "statement_time_ge": "number", "statement_time_lt": "number", "sort_field": "string" }, "response_fields": [ "statements", "next_page_token", "total_count" ] }, { "method": "GET", "path": "/finance/202501/statements/{statement_id}/statement_transactions", "description": "Get the per-order transactions that make up a settlement statement.", "query_params": { "page_size": "number (required)", "page_token": "string", "sort_field": "string" }, "response_fields": [ "statement_transactions", "next_page_token", "total_count" ] }, { "method": "GET", "path": "/finance/202309/payments", "description": "Get the seller's payouts/payments to the bank account, with status and amounts.", "query_params": { "page_size": "number (required)", "page_token": "string", "create_time_ge": "number", "create_time_lt": "number" }, "response_fields": [ "payments", "next_page_token", "total_count" ] }, { "method": "GET", "path": "/finance/202501/orders/{order_id}/statement_transactions", "description": "Get Transactions by Order", "response_fields": [ "order_id", "order_create_time", "currency", "revenue_amount", "fee_and_tax_amount", "shipping_cost_amount", "settlement_amount", "sku_transactions", "total_count" ] } ], "return_refund": [ { "method": "POST", "path": "/return_refund/202602/returns/search", "description": "Search return/refund requests by status, type, and time range.", "query_params": { "page_size": "number (required)", "page_token": "string", "sort_field": "string", "sort_order": "string" }, "body_params": { "return_ids": "array of string", "order_ids": "array of string", "return_types": "array of string", "return_status": "string", "create_time_ge": "number", "create_time_lt": "number" }, "response_fields": [ "return_orders", "next_page_token", "total_count" ] }, { "method": "GET", "path": "/return_refund/202309/returns/{return_id}/records", "description": "Get the negotiation/status history records for a return request.", "response_fields": [ "records" ] }, { "method": "POST", "path": "/return_refund/202602/cancellations/search", "description": "Search order cancellation requests by status, role, and time range.", "query_params": { "page_size": "number (required)", "page_token": "string" }, "body_params": { "cancel_ids": "array of string", "order_ids": "array of string", "cancel_types": "array of string", "cancel_status": "string", "create_time_ge": "number", "create_time_lt": "number" }, "response_fields": [ "cancellations", "next_page_token", "total_count" ] }, { "method": "POST", "path": "/return_refund/202309/returns/{return_id}/approve", "description": "Approve a buyer's return/refund request.", "body_params": { "decision": "string (required)", "buyer_keep_item": "boolean", "partial_refund": "object { currency, amount }" }, "response_fields": [] }, { "method": "POST", "path": "/return_refund/202309/returns/{return_id}/reject", "description": "Reject a buyer's return/refund request with a reason.", "body_params": { "decision": "string (required)", "reject_reason": "string (required)", "comment": "string", "images": "array of { image_id }" }, "response_fields": [] }, { "method": "POST", "path": "/return_refund/202309/cancellations/{cancel_id}/approve", "description": "Approve Cancellation", "query_params": { "idempotency_key": "optional (string)" } }, { "method": "POST", "path": "/return_refund/202309/cancellations/{cancel_id}/reject", "description": "Reject Cancellation", "query_params": { "idempotency_key": "optional (string)" }, "body_params": { "reject_reason": "required (string)", "comment": "optional (string)", "images": "optional ([]object)", "^image_id": "required (string)", "^mime_type": "optional (string)", "^height": "optional (int)", "^width": "optional (int)" } }, { "method": "POST", "path": "/return_refund/202602/cancellations", "description": "Cancel Order", "body_params": { "order_id": "required (string)", "skus": "optional ([]object)", "^sku_id": "required (string)", "^quantity": "required (int)", "order_line_item_ids": "optional ([]string)", "cancel_reason": "required (string)", "order_line_list": "optional ([]object)", "^order_line_item_id": "optional (string)", "^sub_order_line_item_id": "optional (string)" }, "response_fields": [ "cancel_id", "cancel_status" ] }, { "method": "POST", "path": "/return_refund/202602/refunds/calculate", "description": "Calculate Refund", "body_params": { "order_id": "required (string)", "request_type": "required (string)", "shipment_type": "optional (string)", "handover_method": "optional (string)", "reason_name": "required (string)", "order_line_item_ids": "optional ([]string)", "skus": "optional ([]object)", "^sku_id": "required (string)", "^quantity": "required (int)", "order_line_list": "optional ([]object)", "^order_line_item_id": "optional (string)", "^sub_order_line_item_id": "optional (string)" }, "response_fields": [ "order_refund_amount" ] }, { "method": "POST", "path": "/return_refund/202602/returns", "description": "Create Return", "query_params": { "idempotency_key": "optional (string)" }, "body_params": { "order_id": "required (string)", "skus": "optional ([]object)", "^sku_id": "required (string)", "^quantity": "required (int)", "order_line_item_ids": "optional ([]string)", "return_reason": "required (string)", "return_type": "required (string)", "refund_total": "optional (string)", "currency": "optional (string)", "shipment_type": "optional (string)", "handover_method": "optional (string)", "order_line_list": "optional ([]object)", "^order_line_item_id": "optional (string)", "^sub_order_line_item_id": "optional (string)" }, "response_fields": [ "return_id", "return_status" ] } ], "promotion": [ { "method": "POST", "path": "/promotion/202309/activities/search", "description": "Search the shop's promotion activities (flash sale, direct discount) by status and type.", "query_params": { "page_size": "number (required)", "page_token": "string" }, "body_params": { "status": "string", "activity_title": "string", "activity_type": "string", "page_size": "number", "page_token": "string" }, "response_fields": [ "activities", "next_page_token", "total_count" ] }, { "method": "GET", "path": "/promotion/202309/activities/{activity_id}", "description": "Get the detail of a promotion activity including its products and SKU-level promo prices.", "response_fields": [ "activity" ] }, { "method": "POST", "path": "/promotion/202309/activities", "description": "Create Activity", "body_params": { "title": "required (string)", "activity_type": "required (string)", "product_level": "required (string)", "duration_type": "optional (string)", "begin_time": "required (int)", "end_time": "required (int)", "participation_limit": "optional ([]object)", "^type": "required (string)", "discount": "optional (object)", "^shipping_discount": "optional (object)", "^^threshold_type": "required (string)", "^^threshold_value": "required (string)", "^^type": "required (string)", "^^value": "optional (string)", "^^shipping_method": "optional (string)", "^^inventory_type": "optional (string)", "^^area_scope": "required (object)", "^^^type": "required (string)", "^^^specific_areas": "optional ([]string)", "^bmsm_discount": "optional (object)", "^^details": "optional ([]object)", "^^^tier": "required (int)", "^^^threshold_type": "required (string)", "^^^threshold_value": "required (string)", "^^^value": "required (string)", "^gift_discount": "optional (object)", "^^gift_receiving_type": "required (string)", "^^gift_infos": "required ([]object)", "^^^gift_details": "required ([]object)", "^^^^product_id": "required (string)", "^^^^sku_id": "required (string)", "^^^^total_claim_limit": "required (string)", "^bxgy_discount": "optional (object)", "^^discount_type": "required (string)", "^^discount_value": "required (string)", "^^benefit_max_applicable_quantity": "required (string)", "^^benefit_max_applicable_times": "optional (string)", "target_user_info": "optional (object)", "^user_type": "optional (string)" }, "response_fields": [ "activity_id", "create_time", "update_time", "status" ] }, { "method": "PUT", "path": "/promotion/202309/activities/{activity_id}", "description": "Update Activity", "body_params": { "title": "required (string)", "duration_type": "optional (string)", "begin_time": "required (int)", "end_time": "required (int)", "product_level": "optional (string)", "participation_limit": "optional ([]object)", "^type": "required (string)", "discount": "optional (object)", "^shipping_discount": "optional (object)", "^^threshold_type": "required (string)", "^^threshold_value": "required (string)", "^^type": "required (string)", "^^value": "optional (string)", "^^shipping_method": "optional (string)", "^^inventory_type": "optional (string)", "^^area_scope": "required (object)", "^^^type": "required (string)", "^^^specific_areas": "optional ([]string)", "^bmsm_discount": "optional (object)", "^^details": "optional ([]object)", "^^^tier": "required (int)", "^^^threshold_type": "required (string)", "^^^threshold_value": "required (string)", "^^^value": "required (string)", "^gift_discount": "optional (object)", "^^gift_receiving_type": "required (string)", "^^gift_infos": "required ([]object)", "^^^gift_details": "required ([]object)", "^^^^product_id": "required (string)", "^^^^sku_id": "required (string)", "^^^^total_claim_limit": "required (string)", "^bxgy_discount": "optional (object)", "^^discount_type": "required (string)", "^^discount_value": "required (string)", "^^benefit_max_applicable_quantity": "required (string)", "^^benefit_max_applicable_times": "optional (string)", "target_user_info": "optional (object)", "^user_type": "optional (string)" }, "response_fields": [ "activity_id", "title", "update_time" ] }, { "method": "PUT", "path": "/promotion/202309/activities/{activity_id}/products", "description": "Update Activity Product", "body_params": { "products": "optional ([]object)", "^id": "required (string)", "^activity_price_amount": "optional (string)", "^discount": "optional (string)", "^quantity_limit": "required (int)", "^quantity_per_user": "required (int)", "^skus": "optional ([]object)", "^^id": "required (string)", "^^activity_price_amount": "optional (string)", "^^discount": "optional (string)", "^^quantity_limit": "required (int)", "^^quantity_per_user": "required (int)", "activity_id": "required (string)", "benefit_product_ids": "optional ([]string)", "exclude_product_ids": "optional ([]string)" }, "response_fields": [ "activity_id", "title", "update_time", "status", "total_count" ] }, { "method": "GET", "path": "/promotion/202406/coupons/{coupon_id}", "description": "Get Coupon", "response_fields": [ "coupon" ] }, { "method": "POST", "path": "/promotion/202406/coupons/search", "description": "Search Coupons", "query_params": { "page_token": "optional (string)", "page_size": "optional (int)" }, "body_params": { "status": "optional ([]string)", "title_keyword": "optional (string)", "display_type": "optional ([]string)" }, "response_fields": [ "total_count", "next_page_token", "coupons" ] } ], "customer_service": [ { "method": "GET", "path": "/customer_service/202309/conversations", "description": "Get the list of buyer-seller conversations with unread counts and latest message.", "query_params": { "page_size": "number (required)", "page_token": "string", "locale": "string" }, "response_fields": [ "conversations", "next_page_token" ] }, { "method": "GET", "path": "/customer_service/202309/conversations/{conversation_id}/messages", "description": "Get the messages in a conversation (text, image, product card, order card).", "query_params": { "page_size": "number (required)", "page_token": "string", "sort_order": "string" }, "response_fields": [ "messages", "next_page_token" ] }, { "method": "POST", "path": "/customer_service/202309/conversations", "description": "Create Conversation", "body_params": { "buyer_user_id": "required (string)" }, "response_fields": [ "conversation_id" ] }, { "method": "POST", "path": "/customer_service/202309/conversations/{conversation_id}/messages", "description": "Send Message", "body_params": { "type": "required (string)", "content": "required (string)" }, "response_fields": [ "message_id" ] } ], "analytics": [ { "method": "GET", "path": "/analytics/202509/shop/performance", "description": "Get shop-level performance analytics (GMV, orders, units sold, visitors, CTR) over a date range.", "query_params": { "start_date_ge": "string (YYYY-MM-DD)", "end_date_lt": "string (YYYY-MM-DD)", "granularity": "string (1D|ALL)" }, "response_fields": [ "performance" ] }, { "method": "GET", "path": "/analytics/202509/shop_products/{product_id}/performance", "description": "Get Shop Product Performance Detail", "query_params": { "start_date_ge": "required (string)", "end_date_lt": "required (string)", "granularity": "optional (string)", "currency": "optional (string)" }, "response_fields": [ "performance", "latest_available_date" ] }, { "method": "GET", "path": "/analytics/202509/shop_skus/{sku_id}/performance", "description": "Get Shop SKU Performance", "query_params": { "start_date_ge": "required (string)", "end_date_lt": "required (string)", "granularity": "optional (string)", "currency": "optional (string)" }, "response_fields": [ "latest_available_date", "performance" ] }, { "method": "GET", "path": "/analytics/202511/creators/bestselling", "description": "Get Bestselling Creators", "query_params": { "date": "required (string)", "time_slot": "required (string)", "author_type": "required (string)", "currency": "optional (string)" }, "response_fields": [ "creators" ] } ], "event": [ { "method": "GET", "path": "/event/202309/webhooks", "description": "Get the app's webhook subscriptions (event types and callback addresses) for the shop.", "query_params": { "page_size": "number", "page_token": "string" }, "response_fields": [ "webhooks", "total_count" ] }, { "method": "DELETE", "path": "/event/202309/webhooks", "description": "Delete Shop Webhook", "body_params": { "event_type": "required (string)" } }, { "method": "PUT", "path": "/event/202309/webhooks", "description": "Update Shop Webhook", "body_params": { "address": "required (string)", "event_type": "required (string)" } } ], "utils": [ { "method": "GET", "path": "/api/v2/utils/generate_sign", "description": "Generate the HMAC-SHA256 sign for a request. Pass the API path as `path`, the JSON body as `body`, and any other query params you will send (app_key, timestamp, shop_cipher, …). Use the returned sign with strict_sign=1.", "query_params": { "path": "string (API path to sign, e.g. /product/202309/products/search)", "body": "string (raw JSON request body, if any)", "timestamp": "number", "shop_cipher": "string" }, "response_fields": [ "sign", "app_key", "signed_path", "signed_params" ] } ], "affiliate_creator": [ { "method": "POST", "path": "/affiliate_creator/202405/open_collaborations/products/search", "description": "Creator Search Open Collaboration Product", "query_params": { "page_token": "optional (string)", "page_size": "required (int)", "sort_field": "optional (string)", "sort_order": "optional (string)" }, "body_params": { "title_keywords": "optional ([]string)", "sales_price_range": "optional (object)", "^amount_ge": "optional (string)", "^amount_lt": "optional (string)", "category": "optional (object)", "^id": "optional (string)", "commission_rate_range": "optional (object)", "^rate_ge": "optional (int)", "^rate_lt": "optional (int)" }, "response_fields": [ "products", "next_page_token", "total_count" ] }, { "method": "GET", "path": "/affiliate_creator/202405/showcases/products", "description": "Get Showcase Products", "query_params": { "page_size": "required (int)", "page_token": "optional (string)", "origin": "required (string)" }, "response_fields": [ "products", "next_page_token", "total_count" ] }, { "method": "POST", "path": "/affiliate_creator/202405/showcases/products/add", "description": "Add Showcase Products", "body_params": { "add_type": "required (string)", "product_ids": "optional ([]string)", "product_link": "optional (string)" }, "response_fields": [ "errors" ] }, { "method": "POST", "path": "/affiliate_creator/202405/target_collaborations/search", "description": "Search Creator Target Collaborations", "query_params": { "page_token": "optional (string)", "page_size": "required (int)" }, "body_params": { "shop_id": "required (string)", "keyword_type": "optional (string)", "keyword": "optional (string)" }, "response_fields": [ "total_count", "next_page_token", "target_collaborations" ] }, { "method": "POST", "path": "/affiliate_creator/202409/sample_applications/fulfillments/search", "description": "Creator Search Sample Application Fulfillments", "query_params": { "sort_order": "optional (string)", "sort_field": "optional (string)" }, "body_params": { "fulfillment_statuses": "required ([]string)" }, "response_fields": [ "fulfillments" ] }, { "method": "DELETE", "path": "/affiliate_creator/202409/showcases/products", "description": "Remove Showcase Products", "body_params": { "product_ids": "required ([]string)" }, "response_fields": [ "code", "message", "request_id" ] }, { "method": "POST", "path": "/affiliate_creator/202409/showcases/products/top", "description": "Top Showcase Products", "body_params": { "product_ids": "required ([]string)" }, "response_fields": [ "code", "message", "request_id" ] }, { "method": "POST", "path": "/affiliate_creator/202410/orders/search", "description": "Search Creator Affiliate Orders", "query_params": { "page_token": "optional (string)", "page_size": "required (int)" }, "body_params": { "create_time_ge": "optional (int)", "create_time_lt": "optional (int)" }, "response_fields": [ "orders", "next_page_token", "total_count" ] }, { "method": "POST", "path": "/affiliate_creator/202412/sample_applications/search", "description": "Search Creator Sample Applications", "query_params": { "page_token": "optional (string)", "page_size": "optional (int)" }, "body_params": { "application_statuses": "optional ([]string)" }, "response_fields": [ "next_page_token", "sample_applications" ] }, { "method": "POST", "path": "/affiliate_creator/202412/sample_applications/single_query", "description": "Get Creator Sample Application Detail", "body_params": { "product_id": "required (string)", "application_id": "optional (string)", "application_type": "required (string)", "main_order_id": "optional (string)" }, "response_fields": [ "sample_application" ] }, { "method": "GET", "path": "/affiliate_creator/202412/samples/labels", "description": "Get Creator Applicable Sample Label", "query_params": { "product_id": "required (string)" }, "response_fields": [ "label" ] }, { "method": "POST", "path": "/affiliate_creator/202504/affiliate_sharing_links/publisher/{publisher_id}/generate_batch", "description": "Creator Generate Publisher Link", "body_params": { "material": "required (object)", "^ids": "required ([]string)", "^type": "required (string)", "^promotion_campaign_schema": "optional (string)", "campaign_id": "optional (string)", "link_type": "optional (string)" }, "response_fields": [ "sharing_links", "failed_materials" ] }, { "method": "POST", "path": "/affiliate_creator/202505/affiliate_sharing_links/general_publishers/generate_batch", "description": "Creator Generate General Link", "body_params": { "material": "required (object)", "^ids": "required ([]string)", "^type": "required (string)", "campaign_id": "optional (string)", "link_type": "optional (string)" }, "response_fields": [ "sharing_links", "failed_materials" ] }, { "method": "POST", "path": "/affiliate_creator/202505/orders/trace/search", "description": "Creator Search Affiliate Trace Orders", "query_params": { "page_token": "optional (string)", "page_size": "required (int)" }, "body_params": { "time_ge": "required (int)", "time_lt": "required (int)", "time_type": "optional (string)" }, "response_fields": [ "orders", "next_page_token", "total_count" ] }, { "method": "GET", "path": "/affiliate_creator/202508/profiles", "description": "Get Creator Profile", "response_fields": [ "avatar", "username", "selection_region", "register_region", "seller_type", "permissions", "user_type", "creator_user_open_id" ] }, { "method": "POST", "path": "/affiliate_creator/202509/open_collaborations/products", "description": "Get Open Collaboration Product List By Product Ids", "query_params": { "product_ids": "optional ([]string)" }, "response_fields": [ "products" ] } ], "affiliate_partner": [ { "method": "POST", "path": "/affiliate_partner/202405/campaigns", "description": "Create Affiliate Partner Campaign", "query_params": { "category_asset_cipher": "required (string)" }, "body_params": { "name": "required (string)", "description": "required (string)", "campaign_start_time": "required (int)", "campaign_end_time": "required (int)", "registration_start_time": "required (int)", "registration_end_time": "required (int)", "commission_rate": "required (int)", "contact_info": "required (object)", "^whatsapp": "optional (string)", "^email": "required (string)", "^phone": "optional (string)", "^zalo": "optional (string)", "^viber": "optional (string)", "^line": "optional (string)", "target_shop_codes": "optional ([]string)", "target_seller_types": "optional ([]string)" }, "response_fields": [ "campaign_id" ] }, { "method": "GET", "path": "/affiliate_partner/202405/campaigns", "description": "Get Affiliate Partner Campaign List", "query_params": { "category_asset_cipher": "required (string)", "page_size": "required (int)", "page_token": "optional (string)", "status": "optional (string)", "type": "optional (string)", "query_type_filter": "optional (string)" }, "response_fields": [ "campaigns", "next_page_token", "total_count" ] }, { "method": "GET", "path": "/affiliate_partner/202405/campaigns/{campaign_id}", "description": "Get Affiliate Partner Campaign Detail", "query_params": { "category_asset_cipher": "required (string)" }, "response_fields": [ "id", "name", "description", "status", "region", "registration_start_time", "registration_end_time", "campaign_start_time", "campaign_end_time", "commission_rate", "contact_info", "target_shops", "target_seller_types" ] }, { "method": "POST", "path": "/affiliate_partner/202405/campaigns/{campaign_id}/partial_edit", "description": "Edit Affiliate Partner Campaign", "query_params": { "category_asset_cipher": "required (string)" }, "body_params": { "name": "optional (string)", "description": "optional (string)", "campaign_start_time": "optional (int)", "campaign_end_time": "optional (int)", "registration_start_time": "optional (int)", "registration_end_time": "optional (int)", "commission_rate": "optional (int)", "contact_info": "optional (object)", "^whatsapp": "optional (string)", "^email": "optional (string)", "^phone": "optional (string)", "^zalo": "optional (string)", "^viber": "optional (string)", "^line": "optional (string)", "target_shop_codes": "optional ([]string)", "target_seller_types": "optional ([]string)" } }, { "method": "GET", "path": "/affiliate_partner/202405/campaigns/{campaign_id}/products", "description": "Get Affiliate Partner Campaign Product List", "query_params": { "category_asset_cipher": "required (string)", "page_size": "required (int)", "page_token": "optional (string)", "review_status": "optional (string)", "product_name": "optional (string)", "product_id": "optional (string)", "shop_name": "optional (string)", "category_id": "optional (string)" }, "response_fields": [ "products", "next_page_token", "total_count" ] }, { "method": "POST", "path": "/affiliate_partner/202405/campaigns/{campaign_id}/products/{product_id}/promotion_link/generate", "description": "Generate Affiliate Partner Campaign Product Link", "query_params": { "category_asset_cipher": "required (string)" }, "body_params": { "creator_commission_rate": "required (int)" }, "response_fields": [ "product_promotion_link" ] }, { "method": "POST", "path": "/affiliate_partner/202405/campaigns/{campaign_id}/products/{product_id}/review", "description": "Review Affiliate Partner Campaign Product", "query_params": { "category_asset_cipher": "required (string)" }, "body_params": { "review_result": "required (string)", "reject_reasons": "optional ([]string)" } }, { "method": "POST", "path": "/affiliate_partner/202405/campaigns/{campaign_id}/publish", "description": "Publish Affiliate Partner Campaign", "query_params": { "category_asset_cipher": "required (string)" } }, { "method": "GET", "path": "/affiliate_partner/202501/campaigns/{campaign_id}/products/performance", "description": "Get Affiliate Campaign Creator Fulfillment Status List", "query_params": { "page_size": "optional (int)", "page_token": "optional (string)" }, "response_fields": [ "total_count", "campaign_product_statistics", "next_page_token" ] }, { "method": "POST", "path": "/affiliate_partner/202505/campaigns/{campaign_id}/products/promotion_links/generate_batch", "description": "Partner Generate Multi Affiliate Campaign Product Link", "query_params": { "category_asset_cipher": "optional (string)" }, "body_params": { "product_ids": "optional ([]string)" }, "response_fields": [ "product_promotion_links", "failed_product_ids" ] }, { "method": "GET", "path": "/affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/creator/{creator_temp_id}/content/statistics", "description": "Get Affiliate Campaign Creator Product Content Statistics", "query_params": { "affiliate_product_id": "required (string)", "content_type": "optional (string)", "category_asset_cipher": "required (string)" }, "response_fields": [ "creator_content_statistics" ] }, { "method": "GET", "path": "/affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/creator/{creator_temp_id}/content/statistics/sample/status", "description": "Get Affiliate Campaign Creator Product Sample Status", "query_params": { "category_asset_cipher": "required (string)" }, "response_fields": [ "sample_status" ] }, { "method": "GET", "path": "/affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/performance", "description": "Get Affiliate Campaign Creator Fulfillment Status Info", "query_params": { "page_size": "optional (int)", "page_token": "optional (string)", "category_asset_cipher": "required (string)" }, "response_fields": [ "total_creator_count", "promotion_creators", "next_page_token" ] }, { "method": "POST", "path": "/affiliate_partner/202603/cap_order/search", "description": "Search CAP Affiliate Orders", "query_params": { "page_token": "optional (string)", "page_size": "required (int)", "category_asset_cipher": "required (string)" }, "body_params": { "order_id": "optional (string)", "product_id": "optional (string)", "settle_status": "optional (int)", "create_time_ge": "optional (int)", "create_time_lt": "optional (int)" }, "response_fields": [ "sku_orders", "next_page_token", "total_count" ] }, { "method": "POST", "path": "/affiliate_partner/202603/orders/search", "description": "Search Tap Affiliate Orders", "query_params": { "page_token": "optional (string)", "page_size": "required (int)", "category_asset_cipher": "required (string)" }, "body_params": { "create_time_ge": "optional (int)", "create_time_lt": "optional (int)", "campaign_id": "optional (string)" }, "response_fields": [ "sku_orders", "next_page_token", "total_count" ] } ], "affiliate_seller": [ { "method": "POST", "path": "/affiliate_seller/202405/open_collaboration_settings", "description": "Edit Open Collaboration Settings", "body_params": { "auto_add_product": "optional (object)", "^enable": "required (bool)", "^commission_rate": "required (int)" } }, { "method": "POST", "path": "/affiliate_seller/202405/open_collaborations/products/search", "description": "Seller Search Affiliate Open Collaboration Product", "query_params": { "sort_order": "optional (string)", "sort_field": "optional (string)", "page_token": "optional (string)", "page_size": "required (int)" }, "body_params": { "title_keywords": "optional ([]string)", "sales_price_range": "optional (object)", "^amount_ge": "optional (string)", "^amount_lt": "optional (string)", "category": "optional (object)", "^id": "optional (string)", "commission_rate_range": "optional (object)", "^rate_ge": "optional (int)", "^rate_lt": "optional (int)" }, "response_fields": [ "products", "next_page_token", "total_count" ] }, { "method": "POST", "path": "/affiliate_seller/202405/products/{product_id}/promotion_link/generate", "description": "Generate Affiliate Product Promotion Link", "response_fields": [ "product_promotion_link" ] }, { "method": "GET", "path": "/affiliate_seller/202409/open_collaboration_settings", "description": "Get Open Collaboration Settings", "response_fields": [ "open_collaboration_settings" ] }, { "method": "DELETE", "path": "/affiliate_seller/202409/open_collaborations/products/{product_id}", "description": "Remove Open Collaboration", "response_fields": [ "terminated_effective_time" ] }, { "method": "DELETE", "path": "/affiliate_seller/202409/target_collaborations/{target_collaboration_id}", "description": "Remove Target Collaboration" }, { "method": "POST", "path": "/affiliate_seller/202410/open_collaborations/sample_rules", "description": "Edit Open Collaboration Sample Rule", "body_params": { "product_id": "required (string)", "sample_rule": "optional (object)", "^sample_quota": "optional (int)", "^is_sample_time_unlimited": "optional (bool)", "^start_time": "optional (int)", "^end_time": "optional (int)", "^thresholds": "optional (object)", "^^minimum_follower_count": "optional (int)", "^^minimum_gmv": "optional (int)", "^^avg_ec_video_views": "optional (int)", "^^category_ids": "optional ([]string)", "^^predicted_fulfillment_rank": "optional (string)", "^activate_status": "required (string)" } }, { "method": "GET", "path": "/affiliate_seller/202410/open_collaborations/sample_rules", "description": "Get Open Collaboration Sample Rules", "query_params": { "product_ids": "required ([]string)" }, "response_fields": [ "sample_rules" ] }, { "method": "POST", "path": "/affiliate_seller/202410/orders/search", "description": "Search Seller Affiliate Orders", "query_params": { "page_token": "optional (string)", "page_size": "required (int)" }, "body_params": { "create_time_lt": "optional (int)", "create_time_ge": "optional (int)", "program_id": "optional (string)" }, "response_fields": [ "orders", "next_page_token", "total_count" ] }, { "method": "POST", "path": "/affiliate_seller/202412/open_collaborations", "description": "Create Open Collaboration", "body_params": { "product_id": "required (string)", "commission_rate": "required (int)" }, "response_fields": [ "open_collaboration" ] }, { "method": "POST", "path": "/affiliate_seller/202412/open_collaborations/search", "description": "Search Open Collaboration", "query_params": { "page_token": "optional (string)", "page_size": "required (int)", "sort_order": "optional (string)", "sort_field": "optional (string)" }, "body_params": { "keyword_type": "optional (string)", "keyword": "optional (string)", "top_level_category_id": "optional (string)" }, "response_fields": [ "next_page_token", "total_count", "open_collaborations" ] }, { "method": "POST", "path": "/affiliate_seller/202508/conversations", "description": "Create Conversation with creator", "body_params": { "creator_open_id": "required (string)", "only_need_conversation_id": "optional (bool)" }, "response_fields": [ "conversation_id", "is_new", "username", "avatar", "unread_count", "creator_im_id" ] }, { "method": "GET", "path": "/affiliate_seller/202508/marketplace_creators/{creator_user_id}", "description": "Get Marketplace Creator Performance", "response_fields": [ "creator" ] }, { "method": "POST", "path": "/affiliate_seller/202508/marketplace_creators/search", "description": "Seller Search Creator on Marketplace", "query_params": { "page_token": "optional (string)", "page_size": "required (int)" }, "body_params": { "search_key": "optional (string)", "keyword": "optional (string)", "follower_demographics": "optional (object)", "^age_ranges": "optional ([]string)", "^count_range": "optional (object)", "^^count_ge": "optional (int)", "^^count_le": "optional (int)", "^gender_distribution": "optional (object)", "^^gender": "optional (string)", "^^percentage_ge": "optional (int)", "gmv_ranges": "optional ([]string)", "units_sold_ranges": "optional ([]string)", "category": "optional ([]object)", "^parent_category_id": "optional (string)", "^child_category_id_list": "optional ([]string)", "content_performance": "optional (object)", "^avg_video_views": "optional (string)", "^avg_shoppable_video_views": "optional (string)", "^avg_engagement_rate": "optional (string)", "^avg_shopable_engagement_rate": "optional (string)", "^avg_live_avg_viewers_ge": "optional (string)", "^avg_shoppable_live_avg_viewers_ge": "optional (string)", "affiliate_data": "optional (object)", "^avg_commission_rate": "optional (string)", "^post_rate": "optional (string)", "^creator_agency_staus": "optional (string)", "^is_fast_growing": "optional (bool)", "^not_invited_l90_days": "optional (bool)", "advanced_filters": "optional (object)", "^language": "optional ([]string)", "^creator_level": "optional ([]string)", "^category_pro": "optional ([]string)" }, "response_fields": [ "next_page_token", "search_key", "creators" ] }, { "method": "POST", "path": "/affiliate_seller/202508/open_collaborations/{open_collaboration_id}/remove_creator", "description": "Remove Creator From Open Collaboration", "body_params": { "creator_user_open_id": "required (string)", "product_id": "required (string)" } }, { "method": "GET", "path": "/affiliate_seller/202508/open_collaborations/creator_content_details", "description": "Get Open Collaboration Creator Content Detail", "query_params": { "page_token": "optional (string)", "page_size": "required (int)", "product_id": "required (string)" }, "response_fields": [ "next_page_token", "total_count", "creator_content_details", "product" ] }, { "method": "POST", "path": "/affiliate_seller/202508/target_collaborations", "description": "Create Target Collaboration", "body_params": { "name": "required (string)", "message": "optional (string)", "end_time": "required (string)", "products": "required ([]object)", "^id": "required (string)", "^target_commission_rate": "required (int)", "^shop_ads_commission_rate": "optional (int)", "creator_user_open_ids": "required ([]string)", "seller_contact_info": "required (object)", "^email": "required (string)", "^phone_number": "optional (string)", "^whatsapp": "optional (string)", "^telegram": "optional (string)", "^line": "optional (string)", "free_sample_rule": "required (object)", "^has_free_sample": "required (bool)", "^is_sample_approval_exempt": "required (bool)" }, "response_fields": [ "target_collaboration", "target_collaboration_conflicts", "invalid_open_id_list", "invalid_product_id_list" ] }, { "method": "GET", "path": "/affiliate_seller/202508/target_collaborations/{target_collaboration_id}", "description": "Query Target Collaboration Detail", "response_fields": [ "target_collaboration" ] }, { "method": "PUT", "path": "/affiliate_seller/202508/target_collaborations/{target_collaboration_id}", "description": "Update Target Collaboration", "body_params": { "name": "required (string)", "end_time": "required (string)", "products": "required ([]object)", "^id": "required (string)", "^commission_rate": "required (int)", "^target_ad_commission_rate": "optional (int)", "creator_user_open_ids": "required ([]string)", "seller_contact_info": "required (object)", "^email": "required (string)", "^phone_number": "optional (string)", "^whatsapp": "optional (string)", "^telegram": "optional (string)", "^line": "optional (string)", "free_sample_rule": "required (object)", "^has_free_sample": "required (bool)", "^is_sample_approval_exempt": "required (bool)" }, "response_fields": [ "target_collaboration_conflicts", "update_failed" ] }, { "method": "POST", "path": "/affiliate_seller/202508/target_collaborations/search", "description": "Search Target Collaborations", "query_params": { "page_size": "optional (int)", "page_token": "optional (string)" }, "body_params": { "creator_accept_status": "optional (string)", "free_sample_setting": "optional (string)", "search_param": "optional (object)", "^keyword_type": "required (string)", "^keyword": "required (string)", "creator_user_open_id": "optional (string)", "collaboration_status": "required (string)" }, "response_fields": [ "total_count", "next_page_token", "target_collaborations" ] }, { "method": "POST", "path": "/affiliate_seller/202509/target_collaboration/{target_collaboration_id}/link", "description": "Generate Target Collaboration Link", "response_fields": [ "link" ] }, { "method": "POST", "path": "/affiliate_seller/202601/marketplace_creators/search/filter", "description": "Get Seller Search Creator Marketplace Advanced Filters", "response_fields": [ "advanced_filters" ] } ], "fbt": [ { "method": "POST", "path": "/fbt/202408/inventory/search", "description": "Search FBT Inventory", "query_params": { "page_size": "required (int)", "page_token": "optional (string)" }, "body_params": { "goods_ids": "optional ([]string)", "fbt_warehouse_ids": "optional ([]string)", "sku_ids": "optional ([]string)" }, "response_fields": [ "next_page_token", "total_count", "inventory" ] }, { "method": "GET", "path": "/fbt/202408/warehouses", "description": "Get FBT Warehouse List", "response_fields": [ "warehouses" ] }, { "method": "GET", "path": "/fbt/202409/merchants/onboarded_regions", "description": "Get FBT Merchant Onboarded Regions", "response_fields": [ "onboarded_regions" ] }, { "method": "POST", "path": "/fbt/202410/inventory_records/search", "description": "Search FBT Inventory Record", "query_params": { "page_size": "required (int)", "page_token": "optional (string)" }, "body_params": { "goods_ids": "optional ([]string)", "fbt_warehouse_ids": "optional ([]string)", "create_time_ge": "optional (int)", "create_time_le": "optional (int)" }, "response_fields": [ "inventory_records", "next_page_token", "total_count" ] }, { "method": "POST", "path": "/fbt/202601/mcf_outbound_orders", "description": "Create FBT MCF Order", "body_params": { "external_order_id": "required (string)", "goods": "required ([]object)", "^id": "required (string)", "^quantity": "required (int)", "consignee": "required (object)", "^name": "required (string)", "^phone_number": "required (string)", "^email": "required (string)", "^address": "required (object)", "^^country_code": "required (string)", "^^state_or_region": "required (string)", "^^district_or_county": "required (string)", "^^city": "required (string)", "^^address_line_1": "required (string)", "^^address_line_2": "optional (string)", "^^postal_code": "optional (string)" }, "response_fields": [ "mcf_order" ] }, { "method": "GET", "path": "/fbt/202601/mcf_outbound_orders", "description": "Get FBF MCF Order Status", "query_params": { "mcf_order_id": "required (string)" }, "response_fields": [ "mcf_order" ] }, { "method": "POST", "path": "/fbt/202601/mcf_outbound_orders/cancel", "description": "Cancel FBT MCF Order", "body_params": { "mcf_order_id": "required (string)", "consign_orders": "optional ([]object)", "^id": "optional (string)" }, "response_fields": [ "mcf_order" ] }, { "method": "POST", "path": "/fbt/202601/mcf/goods/inventory/search", "description": "Query Goods Inventory For MCF", "body_params": { "goods": "required ([]object)", "^goods_id": "required (string)" }, "response_fields": [ "goods_inventory_list" ] }, { "method": "GET", "path": "/fbt/202601/merchants/mcf_status", "description": "Get FBT Merchant MCF Status", "response_fields": [ "mcf_status" ] }, { "method": "POST", "path": "/fbt/202602/create_update_inbound_plan", "description": "Create Update Inbound Plan", "body_params": { "plan_id": "optional (string)", "idempotent_key": "optional (string)", "goods_items": "optional ([]object)", "^goods_id": "required (string)", "^quantity": "required (int)", "cartons": "optional ([]object)", "^carton_type": "required (string)", "^items": "required ([]object)", "^^goods_id": "required (string)", "^^quantity": "required (int)", "^^lot_code": "optional (string)", "^^expiration_timestamp": "optional (string)", "^carton_nums": "optional ([]string)", "^box_measurements": "required (object)", "^^weight": "required (string)", "^^weight_unit": "required (string)", "^^width": "required (string)", "^^height": "required (string)", "^^length": "required (string)", "^^length_unit": "required (string)" }, "response_fields": [ "inbound_plan" ] }, { "method": "POST", "path": "/fbt/202602/inbound_method_detail", "description": "Get Inbound Method Detail", "body_params": { "plan_id": "required (string)", "inbound_method": "required (string)", "estimate_arrival_time": "required (object)", "^start_timestamp": "required (string)", "^end_timestamp": "required (string)" }, "response_fields": [ "info", "placement_task_status", "expiration_timestamp" ] }, { "method": "GET", "path": "/fbt/202602/inbound_orders", "description": "Get Inbound Order", "query_params": { "order_ids": "required ([]string)", "include_carton_details": "optional (bool)" }, "response_fields": [ "inbound_orders" ] }, { "method": "POST", "path": "/fbt/202602/inbound_orders/cancel", "description": "Cancel Inbound Order", "body_params": { "order_id": "required (string)", "cancel_reason": "required (string)" } }, { "method": "POST", "path": "/fbt/202602/list_available_inbound_method", "description": "List Available Inbound Method", "body_params": { "plan_id": "required (string)" }, "response_fields": [ "available_inbound_method_list" ] }, { "method": "POST", "path": "/fbt/202603/confirm_inbound_method", "description": "Confirm Inbound Method", "body_params": { "plan_id": "required (string)", "placement_option_id": "required (string)", "inbound_method": "required (string)", "estimate_arrival_time": "required (object)", "^start_timestamp": "required (string)", "^end_timestamp": "required (string)" }, "response_fields": [ "inbound_order_ids" ] }, { "method": "POST", "path": "/fbt/202603/ship_inbound_order", "description": "Ship Inbound Order", "body_params": { "inbound_order_id": "required (string)", "cartons": "optional ([]object)", "^carton_type": "required (string)", "^items": "required ([]object)", "^^goods_id": "required (string)", "^^quantity": "required (int)", "^^lot_code": "optional (string)", "^^expiration_timestamp": "optional (string)", "^quantity": "required (int)", "^carton_nums": "optional ([]string)", "^box_measurements": "required (object)", "^^weight": "required (string)", "^^weight_unit": "required (string)", "^^width": "required (string)", "^^height": "required (string)", "^^length": "required (string)", "^^length_unit": "required (string)", "shipment_option": "required (object)", "^shipping_method": "required (string)", "^freight_type": "optional (string)" }, "response_fields": [ "inbound_order_id" ] } ] } }