API Reference

Create an item for a catalog

Creates a new catalog item. Google Merchant Formatting is highly recommended.

Parameters

CatalogItemId required

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

Name required

Name of the item.

Url required

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

AgeGroup recommended

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.

Bullets recommended

Comma-separated list of short descriptions of the product.

Category recommended

What group or kind of products the item is associated with. Use Google Merchant's product category format.

Condition recommended

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.

Currency recommended

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

CurrentPrice recommended

Current consumer price of the item.

CurrentPriceDescription optional

A description of the current consumer price of the item.

Description recommended

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

ImageUrl recommended

URL that leads to the item's image.

PromotionIds recommended

List of promotion Ids that identify an item as part of a promotion. Can add multiple promotion Ids. Use commas between each new promotion Id.

Inventory recommended

Inventory count of the item.

Labels recommended

Key terms to help partners find a particular catalog in impact.com. Can add multiple labels. Use commas between each new label.

LaunchDate recommended

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

OriginalPrice recommended

Original price of the item.

ProductBid recommended

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

ShippingRate recommended

How much shipping the item costs.

StockAvailability recommended

Status of the product's backstock.

View possible enum values
InStockProduct is in stock
OutofStockProduct is out of stock
Back-OrderProduct is currently back-ordered
Pre-OrderProduct is available for pre-order
Limited AvailabilityProduct is available in limited quantities

More parameters

Click to view...

AdditionalImageUrls optional

Comma-separated list of URLs that point to more images of the product.

Adult optional

If the item is only intended for adults.

AgeRangeMax optional

Maximum age for whom the item is intended.

AgeRangeMin optional

Minimum age for whom the item is intended.

AgeRangeUnit optional

Age range's unit of measurement.

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

Asin optional

Item's Amazon Standard Identification Number.

Colors optional

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

CreditRating optional

Consumer credit rating that the product is aimed towards.

View possible enum values
Excellent
Good
Fair
Average
Poor
Bad
LimitedHistory
NoHistory
Limited
NoCredit

CreditRatingDescription optional

Description of the consumer credit rating that the product is aimed towards.

EstimatedShipDate optional

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

ExpirationDate optional

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

Gender optional

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.

Gtin optional

Item's Global Trade Item Number.

GtinType optional

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.

Manufacturer optional

The person or group that makes the item.

Material optional

Comma-separated list of the primary material(s) of the item.

IntroPurchaseApr optional

Consumer APR during an introductory phase.

IntroPurchaseAprType optional

What type of APR the consumer will get during an introductory phase.

IntroPurchaseAprDescription optional

Description of the introductory phase APR.

IntroPurchaseAprPeriod optional

Amount of time the introductory consumer APR period lasts.

IntroPurchaseAprPeriodType optional

Unit of measurement for the amount of time the introductory phase APR lasts.

View possible enum values
DAYS
MONTHS
YEARS

IntroPurchaseAprPeriodDescription optional

Description of the introductory phase APR period.

NonIntroPurchaseApr optional

Consumer APR during a non-introductory phase.

NonIntroPurchaseAprType optional

What type of APR the consumer will get during a non-introductory phase.

NonIntroPurchaseAprDescription optional

Description of the APR during a non-introductory phase.

PurchaseGracePeriod optional

Amount of time between the consumer purchasing the product and payments beginning.

IntroTransferPurchaseApr optional

Transfer consumer APR during an introductory phase.

IntroTransferPurchaseAprType optional

What type of APR the transfer consumer will get during an introductory phase.

IntroTransferPurchaseAprDescription optional

Description of the transfer consumer's introductory phase APR.

IntroTransferPurchaseAprPeriod optional

Amount of time the transfer consumer's APR introductory phase lasts.

IntroTransferPurchaseAprPeriodType optional

Unit of measurement for the amount of time the transfer consumer's introductory phase APR lasts.

View possible enum values
DAYS
MONTHS
YEARS

IntroTransferPurchaseAprPeriodDescription optional

Description of the transfers consumer's introductory phase APR period.

NonIntroTransferApr optional

Transfer consumer APR during a non-introductory phase.

NonIntroTransferAprType optional

What type of APR the transfer consumer will get during a non-introductory phase.

NonIntroTransferAprDescription optional

Description of the transfer consumer's non-introductory phase APR.

TransferGracePeriod optional

Amount of time between the consumer transferring their balance and payments beginning.

CashAdvanceApr optional

Consumer APR for cash advances.

CashAdvanceAprType optional

What type of APR the consumer will get after obtaining a cash advance.

CashAdvanceAprDescription optional

Description of the consumer's cash advance APR.

CashGracePeriod optional

Amount of time between the consumer obtaining a cash advance and the payments beginning.

PenaltyApr optional

Consumer APR when facing a penalty.

PenaltyAprDescription optional

Description of the consumer's APR when facing a penalty.

BalanceTransferFee optional

