GOgoogle
freelistingsprogram

GET /{merchantId}/freelistingsprogram/checkoutsettings

Gets Checkout settings for the given merchant. This includes information about review state, enrollment state and URL settings.

Request

  • Base URL
    https://shoppingcontent.googleapis.com/content/v2.1
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/content
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/content
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

merchantIdstring required

Required. The ID of the account.

Response

Successful response

reviewState'CHECKOUT_ON_MERCHANT_REVIEW_STATE_UNSPECIFIED' | 'IN_REVIEW' | 'APPROVED' | 'DISAPPROVED'

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 enrollment_state of ENROLLED before a review can begin for the merchant.

effectiveEnrollmentState'CHECKOUT_ON_MERCHANT_ENROLLMENT_STATE_UNSPECIFIED' | 'INACTIVE' | 'ENROLLED' | 'OPT_OUT'

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.

merchantIdstring int64

Required. The ID of the account.

effectiveReviewState'CHECKOUT_ON_MERCHANT_REVIEW_STATE_UNSPECIFIED' | 'IN_REVIEW' | 'APPROVED' | 'DISAPPROVED'

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.

enrollmentState'CHECKOUT_ON_MERCHANT_ENROLLMENT_STATE_UNSPECIFIED' | 'INACTIVE' | 'ENROLLED' | 'OPT_OUT'

Output only. Reflects the merchant enrollment state in Checkout feature.

Changes

No recorded changes to this operation across all 1 revision of this API.