Skip to content
Last update: April 11, 2024

Properties query

This connection allows you to search for catalog property metadata.

Arguments

Argument Description
after String A cursor value to paginate through the results.
first Int The number of pages in a single query.
storeId String! The ID of the store to retrieve pages from.
types PropertyType The type of property to retrieve.
filter String Filters query results.
cultureName String A language to retrieve data in.

Possible returns

Possible return Description
PropertyConnection An individual item within a property dictionary

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{ 
  properties(
    storeId: "B2B-Store"
    cultureName: "en-EN"
    types: [PRODUCT, VARIATION]
  )  
    items {
      name
      type
      id
      multivalue
      propertyDictItems {
        totalCount
        items {
          value
        }
      }
    }
  }

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "data": {
    "properties": {
      "items": [
        {
          "name": "date_prp",
          "type": "Product",
          "id": "2e412a78-e6fb-46d9-837e-e187512b7f62",
          "multivalue": false,
          "propertyDictItems": {
            "totalCount": 0,
            "items": []
          }
        },
        {
          "name": "variation_prop_date",
          "type": "Variation",
          "id": "0a1b9281-b567-40c5-b456-f3c5f420f5bd",
          "multivalue": false,
          "propertyDictItems": {
            "totalCount": 0,
            "items": []
          }
        }
      ]
    }
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  properties(
    storeId: "B2B-Store")
  {
    items {
      name
      type
      id
      multivalue
      propertyDictItems {
        totalCount
        items {
          value
        }
      }
    }
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{
  "data": {
    "properties": {
      "items": [
        {
          "name": "catalog_0_0_0",
          "type": "Catalog",
          "id": "2cdd23ca-f7cc-4496-a46b-2ab7063e86a5",
          "multivalue": false,
          "propertyDictItems": {
            "totalCount": 0,
            "items": []
          }
        },
        {
          "name": "propertycatalog_d",
          "type": "Catalog",
          "id": "bbe0d9f6-7ddd-417c-bb1d-c297044b2b57",
          "multivalue": true,
          "propertyDictItems": {
            "totalCount": 4,
            "items": [
              {
                "value": "qwertyq"
              },
              {
                "value": "3"
              },
              {
                "value": "2"
              },
              {
                "value": "4"
              }
            ]
          }
        },
        {
          "name": "variation_prop_date",
          "type": "Variation",
          "id": "0a1b9281-b567-40c5-b456-f3c5f420f5bd",
          "multivalue": false,
          "propertyDictItems": {
            "totalCount": 0,
            "items": []
          }
        }
      ]
    }
  }
}