PIpinterest
catalog_items

Get item batch status

Changed on

Get a single catalogs items batch owned by the "operating user_account". See detailed documentation here.

  • By default, the "operation user_account" is the token user_account.

Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.

get/catalogs/items/batch/{batch_id}

Request

Path parameters

batch_idstring required

Id of a catalogs items batch to fetch

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Response

The request has succeeded.

OR
OR

Example response

{
  "completed_time": "2024-01-01T20:20:00Z",
  "created_time": "2024-01-01T20:10:40Z",
  "items": [
    {
      "errors": [
        {
          "attribute": "title",
          "code": 106,
          "message": "Title is missing from product metadata."
        }
      ],
      "item_id": "DS0294-M",
      "status": "SUCCESS",
      "warnings": [
        {
          "attribute": "title",
          "code": 106,
          "message": "Title is missing from product metadata."
        }
      ]
    }
  ],
  "status": "PROCESSING"
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      changed the pattern of the path request parameter batch_id from ^[a-zA-Z0-9]+$ to ^\d+$

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      the response optional property //// became not read-only for the status

    • info

      the response optional property //// became not read-only for the status

    • info

      the response optional property //// became not read-only for the status

    • info

      the response optional property //// became not read-only for the status

    • info

      the response optional property //// became not read-only for the status

    • info

      added to the //// response property allOf list for the response status

    • info

      added to the //// response property allOf list for the response status

    • info

      added to the //// response property allOf list for the response status

    • info

      removed the CREATIVE_ASSETS enum value from the //// response property for the response status

    • info

      removed the CREATIVE_ASSETS enum value from the //// response property for the response status

    • info

      removed the HOTEL enum value from the //// response property for the response status

    • info

      removed the HOTEL enum value from the //// response property for the response status

    • info

      removed the RETAIL enum value from the //// response property for the response status

    • info

      removed the RETAIL enum value from the //// response property for the response status

    • info

      the response required property //// became not read-only for the status

  • v579f62f71f05bRevision changes
    • breaking

      the response property //// became nullable for the status

    • info

      the response property //// became required for the status