GetSuppliers
Endpoint
Overview
The "GetSuppliers" endpoint is a GET request. It is used to retrieve a list that contains full information about your suppliers. Detailed functionality of how to use this endpoint is explained in the Multiple Suppliers section.
The endpoint on Swagger is Supplier_GetSuppliers.
Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.
Request Header
Add "Authorization": "Bearer {Token}" to request header. Token of demo configuration can be found here.
Request Model
The request is a GET request without any parameters.
Response Model
The response is an array of ManageSupplierResponse objects as follows:
Response Field | Type | Description |
---|---|---|
SupplierCode | integer | |
SupplierName | string | |
Mobile | string | |
string | ||
CommissionValue | number | |
CommissionPercentage | number | |
DepositTerms | string | |
SupplierStatus | string | "Active", "Pending", "Rejected", "Closed", "Dormant" |
Comment | string | The reason of rejection (if the supplier is rejected) |
Sample Message
/v2/GetSuppliers
[
{
"SupplierCode": 1,
"SupplierName": "Test Supplier 1",
"Mobile": "123456789",
"Email": "[email protected]",
"CommissionValue": 1,
"CommissionPercentage": 13,
"DepositTerms": "Daily",
"SupplierStatus": "Active",
"Comment": ""
},
{
"SupplierCode": 25,
"SupplierName": "string",
"Mobile": "123456789",
"Email": "[email protected]",
"CommissionValue": 1,
"CommissionPercentage": 2,
"DepositTerms": "Daily",
"SupplierStatus": "Active",
"Comment": ""
}
.....................
]
Updated 4 months ago