Methods

  • get - Get All Products

Resource

{
    "limit": "int32",
    "skip": "int32",
    "total": "int64",
    "values": [
        {
            "active": "boolean",
            "assets": [
                {
                    "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"
                }
            ],
            "automaticReOrder": "boolean",
            "brand": {
                "active": "boolean",
                "brandLogo": {
                    "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"
                },
                "companyId": "string",
                "created": "int64",
                "default": "boolean",
                "deleted": "boolean",
                "externalId": "string",
                "id": "string",
                "modified": "int64",
                "name": "string",
                "phoneNo": "string",
                "updated": "boolean",
                "vendorList": [
                    "string"
                ],
                "website": "string"
            },
            "brandId": "string",
            "bundleItems": [
                {
                    "productId": "string",
                    "quantity": "number"
                }
            ],
            "byGram": "boolean",
            "byPrepackage": "boolean",
            "cannabisType": "string",
            "category": {
                "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"
            },
            "categoryId": "string",
            "cbd": "double",
            "cbda": "double",
            "cbn": "double",
            "committedQuantities": {
                "<key>": "number"
            },
            "companyId": "string",
            "companyLinkId": "string",
            "complianceId": "string",
            "created": "int64",
            "customGramType": "string",
            "customTaxInfo": {
                "cityTax": "number",
                "created": "int64",
                "deleted": "boolean",
                "federalTax": "number",
                "id": "string",
                "modified": "int64",
                "stateTax": "number",
                "updated": "boolean"
            },
            "customWeight": "number",
            "deleted": "boolean",
            "description": "string",
            "dirty": "boolean",
            "discountEnabled": "boolean",
            "discountable": "boolean",
            "dispatchPrepackageItemId": "string",
            "enableExciseTax": "boolean",
            "enableMixMatch": "boolean",
            "enableWeedmap": "boolean",
            "externalId": "string",
            "flowerType": "string",
            "genetics": "string",
            "id": "string",
            "importId": "string",
            "importSrc": "string",
            "instock": "boolean",
            "lastLeaflySyncStatus": "boolean",
            "lastLeaflySyncTime": "int64",
            "lastWMSyncTime": "int64",
            "lowInventoryNotification": "boolean",
            "lowThreshold": "number",
            "medicalConditions": [
                {
                    "created": "int64",
                    "deleted": "boolean",
                    "id": "string",
                    "modified": "int64",
                    "name": "string",
                    "updated": "boolean"
                }
            ],
            "medicinal": "boolean",
            "modified": "int64",
            "name": "string",
            "notes": [
                {
                    "created": "int64",
                    "deleted": "boolean",
                    "enableOnFleet": "boolean",
                    "id": "string",
                    "message": "string",
                    "modified": "int64",
                    "updated": "boolean",
                    "writerId": "string",
                    "writerName": "string"
                }
            ],
            "overrideMetrcCategoryId": "string",
            "potency": "boolean",
            "potencyAmount": {
                "cbd": "number",
                "cbda": "number",
                "cbn": "number",
                "thc": "number",
                "thca": "number"
            },
            "prepackageQuantities": {
                "<key>": {
                    "committedQuantities": {
                        "<key>": "int32"
                    },
                    "sellableQuantities": {
                        "<key>": "int32"
                    },
                    "totalCommittedQuantity": "int32",
                    "totalSellableQuantity": "int32"
                }
            },
            "priceBreaks": [
                {
                    "active": "boolean",
                    "assignedPrice": "number",
                    "companyId": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "displayName": "string",
                    "id": "string",
                    "modified": "int64",
                    "name": "string",
                    "price": "number",
                    "priceBreakType": "string",
                    "priority": "int32",
                    "quantity": "int32",
                    "salePrice": "number",
                    "updated": "boolean"
                }
            ],
            "priceIncludesALExcise": "boolean",
            "priceIncludesExcise": "boolean",
            "priceRanges": [
                {
                    "assignedPrice": "number",
                    "id": "string",
                    "price": "number",
                    "priority": "int32",
                    "salePrice": "number",
                    "weightTolerance": {
                        "companyId": "string",
                        "created": "int64",
                        "deleted": "boolean",
                        "enabled": "boolean",
                        "endWeight": "number",
                        "id": "string",
                        "modified": "int64",
                        "name": "string",
                        "priority": "int32",
                        "startWeight": "number",
                        "unitValue": "number",
                        "updated": "boolean",
                        "weightKey": "string",
                        "weightValue": "number"
                    },
                    "weightToleranceId": "string"
                }
            ],
            "pricingTemplateId": "string",
            "producerAddress": {
                "address": "string",
                "addressLine2": "string",
                "city": "string",
                "companyId": "string",
                "country": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "latitude": "number",
                "longitude": "number",
                "modified": "int64",
                "state": "string",
                "updated": "boolean",
                "zipCode": "string"
            },
            "producerLicense": "string",
            "producerMfg": "string",
            "productSaleType": "string",
            "productType": "string",
            "qbItemRef": "string",
            "quantities": [
                {
                    "companyId": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "dirty": "boolean",
                    "id": "string",
                    "inventoryId": "string",
                    "modified": "int64",
                    "quantity": "number",
                    "shopId": "string",
                    "updated": "boolean"
                }
            ],
            "reOrderLevel": "number",
            "salesPrice": "number",
            "secondaryVendors": [
                "string"
            ],
            "sellable": "boolean",
            "sellableQuantities": {
                "<key>": "number"
            },
            "shopId": "string",
            "showInWidget": "boolean",
            "sku": "string",
            "syncToThirdPartyMenus": "boolean",
            "tags": [
                "string"
            ],
            "taxOrder": "string",
            "taxTables": [
                {
                    "active": "boolean",
                    "cityTax": {
                        "active": "boolean",
                        "activeExciseTax": "boolean",
                        "companyId": "string",
                        "compound": "boolean",
                        "created": "int64",
                        "deleted": "boolean",
                        "dirty": "boolean",
                        "displayName": "string",
                        "id": "string",
                        "modified": "int64",
                        "shopId": "string",
                        "taxOrder": "string",
                        "taxRate": "number",
                        "territory": "string",
                        "updated": "boolean"
                    },
                    "companyId": "string",
                    "consumerType": "string",
                    "countyTax": {
                        "active": "boolean",
                        "activeExciseTax": "boolean",
                        "companyId": "string",
                        "compound": "boolean",
                        "created": "int64",
                        "deleted": "boolean",
                        "dirty": "boolean",
                        "displayName": "string",
                        "id": "string",
                        "modified": "int64",
                        "shopId": "string",
                        "taxOrder": "string",
                        "taxRate": "number",
                        "territory": "string",
                        "updated": "boolean"
                    },
                    "created": "int64",
                    "deleted": "boolean",
                    "dirty": "boolean",
                    "federalTax": {
                        "active": "boolean",
                        "activeExciseTax": "boolean",
                        "companyId": "string",
                        "compound": "boolean",
                        "created": "int64",
                        "deleted": "boolean",
                        "dirty": "boolean",
                        "displayName": "string",
                        "id": "string",
                        "modified": "int64",
                        "shopId": "string",
                        "taxOrder": "string",
                        "taxRate": "number",
                        "territory": "string",
                        "updated": "boolean"
                    },
                    "id": "string",
                    "modified": "int64",
                    "name": "string",
                    "shopId": "string",
                    "stateTax": {
                        "active": "boolean",
                        "activeExciseTax": "boolean",
                        "companyId": "string",
                        "compound": "boolean",
                        "created": "int64",
                        "deleted": "boolean",
                        "dirty": "boolean",
                        "displayName": "string",
                        "id": "string",
                        "modified": "int64",
                        "shopId": "string",
                        "taxOrder": "string",
                        "taxRate": "number",
                        "territory": "string",
                        "updated": "boolean"
                    },
                    "taxOrder": "string",
                    "taxType": "string",
                    "updated": "boolean"
                }
            ],
            "taxType": "string",
            "thc": "double",
            "thca": "double",
            "toleranceId": "string",
            "totalCommittedQuantity": "number",
            "totalSellableQuantity": "number",
            "unitPrice": "number",
            "unitValue": "number",
            "updated": "boolean",
            "usableMarijuana": "number",
            "vendor": {
                "accountOwnerId": "string",
                "active": "boolean",
                "additionalAddressList": [
                    {
                        "address": "string",
                        "addressLine2": "string",
                        "city": "string",
                        "companyId": "string",
                        "country": "string",
                        "created": "int64",
                        "deleted": "boolean",
                        "id": "string",
                        "latitude": "number",
                        "longitude": "number",
                        "modified": "int64",
                        "state": "string",
                        "updated": "boolean",
                        "zipCode": "string"
                    }
                ],
                "address": {
                    "address": "string",
                    "addressLine2": "string",
                    "city": "string",
                    "companyId": "string",
                    "country": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "id": "string",
                    "latitude": "number",
                    "longitude": "number",
                    "modified": "int64",
                    "state": "string",
                    "updated": "boolean",
                    "zipCode": "string"
                },
                "armsLengthType": "string",
                "assets": [
                    {
                        "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"
                    }
                ],
                "backOrderEnabled": "boolean",
                "brands": [
                    "string"
                ],
                "companyId": "string",
                "companyLicenses": [
                    {
                        "companyType": "string",
                        "created": "int64",
                        "deleted": "boolean",
                        "id": "string",
                        "licenseExpirationDate": "int64",
                        "licenseNumber": "string",
                        "licenseType": "string",
                        "modified": "int64",
                        "toDefault": "boolean",
                        "updated": "boolean"
                    }
                ],
                "companyType": "string",
                "connectedShop": "string",
                "contactPerson": "string",
                "created": "int64",
                "createdBy": "string",
                "credits": "number",
                "dbaName": "string",
                "defaultContactId": "string",
                "defaultPaymentTerm": "string",
                "deleted": "boolean",
                "description": "string",
                "email": "string",
                "externalId": "string",
                "fax": "string",
                "firstName": "string",
                "id": "string",
                "importId": "string",
                "lastName": "string",
                "licenceType": "string",
                "licenseExpirationDate": "int64",
                "licenseNumber": "string",
                "mobileNumber": "string",
                "modified": "int64",
                "name": "string",
                "notes": [
                    {
                        "created": "int64",
                        "deleted": "boolean",
                        "enableOnFleet": "boolean",
                        "id": "string",
                        "message": "string",
                        "modified": "int64",
                        "updated": "boolean",
                        "writerId": "string",
                        "writerName": "string"
                    }
                ],
                "phone": "string",
                "qbVendorRef": [
                    {
                        "<key>": "string"
                    }
                ],
                "relatedEntity": "boolean",
                "salesPerson": "string",
                "toDefault": "boolean",
                "updated": "boolean",
                "vendorKey": "string",
                "vendorType": "string",
                "website": "string"
            },
            "vendorId": "string",
            "weightPerUnit": "string",
            "wmOnlineSellable": "boolean",
            "wmThreshold": "number"
        }
    ]
}

