Method: freelistingsprogram.checkoutsettings.insert

Page Summary

• Enrolls a merchant in the Checkout program, enabling streamlined checkout experiences for their products.

• Requires an HTTP POST request to a specific endpoint with the merchant ID as a path parameter.

• The request body must contain UrlSettings to indicate Checkout enrollment, using the provided JSON structure.

• Upon successful enrollment, the response returns a CheckoutSettings object confirming the program activation.

• Utilizes OAuth 2.0 for authorization, requiring the https://www.googleapis.com/auth/content scope.

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
• Authorization scopes
• Try it!

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.