openapi: 3.2.0 info: title: TikTok API for Business — Marketing Catalog API description: TikTok API for Business (Marketing API) v1.3. This document is a mechanical union of the 202 per-operation OpenAPI 3.0.1 documents TikTok publishes in yml_files/ of its own SDK repository (https://github.com/tiktok/tiktok-business-api-sdk), which are the swagger-codegen inputs for TikTok's first-party Java/Python/JavaScript SDKs. Operation content (paths, parameters, responses, tags and the x-open-* extensions) is preserved verbatim; only info, servers and components.securitySchemes were written by API Evangelist, because the per-operation fragments carry placeholder info blocks and no servers block. The servers values are the production and sandbox base URLs TikTok documents at https://business-api.tiktok.com/portal/docs?id=1738855331457026 . version: v1.3 contact: name: TikTok API for Business support url: https://business-api.tiktok.com/portal/docs?id=1795190020378625 termsOfService: https://business-api.tiktok.com/portal/docs?id=1737191804348417 x-source: https://github.com/tiktok/tiktok-business-api-sdk/tree/main/yml_files x-harvested-by: API Evangelist enrichment pipeline x-harvested: '2026-08-13' servers: - url: https://business-api.tiktok.com/open_api/v1.3 description: Production - url: https://sandbox-ads.tiktok.com/open_api/v1.3 description: Sandbox security: - AccessToken: [] tags: - name: Catalog paths: /catalog/available_country/get/: get: operationId: Catalog Available_country Get parameters: - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the countries and regions that ads for a catalog can be delivered to. [Catalog Available Country Get](https://business-api.tiktok.com/portal/docs?id=1740491257516034) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id response_cookie: [] response_header: [] response_rule: region_codes: $.rpc.output.countrys x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/capitalize/: post: operationId: Catalog Capitalize parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.adv_id bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 x-open-source: $.http.body.catalog_id required: - bc_id - advertiser_id - catalog_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Migrate catalogs under your ad account to your Business Center. [Catalog Capitalize](https://business-api.tiktok.com/portal/docs?id=1740490222539778) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: user_id required: true source: $.context.core_user_id type: number - name: adv_id required: true source: $.http.body.advertiser_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: source required: true source: '2' type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adv_id: $.http.body.advertiser_id bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id source: 2 user_id: $.context.core_user_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/create/: post: operationId: Catalog Create parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.bc_id catalog_conf: description: '' properties: business_platform: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 channel: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: CLIENT value: CLIENT - description: '' is_valid: true key: BUSINESS_PLATFORM value: BUSINESS_PLATFORM - description: '' is_valid: true key: PARTNER value: PARTNER key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 3 x-open-source: $.http.body.catalog_conf.channel currency: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802164933598209 enum_package_name: CatalogCurrency enums: - description: '' is_valid: true key: AED value: '784' - description: '' is_valid: true key: ALL value: '8' - description: '' is_valid: true key: AOA value: '973' - description: '' is_valid: true key: ARS value: '32' - description: '' is_valid: true key: AUD value: '36' - description: '' is_valid: true key: BAM value: '977' - description: '' is_valid: true key: BDT value: '50' - description: '' is_valid: true key: BGN value: '975' - description: '' is_valid: true key: BHD value: '48' - description: '' is_valid: true key: BND value: '96' - description: '' is_valid: true key: BOB value: '68' - description: '' is_valid: true key: BRL value: '986' - description: '' is_valid: true key: BWP value: '72' - description: '' is_valid: true key: BYN value: '933' - description: '' is_valid: true key: CAD value: '124' - description: '' is_valid: true key: CHF value: '756' - description: '' is_valid: true key: CLP value: '152' - description: '' is_valid: true key: CNY value: '156' - description: '' is_valid: true key: COP value: '170' - description: '' is_valid: true key: CRC value: '188' - description: '' is_valid: true key: CZK value: '203' - description: '' is_valid: true key: DKK value: '208' - description: '' is_valid: true key: DZD value: '12' - description: '' is_valid: true key: EGP value: '818' - description: '' is_valid: true key: EUR value: '978' - description: '' is_valid: true key: GBP value: '826' - description: '' is_valid: true key: GHS value: '936' - description: '' is_valid: true key: GTQ value: '320' - description: '' is_valid: true key: GYD value: '328' - description: '' is_valid: true key: HKD value: '344' - description: '' is_valid: true key: HNL value: '340' - description: '' is_valid: true key: HRK value: '191' - description: '' is_valid: true key: HUF value: '348' - description: '' is_valid: true key: IDR value: '360' - description: '' is_valid: true key: ILS value: '376' - description: '' is_valid: true key: INR value: '356' - description: '' is_valid: true key: IQD value: '368' - description: '' is_valid: true key: IRR value: '364' - description: '' is_valid: true key: ISK value: '352' - description: '' is_valid: true key: JOD value: '400' - description: '' is_valid: true key: JPY value: '392' - description: '' is_valid: true key: KES value: '404' - description: '' is_valid: true key: KHR value: '116' - description: '' is_valid: true key: KRW value: '410' - description: '' is_valid: true key: KWD value: '414' - description: '' is_valid: true key: KZT value: '398' - description: '' is_valid: true key: LAK value: '418' - description: '' is_valid: true key: LBP value: '422' - description: '' is_valid: true key: LKR value: '144' - description: '' is_valid: true key: LYD value: '434' - description: '' is_valid: true key: MAD value: '504' - description: '' is_valid: true key: MDL value: '498' - description: '' is_valid: true key: MKD value: '807' - description: '' is_valid: true key: MMK value: '104' - description: '' is_valid: true key: MNT value: '496' - description: '' is_valid: true key: MOP value: '446' - description: '' is_valid: true key: MUR value: '480' - description: '' is_valid: true key: MVR value: '462' - description: '' is_valid: true key: MWK value: '454' - description: '' is_valid: true key: MXN value: '484' - description: '' is_valid: true key: MYR value: '458' - description: '' is_valid: true key: NGN value: '566' - description: '' is_valid: true key: NIO value: '558' - description: '' is_valid: true key: NOK value: '578' - description: '' is_valid: true key: NPR value: '524' - description: '' is_valid: true key: NZD value: '554' - description: '' is_valid: true key: OMNI value: '-1' - description: '' is_valid: true key: OMR value: '512' - description: '' is_valid: true key: PEN value: '604' - description: '' is_valid: true key: PHP value: '608' - description: '' is_valid: true key: PKR value: '586' - description: '' is_valid: true key: PLN value: '985' - description: '' is_valid: true key: PYG value: '600' - description: '' is_valid: true key: QAR value: '634' - description: '' is_valid: true key: RON value: '946' - description: '' is_valid: true key: RSD value: '941' - description: '' is_valid: true key: RUB value: '643' - description: '' is_valid: true key: SAR value: '682' - description: '' is_valid: true key: SDG value: '938' - description: '' is_valid: true key: SEK value: '752' - description: '' is_valid: true key: SGD value: '702' - description: '' is_valid: true key: SLL value: '694' - description: '' is_valid: true key: SRD value: '968' - description: '' is_valid: true key: SSP value: '728' - description: '' is_valid: true key: SYP value: '760' - description: '' is_valid: true key: THB value: '764' - description: '' is_valid: true key: TND value: '788' - description: '' is_valid: true key: TRY value: '949' - description: '' is_valid: true key: TWD value: '901' - description: '' is_valid: true key: TZS value: '834' - description: '' is_valid: true key: UAH value: '980' - description: '' is_valid: true key: UGX value: '800' - description: '' is_valid: true key: USD value: '840' - description: '' is_valid: true key: UYU value: '858' - description: '' is_valid: true key: UZS value: '860' - description: '' is_valid: true key: VEF value: '937' - description: '' is_valid: true key: VND value: '704' - description: '' is_valid: true key: XAF value: '950' - description: '' is_valid: true key: YER value: '886' - description: '' is_valid: true key: ZAR value: '710' - description: '' is_valid: true key: ZMW value: '967' key_format: string strict: true use_part: false validate_only: true value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.catalog_conf.currency region_code: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.catalog_conf.region_code required: - region_code - currency type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.catalog_conf catalog_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802164714465281 enum_package_name: CatalogType enums: - description: '' is_valid: true key: AUTO value: '11' - description: '' is_valid: true key: DESTINATION value: '15' - description: '' is_valid: true key: ECOM value: '10' - description: '' is_valid: true key: ENTERTAINMENT value: '12' - description: '' is_valid: true key: FLIGHT value: '14' - description: '' is_valid: true key: HOTEL value: '13' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.catalog_type creative_asset_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: VIDEO value: VIDEO key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 5 name: description: '' maxLength: 128 minLength: 1 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.catalog_name required: - bc_id - catalog_type - name - catalog_conf type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a catalog by specifying information such as name, targeted locations, and currency. [Catalog Create](https://business-api.tiktok.com/portal/docs?id=1740306481704961) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_type required: true source: $.http.body.catalog_type type: number - name: catalog_name required: true source: $.http.body.name type: string - children: - name: region_code required: true source: $.http.body.catalog_conf.region_code type: string - name: currency required: true source: $.http.body.catalog_conf.currency type: string - name: channel required: false source: $.http.body.catalog_conf.channel type: string - name: business_platform required: false source: $.http.body.catalog_conf.business_platform type: string is_expand: true name: catalog_conf required: true type: object - name: creative_asset_type required: false source: $.http.query.creative_asset_type type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_conf: business_platform: $.http.body.catalog_conf.business_platform channel: $.http.body.catalog_conf.channel currency: $.http.body.catalog_conf.currency region_code: $.http.body.catalog_conf.region_code catalog_name: $.http.body.name catalog_type: $.http.body.catalog_type creative_asset_type: $.http.query.creative_asset_type response_cookie: [] response_header: [] response_rule: catalog_id: $.rpc.output.catalog_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/delete/: post: operationId: Catalog Delete parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.catalog_id required: - catalog_id - bc_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete a catalog. [Catalog Delete](https://business-api.tiktok.com/portal/docs?id=1740310064588801) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: request_source required: true source: '1' type: number - name: opt_type required: true source: '2' type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: user_id required: false source: $.context.core_user_id type: number - name: bc_id required: false source: $.http.body.bc_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id opt_type: 2 request_source: 1 user_id: $.context.core_user_id response_cookie: [] response_header: [] response_rule: catalog_id: $.http.body.catalog_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/eventsource/bind/: post: operationId: Catalog Eventsource Bind parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.advertiser_id app_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.mobile_app_id bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 x-open-source: $.http.body.catalog_id pixel_code: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.pixel_code required: - bc_id - advertiser_id - catalog_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Bind app or website event sources to a catalog in a Business Center. [Catalog Eventsource Bind](https://business-api.tiktok.com/portal/docs?id=1740492491200513) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: opt_type required: true source: '1' type: number - name: core_user_id required: true source: $.context.core_user_id type: number - name: pixel_code required: false source: $.http.body.pixel_code type: string - name: mobile_app_id required: false source: $.http.body.app_id type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id core_user_id: $.context.core_user_id mobile_app_id: $.http.body.app_id opt_type: 1 pixel_code: $.http.body.pixel_code response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/eventsource/unbind/: post: operationId: Catalog Eventsource Unbind parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.advertiser_id app_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.mobile_app_id bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 x-open-source: $.http.body.catalog_id pixel_code: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.pixel_code required: - bc_id - advertiser_id - catalog_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Unbind event sources from a catalog. [Catalog Eventsource Unbind](https://business-api.tiktok.com/portal/docs?id=1740492512449538) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: opt_type required: true source: '2' type: number - name: core_user_id required: true source: $.context.core_user_id type: number - name: pixel_code required: false source: $.http.body.pixel_code type: string - name: mobile_app_id required: false source: $.http.body.app_id type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id core_user_id: $.context.core_user_id mobile_app_id: $.http.body.app_id opt_type: 2 pixel_code: $.http.body.pixel_code response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/eventsource_bind/get/: get: operationId: Catalog Eventsource_bind Get parameters: - description: '' in: query name: catalog_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalogue_id x-open-field-id: 1 - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get event source binding information. [Catalog Eventsource Bind Get](https://business-api.tiktok.com/portal/docs?id=1740492531343362) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: catalogue_id required: false source: $.http.query.catalog_id type: number - name: user_id required: false source: $.context.core_user_id type: number - name: bc_id required: false source: $.http.query.bc_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalogue_id: $.http.query.catalog_id user_id: $.context.core_user_id response_cookie: [] response_header: [] response_rule: catalog_id: $.http.query.catalog_id event_sources[][]: - app_id: $.rpc.output.event_sources[].meteor_app_id event_source_name: $.rpc.output.event_sources[].app_name pixel_code: $.rpc.output.event_sources[].pixel_code x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/feed/create/: post: operationId: Catalog Feed Create parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.catalog_id feed_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.feed_name schedule_param: description: '' properties: day_of_month: description: '' format: int32 maximum: 31 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.schedule_param.day_of_month hour: description: '' format: int32 maximum: 23 minimum: 0 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.schedule_param.hour interval_count: description: '' format: int32 maximum: 30 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.schedule_param.interval_count interval_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1822447827658753 enum_package_name: CatalogFeedIntervalType enums: - description: '' is_valid: true key: DAILY value: '2' - description: '' is_valid: true key: HOURLY value: '1' - description: '' is_valid: true key: MONTHLY value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 2 x-open-source: $.http.body.schedule_param.interval_type minute: description: '' format: int32 maximum: 59 minimum: 0 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.schedule_param.minute source: description: '' properties: password: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.schedule_param.source.password uri: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.schedule_param.source.uri username: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.schedule_param.source.username type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.schedule_param.source timezone: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.schedule_param.timezone type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.schedule_param update_mode: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1822447728485378 enum_package_name: CatalogFeedUpdateMode enums: - description: '' is_valid: true key: INCREMENTAL value: '1' - description: '' is_valid: true key: OVERWRITE value: '2' - description: '' is_valid: false key: SUPPLEMENT value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int64 x-open-field-id: 4 x-open-source: $.http.body.update_mode required: - bc_id - catalog_id - feed_name - update_mode type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a feed. [Catalog Feed Create](https://business-api.tiktok.com/portal/docs?id=1740665161957377) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: feed_name required: false source: $.http.body.feed_name type: string - name: update_mode required: true source: $.http.body.update_mode type: number - children: - children: - name: uri required: false source: $.http.body.schedule_param.source.uri type: string - name: username required: false source: $.http.body.schedule_param.source.username type: string - name: password required: false source: $.http.body.schedule_param.source.password type: string name: source required: false source: $.http.body.schedule_param.source type: object - name: interval_type required: false source: $.http.body.schedule_param.interval_type type: number - name: interval_count required: false source: $.http.body.schedule_param.interval_count type: number - name: timezone required: false source: $.http.body.schedule_param.timezone type: string - name: day_of_month required: false source: $.http.body.schedule_param.day_of_month type: number - name: hour required: false source: $.http.body.schedule_param.hour type: number - name: minute required: false source: $.http.body.schedule_param.minute type: number name: schedule_param required: false source: $.http.body.schedule_param type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id feed_name: $.http.body.feed_name schedule_param: $.http.body.schedule_param update_mode: $.http.body.update_mode response_cookie: [] response_header: [] response_rule: feed_id: $.rpc.output.feed_data.feed_id feed_name: $.rpc.output.feed_data.feed_name last_update_param: $.rpc.output.feed_data.last_update_param next_update_time: $.rpc.output.feed_data.next_update_time number_of_products: $.rpc.output.feed_data.number_of_products status: $.rpc.output.feed_data.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/feed/delete/: post: operationId: Catalog Feed Delete parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiserId catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 x-open-source: $.http.body.multiLocLangType feed_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.feedIds required: - bc_id - feed_id - catalog_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete a feed. [Catalog Feed Delete](https://business-api.tiktok.com/portal/docs?id=1740665210863617) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - name: id required: false source: $.http.body.feed_id type: number - name: platformId required: false source: $.http.body.catalog_id type: number is_expand: true name: feed required: false type: object - name: optType required: false source: '3' type: number - children: - type: number is_expand: true name: feedIds required: false source: $.feed_ids sub_type: number type: array plugins: after_response: [] before_request: - Plugin_mk_list_5934464: - description: make list - request_params: - $.http.body.feed_id - result_params: - $.feed_ids - version: c9e39304e3af5001d163ef81733004ce request_query_rule: null request_rule: feed: id: $.http.body.feed_id platformId: $.http.body.catalog_id feedIds: $.feed_ids optType: 3 response_cookie: [] response_header: [] response_rule: feed_id: $.http.body.feed_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/feed/get/: get: operationId: Catalog Feed Get parameters: - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: catalog_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 2 - description: '' in: query name: feed_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.feed_id x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get all feeds or a particular feed. [Catalog Feed Get](https://business-api.tiktok.com/portal/docs?id=1740665183073281) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: catalog_id required: true source: $.http.query.catalog_id type: number - name: feed_id required: false source: $.http.query.feed_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id feed_id: $.http.query.feed_id response_cookie: [] response_header: [] response_rule: feed_list: $.rpc.output.feed_list x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/feed/log/: get: operationId: Catalog Feed Log parameters: - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: catalog_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 2 - description: '' in: query name: feed_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.feed_id x-open-field-id: 3 - description: '' in: query name: context_info required: false schema: $ref: ./openapi.yaml#/definitions/Context_infoCatalogFeedLog x-open-field-id: 4 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the last 10 operations of a feed. [Catalog Feed Log](https://business-api.tiktok.com/portal/docs?id=1740665225631810) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: catalog_id required: true source: $.http.query.catalog_id type: number - name: feed_id required: true source: $.http.query.feed_id type: number - children: - name: app_id required: false source: $.http.query.context_info.app_id type: number - name: core_user_id required: false source: $.http.query.context_info.core_user_id type: number - name: developer_id required: false source: $.http.query.context_info.developer_id type: number - name: x_forwarded_for required: false source: $.http.query.context_info.x_forwarded_for type: string - name: x_real_ip required: false source: $.http.query.context_info.x_real_ip type: string is_expand: false name: context_info required: false source: $.http.query.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id context_info: $.http.query.context_info feed_id: $.http.query.feed_id response_cookie: [] response_header: [] response_rule: feed_logs: $.rpc.output.feed_logs x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/feed/update/: post: operationId: Catalog Feed Update parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.catalog_id feed_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 x-open-source: $.http.body.feed_id feed_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.feed_name schedule_param: description: '' properties: day_of_month: description: '' format: int32 maximum: 31 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.schedule_param.day_of_month hour: description: '' format: int32 maximum: 23 minimum: 0 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.schedule_param.hour interval_count: description: '' format: int32 maximum: 30 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.schedule_param.interval_count interval_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1822447827658753 enum_package_name: CatalogFeedIntervalType enums: - description: '' is_valid: true key: DAILY value: '2' - description: '' is_valid: true key: HOURLY value: '1' - description: '' is_valid: true key: MONTHLY value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 2 x-open-source: $.http.body.schedule_param.interval_type minute: description: '' format: int32 maximum: 59 minimum: 0 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.schedule_param.minute source: description: '' properties: password: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.schedule_param.source.password uri: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.schedule_param.source.uri username: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.schedule_param.source.username type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.schedule_param.source timezone: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.schedule_param.timezone type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.schedule_param update_mode: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1822447728485378 enum_package_name: CatalogFeedUpdateMode enums: - description: '' is_valid: true key: INCREMENTAL value: '1' - description: '' is_valid: true key: OVERWRITE value: '2' - description: '' is_valid: false key: SUPPLEMENT value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int64 x-open-field-id: 5 x-open-source: $.http.body.update_mode required: - bc_id - catalog_id - feed_id - feed_name - update_mode type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update a feed. [Catalog Feed Update](https://business-api.tiktok.com/portal/docs?id=1740665197662210) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: feed_id required: false source: $.http.body.feed_id type: number - name: update_mode required: true source: $.http.body.update_mode type: number - children: - children: - name: uri required: false source: $.http.body.schedule_param.source.uri type: string - name: username required: false source: $.http.body.schedule_param.source.username type: string - name: password required: false source: $.http.body.schedule_param.source.password type: string is_expand: true name: source required: false source: $.http.body.schedule_param.source type: object - name: interval_type required: false source: $.http.body.schedule_param.interval_type type: number - name: interval_count required: false source: $.http.body.schedule_param.interval_count type: number - name: timezone required: false source: $.http.body.schedule_param.timezone type: string - name: day_of_month required: false source: $.http.body.schedule_param.day_of_month type: number - name: hour required: false source: $.http.body.schedule_param.hour type: number - name: minute required: false source: $.http.body.schedule_param.minute type: number is_expand: false name: schedule_param required: false source: $.http.body.schedule_param type: object - name: feed_name required: false source: $.http.body.feed_name type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id feed_id: $.http.body.feed_id feed_name: $.http.body.feed_name schedule_param: $.http.body.schedule_param update_mode: $.http.body.update_mode response_cookie: [] response_header: [] response_rule: feed_id: $.rpc.output.feed_data.feed_id feed_name: $.rpc.output.feed_data.feed_name last_update_param: $.rpc.output.feed_data.last_update_param next_update_time: $.rpc.output.feed_data.next_update_time number_of_products: $.rpc.output.feed_data.number_of_products status: $.rpc.output.feed_data.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/get/: get: operationId: Catalog Get parameters: - description: '' in: query name: catalog_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 1 - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 4 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get all catalogs or a particular catalog. [Catalog Get](https://business-api.tiktok.com/portal/docs?id=1740315452868610) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: catalog_id required: false source: $.http.query.catalog_id type: number - name: bc_id required: true source: $.http.query.bc_id type: number - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number plugins: after_response: - Plugin_catalog_get_7931521: - description: filter resp by catalog_id - request_params: - $.http.query.catalog_id - $.rpc.output.catalog_infos[] - result_params: - $.resp_catalog_infos - version: e7b0b08a293ff345d513b1ce2005b5e7 before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - bc_info[]: - bc_id: $.rpc.output.catalog_info[].bc_info.id bc_name: $.rpc.output.catalog_info[].bc_info.name picture_url: $.rpc.output.catalog_info[].bc_info.picture_url catalog_conf: $.rpc.output.catalog_info[].catalog_conf catalog_id: $.rpc.output.catalog_info[].catalog_id catalog_name: $.rpc.output.catalog_info[].catalog_name catalog_type: $.rpc.output.catalog_info[].catalog_type create_time: $.rpc.output.catalog_info[].create_time creative_asset_type: $.rpc.output.catalog_info[].creative_asset_type update_time: $.rpc.output.catalog_info[].update_time page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /catalog/lexicon/get/: get: operationId: Catalog Lexicon Get parameters: - description: '' in: query name: catalog_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 1 - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.lexicon_id x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the lexicon for your catalog for use in ad texts. [Catalog Lexicon Get](https://business-api.tiktok.com/portal/docs?id=1740488375815169) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: dpaID required: false source: $.http.query.catalog_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: dpaID: $.http.query.catalog_id response_cookie: [] response_header: [] response_rule: list[][]: - catalog_id: $.rpc.output.lexicons[].dpaID default_value: $.rpc.output.lexicons[].defaultValue lexicon_id: $.rpc.output.lexicons[].lexiconID metadata: $.rpc.output.lexicons[].metaField name: $.rpc.output.lexicons[].name type: $.rpc.output.lexicons[].type update_time: $.rpc.output.lexicons[].modifyTime x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/location_currency/get/: get: operationId: Catalog Location_currency Get parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get supported locations and corresponding currencies for Catalog API. [Catalog Location Currency Get](https://business-api.tiktok.com/portal/docs?id=1740491571747841) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: [] plugins: after_response: - Plugin_resp_to_list_7973814: - description: map to list - request_params: - $.rpc.output.item - result_params: - $.myList - version: 2d4da8e18a9a66f726c055fc084ea5ec before_request: [] request_query_rule: null request_rule: null response_cookie: [] response_header: [] response_rule: list: $.myList x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/overview/: get: operationId: Catalog Overview parameters: - description: '' in: query name: catalog_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 1 - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the number of products in different audit statuses in a catalog. [Catalog Overview](https://business-api.tiktok.com/portal/docs?id=1740492470201345) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: catalog_id required: true source: $.http.query.catalog_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: catalog_id: $.http.query.catalog_id response_cookie: [] response_header: [] response_rule: approved: $.rpc.output.approved processing: $.rpc.output.processing rejected: $.rpc.output.rejected x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/product/delete/: post: operationId: Catalog Product Delete parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.catalog_id destination_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 feed_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 x-open-source: $.http.body.feed_id flight_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 hotel_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 media_title_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 sku_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 vehicle_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 required: - bc_id - catalog_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete products in bulk. [Catalog Product Delete](https://business-api.tiktok.com/portal/docs?id=1740562489236481) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: request_source required: true source: '1' type: number - name: opt_type required: true source: '2' type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - children: - children: - name: product_id required: true source: $.http.body.products[].product_id type: string - name: name required: true source: $.http.body.products[].name type: string - name: title required: true source: $.http.body.products[].title type: string - name: description required: true source: $.http.body.products[].description type: string - children: - name: url required: true source: $.http.body.products[].image.url type: string - name: width required: true source: $.http.body.products[].image.width type: number - name: height required: true source: $.http.body.products[].image.height type: number - name: ratio required: true source: $.http.body.products[].image.ratio type: number - name: description required: true source: $.http.body.products[].image.description type: string - name: duration required: true source: $.http.body.products[].image.duration type: number - name: video_id required: true source: $.http.body.products[].image.video_id type: string - name: template_id required: true source: $.http.body.products[].image.template_id type: string - name: item_id required: true source: $.http.body.products[].image.item_id type: string - name: is_origin_video required: true source: $.http.body.products[].image.is_origin_video type: boolean - name: tos_uri required: true source: $.http.body.products[].image.tos_uri type: string - name: video_package_type required: true source: $.http.body.products[].image.video_package_type type: number - name: image_label required: false source: $.http.body.products[].image.image_label type: string is_expand: true name: image required: false source: $.http.body.products[].image type: object - children: - children: - name: url required: true source: $.http.body.products[].images[].url type: string - name: width required: true source: $.http.body.products[].images[].width type: number - name: height required: true source: $.http.body.products[].images[].height type: number - name: ratio required: true source: $.http.body.products[].images[].ratio type: number - name: description required: true source: $.http.body.products[].images[].description type: string - name: duration required: true source: $.http.body.products[].images[].duration type: number - name: video_id required: true source: $.http.body.products[].images[].video_id type: string - name: template_id required: true source: $.http.body.products[].images[].template_id type: string - name: item_id required: true source: $.http.body.products[].images[].item_id type: string - name: is_origin_video required: true source: $.http.body.products[].images[].is_origin_video type: boolean - name: tos_uri required: true source: $.http.body.products[].images[].tos_uri type: string - name: video_package_type required: true source: $.http.body.products[].images[].video_package_type type: number - name: image_label required: false source: $.http.body.products[].images[].image_label type: string is_expand: true type: object is_expand: true name: images required: false source: $.http.body.products[].images sub_type: object type: array - children: - name: url required: true source: $.http.body.products[].video.url type: string - name: width required: true source: $.http.body.products[].video.width type: number - name: height required: true source: $.http.body.products[].video.height type: number - name: ratio required: true source: $.http.body.products[].video.ratio type: number - name: description required: true source: $.http.body.products[].video.description type: string - name: duration required: true source: $.http.body.products[].video.duration type: number - name: video_id required: true source: $.http.body.products[].video.video_id type: string - name: template_id required: true source: $.http.body.products[].video.template_id type: string - name: item_id required: true source: $.http.body.products[].video.item_id type: string - name: is_origin_video required: true source: $.http.body.products[].video.is_origin_video type: boolean - name: tos_uri required: true source: $.http.body.products[].video.tos_uri type: string - name: video_package_type required: true source: $.http.body.products[].video.video_package_type type: number - name: image_label required: false source: $.http.body.products[].video.image_label type: string is_expand: true name: video required: false source: $.http.body.products[].video type: object - children: - name: brand_id required: true source: $.http.body.products[].brand.brand_id type: string - name: brand_name required: true source: $.http.body.products[].brand.brand_name type: string - name: en_brand required: true source: $.http.body.products[].brand.en_brand type: string - children: - name: targetUrl required: false source: $.http.body.products[].brand.target_url.targetUrl type: string - name: targetUrlMobile required: false source: $.http.body.products[].brand.target_url.targetUrlMobile type: string - name: targetUrlAndroidApp required: false source: $.http.body.products[].brand.target_url.targetUrlAndroidApp type: string - name: packageAndroidApp required: false source: $.http.body.products[].brand.target_url.packageAndroidApp type: string - name: appNameAndroidApp required: false source: $.http.body.products[].brand.target_url.appNameAndroidApp type: string - name: targetUrlIosApp required: false source: $.http.body.products[].brand.target_url.targetUrlIosApp type: string - name: AppStoreIdIosApp required: false source: $.http.body.products[].brand.target_url.AppStoreIdIosApp type: string - name: AppNameIosApp required: false source: $.http.body.products[].brand.target_url.AppNameIosApp type: string - name: AppStoreIdIphoneApp required: false source: $.http.body.products[].brand.target_url.AppStoreIdIphoneApp type: string - name: AppNameIphoneApp required: false source: $.http.body.products[].brand.target_url.AppNameIphoneApp type: string - name: AppStoreIdIpadApp required: false source: $.http.body.products[].brand.target_url.AppStoreIdIpadApp type: string - name: AppNameIpadApp required: false source: $.http.body.products[].brand.target_url.AppNameIpadApp type: string - name: universalLink required: false source: $.http.body.products[].brand.target_url.universalLink type: string - name: checkoutUrl required: false source: $.http.body.products[].brand.target_url.checkoutUrl type: string is_expand: true name: target_url required: false source: $.http.body.products[].brand.target_url type: object - name: brand_logo required: true source: $.http.body.products[].brand.brand_logo type: string is_expand: true name: brand required: false source: $.http.body.products[].brand type: object - children: - name: shopKeeperID required: false source: $.http.body.products[].shop_keeper.shopKeeperID type: string - name: shopKeeperName required: false source: $.http.body.products[].shop_keeper.shopKeeperName type: string - name: logo required: false source: $.http.body.products[].shop_keeper.logo type: string - name: address required: false source: $.http.body.products[].shop_keeper.address type: string - name: contact required: false source: $.http.body.products[].shop_keeper.contact type: string - name: servicePhone required: false source: $.http.body.products[].shop_keeper.servicePhone type: string - children: - name: targetUrl required: false source: $.http.body.products[].shop_keeper.targetUrl.targetUrl type: string - name: targetUrlMobile required: false source: $.http.body.products[].shop_keeper.targetUrl.targetUrlMobile type: string - name: targetUrlAndroidApp required: false source: $.http.body.products[].shop_keeper.targetUrl.targetUrlAndroidApp type: string - name: packageAndroidApp required: false source: $.http.body.products[].shop_keeper.targetUrl.packageAndroidApp type: string - name: appNameAndroidApp required: false source: $.http.body.products[].shop_keeper.targetUrl.appNameAndroidApp type: string - name: targetUrlIosApp required: false source: $.http.body.products[].shop_keeper.targetUrl.targetUrlIosApp type: string - name: AppStoreIdIosApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppStoreIdIosApp type: string - name: AppNameIosApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppNameIosApp type: string - name: AppStoreIdIphoneApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppStoreIdIphoneApp type: string - name: AppNameIphoneApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppNameIphoneApp type: string - name: AppStoreIdIpadApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppStoreIdIpadApp type: string - name: AppNameIpadApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppNameIpadApp type: string - name: universalLink required: false source: $.http.body.products[].shop_keeper.targetUrl.universalLink type: string - name: checkoutUrl required: false source: $.http.body.products[].shop_keeper.targetUrl.checkoutUrl type: string is_expand: true name: targetUrl required: false source: $.http.body.products[].shop_keeper.targetUrl type: object is_expand: true name: shop_keeper required: false source: $.http.body.products[].shop_keeper type: object - children: - children: - name: id required: true source: $.http.body.products[].category.category.id type: string - name: name required: true source: $.http.body.products[].category.category.name type: string is_expand: true name: category required: false source: $.http.body.products[].category.category type: object - children: - name: id required: true source: $.http.body.products[].category.first_category.id type: string - name: name required: true source: $.http.body.products[].category.first_category.name type: string is_expand: true name: first_category required: false source: $.http.body.products[].category.first_category type: object - children: - name: id required: true source: $.http.body.products[].category.sub_category.id type: string - name: name required: true source: $.http.body.products[].category.sub_category.name type: string is_expand: true name: sub_category required: false source: $.http.body.products[].category.sub_category type: object - children: - name: id required: true source: $.http.body.products[].category.third_category.id type: string - name: name required: true source: $.http.body.products[].category.third_category.name type: string is_expand: true name: third_category required: false source: $.http.body.products[].category.third_category type: object - children: - name: targetUrl required: false source: $.http.body.products[].category.landing_url.targetUrl type: string - name: targetUrlMobile required: false source: $.http.body.products[].category.landing_url.targetUrlMobile type: string - name: targetUrlAndroidApp required: false source: $.http.body.products[].category.landing_url.targetUrlAndroidApp type: string - name: packageAndroidApp required: false source: $.http.body.products[].category.landing_url.packageAndroidApp type: string - name: appNameAndroidApp required: false source: $.http.body.products[].category.landing_url.appNameAndroidApp type: string - name: targetUrlIosApp required: false source: $.http.body.products[].category.landing_url.targetUrlIosApp type: string - name: AppStoreIdIosApp required: false source: $.http.body.products[].category.landing_url.AppStoreIdIosApp type: string - name: AppNameIosApp required: false source: $.http.body.products[].category.landing_url.AppNameIosApp type: string - name: AppStoreIdIphoneApp required: false source: $.http.body.products[].category.landing_url.AppStoreIdIphoneApp type: string - name: AppNameIphoneApp required: false source: $.http.body.products[].category.landing_url.AppNameIphoneApp type: string - name: AppStoreIdIpadApp required: false source: $.http.body.products[].category.landing_url.AppStoreIdIpadApp type: string - name: AppNameIpadApp required: false source: $.http.body.products[].category.landing_url.AppNameIpadApp type: string - name: universalLink required: false source: $.http.body.products[].category.landing_url.universalLink type: string - name: checkoutUrl required: false source: $.http.body.products[].category.landing_url.checkoutUrl type: string is_expand: true name: landing_url required: false source: $.http.body.products[].category.landing_url type: object is_expand: true name: category required: false source: $.http.body.products[].category type: object - children: - name: targetUrl required: false source: $.http.body.products[].landing_url.targetUrl type: string - name: targetUrlMobile required: false source: $.http.body.products[].landing_url.targetUrlMobile type: string - name: targetUrlAndroidApp required: false source: $.http.body.products[].landing_url.targetUrlAndroidApp type: string - name: packageAndroidApp required: false source: $.http.body.products[].landing_url.packageAndroidApp type: string - name: appNameAndroidApp required: false source: $.http.body.products[].landing_url.appNameAndroidApp type: string - name: targetUrlIosApp required: false source: $.http.body.products[].landing_url.targetUrlIosApp type: string - name: AppStoreIdIosApp required: false source: $.http.body.products[].landing_url.AppStoreIdIosApp type: string - name: AppNameIosApp required: false source: $.http.body.products[].landing_url.AppNameIosApp type: string - name: AppStoreIdIphoneApp required: false source: $.http.body.products[].landing_url.AppStoreIdIphoneApp type: string - name: AppNameIphoneApp required: false source: $.http.body.products[].landing_url.AppNameIphoneApp type: string - name: AppStoreIdIpadApp required: false source: $.http.body.products[].landing_url.AppStoreIdIpadApp type: string - name: AppNameIpadApp required: false source: $.http.body.products[].landing_url.AppNameIpadApp type: string - name: universalLink required: false source: $.http.body.products[].landing_url.universalLink type: string - name: checkoutUrl required: false source: $.http.body.products[].landing_url.checkoutUrl type: string is_expand: true name: landing_url required: false source: $.http.body.products[].landing_url type: object - children: - type: string is_expand: true name: tags required: false source: $.http.body.products[].tags sub_type: string type: array - name: status required: true source: $.http.body.products[].status type: number - name: audit_status required: true source: $.http.body.products[].audit_status type: number - children: - name: value required: true source: $.http.body.products[].price.value type: number - name: price_unit required: true source: $.http.body.products[].price.price_unit type: string - name: saving required: true source: $.http.body.products[].price.saving type: number - name: price required: true source: $.http.body.products[].price.price type: number - name: sales_promotion required: true source: $.http.body.products[].price.sales_promotion type: string - name: down_payment required: true source: $.http.body.products[].price.down_payment type: string - name: mortgage required: true source: $.http.body.products[].price.mortgage type: string - name: daily_mortgage required: true source: $.http.body.products[].price.daily_mortgage type: string - name: discount required: true source: $.http.body.products[].price.discount type: number - name: currency required: true source: $.http.body.products[].price.currency type: string - name: sale_price required: true source: $.http.body.products[].price.sale_price type: number - children: - type: number is_expand: true name: sale_price_effective_date required: true source: $.http.body.products[].price.sale_price_effective_date sub_type: number type: array - name: std_price required: true source: $.http.body.products[].price.std_price type: string - name: std_sale_price required: true source: $.http.body.products[].price.std_sale_price type: string - name: has_sale_price required: true source: $.http.body.products[].price.has_sale_price type: boolean - name: total_price required: true source: $.http.body.products[].price.total_price type: number - name: sale_price_effective_date_str required: false source: $.http.body.products[].price.sale_price_effective_date_str type: string is_expand: true name: price required: false source: $.http.body.products[].price type: object - children: - type: string is_expand: true name: profession required: false source: $.http.body.products[].profession sub_type: string type: dict - name: spu_id required: true source: $.http.body.products[].spu_id type: string - name: outer_id required: true source: $.http.body.products[].outer_id type: string - name: gtin required: true source: $.http.body.products[].gtin type: string - name: mpn required: true source: $.http.body.products[].mpn type: string - name: availability required: true source: $.http.body.products[].availability type: string - children: - type: string is_expand: true name: options_field_name required: false source: $.http.body.products[].options_field_name sub_type: string type: array - children: - name: custom_label_0 required: false source: $.http.body.products[].ext.custom_label_0 type: string - name: custom_label_1 required: false source: $.http.body.products[].ext.custom_label_1 type: string - name: custom_label_2 required: false source: $.http.body.products[].ext.custom_label_2 type: string - name: custom_label_3 required: false source: $.http.body.products[].ext.custom_label_3 type: string - name: custom_label_4 required: false source: $.http.body.products[].ext.custom_label_4 type: string is_expand: true name: ext required: false source: $.http.body.products[].ext type: object - name: mark required: true source: $.http.body.products[].mark type: number - children: - name: OriginRichTextDescription required: false source: $.http.body.products[].rich_text.OriginRichTextDescription type: string - name: RichTextDescription required: false source: $.http.body.products[].rich_text.RichTextDescription type: string - name: RichTextDescriptionHtml required: false source: $.http.body.products[].rich_text.RichTextDescriptionHtml type: string is_expand: true name: rich_text required: false source: $.http.body.products[].rich_text type: object - name: vehicle_launched_year required: true source: $.http.body.products[].vehicle_launched_year type: number - name: vehicle_model required: true source: $.http.body.products[].vehicle_model type: string - name: vehicle_body_style required: true source: $.http.body.products[].vehicle_body_style type: string - name: vehicle_vin required: true source: $.http.body.products[].vehicle_vin type: string - children: - name: value required: false source: $.http.body.products[].vehicle_mileage.value type: number - name: unit required: false source: $.http.body.products[].vehicle_mileage.unit type: string - name: mileage required: false source: $.http.body.products[].vehicle_mileage.mileage type: number is_expand: true name: vehicle_mileage required: false source: $.http.body.products[].vehicle_mileage type: object - name: vehicle_trim required: true source: $.http.body.products[].vehicle_trim type: string - name: vehicle_drive_train required: true source: $.http.body.products[].vehicle_drive_train type: string - name: vehicle_fuel_type required: true source: $.http.body.products[].vehicle_fuel_type type: string - children: - type: string is_expand: true name: media_genres required: false source: $.http.body.products[].media_genres sub_type: string type: array - name: room_type required: true source: $.http.body.products[].room_type type: string - name: origin_airport required: true source: $.http.body.products[].origin_airport type: string - name: destination_airport required: true source: $.http.body.products[].destination_airport type: string - name: origin_city required: true source: $.http.body.products[].origin_city type: string - name: destination_city required: true source: $.http.body.products[].destination_city type: string - name: airline_company required: true source: $.http.body.products[].airline_company type: string - name: cabin_class required: true source: $.http.body.products[].cabin_class type: string - name: airline_id required: true source: $.http.body.products[].airline_id type: string - name: feature required: true source: $.http.body.products[].feature type: string - name: stock required: true source: $.http.body.products[].stock type: number - name: time_line required: true source: $.http.body.products[].time_line type: string - children: - name: deliverVideo required: false source: $.http.body.products[].delivery.deliverVideo type: number is_expand: true name: delivery required: true source: $.http.body.products[].delivery type: object - name: has_video required: true source: $.http.body.products[].has_video type: number - children: - children: - type: number is_expand: true name: bidwords required: false source: $.http.body.products[].product_additional_info.bidwords sub_type: number type: array - children: - type: string is_expand: true name: videoTids required: false source: $.http.body.products[].product_additional_info.videoTids sub_type: string type: array - children: - type: number is_expand: true name: videoImageModes required: false source: $.http.body.products[].product_additional_info.videoImageModes sub_type: number type: array is_expand: true name: product_additional_info required: false source: $.http.body.products[].product_additional_info type: object - name: active_status required: true source: $.http.body.products[].active_status type: number - children: - name: language required: false source: $.http.body.products[].i18n_local_info.language type: string - children: - type: number is_expand: true name: tags required: false source: $.http.body.products[].i18n_local_info.tags sub_type: number type: array - children: - type: string is_expand: true name: detectLanguage required: false source: $.http.body.products[].i18n_local_info.detectLanguage sub_type: string type: array is_expand: true name: i18n_local_info required: false source: $.http.body.products[].i18n_local_info type: object - name: pxx_id required: true source: $.http.body.products[].pxx_id type: string - children: - type: string is_expand: true name: label required: false source: $.http.body.products[].label sub_type: string type: array - children: - children: - name: url required: true source: $.http.body.products[].videos[].url type: string - name: width required: true source: $.http.body.products[].videos[].width type: number - name: height required: true source: $.http.body.products[].videos[].height type: number - name: ratio required: true source: $.http.body.products[].videos[].ratio type: number - name: description required: true source: $.http.body.products[].videos[].description type: string - name: duration required: true source: $.http.body.products[].videos[].duration type: number - name: video_id required: true source: $.http.body.products[].videos[].video_id type: string - name: template_id required: true source: $.http.body.products[].videos[].template_id type: string - name: item_id required: true source: $.http.body.products[].videos[].item_id type: string - name: is_origin_video required: true source: $.http.body.products[].videos[].is_origin_video type: boolean - name: tos_uri required: true source: $.http.body.products[].videos[].tos_uri type: string - name: video_package_type required: true source: $.http.body.products[].videos[].video_package_type type: number - name: image_label required: false source: $.http.body.products[].videos[].image_label type: string is_expand: true type: object is_expand: true name: videos required: false source: $.http.body.products[].videos sub_type: object type: array - name: version required: true source: $.http.body.products[].version type: number - children: - type: number is_expand: true name: product_set_ids required: false source: $.http.body.products[].product_set_ids sub_type: number type: array - name: address required: true source: $.http.body.products[].address type: string - name: city required: true source: $.http.body.products[].city type: string - name: rating required: true source: $.http.body.products[].rating type: string - name: user_rating required: true source: $.http.body.products[].user_rating type: string - name: qid required: true source: $.http.body.products[].qid type: string - name: vehicle_exterior_color required: true source: $.http.body.products[].vehicle_exterior_color type: string - name: address_region required: true source: $.http.body.products[].address_region type: string - name: address_country required: true source: $.http.body.products[].address_country type: string - name: vehicle_state required: true source: $.http.body.products[].vehicle_state type: string - name: vehicle_make required: true source: $.http.body.products[].vehicle_make type: string - name: loyalty_program required: true source: $.http.body.products[].loyalty_program type: string - name: margin_level required: true source: $.http.body.products[].margin_level type: string - name: hotel_retailer_id required: true source: $.http.body.products[].hotel_retailer_id type: string - name: hotel_room_id required: true source: $.http.body.products[].hotel_room_id type: string - name: meal_policy required: true source: $.http.body.products[].meal_policy type: string - name: cancellation_policy required: true source: $.http.body.products[].cancellation_policy type: string - name: phone required: true source: $.http.body.products[].phone type: string - name: organic_audit_status required: true source: $.http.body.products[].organic_audit_status type: number - name: appeal_status required: false source: $.http.body.products[].appeal_status type: boolean - children: - children: - name: reason required: false source: $.http.body.products[].reject_infos[].reason type: string - name: suggestion required: false source: $.http.body.products[].reject_infos[].suggestion type: string - children: - type: string is_expand: true name: affected_country required: false source: $.http.body.products[].reject_infos[].affected_country sub_type: string type: array - children: - type: number is_expand: true name: affected_placement required: false source: $.http.body.products[].reject_infos[].affected_placement sub_type: number type: array is_expand: true type: object is_expand: true name: reject_infos required: false source: $.http.body.products[].reject_infos sub_type: object type: array - children: - name: dealerID required: false source: $.http.body.products[].dealer.dealerID type: string - name: name required: false source: $.http.body.products[].dealer.name type: string - name: phone required: false source: $.http.body.products[].dealer.phone type: string - name: stockNumber required: false source: $.http.body.products[].dealer.stockNumber type: string is_expand: true name: dealer required: false source: $.http.body.products[].dealer type: object - name: vehicle_interior_color required: false source: $.http.body.products[].vehicle_interior_color type: string - name: transmission required: false source: $.http.body.products[].transmission type: string - name: vehicleType required: false source: $.http.body.products[].vehicleType type: string - name: dateFirstOnLot required: false source: $.http.body.products[].dateFirstOnLot type: string - name: daysOnLot required: false source: $.http.body.products[].daysOnLot type: number - name: postcode required: false source: $.http.body.products[].postcode type: string - name: lat required: false source: $.http.body.products[].lat type: number - name: lon required: false source: $.http.body.products[].lon type: number - name: product_type required: false source: $.http.body.products[].product_type type: string - name: google_product_category required: false source: $.http.body.products[].google_product_category type: string - children: - children: - name: RatingSystem required: false source: $.http.body.products[].guest_ratings[].RatingSystem type: string - name: MaxScore required: false source: $.http.body.products[].guest_ratings[].MaxScore type: number - name: Score required: false source: $.http.body.products[].guest_ratings[].Score type: number - name: NumberOfReviewers required: false source: $.http.body.products[].guest_ratings[].NumberOfReviewers type: number is_expand: true type: object is_expand: true name: guest_ratings required: false source: $.http.body.products[].guest_ratings sub_type: object type: array - children: - type: string is_expand: true name: destination_types required: false source: $.http.body.products[].destination_types sub_type: string type: array is_expand: true type: object is_expand: false name: products required: true source: $.myProducts sub_type: object type: array - name: feed_id required: false source: $.http.body.feed_id type: number - children: - type: string is_expand: true name: outer_id_list required: false source: $.myOuterIds sub_type: string type: array plugins: after_response: [] before_request: - Plugin_fill_empty_products_6806181: - description: get only one outer_ids - request_params: - $.http.body.sku_ids - $.http.body.vehicle_ids - $.http.body.flight_ids - $.http.body.media_title_ids - $.http.body.hotel_ids - $.http.body.destination_ids - result_params: - $.myProducts - $.myOuterIds - version: f252d6f26daa93852c121840d707a759 request_query_rule: null request_rule: catalog_id: $.http.body.catalog_id feed_id: $.http.body.feed_id opt_type: 2 outer_id_list: $.myOuterIds products: $.myProducts request_source: 1 response_cookie: [] response_header: [] response_rule: feed_log_id: $.rpc.output.feed_log_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/product/file/: post: operationId: Catalog Product File parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.catalog_id feed_id: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 x-open-source: $.http.body.feed_id file_url: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.file_url update_mode: default: INCREMENTAL description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: INCREMENTAL value: '1' - description: '' is_valid: true key: OVERWRITE value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 5 x-open-source: $.http.body.update_mode required: - bc_id - catalog_id - file_url type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Upload products via file URL. [Catalog Product File](https://business-api.tiktok.com/portal/docs?id=1740496787164161) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: file_url required: true source: $.http.body.file_url type: string - name: feed_id required: false source: $.http.body.feed_id type: number - name: update_mode required: true source: $.http.body.update_mode type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id feed_id: $.http.body.feed_id file_url: $.http.body.file_url update_mode: $.http.body.update_mode response_cookie: [] response_header: [] response_rule: feed_log_id: $.rpc.output.feed_log_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/product/log/: get: operationId: Catalog Product Log parameters: - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: catalog_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 2 - description: '' in: query name: feed_log_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.feed_log_id x-open-field-id: 3 - description: '' in: query name: advertiser_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 4 - description: '' in: query name: language required: false schema: default: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.language x-open-field-id: 5 - description: '' in: query name: context_info required: false schema: $ref: ./openapi.yaml#/definitions/Context_infoCatalogProductLog x-open-field-id: 6 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to find out if a product was uploaded or deleted successfully, and what to do if it failed. [Catalog Product Get](https://business-api.tiktok.com/portal/docs?id=1740570027173889) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: catalog_id required: true source: $.http.query.catalog_id type: number - name: feed_log_id required: true source: $.http.query.feed_log_id type: number - name: advertiser_id required: false source: $.http.query.advertiser_id type: number - name: language required: false source: $.http.query.language type: string - children: - name: app_id required: false source: $.http.query.context_info.app_id type: number - name: core_user_id required: false source: $.http.query.context_info.core_user_id type: number - name: developer_id required: false source: $.http.query.context_info.developer_id type: number - name: x_forwarded_for required: false source: $.http.query.context_info.x_forwarded_for type: string - name: x_real_ip required: false source: $.http.query.context_info.x_real_ip type: string name: context_info required: false source: $.http.query.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id context_info: $.http.query.context_info feed_log_id: $.http.query.feed_log_id language: $.http.query.language response_cookie: [] response_header: [] response_rule: product_feed_log: add_count: $.rpc.output.product_feed_log.add_count catalog_id: $.rpc.output.product_feed_log.catalog_id delete_count: $.rpc.output.product_feed_log.delete_count end_time: $.rpc.output.product_feed_log.end_time error_count: $.rpc.output.product_feed_log.error_count feed_id: $.rpc.output.product_feed_log.feed_id feed_log_data: download_path: $.rpc.output.product_feed_log.feed_log_data.download_path error_affected_products[][]: - affected_product_count: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_count affected_product_item_list[][]: - airline_company: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].airline_company brand: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].brand description: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].description flight_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].flight_id home_listing_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].home_listing_id hotel_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].hotel_id index: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].index make: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].make media_title_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].media_title_id name: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].name product_url: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].product_url series_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].series_id sku_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].sku_id title: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].title value: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].value vehicle_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].vehicle_id field: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].field issue: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].issue suggestion: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].suggestion warn_affected_products[][]: - affected_product_count: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_count affected_product_item_list[][]: - airline_company: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].airline_company brand: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].brand description: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].description flight_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].flight_id home_listing_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].home_listing_id hotel_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].hotel_id index: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].index make: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].make media_title_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].media_title_id name: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].name product_url: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].product_url series_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].series_id sku_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].sku_id title: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].title value: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].value vehicle_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].vehicle_id field: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].field issue: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].issue suggestion: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].suggestion process_status: $.rpc.output.product_feed_log.process_status start_time: $.rpc.output.product_feed_log.start_time update_count: $.rpc.output.product_feed_log.update_count update_mode: $.rpc.output.product_feed_log.update_mode warn_count: $.rpc.output.product_feed_log.warn_count x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /catalog/set/delete/: post: operationId: Catalog Set Delete parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 product_set_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 10 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 required: - bc_id - catalog_id - product_set_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete product sets. [Catalog Set Delete](https://business-api.tiktok.com/portal/docs?id=1740573143966722) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: optType required: false source: '7' type: number - children: - children: - name: id required: false type: number - name: platformId required: false type: number - name: name required: false type: string - children: - children: - name: field required: false type: string - name: op required: false type: string - name: fieldType required: false type: string - name: value required: false type: string - name: sensType required: false type: number is_expand: true type: object is_expand: false name: conditions required: false sub_type: object type: array - name: createTime required: false type: number - name: modifyTime required: false type: number - name: bindType required: false type: number - name: pSetType required: false type: number - name: pSetCreateType required: false type: number - name: skuListTosUrl required: false type: string - children: - name: id required: false type: number - name: platformId required: false type: number - name: productSetId required: false type: number - name: status required: false type: number - name: totalCount required: false type: number - name: resolvedCount required: false type: number - name: errorCount required: false type: number - name: uploadPath required: false type: string - name: downloadPath required: false type: string - name: createTime required: false type: number - name: modifyTime required: false type: number is_expand: false name: productSetLog required: false type: object is_expand: false type: object is_expand: true name: pSets required: false source: $.pSets sub_type: object type: array plugins: after_response: [] before_request: - Plugin_map_setids_2329204: - description: map list of setids to pSets - request_params: - $.http.body.product_set_ids - $.http.body.catalog_id - result_params: - $.pSets - version: 40b87f525366565b0a358a95b6bed5cc request_query_rule: null request_rule: optType: 7 pSets: $.pSets response_cookie: [] response_header: [] response_rule: product_set_ids: $.http.body.product_set_ids[] x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/set/get/: get: operationId: Catalog Set Get parameters: - description: '' in: query name: catalog_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 1 - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 2 - description: '' in: query name: product_set_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.product_set_id x-open-field-id: 3 - description: '' in: query name: return_product_count required: false schema: default: true type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.return_product_count x-open-field-id: 4 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get product sets. [Catalog Set Get](https://business-api.tiktok.com/portal/docs?id=1740570556295169) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: catalog_id required: true source: $.http.query.catalog_id type: number - name: bc_id required: true source: $.http.query.bc_id type: number - name: product_set_id required: false source: $.http.query.product_set_id type: number - name: return_product_count required: false source: $.http.query.return_product_count type: boolean plugins: after_response: - Plugin_json_loads_resp_14621553: - description: sdadsasd - request_params: - $.rpc.output.result_list[] - result_params: - $.processed_list - version: e2b9b697638e7c43eb264f9aa412a4f8 before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id product_set_id: $.http.query.product_set_id return_product_count: $.http.query.return_product_count response_cookie: [] response_header: [] response_rule: list: $.processed_list x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/set/update/: post: operationId: Catalog Set Update parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.catalog_id conditions: description: '' properties: and: description: '' items: properties: {} type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - json_dumps(%s) minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.conditions.and_condition or: description: '' items: properties: {} type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - json_dumps(%s) minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.conditions.or_condition type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.conditions product_set_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 x-open-source: $.http.body.product_set_id product_set_name: description: '' maxLength: 28 minLength: 1 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.product_set_name required: - catalog_id - bc_id - product_set_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to update the filter conditions or name of a product set. [Catalog Set Get](https://business-api.tiktok.com/portal/docs?id=1740572974725122) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: bc_id required: true source: $.http.body.bc_id type: number - name: product_set_id required: false source: $.http.body.product_set_id type: number - name: product_set_name required: false source: $.http.body.product_set_name type: string - children: - children: - type: string is_expand: true name: and_condition required: false source: $.http.body.conditions.and[] sub_type: string type: array - children: - type: string is_expand: true name: or_condition required: false source: $.http.body.conditions.or[] sub_type: string type: array is_expand: true name: conditions required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id conditions: and_condition: $.http.body.conditions.and[] or_condition: $.http.body.conditions.or[] product_set_id: $.http.body.product_set_id product_set_name: $.http.body.product_set_name response_cookie: [] response_header: [] response_rule: product_count: $.rpc.output.product_count product_set_id: $.rpc.output.product_set_id product_set_name: $.rpc.output.product_set_name x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/update/: post: operationId: Catalog Update parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.catalog_id name: description: '' maxLength: 100 minLength: 1 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.name required: - catalog_id - bc_id - name type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to update the name of a catalog. The catalog must be under a Business Center. [Catalog Update](https://business-api.tiktok.com/portal/docs?id=1740306544966657) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - name: platformId required: false source: $.http.body.catalog_id type: number - name: name required: false source: $.http.body.name type: string - name: source required: false source: '2' type: number is_expand: true name: productLibrary required: false type: object - name: optType required: false source: '2' type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: optType: 2 productLibrary: name: $.http.body.name platformId: $.http.body.catalog_id source: 2 response_cookie: [] response_header: [] response_rule: catalog_id: $.rpc.output.dataTicket x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/video/delete/: post: operationId: Catalog Video Delete parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.catalog_id catalog_video_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.catalog_video_ids required: - bc_id - catalog_id - catalog_video_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete uploaded catalog videos. [Catalog Video Delete](https://business-api.tiktok.com/portal/docs?id=1803655103069185) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - children: - type: string name: catalog_video_ids required: false source: $.http.body.catalog_video_ids sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id catalog_video_ids: $.http.body.catalog_video_ids response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/video/file/: post: operationId: Catalog Video File parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.advertiser_ids bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.bc_id catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.catalog_id file_url: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.file_url required: - bc_id - catalog_id - file_url type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: null tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: file_url required: true source: $.http.body.file_url type: string - children: - type: number name: advertiser_ids required: false source: $.http.body.advertiser_ids sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_ids: $.http.body.advertiser_ids bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id file_url: $.http.body.file_url response_cookie: [] response_header: [] response_rule: feed_log_id: $.rpc.output.feed_log_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/video/get/: get: operationId: Catalog Video Get parameters: - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: catalog_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 2 - description: '' in: query name: catalog_video_ids required: false schema: items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.catalog_video_ids x-open-field-id: 3 - description: '' in: query name: page required: false schema: default: 1 format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 4 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 5 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: null tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: catalog_id required: true source: $.http.query.catalog_id type: number - children: - type: string name: catalog_video_ids required: false source: $.http.query.catalog_video_ids sub_type: string type: array - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id catalog_video_ids: $.http.query.catalog_video_ids page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: page_info: $.rpc.output.page_info videos: $.rpc.output.videos x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/set/product/get/: get: operationId: Catalog Set Product Get parameters: - description: '' in: query name: bc_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: catalog_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 2 - description: '' in: query name: product_set_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.product_set_id x-open-field-id: 3 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 4 - description: '' in: query name: page_size required: false schema: default: 20 format: int64 maximum: 100 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 5 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get products in a product set. [Catalog Set Product Get](https://business-api.tiktok.com/portal/docs?id=1740571478441986) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: false source: $.http.query.bc_id type: number - name: catalog_id required: true source: $.http.query.catalog_id type: number - children: - name: page_size required: false source: $.http.query.page_size type: number - name: page_num required: false source: $.http.query.page type: number is_expand: true name: page_info required: false type: object - children: - type: string is_expand: true name: pset_ids required: false source: $.pset_ids sub_type: string type: array - name: user_id required: false source: $.context.core_user_id type: number - name: request_source required: true source: '1' type: number plugins: after_response: - Plugin_handle_dpa_products_13408686: - description: map set products & total_page - request_params: - $.rpc.output.data - $.rpc.output.storeType - $.http.query.page_size - result_params: - $.total_cnt - $.products - $.total_page - version: ccae030c27ac65b7bb312d1083fdbcf4 before_request: - Plugin_pset_ids_list_13403048: - description: string to string list - request_params: - $.http.query.product_set_id - result_params: - $.pset_ids - version: 59f372763e33e608849ed73e192da44e request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id page_info: page_num: $.http.query.page page_size: $.http.query.page_size pset_ids: $.pset_ids request_source: 1 user_id: $.context.core_user_id response_cookie: [] response_header: [] response_rule: catalog_id: $.http.query.catalog_id page_info: page: $.http.query.page page_size: $.http.query.page_size total_number: $.total_cnt total_page: $.total_page product_count: $.total_cnt product_set_id: $.http.query.product_set_id products: $.products x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false components: securitySchemes: AccessToken: type: apiKey in: header name: Access-Token description: Long-term access token issued by POST /oauth2/access_token/ after advertiser authorization. See https://business-api.tiktok.com/portal/docs?id=1738373164380162