Batches

Manage product batches including batch quantities, inventory transfers, and batch date queries.

Base URL: /api/v1/partner/store/batches

Endpoints Overview

Method	Endpoint	Description
GET	/	Get Batches
GET	/dates	Get Batches By Dates
GET	/dates/purchaseDate	Get Batches By Dates
GET	/{productId}/batchQuantityInfo	Get Batch Quantity By Product
GET	/quantities	Get Batch Quantity By Inventory
POST	/transferInventory	Inventory transfer For Partner
PUT	/transferInventory/{historyId}	Inventory transfer For Partner
POST	/transferInventory/{historyId}/accept	Accept inventory transfer history's status for partner
POST	/transferInventory/{historyId}/decline	Decline inventory transfer history's status for partner

---

Get Batches

GET /api/v1/partner/store/batches

Retrieve a paginated list of product batches. You can filter by productId, status, or search by term. If batchId is provided, it returns that single batch directly and ignores all other filters. Results are capped at 100 per page and sorted by most recently modified first.

Query Parameters

Parameter	Type	Required	Description
batchId	string	No	batch i d
productId	string	No	product i d
start	integer	No	Number of records to skip
limit	integer	No	Maximum records to return
term	string	No	term

Response

Returns a paginated SearchResult of ProductBatch objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
weightType	string	No	Weight Type
productId	string	Yes	Product identifier
vendorId	string	No	Vendor identifier
batchNo	integer	No	Batch No (default: 0)
cost	number	No	Cost
costPerUnit	number	No	Cost Per Unit
quantity	number	No	Quantity
sku	string	No	Sku
totalTerpenes	double	No	Total Terpenes
totalCannabinoids	double	No	Total Cannabinoids
thc	double	No	Thc
cbn	double	No	Cbn
cbd	double	No	Cbd
cbda	double	No	Cbda
thca	double	No	Thca
cbg	double	No	Cbg
thcName	string	No	Thc Name
cbnName	string	No	Cbn Name
cbdName	string	No	Cbd Name
cbdaName	string	No	Cbda Name
thcaName	string	No	Thca Name
cbgName	string	No	Cbg Name
retailIdCount	integer	No	Retail Id Count
retailIdTraceMessage	string	No	Retail Id Trace Message
retailIdUpdatedAt	long	No	Retail Id Updated At
maxThc	double	No	Max Thc
maxCbn	double	No	Max Cbn
maxCbd	double	No	Max Cbd
maxCbda	double	No	Max Cbda
maxThca	double	No	Max Thca
purchasedDate	long	No	Purchased timestamp (epoch ms)
sellBy	long	No	Sell By
archived	boolean	No	Archived (default: false)
archivedDate	long	No	Archived timestamp (epoch ms)
published	boolean	No	Published (default: false)
unsellable	boolean	No	Unsellable (default: false)
unsellableReasons	Reason[]	No	Unsellable Reasons
publishedQuantity	number	No	Published Quantity
publishedDate	long	No	Published timestamp (epoch ms)
lastAuditDate	long	No	Last Audit timestamp (epoch ms)
trackTraceVerified	boolean	No	Track Trace Verified (default: false)
trackPackageId	integer	No	Track Package identifier
trackPackageLabel	string	No	Track Package Label
trackHarvestBatch	string	No	Track Harvest Batch
trackHarvestDate	string	No	Track Harvest timestamp (epoch ms)
trackTraceSystem	string	No	Track Trace System. One of: MANUAL, METRC, BIOTRACK, UTAH_ICS, OTHER (default: MANUAL)
purchaseOrderId	string	No	Purchase Order identifier
perUnitExciseTax	number	No	Per Unit Excise Tax
totalExciseTax	number	No	Total Excise Tax
customerCompanyId	string	No	Customer Company identifier
brandId	string	No	Brand identifier
receiveDate	long	No	Receive timestamp (epoch ms)
poNumber	string	No	Po Number
status	string	No	Status. One of: IN_TRANSFER, RECEIVED, IN_TESTING, READY_FOR_SALE, PROCESSING (default: RECEIVED)
prevStatus	string	No	Prev Status. One of: IN_TRANSFER, RECEIVED, IN_TESTING, READY_FOR_SALE, PROCESSING (default: RECEIVED)
requestedStatus	string	No	Requested Status. One of: IN_TRANSFER, RECEIVED, IN_TESTING, READY_FOR_SALE, PROCESSING (default: RECEIVED)
complianceError	string	No	Compliance Error
metrcCategory	string	No	Metrc Category
voidStatus	boolean	No	Void Status (default: false)
active	boolean	No	Whether active
batchQRAsset	CompanyAsset	No	Batch Q R Asset
productBatchLabel	ProductBatchLabel	No	Product Batch Label
lotId	string	No	Lot identifier
metrcTagId	string	No	Metrc Tag identifier
totalCultivationTax	number	No	Total Cultivation Tax
potencyAmount	PotencyMG	No	Potency Amount
isPrepaidTax	boolean	No	Is Prepaid Tax
referenceNote	Note	No	Reference Note
attachments	CompanyAsset[]	No	Attachments
productName	string	No	Product Name
vendorName	string	No	Vendor Name
brandName	string	No	Brand Name
liveQuantity	number	No	Live Quantity (default: ZERO)
derivedLogId	string	No	Derived Log identifier
expirationDate	long	No	Expiration timestamp (epoch ms)
licenseId	string	No	License identifier
labelInfo	string	No	Label Info
bundleItems	BatchBundleItems[]	No	Bundle Items
externalId	string	No	External system identifier
externalLicense	string	No	External License
roomId	string	No	Room identifier
actualWeightPerUnit	number	No	Actual Weight Per Unit
waste	number	No	Waste
unProcessed	boolean	No	Un Processed (default: false)
productionBatch	boolean	No	Production Batch (default: false)
moistureLoss	double	No	Moisture Loss
batchType	string	No	Batch Type. One of: SAMPLE, SALE (default: SALE)
connectedBatchId	string	No	Connected Batch identifier
metrcQuantity	number	No	Metrc Quantity (default: ZERO)
trackHarvestName	string	No	Track Harvest Name
metrcLabTestingState	string	No	Metrc Lab Testing State
complianceLabTestingState	string	No	Compliance Lab Testing State
fromTestSample	boolean	No	From Test Sample (default: false)
terpenoids	object	No	Terpenoids
produceDate	long	No	Produce timestamp (epoch ms)
packageDate	long	No	Package timestamp (epoch ms)
finalTestingDate	long	No	Final Testing timestamp (epoch ms)
complianceInfo	ComplianceInfo	No	Compliance Info
cannabinoidInfo	CannabinoidInfoValue	No	Cannabinoid Info
potencyAmountInfo	CannabinoidInfoValue	No	Potency Amount Info
runId	string	No	Run identifier
useBatchInfoQATest	boolean	No	Use Batch Info Q A Test (default: false)
doh	boolean	No	Doh
notes	Note[]	No	Notes
ndcNumber	string	No	Ndc Number
unitWeightValue	number	No	Unit Weight Value (default: ZERO)
unitWeightType	string	No	Unit Weight Type. One of: NONE, GRAM, OUNCE, FLUID_OUNCE, MILLIGRAM (default: NONE)
usableNetWeight	number	No	Usable Net Weight (default: ZERO)
labResultData	labresultdata	No	Lab Result Data
servingWeight	number	No	Serving Weight (default: ZERO)
externalTransferId	string	No	External Transfer identifier
sample	boolean	No	Sample (default: false)
complianceSampleChecked	boolean	No	Compliance Sample Checked (default: false)

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "weightType": "string",
  "productId": "abc123",
  "vendorId": "abc123",
  "batchNo": 0,
  "cost": 0,
  "costPerUnit": 0,
  "quantity": 0,
  "sku": "string",
  "totalTerpenes": 0,
  "totalCannabinoids": 0,
  "thc": 0,
  "cbn": 0,
  "cbd": 0,
  "cbda": 0,
  "thca": 0,
  "cbg": 0,
  "thcName": "string",
  "cbnName": "string",
  "cbdName": "string",
  "cbdaName": "string",
  "thcaName": "string",
  "cbgName": "string",
  "retailIdCount": 0,
  "retailIdTraceMessage": "string",
  "retailIdUpdatedAt": 0,
  "maxThc": 0,
  "maxCbn": 0,
  "maxCbd": 0,
  "maxCbda": 0,
  "maxThca": 0,
  "purchasedDate": 1704067200000,
  "sellBy": 0,
  "archived": false,
  "archivedDate": 1704067200000,
  "published": false,
  "unsellable": false,
  "unsellableReasons": [
    {
      "id": "abc123",
      "source": "string",
      "message": "string"
    }
  ],
  "publishedQuantity": 0,
  "publishedDate": 1704067200000,
  "lastAuditDate": 1704067200000,
  "trackTraceVerified": false,
  "trackPackageId": 0,
  "trackPackageLabel": "string",
  "trackHarvestBatch": "string",
  "trackHarvestDate": "string",
  "trackTraceSystem": "MANUAL",
  "purchaseOrderId": "abc123",
  "perUnitExciseTax": 0,
  "totalExciseTax": 0,
  "customerCompanyId": "abc123",
  "brandId": "abc123",
  "receiveDate": 1704067200000,
  "poNumber": "string",
  "status": "RECEIVED",
  "prevStatus": "RECEIVED",
  "requestedStatus": "RECEIVED",
  "complianceError": "string",
  "metrcCategory": "string",
  "voidStatus": false,
  "active": false,
  "batchQRAsset": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "name": "string",
    "key": "string",
    "type": {},
    "publicURL": "string",
    "active": false,
    "priority": 0,
    "secured": true,
    "thumbURL": "string",
    "mediumURL": "string",
    "largeURL": "string",
    "largeX2URL": "string",
    "origURL": "string",
    "platformFileUrl": "string"
  },
  "productBatchLabel": {
    "labelType": "TEST_RESULT",
    "enabledProductName": false,
    "enablesBatchId": false,
    "enablesLotId": false,
    "enabledPackageId": false,
    "enablesNetWeight": false,
    "enabledBarCode": false,
    "enabledQRCode": false,
    "enableCultivationName": false,
    "enableTestResults": false,
    "enableTestDate": false
  },
  "lotId": "abc123",
  "metrcTagId": "abc123",
  "totalCultivationTax": 0,
  "potencyAmount": {
    "thc": "ZERO",
    "cbd": "ZERO",
    "cbn": "ZERO",
    "thca": "ZERO",
    "cbda": "ZERO",
    "cbg": "ZERO",
    "maxThc": 0,
    "maxCbd": 0,
    "maxCbn": 0,
    "maxThca": 0,
    "maxCbda": 0,
    "thcName": "string",
    "cbdName": "string",
    "cbnName": "string",
    "thcaName": "string",
    "cbdaName": "string",
    "cbgName": "string"
  },
  "isPrepaidTax": false,
  "referenceNote": {
    "id": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "writerId": "abc123",
    "writerName": "string",
    "message": "string",
    "enableOnFleet": false
  },
  "attachments": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "name": "string",
      "key": "string",
      "type": {},
      "publicURL": "string",
      "active": false,
      "priority": 0,
      "secured": true,
      "thumbURL": "string",
      "mediumURL": "string",
      "largeURL": "string",
      "largeX2URL": "string",
      "origURL": "string",
      "platformFileUrl": "string"
    }
  ],
  "productName": "string",
  "vendorName": "string",
  "brandName": "string",
  "liveQuantity": "ZERO",
  "derivedLogId": "abc123",
  "expirationDate": 1704067200000,
  "licenseId": "abc123",
  "labelInfo": "string",
  "bundleItems": [
    {
      "productId": "abc123",
      "batchItems": [],
      "batchId": "abc123",
      "inventoryId": "abc123",
      "quantity": 0
    }
  ],
  "externalId": "abc123",
  "externalLicense": "string",
  "roomId": "abc123",
  "actualWeightPerUnit": 0,
  "waste": 0,
  "unProcessed": false,
  "productionBatch": false,
  "moistureLoss": 0,
  "batchType": "SALE",
  "connectedBatchId": "abc123",
  "metrcQuantity": "ZERO",
  "trackHarvestName": "string",
  "metrcLabTestingState": "string",
  "complianceLabTestingState": "string",
  "fromTestSample": false,
  "terpenoids": {},
  "produceDate": 1704067200000,
  "packageDate": 1704067200000,
  "finalTestingDate": 1704067200000,
  "complianceInfo": {
    "produceDate": 1704067200000,
    "packageDate": 1704067200000,
    "finalTestingDate": 1704067200000,
    "producerName": "string",
    "producerLicense": "string",
    "registrationCertificateNo": "string",
    "lotNumber": "string",
    "productionRunNumber": "string",
    "totalThcPerServing": 0,
    "ingredients": "string",
    "allergens": "string",
    "productDate": 1704067200000,
    "extractionProcess": "string",
    "testDate": 1704067200000,
    "labName": "string",
    "strain": "string",
    "packedBy": "string",
    "packedByRegistrationNo": "string",
    "producerPhone": "string",
    "producerEmail": "string",
    "producerWebsite": "string",
    "producerAddress": "string",
    "producerRegistrationNo": "string",
    "refrigeration": "string",
    "mjTypeAndSolventUsed": "string",
    "servingSize": 0,
    "servingsPerContainer": 0,
    "nutritionInfo": {},
    "directions": "string",
    "testedBy": "string",
    "packagedBy": "string",
    "packagedByLicense": "string",
    "cultivatorLicense": "string",
    "solventUsed": "string",
    "thcPerServing": "string",
    "thcPerContainer": "string",
    "cbdPerServing": "string",
    "cbdPerContainer": "string",
    "statementIntendedUse": "string",
    "manufacturerName": "string",
    "manufacturerLicense": "string",
    "manufacturerAddress": "string",
    "manufacturerPhone": "string",
    "manufacturerEmail": "string",
    "manufacturerWebsite": "string",
    "form": "string",
    "manufacturer": "string",
    "manufacturedDate": 1704067200000,
    "testingLab": "string",
    "totalUnits": "string",
    "pesticides": "string",
    "timeDoseEffects": "string",
    "storage": "string",
    "productExpirationDate": 1704067200000,
    "thcDeltaEightPercentagePerServing": 0,
    "thcDeltaEightPercentagePerPackage": 0,
    "thcDeltaEightMgPerServing": 0,
    "thcDeltaEightMgPerPackage": 0,
    "thcDeltaNinePercentagePerServing": 0,
    "thcDeltaNinePercentagePerPackage": 0,
    "thcDeltaNineMgPerServing": 0,
    "thcDeltaNineMgPerPackage": 0,
    "nutrition": "string",
    "cannabisIngredients": "string",
    "processorName": "string"
  },
  "cannabinoidInfo": {
    "displayName": "string",
    "thc": "NUMERIC",
    "cbn": "NUMERIC",
    "cbd": "NUMERIC",
    "cbda": "NUMERIC",
    "thca": "NUMERIC"
  },
  "potencyAmountInfo": {
    "displayName": "string",
    "thc": "NUMERIC",
    "cbn": "NUMERIC",
    "cbd": "NUMERIC",
    "cbda": "NUMERIC",
    "thca": "NUMERIC"
  },
  "runId": "abc123",
  "useBatchInfoQATest": false,
  "doh": false,
  "notes": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "writerId": "abc123",
      "writerName": "string",
      "message": "string",
      "enableOnFleet": false
    }
  ],
  "ndcNumber": "string",
  "unitWeightValue": "ZERO",
  "unitWeightType": "NONE",
  "usableNetWeight": "ZERO",
  "labResultData": {},
  "servingWeight": "ZERO",
  "externalTransferId": "abc123",
  "sample": false,
  "complianceSampleChecked": false
}

