API Reference

List catalogs

Returns a list of catalogs that are available to you.

Parameters

CampaignId optional

Only returns catalogs associated with the specified program (or campaign) ID.

Returns

Returns an array of catalogs up to a limit dictated by @pagesize. Each entry in the array is a separate catalog. If no catalogs meet the criteria, the resulting array will be empty. This request should never return an error.

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/Catalogs' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \

Example response

{
  "@page": "1",
  ...
  "Catalogs" [
    {
      "Id": "4321",
      "Name": "Acme Product Catalog",
      "Language": "English",
      "AdvertiserId": "123456",
      "AdvertiserName": "Acme Corporation",
      "AdvertiserLocation": "United States",
      "CampaignId": "0102",
      "CampaignName": "Acme Partner Program",
      "NumberOfItems": "512",
      "DateLastUpdated": "2021-05-05T00:15:28-04:00",
      "Currency": "USD",
      "ServiceAreas": [
        "United States",
        "United Kingdom",
        "Canada",
      ],
      "Locations": [
          "/B2B-Demo/Acme-Product-Catalog_GOOGLE_TXT.txt.gz",
          "/B2B-Demo/Acme-Product-Catalog_IR.txt.gz"
      ],
      "FTPLocations": [],
      "ItemsUri": "/Mediapartners/<AccountSID>/Catalogs/4321/Items",
      "Uri": "/Mediapartners/<AccountSID>/Catalogs/4321"
    },
    {
      ...
    }
  ]
}