Get a page of product groups

​

Query Parameters

  • PageIndex
    Type: integerFormat: int32

    The page index of the search.

  • PageSize
    Type: integerFormat: int32

    The number of product groups to be returned in the response. Returns pages of up to 50 records.

  • SearchText
    Type: string

    The search text to filter product groups by. This can be all or part of a product group name.

  • Status
    Type: enum

    The status to filter product groups by.

Responses

  • application/json
Request Example for get/v1/product-groups
curl 'https://api.consignlyhq.com/v1/product-groups?PageIndex=1&PageSize=25&SearchText=frozen%20goods&Status=1'

{
  "index": 1,
  "total": 1,
  "productGroups": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": null,
      "status": "enum (Active = 1, Inactive = 2)"
    }
  ]
}

OK