Batch Get Variants
POST /v1/{companyId}/variants/batch-get
POST
/v1/{companyId}/variants/batch-get
Retrieves a batch of product variants for a specified company and location. You can look up variants using a list of barcodes, a list of SKUs, or a combination of both.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” companyId
required
string
Request Body required
Section titled “Request Body required ”Request body for batch get variants
object
barcodes
Array<string>
locationId
required
integer
skus
Array<string>
stateCode
string
Responses
Section titled “ Responses ”200 response
Response body for batch get variants
object
failedBarcodes
required
Array<string>
failedSkus
required
Array<string>
mappedSkuBarcodes
required
object
variants
required
Array<object>
object
assets
required
object
barcode
required
string
brand
required
string
brandAssets
required
object
cannabisUnitOfMeasure
required
string
catalogSource
object
cbd
required
object
avg
required
string
max
required
string
min
required
string
classification
required
string
delisted
required
boolean
description
required
string
lineages
required
Array<string>
manufacturer
required
string
name
required
string
packagedQuantity
required
integer
presentTerpenes
required
Array<string>
productType
required
string
secondaryCannabinoids
required
object
shortDescription
required
string
strain
required
string
tac
required
object
avg
required
string
max
required
string
min
required
string
terpeneUnitOfMeasure
required
string
thc
required
object
avg
required
string
max
required
string
min
required
string
topTerpene
required
string
totalTerpene
required
object
avg
required
string
max
required
string
min
required
string
unitOfMeasure
required
string
unitSize
required
number
variantType
required
string