Miscellaneous
The Miscellaneous endpoints allows you to get general information about the status of the API and the PIM installation as well as the ability to manage objects which are shared between entities in Struct PIM.
#Available from v.3.3.0
Authorizations
Body
An archive reason defines a reason that can be chosen when archiving products or variants in the system
Uidstring · uuidOptional
Unique id of archive reason
Namestring | nullableOptional
Presented name of archive reason
Responses
200
OK
post
POST /v1/misc/archivereasons HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 60
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text"
}
200
OK
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text"
}
#Available from v.3.3.0
Authorizations
Body
An archive reason defines a reason that can be chosen when archiving products or variants in the system
Uidstring · uuidOptional
Unique id of archive reason
Namestring | nullableOptional
Presented name of archive reason
Responses
200
OK
put
PUT /v1/misc/archivereasons HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 60
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text"
}
200
OK
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text"
}
#Available from v.3.2.0 Get complete the model descriptions for products, variants and categories, usable for migration tools, Model classes scaffolding etc.
Authorizations
Responses
200
OK
get
GET /v1/misc/models HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
OK
{
"ProductModels": [
{
"Alias": "text",
"Properties": [
{
"Alias": "text",
"DataType": "text",
"Localized": true,
"IsMultiValue": true,
"DimensionSpecific": true,
"ReferencedAttribute": "text",
"Properties": [
"[Circular Reference]"
],
"Name": "text",
"Description": "text"
}
]
}
],
"VariantModels": [
{
"Alias": "text",
"Properties": [
{
"Alias": "text",
"DataType": "text",
"Localized": true,
"IsMultiValue": true,
"DimensionSpecific": true,
"ReferencedAttribute": "text",
"Properties": [
"[Circular Reference]"
],
"Name": "text",
"Description": "text"
}
]
}
],
"CategoryModels": [
{
"Alias": "text",
"Properties": [
{
"Alias": "text",
"DataType": "text",
"Localized": true,
"IsMultiValue": true,
"DimensionSpecific": true,
"ReferencedAttribute": "text",
"Properties": [
"[Circular Reference]"
],
"Name": "text",
"Description": "text"
}
]
}
],
"VariantGroupModels": [
{
"Alias": "text",
"Properties": [
{
"Alias": "text",
"DataType": "text",
"Localized": true,
"IsMultiValue": true,
"DimensionSpecific": true,
"ReferencedAttribute": "text",
"Properties": [
"[Circular Reference]"
],
"Name": "text",
"Description": "text"
}
]
}
],
"GlobalListModels": [
{
"Alias": "text",
"DataType": "text",
"Localized": true,
"IsMultiValue": true,
"DimensionSpecific": true,
"ReferencedAttribute": "text",
"Properties": [
{
"Alias": "text",
"DataType": "text",
"Localized": true,
"IsMultiValue": true,
"DimensionSpecific": true,
"ReferencedAttribute": "text",
"Properties": [
"[Circular Reference]"
],
"Name": "text",
"Description": "text"
}
],
"Name": "text",
"Description": "text"
}
],
"CategoryAttributeModels": [
{
"Alias": "text",
"DataType": "text",
"Localized": true,
"IsMultiValue": true,
"DimensionSpecific": true,
"ReferencedAttribute": "text",
"Properties": [
{
"Alias": "text",
"DataType": "text",
"Localized": true,
"IsMultiValue": true,
"DimensionSpecific": true,
"ReferencedAttribute": "text",
"Properties": [
"[Circular Reference]"
],
"Name": "text",
"Description": "text"
}
],
"Name": "text",
"Description": "text"
}
]
}