Guides

GetSupplierDetails

Endpoint

Suggest Edits

Overview

The "GetSupplierDetails" endpoint is a GET request. It is used to retrieve the full information about your specific supplier. Detailed functionality of how to use this endpoint is explained in the Multiple Suppliers section.

The endpoint on Swagger is GetSupplierDetails.

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 with the following parameters:

Input ParameterTypeDescription
SupplierCodeinteger

Response Model

The response is a ManageSupplierResponse object as follows:

Response FieldTypeDescription
SupplierCode integer
SupplierName string
Mobile string
Email string
CommissionValue number
CommissionPercentage number
DepositTerms string
SupplierStatusstring"Active", "Pending", "Rejected",
"Closed", "Dormant"
CommentstringThe reason for rejection (if the supplier is rejected)

Sample Message

/v2/GetSupplierDetails?suppplierCode=1

{
    "SupplierCode": 1,
    "SupplierName": "test",
    "Mobile": "1234",
    "Email": "[email protected]",
    "CommissionValue": 5.00,
    "CommissionPercentage": 0.000,
    "DepositTerms": "Daily",
    "SupplierStatus": "Active",
    "Comment": "",
    "IsPercentageOfNetValue": true,
    "BusinessName": null,
    "DisplaySupplierDetails": false,
    "SupplierCommissions": [
        {
            "PaymentMethodName": "KNET",
            "CommissionValue": 1.000,
            "CommissionPercentage": 5.000,
            "IsPercentageOfNetValue": "False"
        },
        {
            "PaymentMethodName": "VISA/MASTER",
            "CommissionValue": 0.000,
            "CommissionPercentage": 10.000,
            "IsPercentageOfNetValue": "True"
        }
    ]
}

Updated 12 months ago