---

Get Batches By Dates

GET /api/v1/partner/store/batches/dates

Retrieve batches filtered by their record modification date. Provide startDate and endDate as epoch milliseconds. If endDate is omitted, it defaults to the current time. Results are capped at 100 per page.

Query Parameters

Parameter	Type	Required	Description
startDate	long	No	Start date filter
endDate	long	No	End date filter
start	integer	No	Number of records to skip
limit	integer	No	Maximum records to return

Response

Returns a paginated SearchResult of ProductBatch objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
weightType	string	No	Weight Type
productId	string	Yes	Product identifier
vendorId	string	No	Vendor identifier
batchNo	integer	No	Batch No (default: 0)
cost	number	No	Cost
costPerUnit	number	No	Cost Per Unit
quantity	number	No	Quantity
sku	string	No	Sku
totalTerpenes	double	No	Total Terpenes
totalCannabinoids	double	No	Total Cannabinoids
thc	double	No	Thc
cbn	double	No	Cbn
cbd	double	No	Cbd
cbda	double	No	Cbda
thca	double	No	Thca
cbg	double	No	Cbg
thcName	string	No	Thc Name
cbnName	string	No	Cbn Name
cbdName	string	No	Cbd Name
cbdaName	string	No	Cbda Name
thcaName	string	No	Thca Name
cbgName	string	No	Cbg Name
retailIdCount	integer	No	Retail Id Count
retailIdTraceMessage	string	No	Retail Id Trace Message
retailIdUpdatedAt	long	No	Retail Id Updated At
maxThc	double	No	Max Thc
maxCbn	double	No	Max Cbn
maxCbd	double	No	Max Cbd
maxCbda	double	No	Max Cbda
maxThca	double	No	Max Thca
purchasedDate	long	No	Purchased timestamp (epoch ms)
sellBy	long	No	Sell By
archived	boolean	No	Archived (default: false)
archivedDate	long	No	Archived timestamp (epoch ms)
published	boolean	No	Published (default: false)
unsellable	boolean	No	Unsellable (default: false)
unsellableReasons	Reason[]	No	Unsellable Reasons
publishedQuantity	number	No	Published Quantity
publishedDate	long	No	Published timestamp (epoch ms)
lastAuditDate	long	No	Last Audit timestamp (epoch ms)
trackTraceVerified	boolean	No	Track Trace Verified (default: false)
trackPackageId	integer	No	Track Package identifier
trackPackageLabel	string	No	Track Package Label
trackHarvestBatch	string	No	Track Harvest Batch
trackHarvestDate	string	No	Track Harvest timestamp (epoch ms)
trackTraceSystem	string	No	Track Trace System. One of: MANUAL, METRC, BIOTRACK, UTAH_ICS, OTHER (default: MANUAL)
purchaseOrderId	string	No	Purchase Order identifier
perUnitExciseTax	number	No	Per Unit Excise Tax
totalExciseTax	number	No	Total Excise Tax
customerCompanyId	string	No	Customer Company identifier
brandId	string	No	Brand identifier
receiveDate	long	No	Receive timestamp (epoch ms)
poNumber	string	No	Po Number
status	string	No	Status. One of: IN_TRANSFER, RECEIVED, IN_TESTING, READY_FOR_SALE, PROCESSING (default: RECEIVED)
prevStatus	string	No	Prev Status. One of: IN_TRANSFER, RECEIVED, IN_TESTING, READY_FOR_SALE, PROCESSING (default: RECEIVED)
requestedStatus	string	No	Requested Status. One of: IN_TRANSFER, RECEIVED, IN_TESTING, READY_FOR_SALE, PROCESSING (default: RECEIVED)
complianceError	string	No	Compliance Error
metrcCategory	string	No	Metrc Category
voidStatus	boolean	No	Void Status (default: false)
active	boolean	No	Whether active
batchQRAsset	CompanyAsset	No	Batch Q R Asset
productBatchLabel	ProductBatchLabel	No	Product Batch Label
lotId	string	No	Lot identifier
metrcTagId	string	No	Metrc Tag identifier
totalCultivationTax	number	No	Total Cultivation Tax
potencyAmount	PotencyMG	No	Potency Amount
isPrepaidTax	boolean	No	Is Prepaid Tax
referenceNote	Note	No	Reference Note
attachments	CompanyAsset[]	No	Attachments
productName	string	No	Product Name
vendorName	string	No	Vendor Name
brandName	string	No	Brand Name
liveQuantity	number	No	Live Quantity (default: ZERO)
derivedLogId	string	No	Derived Log identifier
expirationDate	long	No	Expiration timestamp (epoch ms)
licenseId	string	No	License identifier
labelInfo	string	No	Label Info
bundleItems	BatchBundleItems[]	No	Bundle Items
externalId	string	No	External system identifier
externalLicense	string	No	External License
roomId	string	No	Room identifier
actualWeightPerUnit	number	No	Actual Weight Per Unit
waste	number	No	Waste
unProcessed	boolean	No	Un Processed (default: false)
productionBatch	boolean	No	Production Batch (default: false)
moistureLoss	double	No	Moisture Loss
batchType	string	No	Batch Type. One of: SAMPLE, SALE (default: SALE)
connectedBatchId	string	No	Connected Batch identifier
metrcQuantity	number	No	Metrc Quantity (default: ZERO)
trackHarvestName	string	No	Track Harvest Name
metrcLabTestingState	string	No	Metrc Lab Testing State
complianceLabTestingState	string	No	Compliance Lab Testing State
fromTestSample	boolean	No	From Test Sample (default: false)
terpenoids	object	No	Terpenoids
produceDate	long	No	Produce timestamp (epoch ms)
packageDate	long	No	Package timestamp (epoch ms)
finalTestingDate	long	No	Final Testing timestamp (epoch ms)
complianceInfo	ComplianceInfo	No	Compliance Info
cannabinoidInfo	CannabinoidInfoValue	No	Cannabinoid Info
potencyAmountInfo	CannabinoidInfoValue	No	Potency Amount Info
runId	string	No	Run identifier
useBatchInfoQATest	boolean	No	Use Batch Info Q A Test (default: false)
doh	boolean	No	Doh
notes	Note[]	No	Notes
ndcNumber	string	No	Ndc Number
unitWeightValue	number	No	Unit Weight Value (default: ZERO)
unitWeightType	string	No	Unit Weight Type. One of: NONE, GRAM, OUNCE, FLUID_OUNCE, MILLIGRAM (default: NONE)
usableNetWeight	number	No	Usable Net Weight (default: ZERO)
labResultData	labresultdata	No	Lab Result Data
servingWeight	number	No	Serving Weight (default: ZERO)
externalTransferId	string	No	External Transfer identifier
sample	boolean	No	Sample (default: false)
complianceSampleChecked	boolean	No	Compliance Sample Checked (default: false)

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "weightType": "string",
  "productId": "abc123",
  "vendorId": "abc123",
  "batchNo": 0,
  "cost": 0,
  "costPerUnit": 0,
  "quantity": 0,
  "sku": "string",
  "totalTerpenes": 0,
  "totalCannabinoids": 0,
  "thc": 0,
  "cbn": 0,
  "cbd": 0,
  "cbda": 0,
  "thca": 0,
  "cbg": 0,
  "thcName": "string",
  "cbnName": "string",
  "cbdName": "string",
  "cbdaName": "string",
  "thcaName": "string",
  "cbgName": "string",
  "retailIdCount": 0,
  "retailIdTraceMessage": "string",
  "retailIdUpdatedAt": 0,
  "maxThc": 0,
  "maxCbn": 0,
  "maxCbd": 0,
  "maxCbda": 0,
  "maxThca": 0,
  "purchasedDate": 1704067200000,
  "sellBy": 0,
  "archived": false,
  "archivedDate": 1704067200000,
  "published": false,
  "unsellable": false,
  "unsellableReasons": [
    {
      "id": "abc123",
      "source": "string",
      "message": "string"
    }
  ],
  "publishedQuantity": 0,
  "publishedDate": 1704067200000,
  "lastAuditDate": 1704067200000,
  "trackTraceVerified": false,
  "trackPackageId": 0,
  "trackPackageLabel": "string",
  "trackHarvestBatch": "string",
  "trackHarvestDate": "string",
  "trackTraceSystem": "MANUAL",
  "purchaseOrderId": "abc123",
  "perUnitExciseTax": 0,
  "totalExciseTax": 0,
  "customerCompanyId": "abc123",
  "brandId": "abc123",
  "receiveDate": 1704067200000,
  "poNumber": "string",
  "status": "RECEIVED",
  "prevStatus": "RECEIVED",
  "requestedStatus": "RECEIVED",
  "complianceError": "string",
  "metrcCategory": "string",
  "voidStatus": false,
  "active": false,
  "batchQRAsset": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "name": "string",
    "key": "string",
    "type": {},
    "publicURL": "string",
    "active": false,
    "priority": 0,
    "secured": true,
    "thumbURL": "string",
    "mediumURL": "string",
    "largeURL": "string",
    "largeX2URL": "string",
    "origURL": "string",
    "platformFileUrl": "string"
  },
  "productBatchLabel": {
    "labelType": "TEST_RESULT",
    "enabledProductName": false,
    "enablesBatchId": false,
    "enablesLotId": false,
    "enabledPackageId": false,
    "enablesNetWeight": false,
    "enabledBarCode": false,
    "enabledQRCode": false,
    "enableCultivationName": false,
    "enableTestResults": false,
    "enableTestDate": false
  },
  "lotId": "abc123",
  "metrcTagId": "abc123",
  "totalCultivationTax": 0,
  "potencyAmount": {
    "thc": "ZERO",
    "cbd": "ZERO",
    "cbn": "ZERO",
    "thca": "ZERO",
    "cbda": "ZERO",
    "cbg": "ZERO",
    "maxThc": 0,
    "maxCbd": 0,
    "maxCbn": 0,
    "maxThca": 0,
    "maxCbda": 0,
    "thcName": "string",
    "cbdName": "string",
    "cbnName": "string",
    "thcaName": "string",
    "cbdaName": "string",
    "cbgName": "string"
  },
  "isPrepaidTax": false,
  "referenceNote": {
    "id": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "writerId": "abc123",
    "writerName": "string",
    "message": "string",
    "enableOnFleet": false
  },
  "attachments": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "name": "string",
      "key": "string",
      "type": {},
      "publicURL": "string",
      "active": false,
      "priority": 0,
      "secured": true,
      "thumbURL": "string",
      "mediumURL": "string",
      "largeURL": "string",
      "largeX2URL": "string",
      "origURL": "string",
      "platformFileUrl": "string"
    }
  ],
  "productName": "string",
  "vendorName": "string",
  "brandName": "string",
  "liveQuantity": "ZERO",
  "derivedLogId": "abc123",
  "expirationDate": 1704067200000,
  "licenseId": "abc123",
  "labelInfo": "string",
  "bundleItems": [
    {
      "productId": "abc123",
      "batchItems": [],
      "batchId": "abc123",
      "inventoryId": "abc123",
      "quantity": 0
    }
  ],
  "externalId": "abc123",
  "externalLicense": "string",
  "roomId": "abc123",
  "actualWeightPerUnit": 0,
  "waste": 0,
  "unProcessed": false,
  "productionBatch": false,
  "moistureLoss": 0,
  "batchType": "SALE",
  "connectedBatchId": "abc123",
  "metrcQuantity": "ZERO",
  "trackHarvestName": "string",
  "metrcLabTestingState": "string",
  "complianceLabTestingState": "string",
  "fromTestSample": false,
  "terpenoids": {},
  "produceDate": 1704067200000,
  "packageDate": 1704067200000,
  "finalTestingDate": 1704067200000,
  "complianceInfo": {
    "produceDate": 1704067200000,
    "packageDate": 1704067200000,
    "finalTestingDate": 1704067200000,
    "producerName": "string",
    "producerLicense": "string",
    "registrationCertificateNo": "string",
    "lotNumber": "string",
    "productionRunNumber": "string",
    "totalThcPerServing": 0,
    "ingredients": "string",
    "allergens": "string",
    "productDate": 1704067200000,
    "extractionProcess": "string",
    "testDate": 1704067200000,
    "labName": "string",
    "strain": "string",
    "packedBy": "string",
    "packedByRegistrationNo": "string",
    "producerPhone": "string",
    "producerEmail": "string",
    "producerWebsite": "string",
    "producerAddress": "string",
    "producerRegistrationNo": "string",
    "refrigeration": "string",
    "mjTypeAndSolventUsed": "string",
    "servingSize": 0,
    "servingsPerContainer": 0,
    "nutritionInfo": {},
    "directions": "string",
    "testedBy": "string",
    "packagedBy": "string",
    "packagedByLicense": "string",
    "cultivatorLicense": "string",
    "solventUsed": "string",
    "thcPerServing": "string",
    "thcPerContainer": "string",
    "cbdPerServing": "string",
    "cbdPerContainer": "string",
    "statementIntendedUse": "string",
    "manufacturerName": "string",
    "manufacturerLicense": "string",
    "manufacturerAddress": "string",
    "manufacturerPhone": "string",
    "manufacturerEmail": "string",
    "manufacturerWebsite": "string",
    "form": "string",
    "manufacturer": "string",
    "manufacturedDate": 1704067200000,
    "testingLab": "string",
    "totalUnits": "string",
    "pesticides": "string",
    "timeDoseEffects": "string",
    "storage": "string",
    "productExpirationDate": 1704067200000,
    "thcDeltaEightPercentagePerServing": 0,
    "thcDeltaEightPercentagePerPackage": 0,
    "thcDeltaEightMgPerServing": 0,
    "thcDeltaEightMgPerPackage": 0,
    "thcDeltaNinePercentagePerServing": 0,
    "thcDeltaNinePercentagePerPackage": 0,
    "thcDeltaNineMgPerServing": 0,
    "thcDeltaNineMgPerPackage": 0,
    "nutrition": "string",
    "cannabisIngredients": "string",
    "processorName": "string"
  },
  "cannabinoidInfo": {
    "displayName": "string",
    "thc": "NUMERIC",
    "cbn": "NUMERIC",
    "cbd": "NUMERIC",
    "cbda": "NUMERIC",
    "thca": "NUMERIC"
  },
  "potencyAmountInfo": {
    "displayName": "string",
    "thc": "NUMERIC",
    "cbn": "NUMERIC",
    "cbd": "NUMERIC",
    "cbda": "NUMERIC",
    "thca": "NUMERIC"
  },
  "runId": "abc123",
  "useBatchInfoQATest": false,
  "doh": false,
  "notes": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "writerId": "abc123",
      "writerName": "string",
      "message": "string",
      "enableOnFleet": false
    }
  ],
  "ndcNumber": "string",
  "unitWeightValue": "ZERO",
  "unitWeightType": "NONE",
  "usableNetWeight": "ZERO",
  "labResultData": {},
  "servingWeight": "ZERO",
  "externalTransferId": "abc123",
  "sample": false,
  "complianceSampleChecked": false
}

