Retrieve a list of vendors

OData

P4W utilizes OData when querying database through API calls. Following example retrieves first 20 vendors, including assigned clients if applicable.

GET https://{tenant_name}.p4warehouse.com/odata/Vendor

Query Parameters

Name	Type	Description
$expand*	String	Client base
$orderby*	String	Vendor code
$top*	Integer	Number of vendors to retrieve
$count*	Boolean	Whether to displays total number of vendors available

Headers

Name	Type	Description
ApiKey*	Stirng	System API key

200: OK

"@odata.context": "https://doc1.p4warehouse.com/odata/$metadata#Vendor(Client(Id,Name))",
    "@odata.count": 6,
    "value": [
        {
            "VendorCode": "123456",
            "ClientId": null,
            "CompanyName": "Demo",
            "ProductExpiryAllowance": null,
            "Description": "Test",
            "Logo": null,
            "ReceivingSlipDisclaimer": null,
            "IsGeneratePoBackOrder": null,
            "ContactPerson": "A.Smith",
            "Email": null,
            "Phone": null,
            "Info1": null,
            "Info2": null,
            "Info3": null,
            "Info4": null,
            "Info5": null,
            "Info6": null,
            "Info7": null,
            "Info8": null,
            "Info9": null,
            "Info10": null,
            "IsEmailReceivingSlips": false,
            "Address1": null,
            "Address2": null,
            "City": null,
            "StateProvince": null,
            "ZipPostalCode": null,
            "Country": null,
            "Id": "a46cc369-4fdd-4af5-9ea7-f79a582f900d",
            "DateCreated": "2023-08-16T14:58:21.7082476Z",
            "Client": null
        },
        {
            "VendorCode": "AB01",
            "ClientId": null,
            "CompanyName": "A and B Supplier",
            "ProductExpiryAllowance": null,
            "Description": "DemoVendor01",

Use OData syntax (https://www.odata.org/documentation/) to personalize queries through API calls.

Example of OData query

https://{tenant_name}.p4warehouse.com/odata/Vendor
?$expand=Client($select=Id,Name)&$orderby=VendorCode&$top=20&$count=true