Brand GET
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}/product-service/brand/{ID-SET} Refer to our documentation on URI syntax for more information on how to construct URIs.
Description
Returns the ID, name, description, createdOn and updatedOn values of a brand.
Historically, Brand GET responses did not include the createdOn and updatedOn fields. Older brands will have a newer date (from when the fields were introduced), however this is intended for change detection rather than for a historical audit trail.
Example 1
Requesting all brands.
Request URI
/brand/ Response
{
"response": [
{
"id": 74,
"name": "Other",
"description": "",
"createdOn": "2020-01-01T01:02:03.000Z",
"updatedOn": "2020-01-02T03:04:05.000Z"
},
{
"id": 75,
"name": "Test-1",
"description": "Test 1 description",
"createdOn": "2020-02-01T02:03:04.000Z",
"updatedOn": "2020-02-02T04:05:06.000Z"
},
{
"id": 76,
"name": "Test-2",
"description": "Test 2 description",
"createdOn": "2020-03-01T03:04:05.000Z",
"updatedOn": "2020-03-02T05:06:07.000Z"
},
{
"id": 77,
"name": "Test-3",
"description": "Test 3 description",
"createdOn": "2020-04-01T04:05:06.000Z",
"updatedOn": "2020-04-02T06:07:08.000Z"
},
{
"id": 78,
"name": "Test-4",
"description": "Test 4 description",
"createdOn": "2020-05-01T05:06:07.000Z",
"updatedOn": "2020-05-02T07:08:09.000Z"
}
]
}Example 2
Requesting brands using an ID set.
Request URI
/brand/74,76 Response
{
"response": [
{
"id": 74,
"name": "Other",
"description": "",
"createdOn": "2020-01-01T01:02:03.000Z",
"updatedOn": "2020-01-02T03:04:05.000Z"
},
{
"id": 76,
"name": "Test-2",
"description": "Test 2 description",
"createdOn": "2020-03-01T03:04:05.000Z",
"updatedOn": "2020-03-02T05:06:07.000Z"
}
]
}