GET single Product by SKU
GEThttps://instancename.piminto.com/api/en-us/v/p/:sku
- Requires Data Viewer ApiKey permissions.
- Example URI: https://instancename.piminto.com/api/en-us/v/p/Part-number00
Provides the ability to retrieve information about an existing product.
Returns
Specify the unique product code or number (SKU) of the product from either the product creation request or the product list, and the endpoint will return the corresponding product information and structured category data assigned to the specified product.
Returns an Error if an invalid SKU identifier was specified.
Request
Path Parameters
unique product code
Header Parameters
View name from the PIM's view Dictionary. ✔If the ApiView parameter is not passed- data is returned according to default View defined for access group.
Responses
- 200
- default
success
- application/json
- Schema
- Example (from schema)
Schema
The status of the API request. A value of "OK" indicates that the request was successfully sent and processed.
The SKU that was specified in the API parameter.
data objectrequired
{
"status": "OK",
"sku": "Part-number00",
"data": {
"attributes": {
"sku": "Part-number00",
"categories": [
"Category-1 Name > Category-2 Name"
],
"status": "active",
"thumbnail": "string",
"title": "Title PART-number00",
"price": "100.00",
"rod_diameter": "2.875 in (7.3 cm)",
"variation_attributes": [
"rod_diameter"
],
"variation_of": null,
"variation_skus": [
[
"Part-number01",
"Part-number02"
]
],
"variation_matrix": {
"Part-number01": {
"rod_diameter": [
"1.66 in (4.22 cm)"
]
},
"Part-number02": {
"rod_diameter": [
"2.625 in (6.67 cm)"
]
},
"Part-number00": {
"rod_diameter": [
"2.875 in (7.3 cm)"
]
}
}
},
"definition": {
"status": {
"type": "string",
"collection": "string",
"isUnique": "string",
"label": {
"en-us": "string"
},
"validation": "string",
"isSearchable": "string",
"isIndexable": "string",
"isFilterable": "string",
"group": "string",
"comment": {
"en-us": "string"
}
},
"variation_skus": {
"isUnique": "string",
"dictionaryIsStatic": "string",
"comment": {
"en-us": "string"
},
"value": "string",
"collection": "string",
"isIndexable": "string",
"label": {
"en-us": "string"
},
"validation": "string",
"group": "string",
"type": "string",
"isSearchable": "string",
"isSimpleType": "string",
"isFilterable": "string"
},
"variation_attributes": {
"isSearchable": "string",
"group": "string",
"type": "string",
"label": {
"en-us": "string"
},
"isIndexable": "string",
"validation": "string",
"isFilterable": "string",
"isSimpleType": "string",
"value": "string",
"comment": {
"en-us": "string"
},
"dictionaryIsStatic": "string",
"isUnique": "string",
"collection": "string"
},
"variation_of": {
"isSimpleType": "string",
"isFilterable": "string",
"type": "string",
"group": "string",
"validation": "string",
"label": {
"en-us": "string"
},
"isIndexable": "string",
"isSearchable": "string",
"collection": "string",
"dictionaryIsStatic": "string",
"isUnique": "string",
"value": "string",
"comment": {
"en-us": "string"
}
},
"sku": {
"isFilterable": "string",
"collection": "string",
"isSearchable": "string",
"comment": {
"en-us": "string"
},
"group": "string",
"type": "string",
"label": {
"en-us": "string"
},
"isIndexable": "string",
"isUnique": "string",
"validation": "string"
},
"rod_diameter": {
"collection": "string",
"isFilterable": "string",
"type": "string",
"isIndexable": "string",
"isUnique": "string",
"isSimpleType": "string",
"group": "string",
"label": {
"en-us": "string"
},
"dictionary": {
"visible": [
0
],
"sortingMethod": "string",
"columns": [
"string"
],
"validation": [
null
],
"sorting": [
null
],
"unique": [
0
],
"data": [
"string"
]
},
"validation": "string",
"value": "string",
"isSearchable": "string",
"comment": {
"en-us": "string"
},
"dictionaryIsStatic": "string"
},
"price": {
"value": "string",
"label": {
"en-us": "string"
},
"comment": {
"en-us": "string"
},
"collection": "string",
"group": "string",
"isFilterable": "string",
"isSimpleType": "string",
"validation": "string",
"isIndexable": "string",
"isUnique": "string",
"type": "string",
"isSearchable": "string",
"dictionaryIsStatic": "string"
},
"title": {
"isFilterable": "string",
"group": "string",
"collection": "string",
"label": {
"en-us": "string"
},
"comment": {
"en-us": "string"
},
"isIndexable": "string",
"isUnique": "string",
"validation": "string",
"isSearchable": "string",
"type": "string"
},
"categories": {
"type": "string",
"collection": "string",
"label": {
"en-us": "string"
},
"isUnique": "string",
"isFilterable": "string",
"isSearchable": "string",
"isIndexable": "string",
"validation": "string",
"group": "string",
"comment": {
"en-us": "string"
}
},
"thumbnail": {
"comment": {
"en-us": "string"
},
"group": "string",
"collection": "string",
"type": "string",
"isSearchable": "string",
"isFilterable": "string",
"isIndexable": "string",
"validation": "string",
"label": {
"en-us": "string"
},
"isUnique": "string"
}
},
"categories": {
"CategoryNameParent > CategoryName": {
"cat_id": 2,
"cat_name": "CategoryName",
"cat_path_id": "0 > 2"
}
}
}
}
The reason for the error is included in the response body
- application/json
- Schema
- Example (from schema)
Schema
Indicates the status of the API request. In this case, the value "Error" means that an error occurred while processing the request.
Provides a message that describes the reason for the error that occurred while processing the API request. In this case, the value 'SKU not found' indicates that the SKU was not found in your PIMs.
{
"status": "Error",
"status_message": "SKU not found!"
}
Authorization: ApiKey
name: ApiKeytype: apiKeyin: header
- curl
- python
- nodejs
- php
- java
- CURL
curl -L -X GET 'https://instancename.piminto.com/api/en-us/v/p/:sku' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>'