List product families - celdotro/marketplace GitHub Wiki

About

  • List product families

Class

celmarket\Products\ProductsList

Method

getProductsFamilies

Parameters

  • start = start position
  • limit = total number of records
  • search = name based search

Response

An object with the following attributes

  • data = family data -> array
    • family_id = family ID
    • family_name = family's name
    • characteristics = family's characteristics -> array
      • charact = characteristic's ID
      • mode = characteristic's type
        • 1 => text
        • 2 => image
      • charactName = characteristic's name
      • productsNr = family's number of products
  • count = number of returned records
  • start = start position
  • limit = limit of returned records

Example - PHP

Example - JSON

{
  "request": {
    "start": 0,
    "limit": 1,
    "search": "X"
  },
  
  "response": {
    "data": [
      {
        "family_id": 1,
        "family_name": "X",
        "characteristics": [
          {
            "charact": 1,
            "mode": 1,
            "charactName": "X",
            "productsNr": "X"
          }
        ]
      }
    ],
    "count": 1,
    "start": 1,
    "limit": 1
  }
}
⚠️ **GitHub.com Fallback** ⚠️