Get All Customers

Overview

In order to get information for many customers in a single request, then you can consume the endpoint presented in this article. However 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 on the call for getting customers information.

  • You can provide page number and page size and some filtering information

Endpoint

Example for such endpoint for TT server:

https://tt.api.sellercloud.com/rest/api/Customers?pageNumber=1&pageSize=1

For your server endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/Customers?pageNumber=1&pageSize=1

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 + token received from token authentication
  • Header info: Content-Type: application/json
  • Parameters:
ParametersData TypeDescriptionIs Required
pageNumberintegerNumber of pageyes
pageSizeintegerNumber of customers per pageyes
customerIDsListList of ID of customersNo
firstNamestringFirst name of customerNo
lastNamestringLast name of customerNo
emailstringEmail of customerNo
ratingstringNotRated, Very_Disatisfied, Neutral, Satisfied, Very_SatisfiedNo
customerTypestringRetail, WholesaleNo
subscribedintegerNo
createdOnFromDateTimeNo
createdOnToDateTimeNo
modifiedOnFromDateTimeNo
modifiedOnToDateTimeNo
phoneNumberstringCustomer phone number.No
citystringCustomer city.No
zipCodestringCustomer zip codeNo
exportedintegerNo
channelstringLocal_Store, Amazon etc.

Please check swagger for more information.

No
corporateNamestringThe Business NameNo
keywordstringA search term for performing a global search. NoNo

Response

  • If user is authenticated and provides a valid page number and page size, then response will be Status Code 200 => OK and orders metadata in JSON format

  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server response => Status Code 500 => Internal Server Error

Was this article helpful?

Next
Create New Customer