The catalog object holds information for the product catalog(s) in your program, but not the items within a specific product catalog. You can retrieve a product catalog's information object as well as list all product catalog information objects.
Attributes
Id
integer
Id
integerUnique identifier for the object referred to as the impact.com Catalog Id.
Name
string
Name
stringName of the catalog.
Filename
string
Filename
stringName of the file that contains the catalog.
AdvertiserId
integer
AdvertiserId
integerId of the Brand (formerly known as advertiser) that owns the catalog.
CampaignId
integer
CampaignId
integerId of the Program (formerly known as campaign) to which the catalog belongs.
Status
enum
Status
enumWhat state of use the catalog is in.
View possible enum values | |
---|---|
ACTIVE | Live catalogs that partners can view. |
CLOSED | Product catalogs that are closed. |
DEACTIVATED | Product catalogs that were deactivated by an account user. |
PENDING | Product catalogs that are still pending activation. |
NumberOfItems
integer
NumberOfItems
integerAmount of items in the catalog.
DateLastUpdated
string
DateLastUpdated
stringDate and time the catalog was last updated. See ISO 8601.
UploadMethod
enum
UploadMethod
enumHow the catalog was uploaded to impact.com.
View possible enum values | |
---|---|
DIRECT_UPLOAD | The catalog was uploaded directly to impact.com. |
IMPACT_RADIUS_FTP_SERVER | impact.com retrieved the catalog using an FTP server call. |
IR_SFTP | impact.com retrieved the catalog using a secure FTP server call. |
PULL_FROM_URL | impact.com retrieved the catalog from a provided URL. |
SHOPPING_CART_PULL | impact.com retrieved the catalog from a shopping cart integration. |
ItemsUri
string
ItemsUri
stringCatalog's item's direct URI to view one set of catalog items.
Uri
string
Uri
stringCatalog's direct URI.
{
"Id": "1234",
"Name": "ACME Catalog",
"Filename": "anvils.xml",
"AdvertiserId": "7777777",
"CampaignId": "1000",
"Status": "PENDING",
"NumberOfItems": "25",
"DateLastUpdated": "",
"UploadMethod": "IMPACT_RADIUS_FTP_SERVER",
"ItemsUri": "/Advertisers/<AccoutnSID>/Catalogs/1234/Items",
"Uri": "/Advertisers/<AccountSID>/Catalogs/1234"
}