API Reference

Search catalog items

Searches across all product catalogs available to you based on the provided criteria.

Parameters

Query optional

Narrows the list down based on the provided criteria.

Supported search operators
>Greater than (e.g., CurrentPrice > 10.00)
>=Greater than or equal to (e.g., CurrentPrice >= 10.00)
<Less than (e.g., CurrentPrice < 10.00)
<Less than or equal to (e.g., CurrentPrice <= 10.00)
=Equal to (e.g., Manufacturer = 'Acme')
!=Not equal to (e.g., Manufacturer != 'Acme')
~Contains to (e.g., Manufacturer ~ 'Acme')
AND"And" operator (e.g., CurrentPrice = 10.00 AND Manufacturer != 'Acme')
OR"Or" operator (e.g., Color = 'Red' OR Color = 'Blue')
AND & ORYou can also combine the "And" and "Or" operators by placing them in parentheses.
e.g., (CurrentPrice <= 10.00 AND (Manufacturer != 'Acme' OR Labels NOT IN('label1','label2')) AND Gender = 'Female')
INInclude (e.g., Labels IN('label1','label2'))
NOT INNot included (e.g., Labels NOT IN('label1','label2'))

View eligible attributes

Click to view…

⚠️

Note

The field names and values in the search phrase are case-sensitive and string values need to be in single quotes.
e.g., (Color = 'Navy')

CatalogItemId optional

Unique number Id for an item in the object.

Name optional

Name of the item.

Manufacturer optional

The person or group that makes the item.

Labels optional

Key terms to help partners find a particular catalog in impact.com.

CurrentPrice optional

Current consumer price of the item.

DiscountPercentage optional

The percentage of discount applied to the item.

Gtin optional

Item's 14-digit Global Trade Item Number.

Color optional

Comma-separated list of the primary colors of the item.

Size optional

Size of the item.

StockAvailability optional

Availability of the item.

View possible enum values
InStockIn stock.
OutofStockOut of stock.
BackOrderCurrently back-ordered.
PreOrderAvailable for pre-order.
LimitedAvailabilityAvailable in limited quantities.

Gender optional

Gender meant to use the item.

View possible enum values
MaleProduct is meant for male-identifying customers.
FemaleProduct is meant for female-identifying customers.
UnisexProduct is meant for all customers.

PromotionIds optional

You can use PromotionIds=null to return products with no promotions, or PromotionIds!=null to return products with promotions.

SortBy optional

Sorts list results by your chosen attributes. You can control the sort order by specifying either an ASC or DESC sort order. You can sort search results by the following attributes.

View eligible attributes

Click to view…

CatalogItemId optional

Unique number Id for an item in the object.

Manufacturer optional

The person or group that makes the item.

CurrentPrice optional

Current consumer price of the item.

StockAvailability optional

Availability of the item.

View possible enum values
InStockIn stock.
OutofStockOut of stock.
BackOrderCurrently back-ordered.
PreOrderAvailable for pre-order.
LimitedAvailabilityAvailable in limited quantities.

Gtin optional

Item's 14-digit Global Trade Item Number.

Gender optional

Gender meant to use the item.

View possible enum values
MaleProduct is meant for male-identifying customers.
FemaleProduct is meant for female-identifying customers.
UnisexProduct is meant for all customers.

Keyword optional

Searches for the specified word or phrase across all item attributes in all product catalogs. Keyword search is not case sensitive and it is treated as an AND operator in your query.

PageSize integer | optional

Can be used to specify the number of entities on each page. If no PageSize is specified, 100 products will be returned per page by default.

Returns

Returns a list of catalog item objects based on your specified search criteria.

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/Catalogs/ItemSearch' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'Query=CurrentPrice>=12.00ANDStockAvailability!=OutOfStock' \
  -d 'Keyword=Acme' \
  -G

Example response

{
  "Id": "product_1000_9876543",
  "CatalogId": "1000",
  "CampaignId": "1234",
  "CampaignName": "Acme Partner Program",
  "CatalogItemId": "9876543",
  "Name": "Acme Tennis Balls (One Dozen)",
  "Description": "A case of one dozen professional-grade tennis balls.",
  "MultiPack": "",
  "Bullets": [],
  "Labels": [],
  "Manufacturer": "",
  "Url": "https://example.com/shop/tennis-balls",
  "MobileUrl": "",
  "ImageUrl": "https://example.com/shop/tennis-balls/tennis-balls.png",
  "ProductBid": "",
  "AdditionalImageUrls": [],
  "CurrentPrice": "16.99",
  "OriginalPrice": "16.99",
  "DiscountPercentage": "",
  "Currency": "USD",
  "StockAvailability": "InStock",
  "EstimatedShipDate": "",
  "LaunchDate": "",
  "ExpirationDate": "",
  "Gtin": "",
  "GtinType": "",
  "Asin": "",
  "Mpn": "",
  "ShippingRate": "",
  "ShippingWeight": "",
  "ShippingWeightUnit": "",
  "ShippingLength": "",
  "ShippingWidth": "",
  "ShippingHeight": "",
  "ShippingLengthUnit": "",
  "ShippingLabel": "",
  "Category": "Home > Sports",
  "SubCategory": "Home > Sports > Tennis & Golf",
  "AdvertiserFormatCategories": "",
  "OriginalFormatCategory": "",
  "OriginalFormatCategoryId": "",
  "ParentName": "",
  "ParentSku": "",
  "IsParent": false,
  "ItemGroupId": "AB12345",
  "Colors": [],
  "Material": "",
  "Pattern": "",
  "Size": "",
  "SizeUnit": "",
  "Weight": "",
  "WeightUnit": "",
  "Condition": "New",
  "AgeGroup": "",
  "AgeRangeMin": "0",
  "AgeRangeMax": "0",
  "AgeRangeUnit": "",
  "Gender": "",
  "Adult": false,
  "Text1": "",
  "Text2": "",
  "Text3": "",
  "Numeric1": "",
  "Numeric2": "",
  "Numeric3": "",
  "Money1": "",
  "Money2": "",
  "Money3": "",
  "Uri": "/Mediapartners/<AccountSID>/Catalogs/1000/Items/product_1000_9876543"
},