Ctrlk
Help CenterContact Support

Catalogs

Endpoints for retrieving brand product catalogs and their items.

List Catalogs

get

Returns a list of all product catalogs available to you.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

Query parameters
CampaignIdintegerOptional

Filters catalogs by the campaign (brand program) they belong to.

Responses
200

A list of catalog objects.

application/json
get
/Mediapartners/{AccountSID}/Catalogs
200

A list of catalog objects.

Retrieve a Catalog

get

Retrieves the details of an existing catalog using its unique ID.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

The unique impact.com identifier for the catalog.

Responses
200

The catalog object.

application/json
IdstringOptional

Unique identifier for the catalog.

Example: 24836
NamestringOptional

Display name of the catalog.

Example: Wayne Enterprises Official Catalog
LanguagestringOptional

Language of the catalog content.

Example: English (United States)
AdvertiserIdstringOptional

Unique identifier for the brand's advertiser account.

Example: 1804207
AdvertiserNamestringOptional

Display name of the brand.

Example: Acme Corporation
AdvertiserLocationstringOptional

Geographic location of the advertiser.

Example: United States
CampaignIdstringOptional

Unique identifier for the campaign (brand program) associated with the catalog.

Example: 10306
CampaignNamestringOptional

Display name of the campaign associated with the catalog.

Example: Wayne Enterprises
NumberOfItemsstringOptional

The number of items currently in the catalog.

Example: 20
DateLastUpdatedstring · date-timeOptional

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

Example: 2022-09-02T01:37:15-07:00
Locationsstring[]Optional

Download paths for catalog files.

Example: ["/Wayne-Enterprises/Wayne-Enterprises-Official-Catalog_GOOGLE_TXT.txt.gz","/Wayne-Enterprises/Wayne-Enterprises-Official-Catalog_IR.txt.gz"]
CurrencystringOptional

ISO 4217 currency code for the catalog's pricing.

Example: USD
ServiceAreasstringOptional

Geographic regions the catalog serves.

FTPLocationsstring[]Optional

FTP access paths for catalog files. Includes authentication credentials — handle securely.

Example: ["ftp://ps-ftp_<AccountSID>:<FTPPassword>@products.impact.com/Wayne-Enterprises/Wayne-Enterprises-Official-Catalog_GOOGLE_TXT.txt.gz"]
ItemsUristringOptional

API resource path for the catalog's items.

Example: /Mediapartners/<AccountSID>/Catalogs/24836/Items
UristringOptional

Unique reference to the catalog object in the impact.com API.

Example: /Mediapartners/<AccountSID>/Catalogs/24836
get
/Mediapartners/{AccountSID}/Catalogs/{Id}
200

The catalog object.

List Catalog Items

get

Returns a list of all items in the specified catalog.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

CatalogIdstringRequired

The unique impact.com identifier for the catalog.

Query parameters
QuerystringOptional

Filter expression to narrow the list of items. Uses a comparison syntax against item attributes (e.g., CurrentPrice > 50, Manufacturer == 'Wayne Enterprises').

Responses
200

A list of catalog item objects.

application/json
get
/Mediapartners/{AccountSID}/Catalogs/{CatalogId}/Items
200

A list of catalog item objects.

Retrieve a Catalog Item

get

Retrieves the details of a specific item within a catalog using its unique ID.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

CatalogIdstringRequired

The unique impact.com identifier for the catalog.

IdstringRequired

The unique identifier for the catalog item.

Responses
200

The catalog item object.

application/json
IdstringOptional

Unique identifier for the catalog item, combining the catalog ID and the brand's item ID.

Example: product_24836_APP-0016
CatalogIdstringOptional

Unique identifier for the catalog this item belongs to.

Example: 24836
CampaignIdstringOptional

Unique identifier for the campaign associated with this item.

Example: 10306
CampaignNamestringOptional

Display name of the campaign associated with this item.

Example: Wayne Enterprises
CatalogItemIdstringOptional

The brand's own identifier for this item within the catalog.

Example: APP-0016
NamestringOptional

Product name.

Example: Wayne Reactive Armor Vest
DescriptionstringOptional

Product description.

Example: Wayne Reactive Armor Vest (Product Code APP-0016) by Wayne Enterprises.
MultiPackstringOptional

Indicates if this is a multi-pack product and the quantity included.

Bulletsstring[]Optional

Bullet-point product highlights.

Labelsstring[]Optional

Labels assigned to the item.

ManufacturerstringOptional

The manufacturer of the product.

Example: Wayne Enterprises
Urlstring · uriOptional

Tracking URL for the product page, unique to your partner account.

Example: https://example.pxf.io/c/1924609/3061936/10306?prodsku=APP-0016
MobileUrlstring · uriOptional

Mobile-optimized tracking URL for the product page.

ImageUrlstring · uriOptional

URL to the primary product image.

Example: https://wayne.limited/images/armorvest.jpg
ProductBidstringOptional

Bid value for the product in automated campaigns.

AdditionalImageUrlsstring · uri[]Optional

Additional product image URLs.

CurrentPricestringOptional

Current selling price of the item.

Example: 719.10
OriginalPricestringOptional

Original price before any discounts.

Example: 799.00
DiscountPercentagestringOptional

Discount percentage applied to the item.

Example: 10
CurrencystringOptional

ISO 4217 currency code for the item's pricing.

Example: USD
StockAvailabilitystringOptional

