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.
Add a checkout link to your free listings
Stay organized with collections
Save and categorize content based on your preferences.
You can use the
checkoutSettings
attribute of free listings to provide a link for customers to go directly to the
checkout page. For more information, see add a checkout link for your free
listings.
You must provide specific information about your business and products before
you can opt in to the checkout program. You must meet the following criteria to
use checkoutSettings
:
Check the Google Merchant Center UI to see if you're already enrolled in the
free listings program. If you're not enrolled, complete the free listings
onboarding steps. Use the
following format for your checkout URLs:
https://mystore.com/path-to-product/{id}
When a customer clicks on the checkout URL in your free listing, {id}
is
automatically replaced with the offerId
of the product.
Add your checkout URL
You can use
freelistingsprogram.checkoutsettings.insert
to
add or update your checkout URL template. This call updates your checkout URL
template at the account level, and opts all valid offers into the checkout
feature.
POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/freelistingsprogram/checkoutsettings
Here's an example:
{
uri_settings: {
checkout_uri_template: "https://domain_name.com/custom_path/{id}"
}
}
View your current checkout URL
You can use
freelistingsprogram.checkoutsettings.get
to view your existing checkout URL. get
is read-only, and requires your
merchantId
. The get
method returns the corresponding checkout
resource.
GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/freelistingsprogram/checkoutsettings
Remove your checkout URL
You can remove your checkout URL by using
freelistingsprogram.checkoutsettings.delete
.
This opts all your offers out of the checkout feature.
DELETE https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/freelistingsprogram/checkoutsettings
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-08-13 UTC.
[null,null,["Last updated 2025-08-13 UTC."],[[["\u003cp\u003eGoogle is introducing the Merchant API beta, the new version of the Content API for Shopping.\u003c/p\u003e\n"],["\u003cp\u003eUse the \u003ccode\u003echeckoutSettings\u003c/code\u003e attribute to add a checkout link directly to your free listings, enhancing the customer shopping experience.\u003c/p\u003e\n"],["\u003cp\u003eTo utilize \u003ccode\u003echeckoutSettings\u003c/code\u003e, you need an active product feed in Google Merchant Center and be enrolled in the free listings program.\u003c/p\u003e\n"],["\u003cp\u003eImplement the checkout feature by adding or updating your checkout URL template using the provided API calls, allowing customers to purchase directly from your free listings.\u003c/p\u003e\n"],["\u003cp\u003eManage your checkout URL by viewing, updating, or removing it via the respective API calls, giving you control over the checkout process for your free listings.\u003c/p\u003e\n"]]],["The Merchant API beta, a new version of the Content API for Shopping, is introduced. To use `checkoutSettings` for free listings, users need an active product feed and enrollment in the free listings program. Merchants can add or update their checkout URL templates using `freelistingsprogram.checkoutsettings.insert`, view existing URLs with `get`, and remove them with `delete`. The checkout URL directs customers to a product's checkout page, automatically replacing `{id}` with the product's `offerId`.\n"],null,["# Add a checkout link to your free listings\n\nYou can use the\n[`checkoutSettings`](/shopping-content/reference/rest/v2.1/CheckoutSettings)\nattribute of free listings to provide a link for customers to go directly to the\ncheckout page. For more information, see [add a checkout link for your free\nlistings](//support.google.com/merchants/answer/13580732).\n\nYou must provide specific information about your business and products before\nyou can opt in to the checkout program. You must meet the following criteria to\nuse `checkoutSettings`:\n\n- Have an active [product\n feed](//support.google.com/merchants/answer/7439882?) in the [Google\n Merchant Center](//merchants.google.com/).\n- Your merchant account must be enrolled in the free listings program.\n\nCheck the Google Merchant Center UI to see if you're already enrolled in the\nfree listings program. If you're not enrolled, complete the [free listings\nonboarding](//support.google.com/merchants/answer/9455788) steps. Use the\nfollowing format for your checkout URLs: \n\n https://mystore.com/path-to-product/{id}\n\nWhen a customer clicks on the checkout URL in your free listing, `{id}` is\nautomatically replaced with the [`offerId`](/shopping-content/guides/products/product-id) of the product.\n\nAdd your checkout URL\n---------------------\n\nYou can use\n[`freelistingsprogram.checkoutsettings.insert`](/shopping-content/reference/rest/v2.1/freelistingsprogram.checkoutsettings/insert)to\nadd or update your checkout URL template. This call updates your checkout URL\ntemplate at the account level, and opts all valid offers into the checkout\nfeature. \n\n POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/freelistingsprogram/checkoutsettings\n\nHere's an example: \n\n {\n uri_settings: {\n checkout_uri_template: \"https://domain_name.com/custom_path/{id}\"\n }\n }\n\nView your current checkout URL\n------------------------------\n\nYou can use\n[`freelistingsprogram.checkoutsettings.get`](/shopping-content/reference/rest/v2.1/freelistingsprogram.checkoutsettings/get)\nto view your existing checkout URL. `get` is read-only, and requires your\n`merchantId`. The `get` method returns the corresponding `checkout` resource. \n\n GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/freelistingsprogram/checkoutsettings\n\nRemove your checkout URL\n------------------------\n\nYou can remove your checkout URL by using\n[`freelistingsprogram.checkoutsettings.delete`](/shopping-content/reference/rest/v2.1/freelistingsprogram.checkoutsettings/delete).\nThis opts all your offers out of the checkout feature. \n\n DELETE https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/freelistingsprogram/checkoutsettings"]]