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