Current inventory status of the item (e.g., InStock, OutOfStock, PreOrder).

Example: InStock
EstimatedShipDatestring · date-timeOptional

Estimated shipping date for the item.

LaunchDatestring · date-timeOptional

Date the product was launched.

ExpirationDatestring · date-timeOptional

Date the product listing expires.

GtinstringOptional

Global Trade Item Number (barcode) for the product.

Example: 7774561230001
GtinTypestringOptional

The type of GTIN provided (e.g., EAN, UPC, ISBN, JAN).

Example: EAN
AsinstringOptional

Amazon Standard Identification Number.

MpnstringOptional

Manufacturer Part Number.

Example: ARM-VST-01
ShippingRatestringOptional

Shipping cost for the item.

Example: 5.99
ShippingWeightstringOptional

Weight of the packaged item for shipping.

Example: 2.0
ShippingWeightUnitstringOptional

Unit of measurement for the shipping weight (e.g., kg, lb).

Example: lb
ShippingLengthstringOptional

Length of the packaged item for shipping.

Example: 12
ShippingWidthstringOptional

Width of the packaged item for shipping.

Example: 10
ShippingHeightstringOptional

Height of the packaged item for shipping.

Example: 3
ShippingLengthUnitstringOptional

Unit of measurement for shipping dimensions (e.g., cm, in).

Example: in
ShippingLabelstringOptional

Shipping label or carrier information.

CategorystringOptional

Product category hierarchy.

Example: Apparel & Accessories > Clothing > Outerwear
SubCategorystringOptional

Product subcategory.

Example: Tactical Outerwear
AdvertiserFormatCategoriesstring[]Optional

Categories in the advertiser's own taxonomy format.

Example: ["Apparel > Uniforms > Tactical"]
OriginalFormatCategorystringOptional

Category as provided in the original catalog feed format.

Example: Apparel & Accessories > Clothing > Outerwear
OriginalFormatCategoryIdstringOptional

Identifier for the original format category.

Example: 424
ParentNamestringOptional

Name of the parent product if this item is a variant.

ParentSkustringOptional

SKU of the parent product if this item is a variant.

IsParentbooleanOptional

Whether this item is a parent product that has variants.

Example: false
ItemGroupIdstringOptional

Identifier grouping this item with its variants.

Colorsstring[]Optional

Available colors for the item.

Example: ["Black"]
MaterialstringOptional

Material the item is made of.

Example: Reactive composite
PatternstringOptional

Pattern or design of the item.

Example: Solid
SizestringOptional

Size of the item.

Example: L
SizeUnitstringOptional

Unit of measurement for the item's size.

Example: US
WeightstringOptional

Weight of the item.

Example: 1.8
WeightUnitstringOptional

Unit of measurement for the item's weight (e.g., kg, lb).

Example: lb
ConditionstringOptional

Condition of the item (e.g., New, Used, Refurbished).

Example: New
AgeGroupstringOptional

Target age group for the item (e.g., Adult, Kids, Infant).

Example: adult
AgeRangeMinstringOptional

Minimum age in the target age range.

Example: 0
AgeRangeMaxstringOptional

Maximum age in the target age range.

Example: 0
AgeRangeUnitstringOptional

Unit for the age range values (e.g., years, months).

Example: years
GenderstringOptional

Target gender for the item (e.g., Male, Female, Unisex).

Example: Unisex
AdultstringOptional

Whether the item is intended for adults only.

Text1stringOptional

Custom text field 1, defined by the brand.

Example: Wayne certified
Text2stringOptional

Custom text field 2, defined by the brand.

Example: Active threat resistant
Text3stringOptional

Custom text field 3, defined by the brand.

Example: NIJ Level IIIA
Numeric1stringOptional

Custom numeric field 1, defined by the brand.

Example: 4.7
Numeric2stringOptional

Custom numeric field 2, defined by the brand.

Example: 127
Numeric3stringOptional

Custom numeric field 3, defined by the brand.

Example: 5
Money1stringOptional

Custom monetary field 1, defined by the brand.

Example: 79.90
Money2stringOptional

Custom monetary field 2, defined by the brand.

Example: 0.00
Money3stringOptional

Custom monetary field 3, defined by the brand.

Example: 0.00
UristringOptional

Unique reference to the catalog item in the impact.com API.

Example: /Mediapartners/<AccountSID>/Catalogs/24836/Items/product_24836_APP-0016
get
/Mediapartners/{AccountSID}/Catalogs/{CatalogId}/Items/{Id}
200

The catalog item object.

Search Catalog Items

get

Searches for items across all available catalogs using a keyword. Unlike the per-catalog /Items endpoint, this endpoint searches across all catalogs in a single request and returns a paginated list of matching items.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

Query parameters
KeywordstringOptional

Keyword to search for across all catalog item fields (name, description, manufacturer, etc.). If omitted, all items across all catalogs are returned.

Example: Wayne
PageSizeintegerOptional

Number of items to return per page. Defaults to 100.

Example: 50
PageintegerOptional

Page number to retrieve (1-based). Use with PageSize to paginate through large result sets.

Example: 1
Responses
200

A paginated list of catalog item objects matching the search.

application/json
get
/Mediapartners/{AccountSID}/Catalogs/ItemSearch
200

A paginated list of catalog item objects matching the search.

PreviousCatalogsNextModels

Last updated