Returns a list of all your catalogs.
Parameters
CampaignId
optional
CampaignId
optionalId of the program (formerly known as campaign) to which the catalog belongs.
Status
optional
Status
optionalWhat state of use the catalog is in. If no enum is added, all catalog statuses can be returned.
View possible enum values | |
---|---|
ACTIVE | Live catalogs that partners can view. |
CLOSED | Product catalogs that have been closed by impact.com. |
DEACTIVATED | Product catalogs that were deactivated by an account user. |
PENDING | Product catalogs that are still pending activation. |
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/Advertisers/<AccountSID>/Catalogs' \
-X GET \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json' \
-d 'Status=ACTIVE' \
-G
Example Response
{
"@page": "1",
...
"Catalogs": [
{
"Id": "1234",
"Name": "ACME Catalog",
"Filename": "anvils.xml",
"AdvertiserId": "7777777",
"CampaignId": "1000",
"Status": "PENDING",
"NumberOfItems": "25",
"DateLastUpdated": "",
"Currency": "USD",
"ServiceAreas": [
"United States",
"United Kingdom",
"Canada",
],
"UploadMethod": "IMPACT_RADIUS_FTP_SERVER",
"ItemsUri": "/Advertisers/<AccoutnSID>/Catalogs/1234/Items",
"Uri": "/Advertisers/<AccountSID>/Catalogs/1234"
},
...
]
}