Properties

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

Possible values are:

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

Possible values are:

  • Photo
  • Document
  • Kml
Optional
values[].assets[].updated boolean Optional
values[].automaticReOrder boolean Optional
values[].brand object Brand Optional
values[].brand.active boolean Optional
values[].brand.brandLogo object CompanyAsset Optional
values[].brand.brandLogo.active boolean Optional
values[].brand.brandLogo.assetType string

Possible values are:

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

Possible values are:

  • Photo
  • Document
  • Kml
Optional
values[].brand.brandLogo.updated boolean Optional
values[].brand.companyId string Optional
values[].brand.created int64 Optional
values[].brand.default boolean Optional
values[].brand.deleted boolean Optional
values[].brand.externalId string Optional
values[].brand.id string Optional
values[].brand.modified int64 Optional
values[].brand.name string Optional
values[].brand.phoneNo string Optional
values[].brand.updated boolean Optional
values[].brand.vendorList[] array of string Optional
values[].brand.website string Optional
values[].brandId string Optional
values[].bundleItems[] array Optional
values[].bundleItems[].productId string Optional
values[].bundleItems[].quantity number Optional
values[].byGram boolean Optional
values[].byPrepackage 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[].category object ProductCategory Optional
values[].category.active boolean Optional
values[].category.cannabis boolean Optional
values[].category.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[].category.companyId string Optional
values[].category.complianceId string Optional
values[].category.created int64 Optional
values[].category.deleted boolean Optional
values[].category.dirty boolean Optional
values[].category.externalId string Optional
values[].category.id string Optional
values[].category.lowThreshold number Optional
values[].category.modified int64 Optional
values[].category.name string Optional
values[].category.photo object CompanyAsset Optional
values[].category.photo.active boolean Optional
values[].category.photo.assetType string

