Operate on item batch
POST {{baseUrl}}/catalogs/items/batch?ad_account_id=579382468
This endpoint supports multiple operations on a set of one or more catalog items owned by the operation user_account
. See detailed documentation here.
- By default, the operation user_account
is the token user_account.
Optional: Business Access: Specify an adaccountid
(obtained via List ad accounts) to use the owner of that adaccount as the "operation useraccount. In order to do this, the token user_account must have one of the following https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts">Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
ad_account_id | number | Unique identifier of an ad account. |
Request Body
{"country"=>"AS", "language"=>"BN", "operation"=>"DELETE_DISCONTINUED", "items"=>[{"item_id"=>"<string>", "attributes"=>{"ad_link"=>"<string>", "adult"=>"<boolean>", "age_group"=>"<string>", "availability"=>"<string>", "average_review_rating"=>"<number>", "brand"=>"<string>", "checkout_enabled"=>"<boolean>", "color"=>"<string>", "condition"=>"<string>", "custom_label_0"=>"<string>", "custom_label_1"=>"<string>", "custom_label_2"=>"<string>", "custom_label_3"=>"<string>", "custom_label_4"=>"<string>", "description"=>"<string>", "free_shipping_label"=>"<boolean>", "free_shipping_limit"=>"<string>", "gender"=>"<string>", "google_product_category"=>"<string>", "gtin"=>"<integer>", "id"=>"<string>", "item_group_id"=>"<string>", "last_updated_time"=>"<long>", "link"=>"<string>", "material"=>"<string>", "min_ad_price"=>"<string>", "mobile_link"=>"<string>", "mpn"=>"<string>", "number_of_ratings"=>"<integer>", "number_of_reviews"=>"<integer>", "pattern"=>"<string>", "price"=>"<string>", "product_type"=>"<string>", "sale_price"=>"<string>", "shipping"=>"<string>", "shipping_height"=>"<string>", "shipping_weight"=>"<string>", "shipping_width"=>"<string>", "size"=>"<string>", "size_system"=>"<string>", "size_type"=>"<string>", "tax"=>"<string>", "title"=>"<string>", "variant_names"=>["<string>", "<string>"], "variant_values"=>["<string>", "<string>"]}, "update_mask"=>["shipping_height", "average_review_rating"]}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"items":[{"item_id":"\u003cstring\u003e","errors":[{"attribute":"\u003cstring\u003e","code":"\u003cinteger\u003e","message":"\u003cstring\u003e"},{"attribute":"\u003cstring\u003e","code":"\u003cinteger\u003e","message":"\u003cstring\u003e"}],"warnings":[{"attribute":"\u003cstring\u003e","code":"\u003cinteger\u003e","message":"\u003cstring\u003e"},{"attribute":"\u003cstring\u003e","code":"\u003cinteger\u003e","message":"\u003cstring\u003e"}],"status":"PROCESSING"},{"item_id":"\u003cstring\u003e","errors":[{"attribute":"\u003cstring\u003e","code":"\u003cinteger\u003e","message":"\u003cstring\u003e"},{"attribute":"\u003cstring\u003e","code":"\u003cinteger\u003e","message":"\u003cstring\u003e"}],"warnings":[{"attribute":"\u003cstring\u003e","code":"\u003cinteger\u003e","message":"\u003cstring\u003e"},{"attribute":"\u003cstring\u003e","code":"\u003cinteger\u003e","message":"\u003cstring\u003e"}],"status":"PROCESSING"}],"batch_id":"\u003cstring\u003e","created_time":"\u003cdateTime\u003e","completed_time":"\u003cdateTime\u003e","status":"COMPLETED"}