attributeMetadata/customerAddress

GET

/V1/attributeMetadata/customerAddress

Get all attribute metadata.

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'http:///V1/attributeMetadata/customerAddress'

响应示例

200 - 示例 1

[
    {
        "attribute_code": "string",
        "backend_type": "string",
        "data_model": "string",
        "frontend_class": "string",
        "frontend_input": "string",
        "frontend_label": "string",
        "input_filter": "string",
        "is_filterable_in_grid": true,
        "is_searchable_in_grid": true,
        "is_used_in_grid": true,
        "is_visible_in_grid": true,
        "multiline_count": 0,
        "note": "string",
        "options": [
            {
                "label": "string",
                "options": [
                    {}
                ],
                "value": "string"
            }
        ],
        "required": true,
        "sort_order": 0,
        "store_label": "string",
        "system": true,
        "user_defined": true,
        "validation_rules": [
            {
                "name": "string",
                "value": "string"
            }
        ],
        "visible": true
    }
]

请求参数

无

返回响应

🟢200成功

application/json

200 Success.

Body

array of:

attribute_code

string

必需

Code of the attribute.

backend_type

string

必需

Backend type.

data_model

string

必需

Data model for attribute.

frontend_class

string

必需

Class which is used to display the attribute on frontend.

frontend_input

string

必需

HTML for input element.

frontend_label

string

必需

Label which supposed to be displayed on frontend.

input_filter

string

必需

Template used for input (e.g. "date")

is_filterable_in_grid

boolean

可选

It is filterable in customer grid

is_searchable_in_grid

boolean

可选

It is searchable in customer grid

is_used_in_grid

boolean

可选

It is used in customer grid

is_visible_in_grid

boolean

可选

It is visible in customer grid

multiline_count

integer

必需

Of lines of the attribute value.

note

string

必需

The note attribute for the element.

options

array[object (customer-data-option-interface) {3}]

必需

Options of the attribute (key => value pairs for select)

label

string

必需

Option label

options

array[object (customer-data-option-interface) {3}]

可选

Nested options

value

string

可选

Option value

required

boolean

必需

Attribute is required.

sort_order

integer

必需

Attributes sort order.

store_label

string

必需

Label of the store.

system

boolean

必需

This is a system attribute.

user_defined

boolean

必需

Current attribute has been defined by a user.

validation_rules

array[object (customer-data-validation-rule-interface) {2}]

必需

Validation rules.

name

string

必需

Validation rule name

value

string

必需

Validation rule value

visible

boolean

必需

Attribute is visible on frontend.

🟠401没有权限

🔴500服务器错误

修改于 2024-11-22 03:29:06

products/base-prices

products/base-prices-information