commerce/settings/checkout/customercheckoutsettings

Use the Customer Checkout Settings resource to define login settings that apply when shoppers proceed to checkout.

JSON Example

CustomerCheckoutSettings Properties

Property Description
auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

customerCheckoutType

type: string

The type of customer checking out in the order such as a guest who has not logged in or a customer who has logged in. Valid strings are either "LoginOptional," where shoppers are prompted to sign in but are not required to do so, or "LoginRequired," where shopppers must login before purchasing.

Operations

Operation Name Request URI Description
GetCustomerCheckoutSettings GET customercheckoutsettings%3fresponseFields%3d%7bresponseFields%7d

Retrieves all checkout settings defined for the site: Payment settings, such as the payment gateway ID and credentials, supported credit cards, and more; Customer Checkout settings, such as whether login is required, and any custom attributes; and Order Processing settings, such as when payment is authorized and captured, and any custom attributes.

UpdateCustomerCheckoutSettings PUT customercheckoutsettings%3fresponseFields%3d%7bresponseFields%7d

Modifies existing site checkout settings. Modify Payment, Customer Checkout, and Order Processing settings in one PUT.