---

Get Batches By Dates

GET /api/v1/partner/store/batches/dates/purchaseDate

Retrieve batches filtered by their purchase date (when the batch was actually purchased), as opposed to the /dates endpoint which filters by record modification date. Same date parameters and limits apply.

Query Parameters

Parameter	Type	Required	Description
startDate	long	No	Start date filter
endDate	long	No	End date filter
start	integer	No	Number of records to skip
limit	integer	No	Maximum records to return

Response

Returns a paginated SearchResult of ProductBatch objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
weightType	string	No	Weight Type
productId	string	Yes	Product identifier
vendorId	string	No	Vendor identifier
batchNo	integer	No	Batch No (default: 0)
cost	number	No	Cost
costPerUnit	number	No	Cost Per Unit
quantity	number	No	Quantity
sku	string	No	Sku
totalTerpenes	double	No	Total Terpenes
totalCannabinoids	double	No	Total Cannabinoids
thc	double	No	Thc
cbn	double	No	Cbn
cbd	double	No	Cbd
cbda	double	No	Cbda
thca	double	No	Thca
cbg	double	No	Cbg
thcName	string	No	Thc Name
cbnName	string	No	Cbn Name
cbdName	string	No	Cbd Name
cbdaName	string	No	Cbda Name
thcaName	string	No	Thca Name
cbgName	string	No	Cbg Name
retailIdCount	integer	No	Retail Id Count
retailIdTraceMessage	string	No	Retail Id Trace Message
retailIdUpdatedAt	long	No	Retail Id Updated At
maxThc	double	No	Max Thc
maxCbn	double	No	Max Cbn
maxCbd	double	No	Max Cbd
maxCbda	double	No	Max Cbda
maxThca	double	No	Max Thca
purchasedDate	long	No	Purchased timestamp (epoch ms)
sellBy	long	No	Sell By
archived	boolean	No	Archived (default: false)
archivedDate	long	No	Archived timestamp (epoch ms)
published	boolean	No	Published (default: false)
unsellable	boolean	No	Unsellable (default: false)
unsellableReasons	Reason[]	No	Unsellable Reasons
publishedQuantity	number	No	Published Quantity
publishedDate	long	No	Published timestamp (epoch ms)
lastAuditDate	long	No	Last Audit timestamp (epoch ms)
trackTraceVerified	boolean	No	Track Trace Verified (default: false)
trackPackageId	integer	No	Track Package identifier
trackPackageLabel	string	No	Track Package Label
trackHarvestBatch	string	No	Track Harvest Batch
trackHarvestDate	string	No	Track Harvest timestamp (epoch ms)
trackTraceSystem	string	No	Track Trace System. One of: MANUAL, METRC, BIOTRACK, UTAH_ICS, OTHER (default: MANUAL)
purchaseOrderId	string	No	Purchase Order identifier
perUnitExciseTax	number	No	Per Unit Excise Tax
totalExciseTax	number	No	Total Excise Tax
customerCompanyId	string	No	Customer Company identifier
brandId	string	No	Brand identifier
receiveDate	long	No	Receive timestamp (epoch ms)
poNumber	string	No	Po Number
status	string	No	Status. One of: IN_TRANSFER, RECEIVED, IN_TESTING, READY_FOR_SALE, PROCESSING (default: RECEIVED)
prevStatus	string	No	Prev Status. One of: IN_TRANSFER, RECEIVED, IN_TESTING, READY_FOR_SALE, PROCESSING (default: RECEIVED)
requestedStatus	string	No	Requested Status. One of: IN_TRANSFER, RECEIVED, IN_TESTING, READY_FOR_SALE, PROCESSING (default: RECEIVED)
complianceError	string	No	Compliance Error
metrcCategory	string	No	Metrc Category
voidStatus	boolean	No	Void Status (default: false)
active	boolean	No	Whether active
batchQRAsset	CompanyAsset	No	Batch Q R Asset
productBatchLabel	ProductBatchLabel	No	Product Batch Label
lotId	string	No	Lot identifier
metrcTagId	string	No	Metrc Tag identifier
totalCultivationTax	number	No	Total Cultivation Tax
potencyAmount	PotencyMG	No	Potency Amount
isPrepaidTax	boolean	No	Is Prepaid Tax
referenceNote	Note	No	Reference Note
attachments	CompanyAsset[]	No	Attachments
productName	string	No	Product Name
vendorName	string	No	Vendor Name
brandName	string	No	Brand Name
liveQuantity	number	No	Live Quantity (default: ZERO)
derivedLogId	string	No	Derived Log identifier
expirationDate	long	No	Expiration timestamp (epoch ms)
licenseId	string	No	License identifier
labelInfo	string	No	Label Info
bundleItems	BatchBundleItems[]	No	Bundle Items
externalId	string	No	External system identifier
externalLicense	string	No	External License
roomId	string	No	Room identifier
actualWeightPerUnit	number	No	Actual Weight Per Unit
waste	number	No	Waste
unProcessed	boolean	No	Un Processed (default: false)
productionBatch	boolean	No	Production Batch (default: false)
moistureLoss	double	No	Moisture Loss
batchType	string	No	Batch Type. One of: SAMPLE, SALE (default: SALE)
connectedBatchId	string	No	Connected Batch identifier
metrcQuantity	number	No	Metrc Quantity (default: ZERO)
trackHarvestName	string	No	Track Harvest Name
metrcLabTestingState	string	No	Metrc Lab Testing State
complianceLabTestingState	string	No	Compliance Lab Testing State
fromTestSample	boolean	No	From Test Sample (default: false)
terpenoids	object	No	Terpenoids
produceDate	long	No	Produce timestamp (epoch ms)
packageDate	long	No	Package timestamp (epoch ms)
finalTestingDate	long	No	Final Testing timestamp (epoch ms)
complianceInfo	ComplianceInfo	No	Compliance Info
cannabinoidInfo	CannabinoidInfoValue	No	Cannabinoid Info
potencyAmountInfo	CannabinoidInfoValue	No	Potency Amount Info
runId	string	No	Run identifier
useBatchInfoQATest	boolean	No	Use Batch Info Q A Test (default: false)
doh	boolean	No	Doh
notes	Note[]	No	Notes
ndcNumber	string	No	Ndc Number
unitWeightValue	number	No	Unit Weight Value (default: ZERO)
unitWeightType	string	No	Unit Weight Type. One of: NONE, GRAM, OUNCE, FLUID_OUNCE, MILLIGRAM (default: NONE)
usableNetWeight	number	No	Usable Net Weight (default: ZERO)
labResultData	labresultdata	No	Lab Result Data
servingWeight	number	No	Serving Weight (default: ZERO)
externalTransferId	string	No	External Transfer identifier
sample	boolean	No	Sample (default: false)
complianceSampleChecked	boolean	No	Compliance Sample Checked (default: false)

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "weightType": "string",
  "productId": "abc123",
  "vendorId": "abc123",
  "batchNo": 0,
  "cost": 0,
  "costPerUnit": 0,
  "quantity": 0,
  "sku": "string",
  "totalTerpenes": 0,
  "totalCannabinoids": 0,
  "thc": 0,
  "cbn": 0,
  "cbd": 0,
  "cbda": 0,
  "thca": 0,
  "cbg": 0,
  "thcName": "string",
  "cbnName": "string",
  "cbdName": "string",
  "cbdaName": "string",
  "thcaName": "string",
  "cbgName": "string",
  "retailIdCount": 0,
  "retailIdTraceMessage": "string",
  "retailIdUpdatedAt": 0,
  "maxThc": 0,
  "maxCbn": 0,
  "maxCbd": 0,
  "maxCbda": 0,
  "maxThca": 0,
  "purchasedDate": 1704067200000,
  "sellBy": 0,
  "archived": false,
  "archivedDate": 1704067200000,
  "published": false,
  "unsellable": false,
  "unsellableReasons": [
    {
      "id": "abc123",
      "source": "string",
      "message": "string"
    }
  ],
  "publishedQuantity": 0,
  "publishedDate": 1704067200000,
  "lastAuditDate": 1704067200000,
  "trackTraceVerified": false,
  "trackPackageId": 0,
  "trackPackageLabel": "string",
  "trackHarvestBatch": "string",
  "trackHarvestDate": "string",
  "trackTraceSystem": "MANUAL",
  "purchaseOrderId": "abc123",
  "perUnitExciseTax": 0,
  "totalExciseTax": 0,
  "customerCompanyId": "abc123",
  "brandId": "abc123",
  "receiveDate": 1704067200000,
  "poNumber": "string",
  "status": "RECEIVED",
  "prevStatus": "RECEIVED",
  "requestedStatus": "RECEIVED",
  "complianceError": "string",
  "metrcCategory": "string",
  "voidStatus": false,
  "active": false,
  "batchQRAsset": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "name": "string",
    "key": "string",
    "type": {},
    "publicURL": "string",
    "active": false,
    "priority": 0,
    "secured": true,
    "thumbURL": "string",
    "mediumURL": "string",
    "largeURL": "string",
    "largeX2URL": "string",
    "origURL": "string",
    "platformFileUrl": "string"
  },
  "productBatchLabel": {
    "labelType": "TEST_RESULT",
    "enabledProductName": false,
    "enablesBatchId": false,
    "enablesLotId": false,
    "enabledPackageId": false,
    "enablesNetWeight": false,
    "enabledBarCode": false,
    "enabledQRCode": false,
    "enableCultivationName": false,
    "enableTestResults": false,
    "enableTestDate": false
  },
  "lotId": "abc123",
  "metrcTagId": "abc123",
  "totalCultivationTax": 0,
  "potencyAmount": {
    "thc": "ZERO",
    "cbd": "ZERO",
    "cbn": "ZERO",
    "thca": "ZERO",
    "cbda": "ZERO",
    "cbg": "ZERO",
    "maxThc": 0,
    "maxCbd": 0,
    "maxCbn": 0,
    "maxThca": 0,
    "maxCbda": 0,
    "thcName": "string",
    "cbdName": "string",
    "cbnName": "string",
    "thcaName": "string",
    "cbdaName": "string",
    "cbgName": "string"
  },
  "isPrepaidTax": false,
  "referenceNote": {
    "id": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "writerId": "abc123",
    "writerName": "string",
    "message": "string",
    "enableOnFleet": false
  },
  "attachments": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "name": "string",
      "key": "string",
      "type": {},
      "publicURL": "string",
      "active": false,
      "priority": 0,
      "secured": true,
      "thumbURL": "string",
      "mediumURL": "string",
      "largeURL": "string",
      "largeX2URL": "string",
      "origURL": "string",
      "platformFileUrl": "string"
    }
  ],
  "productName": "string",
  "vendorName": "string",
  "brandName": "string",
  "liveQuantity": "ZERO",
  "derivedLogId": "abc123",
  "expirationDate": 1704067200000,
  "licenseId": "abc123",
  "labelInfo": "string",
  "bundleItems": [
    {
      "productId": "abc123",
      "batchItems": [],
      "batchId": "abc123",
      "inventoryId": "abc123",
      "quantity": 0
    }
  ],
  "externalId": "abc123",
  "externalLicense": "string",
  "roomId": "abc123",
  "actualWeightPerUnit": 0,
  "waste": 0,
  "unProcessed": false,
  "productionBatch": false,
  "moistureLoss": 0,
  "batchType": "SALE",
  "connectedBatchId": "abc123",
  "metrcQuantity": "ZERO",
  "trackHarvestName": "string",
  "metrcLabTestingState": "string",
  "complianceLabTestingState": "string",
  "fromTestSample": false,
  "terpenoids": {},
  "produceDate": 1704067200000,
  "packageDate": 1704067200000,
  "finalTestingDate": 1704067200000,
  "complianceInfo": {
    "produceDate": 1704067200000,
    "packageDate": 1704067200000,
    "finalTestingDate": 1704067200000,
    "producerName": "string",
    "producerLicense": "string",
    "registrationCertificateNo": "string",
    "lotNumber": "string",
    "productionRunNumber": "string",
    "totalThcPerServing": 0,
    "ingredients": "string",
    "allergens": "string",
    "productDate": 1704067200000,
    "extractionProcess": "string",
    "testDate": 1704067200000,
    "labName": "string",
    "strain": "string",
    "packedBy": "string",
    "packedByRegistrationNo": "string",
    "producerPhone": "string",
    "producerEmail": "string",
    "producerWebsite": "string",
    "producerAddress": "string",
    "producerRegistrationNo": "string",
    "refrigeration": "string",
    "mjTypeAndSolventUsed": "string",
    "servingSize": 0,
    "servingsPerContainer": 0,
    "nutritionInfo": {},
    "directions": "string",
    "testedBy": "string",
    "packagedBy": "string",
    "packagedByLicense": "string",
    "cultivatorLicense": "string",
    "solventUsed": "string",
    "thcPerServing": "string",
    "thcPerContainer": "string",
    "cbdPerServing": "string",
    "cbdPerContainer": "string",
    "statementIntendedUse": "string",
    "manufacturerName": "string",
    "manufacturerLicense": "string",
    "manufacturerAddress": "string",
    "manufacturerPhone": "string",
    "manufacturerEmail": "string",
    "manufacturerWebsite": "string",
    "form": "string",
    "manufacturer": "string",
    "manufacturedDate": 1704067200000,
    "testingLab": "string",
    "totalUnits": "string",
    "pesticides": "string",
    "timeDoseEffects": "string",
    "storage": "string",
    "productExpirationDate": 1704067200000,
    "thcDeltaEightPercentagePerServing": 0,
    "thcDeltaEightPercentagePerPackage": 0,
    "thcDeltaEightMgPerServing": 0,
    "thcDeltaEightMgPerPackage": 0,
    "thcDeltaNinePercentagePerServing": 0,
    "thcDeltaNinePercentagePerPackage": 0,
    "thcDeltaNineMgPerServing": 0,
    "thcDeltaNineMgPerPackage": 0,
    "nutrition": "string",
    "cannabisIngredients": "string",
    "processorName": "string"
  },
  "cannabinoidInfo": {
    "displayName": "string",
    "thc": "NUMERIC",
    "cbn": "NUMERIC",
    "cbd": "NUMERIC",
    "cbda": "NUMERIC",
    "thca": "NUMERIC"
  },
  "potencyAmountInfo": {
    "displayName": "string",
    "thc": "NUMERIC",
    "cbn": "NUMERIC",
    "cbd": "NUMERIC",
    "cbda": "NUMERIC",
    "thca": "NUMERIC"
  },
  "runId": "abc123",
  "useBatchInfoQATest": false,
  "doh": false,
  "notes": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "writerId": "abc123",
      "writerName": "string",
      "message": "string",
      "enableOnFleet": false
    }
  ],
  "ndcNumber": "string",
  "unitWeightValue": "ZERO",
  "unitWeightType": "NONE",
  "usableNetWeight": "ZERO",
  "labResultData": {},
  "servingWeight": "ZERO",
  "externalTransferId": "abc123",
  "sample": false,
  "complianceSampleChecked": false
}

