Attribute options

This section describes how to manage attribute options for the ontology in the Catalog API. The attribute options only apply to enum attributes.

🡢 See Structure of attributes

Creating or updating attribute options

POST /1/catalog/attribute-options

Multiple attribute options can be created and/or updated in one call by specifying a list of attribute options. The endpoint returns indices in the input of the attribute options have created and updated. The result contains also an error dictionary in case some attribute options could not be created with corresponding error descriptions.

Request body field	Value
attribute_id	Unique id of the attribute in the catalog
option_id	Unique id of the attribute option in the context of the attribute
value	Value of the attribute. Dictionary with language-specific values. This value will be displayed in the UI

note

This endpoint will respond with error code 503 when the catalog API is in maintenance mode.

🡢 See API Reference

---

HTTP

> POST https://api.partium.io/1/catalog/attribute-options
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> [
>    {
>      "attribute_id": "manufacturer",
>      "option_id": "metalbars",
>      "value": {
>        "en": "Metalbars",
>        "de": "Metallstangen"
>      },
>    }
> ]
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "created": [0],
<   "updated": [],
<   "errors": {}
< }

Python

response = requests.post(
  'https://api.partium.io/1/catalog/attribute-options',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json=[
    {
      "attribute_id": "manufacturer",
      "option_id": "metalbars",
      "value": {
        "en": "Metalbars",
        "de": "Metallstangen"
      },
    }
  ]
)

JavaScript

fetch('https://api.partium.io/1/catalog/attribute-options', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: [
    {
      "attribute_id": "manufacturer",
      "option_id": "metalbars",
      "value": {
        "en": "Metalbars",
        "de": "Metallstangen"
      },
    }
  ]
}).then(res => {
  ...
});

note

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

---

Deleting attribute options

DELETE /1/catalog/attribute-options

Multiple attribute options can be deleted in one call by specifying a list of identifiers composed of the attribute id and the option id. The endpoint returns the indices of the attribute options in the input that have been deleted. The result contains also an error dictionary in case some attribute options could not be deleted with corresponding error descriptions.

note

Before an attribute option can be deleted, all references to the attribute option must be removed from the part attributes.

note

This endpoint will respond with error code 503 when the catalog API is in maintenance mode.

🡢 See API Reference

---

HTTP

> DELETE https://api.partium.io/1/catalog/attribute-options
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> [{"attribute_id": "manufacturer", "option_id": "metalbars"}]
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "deleted": [0],
<   "errors": {}
< }

Python

response = requests.delete(
  'https://api.partium.io/1/catalog/attribute-options',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json=[{"attribute_id": "manufacturer", "option_id": "metalbars"}]
)

JavaScript

fetch('https://api.partium.io/1/catalog/attribute-options', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: [{"attribute_id": "manufacturer", "option_id": "metalbars"}]
}).then(res => {
  ...
});

note

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

---

Listing attribute options

POST /1/catalog/attribute-options/list

Query a list of attribute options. A paging mechanism can be used to fetch more data if the number of results exceeds the paging limit.

Parameter	Value
paging.limit	Maximum number of results returned by the endpoint
paging.last_object_id	Use this id to get the next page of results. The id is returned by a previous call to this endpoint
projection	Optional list of fields to be included in the response. Possible values: value

🡢 See API Reference

---

HTTP

> POST https://api.partium.io/1/catalog/attribute-options/list
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> {
>   "paging": {
>     "limit": 10
>   },
>   "projection": ["value"]
> }
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "result": [
<     {
<       "attribute_id": "manufacturer",
<       "option_id": "metalbars",
<       "value": {
<         "en": "Metalbars",
<         "de": "Metallstangen"
<       },
<     }
<   ],
<   "last_object_id": "unique_object_id",
<   "more_data": false
< }

Python

response = requests.post(
  'https://api.partium.io/1/catalog/attribute-options/list',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json={
    "paging": {
      "limit": 10
    },
    "projection": ["value"]
  }
)

JavaScript

fetch('https://api.partium.io/1/catalog/attribute-options/list', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    "paging": {
      "limit": 10
    },
    "projection": ["value"]
  }
}).then(res => {
  ...
});

note

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

more_data in the response is true indicates that there are more results to fetch. In that case use the returned last_object_id as a parameter for the next call to fetch the next page of results. Repeat this until more_data is false.

---

Fetching attribute options by ID

POST /1/catalog/attribute-options/select

Fetch a list of attribute options by specifying a list of attribute and option ids.

Parameter	Value
option_id_pairs	List of attribute and option id pairs
projection	Optional list of fields to be included in the response. Possible values: value

🡢 See API Reference

---

HTTP

> POST https://api.partium.io/1/catalog/attribute-options/select
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> {
>   "option_id_pairs": [{"attribute_id": "manufacturer", "option_id": "metalbars"}],
>   "projection": ["value"]
> }
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< [
<   {
<     "attribute_id": "manufacturer",
<     "option_id": "metalbars",
<     "value": {"en": "Manufacturer ID", "de": "Hersteller ID"},
<   }
< ]

Python

response = requests.post(
  'https://api.partium.io/1/catalog/attribute-options/select',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json={
    "option_id_pairs": [{"attribute_id": "manufacturer", "option_id": "metalbars"}],
    "projection": ["value"]
  }
)

JavaScript

fetch('https://api.partium.io/1/catalog/attribute-options/select', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    "option_id_pairs": [{"attribute_id": "manufacturer", "option_id": "metalbars"}],
    "projection": ["value"]
  }
}).then(res => {
  ...
});

note

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

---