Skip to content

Fields Listing

Endpoint: https://api.youcan.shop/settings/checkout/fields/

Method: GET

Required Scopes

  • view-checkout-fields

Response

Array of field object.

[200]

json
[
    {
        "custom": false,
        "name": "first_name",
        "display_name": "First name",
        "placeholder": "First name",
        "type": "text",
        "options": [],
        "required": true,
        "enabled": true
    },
    {
        "custom": false,
        "name": "last_name",
        "display_name": "Last name",
        "placeholder": "Last name",
        "type": "text",
        "options": [],
        "required": true,
        "enabled": false
    },
    {
        "custom": false,
        "name": "email",
        "display_name": "Email",
        "placeholder": "Email",
        "type": "text",
        "options": [],
        "required": true,
        "enabled": false
    },
    {
        "custom": false,
        "name": "phone",
        "display_name": "Phone",
        "placeholder": "Phone",
        "type": "text",
        "options": [],
        "required": true,
        "enabled": false
    },
    {
        "custom": false,
        "name": "phone_or_email",
        "display_name": "Phone or email",
        "placeholder": "Phone or email",
        "type": "text",
        "options": [],
        "required": true,
        "enabled": false
    },
    {
        "custom": false,
        "name": "company",
        "display_name": "Company",
        "placeholder": "Company",
        "type": "text",
        "options": [],
        "required": true,
        "enabled": false
    },
    {
        "custom": false,
        "name": "country",
        "display_name": "Country",
        "placeholder": "Country",
        "type": "text",
        "options": [],
        "required": true,
        "enabled": false
    },
    {
        "custom": false,
        "name": "region",
        "display_name": "Region",
        "placeholder": "Region",
        "type": "text",
        "options": [],
        "required": true,
        "enabled": false
    },
    {
        "custom": false,
        "name": "city",
        "display_name": "City",
        "placeholder": "City",
        "type": "text",
        "options": [],
        "required": true,
        "enabled": false
    },
    {
        "custom": false,
        "name": "password",
        "display_name": "Password",
        "placeholder": "Password",
        "type": "password",
        "options": [],
        "required": true,
        "enabled": true
    },
    {
        "custom": true,
        "name": "custom_field_w5Goh2hCAHbF9qhq",
        "display_name": "Middle Name",
        "placeholder": "Middle Name",
        "type": "text",
        "required": true,
        "enabled": true
    },
    {
        "custom": true,
        "name": "custom_field_w5Goh2hCAHbF9qhq",
        "display_name": "State",
        "placeholder": "State",
        "type": "select",
        "options": [
            "LA",
            "NY"
        ],
        "required": true,
        "enabled": true
    }
]