---

Get Batch Quantity By Product

GET /api/v1/partner/store/batches/{productId}/batchQuantityInfo

Retrieve all batch quantity details for a specific product, including available quantity, committed quantity, and sellable quantity across all inventory locations. Returns the full list without pagination.

Path Parameters

Parameter	Type	Description
productId	string	The product i d

Response

Returns a list of BatchQuantity objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
productId	string	No	Product identifier
inventoryId	string	No	Inventory identifier
batchId	string	No	Batch identifier
quantity	number	No	Quantity
committedQty	number	No	Committed Qty (default: ZERO)
batchPurchaseDate	long	No	Batch Purchase timestamp (epoch ms)
batchArchived	boolean	No	Batch Archived
unsellable	boolean	No	Unsellable

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "productId": "abc123",
  "inventoryId": "abc123",
  "batchId": "abc123",
  "quantity": 0,
  "committedQty": "ZERO",
  "batchPurchaseDate": 1704067200000,
  "batchArchived": false,
  "unsellable": false
}

---

Get Batch Quantity By Inventory

GET /api/v1/partner/store/batches/quantities

Retrieve batch quantities for a specific inventory room. Use the inventoryId query parameter to specify which inventory location. Results are paginated and capped at 100 per page. Requires a store context.

Query Parameters