Possible values are:

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

Possible values are:

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

Possible values are:

  • units
  • grams
Optional
values[].category.updated boolean Optional
values[].category.wmCategory string Optional
values[].categoryId string Optional
values[].cbd double Optional
values[].cbda double Optional
values[].cbn double Optional
values[].committedQuantities object Optional
values[].committedQuantities.<key> map of number Optional
values[].companyId string Optional
values[].companyLinkId string Optional, read only.
values[].complianceId string Optional
values[].created int64 Optional
values[].customGramType string

Possible values are:

  • GRAM
  • MILLIGRAM
  • MILLILITER
  • FLUID_OUNCE
Optional
values[].customTaxInfo object TaxInfo Optional
values[].customTaxInfo.cityTax number Optional
values[].customTaxInfo.created int64 Optional
values[].customTaxInfo.deleted boolean Optional
values[].customTaxInfo.federalTax number Optional
values[].customTaxInfo.id string Optional
values[].customTaxInfo.modified int64 Optional
values[].customTaxInfo.stateTax number Optional
values[].customTaxInfo.updated boolean Optional
values[].customWeight number Optional
values[].deleted boolean Optional
values[].description string Optional
values[].dirty boolean Optional
values[].discountEnabled boolean Optional
values[].discountable boolean Optional
values[].dispatchPrepackageItemId string Optional
values[].enableExciseTax boolean Optional
values[].enableMixMatch boolean Optional
values[].enableWeedmap boolean Optional
values[].externalId string Optional
values[].flowerType string Optional
values[].genetics string Optional
values[].id string Optional
values[].importId string Optional
values[].importSrc string Optional
values[].instock boolean Optional
values[].lastLeaflySyncStatus boolean Optional
values[].lastLeaflySyncTime int64 Optional
values[].lastWMSyncTime int64 Optional
values[].lowInventoryNotification boolean Optional
values[].lowThreshold number Optional
values[].medicalConditions[] array Optional
values[].medicalConditions[].created int64 Optional
values[].medicalConditions[].deleted boolean Optional
values[].medicalConditions[].id string Optional
values[].medicalConditions[].modified int64 Optional
values[].medicalConditions[].name string Optional
values[].medicalConditions[].updated boolean Optional
values[].medicinal boolean Optional
values[].modified int64 Optional
values[].name string

