Vendors allow merchants to specify how products and shipping might be applied in your catalog, as well as show customers who the vendor for a product is. This area of the API allows you to manage how that is done.
The following pre-requisites will be necessary to accomplish the goals of this article:
- General understanding of REST and API’s
If you haven’t already done so, you should probably have a development environment ready to development against, complete with Hotcakes installed and configured.
REST API Endpoints for Vendors
There are a handful of REST API endpoints that allow you to display or manage various aspects of vendors. Those endpoints are detailed below.
|VendorCreate||VendorManufacturerDTO||Create a vendor for your store to assign to products in your catalog.|
|VendorDelete||Boolean||Permanently deletes the vendor from the store.|
|VendorFind||VendorManufacturerDTO||Find a specific vendor using the Bvin of the respective vendor.|
|VendorFindAll||List of VendorManufacturerDTO||Allows you to find all vendors that are in your store.|
|VendorUpdate||VendorManufacturerDTO||Updates the vendor record with the information specified.|