MasterProductOffers (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.

Response Format¶

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

Example¶

POST /api/master_products/310/master_product_offers

Example JSON¶

{
    "company_id": "1"
}

This request creates a product offer of a common product with the id 310 for the vendor with the ID 1.

Response Format¶

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

{
   "product_id": 310
}

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

Example JSON¶

{
    "price": "100",
    "amount": "5"
}

This request updates the price and quantity of the product offer.

Response Format¶

• The product has been updated successfully: HTTP/1.1 200 OK and JSON with product_id.
• The product couldn’t be updated: HTTP/1.1 400 Bad Request.
• The product does not exist: HTTP/1.1 404 Not Found.

Response Format¶

• The product has been deleted successfully: HTTP/1.1 204 No Content.
• The product does not exist: HTTP/1.1 404 Not Found.
• The product couldn’t be deleted: HTTP/1.1 400 Bad Request.