Parameter	Type	Required	Description
inventoryId	string	No	inventory i d
start	integer	No	Number of records to skip
limit	integer	No	Maximum records to return

Response

Returns a paginated SearchResult of BatchQuantity objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
productId	string	No	Product identifier
inventoryId	string	No	Inventory identifier
batchId	string	No	Batch identifier
quantity	number	No	Quantity
committedQty	number	No	Committed Qty (default: ZERO)
batchPurchaseDate	long	No	Batch Purchase timestamp (epoch ms)
batchArchived	boolean	No	Batch Archived
unsellable	boolean	No	Unsellable

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "productId": "abc123",
  "inventoryId": "abc123",
  "batchId": "abc123",
  "quantity": 0,
  "committedQty": "ZERO",
  "batchPurchaseDate": 1704067200000,
  "batchArchived": false,
  "unsellable": false
}

---

Inventory transfer For Partner

POST /api/v1/partner/store/batches/transferInventory

Create a new inventory transfer between two inventory rooms or shops. Requires fromInventoryId, toInventoryId, and currentEmployeeId. Include transferLogs with the individual items and quantities to transfer.

Request Body

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
status	string	No	Status. One of: ACCEPTED, DECLINED, PENDING
createByEmployeeId	string	No	Create By Employee identifier
acceptByEmployeeId	string	No	Accept By Employee identifier
declineByEmployeeId	string	No	Decline By Employee identifier
fromShopId	string	No	From Shop identifier
toShopId	string	No	To Shop identifier
fromInventoryId	string	Yes	From Inventory identifier
toInventoryId	string	Yes	To Inventory identifier
prevFromInventoryId	string	No	Prev From Inventory identifier
declinedDate	long	No	Declined timestamp (epoch ms)
acceptedDate	long	No	Accepted timestamp (epoch ms)
transferNo	string	No	Transfer No
completeTransfer	boolean	No	Complete Transfer
transferByBatch	boolean	No	Transfer By Batch
processedTime	long	No	Processed timestamp (epoch ms)
processing	boolean	No	Processing (default: false)
driverId	string	No	Driver identifier
transactionId	string	No	Transaction identifier
orderNo	string	No	Order No
activeTopUserId	string	No	Active Top User identifier
currentEmployeeId	string	Yes	Current Employee identifier

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "status": "ACCEPTED",
  "createByEmployeeId": "abc123",
  "acceptByEmployeeId": "abc123",
  "declineByEmployeeId": "abc123",
  "fromShopId": "abc123",
  "toShopId": "abc123",
  "fromInventoryId": "abc123",
  "toInventoryId": "abc123",
  "prevFromInventoryId": "abc123",
  "declinedDate": 1704067200000,
  "acceptedDate": 1704067200000,
  "transferNo": "string",
  "completeTransfer": false,
  "transferByBatch": false,
  "processedTime": 1704067200000,
  "processing": false,
  "driverId": "abc123",
  "transactionId": "abc123",
  "orderNo": "string",
  "activeTopUserId": "abc123",
  "currentEmployeeId": "abc123"
}

