The iPIM Server REST API has a few standard query parameters used with most of the endpoints (used especially with GET endpoints),
like: type, locale and include, mainAsset, assetSize.
type parameter is a string value used to switch between 2 response types: technical (default) and display.
display response type return all the resource data needed to display the resource in addition to its technical data, like: description, ...
GET .../iPIM/rest/api/attributes/Std_EAN?type=technical
{
"pimRef": "22",
"identifier": "Std_EAN",
"scope": "ALL",
"type": {
"id": 35,
"pimRef": "35",
"identifier": "PS"
},
"sequence": 33,
"group": {
"id": 158,
"pimRef": "158",
"identifier": "IPIMCORE"
},
"mandatory": {
"id": 104,
"pimRef": "104",
"identifier": "OPTIONAL"
},
"inheritable": true,
"onlyItemLevel": true,
"dimensionLevel": false,
"dimension": false,
"level": "item"
}
locale parameter is a comma separated list of locales, default value is deDE used when type is set to display to specify the locales for which values should be retrieved.
GET .../iPIM/rest/api/attributes/Std_EAN?type=display&locale=enGB,deDE
{
"pimRef": "22",
"identifier": "Std_EAN",
"scope": "ALL",
"description": [
{
"text": "EAN",
"lang": "en_GB"
},
{
"text": "EAN",
"lang": "de_DE"
}
],
"type": {
"id": 35,
"pimRef": "35",
"identifier": "PS",
"description": [
{
"text": "Character string, not localised",
"lang": "en_GB"
},
{
"text": "Zeichenkette, nicht lokalisiert",
"lang": "de_DE"
}
]
},
"sequence": 33,
"group": {
"id": 158,
"pimRef": "158",
"identifier": "IPIMCORE",
"description": [
{
"text": "iPIM Standard attribute (Basic setup)",
"lang": "en_GB"
},
{
"text": "iPIM Standardattribut (Basissetup)",
"lang": "de_DE"
}
]
},
"mandatory": {
"id": 104,
"pimRef": "104",
"identifier": "OPTIONAL",
"description": [
{
"text": "Optional",
"lang": "en_GB"
},
{
"text": "Optional",
"lang": "de_DE"
}
]
},
"inheritable": true,
"onlyItemLevel": true,
"dimensionLevel": false,
"dimension": false,
"level": "item",
"levelDescription": [
{
"text": "Item",
"lang": "en_GB"
},
{
"text": "Artikel",
"lang": "de_DE"
}
]
}
include parameter is a comma separated list of values to sepecify which resource related data should be included in the response. (there is usually an ALL option)
GET .../iPIM/rest/api/attributes/Std_EAN?include=properties
{
"pimRef": "22",
"identifier": "Std_EAN",
"scope": "ALL",
"type": {
"id": 35,
"pimRef": "35",
"identifier": "PS"
},
"sequence": 33,
"group": {
"id": 158,
"pimRef": "158",
"identifier": "IPIMCORE"
},
"mandatory": {
"id": 104,
"pimRef": "104",
"identifier": "OPTIONAL"
},
"inheritable": true,
"onlyItemLevel": true,
"dimensionLevel": false,
"dimension": false,
"level": "item",
"attributeProperties": [
{
"pimRef": 100264025,
"identifier": "ishop_exclude_identifier",
"type": "attribute",
"attributeDataType": "BOOLEAN",
"values": [
{
"value": "true"
}
]
},
{
"pimRef": 100264026,
"identifier": "ishop_export_name",
"type": "attribute",
"attributeDataType": "PLAIN_STRING",
"values": [
{
"value": "EAN"
}
]
},
{
"pimRef": 1000033,
"identifier": "WCS_EXPORT_ALLOWED",
"type": "attribute",
"attributeDataType": "BOOLEAN",
"values": [
{
"value": "true"
}
]
}
]
}
GET .../iPIM/rest/api/products/100990?mainAsset=true
{
"productNo": "100990",
"description": "DatenfeedTestProdukt",
"category": {
"pimRef": "2",
"parentPimRef": "1",
"identifier": "MAIN A",
"sequenceNo": 1,
"categoryURI": "/iPIM/rest/api/categories/MAIN%20A?versionIdentifier=VER_EK",
"versionIdentifier": "VER_EK"
},
"deleted": false,
"state1": {
"state": "2"
},
"state2": {
"state": "2"
},
"state3": {
"state": "2"
},
"state4": {
"state": "2"
},
"objectType": "ARTICLE_TYPE_PRODUCT",
"itemURIs": [
"/iPIM/rest/api/items/100990%20BLAU%20L",
"/iPIM/rest/api/items/100990%20BLAU%20M",
"/iPIM/rest/api/items/100990%20BLAU%20XL",
"/iPIM/rest/api/items/100990%20BLAU%20XXL",
"/iPIM/rest/api/items/100990%20BLAU%20XXXL",
"/iPIM/rest/api/items/100990%20GRUEN%20L",
"/iPIM/rest/api/items/100990%20GRUEN%20M",
"/iPIM/rest/api/items/100990%20GRUEN%20XL",
"/iPIM/rest/api/items/100990%20GRUEN%20XXL",
"/iPIM/rest/api/items/100990%20GRUEN%20XXXL",
"/iPIM/rest/api/items/100990%20ROT%20L",
"/iPIM/rest/api/items/100990%20ROT%20M",
"/iPIM/rest/api/items/100990%20ROT%20XL",
"/iPIM/rest/api/items/100990%20ROT%20XXL",
"/iPIM/rest/api/items/100990%20ROT%20XXXL"
],
"mainAsset": {
"identifier": "2309187.jpg",
"uri": "/iPIM/rest/api/assets/2309187.jpg"
},
"sequenceNo": 1
}
assetSize parameter is a comma separated list of values to sepecify the asset size profiles to be included in the response.
available options: PICTURES_JPG_SMALL,PICTURES_JPG_MEDIUM,PICTURES_JPG_LARGE,ORIGINAL_FORMAT
GET .../iPIM/rest/api/attributes/FARBE/values/ROT?assetSize=PICTURES_JPG_SMALL,PICTURES_JPG_MEDIUM,PICTURES_JPG_LARGE,ORIGINAL_FORMAT
{
"pimRef": "1000219",
"identifier": "ROT",
"descriptions": [
{
"text": "Red",
"lang": "en_GB",
"description": "Red",
"asset": {
"id": 100116467,
"identifier": "sample-image1.PNG",
"fileType": "png",
"sizes": [
{
"size": "PICTURES_JPG_SMALL",
"uri": "http://ipim-ref-2.nm-eg.com:8888/basket/sample-image1.PNG"
},
{
"size": "PICTURES_JPG_MEDIUM",
"uri": "http://ipim-ref-2.nm-eg.com:8888/pdthumb/sample-image1.PNG"
},
{
"size": "PICTURES_JPG_LARGE",
"uri": "http://ipim-ref-2.nm-eg.com:8888/pdmain/sample-image1.PNG"
},
{
"size": "ORIGINAL_FORMAT",
"uri": "http://ipim-ref-2.nm-eg.com:8888/original/sample-image1.PNG"
}
]
}
},
{
"text": "Rot",
"lang": "de_DE",
"description": "Rot"
}
],
"sequence": 11,
"defaultValue": true,
"systemUser": true,
"inactive": true
}