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.
CheckoutSettings
Stay organized with collections
Save and categorize content based on your preferences.
CheckoutSettings for a specific merchant ID.
| Fields |
merchantId |
string (int64 format)
Required. The ID of the account.
|
uriSettings |
object (UrlSettings)
URL settings for cart or checkout URL.
|
effectiveUriSettings |
object (UrlSettings)
The effective value of url_settings for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
|
enrollmentState |
enum (CheckoutEnrollmentState)
Output only. Reflects the merchant enrollment state in Checkout feature.
|
reviewState |
enum (CheckoutReviewState)
Output only. Reflects the merchant review state in Checkout feature. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as ENROLLED can be in the following review states: IN_REVIEW, APPROVED or DISAPPROVED. A merchant must be in an enrollmentState of ENROLLED before a review can begin for the merchant.
|
effectiveEnrollmentState |
enum (CheckoutEnrollmentState)
Output only. The effective value of enrollment state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
|
effectiveReviewState |
enum (CheckoutReviewState)
Output only. The effective value of review state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
|
CheckoutEnrollmentState
Enum indicating the enrollment state of merchant in Checkout program. LINT.IfChange(CheckoutOnMerchantEnrollmentState)
| Enums |
CHECKOUT_ON_MERCHANT_ENROLLMENT_STATE_UNSPECIFIED |
Default enrollment state when enrollment state is not specified. |
INACTIVE |
Merchant has not enrolled into the feature. |
ENROLLED |
Merchant has enrolled into the feature by providing either an account level URL or checkout URLs as part of their feed. |
OPT_OUT |
Merchant has previously enrolled but opted out of the feature. |
CheckoutReviewState
Enum indicating the review state of merchant in Checkout program. LINT.IfChange(CheckoutReviewState)
| Enums |
CHECKOUT_ON_MERCHANT_REVIEW_STATE_UNSPECIFIED |
Default review state when review state is not specified. |
IN_REVIEW |
Merchant provided URLs are being reviewed for data quality issues. |
APPROVED |
Merchant account has been approved. Indicates the data quality checks have passed. |
DISAPPROVED |
Merchant account has been disapproved due to data quality issues. |
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\u003e\u003ccode\u003eCheckoutSettings\u003c/code\u003e defines URL and enrollment settings for a specific merchant to participate in the Google Checkout program.\u003c/p\u003e\n"],["\u003cp\u003eMerchants can enroll in the program by providing account-level or feed-level checkout URLs, which are subject to data quality review.\u003c/p\u003e\n"],["\u003cp\u003eEnrollment and review states for a merchant can be \u003ccode\u003eINACTIVE\u003c/code\u003e, \u003ccode\u003eENROLLED\u003c/code\u003e, \u003ccode\u003eOPT_OUT\u003c/code\u003e, \u003ccode\u003eIN_REVIEW\u003c/code\u003e, \u003ccode\u003eAPPROVED\u003c/code\u003e, or \u003ccode\u003eDISAPPROVED\u003c/code\u003e, reflecting their participation status in the program.\u003c/p\u003e\n"],["\u003cp\u003eEffective settings inherit from account-level settings or the parent account if not explicitly defined.\u003c/p\u003e\n"]]],["The core information defines `CheckoutSettings` for a merchant, including their `merchantId`, URL settings, and enrollment and review states. `CheckoutEnrollmentState` reflects if a merchant is `INACTIVE`, `ENROLLED`, or has `OPT_OUT` from the checkout feature. `CheckoutReviewState` indicates if the merchant is `IN_REVIEW`, `APPROVED`, or `DISAPPROVED` based on data quality checks. Effective states reflect account or parent level settings when available, otherwise, the direct value will be the effective state.\n"],null,["# CheckoutSettings\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [CheckoutEnrollmentState](#CheckoutEnrollmentState)\n- [CheckoutReviewState](#CheckoutReviewState)\n\n`CheckoutSettings` for a specific merchant ID.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"merchantId\": string, \"uriSettings\": { object (/shopping-content/reference/rest/v2.1/UrlSettings) }, \"effectiveUriSettings\": { object (/shopping-content/reference/rest/v2.1/UrlSettings) }, \"enrollmentState\": enum (/shopping-content/reference/rest/v2.1/CheckoutSettings#CheckoutEnrollmentState), \"reviewState\": enum (/shopping-content/reference/rest/v2.1/CheckoutSettings#CheckoutReviewState), \"effectiveEnrollmentState\": enum (/shopping-content/reference/rest/v2.1/CheckoutSettings#CheckoutEnrollmentState), \"effectiveReviewState\": enum (/shopping-content/reference/rest/v2.1/CheckoutSettings#CheckoutReviewState) } ``` |\n\n| Fields ||\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `merchantId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the account. |\n| `uriSettings` | `object (`[UrlSettings](/shopping-content/reference/rest/v2.1/UrlSettings)`)` URL settings for cart or checkout URL. |\n| `effectiveUriSettings` | `object (`[UrlSettings](/shopping-content/reference/rest/v2.1/UrlSettings)`)` The effective value of `url_settings` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account. |\n| `enrollmentState` | `enum (`[CheckoutEnrollmentState](/shopping-content/reference/rest/v2.1/CheckoutSettings#CheckoutEnrollmentState)`)` Output only. Reflects the merchant enrollment state in `Checkout` feature. |\n| `reviewState` | `enum (`[CheckoutReviewState](/shopping-content/reference/rest/v2.1/CheckoutSettings#CheckoutReviewState)`)` Output only. Reflects the merchant review state in `Checkout` feature. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an enrollmentState of `ENROLLED` before a review can begin for the merchant. |\n| `effectiveEnrollmentState` | `enum (`[CheckoutEnrollmentState](/shopping-content/reference/rest/v2.1/CheckoutSettings#CheckoutEnrollmentState)`)` Output only. The effective value of enrollment state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account. |\n| `effectiveReviewState` | `enum (`[CheckoutReviewState](/shopping-content/reference/rest/v2.1/CheckoutSettings#CheckoutReviewState)`)` Output only. The effective value of review state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account. |\n\nCheckoutEnrollmentState\n-----------------------\n\nEnum indicating the enrollment state of merchant in `Checkout` program. LINT.IfChange(CheckoutOnMerchantEnrollmentState)\n\n| Enums ||\n|-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|\n| `CHECKOUT_ON_MERCHANT_ENROLLMENT_STATE_UNSPECIFIED` | Default enrollment state when enrollment state is not specified. |\n| `INACTIVE` | Merchant has not enrolled into the feature. |\n| `ENROLLED` | Merchant has enrolled into the feature by providing either an account level URL or checkout URLs as part of their feed. |\n| `OPT_OUT` | Merchant has previously enrolled but opted out of the feature. |\n\nCheckoutReviewState\n-------------------\n\nEnum indicating the review state of merchant in `Checkout` program. LINT.IfChange(CheckoutReviewState)\n\n| Enums ||\n|-------------------------------------------------|------------------------------------------------------------------------------------|\n| `CHECKOUT_ON_MERCHANT_REVIEW_STATE_UNSPECIFIED` | Default review state when review state is not specified. |\n| `IN_REVIEW` | Merchant provided URLs are being reviewed for data quality issues. |\n| `APPROVED` | Merchant account has been approved. Indicates the data quality checks have passed. |\n| `DISAPPROVED` | Merchant account has been disapproved due to data quality issues. |"]]