Get All Vendors

Overview

In order to get information for many Vendors in a single request, you can consume the endpoint presented in this article. In order to do that, 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 XX server:

https://xx.api.sellercloud.com/rest/api/Vendors

For your server endpoint will be:

​https://{your_server_id}.api.sellercloud.com/rest/api/Vendors

Request

  • Method Type: HttpGet
  • Authorization: Use Bearer Token (where ‘Token’ is the token received from the token authentication)
  • Header info: Content-Type: application/json
  • Parameters:
Parameters Data Type Description Is Required
vendorIDs List List of vendor IDs No
names List List of vendor names No
email string Vendor email No
activeStatus integer Active status. Possible values:

0 – Inactive

1- Active

No
pageNumber integer Number of page No
pageSize integer Number of vendors per page No

Response

  • If user is authenticated, then response will be Status Code 200 => OK and vendors metadata in JSON format
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • In case of error, the response will be Status Code 500 => Internal Server Error

Response Body Format

{
  "Items": [
    {
      "ID": 0,
      "Name": "string",
      "Email": "string",
      "IsDefault": true
    }
  ],
  "TotalResults": 0
}

Was this article helpful?

Next
Get Vendor Products