API Reference

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.

Parameters

No parameters

Returns

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

Example request

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

Example response

{
  "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"
}