Get Customer Checkout Settings

Retrieves existing customer checkout settings including the checkout type, which determines whether the customer must be logged in when placing an order. Also lists any custom customer checkout attributes.

GET /commerce/settings/checkout/customercheckoutsettings

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "customerCheckoutType": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

Checkout requirements for customers, for example, whether they must login before purchasing from your store. Other customized checkout requirements can be defined.

auditInfo · object

Show child attributes

customerCheckoutType · string | null

Checkout login setting. Value can be either "LoginOptional," where shoppers are prompted to sign in but are not required to do so, or "LoginRequired," where shopppers must login before purchasing.