product name

values[].notes[] array Optional
values[].notes[].created int64 Optional
values[].notes[].deleted boolean Optional
values[].notes[].enableOnFleet boolean Optional
values[].notes[].id string Optional
values[].notes[].message string Optional
values[].notes[].modified int64 Optional
values[].notes[].updated boolean Optional
values[].notes[].writerId string Optional
values[].notes[].writerName string Optional
values[].overrideMetrcCategoryId string Optional
values[].potency boolean Optional
values[].potencyAmount object PotencyMG Optional
values[].potencyAmount.cbd number Optional
values[].potencyAmount.cbda number Optional
values[].potencyAmount.cbn number Optional
values[].potencyAmount.thc number Optional
values[].potencyAmount.thca number Optional
values[].prepackageQuantities object Optional
values[].prepackageQuantities.<key> map of object PrepackageQuantity Optional
values[].prepackageQuantities.<key>.committedQuantities object Optional
values[].prepackageQuantities.<key>.committedQuantities.<key> map of int32 Optional
values[].prepackageQuantities.<key>.sellableQuantities object Optional
values[].prepackageQuantities.<key>.sellableQuantities.<key> map of int32 Optional
values[].prepackageQuantities.<key>.totalCommittedQuantity int32 Optional
values[].prepackageQuantities.<key>.totalSellableQuantity int32 Optional
values[].priceBreaks[] array Optional
values[].priceBreaks[].active boolean Optional
values[].priceBreaks[].assignedPrice number Optional
values[].priceBreaks[].companyId string Optional
values[].priceBreaks[].created int64 Optional
values[].priceBreaks[].deleted boolean Optional
values[].priceBreaks[].displayName string Optional
values[].priceBreaks[].id string Optional
values[].priceBreaks[].modified int64 Optional
values[].priceBreaks[].name string Optional
values[].priceBreaks[].price number Optional
values[].priceBreaks[].priceBreakType string

