Product Catalogs

List all catalogs

get

Returns a list of all product catalogs in your program.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique account identifier.

Query parameters

CampaignIdintegerOptional

Filter catalogs by the ID of the program (campaign) they belong to.

Statusstring · enumOptional

Filter catalogs by their current state of use.

Possible values:

Responses

200

A list of catalogs.

application/json

get/Advertisers/{AccountSID}/Catalogs

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Catalogs' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

A list of catalogs.

{
  "Catalogs": [
    {
      "Id": "99999",
      "Name": "Acme Sports Catalog",
      "Language": "ENGLISH",
      "Filename": "acme_sports.csv",
      "AdvertiserId": "1000",
      "CampaignId": "1000",
      "Status": "ACTIVE",
      "NumberOfItems": 1000,
      "DateLastUpdated": "2026-01-15T10:00:00-08:00",
      "Currency": "USD",
      "UploadMethod": "IR_SFTP",
      "ItemsUri": "/Advertisers/<AccountSID>/Catalogs/99999/Items",
      "Uri": "/Advertisers/<AccountSID>/Catalogs/99999"
    }
  ]
}

Retrieve a catalog

get

Retrieves metadata for a specific product catalog.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdstringRequired

Unique identifier for the catalog.

Responses

200

Catalog details.

application/json

IdstringOptional

Unique identifier for the catalog (the impact.com Catalog Id).

Example: 99999

NamestringOptional

Name of the catalog.

Example: Acme Sports Catalog

LanguagestringOptionalExample: ENGLISH

FilenamestringOptional

Name of the file that contains the catalog.

Example: acme_sports.csv

AdvertiserIdstringOptional

Id of the brand (formerly known as advertiser) that owns the catalog.

Example: 1000

CampaignIdstringOptional

Id of the program (formerly known as campaign) to which the catalog belongs.

Example: 1000

Statusstring · enumOptional

State of use the catalog is in (e.g., ACTIVE, CLOSED, DEACTIVATED, PENDING).

Example: ACTIVEPossible values:

NumberOfItemsintegerOptional

Number of items in the catalog.

Example: 1000

DateLastUpdatedstring · date-timeOptional

Date and time the catalog was last updated (ISO 8601).

Example: 2026-01-15T10:00:00-08:00

CurrencystringOptional

Currency in which the items' prices are listed. See ISO 4217.

Example: USD

UploadMethodstring · enumOptional

How the catalog was uploaded (e.g., DIRECT_UPLOAD, IR_SFTP, SHOPPING_CART_PULL).

Example: IR_SFTPPossible values:

ItemsUristring · uri-referenceOptional

URI to view this catalog's items.

Example: /Advertisers/<AccountSID>/Catalogs/99999/Items

Uristring · uri-referenceOptional

Direct URI to this catalog.

Example: /Advertisers/<AccountSID>/Catalogs/99999

get/Advertisers/{AccountSID}/Catalogs/{CatalogId}

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Catalogs/{CatalogId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

Catalog details.

{
  "Id": "99999",
  "Name": "Acme Sports Catalog",
  "Language": "ENGLISH",
  "Filename": "acme_sports.csv",
  "AdvertiserId": "1000",
  "CampaignId": "1000",
  "Status": "ACTIVE",
  "NumberOfItems": 1000,
  "DateLastUpdated": "2026-01-15T10:00:00-08:00",
  "Currency": "USD",
  "UploadMethod": "IR_SFTP",
  "ItemsUri": "/Advertisers/<AccountSID>/Catalogs/99999/Items",
  "Uri": "/Advertisers/<AccountSID>/Catalogs/99999"
}