Skip to main content
GET
/
advertisers
/
{advertiserId}
/
catalogs
List catalogs
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/advertisers/{advertiserId}/catalogs \
  --header 'Authorization: Bearer <token>'
{
  "catalogs": [
    {
      "catalogId": "<string>",
      "platformId": "<string>",
      "name": "<string>",
      "url": "<string>",
      "itemCount": 4503599627370495,
      "latestVersionId": "<string>",
      "latestVersionNumber": 123,
      "latestContentHash": "<string>",
      "activeTransformId": "<string>",
      "latestActivationPlanId": "<string>",
      "lastChangeSummary": {
        "added": 0,
        "updated": 0,
        "unchanged": 0,
        "removed": 0
      },
      "lastSyncAttemptAt": "2023-11-07T05:31:56Z",
      "lastSyncedAt": "2023-11-07T05:31:56Z",
      "nextSyncAt": "2023-11-07T05:31:56Z",
      "staleAfterAt": "2023-11-07T05:31:56Z",
      "versions": [
        {
          "versionId": "<string>",
          "versionNumber": 123,
          "itemCount": 4503599627370495,
          "contentHash": "<string>",
          "changeSummary": {
            "added": 0,
            "updated": 0,
            "unchanged": 0,
            "removed": 0
          },
          "createdAt": "2023-11-07T05:31:56Z",
          "completedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "recentRefreshRuns": [
        {
          "refreshRunId": "<string>",
          "httpStatus": 0,
          "itemCount": 4503599627370495,
          "activationSkippedReason": "<string>",
          "error": "<string>",
          "startedAt": "2023-11-07T05:31:56Z",
          "completedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "recentActivationExecutions": [
        {
          "executionId": "<string>",
          "planId": "<string>",
          "catalogVersionId": "<string>",
          "campaignGroupCount": 4503599627370495,
          "creativeAssetCount": 4503599627370495,
          "syndicationTargetCount": 4503599627370495,
          "error": "<string>",
          "startedAt": "2023-11-07T05:31:56Z",
          "completedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "advertiserId": "<string>"
    }
  ],
  "total": 4503599627370495
}

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
advertiserId
string
required

Unique identifier for the advertiser

Minimum string length: 1
Example:

"12345"

Query Parameters

​
type
enum<string>
Available options:
offering,
product,
inventory,
store,
promotion,
hotel,
flight,
job,
vehicle,
real_estate,
education,
destination
​
take
integer
default:50

Number of results to return (max 250)

Required range: x <= 250
Example:

50

​
skip
integer
default:0

Number of results to skip for pagination

Required range: 0 <= x <= 9007199254740991
Example:

0

Response

List catalogs

​
catalogs
object[]
required
​
total
integer
required
Required range: 0 <= x <= 9007199254740991