Possible values are:

  • None
  • HalfGramUnit
  • OneGramUnit
  • TwoGramUnits
  • ThreeGramUnits
  • FourGramUnits
  • FiveGramUnits
  • SixGramUnits
  • SevenGramUnits
  • EightGramUnits
Optional
values[].priceBreaks[].priority int32 Optional
values[].priceBreaks[].quantity int32 Optional
values[].priceBreaks[].salePrice number Optional
values[].priceBreaks[].updated boolean Optional
values[].priceIncludesALExcise boolean Optional
values[].priceIncludesExcise boolean Optional
values[].priceRanges[] array Optional
values[].priceRanges[].assignedPrice number Optional
values[].priceRanges[].id string Optional
values[].priceRanges[].price number Optional
values[].priceRanges[].priority int32 Optional
values[].priceRanges[].salePrice number Optional
values[].priceRanges[].weightTolerance object ProductWeightTolerance Optional
values[].priceRanges[].weightTolerance.companyId string Optional
values[].priceRanges[].weightTolerance.created int64 Optional
values[].priceRanges[].weightTolerance.deleted boolean Optional
values[].priceRanges[].weightTolerance.enabled boolean Optional
values[].priceRanges[].weightTolerance.endWeight number Optional
values[].priceRanges[].weightTolerance.id string Optional
values[].priceRanges[].weightTolerance.modified int64 Optional
values[].priceRanges[].weightTolerance.name string Optional
values[].priceRanges[].weightTolerance.priority int32 Optional
values[].priceRanges[].weightTolerance.startWeight number Optional
values[].priceRanges[].weightTolerance.unitValue number Optional
values[].priceRanges[].weightTolerance.updated boolean Optional
values[].priceRanges[].weightTolerance.weightKey string

Possible values are:

  • UNIT
  • HALF_GRAM
  • GRAM
  • TWO_GRAMS
  • THREE_GRAMS
  • ONE_EIGHTTH
  • QUARTER
  • HALF
  • OUNCE
  • CUSTOM
  • POUND
  • FLUID_OZ
Optional
values[].priceRanges[].weightTolerance.weightValue number Optional
values[].priceRanges[].weightToleranceId string Optional
values[].pricingTemplateId string Optional
values[].producerAddress object Address Optional
values[].producerAddress.address string Optional
values[].producerAddress.addressLine2 string Optional
values[].producerAddress.city string Optional
values[].producerAddress.companyId string Optional
values[].producerAddress.country string Optional
values[].producerAddress.created int64 Optional
values[].producerAddress.deleted boolean Optional
values[].producerAddress.id string Optional
values[].producerAddress.latitude number Optional
values[].producerAddress.longitude number Optional
values[].producerAddress.modified int64 Optional
values[].producerAddress.state string Optional
values[].producerAddress.updated boolean Optional
values[].producerAddress.zipCode string Optional
values[].producerLicense string Optional
values[].producerMfg string Optional
values[].productSaleType string

