Part types

Use the following endpoints to manage part types and their attributes in a catalog:

Creating or updating part types

POST /1/catalog/parts

Multiple part types can be created and/or updated in one call by specifying a list of part types. The endpoint returns a list of ids of part types, which have been created and a list of updated ids. The result contains also an error dictionary in case some part types could not be created with corresponding error descriptions.

Parameter	Value
part_id	Unique id of the part type in the catalog
name	Name of the part. Dictionary with language-specific values. This name will be displayed in the UI
attributes	List of attributes of the part as defined in the attribute ontology.

note

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

🡢 See Structure of part types

🡢 See API Reference

---

HTTP

> POST https://api.partium.io/1/catalog/parts
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> [
>   {
>     "part_id": "part1",
>     "name": {
>       "en": "Screw X",
>       "de": "Schraube X"
>     },
>     "attributes": [
>       {
>         "attribute_id": "screw-type",
>         "values": [
>           {
>             "organization": "",
>             "value": {
>               "en": "Metric",
>               "de": "Metrisch",
>             }
>           }
>         ]
>       }
>     ]
>   }
> ]
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "created": ["part1"],
<   "updated": [],
<   "errors": {}
< }

Python

response = requests.post(
  'https://api.partium.io/1/catalog/parts',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json=[
    {
      "part_id": "part1",
      "name": {
        "en": "Screw X",
        "de": "Schraube X"
      },
      "attributes": [
        {
          "attribute_id": "screw-type",
          "values": [
            {
              "organization": "",
              "value": {
                "en": "Metric",
                "de": "Metrisch",
              }
            }
          ]
        }
      ]
    }
  ]
)

JavaScript

fetch('https://api.partium.io/1/catalog/parts', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: [
    {
      "part_id": "part1",
      "name": {
        "en": "Screw X",
        "de": "Schraube X"
      },
      "attributes": [
        {
          "attribute_id": "screw-type",
          "values": [
            {
              "organization": "",
              "value": {
                "en": "Metric",
                "de": "Metrisch",
              }
            }
          ]
        }
      ]
    }
  ]
}).then(res => {
  ...
});

note

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

---

Deleting part types

DELETE /1/catalog/parts

Multiple parts can be deleted in one call by specifying a list of part ids. The endpoint returns a list of ids of part types, which have been deleted. The result contains also an error dictionary in case some part types could not be deleted with corresponding error descriptions.

note

Before a part type can be deleted, all references to the BOM hierarchy (assemblies) must be removed first. Likewise, all images related to the part type must be deleted first.

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/parts
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> ["part1"]
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "deleted": ["part1"],
<   "errors": {}
< }

Python

response = requests.delete(
  'https://api.partium.io/1/catalog/parts',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json=["part1"]
)

JavaScript

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

note

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

---

Listing part types

POST /1/catalog/parts/list

Query a list of part types. 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: name, attributes

🡢 See API Reference

---

HTTP

> POST https://api.partium.io/1/catalog/parts/list
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> {
>   "paging": {
>     "limit": 10
>   },
>   "projection": ["name", "attributes"]
> }
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "result": [
<     {
<       "part_id": "part1",
<       "name": {"en": "Screw X", "de": "Schraube X"},
<       "attributes": [
<         {
<           "attribute_id": "screw-type",
<           "values": [
<             {
<               "organization": "",
<               "value": {"en": "Metric", "de": "Metrisch"}
<             }
<           ]
<         }
<       ]
<     },
<     {
<       "part_id": "part2",
<       "name": {"en": "Screw Y", "de": "Schraube Y"},
<       "attributes": [
<         {
<           "attribute_id": "screw-type",
<           "values": [
<             {
<               "organization": "",
<               "value": {"en": "Imperial", "de": "Zoll"}
<             }
<           ]
<         }
<       ]
<     }
<   ],
<   "last_object_id": "unique_object_id",
<   "more_data": false
< }

Python

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

JavaScript

fetch('https://api.partium.io/1/catalog/parts/list', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    "paging": {
      "limit": 10
    },
    "projection": ["name", "attributes"]
  }
}).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 part types by ID

POST /1/catalog/parts/select

Fetch a list of part types by specifying a list of part ids.

Parameter	Value
part_ids	List of ids of part types to fetch
projection	Optional list of fields to be included in the response. Possible values: name, attributes

🡢 See API Reference

---

HTTP

> POST https://api.partium.io/1/catalog/parts/select
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> {
>   "part_ids": ["part1"],
>   "projection": ["name"]
> }
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< [
<   {
<     "part_id": "part1",
<     "name": {"en": "Screw X", "de": "Schraube X"},
<   },
<   {
<     "part_id": "part2",
<     "name": {"en": "Screw Y", "de": "Schraube Y"},
<   }
< ]

Python

response = requests.post(
  'https://api.partium.io/1/catalog/parts/select',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json={
    "part_ids": ["part1"],
    "projection": ["name"]
  }
)

JavaScript

fetch('https://api.partium.io/1/catalog/parts/select', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    "part_ids": ["part1"],
    "projection": ["name"]
  }
}).then(res => {
  ...
});

note

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

---