The glossary is used to define values such as manufacturer, measurement units, and vat rate for work products.

To learn more about draft products, click here

⚠️

Attention! You can also define fields using the backoffice. To do this, select configuration → dictionaries → manufactures / measurement units / vat rate

Table of contents Glossary POST - create manufacturer PUT - update manufacturer POST - create measurement unit POST - create vat rate

Glossary

Name	Explanation
`name`	name of manufacturer
`externalId`	external identifier of manufacturer
`acronym`	shortcut of manufacturer name
`externalId` (measurement unit)	external identifier of measurement unit
`shortName`	shortcut of measurement unit
`fullName`	name of measurement unit
`externalId` (vat rate)	external identifier of vat rate
`label`	label of vat rate (will appear when selecting vat of draft product)
`value`	value of vat rate (example for a tax of 23% you should set 0.23)

POST - create manufacturer

In order to add manufacturer for draft products use POST /api/v1/catalog/integrations/auth-required/dictionaries/manufactures. The diagram below shows the dependency of communicating with the API:

Example request:

json
curl -X POST
"https://api-preprod.one.unity.pl/api/v1/catalog/integrations/auth-required/dictionaries/manufacturers" 
-H  "accept: */*" 
-H  "one-tenant: {tenant}" 
-H  "ApiAuth: {apiKey}"
-H "Content-Type: application/json" 
-d " {
  "name": "name of manufacturers", -- required
  "externalId": "001", -- required
  "acronym": "manu" -- required
}"

In response you will receive manufacturer identifier (manufacturerId)

json
{
  "manufacturerId": "cf333fb0-5dde-41e4-a812-50688ef93ee4"
}

PUT - update manufacturer

Here it is possible to update the producer created in the earlier endpoint. It is possible to update name, external Id and acronym. To do this, use PUT/api/v1/catalog/integrations/auth-required/dictionaries/manufactures/{manufacturerId}. The sequence diagram below shows the process:

Use the parameter in query below to update manufacturer:

manufacturerId

Example request:

json
curl -X PUT
"https://api-preprod.one.unity.pl/api/v1/catalog/integrations/auth-required/dictionaries/manufacturers/cf333fb0-5dde-41e4-a812-50688ef93ee4" 
-H  "accept: */*" 
-H  "one-tenant: {tenant}" 
-H  "ApiAuth: {apiKey}"

POST - create measurement unit

In order to add measurement unit for draft products use POST /api/v1/catalog/integrations/auth-required/dictionaries/measurement-units. The diagram below shows the dependency of communicating with the API:

Example request:

json
curl -X POST
"https://api-preprod.one.unity.pl/api/v1/catalog/integrations/auth-required/dictionaries/measurement-units" 
-H  "accept: */*" 
-H  "one-tenant: {tenant}" 
-H  "ApiAuth: {apiKey}"
-H "Content-Type: application/json" 
-d "{
  "externalId": "METER2",
  "shortName": "M2",
  "fullName": "SQUARE METER"
}

POST - create vat rate

In order to add vat rate for draft products use POST /api/v1/catalog/integrations/auth-required/dictionaries/vat-rates. The diagram below shows the dependency of communicating with the API:

Example request:

json
curl -X POST
"https://api-preprod.one.unity.pl/api/v1/catalog/integrations/auth-required/dictionaries/vat-rates" 
-H  "accept: */*" 
-H  "one-tenant: {tenant}" 
-H  "ApiAuth: {apiKey}"
-H "Content-Type: application/json" 
-d " {
  "externalId": "vat23",
  "label": "Vat 23%",
  "value": 0.23
}

Dictionaries

Table of contents

Glossary

POST - create manufacturer

PUT - update manufacturer

POST - create measurement unit

POST - create vat rate