Vendors
Retrieve and manage vendor records.
| Field | Data Type | POST | PATCH |
|---|---|---|---|
| VendorID | String | X | X |
| Description | String | X | X |
| Address1 | String | X | X |
| Address2 | String | X | X |
| City | String | X | X |
| State | String | X | X |
| ZipCode | String | X | X |
| Country | String | X | X |
| Phone | String | X | X |
| Fax | String | X | X |
| Web | String | X | X |
| Type | String | X | X |
| AccountNo | String | X | X |
| Currency | String | X | X |
| TaxCode | String | X | X |
| PaymentTerms | String | X | X |
| ShipVia | String | X | X |
| IsActive | Boolean | X | X |
| Notes | String | X | X |
| CreatedBy | String | ||
| DateCreated | DateTime | ||
| EditedBy | String | ||
| DateEdited | DateTime |
Key: VendorID
Required property: VendorID
Endpoints
GET
URL: https://{site}.mvpplant.com/ODataApi/v1/Vendors
Description: Retrieve vendor records.
POST
URL: https://{site}.mvpplant.com/ODataApi/v1/Vendors
Description: Create a vendor record.
Body: Send the property values marked in the POST column.
PATCH
URL: https://{site}.mvpplant.com/ODataApi/v1/Vendors('vendorID')
Description: Update an existing vendor record.
Body: Send only the property values you want to update from the PATCH column.
OData Query Examples
-
Select specific fields:
https://{site}.mvpplant.com/ODataApi/v1/Vendors?$select=VendorID,Description,Currency -
Filter active vendors:
https://{site}.mvpplant.com/ODataApi/v1/Vendors?$filter=IsActive eq true -
Sort by vendor ID:
https://{site}.mvpplant.com/ODataApi/v1/Vendors?$orderby=VendorID -
Return the first 10 records:
https://{site}.mvpplant.com/ODataApi/v1/Vendors?$top=10
Notes
CreatedBy,DateCreated,EditedBy, andDateEditedare system-generated fields.- Use
VendorIDas the key field for vendor records.