CheckoutSettings

CheckoutSettings for a specific merchant ID.

JSON representation
{
  "merchantId": string,
  "uriSettings": {
    object (UrlSettings)
  },
  "effectiveUriSettings": {
    object (UrlSettings)
  },
  "enrollmentState": enum (CheckoutEnrollmentState),
  "reviewState": enum (CheckoutReviewState),
  "effectiveEnrollmentState": enum (CheckoutEnrollmentState),
  "effectiveReviewState": enum (CheckoutReviewState)
}
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_UNSPECIFIEDDefault enrollment state when enrollment state is not specified.
INACTIVEMerchant has not enrolled into the feature.
ENROLLEDMerchant has enrolled into the feature by providing either an account level URL or checkout URLs as part of their feed.
OPT_OUTMerchant 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_UNSPECIFIEDDefault review state when review state is not specified.
IN_REVIEWMerchant provided URLs are being reviewed for data quality issues.
APPROVEDMerchant account has been approved. Indicates the data quality checks have passed.
DISAPPROVEDMerchant account has been disapproved due to data quality issues.