API Reference

The (catalog) item object

The (catalog) item object holds all items within a product catalog. You can create, retrieve, update, and delete an item, as well as list all items within a product catalog.

Attributes

CatalogItemId integer

Unique identifier for the object referred to as the Catalog Item Object.

Name string

Name of the item.

Description string

Description of the item, like information about it or what it does.

Multipack enum

If the item represents 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 person or group that makes 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.

AdditionalImageUrls array

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

PromotionIds array

List of promotion Ids that identify an item as part of a promotion. Contains each individual PromotionId for the item, which are strings.

CurrentPrice decimal

Current consumer price of the item.

OriginalPrice decimal

Original consumer price of the item.

DiscountPercentage integer

Percent discount a consumer can get when they purchase the product.

ManufacturingCost decimal

Cost to produce the item.

Currency string

The currency in which the item's price is listed. See ISO 4217.

StockAvailability enum

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.

EstimatedShipDate string

Date that the item will being shipping. See ISO 8601.

LaunchDate string

Date the item becomes available (or became available if already released). See ISO 8601.

ExpirationDate string

Date that the item will be removed from the catalog. See See ISO 8601.

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 string

Item's Manufacturing Part Number.

ShippingRate decimal

Standard rate to ship the item.

ShippingWeight decimal

Weight 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 of the shipping parcel.

ShippingWidth decimal

Width of the shipping parcel.

ShippingHeight decimal

Height of the shipping parcel.

ShippingLengthUnit enum

What the shipping parcel's length is measured in.

View possible enum values
inImperial inches
cmMetric centimeters

ShippingLabel string

Label of the shipping parcel.

Category string

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

OriginalFormatCategory string

Category breadcrumb to locate the item.

OriginalFormatCategoryId integer

Id of the category that the item is located in.

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

An item that represents a bundle of items.

ItemGroupId string

This attribute is used to group product variants in your 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 string

Primary color(s) of the item.

Material string

Primary material of the item.

Pattern string

Pattern of the item.

Size string

Numerical 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

Weight of the item.

WeightUnit string

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

If the item is only intended for adults.

ProductBid string

How much the partner will be paid for driving a conversion on the product.

Inventory integer

Item's inventory count.

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 decimal

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

Numeric2 decimal

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

Numeric3 decimal

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 a specific (catalog) item.

Field list

{
  "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": "ABC1234DE",
  "ShippingRate": "0.00",
  "ShippingWeight": "3.0",
  "ShippingWeightUnit": "",
  "ShippingLength": "",
  "ShippingWidth": "",
  "ShippingHeight": "",
  "ShippingLengthUnit": "",
  "ShippingLabel": "",
  "Category": "Forge > Anvils",
  "OriginalFormatCategory": "Forge > Anvils",
  "OriginalFormatCategoryId": "98765",
  "ParentName": "ACME Forges",
  "ParentSku": "123456A78",
  "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"
}