Updates the specified note by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Bulk updates to a product catalog can also be performed via API. To do so, the Body Type of the call must be set to raw
and the Content Type must be set to application/json
. A JSON file can then be placed in the body of the call—the parameters found in this file (see the example below) will be used to update each item. The item's CatalogItemId
must be used in each object within the JSON file so that the correct items are updated.
Example bulk update:
[{"CatalogItemId":"ABC-123456", "Name":"Particle Collider", "Url":"https://www.example.com", "CurrentPrice":"12.00"},{"CatalogItemId":"ABC-45678", "Name":"Particle Collider1", "Url":"https://www.example.com", "CurrentPrice":"13.00"}].
Please note that impact.com allows a maximum of 500 products per update.
Single product update allows 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.
Example single update:
{"CatalogItemId":"ABC-123456", "Name":"Particle Collider", "Url":"
For both single and bulk updates, field names and field values must be in double quotes.
Parameters
Adult
optional
Adult
optionalThe item is only intended for adults.
AgeGroup
optional
AgeGroup
optionalAge group that the item targets.
View possible enum value | |
---|---|
Newborn | Product is meant for newborns. |
Infant | Product is meant for infants. |
Toddler | Product is meant for toddlers. |
Kids | Product is meant for kids. |
Adult | Product is meant for adults. |
Category
optional
Category
optionalWhat group or kind of products the item is associated with.
Colors
optional
Colors
optionalComma-separated list of the primary color(s) of the item.
Condition
optional
Condition
optionalWhat condition the item is in when it is sold.
View possible enum value | |
---|---|
New | Item is brand new. |
Used | Item had a previous owner. |
Refurbished | Item had a previous owner and was touched up before being sold again. |
Currency
optional
Currency
optionalWhat currency the item's price is listed in. See ISO 4217.
Description
optional
Description
optionalDescription of the item, like information about it or what it does.
ImageUrl
optional
ImageUrl
optionalURL that leads to the item's image.
PromotionIds
optional
PromotionIds
optionalList 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
optionalInventory count of the item.
Labels
optional
Labels
optionalKey terms to help partners find a particular catalog in impact.com. Can add multiple labels. Use commas between each new label.
LaunchDate
optional
LaunchDate
optionalDate the item becomes available (or became available if already released). See ISO 8601.
Manufacturer
optional
Manufacturer
optionalThe person or group that makes the item.
Material
optional
Material
optionalComma-separated list of the primary material(s) of the item.
Name
optional
Name
optionalName of the item.
OriginalPrice
optional
OriginalPrice
optionalOriginal price of the item.
Pattern
optional
Pattern
optionalPattern of the item.
ProductBid
optional
ProductBid
optionalHow much the partner will be paid for driving a conversion on the product.
ShippingHeight
optional
ShippingHeight
optionalHeight of the shipping parcel.
ShippingLabel
optional
ShippingLabel
optionalLabel of the shipping parcel.
ShippingLength
optional
ShippingLength
optionalLength of the shipping parcel.
ShippingLengthUnit
optional
ShippingLengthUnit
optionalMeasurement unit of the length of the shipping parcel.
View possible enum values | |
---|---|
in | Imperial inches |
cm | Metric centimeters |
ShippingRate
optional
ShippingRate
optionalHow much shipping the item costs.
ShippingWeight
optional
ShippingWeight
optionalWeight of the shipping parcel.
ShippingWeightUnit
optional
ShippingWeightUnit
optionalMeasurement of the weight of the shipping parcel.
View possible enum values | |
---|---|
lb | Imperial pounds |
oz | Imperial ounces |
g | Metric grams |
kg | Metric kilograms |
mg | Metric milligrams |
ShippingWidth
optional
ShippingWidth
optionalWidth of the shipping parcel.
StockAvailability
optional
StockAvailability
optionalStatus of the product's backstock.
View possible enum values | |
---|---|
InStock | Product is in stock. |
OutofStock | Product is out of stock. |
BackOrder | Product is currently back-ordered. |
PreOrder | Product is available for pre-order. |
LimitedAvailability | Product is available in limited quantities. |
Url
optional
Url
optionalURL that leads to the item's online store listing.
More parameters
Click to view...
AdditionalImageUrls
optional
AdditionalImageUrls
optionalComma-separated list of URLs that point to more images of the product.
AgeRangeMax
optional
AgeRangeMax
optionalMaximum age for whom the item is intended.
AgeRangeMin
optional
AgeRangeMin
optionalMinimum age for whom the item is intended.
Asin
optional
Asin
optionalItem's Amazon Standard Identification Number.
EstimatedShipDate
optional
EstimatedShipDate
optionalDate that the item will being shipping. See ISO 8601.
ExpirationDate
optional
ExpirationDate
optionalDate that the item will be removed from the catalog. See ISO 8601.
Gender
optional
Gender
optionalGender for whom the item is intended.
View possible enum values | |
---|---|
Male | Product is meant for male-identifying customers. |
Female | Product is meant for female-identifying customers. |
Unisex | Product is meant for all customers. |
Gtin
optional
Gtin
optionalItem's Global Trade Item Number.
GtinType
optional
GtinType
optionalType of GTIN number the item uses.
ManufacturingCost
optional
ManufacturingCost
optionalCost to produce the item.
MobileUrl
optional
MobileUrl
optionalThe URI that points directly to the item's mobile listing.
Money1
optional
Money1
optionalGeneral numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.
Money2
optional
Money2
optionalGeneral numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.
Money3
optional
Money3
optionalGeneral numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.
Mpn
optional
Mpn
optionalItem's Manufacturing Part Number.
Multipack
optional
Multipack
optionalIf the item represents a merchant-defined multi-pack.
Numeric1
optional
Numeric1
optionalGeneral numeral field that accepts strings of any numeric data you want to send. Appears in your reports.
Numeric2
optional
Numeric2
optionalGeneral numeral field that accepts strings of any numeric data you want to send. Appears in your reports.
Numeric3
optional
Numeric3
optionalGeneral numeral field that accepts strings of any numeric data you want to send. Appears in your reports.
OriginalFormatCategory
optional
OriginalFormatCategory
optionalCategory breadcrumb to locate the item.
OriginalFormatCategoryId
optional
OriginalFormatCategoryId
optionalId of the category that the item is located in.
IsParent
optional
IsParent
optionalItem that represents a bundle of items.
ParentName
optional
ParentName
optionalIf the item has a parent item, the parent item's name.
ParentSku
optional
ParentSku
optionalIf the item has a parent item, the parent item's SKU.
Size
optional
Size
optionalSize of the item.
SizeUnit
optional
SizeUnit
optionalItem'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
Text1
optionalGeneral text field that accepts strings of any text data you want to send. Appears in your reports.
Text2
optional
Text2
optionalGeneral text field that accepts strings of any text data you want to send. Appears in your reports.
Text3
optional
Text3
optionalGeneral text field that accepts strings of any text data you want to send. Appears in your reports.
Weight
optional
Weight
optionalWeight of the item.
WeightUnit
optional
WeightUnit
optionalItem's weight's unit of measurement.
View possible enum values | |
---|---|
lb | Imperial pounds |
oz | Imperial ounces |
g | Metric grams |
kg | Metric kilograms |
mg | Metric 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/4000/Items/55555' \
-X PUT \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json' \
-d 'Adult=false' \
-d 'Name=Hammer' \
-d 'StockAvailability="BackOrder"' \
-d 'Gtin=14141414141414'
curl 'https://api.impact.com/Advertisers/<AccountSID>/Catalogs/4000/Items' \
-X PUT \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '[{"CatalogItemId:"12345", "Name":"Anvil"}, {"CatalogitemId":"67890", "CurrentPrice":"50.00"}]'
Example Response
{
"Status": "OK",
"Uri": "/Advertisers/<AccoutnSID>/Catalogs/4000/Items/55555"
}
{
"Status": "OK",
"Uri": "/Advertisers/<AccountSID>/Catalogs/4000/BulkUpdate/Products updated successfully.json"
}