API Reference

List all items for a catalog

Returns a list of the items for a specific catalog. The items are returned by creation date, with the most recently created items appearing first.

Parameters

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.

PromotionIds optional

You can use PromotionIds=null to return a list of catalog products with no promotions, or PromotionIds!=null to return a list of catalog products which have promotions.

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., Category = 'Sports' OR Category = 'Equipment')
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 fields…

Name optional

Name of the item.

Description optional

Description of the product.

Labels optional

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

Manufacturer optional

The person or group that makes the item.

CurrentPrice optional

Current consumer price of the item.

StockAvailability optional

Status of the product's backstock.

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.

Category optional

What group or kind of products the item is associated with.

DiscountPercentage optional

The percentage of discount applied to the item.

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.

Color optional

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

Size optional

Size of the item.

SortBy optional

Sort the order of the results using specific attributes. To control the sort order one can set the 'SortOrder' query parameter to either 'ASC' or 'DESC'.

View eligible fields…

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.

Returns

Returns an array of (catalog) item objects up to a limit dictated by @pagesize. Each entry in the array is a separate (catalog) item object. If no (catalog) items 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/5050/Items' \
  -X GET \
  -H 'ContentType:application/w-www/form-urlencoded' \
  -H 'Accept: application/json' \
  -u '<AccountSID>:<AuthToken>' \
  -d 'Query=(Name=%27Anvil%27%20AND%20CurrentPrice=50.00)%20OR%20Manufacturer=%27ACME%27' \
  -d 'SortByASC=CatalogItemId' \
  -G

Example Response

{
  "@page": "0",
  ...
  "Items": [
    {
      "CatalogItemId": "55555",
       "Name": "Anvil",
       "Description": "Pairs well with a hammer.",
       "MultiPack": "YES",
       "Bullets": [
         "Reinforced Steel"
         ],
       "Labels": [],
       "Manufacturer": "ACME",
       "Url": "https://acme.impact.com/store/anvil",
       "MobileUrl": "mobile.anvil.com",
       "ImageUrl": "anvil.jpg.com",
       "AdditionalImageUrls": [
         "ACMEanvils.com"
         ],
       "PromotionIds": [
         "3monthsfree",
         "get20off"
         ],
       "CurrentPrice": "20.00",
       "OriginalPrice": "40.00",
       "DiscountPercentage": "50",
       "ManufacturingCost": "",
       "Currency": "USD",
       "StockAvailability": "OutOfStock",
       "EstimatedShipDate": "",
       "LaunchDate": "2021-01-19T16:00:00-08:00",
       "ExpirationDate": "",
       "Gtin": "9876543210987",
       "GtinType": "EAN",
       "Asin": "",
       "Mpn": "BSC0424PP",
       "ShippingRate": "0.00",
       "ShippingWeight": "3.0",
       "ShippingWeightUnit": "",
       "ShippingLength": "",
       "ShippingWidth": "",
       "ShippingHeight": "",
       "ShippingLengthUnit": "",
       "ShippingLabel": "",
       "Category": "Forge > Anvils",
       "OriginalFormatCategory": "Forge > Anvils",
       "OriginalFormatCategoryId": "98765",
       "ParentName": "ACME Forges",
       "ParentSku": "323461A33",
       "IsParent": false,
       "ItemGroupId": "AB12345",
       "Colors": [
         "Gray"
         ],
       "Material": "Steel",
       "Pattern": "",
       "Size": "300",
       "SizeUnit": "Pounds",
       "Weight": "300.0",
       "WeightUnit": "lbs",
       "Condition": "Used",
       "AgeGroup": "",
       "AgeRangeMin": "25",
       "AgeRangeMax": "55",
       "AgeRangeUnit": "Years",
       "Gender": "Male",
       "Adult": true,
       "ProductBid": "4",
       "Inventory": "0",
       "Text1": "Masterclass anvil",
       "Text2": "",
       "Text3": "",
       "Numeric1": "123.00",
       "Numeric2": "",
       "Numeric3": "",
       "Money1": "$600",
       "Money2": "",
       "Money3": "",
       "Uri": "/Advertisers/<AccountSID>/Catalogs/1234/Items/product_1234_55555"
        },
      ...
        }
    ]
}