Get Single Vendor
Overview
In order to get information for a single vendor, you can consume the endpoint presented in this article. In order to consume it, you must:
- Be authenticated user
For information on how you can authenticate, see: Authentication
As soon as you do authentication and receive a valid token, it needs to be passed to the call.
Endpoint
Example for such endpoint for TT server is:
https://tt.api.sellercloud.com/rest/api/Vendors/{id}
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/Vendors/{id}
Request
Information about expected request parameters can be found on swagger UI https://tt/api.sellercloud.com/rest/swagger.
- Method Type: HttpGet
- Authorization: Use Bearer Token (where 'Token' is the token received from token authentication)
- Header info: Content-Type: application/json
- Parameters: ID of a vendor
Parameter | Data Type | Description | Is Required |
id | integer | ID of existing vendor | true |
Example: https://tt.api.sellercloud.com/rest/api/Vendors/81
Response
- If user is authenticated and provides a valid ID of a vendor, then response will be Status Code 200 => OK and vendor metadata in JSON format returned in the response body
- If user is not authenticated, then response will be Status Code 401 => Not Valid Token
- In case of error, response will be Status Code 500 => Internal Server Error
Response Body Format
{
"Alias": "string",
"AccountNumber": "string",
"EmailCC": "string",
"Website": "string",
"IsActive": true,
"ID": 0,
"Name": "string",
"Email": "string",
"IsDefault": true
}