Possible values are:

  • Medicinal
  • Recreational
  • Both
Optional
values[].productType string

Possible values are:

  • REGULAR
  • DERIVED
  • BUNDLE
Optional
values[].qbItemRef string Optional
values[].quantities[] array Optional
values[].quantities[].companyId string Optional
values[].quantities[].created int64 Optional
values[].quantities[].deleted boolean Optional
values[].quantities[].dirty boolean Optional
values[].quantities[].id string Optional
values[].quantities[].inventoryId string Optional
values[].quantities[].modified int64 Optional
values[].quantities[].quantity number Optional
values[].quantities[].shopId string Optional
values[].quantities[].updated boolean Optional
values[].reOrderLevel number Optional
values[].salesPrice number Optional
values[].secondaryVendors[] array of string Optional
values[].sellable boolean Optional
values[].sellableQuantities object Optional
values[].sellableQuantities.<key> map of number Optional
values[].shopId string Optional
values[].showInWidget boolean Optional
values[].sku string Optional
values[].syncToThirdPartyMenus boolean Optional, read only.
values[].tags[] array of string Optional
values[].taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
values[].taxTables[] array Optional
values[].taxTables[].active boolean Optional
values[].taxTables[].cityTax object CompoundTaxRate Optional
values[].taxTables[].cityTax.active boolean Optional
values[].taxTables[].cityTax.activeExciseTax boolean Optional
values[].taxTables[].cityTax.companyId string Optional
values[].taxTables[].cityTax.compound boolean Optional
values[].taxTables[].cityTax.created int64 Optional
values[].taxTables[].cityTax.deleted boolean Optional
values[].taxTables[].cityTax.dirty boolean Optional
values[].taxTables[].cityTax.displayName string Optional
values[].taxTables[].cityTax.id string Optional
values[].taxTables[].cityTax.modified int64 Optional
values[].taxTables[].cityTax.shopId string Optional
values[].taxTables[].cityTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
values[].taxTables[].cityTax.taxRate number Optional
values[].taxTables[].cityTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
values[].taxTables[].cityTax.updated boolean Optional
values[].taxTables[].companyId string Optional
values[].taxTables[].consumerType string

Possible values are:

  • Other
  • AdultUse
  • MedicinalState
  • MedicinalThirdParty
