Skip to content
BudSense Partner API - prod

Batch Get Variants

POST
/v1/{companyId}/variants/batch-get
curl --request POST \
  --url https://example.com/v1/example/variants/batch-get \
  --header 'Content-Type: application/json' \
  --data '{ "barcodes": [ "example" ], "locationId": 1, "skus": [ "example" ], "stateCode": "example" }'

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.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
companyId
required
string

The company ID

Request Bodyrequired

Section titled “ Request Bodyrequired ”

Request body

Media typeapplication/json
object
barcodes
Array<string>
locationId
required
integer
skus
Array<string>
stateCode
string
Examplegenerated
{
  "barcodes": [
    "example"
  ],
  "locationId": 1,
  "skus": [
    "example"
  ],
  "stateCode": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”
Media typeapplication/json
object
failedBarcodes
required
Array<string>
failedSkus
required
Array<string>
mappedSkuBarcodes
required
object
variants
required
Array<object>
object
appearance
Array<string>
aromas
Array<string>
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
companyId
required
integer
craftDesignations
Array<string>
delisted
required
boolean
description
required
string
effects
Array<string>
energyScore
string
flavors
Array<string>
gradingResults
object
growingConditions
Array<string>
helpsWith
Array<string>
lineages
required
Array<string>
locationId
required
integer
manufacturer
required
string
name
required
string
originCity
string
originState
string
packagedQuantity
required
integer
presentTerpenes
required
Array<string>
productType
required
string
secondaryCannabinoids
required
object
shortDescription
required
string
strain
required
string
strainType
required
string
tac
required
object
avg
required
string
max
required
string
min
required
string
tags
Array<string>
terpeneUnitOfMeasure
required
string
thc
required
object
avg
required
string
max
required
string
min
required
string
topFlavor
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
Examplegenerated
{
  "failedBarcodes": [
    "example"
  ],
  "failedSkus": [
    "example"
  ],
  "mappedSkuBarcodes": {},
  "variants": [
    {
      "appearance": [
        "example"
      ],
      "aromas": [
        "example"
      ],
      "assets": {},
      "barcode": "example",
      "brand": "example",
      "brandAssets": {},
      "cannabisUnitOfMeasure": "example",
      "catalogSource": {},
      "cbd": {
        "avg": "example",
        "max": "example",
        "min": "example"
      },
      "classification": "example",
      "companyId": 1,
      "craftDesignations": [
        "example"
      ],
      "delisted": true,
      "description": "example",
      "effects": [
        "example"
      ],
      "energyScore": "example",
      "flavors": [
        "example"
      ],
      "gradingResults": {},
      "growingConditions": [
        "example"
      ],
      "helpsWith": [
        "example"
      ],
      "lineages": [
        "example"
      ],
      "locationId": 1,
      "manufacturer": "example",
      "name": "example",
      "originCity": "example",
      "originState": "example",
      "packagedQuantity": 1,
      "presentTerpenes": [
        "example"
      ],
      "productType": "example",
      "secondaryCannabinoids": {},
      "shortDescription": "example",
      "strain": "example",
      "strainType": "example",
      "tac": {
        "avg": "example",
        "max": "example",
        "min": "example"
      },
      "tags": [
        "example"
      ],
      "terpeneUnitOfMeasure": "example",
      "thc": {
        "avg": "example",
        "max": "example",
        "min": "example"
      },
      "topFlavor": "example",
      "topTerpene": "example",
      "totalTerpene": {
        "avg": "example",
        "max": "example",
        "min": "example"
      },
      "unitOfMeasure": "example",
      "unitSize": 1,
      "variantType": "example"
    }
  ]
}

Headers

Section titled “ Headers ”
Access-Control-Allow-Origin
string
default: *
Example
*

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

401

Section titled “ 401 ”
Media typeapplication/json
object
body
required
code
required
integer
message
required
string
suggestion
required
string
title
required
string
Examplegenerated
{
  "body": "example",
  "code": 1,
  "message": "example",
  "suggestion": "example",
  "title": "example"
}

Headers

Section titled “ Headers ”
Access-Control-Allow-Origin
string
default: *
Example
*

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

500

Section titled “ 500 ”
Media typeapplication/json
object
body
required
code
required
integer
message
required
string
suggestion
required
string
title
required
string
Examplegenerated
{
  "body": "example",
  "code": 1,
  "message": "example",
  "suggestion": "example",
  "title": "example"
}

Headers

Section titled “ Headers ”
Access-Control-Allow-Origin
string
default: *
Example
*

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link