SearchResultProductBatch resource

Methods

  • get - Get Batches
  • get - Get Batches By Dates
  • get - Get Batches By Dates

Resource

{
    "limit": "int32",
    "skip": "int32",
    "total": "int64",
    "values": [
        {
            "active": "boolean",
            "actualWeightPerUnit": "number",
            "archived": "boolean",
            "archivedDate": "int64",
            "armsLengthType": "string",
            "attachments": [
                {
                    "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"
                }
            ],
            "batchNo": "int32",
            "batchQRAsset": {
                "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"
            },
            "batchType": "string",
            "brandId": "string",
            "brandName": "string",
            "bundleItems": [
                {
                    "batchItems": [
                        {
                            "batchId": "string",
                            "inventoryId": "string",
                            "quantity": "number"
                        }
                    ],
                    "productId": "string"
                }
            ],
            "cannabinoidInfo": {
                "cbd": "string",
                "cbda": "string",
                "cbn": "string",
                "thc": "string",
                "thca": "string"
            },
            "cbd": "double",
            "cbda": "double",
            "cbn": "double",
            "companyId": "string",
            "complianceError": "string",
            "complianceInfo": {
                "allergens": "string",
                "directions": "string",
                "extractionProcess": "string",
                "finalTestingDate": "int64",
                "ingredients": "string",
                "labName": "string",
                "lotNumber": "string",
                "mjTypeAndSolventUsed": "string",
                "nutritionInfo": {
                    "sodium": "number",
                    "sugar": "number",
                    "totalCarbs": "number",
                    "totalFat": "number"
                },
                "packageDate": "int64",
                "packagedBy": "string",
                "packagedByLicense": "string",
                "packedBy": "string",
                "packedByRegistrationNo": "string",
                "produceDate": "int64",
                "producerEmail": "string",
                "producerLicense": "string",
                "producerName": "string",
                "producerPhone": "string",
                "producerRegistrationNo": "string",
                "producerWebsite": "string",
                "productionRunNumber": "string",
                "refrigeration": "string",
                "registrationCertificateNo": "string",
                "servingSize": "number",
                "servingsPerContainer": "number",
                "strain": "string",
                "testDate": "int64",
                "testedBy": "string",
                "totalThcPerServing": "number"
            },
            "connectedBatchId": "string",
            "cost": "number",
            "costPerUnit": "number",
            "created": "int64",
            "customerCompanyId": "string",
            "deleted": "boolean",
            "derivedLogId": "string",
            "dirty": "boolean",
            "expirationDate": "int64",
            "externalId": "string",
            "externalLicense": "string",
            "finalTestingDate": "int64",
            "flowerSourceType": "string",
            "fromTestSample": "boolean",
            "id": "string",
            "labelInfo": "string",
            "licenseId": "string",
            "liveQuantity": "number",
            "lotId": "string",
            "metrcCategory": "string",
            "metrcLabTestingState": "string",
            "metrcQuantity": "number",
            "metrcTagId": "string",
            "modified": "int64",
            "moistureLoss": "double",
            "notes": [
                {
                    "created": "int64",
                    "deleted": "boolean",
                    "enableOnFleet": "boolean",
                    "id": "string",
                    "message": "string",
                    "modified": "int64",
                    "updated": "boolean",
                    "writerId": "string",
                    "writerName": "string"
                }
            ],
            "packageDate": "int64",
            "perUnitExciseTax": "number",
            "poNumber": "string",
            "potencyAmount": {
                "cbd": "number",
                "cbda": "number",
                "cbn": "number",
                "thc": "number",
                "thca": "number"
            },
            "potencyAmountInfo": {
                "cbd": "string",
                "cbda": "string",
                "cbn": "string",
                "thc": "string",
                "thca": "string"
            },
            "prepaidTax": "boolean",
            "produceDate": "int64",
            "productBatchLabel": {
                "enableCultivationName": "boolean",
                "enableTestDate": "boolean",
                "enableTestResults": "boolean",
                "enabledBarCode": "boolean",
                "enabledPackageId": "boolean",
                "enabledProductName": "boolean",
                "enabledQRCode": "boolean",
                "enablesBatchId": "boolean",
                "enablesLotId": "boolean",
                "enablesNetWeight": "boolean",
                "labelType": "string"
            },
            "productId": "string",
            "productName": "string",
            "productionBatch": "boolean",
            "published": "boolean",
            "publishedDate": "int64",
            "publishedQuantity": "number",
            "purchaseOrderId": "string",
            "purchasedDate": "int64",
            "quantity": "number",
            "receiveDate": "int64",
            "referenceNote": {
                "created": "int64",
                "deleted": "boolean",
                "enableOnFleet": "boolean",
                "id": "string",
                "message": "string",
                "modified": "int64",
                "updated": "boolean",
                "writerId": "string",
                "writerName": "string"
            },
            "requestedStatus": "string",
            "roomId": "string",
            "sellBy": "int64",
            "shopId": "string",
            "sku": "string",
            "status": "string",
            "terpenoids": {
                "<key>": "number"
            },
            "thc": "double",
            "thca": "double",
            "totalCultivationTax": "number",
            "totalExciseTax": "number",
            "trackHarvestBatch": "string",
            "trackHarvestDate": "string",
            "trackHarvestName": "string",
            "trackPackageId": "int32",
            "trackPackageLabel": "string",
            "trackTraceSystem": "string",
            "trackTraceVerified": "boolean",
            "trackWeight": "string",
            "unProcessed": "boolean",
            "updated": "boolean",
            "vendorId": "string",
            "vendorName": "string",
            "voidStatus": "boolean",
            "waste": "number"
        }
    ]
}

