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.
Method: freelistingsprogram.checkoutsettings.insert
Stay organized with collections
Save and categorize content based on your preferences.
Enrolls merchant in Checkout program.
HTTP request
POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/freelistingsprogram/checkoutsettings
Path parameters
| Parameters |
merchantId |
string (int64 format)
Required. The ID of the account.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"uriSettings": {
object (UrlSettings)
}
} |
| Fields |
uriSettings |
object (UrlSettings)
Required. The UrlSettings for the request. The presence of URL settings indicates Checkout enrollment.
|
Response body
If successful, the response body contains a newly created instance of CheckoutSettings.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
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\u003eEnrolls a merchant in the Checkout program, enabling streamlined checkout experiences for their products.\u003c/p\u003e\n"],["\u003cp\u003eRequires an HTTP POST request to a specific endpoint with the merchant ID as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain UrlSettings to indicate Checkout enrollment, using the provided JSON structure.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful enrollment, the response returns a CheckoutSettings object confirming the program activation.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes OAuth 2.0 for authorization, requiring the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This content outlines how to enroll a merchant in the `Checkout` program via an HTTP POST request. The request, directed to `https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/freelistingsprogram/checkoutsettings`, requires the `merchantId` as a path parameter. The request body must contain a `uriSettings` object, indicating `Checkout` enrollment. Successful requests return a `CheckoutSettings` instance, and authentication requires the `https://www.googleapis.com/auth/content` OAuth scope.\n"],null,["# Method: freelistingsprogram.checkoutsettings.insert\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nEnrolls merchant in `Checkout` program.\n\n### HTTP request\n\n`POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/freelistingsprogram/checkoutsettings`\n\n### Path parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------|\n| `merchantId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the account. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------|\n| ``` { \"uriSettings\": { object (/shopping-content/reference/rest/v2.1/UrlSettings) } } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `uriSettings` | `object (`[UrlSettings](/shopping-content/reference/rest/v2.1/UrlSettings)`)` Required. The `UrlSettings` for the request. The presence of URL settings indicates `Checkout` enrollment. |\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [CheckoutSettings](/shopping-content/reference/rest/v2.1/CheckoutSettings).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]