API Reference

The (catalog) item object

The (catalog) item object describes a specific item within a catalog. You can retrieve an item, as well as list all items within a product catalog.

Attributes

Id string

The full unique identifier for the object. Used when retrieving a specific item.

CatalogId integer

Unique identifier for the catalog that the item belongs to.

CampaignId integer

Unique identifier for the program (or campaign) that the item (and catalog) belongs to.

CampaignName string

Name of the program (or campaign) that the item (and catalog) belongs to.

CatalogItemId integer

Abbreviated unique identifier for a catalog item.

Name string

Name of the item.

Description string

Description of the item.

Multipack enum

If the item is a merchant-defined multi-pack.

View possible enum value
YESThe item represents a multi-pack.
NOThe item does not represent a multi-pack.

Bullets array

Short descriptions of the product. Contains each individual Bullet for the item, which are strings.

Labels array

Key terms to help partners find a particular catalog in impact.com. Contains each individual Label for the item, which are strings.

Manufacturer string

The entity that manufacturers the item.

Url string

URL that leads to the item's online store listing.

MobileUrl string

The URI that points directly to the item's mobile listing.

ImageUrl string

URL that leads to the item's image.

ProductBid string

In a CPC campaign, this is the bid amount for clicks on the item.

AdditionalImageUrls array

List of URLs that point to more images of the item. Contains each individual AdditionalImageUrl for the item, which are strings.

Promotions array

List of promotions that include the item.

View child attributes

PromotionId string

Id of the promotion.

PromotionTitle string

Name of the promotion.

PromotionEffectiveDates yyyy-mm-dd/yyyy-mm-dd

The start and end dates of the promotion. First date is start date. Second date is end date.

GenericRedemptionCode string

Redemption code that customers can use to redeem the promotion.

CurrentPrice integer

The current listed price for the item.

OriginalPrice integer

The original listed price for the item.

DiscountPercentage integer

The discount offered on an item, expressed as a percentage of the original price.

Currency currency

The three-letter ISO 4217 code for the currency of the item's price.

StockAvailability enum

Status of the item's stock availability.

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

EstimatedShipDate datetime

Estimated date the item will ship, expressed in ISO 8601 format.

LaunchDate datetime

Date the item becomes available (or became available if already released), expressed in ISO 8601 format.

ExpirationDate datetime

Date that the item will be removed from the catalog, expressed in ISO 8601 format.

View more attributes

Click to view...

Gtin integer

Item's Global Trade Item Number.

GtinType enum

Type of GTIN number the item uses.

View possible enum values
EANEuropean Article Number. 13 numbers.
UPCUniversal Product Code. 12 numbers.
ISBNInternational Standard Book number. 13 numbers.
JANJapanese Article Numbering. 13 numbers.

Asin integer

Item's Amazon Standard Identification Number.

Mpn integer

Item's Manufacturing Part Number.

ShippingRate decimal

Standard rate (i.e., cost) to ship the item.

ShippingWeight decimal

Weight value of the shipping parcel.

ShippingWeightUnit enum

What the shipping parcel's weight is measured in.

View possible enum values
lbImperial pounds
ozImperial ounces
gMetric grams
kgMetric kilograms
mgMetric milligrams

ShippingLength decimal

Length value of the shipping parcel.

ShippingWidth decimal

Width value of the shipping parcel.

ShippingHeight decimal

Height value of the shipping parcel.

ShippingLengthUnit enum

What the shipping parcel's length, width, and height is measured in.

View possible enum values
inImperial inches
cmMetric centimeters

ShippingLabel string

Label details of the shipping parcel.

Category string

If the brand is using a custom catalog format, this is the defined category that the item is associated with.

SubCategory string

If the brand is using a custom catalog format, this is the defined subcategory that the item is associated with.

AdvertiserFormatCategories array

The item's categories defined in the brand's product catalog format.

OriginalFormatCategory string

The item's category from the original format of the product/item catalog.

OriginalFormatCategoryId integer

ID of the category from the original format of the product/item catalog.

ParentName string

If the item has a parent item, the parent item's name.

ParentSku integer

If the item has a parent item, the parent item's SKU.

IsParent boolean

If set to true, the item is a parent item with child items; otherwise false.

ItemGroupId string

This attribute is used to group product variants in product data. Variants are a group of similar products that only differ from one another by product details like size, color, pattern, age group, and gender.

Colors array

Listed colors of the item.

Material string

Listed materials of the item.

Pattern string

Listed patterns of the item.

Size string

Numerical expression of the size of the item.

SizeUnit enum

Item's size's unit of measurement.

View possible enum values
Meters
Decimeters
Centimeters
Millimeters
Liters
Deciliter
Centiliter
Milliliters
Kilograms
Grams
Milligrams
Yards
Feet
Inches
Pounds
Gallons
Quarts
Pints
Ounces

Weight decimal

Numerical expression of the weight of the item.

WeightUnit enum

Item's weight's unit of measurement.

View possible enum values
lbImperial pounds
ozImperial ounces
gMetric grams
kgMetric kilograms
mgMetric milligrams

Condition enum

What condition the item is in when it is sold.

View possible enum value
NewItem is brand new.
UsedItem had a previous owner.
RefurbishedItem had a previous owner and was touched up before being sold again.
OEMOriginal Equipment Manufacturer
OpenBoxOriginal package seals were opened.

AgeGroup enum

Age group that the item targets.

View possible enum value
NewbornProduct is meant for newborns.
InfantProduct is meant for infants.
ToddlerProduct is meant for toddlers.
KidsProduct is meant for kids.
AdultProduct is meant for adults.

AgeRangeMin integer

Minimum age for whom the item is intended.

AgeRangeMax integer

Maximum age for whom the item is intended.

AgeRangeUnit enum

Age range's unit of measurement.

View possible enum values
MonthsAge is measured in months.
YearsAge is measured in years.

Gender enum

Gender for whom the item is intended.

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

Adult boolean

Whether the item is intended for adults (true) or general audiences (false).

Text1 string

General text field that accepts strings of any text data you want to send. Appears in your reports.

Text2 string

General text field that accepts strings of any text data you want to send. Appears in your reports.

Text3 string

General text field that accepts strings of any text data you want to send. Appears in your reports.

Numeric1 integer

General numeral field that accepts strings of any numeric data you want to send. Appears in your reports.

Numeric2 integer

General numeral field that accepts strings of any numeric data you want to send. Appears in your reports.

Numeric3 integer

General numeral field that accepts strings of any numeric data you want to send. Appears in your reports.

Money1 string

General numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.

Money2 string

General numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.

Money3 string

General numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.

Uri string

The URI that points directly to the specific catalog item.

Field list

{
  "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": [],
  "Promotions": [
    {
      "PromotionId": "3monthsfree",
      "PromotionTitle": "Get 3 months of TV free with your purchase.",
      "PromotionEffectiveDates": "2023-01-01/2023-06-30",
      "GenericRedemptionCode": "Get3Months"
      }
    ],
  "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_100_9876543"
},