MasterProducts (Common Products for Vendors)¶

Pagination, Sorting and Filtering¶

Pagination, sorting, and filtering parameters are inherited from Products.

The Common Products for Vendors add-on adds the show_master_products_only filtering parameter with true or false value, available via Products API.

The true value will return only common products in the response, while the false will return only products offered by vendors.

Examples¶

• GET /api/master_products?sort_by=price&sort_order=asc

  Response is an array of all common products sorted by price in an ascending order.

• GET /api/master_products?page=5&items_per_page=20

  Response is an array of 20 common products from the 5th Products page.

• GET /api/master_products/310

  Response is the data of a common product with the id 310.

Response Format¶

• The response format is inherited from Products.
• The Common Products for Vendors add-on adds three product fields to the response:

Example JSON¶

{
   "product": "Common product name",
   "price": "100"
}
``

This request creates a common product with minimum required details: a name, and a price.

Response Format¶

• The product has been created successfully: HTTP/1.1 201 Created and the JSON with the new product_id. For example:

  {
      "product_id": 310
  }
  

• The product couldn’t be created: HTTP/1.1 400 Bad Request.

Example JSON¶

{
         "product_code": "12345",
         "price": "99.90",
         "list_price": "110.00",
         "category_ids": [223]
}

This request updates the Product Code, the List Price, the Price, and the Category of the particular Common Product.

Response Format¶

• The product has been updated successfully: HTTP/1.1 200 OK and JSON with product_id.
• The product couldn’t be updated because it is not common: HTTP/1.1 400 Bad Request: Product was found but it is not common product. Please specify common product ID.

Response Format¶

• The product has been deleted successfully: HTTP/1.1 204 No Content.
• The product could not be deleted or does not exist: HTTP/1.1 400 Bad Request.