Definition of the hierarchy

Use the following endpoints to manage the BOM hierarchy in a catalog:

Creating or updating assemblies

POST /1/catalog/assemblies

Multiple assemblies can be created and/or updated in one call by specifying a list of assemblies.

It is also possible to create tree structures in one call. In that case assemblies that are parents of sub-assemblies must be specified in the list before the sub-assemblies. An assembly can only be inserted as a child of another assembly if it already exists.

The endpoint returns a list of ids of assemblies, which have been created and a list of updated ids. The result contains also an error dictionary in case some assemblies could not be created with corresponding error descriptions.

Parameter	Value
`ass_id`	Unique id of the assembly in the catalog
`parent_id`	Id of the parent assembly, is empty for root assemblies
`name`	Name of the assembly. Dictionary with language-specific values. This name 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
Python
JavaScript

> POST https://api.partium.io/1/catalog/assemblies
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> [
>   {
>     "ass_id": "ass1",
>     "parent_id": "",
>     "name": {
>       "en": "Car",
>       "de": "Auto"
>     }
>   },
>   {
>     "ass_id": "ass2",
>     "parent_id": "ass1",
>     "name": {
>       "en": "Engine",
>       "de": "Motor"
>     }
>   }
> ]
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "created": ["ass1", "ass2"],
<   "updated": [],
<   "errors": {}
< }

response = requests.post(
  'https://api.partium.io/1/catalog/assemblies',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json=[
    {
      "ass_id": "ass1",
      "parent_id": "",
      "name": {
        "en": "Car",
        "de": "Auto"
      }
    },
    {
      "ass_id": "ass2",
      "parent_id": "ass1",
      "name": {
        "en": "Engine",
        "de": "Motor"
      }
    }
  ]
)

fetch('https://api.partium.io/1/catalog/assemblies', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: [
    {
      "ass_id": "ass1",
      "parent_id": "",
      "name": {
        "en": "Car",
        "de": "Auto"
      }
    },
    {
      "ass_id": "ass2",
      "parent_id": "ass1",
      "name": {
        "en": "Engine",
        "de": "Motor"
      }
    }
  ]
}).then(res => {
  ...
});

note

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

Deleting assemblies

DELETE /1/catalog/assemblies

Multiple assemblies can be deleted in one call by specifying a list of assembly ids.

The endpoint returns a list of ids of assemblies, which have been deleted. The result contains also an error dictionary in case some assemblies could not be deleted with corresponding error descriptions.

note

Before an assembly can be deleted, all sub-assemblies of that assembly must be removed first.

Before an assembly can be deleted, all assignments of part types to this assembly must be removed first.

note

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

🡢 See API Reference

HTTP
Python
JavaScript

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

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

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

note

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

Listing assemblies

POST /1/catalog/assemblies/list

Query a list of assemblies. The list can be filtered by specifying a list of parent_ids. A paging mechanism can be used to fetch more data if the number of results exceeds the paging limit.

Parameter	Value
`query.parent_ids`	Optional list of parent ids. If specified, only assemblies that are children of the specified parent assemblies are part of the result.
`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: `parent_id`, `name`

🡢 See API Reference

HTTP
Python
JavaScript

> POST https://api.partium.io/1/catalog/assemblies/list
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> {
>   "query": {
>     "parent_ids": ["", "ass1"]
>   },
>   "paging": {
>     "limit": 10
>   },
>   "projection": ["parent_id", "name"]
> }
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "result": [
<     {
<       "ass_id": "ass1",
<       "parent_id": "",
<       "name": {
<         "en": "Car",
<         "de": "Auto"
<       }
<     },
<     {
<       "ass_id": "ass2",
<       "parent_id": "ass1",
<       "name": {
<         "en": "Engine",
<         "de": "Motor"
<       }
<     }
<   ],
<   "last_object_id": "unique_object_id",
<   "more_data": false
< }

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

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

POST /1/catalog/assemblies/select

Fetch a list of assemblies by specifying a list of assembly ids.

Parameter	Value
`ass_ids`	List of ids of assemblies to fetch
`projection`	Optional list of fields to be included in the response. Possible values: `parent_id`, `name`

🡢 See API Reference

HTTP
Python
JavaScript

> POST https://api.partium.io/1/catalog/assemblies/select
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
>
> {
>   "ass_ids": ["ass1", "ass2"],
>   "projection": ["parent_id", "name"]
> }
>
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< [
<   {
<     "ass_id": "ass1",
<     "parent_id": "",
<     "name": {"en": "Car", "de": "Auto"},
<   },
<   {
<     "ass_id": "ass2",
<     "parent_id": "ass1",
<     "name": {"en": "Engine", "de": "Motor"},
<   }
< ]

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

fetch('https://api.partium.io/1/catalog/assemblies/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.

Creating or updating assemblies​

Deleting assemblies​

Listing assemblies​

Fetching assemblies by ID​

Creating or updating assemblies

Deleting assemblies

Listing assemblies

Fetching assemblies by ID