SearchResultProductCategory resource

Methods

  • get - Get All Categories
  • get - Get Product Categories

Resource

{
    "limit": "int32",
    "skip": "int32",
    "total": "int64",
    "values": [
        {
            "active": "boolean",
            "cannabis": "boolean",
            "cannabisType": "string",
            "companyId": "string",
            "complianceId": "string",
            "created": "int64",
            "deleted": "boolean",
            "dirty": "boolean",
            "externalId": "string",
            "id": "string",
            "lowThreshold": "number",
            "modified": "int64",
            "name": "string",
            "photo": {
                "active": "boolean",
                "assetType": "string",
                "companyId": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "key": "string",
                "largeURL": "string",
                "largeX2URL": "string",
                "mediumURL": "string",
                "modified": "int64",
                "name": "string",
                "origURL": "string",
                "priority": "int32",
                "publicURL": "string",
                "secured": "boolean",
                "thumbURL": "string",
                "type": "string",
                "updated": "boolean"
            },
            "priority": "int32",
            "shopId": "string",
            "unitType": "string",
            "updated": "boolean",
            "wmCategory": "string"
        }
    ]
}

Properties

Name Type Description Additional
limit int32 Optional
skip int32 Optional
total int64 Optional
values[] array Optional
values[].active boolean Optional
values[].cannabis boolean Optional
values[].cannabisType string

Possible values are:

  • NONE
  • DEFAULT
  • NON_CANNABIS
  • CBD
  • CBD_CANNABIS
  • CBD_CANNABIS_FLOWER
  • CONCENTRATE
  • NON_CONCENTRATE
  • PLANT
  • EDIBLE
  • EXTRACT
  • DRY_FLOWER
  • KIEF
  • DRY_LEAF
  • LIQUID
  • SUPPOSITORY
  • TINCTURE
  • TOPICAL
  • OIL
  • SEEDS
  • THC
  • LIVE_PLANT
  • IMMATURE_PLANT
  • CLONE_CUTTING
  • CLONE_TISSUE_CULTURE
  • PRE_ROLL_FLOWER
  • PRE_ROLL_LEAF
  • PRE_ROLL_INFUSED
  • SEEDS_EA
  • PRE_ROLL
  • PRE_ROLL_CBD
 Optional
values[].companyId string Optional
values[].complianceId string Optional
values[].created int64 Optional
values[].deleted boolean Optional
values[].dirty boolean Optional
values[].externalId string Optional
values[].id string Optional
values[].lowThreshold number Optional
values[].modified int64 Optional
values[].name string Optional
values[].photo object CompanyAsset Optional
values[].photo.active boolean Optional
values[].photo.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
values[].photo.companyId string Optional
values[].photo.created int64 Optional
values[].photo.deleted boolean Optional
values[].photo.id string Optional
values[].photo.key string Optional
values[].photo.largeURL string Optional
values[].photo.largeX2URL string Optional
values[].photo.mediumURL string Optional
values[].photo.modified int64 Optional
values[].photo.name string Optional
values[].photo.origURL string Optional
values[].photo.priority int32 Optional
values[].photo.publicURL string Optional
values[].photo.secured boolean Optional
values[].photo.thumbURL string Optional
values[].photo.type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
values[].photo.updated boolean Optional
values[].priority int32 Optional
values[].shopId string Optional
values[].unitType string

Possible values are:

  • units
  • grams
 Optional
values[].updated boolean Optional
values[].wmCategory string Optional