Optional
values[].taxTables[].countyTax object CompoundTaxRate Optional
values[].taxTables[].countyTax.active boolean Optional
values[].taxTables[].countyTax.activeExciseTax boolean Optional
values[].taxTables[].countyTax.companyId string Optional
values[].taxTables[].countyTax.compound boolean Optional
values[].taxTables[].countyTax.created int64 Optional
values[].taxTables[].countyTax.deleted boolean Optional
values[].taxTables[].countyTax.dirty boolean Optional
values[].taxTables[].countyTax.displayName string Optional
values[].taxTables[].countyTax.id string Optional
values[].taxTables[].countyTax.modified int64 Optional
values[].taxTables[].countyTax.shopId string Optional
values[].taxTables[].countyTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
values[].taxTables[].countyTax.taxRate number Optional
values[].taxTables[].countyTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
values[].taxTables[].countyTax.updated boolean Optional
values[].taxTables[].created int64 Optional
values[].taxTables[].deleted boolean Optional
values[].taxTables[].dirty boolean Optional
values[].taxTables[].federalTax object CompoundTaxRate Optional
values[].taxTables[].federalTax.active boolean Optional
values[].taxTables[].federalTax.activeExciseTax boolean Optional
values[].taxTables[].federalTax.companyId string Optional
values[].taxTables[].federalTax.compound boolean Optional
values[].taxTables[].federalTax.created int64 Optional
values[].taxTables[].federalTax.deleted boolean Optional
values[].taxTables[].federalTax.dirty boolean Optional
values[].taxTables[].federalTax.displayName string Optional
values[].taxTables[].federalTax.id string Optional
values[].taxTables[].federalTax.modified int64 Optional
values[].taxTables[].federalTax.shopId string Optional
values[].taxTables[].federalTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
values[].taxTables[].federalTax.taxRate number Optional
values[].taxTables[].federalTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
values[].taxTables[].federalTax.updated boolean Optional
values[].taxTables[].id string Optional
values[].taxTables[].modified int64 Optional
values[].taxTables[].name string Optional
values[].taxTables[].shopId string Optional
values[].taxTables[].stateTax object CompoundTaxRate Optional
values[].taxTables[].stateTax.active boolean Optional
values[].taxTables[].stateTax.activeExciseTax boolean Optional
values[].taxTables[].stateTax.companyId string Optional
values[].taxTables[].stateTax.compound boolean Optional
values[].taxTables[].stateTax.created int64 Optional
values[].taxTables[].stateTax.deleted boolean Optional
values[].taxTables[].stateTax.dirty boolean Optional
values[].taxTables[].stateTax.displayName string Optional
values[].taxTables[].stateTax.id string Optional
values[].taxTables[].stateTax.modified int64 Optional
values[].taxTables[].stateTax.shopId string Optional
values[].taxTables[].stateTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
values[].taxTables[].stateTax.taxRate number Optional
values[].taxTables[].stateTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
values[].taxTables[].stateTax.updated boolean Optional
values[].taxTables[].taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
values[].taxTables[].taxType string

Possible values are:

  • Default
  • Inherit
  • Custom
  • Exempt
Optional
values[].taxTables[].updated boolean Optional
values[].taxType string

Possible values are:

  • Default
  • Inherit
  • Custom
  • Exempt
Optional
values[].thc double Optional
values[].thca double Optional
values[].toleranceId string Optional
values[].totalCommittedQuantity number Optional
values[].totalSellableQuantity number Optional
values[].unitPrice number Optional
values[].unitValue number Optional
values[].updated boolean Optional
values[].usableMarijuana number Optional
values[].vendor object Vendor Optional
values[].vendor.accountOwnerId string Optional
values[].vendor.active boolean Optional
values[].vendor.additionalAddressList[] array Optional
values[].vendor.additionalAddressList[].address string Optional
values[].vendor.additionalAddressList[].addressLine2 string Optional
values[].vendor.additionalAddressList[].city string Optional
values[].vendor.additionalAddressList[].companyId string Optional
values[].vendor.additionalAddressList[].country string Optional
values[].vendor.additionalAddressList[].created int64 Optional
values[].vendor.additionalAddressList[].deleted boolean Optional
values[].vendor.additionalAddressList[].id string Optional
values[].vendor.additionalAddressList[].latitude number Optional
values[].vendor.additionalAddressList[].longitude number Optional
values[].vendor.additionalAddressList[].modified int64 Optional
values[].vendor.additionalAddressList[].state string Optional
values[].vendor.additionalAddressList[].updated boolean Optional
values[].vendor.additionalAddressList[].zipCode string Optional
values[].vendor.address object Address Optional
values[].vendor.address.address string Optional
values[].vendor.address.addressLine2 string Optional
values[].vendor.address.city string Optional
values[].vendor.address.companyId string Optional
values[].vendor.address.country string Optional
values[].vendor.address.created int64 Optional
values[].vendor.address.deleted boolean Optional
values[].vendor.address.id string Optional
values[].vendor.address.latitude number Optional
values[].vendor.address.longitude number Optional
values[].vendor.address.modified int64 Optional
values[].vendor.address.state string Optional
values[].vendor.address.updated boolean Optional
values[].vendor.address.zipCode string Optional
values[].vendor.armsLengthType string

Possible values are:

  • ARMS_LENGTH
  • NON_ARMS_LENGTH
Optional
values[].vendor.assets[] array Optional
values[].vendor.assets[].active boolean Optional
values[].vendor.assets[].assetType string