How much transferring balances will cost the consumer.

BalanceTransferFeeDescription optional

A description describing the amount a consumer has to pay to transfer balances.

CashAdvanceFee optional

How much getting a cash advance will cost the consumer.

CashAdvanceFeeDescription optional

A description describing the amount a consumer has to pay to get a cash advance.

LatePaymentFee optional

How much a late payment will cost the consumer.

LatePaymentFeeDescription optional

A description describing the amount a consumer has to pay to if they make a late payment.

ReturnCheckFee optional

How much the penalty for a returned/bounced check is.

ReturnCheckFeeDescription optional

A description describing the amount a consumer has to pay for returned/bounced checks.

OverlimitFee optional

How much being over their limit will cost the consumer.

OverlimitFeeDescription optional

A description describing the penalty a consumer has to pay for being above their limit.

ForeignTransactionFee optional

How much each foreign transaction will cost the consumer.

ForeignTransactionFeeDescription optional

A description describing the amount a consumer has to pay for each foreign transaction.

MinimumDeposit optional

The minimum amount needed to make a deposit.

RewardsType optional

What kind of incentive the consumer gets for using a particular credit option.

View possible enum values
MilesConsumer receives travel miles.
PointsConsumer receives points to spend.
CashbackConsumer receives cash back on purchases.
StarpointsConsumer receives starpoints.

RewardsBonus optional

Consumer bonus on top of their rewards.

RewardsRate optional

How fast a consumer will earn rewards.

RewardsType2 optional

What kind of incentive the consumer gets for using a particular credit option.

View possible enum values
MilesConsumer receives travel miles.
PointsConsumer receives points to spend.
CashbackConsumer receives cash back on purchases.
StarpointsConsumer receives starpoints.

RewardsBonus2 optional

Consumer bonus on top of their rewards.

RewardsRate2 RewardsRate

How fast a consumer will earn rewards.

RewardsType3 optional

What kind of incentive the consumer gets for using a particular credit option.

View possible enum values
MilesConsumer receives travel miles.
PointsConsumer receives points to spend.
CashbackConsumer receives cash back on purchases.
StarpointsConsumer receives starpoints.

RewardsBonus3 optional

Consumer bonus on top of their rewards.

RewardsRate3 optional

How fast a consumer will earn rewards.

AvailableApplications optional

Where the consumer can access their account.

View possible enum values
DesktopConsumer can use a regular computer.
MobileConsumer can use a smartphone.
PhoneConsumer can call a dedicated phone number.

Terms optional

Terms tied to the offer a consumer receives.

BonusOffer optional

A bonus the consumer will get if they accept the offer.

BonusOfferTerms optional

Terms tied to the bonus the consumer will get if they accept the offer.

Pattern optional

Pattern of the item.

ProductType optional

What kind of consumer the product is meant for.

View possible enum value
BusinessItem is meant for businesspeople.
ConsumerItem is meant for the average consumer.
StudentItem is meant for students.

ShippingHeight optional

Height of the shipping parcel.

ShippingLabel optional

Label of the shipping parcel.

ShippingLength optional

Length of the shipping parcel.

ShippingLengthUnit optional

What the shipping parcel's length is measured in.

View possible enum values
inImperial inches
cmMetric centimeters

ShippingWeight optional

Weight of the shipping parcel.

ShippingWeightUnit optional

What the shipping parcel's weight is measured in.

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

ShippingWidth optional

Width of the shipping parcel.

ProhibitedCategories optional

Comma-separated list of categories that are excluded.

ManufacturingCost optional

Cost to produce the item.

MobileDescription optional

Product's description for a mobile store page.

MobileUrl optional

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

Money1 optional

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

Money2 optional

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

Money3 optional

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

Mpn optional

Item's Manufacturing Part Number.

Multipack optional

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

Numeric1 optional

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

Numeric2 optional

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

Numeric3 optional

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

OriginalFormatCategory optional

Category breadcrumb to locate the item.

OriginalFormatCategoryId optional

IsParent optional

Item that represents a bundle of items.

ParentName optional

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

ParentSku optional

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

ProcessingNetwork optional

What internet network processes product purchases.

Size optional

Size of the item.

SizeUnit optional

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

Text1 optional

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

Text2 optional

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

Text3 optional

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

Weight optional

Weight of the item.

WeightUnit optional

Item's weight's unit of measurement.

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

Returns

Returns the status of the request and the URI of the newly created note. Returns an error if create parameters are invalid or if a required parameter is missing.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Catalogs/1234/Items' \
  -X POST \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'CatalogItemId=12345' \
  -d 'Name=Anvil' \
  -d 'Url=https://acme.impact.com/store/anvil' \
  -d 'Adult=false' \
  -d 'StockAvailability="BackOrder"' \
  -d 'Gtin=14141414141414'

Example Response

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Catalogs/1234/Items/12345"
}