Filtering

Get Custom Field by filters

GET https://{{accountSlug}}.myeshopbox.com/api/platform/v1/property/search

This endpoint allows you to get custom field by applying filters.

Query Parameters

Name
Type
Description

isUnique

string

It states whether the property is unique or not.

fieldType

string

It is the data type of property.

scope

string

It is the name of the module to which property can be assigned.

label

string

It is the name with which the property will be identified.

internalName

string

It is the unique name of the property within a workspace

sortby

string

Whether the cake should be gluten-free or not.

Headers

Name
Type
Description

Authorization

string

The Bearer token to grant access to the API.

{
    "data": [
        {
            "label": "style code",
            "internalName": "stylecode4",
            "description": "this is style code property",
            "isUnique": "yes",
            "fieldType": "multi_select",
            "options": [
                "rock",
                "classy",
                "bestseller"
            ],
            "scope": [
                "recall consignment",
                "product"
            ],
            "createdAt": "2020-03-16T16:31:24.217+05:30",
            "updatedAt": "2020-03-16T16:31:24.217+05:30"
        },
        {
            "label": "style code",
            "internalName": "stylecode3",
            "description": "this is style code property",
            "isUnique": "yes",
            "fieldType": "multi_select",
            "options": [
                "rock",
                "classy",
                "bestseller"
            ],
            "scope": [
                "recall consignment",
                "product"
            ],
            "createdAt": "2020-03-16T16:11:51.371+05:30",
            "updatedAt": "2020-03-16T16:11:51.371+05:30"
        },
        {
            "label": "style code",
            "internalName": "stylecode",
            "description": "this is style code property",
            "isUnique": "yes",
            "fieldType": "multi_select",
            "options": [
                "rock",
                "classy",
                "bestseller"
            ],
            "scope": [
                "recall consignment",
                "product"
            ],
            "createdAt": "2020-03-16T13:22:56.018+05:30",
            "updatedAt": "2020-03-16T13:22:56.018+05:30"
        },
        {
            "label": "fabric",
            "internalName": "style type",
            "description": "this is style code type property",
            "isUnique": "yes",
            "fieldType": "multi_select",
            "options": [
                "rock",
                "classy"
            ],
            "scope": [
                "product"
            ],
            "createdAt": "2020-03-09T17:16:20.645+05:30",
            "updatedAt": "2020-03-17T11:31:24.193+05:30"
        },
        {
            "label": "fabric",
            "internalName": "fabric",
            "description": "type of fabric used in a dress",
            "isUnique": "no",
            "fieldType": "single_select",
            "options": [
                "silk",
                "cotton"
            ],
            "scope": [
                "product"
            ],
            "createdAt": "2020-03-09T10:28:34.645+05:30",
            "updatedAt": "2020-03-09T10:28:34.645+05:30"
        },
        {
            "label": "Season",
            "internalName": "xyz",
            "description": "qwerty-new",
            "isUnique": "yes",
            "fieldType": "long_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-03-07T11:29:05.346+05:30",
            "updatedAt": "2020-03-11T17:47:53.431+05:30"
        },
        {
            "label": "Size",
            "internalName": "fashionu544cgf",
            "isUnique": "no",
            "fieldType": "short_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-28T14:40:34.472+05:30",
            "updatedAt": "2020-03-11T17:48:47.048+05:30"
        },
        {
            "label": "fashiontype",
            "internalName": "fashionu54cgf",
            "isUnique": "no",
            "fieldType": "short_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-28T14:40:20.308+05:30",
            "updatedAt": "2020-02-28T14:40:20.308+05:30"
        },
        {
            "label": "fashiontype",
            "internalName": "fashionucgf",
            "isUnique": "no",
            "fieldType": "short_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-28T13:33:29.699+05:30",
            "updatedAt": "2020-02-28T13:33:29.699+05:30"
        },
        {
            "label": "fashion@type",
            "internalName": "fashion 67type",
            "isUnique": "no",
            "fieldType": "short_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-28T13:19:34.371+05:30",
            "updatedAt": "2020-02-28T13:19:34.371+05:30"
        },
        {
            "label": "style",
            "internalName": "codevvv",
            "description": "this is style code property",
            "isUnique": "yes",
            "fieldType": "multi_select",
            "options": [
                "rock",
                "classy",
                "bestseller"
            ],
            "scope": [
                "recall consignment",
                "product"
            ],
            "createdAt": "2020-02-27T18:42:28.943+05:30",
            "updatedAt": "2020-02-27T18:42:28.943+05:30"
        },
        {
            "label": "occassion",
            "internalName": "occassion",
            "description": "occassion dresses",
            "isUnique": "no",
            "fieldType": "multi_select",
            "options": [
                "red,blue,green"
            ],
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-27T18:32:15.528+05:30",
            "updatedAt": "2020-02-27T18:32:15.528+05:30"
        },
        {
            "label": "batch",
            "internalName": "batch",
            "isUnique": "yes",
            "fieldType": "short_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-27T15:14:29.519+05:30",
            "updatedAt": "2020-02-27T15:32:53.951+05:30"
        },
        {
            "label": "Fabric",
            "internalName": "fabric",
            "description": "type of fabric used in a dress",
            "isUnique": "no",
            "fieldType": "long_text",
            "options": [
                "silk",
                "cotton"
            ],
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-27T15:14:29.519+05:30",
            "updatedAt": "2020-03-11T17:39:15.062+05:30"
        },
        {
            "label": "dsdcgscsfgcd",
            "internalName": "dbsdvsd",
            "description": "sd scdgcs",
            "isUnique": "yes",
            "fieldType": "short_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-24T18:18:49.844+05:30",
            "updatedAt": "2020-02-24T18:18:49.844+05:30"
        },
        {
            "label": "testing-prop",
            "internalName": "testingprop",
            "description": "description optional",
            "isUnique": "no",
            "fieldType": "date_picker",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-24T17:59:16.948+05:30",
            "updatedAt": "2020-02-24T19:34:21.240+05:30"
        },
        {
            "label": "colorsbj",
            "internalName": "colors",
            "isUnique": "no",
            "fieldType": "attachment",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-24T12:05:29.031+05:30",
            "updatedAt": "2020-02-24T12:21:58.605+05:30"
        },
        {
            "label": "style",
            "internalName": "code",
            "description": "this is style code property",
            "isUnique": "yes",
            "fieldType": "multi_select",
            "options": [
                "rock",
                "classy",
                "bestseller"
            ],
            "scope": [
                "recall consignment",
                "product"
            ],
            "createdAt": "2020-02-24T11:31:06.270+05:30",
            "updatedAt": "2020-02-24T11:31:06.270+05:30"
        },
        {
            "label": "style code",
            "internalName": "style code",
            "description": "this is style code property",
            "isUnique": "yes",
            "fieldType": "multi_select",
            "options": [
                "rock",
                "classy",
                "bestseller"
            ],
            "scope": [
                "recall consignment",
                "product"
            ],
            "createdAt": "2020-02-24T11:30:47.247+05:30",
            "updatedAt": "2020-02-24T11:30:47.247+05:30"
        },
        {
            "label": "label val",
            "internalName": "sdkfjhsdjkf",
            "description": "sdkfjlsdlfkjkl sdlfjklsdfj",
            "isUnique": "yes",
            "fieldType": "long_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-21T19:18:02.944+05:30",
            "updatedAt": "2020-02-21T19:18:02.944+05:30"
        },
        {
            "label": "brand sizes",
            "internalName": "brand sizes",
            "description": "brand sizes",
            "isUnique": "no",
            "fieldType": "single_select",
            "options": [
                "28",
                "30",
                "32",
                "34",
                "36",
                "38",
                "40",
                "42",
                "44",
                "46"
            ],
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-19T15:26:10.051+05:30",
            "updatedAt": "2020-02-19T15:26:10.051+05:30"
        },
        {
            "label": "description ",
            "internalName": "description",
            "description": "description",
            "isUnique": "no",
            "fieldType": "long_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-19T15:24:43.111+05:30",
            "updatedAt": "2020-02-19T15:24:43.111+05:30"
        },
        {
            "label": "product category",
            "internalName": "product category",
            "description": "category of the product",
            "isUnique": "yes",
            "fieldType": "short_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-19T15:24:15.069+05:30",
            "updatedAt": "2020-02-25T10:28:03.126+05:30"
        },
        {
            "label": "check date",
            "internalName": "check date",
            "description": "check_date",
            "isUnique": "yes",
            "fieldType": "date_picker",
            "scope": [
                "product",
                "listing",
                "inventory",
                "order",
                "return",
                "inward consignment",
                "recall consignment",
                "invoice",
                "expense",
                "payment"
            ],
            "createdAt": "2020-02-07T17:44:31.085+05:30",
            "updatedAt": "2020-02-07T17:44:31.085+05:30"
        },
        {
            "label": "mfg date",
            "internalName": "mfg date",
            "description": "date of manufacture",
            "isUnique": "yes",
            "fieldType": "single_select",
            "options": [
                "2020-01-30t10:44:02.366+00:00,2020-01-30t10:03:12.397+00:00"
            ],
            "scope": [
                "product",
                "inventory",
                "order",
                "inward consignment"
            ],
            "createdAt": "2020-01-31T13:54:59.951+05:30",
            "updatedAt": "2020-02-21T16:25:35.447+05:30"
        }
    ],
    "page": 1,
    "perPage": 25,
    "total": "26"
}
curl --location --request GET 'http://localhost:8080/_ah/api/esb/v1/property/search?scope=product' \
--header 'Content-Type: application/json' \
--header 'Authorization: '

Last updated