Product Properties
Product properties are "custom" properties for a product. The definition of these properties can be performed on the MarketHub website.The individual properties for each product can be updated via the unique property name specified for each property.
The API allows you to update these properties but as they are assosciated directly with the product, they can't be
created or deleted directly. You can however update individual properties for each product or in a batch update.
- Method: GET
- URL: https://madic-esl.markethubpulse.com/api/ProductProperty/Get/
The method takes a 2 parameters via the url. Product properties are filtered at a store & product level so the
store id needs to be passed in the last part of the url in addtion to the product is. So for example if the store is 'SampleStore'
and the product is 'Prod001' then the url for the request would be as follows: https://madic-esl.markethubpulse.com/api//ProductProperty/Get?StoreID=SampleID&ProductID=PROD001
Request Headers
| Header Field Name | Value |
|---|---|
| Accept | application/json or application/xml |
| Authorisation | Basic authentication with base 64 encoded credentials e.g. "Basic dGVzdHVzZXI6dGVzdHBhc3N3b3Jk". See EndPoint & Authorisation for more information. |
Once the request is successful the response will return an array/list of product properties. Each property will contain the following fields:
| Name | Type | Description |
|---|---|---|
| Name | String | The unique product property name. |
| Value | String | The value assigned to the product property. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"Name":"QRCode",
"Value":"http://example.com"
},
{
"Name":"Brand",
"Value":"Sample Brand"
}
]
Sample Code
- Method: POST
- URL: https://madic-esl.markethubpulse.com/api/ProductProperty/Update/
The method takes a single product property object and adds it to the database if it does not already exist or
will update it if it already exists. The product must at the very least have a valid product id and store id specified
in addition to the property name & value in order for the product to be added to the database.
Request Headers
| Header Field Name | Value |
|---|---|
| Accept | application/json or application/xml |
| Authorisation | Basic authentication with base 64 encoded credentials e.g. "Basic dGVzdHVzZXI6dGVzdHBhc3N3b3Jk". See EndPoint & Authorisation for more information. |
Body Format
| Name | Type | Description |
|---|---|---|
| ProductID | String | The unique product id for the product within the system. |
| StoreID | String | The unique store id that the product is assigned to. |
| Name | String | The unique property name, |
| Value | String | The unqiue property value. |
Response
| Name | Type | Description |
|---|---|---|
| Name | String | The unique product property name. |
| Value | String | The value of the update property name. |
| Error | boolean | A flag indicating if an error occur during the request. |
| ErrorMessage | string | If an error has occurred then the error message will be populated in this field. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
"Name":"QRCode",
"Value":"http://example.com",
"Error":false,
"ErrorMessage":null
}
Sample Code
- Method: POST
- URL: https://madic-esl.markethubpulse.com/api/ProductProperty/UpdateMany/
The method takes multiple product properties object and adds them to the database if they do not already exist or
will update them if they already exist. Each product property must have a valid product id and store id specified
in addition to the property name & value in order for the property to be added to the database.
Request Headers
| Header Field Name | Value |
|---|---|
| Accept | application/json or application/xml |
| Authorisation | Basic authentication with base 64 encoded credentials e.g. "Basic dGVzdHVzZXI6dGVzdHBhc3N3b3Jk". See EndPoint & Authorisation for more information. |
Body Format
| Name | Type | Description |
|---|---|---|
| ProductID | String | The unique product id for the product within the system. |
| StoreID | String | The unique store id that the product is assigned to. |
| Name | String | The unique property name, |
| Value | String | The unqiue property value. |
Response
| Name | Type | Description |
|---|---|---|
| Name | String | The unique product property name. |
| Value | String | The value of the update property name. |
| Error | boolean | A flag indicating if an error occur during the request. |
| ErrorMessage | string | If an error has occurred then the error message will be populated in this field. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
] {
"Name":"QRCode",
"Value":"http://example.com",
"Error":false,
"ErrorMessage":null
},
{
"Name":"Brand",
"Value":"Sample Brand",
"Error":false,
"ErrorMessage":null
}