Retrieve a catalog

Retrieves the details of an existing catalog. You need to pass the unique impact.com catalog Id that was returned when listing catalogs.

Note: There are different catalog endpoints for retail and finance-related products (e.g., credit cards, loans).

Parameters

`Id` required

The unique impact.com catalog ID that was returned when listing catalogs.

Returns

Returns a catalog object if a valid identifier is provided. Returns an error for invalid or deleted contact identifiers.

Example request

Product catalog

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

Financial catalog

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

Example response

Product catalog

{
  "Id": "4321",
  "Name": "Acme Product Catalog",
  "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"
}

Financial catalog

{
  "Id": "18220",
  "Name": "Wayne Enterprises Credit Cards",
  "AdvertiserId": "1804207",
  "AdvertiserName": "Acme Corporation",
  "AdvertiserLocation": "United States",
  "CampaignId": "10306",
  "CampaignName": "Wayne Enterprises",
  "NumberOfItems": "0",
  "DateLastUpdated": "2024-07-19T04:05:18-07:00",
  "Locations": [
      "/Wayne-Enterprises/Wayne-Enterprises-Credit-Cards_FINANCE_TXT.csv.gz",
      "/Wayne-Enterprises/Wayne-Enterprises-Credit-Cards_IR_FINANCE.txt.gz"
  ],
  "Currency": "USD",
  "FTPLocations": [],
  "ItemsUri": "/Mediapartners/<AccountSID>/FinancialCatalogs/18220/Items",
  "Uri": "/Mediapartners/<AccountSID>/FinancialCatalogs/18220"
}