checkout_types
Description
This property helper lets you know which checkout types we currently support. The checkout type defines how the customer will interact with the checkout, either as a named account or a guest (is_anonymous = 1). Note: subscriptions require customers to create accunts, so if your store is using subscriptions, you can not use a guest only checkout type.
The values
JSON object has the following properties
- default_account: Allow guest and customer accounts, default to account.
- default_guest: Allow guest and customer accounts, default to guest.
- account_only: Allow customer accounts only.
- guest_only: Allow guests only.
Interact with this resource
To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.
Actions
- GET
- View a checkout_types
- HEAD
- Get just the header response
- OPTIONS
- Get a response explaining which HTTP methods are supported
Properties
Property | Description | Type | Constraints |
---|---|---|---|
message | A small, human readable explanation of this property helper. | String | Read only |
values | JSON objects with the checkout types supported. The key values are the values you use for the Store resource's checkout_type property. |
JSON | Read only |
Example Representation
{ "_links": { "curies": [ { "name": "fx", "href": "https://api.foxycart.com/rels/{rel}", "templated": true } ], "self": { "href": "https://api.foxycart.com/property_helpers/checkout_types", "title": "List of valid checkout type values for the Store resource checkout_type setting." }, "fx:property_helpers": { "href": "https://api.foxycart.com/property_helpers", "title": "Property Helpers Home" } }, "message": "The values listed here are the correct values for the Store checkout_type field. The values are listed in the format value => description.", "values": { "default_account": "Allow guest and customer accounts, default to account", "default_guest": "Allow guest and customer accounts, default to guest", "account_only": "Allow customer accounts only", "guest_only": "Allow guests only" } }
<?xml version="1.0" encoding="UTF-8"?> <resource href="https://api.foxycart.com/property_helpers/checkout_types"> <link rel="self" href="https://api.foxycart.com/property_helpers/checkout_types" title="List of valid checkout type values for the Store resource checkout_type setting."/> <link rel="https://api.foxycart.com/rels/property_helpers" href="https://api.foxycart.com/property_helpers" title="Property Helpers Home"/> <message>The values listed here are the correct values for the Store checkout_type field. The values are listed in the format value =&gt; description.</message> <values> <default_account>Allow guest and customer accounts, default to account</default_account> <default_guest>Allow guest and customer accounts, default to guest</default_guest> <account_only>Allow customer accounts only</account_only> <guest_only>Allow guests only</guest_only> </values> </resource>
{ "properties": { "message": "The values listed here are the correct values for the Store checkout_type field. The values are listed in the format value => description.", "values": { "default_account": "Allow guest and customer accounts, default to account", "default_guest": "Allow guest and customer accounts, default to guest", "account_only": "Allow customer accounts only", "guest_only": "Allow guests only" } }, "links": [ { "rel": [ "self" ], "href": "https://api.foxycart.com/property_helpers/checkout_types" }, { "rel": [ "https://api.foxycart.com/rels/property_helpers" ], "href": "https://api.foxycart.com/property_helpers" } ] }
Zoomable Resources
This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.