PHphorest
Product

List products

Get a list of products for the specified business id and branch id. List can be filtered by product type, DateTime of update, name and barcode and possibility to include archived products in the list or only to list archived, low in stock or out of stock products

get/api/business/{businessId}/branch/{branchId}/product

Request

Path parameters

businessIdstring required
branchIdstring required

Query parameters

productTypestring

type of product to filter by

searchQuerystring

query to search for a product by name or barcode

archivedOnlyboolean

list only archived products

outOfStockboolean

list only out of stock products

lowStockboolean

list only low in stock products

includeArchivedboolean

include archived products in the list

updated_fromstring

date-time from which the products has been updated onwards

updated_tostring

date-time to which the products has been updated backwards

number of products records to return, max is 200

page number, default is 0 and is optional

Response

Products listed

Example response

{
  "_embedded": {
    "products": [
      {
        "productId": "12323",
        "parentProductId": "12323",
        "name": "Gentle Foaming Cleanser Combination/Oily Skin",
        "brandId": "123",
        "brandName": "100% Pure",
        "categoryId": "123456",
        "categoryName": "2 Minute Root Touch-ups",
        "price": 30,
        "minQuantity": 1,
        "maxQuantity": 19,
        "type": "RETAIL, COLOUR, PROFESSIONAL",
        "barcode": "2313131312",
        "measurementQuantity": 8,
        "measurementUnit": "ml",
        "reorderCount": 10,
        "reorderCost": 20,
        "quantityInStock": -2,
        "code": "134"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.