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 FieldTypeDescription
SupplierCode integer
SupplierName string
Mobile string
Email string
CommissionValue number
CommissionPercentage number
DepositTerms string
IsDepositHold boolean

Sample Message

/v2/GetSuppliers
[
    {
        "SupplierCode": 1,
        "SupplierName": "supplier_name",
        "Mobile": "string",
        "Email": "[email protected]",
        "CommissionValue": 1.00,
        "CommissionPercentage": 0.10,
        "DepositTerms": "Monthly",
        "IsDepositHold": false
    },
    {
        "SupplierCode": 2,
        "SupplierName": "Anagorsky Test Supplier",
        "Mobile": "79118190050",
        "Email": "[email protected]",
        "CommissionValue": 0.00,
        "CommissionPercentage": 0.00,
        "DepositTerms": "Monthly",
        "IsDepositHold": false
    },
    .....................
]