ABCDEFGH
1
NotesParameter NameDynamic ValueFormatValies Values (if empty, N/A)Can Change When Product is UpdatedDescriptionJSON Example
2
Some parameters you may elect to include in your body can change if an action is modified or reversed. Use the Changes in Mods/Reversals column to view for which parameters this is the case.Type of Change{Operation}Enum • InsertYesWhat change is happening to the product. Products can be added to the catalog (Insert), updated (Update), or deleted (Delete)."change": "{Operation}"
3
• Update
4
• Delete
5
Product Catalog ID{CatalogId}IntegerNoImpact-assigned ID for the product catalog that contains the changed item."catalog_id": "{CatalogId}"
6
Program ID{CampaignId}IntegerNoImpact-assigned ID for the program that uploaded the change."program_id": "{CampaignId}"
7
Product Catalog Item ID{CatalogItemId}StringNoImpact-assigned ID for the product being changed."item_id": "{CatalogItemId}"
8
The JSON examples will show a key-value map using the Dynamic value. The key should align with your system's name for that parameter.Product Name{Name}StringYesName of the changed product."item_name": "{Name}"
9
Product Description{Description}StringYesDescription of the product."item_description": "{Description}"
10
Merchant Multipack{Multipack}Enum • YesYesWhether the item is contained in a merchant-defined (not manufacturer-defined) multipack."is_in_multipack": "{Multipack}"
11
• No
12
Bullet Points{Bullets}Array containing StringsNoShort descriptions of the product. Contains each individual bullet for the item, which are formatted as strings."bullet_points": "{Bullets}"
13
Categorization Labels{Labels}Array containing StringsYesTerms to help partners like you find the catalog that contains the changed item. Contains each individual label for the item, which are formatted as strings."search_labels": "{Labels}"
14
Manufacturer{Manufacturer}StringYesThe person or group that makes the item."manufacturer": "{Manufacturer}"
15
Item Listing URL{Url}StringYesURL that leads to the item's online store listing."listing_url": "{Url}"
16
Mobile Item Listing URL{MobileUrl}StringYesURL that leads to the item's mobile device-optimized online store listing."listing_url_mobile": "MobileUrl}"
17
Product Image URL{ImageUrl}StringYesURL that leads to the product's image."item_image_main": "{ImageUrl}"
18
Additional Product Image URLs{AdditionalImageUrls}Array containing StringsYesAny URLs that lead to additional image of the product. Contains each individual URL for the item's images, which are formatted as strings."item_image_additional": "{AdditionalImageUrls}"
19
Bid Value{ProductBid}StringYesHow much you will be paid for driving a conversion on the product."payment": "{ProductBid}"
20
Current Price{CurrentPrice}IntegerYesCurrent consumer price of the item."product_price_current": "{CurerntPrice}"
21
Original Price{OriginalPrice}IntegerYesOriginal consumer price of the item."product_price_original": "{OriginalPrice}"
22
Price Currency{Currency}EnumISO 4217YesWhat currency the item's price is listed in."listing_currency": "{Currency}"
23
Stock Availabilitiy{StockAvailability}Enum • InStockYesStatus of the product's backstock."product_availability": "{StockAvailability}"
24
• OutofStock
25
• BackOrder
26
• PreOrder
27
• LimitedAvailability
28
Estimated Shipping Date{EstimatedShipDate}DatetimeISO 8601YesDate and time that the item will begin shipping."ship_date": "{EstimatedDhipDate}"
29
Product Launch Date{LaunchDate}DatetimeISO 8601YesDate the item becomes available (or became available if already released)."product_launch_date": "{LaunchDate}"
30
Listing Expiration Date{ExpirationDate}DatetimeISO 8601YesDate that the item will be removed from the catalog."catalog_listing_expiry_date": "{ExpirationDate}"
31
GTIN{Gtin}IntegerGTIN FomatsYesThe item's Global Trade Identification Number."gtin": "{Gtin}"
32
GTIN Type{GtinType}Enum • EANYesWhat type of GTIN the item uses."gtin_type": "{GtinType}"
33
• UPC
34
• ISBN
35
• JAN
36
MPN{Mpn}IntegerYesThe item's Manufacturing Part Number."mpn": "{Mpn}"
37
ASIN{Asin}IntegerYesThe item's Amazon Standard Identificaiton Number."asin": "{Asin}"
38
Product Shipping Rate{ShippingRate}DecimalYesThe standard shipping rate of the of the item."ship_rate": "{ShippingRate}"
39
Product Shipping Weight{ShippingWeight}DecimalYesWeight of the shipping parcel."ship_weight": "{ShippingWeight}"
40
Shipping Weight Unit{ShippingWeightUnit}Enum • lbYesWhat the shipping parcel's weight is measured in."ship_weight_unit": "{ShippingWeightUnit}"
41
• oz
42
• g
43
• kg
44
• mg
45
Product Shipping Width{ShippingWidth}DecimalYesWidth of the shipping parcel."ship_width": "{ShippingWidth}"
46
Product Shipping Length{ShippingLength}DecimalYesLength of the shipping parcel."ship_length": "{ShippingLength}"
47
Product Shipping Height{ShippingHeight}DecimalYesHeight of the shipping parcel."ship_height": "{ShippingHeight}"
48
Shipping Size Dimension Unit{ShippingLengthUnit}Enum • inYesWhat the shipping parcel's size dimensions are measured in."ship_dimension_unit": "{ShippingLengthUnit}"
49
• cm
50
Special Shipping Labels{ShippingLabel}StringYesAny special labels the shipping providers should know (e.g., fragile)."ship_special_label": "{ShippingLabel}"
51
Original Catalog Format Category ID{OriginalFormatCategoryId}StringYesId of the category from the original format that the product was contained in (e.g., Google Merchant Center)"original_catalog_id": "{OriginalFormatCategoryId}"
52
Original Catalog Format Category{OriginalFormatCategory}StringYesThe original category that the product was contained in (e.g., Google Merchant Center)"original_catalog_name": "{OriginalFormatCategory}"
53
Current Category{Category}StringYesIf the brand is using a custom catalog format, this is their defined category that the item is associated with."custom_cat_format_category": "{Category}"
54
Parent Item{IsParent}BooleanYesWhether this item has child items"is_parent": "{IsParent}"
55
Parent Item SKU{ParentSku}StringYesIf the item has a parent item, the parent item's SKU."parent_item_sku": "{ParentSku}"
56
Parent Item Name{ParentName}StringYesIf the item has a parent item, the parent item's name."parent_item_name": "{ParentName}"
57
Intended Gender{Gender}Enum • MaleYesThe gender for whom the item is intended."intended_gender": "{Gender}"
58
• Female
59
• Unisex
60
Intended Age Group{AgeGroup}Enum • NewbornYesThe age group that the item targets."intended_age_group": "{AgeGroup}"
61
• Infant
62
• Toddler
63
• Kids
64
• Adult
65
For Adults{Adult}BooleanYesWhether the item is only intended for adults."for_adults": "{Adult}"
66
Product Colors{Colors}Array containing StringsYesWhat colors the item can come as. Contains each individual color for the item, which are formatted as strings."item_colors": "{Colors}"
67
Product Materials{Material}StringYesWhat material the item comes as."item_material": "{Material}"
68
Product Pattern{Pattern}StringYesWhat pattern the item comes as."item_pattern": "{Pattern}"
69
Product Size{Size}StringYesA numerical expression of the size of the item."item_size": "{Size}"
70
Product Size Unit{SizeUnit}Enum • MetersYesThe unit used for the product's size."item_size_unit": "{SizeUnit}"
71
• Decimenters
72
• Centimaters
73
• Millimeters
74
• Liters
75
• Deciliter
76
• Centiliter
77
• Milliliters
78
• Kilograms
79
• Grams
80
• Milligrams
81
• Yards
82
• Feet
83
• Inches
84
• Pounds
85
• Gallons
86
• Quarts
87
• Pints
88
• Ounces
89
Product Weight{Weight}DecimalYesA numerical expression of the weight of the item."item_weight": "{Weight}"
90
Product Weight Unit{WeightUnit}Enum • lbYesThe unit used for the product's weight."item_weight_unit": "{WeightUnit}"
91
• oz
92
• g
93
• kg
94
• mg
95
Product Selling Condition{Condition}Enum • NewYesWhat condition the item is in when it is sold."item_selling_condition": "{Condition}"
96
• Used
97
• Refurbished
98
• OEM
99
• OpenBox
100
Intended Minimum Age{AgeRangeMin}IntegerYesMinimum age for whom the item is intended."item_age_range_min": "{AgeRangeMin}"