Search attributes

POST 
/attributes/search

Retrieves a list of attributes by using the search fields below:

Field	Type
ids	array(int)
names	array(string)
class	string
isPublic	boolean
isSearchable	boolean
isHidden	boolean
isSystem	boolean
offset	int (max: `100``)
page	int

Results will be paginated. The default number of attributes per page is 12, but can be up to 100.

Request

application/json

Body

class string
id number[]
isHidden boolean
isPublic boolean
isSearchable boolean
isSystem boolean
names string[]
offset number
page number

Responses

200

Search attributes - 200 (with results) / Search attributes - 200 (no results)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

data

object[]

Array [

class string

defaultLanguage string

descriptions

object[]

Array [

language string

value string

]

group string

id number

isHidden boolean

isPublic boolean

isSearchable boolean

isSystem boolean

name string

type string

typeParam string

units

object[]

Array [

language string

value string

]

value

object

anyOf

MOD1

number

MOD2

string

]

end number
itemsFound number
messages string[]
offset number
page number
pages number
start number
total number

Example (from schema)

{
  "data": [
    {
      "class": "product",
      "defaultLanguage": "EN",
      "descriptions": [
        {
          "language": "EN",
          "value": "Weight"
        },
        {
          "language": "NL",
          "value": "Gewicht"
        }
      ],
      "group": "",
      "id": 661,
      "isHidden": false,
      "isPublic": true,
      "isSearchable": false,
      "isSystem": false,
      "name": "WEIGHT",
      "type": "decimal",
      "typeParam": "",
      "units": [
        {
          "language": "EN",
          "value": "kg"
        },
        {
          "language": "NL",
          "value": "kg"
        }
      ],
      "value": 0
    },
    {
      "class": "product",
      "defaultLanguage": "EN",
      "descriptions": [
        {
          "language": "EN",
          "value": "Color"
        },
        {
          "language": "NL",
          "value": "Kleur"
        }
      ],
      "group": "",
      "id": 668,
      "isHidden": false,
      "isPublic": true,
      "isSearchable": false,
      "isSystem": false,
      "name": "COLOR",
      "type": "enum",
      "typeParam": "COLORS",
      "units": [
        {
          "language": "EN",
          "value": ""
        },
        {
          "language": "NL",
          "value": ""
        }
      ],
      "value": ""
    }
  ],
  "end": 2,
  "itemsFound": 2,
  "messages": [
    "Completed"
  ],
  "offset": 10,
  "page": 1,
  "pages": 1,
  "start": 1,
  "total": 2
}

Search attributes - 200 (no results)

{
  "data": [],
  "itemsFound": 0,
  "messages": [
    "Completed"
  ],
  "offset": 10,
  "page": 1,
  "total": 1
}

Search attributes - 200 (with results)

{
  "data": [
    {
      "class": "product",
      "defaultLanguage": "EN",
      "descriptions": [
        {
          "language": "EN",
          "value": "Weight"
        },
        {
          "language": "NL",
          "value": "Gewicht"
        }
      ],
      "group": "",
      "id": 661,
      "isHidden": false,
      "isPublic": true,
      "isSearchable": false,
      "isSystem": false,
      "name": "WEIGHT",
      "type": "decimal",
      "typeParam": "",
      "units": [
        {
          "language": "EN",
          "value": "kg"
        },
        {
          "language": "NL",
          "value": "kg"
        }
      ],
      "value": 0
    },
    {
      "class": "product",
      "defaultLanguage": "EN",
      "descriptions": [
        {
          "language": "EN",
          "value": "Color"
        },
        {
          "language": "NL",
          "value": "Kleur"
        }
      ],
      "group": "",
      "id": 668,
      "isHidden": false,
      "isPublic": true,
      "isSearchable": false,
      "isSystem": false,
      "name": "COLOR",
      "type": "enum",
      "typeParam": "COLORS",
      "units": [
        {
          "language": "EN",
          "value": ""
        },
        {
          "language": "NL",
          "value": ""
        }
      ],
      "value": ""
    }
  ],
  "end": 2,
  "itemsFound": 2,
  "messages": [
    "Completed"
  ],
  "offset": 10,
  "page": 1,
  "pages": 1,
  "start": 1,
  "total": 2
}

400

Search attributes - 400 (invalid search fields)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [id] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Search attributes - 400 (invalid search fields)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [id] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Loading...