Overview
This API can be used to view a list of suppliers available in your account, by Survey Localization. The response of this API endpoint will return suppliers, by supplier ID, which may then be used in other API requests like [Selecting Suppliers For Your Survey] & [Setting Quotas By Supplier].
Our list of suppliers updates as we add/remove suppliers to our marketplace. Please take this into consideration when caching supplier names & id’s.
Use
To pull the list of suppliers in a locale, use the GET $apihost/$basepath/suppliers endpoint. We do not paginate the results of this endpoint.
Passing an invalid localization code will result in an HTTP 400 error. For a list of valid survey localization codes, please see: Codes & Units
Important Considerations
Only suppliers that are not blocked, and have sample available in the selected survey localization will appear in the response.
Request
GET $apihost/$basepath/suppliers?locale=[%%survey_localization%%]
($apihost is the environment against which you are testing, and $basepath is the base path with the api version. All Buy API calls will require access-token parameter in the header)
Parameters:
GET https://api.spectrumsurveys.com/buyers/v2/suppliers?locale=en_US
Result
Response Code
200
Response Body
[
{
"id": 6,
"name": "Supplier 1"
},
{
"id": 8,
"name": "Supplier 2"
},
{
"id": 10,
"name": "Supplier 3"
}
]
|