Response

Returns a InventoryTransferHistory object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
status	string	No	Status. One of: ACCEPTED, DECLINED, PENDING
createByEmployeeId	string	No	Create By Employee identifier
acceptByEmployeeId	string	No	Accept By Employee identifier
declineByEmployeeId	string	No	Decline By Employee identifier
fromShopId	string	No	From Shop identifier
toShopId	string	No	To Shop identifier
fromInventoryId	string	Yes	From Inventory identifier
toInventoryId	string	Yes	To Inventory identifier
prevFromInventoryId	string	No	Prev From Inventory identifier
declinedDate	long	No	Declined timestamp (epoch ms)
acceptedDate	long	No	Accepted timestamp (epoch ms)
transferNo	string	No	Transfer No
completeTransfer	boolean	No	Complete Transfer
transferByBatch	boolean	No	Transfer By Batch
processedTime	long	No	Processed timestamp (epoch ms)
processing	boolean	No	Processing (default: false)
driverId	string	No	Driver identifier
transactionId	string	No	Transaction identifier
orderNo	string	No	Order No
activeTopUserId	string	No	Active Top User identifier

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "status": "ACCEPTED",
  "createByEmployeeId": "abc123",
  "acceptByEmployeeId": "abc123",
  "declineByEmployeeId": "abc123",
  "fromShopId": "abc123",
  "toShopId": "abc123",
  "fromInventoryId": "abc123",
  "toInventoryId": "abc123",
  "prevFromInventoryId": "abc123",
  "declinedDate": 1704067200000,
  "acceptedDate": 1704067200000,
  "transferNo": "string",
  "completeTransfer": false,
  "transferByBatch": false,
  "processedTime": 1704067200000,
  "processing": false,
  "driverId": "abc123",
  "transactionId": "abc123",
  "orderNo": "string",
  "activeTopUserId": "abc123"
}

