v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13125317428.7 KB
products

Updates an existing product in your Merchant Center account. Only updates attributes provided in the request.

patch/{merchantId}/products/{productId}

Path parameters

merchantIdstring required

The ID of the account that contains the product. This account cannot be a multi-client account.

productIdstring required

The REST ID of the product for which to update.

Query parameters

updateMaskstring

The comma-separated list of product attributes to be updated. Example: "title,salePrice". Attributes specified in the update mask without a value specified in the body will be deleted from the product. You must specify the update mask to delete attributes. Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged.

Request body

promotionIdsstring[]

The unique ID of a promotion.

colorstring

Color of the item.

isBundleboolean

Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.

virtualModelLinkstring

URL of the 3D model of the item to provide more visuals.

idstring

The REST ID of the product. Content API methods that operate on products take this as their productId parameter. The REST ID for a product has one of the 2 forms channel:contentLanguage: targetCountry: offerId or channel:contentLanguage:feedLabel: offerId.

titlestring

Title of the item.

genderstring

Target gender of the item.

excludedDestinationsstring[]

The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.

customLabel1string

Custom label 1 for custom grouping of items in a Shopping campaign.

channelstring

Required. The item's channel (online or local). Acceptable values are: - "local" - "online"

adultboolean

Should be set to true if the item is targeted towards adults.

sizeTypestring

The cut of the item. Recommended for apparel items.

expirationDatestring

Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future.

multipackstring int64

The number of identical products in a merchant-defined multipack.

transitTimeLabelstring

The transit time label of the product, used to group product in account-level transit time tables.

displayAdsValuenumber double

Offer margin for dynamic remarketing campaigns.

taxCategorystring

The tax category of the product, used to configure detailed tax nexus in account-level tax settings.

productTypesstring[]

Categories of the item (formatted as in product data specification).

gtinstring

Global Trade Item Number (GTIN) of the item.

mpnstring

Manufacturer Part Number (MPN) of the item.

disclosureDatestring

The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See Disclosure date for more information.

minHandlingTimestring int64

Minimal product handling time (in business days).

shoppingAdsExcludedCountriesstring[]

List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.

mobileLinkstring

URL for the mobile-optimized version of your item's landing page.

maxHandlingTimestring int64

Maximal product handling time (in business days).

sellOnGoogleQuantitystring int64

The quantity of the product that is available for selling on Google. Supported only for online products.

customLabel3string

Custom label 3 for custom grouping of items in a Shopping campaign.

lifestyleImageLinksstring[]

Additional URLs of lifestyle images of the item. Used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.

descriptionstring

Description of the item.

feedLabelstring

Feed label for the item. Either targetCountry or feedLabel is required. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).

shippingLabelstring

The shipping label of the product, used to group product in account-level shipping rules.

contentLanguagestring

Required. The two-letter ISO 639-1 language code for the item.

googleProductCategorystring

Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.

displayAdsLinkstring

URL directly to your item's landing page for dynamic remarketing campaigns.

externalSellerIdstring

Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.

linkTemplatestring

URL template for merchant hosted local storefront.

availabilitystring

Availability status of the item.

conditionstring

Condition or state of the item.

materialstring

The material of which the item is made.

sourcestring

Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "api" - "crawl" - "feed"

pausestring

Publication of this item should be temporarily paused. Acceptable values are: - "ads"

displayAdsIdstring

An identifier for an item for dynamic remarketing campaigns.

productHighlightsstring[]

Bullet points describing the most relevant highlights of a product.

customLabel2string

Custom label 2 for custom grouping of items in a Shopping campaign.

ageGroupstring

Target age group of the item.

mobileLinkTemplatestring

URL template for merchant hosted local storefront optimized for mobile devices.

brandstring

Brand of the item.

pickupSlastring

Item store pickup timeline. Acceptable values are: - "same day" - "next day" - "2-day" - "3-day" - "4-day" - "5-day" - "6-day" - "7-day" - "multi-week"

includedDestinationsstring[]

The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations.

displayAdsTitlestring

Title of an item for dynamic remarketing campaigns.

targetCountrystring

Required. The CLDR territory code for the item's country of sale.

itemGroupIdstring

Shared identifier for all variants of the same product.

patternstring

The item's pattern (for example, polka dots).

adsRedirectstring

Allows advertisers to override the item URL when the product is shown within the context of Product Ads.

identifierExistsboolean

False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.

energyEfficiencyClassstring

The energy efficiency class as defined in EU directive 2010/30/EU.

maxEnergyEfficiencyClassstring

The energy efficiency class as defined in EU directive 2010/30/EU.

kindstring

Identifies what kind of resource this is. Value: the fixed string "content#product"

salePriceEffectiveDatestring

Date range during which the item is on sale (see product data specification ).

sizeSystemstring

System in which the size is specified. Recommended for apparel items.

canonicalLinkstring

URL for the canonical version of your item's landing page.

customLabel0string

Custom label 0 for custom grouping of items in a Shopping campaign.

additionalImageLinksstring[]

Additional URLs of images of the item.

linkstring

URL directly linking to your item's page on your website.

displayAdsSimilarIdsstring[]

Advertiser-specified recommendations.

offerIdstring

Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. Note: Content API methods that operate on products take the REST ID of the product, not this identifier.

pickupMethodstring

The pick up option for the item. Acceptable values are: - "buy" - "reserve" - "ship to store" - "not supported"

sizesstring[]

Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value (see size definition).

adsGroupingstring

Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.

additionalSizeTypestring

Additional cut of the item. Used together with size_type to represent combined size types for apparel items.

minEnergyEfficiencyClassstring

The energy efficiency class as defined in EU directive 2010/30/EU.

availabilityDatestring

The day a pre-ordered product becomes available for delivery, in ISO 8601 format.

adsLabelsstring[]

Similar to ads_grouping, but only works on CPC.

customLabel4string

Custom label 4 for custom grouping of items in a Shopping campaign.

imageLinkstring

URL of an image of the item.

Response

Successful response