REST API

HomeKnowledge BaseAPI

QW_Get_CustomerList_FromName

54 views /  0 like /  // neha.bansal/

OVERVIEW

This REST API returns the result of a Customer name search in a comma-separated list of the customer Id.

Method:  Get

Request Param:

Authorization: Basic Auth token in the Request Headers 

Search String: Customer name (no exact match) as a query-string param

Output:

The response is the following JSON Object 

{
  "IsSuccess": true,
   "Data": {
         "CustomerId": "13,15,16,17,18,30,33"
   }
   "Message": "",
    "HttpCode": 200
}

IsSuccess: if successful then true else false

Data: JSON object 

CustomerId: comma-separated list of customer ids

Message: Error message in case IsSuccess is false

HttpCode: Response HttpCode

CURL Example:

curl -X GET --header 'Accept: application/json' --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' 'https://alm.orcanos.com/[ACCOUNT NAME]/API/v2/Json/QW_Get_CustomerList_FromName?SearchString=[SearchKeyword]'

Note: In the above example, Authorization: Basic

Click here to know how to generate the Basic Authorization key.

Related Articles