---

Inventory transfer For Partner

PUT /api/v1/partner/store/batches/transferInventory/{historyId}

Update an existing inventory transfer that has not yet been accepted or declined. Use this to modify items, quantities, or other details on a pending transfer.

Path Parameters

Parameter	Type	Description
historyId	string	The history i d

Request Body

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
status	string	No	Status. One of: ACCEPTED, DECLINED, PENDING
createByEmployeeId	string	No	Create By Employee identifier
acceptByEmployeeId	string	No	Accept By Employee identifier
declineByEmployeeId	string	No	Decline By Employee identifier
fromShopId	string	No	From Shop identifier
toShopId	string	No	To Shop identifier
fromInventoryId	string	Yes	From Inventory identifier
toInventoryId	string	Yes	To Inventory identifier
prevFromInventoryId	string	No	Prev From Inventory identifier
declinedDate	long	No	Declined timestamp (epoch ms)
acceptedDate	long	No	Accepted timestamp (epoch ms)
transferNo	string	No	Transfer No
completeTransfer	boolean	No	Complete Transfer
transferByBatch	boolean	No	Transfer By Batch
processedTime	long	No	Processed timestamp (epoch ms)
processing	boolean	No	Processing (default: false)
driverId	string	No	Driver identifier
transactionId	string	No	Transaction identifier
orderNo	string	No	Order No
activeTopUserId	string	No	Active Top User identifier
currentEmployeeId	string	Yes	Current Employee identifier

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "status": "ACCEPTED",
  "createByEmployeeId": "abc123",
  "acceptByEmployeeId": "abc123",
  "declineByEmployeeId": "abc123",
  "fromShopId": "abc123",
  "toShopId": "abc123",
  "fromInventoryId": "abc123",
  "toInventoryId": "abc123",
  "prevFromInventoryId": "abc123",
  "declinedDate": 1704067200000,
  "acceptedDate": 1704067200000,
  "transferNo": "string",
  "completeTransfer": false,
  "transferByBatch": false,
  "processedTime": 1704067200000,
  "processing": false,
  "driverId": "abc123",
  "transactionId": "abc123",
  "orderNo": "string",
  "activeTopUserId": "abc123",
  "currentEmployeeId": "abc123"
}