Possible values are:

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

Possible values are:

  • Photo
  • Document
  • Kml
Optional
values[].vendor.assets[].updated boolean Optional
values[].vendor.backOrderEnabled boolean Optional
values[].vendor.brands[] array of string Optional
values[].vendor.companyId string Optional
values[].vendor.companyLicenses[] array Optional
values[].vendor.companyLicenses[].companyType string

Possible values are:

  • DISTRIBUTOR
  • CULTIVATOR
  • RETAILER
  • MANUFACTURER
  • TRANSPORTER
  • OTHER
  • TESTING_FACILITY
Optional
values[].vendor.companyLicenses[].created int64 Optional
values[].vendor.companyLicenses[].deleted boolean Optional
values[].vendor.companyLicenses[].id string Optional
values[].vendor.companyLicenses[].licenseExpirationDate int64 Optional
values[].vendor.companyLicenses[].licenseNumber string Optional
values[].vendor.companyLicenses[].licenseType string

Possible values are:

  • RECREATIONAL
  • MEDICINAL
  • BOTH
Optional
values[].vendor.companyLicenses[].modified int64 Optional
values[].vendor.companyLicenses[].toDefault boolean Optional
values[].vendor.companyLicenses[].updated boolean Optional
values[].vendor.companyType string

Possible values are:

  • DISTRIBUTOR
  • CULTIVATOR
  • RETAILER
  • MANUFACTURER
  • TRANSPORTER
  • OTHER
  • TESTING_FACILITY
Optional
values[].vendor.connectedShop string Optional
values[].vendor.contactPerson string Optional
values[].vendor.created int64 Optional
values[].vendor.createdBy string Optional
values[].vendor.credits number Optional
values[].vendor.dbaName string Optional
values[].vendor.defaultContactId string Optional
values[].vendor.defaultPaymentTerm string Optional
values[].vendor.deleted boolean Optional
values[].vendor.description string Optional
values[].vendor.email string Optional
values[].vendor.externalId string Optional
values[].vendor.fax string Optional
values[].vendor.firstName string Optional
values[].vendor.id string Optional
values[].vendor.importId string Optional
values[].vendor.lastName string Optional
values[].vendor.licenceType string

Possible values are:

  • RECREATIONAL
  • MEDICINAL
  • BOTH
Optional
values[].vendor.licenseExpirationDate int64 Optional
values[].vendor.licenseNumber string Optional
values[].vendor.mobileNumber string Optional
values[].vendor.modified int64 Optional
values[].vendor.name string Optional
values[].vendor.notes[] array Optional
values[].vendor.notes[].created int64 Optional
values[].vendor.notes[].deleted boolean Optional
values[].vendor.notes[].enableOnFleet boolean Optional
values[].vendor.notes[].id string Optional
values[].vendor.notes[].message string Optional
values[].vendor.notes[].modified int64 Optional
values[].vendor.notes[].updated boolean Optional
values[].vendor.notes[].writerId string Optional
values[].vendor.notes[].writerName string Optional
values[].vendor.phone string Optional
values[].vendor.qbVendorRef[] array of object Optional
values[].vendor.qbVendorRef[].<key> map of string Optional
values[].vendor.relatedEntity boolean Optional
values[].vendor.salesPerson string Optional
values[].vendor.toDefault boolean Optional
values[].vendor.updated boolean Optional
values[].vendor.vendorKey string Optional, read only.
values[].vendor.vendorType string

Possible values are:

  • CUSTOMER
  • VENDOR
  • BOTH
Optional
values[].vendor.website string Optional
values[].vendorId string Optional
values[].weightPerUnit string

Possible values are:

  • EACH
  • HALF_GRAM
  • FULL_GRAM
  • TWO_GRAMS
  • EIGHTH
  • FOURTH
  • HALF_OUNCE
  • OUNCE
  • CUSTOM_GRAMS
  • POUND
  • FLUID_OZ
Optional
values[].wmOnlineSellable boolean Optional
values[].wmThreshold number Optional