Properties

Name Type Description Additional
limit int32 Optional
skip int32 Optional
total int64 Optional
values[] array Optional
values[].active boolean Optional
values[].actualWeightPerUnit number Optional
values[].archived boolean Optional
values[].archivedDate int64 Optional
values[].armsLengthType string

Possible values are:

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

Possible values are:

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

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
values[].attachments[].updated boolean Optional
values[].batchNo int32 Optional
values[].batchQRAsset object CompanyAsset Optional
values[].batchQRAsset.active boolean Optional
values[].batchQRAsset.assetType string

Possible values are:

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

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
values[].batchQRAsset.updated boolean Optional
values[].batchType string

Possible values are:

  • SAMPLE
  • SALE
 Optional
values[].brandId string Optional
values[].brandName string Optional
values[].bundleItems[] array Optional
values[].bundleItems[].batchItems[] array Optional
values[].bundleItems[].batchItems[].batchId string Optional
values[].bundleItems[].batchItems[].inventoryId string Optional
values[].bundleItems[].batchItems[].quantity number Optional
values[].bundleItems[].productId string Optional
values[].cannabinoidInfo object CannabinoidInfoValue Optional
values[].cannabinoidInfo.cbd string

Possible values are:

  • NUMERIC
  • LOD
  • LOQ
 Optional
values[].cannabinoidInfo.cbda string

Possible values are:

  • NUMERIC
  • LOD
  • LOQ
 Optional
values[].cannabinoidInfo.cbn string

Possible values are:

  • NUMERIC
  • LOD
  • LOQ
 Optional
values[].cannabinoidInfo.thc string

Possible values are:

  • NUMERIC
  • LOD
  • LOQ
 Optional
values[].cannabinoidInfo.thca string

Possible values are:

  • NUMERIC
  • LOD
  • LOQ
 Optional
values[].cbd double Optional
values[].cbda double Optional
values[].cbn double Optional
values[].companyId string Optional
values[].complianceError string Optional
values[].complianceInfo object ComplianceInfo Optional
values[].complianceInfo.allergens string Optional
values[].complianceInfo.directions string Optional
values[].complianceInfo.extractionProcess string Optional
values[].complianceInfo.finalTestingDate int64 Optional
values[].complianceInfo.ingredients string Optional
values[].complianceInfo.labName string Optional
values[].complianceInfo.lotNumber string Optional
values[].complianceInfo.mjTypeAndSolventUsed string Optional
values[].complianceInfo.nutritionInfo object NutritionInfo Optional
values[].complianceInfo.nutritionInfo.sodium number Optional
values[].complianceInfo.nutritionInfo.sugar number Optional
values[].complianceInfo.nutritionInfo.totalCarbs number Optional
values[].complianceInfo.nutritionInfo.totalFat number Optional
values[].complianceInfo.packageDate int64 Optional
values[].complianceInfo.packagedBy string Optional
values[].complianceInfo.packagedByLicense string Optional
values[].complianceInfo.packedBy string Optional
values[].complianceInfo.packedByRegistrationNo string Optional
values[].complianceInfo.produceDate int64 Optional
values[].complianceInfo.producerEmail string Optional
values[].complianceInfo.producerLicense string Optional
values[].complianceInfo.producerName string Optional
values[].complianceInfo.producerPhone string Optional
values[].complianceInfo.producerRegistrationNo string Optional
values[].complianceInfo.producerWebsite string Optional
values[].complianceInfo.productionRunNumber string Optional
values[].complianceInfo.refrigeration string Optional
values[].complianceInfo.registrationCertificateNo string Optional
values[].complianceInfo.servingSize number Optional
values[].complianceInfo.servingsPerContainer number Optional
values[].complianceInfo.strain string Optional
values[].complianceInfo.testDate int64 Optional
values[].complianceInfo.testedBy string Optional
values[].complianceInfo.totalThcPerServing number Optional
values[].connectedBatchId string Optional
values[].cost number Optional
values[].costPerUnit number Optional
values[].created int64 Optional
values[].customerCompanyId string Optional
values[].deleted boolean Optional
values[].derivedLogId string Optional
values[].dirty boolean Optional
values[].expirationDate int64 Optional
values[].externalId string Optional
values[].externalLicense string Optional
values[].finalTestingDate int64 Optional
values[].flowerSourceType string

