rocket
Meet
Merchant API
- the official successor to Content API for Shopping.
update
Get the latest
on new Merchant API features, bug fixes, and updates.
add_alert
Note: Content API for Shopping will be sunset on August 18, 2026.
UrlSettings
Stay organized with collections
Save and categorize content based on your preferences.
Specifications related to the Checkout URL. The UriTemplate is of the form https://www.mystore.com/checkout?item_id={id}
where {id} will be automatically replaced with data from the merchant account with this attribute offerId
| JSON representation |
{
// Union field url_template can be only one of the following:
"checkoutUriTemplate": string,
"cartUriTemplate": string
// End of list of possible types for union field url_template.
} |
| Fields |
Union field url_template. url_template can be only one of the following:
|
checkoutUriTemplate |
string
URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
|
cartUriTemplate |
string
URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eCheckout\u003c/code\u003e URL directs buyers to the merchant's checkout page with the specified item.\u003c/p\u003e\n"],["\u003cp\u003eThe URL template uses placeholders that are automatically replaced with the merchant's \u003ccode\u003eofferId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003echeckoutUriTemplate\u003c/code\u003e field provides the URL template for the checkout process.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecartUriTemplate\u003c/code\u003e field (if available) provides the URL template for adding an item to the merchant's cart.\u003c/p\u003e\n"]]],["The `Checkout` URL utilizes a `UriTemplate` like `https://www.mystore.com/checkout?item_id={id}`, with `{id}` replaced by the merchant's `offerId`. The `url_template` field, a union type, can be either `checkoutUriTemplate` or `cartUriTemplate`. `checkoutUriTemplate` directs buyers to the checkout page, while `cartUriTemplate` leads to the merchant's cart page, each with the selected item included. Only one of them can be defined.\n"],null,["# UrlSettings\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nSpecifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}`\n\nwhere `{id}` will be automatically replaced with data from the merchant account with this attribute [offerId](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id)\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { // Union field `url_template` can be only one of the following: \"checkoutUriTemplate\": string, \"cartUriTemplate\": string // End of list of possible types for union field `url_template`. } ``` |\n\n| Fields ||\n|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Union field `url_template`. `url_template` can be only one of the following: ||\n| `checkoutUriTemplate` | `string` URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. |\n| `cartUriTemplate` | `string` URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. |"]]