get https://{host}/api_gateway/rewards/core/v1/vendor/brand/
This API is used to retrieve details of Vendor List of a specific brand using Brand ID.
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
Prerequisites
- Authentication: Basic or OAuth authentication
- Default access group
API Specification
| URI | /api_gateway/rewards/core/v1/vendor/brand/1 |
| HTTP Method | GET |
| Pagination | No |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/vendor/brand/1?enabled=false
Request path parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| brandId* | Integer | Unique identifier of the brand. You can get the brand ID from this API. |
Request query parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| enabled | Boolean | Filters the vendor list to show only those that are enabled. Supported values: true or false. |
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/vendor/brand/1?enabled=false
Response parameters
| Parameter Name | Description |
|---|---|
| success | Indicates whether the request was successful.true: Request was successful.false: Request was unsuccessful. |
| code | Status code of the request. |
| message | Message describing the status of the response. |
| vendorList | Object containing details of the vendors for the organisation. |
| - id | Unique identifier for the vendor. |
| - name | Name of the vendor. |
| - brandId | Identifier for the brand associated with the vendor. |
| - enabled | Indicates whether the vendor is enabled or disabled. |
| - vendorTypes | Type of vendor. These are specialized vendor types for which we have implemented customized solutions in our system to handle reward issuance. Possible types: LINKAJA/AIRSPRING/OVO/BONUSLINK |
| - vendorDetails | Additional details about the vendor/ |
| - type | Type of vendor. Possible Values: REWARDS/POINTS. REWARDS: If the type is set to REWARDS, it refers to a generic vendor used for issuing rewards. POINTS: It is a vendor type that manages the external points system, where each brand can have only one POINTS type vendor. |
| - rank | Rank assigned to the vendor. This can be used for ordering and prioritizing. |
| - code | Unique identification code for the vendor. |
| - description | Description for the vendor. |
| - images | Object containing details on images associated with the vendor |
| --name | Unique name identifier for the image. |
| --id | Unique ID that is generated when creating the image. |
| --altText | Descriptive text that conveys the meaning and context of the image. |
| --url | Direct link to the image. |
| --isExternal | Indicates if the image is from an external source. |
| - videos | Object containing details on videos associated with the vendor |
| --name | Unique name identifier for the video. |
| --id | Unique ID that is generated when creating the video. |
| --altText | Descriptive text that conveys the meaning and context of the video. |
| --url | Direct link to the video. |
| --isExternal | Indicates if the video is from an external source. |
| - lastUpdatedOn | Timestamp of the last update in since epoch format. |
| -encryptionRequired | Indicates if encryption is required for transactions with the vendor. |
{
"status": {
"success": true,
"code": 5001,
"message": "Vendor fetched successfully"
},
"vendorList": [
{
"id": 2,
"name": "BonusLink",
"brandId": 1,
"enabled": false,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1697634702000,
"encryptionRequired": false
},
{
"id": 4,
"name": "OVO",
"brandId": 1,
"enabled": false,
"vendorTypes": "LINKAJA",
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1717759204000,
"encryptionRequired": true
},
{
"id": 6,
"name": "sadfhlk",
"brandId": 1,
"enabled": false,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1697634705000,
"encryptionRequired": false
},
{
"id": 7,
"name": "Test 123",
"brandId": 1,
"enabled": false,
"vendorTypes": null,
"vendorDetails": {
"Test": "********************************************"
},
"type": "REWARDS",
"lastUpdatedOn": 1717759201000,
"encryptionRequired": false
},
{
"id": 58,
"name": "DocVendor6",
"brandId": 61,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"rank": null,
"code": "Doc006",
"description": null,
"images": [
{
"name": "imageName001",
"altText": null,
"id": null,
"url": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcS6RFSqYEgenJSDc0Wo_eoEKzxd0iXvTOO-LQ&s",
"isExternal": true
}
],
"videos": [],
"lastUpdatedOn": 1739783325000,
"encryptionRequired": false
}
]
}
{
"status": {
"success": true,
"code": 5001,
"message": "Vendor fetched successfully"
},
"vendorList": [
{
"id": 21,
"name": "Delta",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1717833026000,
"encryptionRequired": false
},
{
"id": 32,
"name": "Dick's Sporting Goods",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1723837313000,
"encryptionRequired": false
},
{
"id": 31,
"name": "Marriot",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1723836103000,
"encryptionRequired": false
},
{
"id": 20,
"name": "Points for Good",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1717833026000,
"encryptionRequired": false
},
{
"id": 22,
"name": "Qwikzozo",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1718002449000,
"encryptionRequired": false
},
{
"id": 28,
"name": "Qwikzozoo",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {
"clientSecret": "****************************************************"
},
"type": "REWARDS",
"lastUpdatedOn": 1721042314000,
"encryptionRequired": false
},
{
"id": 23,
"name": "Sweepstakes",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1718004095000,
"encryptionRequired": false
},
{
"id": 30,
"name": "Target",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1721722266000,
"encryptionRequired": false
},
{
"id": 27,
"name": "test1",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {
"test": "********************************************"
},
"type": "REWARDS",
"lastUpdatedOn": 1721030412000,
"encryptionRequired": false
},
{
"id": 29,
"name": "test2",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {
"clientSecret": "****************************************************"
},
"type": "REWARDS",
"lastUpdatedOn": 1721042619000,
"encryptionRequired": false
},
{
"id": 35,
"name": "test5",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {
"clientSecret": "****************************************************"
},
"type": "REWARDS",
"lastUpdatedOn": 1727331817000,
"encryptionRequired": false
},
{
"id": 36,
"name": "test6",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {
"clientSecret": "************************************************"
},
"type": "REWARDS",
"lastUpdatedOn": 1727331838000,
"encryptionRequired": false
},
{
"id": 37,
"name": "test7",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {
"clientSecret": "************************************************"
},
"type": "REWARDS",
"lastUpdatedOn": 1727332433000,
"encryptionRequired": false
},
{
"id": 38,
"name": "test8",
"brandId": 1,
"enabled": true,
"vendorTypes": null,
"vendorDetails": {},
"type": "REWARDS",
"lastUpdatedOn": 1727339906000,
"encryptionRequired": false
}
]
}
{
"status": {
"success": false,
"code": 3004,
"message": "Brand not found"
}
}
API-specific error codes
| Error Code | Description |
|---|---|
| 3004 | Invalid Brand ID |