HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference
Start typing to search…

Update items for a catalog

Updates the specified note by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Single product updates allow you to update a catalog item. The supported submission formats are Form and JSON formats. The Body Type of the call must be set to either form-data, raw, or x-www-form-urlencoded and enter key-value pairs as the data you wish to send.

For single item updates, the field names and field values must be in double quotes.

Parameters

Adult optional

The item is only intended for adults.

AgeGroup optional

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.

Category recommended

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

Colors optional

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

Condition optional

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.

Currency optional

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

Description optional

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

ImageUrl optional

URL that leads to the item's image.

PromotionIds optional

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 optional

Inventory count of the item.

Labels optional

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

LaunchDate optional

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

Manufacturer optional

The person or group that makes the item.

Material optional

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

Name optional

Name of the item.

OriginalPrice optional

Original price of the item.

Pattern optional

Pattern of the item.

ProductBid optional

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

ShippingHeight optional

Height of the shipping parcel.

ShippingLabel optional

Label of the shipping parcel.

ShippingLength optional

Length of the shipping parcel.

ShippingLengthUnit optional

Measurement unit of the length of the shipping parcel.

View possible enum values
inImperial inches
cmMetric centimeters

ShippingRate optional

How much shipping the item costs.

ShippingWeight optional

Weight of the shipping parcel.

ShippingWeightUnit optional

Measurement of the weight of the shipping parcel.

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

ShippingWidth optional

Width of the shipping parcel.

StockAvailability optional

Status of the product's backstock.

View possible enum values
InStockProduct is in stock.
OutofStockProduct is out of stock.
BackOrderProduct is currently back-ordered.
PreOrderProduct is available for pre-order.
LimitedAvailabilityProduct is available in limited quantities.

Url optional

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

More parameters

Click to view...

AdditionalImageUrls optional

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

AgeRangeMax optional

Maximum age for whom the item is intended.

AgeRangeMin optional

Minimum age for whom the item is intended.

Asin optional

Item's Amazon Standard Identification Number.

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.

ManufacturingCost optional

Cost to produce the item.

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

Id of the category that the item is located in.

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.

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 updated note. Returns an error if update parameters are invalid.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Catalogs/<CatalogId>/Items/<CatalogItemId>?Url={Url}&Name={Name}' \
  -X PUT \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

Example Response

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Catalogs/3656/Items/TV_55555"
}