Response

Returns a InventoryTransferHistory object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
status	string	No	Status. One of: ACCEPTED, DECLINED, PENDING
createByEmployeeId	string	No	Create By Employee identifier
acceptByEmployeeId	string	No	Accept By Employee identifier
declineByEmployeeId	string	No	Decline By Employee identifier
fromShopId	string	No	From Shop identifier
toShopId	string	No	To Shop identifier
fromInventoryId	string	Yes	From Inventory identifier
toInventoryId	string	Yes	To Inventory identifier
prevFromInventoryId	string	No	Prev From Inventory identifier
declinedDate	long	No	Declined timestamp (epoch ms)
acceptedDate	long	No	Accepted timestamp (epoch ms)
transferNo	string	No	Transfer No
completeTransfer	boolean	No	Complete Transfer
transferByBatch	boolean	No	Transfer By Batch
processedTime	long	No	Processed timestamp (epoch ms)
processing	boolean	No	Processing (default: false)
driverId	string	No	Driver identifier
transactionId	string	No	Transaction identifier
orderNo	string	No	Order No
activeTopUserId	string	No	Active Top User identifier

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "status": "ACCEPTED",
  "createByEmployeeId": "abc123",
  "acceptByEmployeeId": "abc123",
  "declineByEmployeeId": "abc123",
  "fromShopId": "abc123",
  "toShopId": "abc123",
  "fromInventoryId": "abc123",
  "toInventoryId": "abc123",
  "prevFromInventoryId": "abc123",
  "declinedDate": 1704067200000,
  "acceptedDate": 1704067200000,
  "transferNo": "string",
  "completeTransfer": false,
  "transferByBatch": false,
  "processedTime": 1704067200000,
  "processing": false,
  "driverId": "abc123",
  "transactionId": "abc123",
  "orderNo": "string",
  "activeTopUserId": "abc123"
}

---

Accept inventory transfer history's status for partner

POST /api/v1/partner/store/batches/transferInventory/{historyId}/accept

Accept a pending inventory transfer, triggering the actual movement of inventory. Requires currentEmployeeId to record who accepted the transfer. After acceptance, a background job processes the inventory movement.

Path Parameters

Parameter	Type	Description
historyId	string	The history i d

Request Body

Fields

Field	Type	Required	Description
currentEmployeeId	string	Yes	Current Employee identifier

JSON

{
  "currentEmployeeId": "abc123"
}

Response

Returns a InventoryTransferHistory object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
status	string	No	Status. One of: ACCEPTED, DECLINED, PENDING
createByEmployeeId	string	No	Create By Employee identifier
acceptByEmployeeId	string	No	Accept By Employee identifier
declineByEmployeeId	string	No	Decline By Employee identifier
fromShopId	string	No	From Shop identifier
toShopId	string	No	To Shop identifier
fromInventoryId	string	Yes	From Inventory identifier
toInventoryId	string	Yes	To Inventory identifier
prevFromInventoryId	string	No	Prev From Inventory identifier
declinedDate	long	No	Declined timestamp (epoch ms)
acceptedDate	long	No	Accepted timestamp (epoch ms)
transferNo	string	No	Transfer No
completeTransfer	boolean	No	Complete Transfer
transferByBatch	boolean	No	Transfer By Batch
processedTime	long	No	Processed timestamp (epoch ms)
processing	boolean	No	Processing (default: false)
driverId	string	No	Driver identifier
transactionId	string	No	Transaction identifier
orderNo	string	No	Order No
activeTopUserId	string	No	Active Top User identifier

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "status": "ACCEPTED",
  "createByEmployeeId": "abc123",
  "acceptByEmployeeId": "abc123",
  "declineByEmployeeId": "abc123",
  "fromShopId": "abc123",
  "toShopId": "abc123",
  "fromInventoryId": "abc123",
  "toInventoryId": "abc123",
  "prevFromInventoryId": "abc123",
  "declinedDate": 1704067200000,
  "acceptedDate": 1704067200000,
  "transferNo": "string",
  "completeTransfer": false,
  "transferByBatch": false,
  "processedTime": 1704067200000,
  "processing": false,
  "driverId": "abc123",
  "transactionId": "abc123",
  "orderNo": "string",
  "activeTopUserId": "abc123"
}

---

Decline inventory transfer history's status for partner

POST /api/v1/partner/store/batches/transferInventory/{historyId}/decline

Decline a pending inventory transfer. Requires currentEmployeeId to record who declined it. The transfer items will not be moved.

Path Parameters

Parameter	Type	Description
historyId	string	The history i d

Request Body

Fields

Field	Type	Required	Description
currentEmployeeId	string	Yes	Current Employee identifier

JSON

{
  "currentEmployeeId": "abc123"
}

Response

Returns a InventoryTransferHistory object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
status	string	No	Status. One of: ACCEPTED, DECLINED, PENDING
createByEmployeeId	string	No	Create By Employee identifier
acceptByEmployeeId	string	No	Accept By Employee identifier
declineByEmployeeId	string	No	Decline By Employee identifier
fromShopId	string	No	From Shop identifier
toShopId	string	No	To Shop identifier
fromInventoryId	string	Yes	From Inventory identifier
toInventoryId	string	Yes	To Inventory identifier
prevFromInventoryId	string	No	Prev From Inventory identifier
declinedDate	long	No	Declined timestamp (epoch ms)
acceptedDate	long	No	Accepted timestamp (epoch ms)
transferNo	string	No	Transfer No
completeTransfer	boolean	No	Complete Transfer
transferByBatch	boolean	No	Transfer By Batch
processedTime	long	No	Processed timestamp (epoch ms)
processing	boolean	No	Processing (default: false)
driverId	string	No	Driver identifier
transactionId	string	No	Transaction identifier
orderNo	string	No	Order No
activeTopUserId	string	No	Active Top User identifier

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "status": "ACCEPTED",
  "createByEmployeeId": "abc123",
  "acceptByEmployeeId": "abc123",
  "declineByEmployeeId": "abc123",
  "fromShopId": "abc123",
  "toShopId": "abc123",
  "fromInventoryId": "abc123",
  "toInventoryId": "abc123",
  "prevFromInventoryId": "abc123",
  "declinedDate": 1704067200000,
  "acceptedDate": 1704067200000,
  "transferNo": "string",
  "completeTransfer": false,
  "transferByBatch": false,
  "processedTime": 1704067200000,
  "processing": false,
  "driverId": "abc123",
  "transactionId": "abc123",
  "orderNo": "string",
  "activeTopUserId": "abc123"
}