Request

PUT http:///api/v1/partner/products/{productId}

Path parameters

Parameter name Value Description Additional
productId string Required

Request body

The request body takes a complete PartnerProductUpdateRequest resource, containing the following writable properties:

{
    "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",
    "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",
    "employeeId": "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",
    "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",
        "vendorType": "string",
        "website": "string"
    },
    "vendorId": "string",
    "weightPerUnit": "string",
    "wmOnlineSellable": "boolean",
    "wmThreshold": "number"
}

Properties

Name Type Description Additional
active boolean Optional
assets[] array Optional
assets[].active boolean Optional
assets[].assetType string

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

product name

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

Possible values are:

  • None
  • HalfGramUnit
  • OneGramUnit
  • TwoGramUnits
  • ThreeGramUnits
  • FourGramUnits
  • FiveGramUnits
  • SixGramUnits
  • SevenGramUnits
  • EightGramUnits
Optional
priceBreaks[].priority int32 Optional
priceBreaks[].quantity int32 Optional
priceBreaks[].salePrice number Optional
priceBreaks[].updated boolean Optional
priceIncludesALExcise boolean Optional
priceIncludesExcise boolean Optional
priceRanges[] array Optional
priceRanges[].assignedPrice number Optional
priceRanges[].id string Optional
priceRanges[].price number Optional
priceRanges[].priority int32 Optional
priceRanges[].salePrice number Optional
priceRanges[].weightTolerance object ProductWeightTolerance Optional
priceRanges[].weightTolerance.companyId string Optional
priceRanges[].weightTolerance.created int64 Optional
priceRanges[].weightTolerance.deleted boolean Optional
priceRanges[].weightTolerance.enabled boolean Optional
priceRanges[].weightTolerance.endWeight number Optional
priceRanges[].weightTolerance.id string Optional
priceRanges[].weightTolerance.modified int64 Optional
priceRanges[].weightTolerance.name string Optional
priceRanges[].weightTolerance.priority int32 Optional
priceRanges[].weightTolerance.startWeight number Optional
priceRanges[].weightTolerance.unitValue number Optional
priceRanges[].weightTolerance.updated boolean Optional
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
priceRanges[].weightTolerance.weightValue number Optional
priceRanges[].weightToleranceId string Optional
pricingTemplateId string Optional
producerAddress object Address Optional
producerAddress.address string Optional
producerAddress.addressLine2 string Optional
producerAddress.city string Optional
producerAddress.companyId string Optional
producerAddress.country string Optional
producerAddress.created int64 Optional
producerAddress.deleted boolean Optional
producerAddress.id string Optional
producerAddress.latitude number Optional
producerAddress.longitude number Optional
producerAddress.modified int64 Optional
producerAddress.state string Optional
producerAddress.updated boolean Optional
producerAddress.zipCode string Optional
producerLicense string Optional
producerMfg string Optional
productSaleType string

Possible values are:

  • Medicinal
  • Recreational
  • Both
Optional
productType string

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
taxTables[].taxType string

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

  • CUSTOMER
  • VENDOR
  • BOTH
Optional
vendor.website string Optional
vendorId string Optional
weightPerUnit string

Possible values are:

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

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

Product

Explore this API

productId
body
Request Content-Type
Response Content-Type
Try it out!