Possible values are:

  • CULTIVATOR_DIRECT
  • DISTRIBUTOR
 Optional
values[].fromTestSample boolean Optional
values[].id string Optional
values[].labelInfo string Optional
values[].licenseId string Optional
values[].liveQuantity number Optional
values[].lotId string Optional
values[].metrcCategory string Optional
values[].metrcLabTestingState string Optional
values[].metrcQuantity number Optional
values[].metrcTagId string Optional
values[].modified int64 Optional
values[].moistureLoss double Optional
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[].packageDate int64 Optional
values[].perUnitExciseTax number Optional
values[].poNumber string 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[].potencyAmountInfo object CannabinoidInfoValue Optional
values[].potencyAmountInfo.cbd string

Possible values are:

  • NUMERIC
  • LOD
  • LOQ
 Optional
values[].potencyAmountInfo.cbda string

Possible values are:

  • NUMERIC
  • LOD
  • LOQ
 Optional
values[].potencyAmountInfo.cbn string

Possible values are:

  • NUMERIC
  • LOD
  • LOQ
 Optional
values[].potencyAmountInfo.thc string

Possible values are:

  • NUMERIC
  • LOD
  • LOQ
 Optional
values[].potencyAmountInfo.thca string

Possible values are:

  • NUMERIC
  • LOD
  • LOQ
 Optional
values[].prepaidTax boolean Optional
values[].produceDate int64 Optional
values[].productBatchLabel object ProductBatchLabel Optional
values[].productBatchLabel.enableCultivationName boolean Optional
values[].productBatchLabel.enableTestDate boolean Optional
values[].productBatchLabel.enableTestResults boolean Optional
values[].productBatchLabel.enabledBarCode boolean Optional
values[].productBatchLabel.enabledPackageId boolean Optional
values[].productBatchLabel.enabledProductName boolean Optional
values[].productBatchLabel.enabledQRCode boolean Optional
values[].productBatchLabel.enablesBatchId boolean Optional
values[].productBatchLabel.enablesLotId boolean Optional
values[].productBatchLabel.enablesNetWeight boolean Optional
values[].productBatchLabel.labelType string

Possible values are:

  • TEST_RESULT
  • PRODUCT_ID
 Optional
values[].productId string Optional
values[].productName string Optional
values[].productionBatch boolean Optional
values[].published boolean Optional
values[].publishedDate int64 Optional
values[].publishedQuantity number Optional
values[].purchaseOrderId string Optional
values[].purchasedDate int64 Optional
values[].quantity number Optional
values[].receiveDate int64 Optional
values[].referenceNote object Note Optional
values[].referenceNote.created int64 Optional
values[].referenceNote.deleted boolean Optional
values[].referenceNote.enableOnFleet boolean Optional
values[].referenceNote.id string Optional
values[].referenceNote.message string Optional
values[].referenceNote.modified int64 Optional
values[].referenceNote.updated boolean Optional
values[].referenceNote.writerId string Optional
values[].referenceNote.writerName string Optional
values[].requestedStatus string

Possible values are:

  • RECEIVED
  • IN_TESTING
  • READY_FOR_SALE
  • PROCESSING
  • ERROR
 Optional
values[].roomId string Optional
values[].sellBy int64 Optional
values[].shopId string Optional
values[].sku string Optional
values[].status string

Possible values are:

  • RECEIVED
  • IN_TESTING
  • READY_FOR_SALE
  • PROCESSING
  • ERROR
 Optional
values[].terpenoids object Optional
values[].terpenoids.<key> map of number Optional
values[].thc double Optional
values[].thca double Optional
values[].totalCultivationTax number Optional
values[].totalExciseTax number Optional
values[].trackHarvestBatch string Optional
values[].trackHarvestDate string Optional
values[].trackHarvestName string Optional
values[].trackPackageId int32 Optional
values[].trackPackageLabel string Optional
values[].trackTraceSystem string

Possible values are:

  • MANUAL
  • METRC
 Optional
values[].trackTraceVerified boolean Optional
values[].trackWeight string

Possible values are:

  • UNIT
  • HALF_GRAM
  • GRAM
  • TWO_GRAMS
  • THREE_GRAMS
  • ONE_EIGHTTH
  • QUARTER
  • HALF
  • OUNCE
  • CUSTOM
  • POUND
  • FLUID_OZ
 Optional
values[].unProcessed boolean Optional
values[].updated boolean Optional
values[].vendorId string Optional
values[].vendorName string Optional
values[].voidStatus boolean Optional
values[].waste number Optional