Catalogs

List All Catalogs

get

Returns a list of all your product catalogs.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Query parameters

CampaignIdintegerOptional

Filters catalogs by the program (campaign) ID.

Statusstring · enumOptional

Filters catalogs by their status.

Possible values:

Responses

200

An array of catalog objects.

application/json

get/Advertisers/{AccountSID}/Catalogs

cURL

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

200

An array of catalog objects.

{
  "Catalogs": [
    {
      "Id": "99999",
      "Name": "Acme Sports Catalog",
      "Filename": "acme_sports.csv",
      "AdvertiserId": 1000,
      "CampaignId": 1000,
      "Status": "ACTIVE",
      "NumberOfItems": 1000,
      "DateLastUpdated": "2026-01-15T10:00:00-08:00",
      "Currency": "USD",
      "ServiceAreas": [
        "text"
      ],
      "UploadMethod": "IR_SFTP",
      "ShoppingCart": {
        "ShoppingCartType": "SHOPIFY",
        "BaseUrl": "https://acme.example.com",
        "CollectionIds": [
          "text"
        ],
        "CollectionTitles": [
          "text"
        ]
      },
      "ItemsUri": "/Advertisers/<AccountSID>/Catalogs/99999/Items",
      "Uri": "/Advertisers/<AccountSID>/Catalogs/99999"
    }
  ]
}

Retrieve a Catalog

get

Retrieves the details of an existing catalog.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CatalogIdintegerRequired

The unique impact.com ID for the catalog.

Responses

200

A catalog object.

application/json

IdstringOptional

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

Example: 99999

NamestringOptional

Name of the catalog.

Example: Acme Sports Catalog

FilenamestringOptional

Name of the file that contains the catalog.

Example: acme_sports.csv

AdvertiserIdintegerOptional

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

Example: 1000

CampaignIdintegerOptional

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

ServiceAreasstring[]Optional

List of geographical areas targeted by the catalog.

UploadMethodstring · enumOptional

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

Example: IR_SFTPPossible values:

ItemsUristringOptional

URI to view this catalog's items.

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

UristringOptional

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

A catalog object.

{
  "Id": "99999",
  "Name": "Acme Sports Catalog",
  "Filename": "acme_sports.csv",
  "AdvertiserId": 1000,
  "CampaignId": 1000,
  "Status": "ACTIVE",
  "NumberOfItems": 1000,
  "DateLastUpdated": "2026-01-15T10:00:00-08:00",
  "Currency": "USD",
  "ServiceAreas": [
    "text"
  ],
  "UploadMethod": "IR_SFTP",
  "ShoppingCart": {
    "ShoppingCartType": "SHOPIFY",
    "BaseUrl": "https://acme.example.com",
    "CollectionIds": [
      "text"
    ],
    "CollectionTitles": [
      "text"
    ]
  },
  "ItemsUri": "/Advertisers/<AccountSID>/Catalogs/99999/Items",
  "Uri": "/Advertisers/<AccountSID>/Catalogs/99999"
}