Vendors¶

List All Vendors¶

To get a list of vendors, send a GET request to /api/vendors/:

GET /api/vendors/

This request returns the list vendors with their details.

GET /api/vendors/

{
 "vendors": [
    {
     "company_id": "2",
     "lang_code": "en",
     "email": "acme_corp@example.com",
     "company": "ACME Corp",
     "timestamp": "1269610461",
     "status": "A",
     "seo_name": "acme-corp",
     "seo_path": "",
     "average_rating": null,
     "company_thread_ids": "2_0"
    },
    {
     "company_id": "1",
     "lang_code": "en",
     "email": "simtech@example.com",
     "company": "Simtech",
     "timestamp": "1269610461",
     "status": "A",
     "seo_name": "simtech",
     "seo_path": "",
     "average_rating": null,
     "company_thread_ids": "1_0"
    }
 ],
 "params": [0]
}

Get a Specific Vendor¶

To get the details of a specific vendor, send a GET request to /api/vendors/<company_id>/. For example:

GET /api/vendors/1

Create a Vendor¶

Send a POST request to /api/vendors/:

POST /api/vendors/

Pass the following fields with vendor details in the HTTP request body in accordance with the Content-Type. Required fields are marked with *.

• company*—the name of the vendor.

• storefront*—this field is required by REST API, but it doesn’t serve any purpose in Multi-Vendor. Pass any value here, for example, api:

  {
   ...
   "storefront": "api",
   ...
  }
  

  Important

  The storefront field must have a unique value for each vendor you create via REST API.

• company_description—the description of the vendor. You can use HTML code here.

• status—the status of the vendor:

  • N—new
  • A—active (the default status)
  • P—pending
  • D—disabled

• lang_code—a two-letter language code, for example, en.

• email*—vendor’s email address.

• phone*—vendor’s phone number

• url—vendor’s website.

• fax—vendor’s fax number.

• address*—vendor’s address.

• city*—vendor’s city.

• country*—vendor’s country. Must be specified as the code (for example, US).

  Hint

  You can find those codes under Administration → Shipping & taxes → Countries.

• state*—vendor’s state. Can be specified as a code.

  Hint

  You can find those codes under Administration → Shipping & taxes → States.

• zipcode*—vendor’s zip code.

• pre_moderation—if you set it to Y, any new products from the vendor will require approval by the store administrator.

• pre_moderation_edit—if you set it to Y, any updates of product information by the vendor will require approval by the store administrator.

• pre_moderation_edit_vendors—if you set it to Y, any updates of the vendor’s profile will require prior approval by the store administrator.

  Note

  The pre_moderation fields will apply only if you configure the Vendor Data Premoderation add-on accordingly.

• categories—the list of categories where the vendor is allowed to create products, separated by commas. If you leave it empty or don’t specify this parameter, the vendor will be able to create products in any category.

• shippings—the shipping methods available to the vendor. For example, if you want to allow the vendor to use shipping methods with shipping IDs 3 and 4, this is how the object will look like:

  {
   ...
   "shippings": {
       "1": "3",
       "2": "4"
   },
   ...
  }
  

  Important

  This object includes only the shipping methods created by the store administrator, not by a vendor’s administrator.

• commission—the size of the commission taken from vendor on every sale. It uses xx.xx format.

• commission_type—the type of the commission taken from the vendor:

  • A—the commission is a certain amount specified in the store’s primary currency.
  • P—the commission is a percentage taken from the vendor’s sales.

  Note

  Starting with Multi-Vendor 4.3.6, commission and commission_type are part of the Vendor Commission add-on.

• terms—the text of vendor’s terms and conditions. You can use HTML code here.

  Note

  This field is added by the Vendor’s Terms and Conditions add-on.

{
  "company": "New Vendor",
  "company_description": "<p>This is the description of the new vendor.</p>",
  "storefront": "example.com",
  "status": "N",
  "lang_code": "en",
  "email": "test_vendor@example.com",
  "phone": "555555555",
  "url": "http://example.com",
  "fax": "+555555555",
  "address": "Boston street",
  "city": "Boston",
  "state": "MA",
  "country": "US",
  "zipcode": "02125",
  "pre_moderation": "Y",
  "pre_moderation_edit": "Y",
  "pre_moderation_edit_vendors": "N",
  "categories": "253,252",
  "shippings": {
     "1": "1",
     "2": "3"
  },
  "commission": "10.55",
  "commission_type": "A",
  "terms": "<p>These are the terms and conditions you must accept before you can buy products from New Vendor.</p>"
}

Update a Vendor¶

To update an existing vendor, send the PUT request to /api/vendors/<company_id>/. For example:

PUT /api/vendors/2/

Pass the fields with the vendor details in the HTTP request body in accordance with the passed Content-Type. None of the fields are required.

{
 "company": "Example",
 "email": "test@example.com",
 "shippings": {
     "1": "1"
  },
  "commission": "0",
  "commission_type": "A"
}

Delete a Vendor¶

To delete a vendor, send the DELETE request to /api/vendors/<company_id>/. For example:

DELETE /api/vendors/2

This request will delete a vendor with company_id=2.