Products
Manage product catalog including creating, updating, and searching products.
Base URL: /api/v1/partner/products
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
| GET | /{productId} | Get product by id |
| GET | /sku/{sku} | Get product by SKU |
| POST | / | Create product |
| PUT | /{productId} | Update Product |
| GET | / | Get list of products |
| GET | /modified | Get list of products by modified date |
| GET | /nearby | Get list of nearby products |
| PUT | /{productId}/metadata | Update Product Meta Data |
| GET | /prices/sync | Sync group pricing |
Get product by id
GET /api/v1/partner/products/{productId}
Retrieve a single product by its ID. Set omitTaxTables to true to exclude tax table data from the response for a lighter payload.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
productId | string | The product i d |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
omitTaxTables | boolean | No | omit tax tables |
Response
Returns a Product object.
- Fields
- JSON
| 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 |
checkSum | long | No | Check Sum |
importId | string | No | Import identifier |
importSrc | string | No | Import Src |
categoryId | string | No | Category identifier |
sku | string | No | Sku |
vendorId | string | No | Vendor identifier |
productSaleType | productsaletype | No | Product Sale Type (default: Both) |
name | string | Yes | Name |
description | string | No | Description (default: ``) |
flowerType | string | No | Flower Type |
unitPrice | number | No | Unit Price |
purchasePrice | number | No | Purchase Price |
weightPerUnit | weightperunit | No | Weight Per Unit (default: EACH) |
unitValue | number | No | Unit Value |
thc | double | No | Thc |
cbn | double | No | Cbn |
cbd | double | No | Cbd |
cbda | double | No | Cbda |
thca | double | No | Thca |
cbg | double | No | Cbg |
totalCannabinoids | double | No | Total Cannabinoids |
totalTerpenes | double | No | Total Terpenes |
terpenoids | object | No | Terpenoids |
active | boolean | No | Whether active (default: true) |
genetics | string | No | Genetics |
medicalConditions | MedicalCondition[] | No | Medical Conditions |
priceRanges | ProductPriceRange[] | No | Price Ranges |
priceBreaks | ProductPriceBreak[] | No | Price Breaks |
assets | CompanyAsset[] | No | Assets |
quantities | ProductQuantity[] | No | Quantities |
instock | boolean | No | Instock (default: false) |
brandId | string | No | Brand identifier |
category | ProductCategory | No | Category |
notes | Note[] | No | Notes |
enableMixMatch | boolean | No | Enable Mix Match (default: false) |
enableWeedmap | boolean | No | Enable Weedmap (default: false) |
showInWidget | boolean | No | Show In Widget (default: true) |
customTaxInfo | TaxInfo | No | Custom Tax Info |
discountable | boolean | No | Discountable (default: true) |
discountEnabled | boolean | No | Discount Enabled (default: true) |
brand | Brand | No | Brand |
lowThreshold | number | No | Low Threshold |
lowInventoryNotification | boolean | No | Low Inventory Notification (default: false) |
medicinal | boolean | No | Medicinal (default: true) |
byGram | boolean | No | By Gram (default: true) |
byPrepackage | boolean | No | By Prepackage (default: false) |
enableExciseTax | boolean | No | Enable Excise Tax (default: false) |
priceIncludesExcise | boolean | No | Price Includes Excise (default: false) |
priceIncludesALExcise | boolean | No | Price Includes A L Excise (default: false) |
cannabisType | cannabistype | No | Cannabis Type (default: DEFAULT) |
potencyAmount | PotencyMG | No | Potency Amount |
taxTables | CompoundTaxTable[] | No | Tax Tables |
tags | string[] | No | Tags |
qbItemRef | string | No | Qb Item Ref |
customWeight | number | No | Custom Weight |
automaticReOrder | boolean | No | Automatic Re Order (default: false) |
reOrderLevel | number | No | Re Order Level |
leadTime | integer | No | Lead timestamp (epoch ms) (default: 0) |
minDaysOnHand | integer | No | Min Days On Hand (default: 0) |
maxDaysOnHand | integer | No | Max Days On Hand (default: 0) |
customGramType | customgramtype | No | Custom Gram Type (default: GRAM) |
pricingTemplateId | string | No | Pricing Template identifier |
companyPricingTemplateId | string | No | Company Pricing Template identifier |
productType | producttype | No | Product Type (default: REGULAR) |
bundleItems | BundleItem[] | No | Bundle Items |
complianceId | string | No | Compliance identifier |
toleranceId | string | No | Tolerance identifier |
producerMfg | string | No | Producer Mfg |
producerLicense | string | No | Producer License |
producerAddress | Address | No | Producer Address |
sellable | boolean | No | Sellable (default: true) |
wmThreshold | number | No | Wm Threshold (default: ZERO) |
salesPrice | number | No | Sales Price |
lastWMSyncTime | long | No | Last W M Sync timestamp (epoch ms) |
lastLeaflySyncTime | long | No | Last Leafly Sync timestamp (epoch ms) |
lastLeaflySyncStatus | boolean | No | Last Leafly Sync Status (default: false) |
overrideMetrcCategoryId | string | No | Override Metrc Category identifier |
wmOnlineSellable | boolean | No | Wm Online Sellable (default: true) |
totalCommittedQuantity | number | No | Total Committed Quantity (default: ZERO) |
totalSellableQuantity | number | No | Total Sellable Quantity (default: ZERO) |
usableMarijuana | number | No | Usable Marijuana (default: ZERO) |
dispatchPrepackageItemId | string | No | Dispatch Prepackage Item identifier |
secondaryVendors | string[] | No | Secondary Vendors |
wmProductId | string | No | Wm Product identifier |
wmBrandId | string | No | Wm Brand identifier |
wmTags | string[] | No | Wm Tags |
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 |
complianceInfo | ComplianceProductInfo | No | Compliance Info |
totalConsumerOrderQuantity | number | No | Total Consumer Order Quantity (default: ZERO) |
metadata | Metadata[] | No | Metadata |
brandName | string | No | Brand Name |
purchaseLimits | purchaselimit[] | No | Purchase Limits |
productInfoSourcingStrategy | productinfosourcingstrategy | No | Product Info Sourcing Strategy (default: NONE) |
activeBatchId | string | No | Active Batch identifier |
activeBatchSku | string | No | Active Batch Sku |
externalId | string | No | External system identifier |
masterId | string | No | Master identifier |
companyProductId | string | No | Company Product identifier |
parentId | string | No | Parent identifier |
globalProductId | string | No | Global Product identifier |
platformProductId | string | No | Platform Product identifier |
shop | Shop | No | Shop |
sourceMap | object | No | Source Map |
shopsList | Shop[] | No | Shops List |
menuApiBrandName | string | No | Menu Api Brand Name |
menuApiProductName | string | No | Menu Api Product Name |
menuApiProductId | integer | No | Menu Api Product identifier |
menuApiVariantProductId | integer | No | Menu Api Variant Product identifier |
menuApiBrandId | integer | No | Menu Api Brand identifier |
metadataModifiedAt | long | No | Metadata Modified At |
component | boolean | No | Component (default: false) |
item | boolean | No | Item (default: false) |
productFamilyId | string | No | Product Family identifier |
archived | boolean | No | Archived (default: false) |
isGiftCard | boolean | No | Is Gift Card |
provider | string | No | Provider |
loyaltyAccrual | boolean | No | Loyalty Accrual (default: true) |
metadataMap | object | No | Metadata Map |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"checkSum": 0,
"importId": "abc123",
"importSrc": "string",
"categoryId": "abc123",
"sku": "string",
"vendorId": "abc123",
"productSaleType": "Both",
"name": "string",
"description": "",
"flowerType": "string",
"unitPrice": 0,
"purchasePrice": 0,
"weightPerUnit": "EACH",
"unitValue": 0,
"thc": 0,
"cbn": 0,
"cbd": 0,
"cbda": 0,
"thca": 0,
"cbg": 0,
"totalCannabinoids": 0,
"totalTerpenes": 0,
"terpenoids": {},
"active": true,
"genetics": "string",
"medicalConditions": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"priceRanges": [
{
"id": "abc123",
"weightToleranceId": "abc123",
"price": 0,
"priority": 0,
"weightTolerance": {},
"salePrice": 0
}
],
"priceBreaks": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"priceBreakType": "None",
"name": "string",
"displayName": "string",
"price": 0,
"quantity": 1,
"active": true,
"priority": 0,
"salePrice": 0
}
],
"assets": [
{
"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"
}
],
"quantities": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"inventoryId": "abc123",
"quantity": 0
}
],
"instock": false,
"brandId": "abc123",
"category": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"cannabis": false,
"blazeCategoryId": "abc123",
"active": true,
"unitType": "units",
"lowThreshold": "ZERO",
"complianceId": "abc123",
"archived": false,
"topLevelCategoryId": "abc123",
"normalizedCategoryId": "abc123",
"shopIds": [],
"parentCategoryId": "abc123",
"companyCategoryId": "abc123",
"wmCategory": "string",
"externalId": "abc123",
"priority": 0,
"masterId": "abc123",
"platformCategoryId": "abc123",
"platformParentCategoryId": "abc123",
"sourceMap": {},
"photo": {},
"labelTemplateId": "abc123",
"categoryApp": "DISTRO",
"unitTrackingEnabled": false,
"isGiftCard": false
},
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"enableMixMatch": false,
"enableWeedmap": false,
"showInWidget": true,
"customTaxInfo": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"cityTax": 0,
"stateTax": 0,
"federalTax": 0,
"activeCDTFATax": false
},
"discountable": true,
"discountEnabled": true,
"brand": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"email": "user@example.com",
"description": "string",
"brandLogo": {},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
},
"lowThreshold": 0,
"lowInventoryNotification": false,
"medicinal": true,
"byGram": true,
"byPrepackage": false,
"enableExciseTax": false,
"priceIncludesExcise": false,
"priceIncludesALExcise": false,
"cannabisType": "DEFAULT",
"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"
},
"taxTables": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"taxType": "Inherit",
"taxOrder": "PostTaxed",
"consumerType": "AdultUse",
"cityTax": {},
"countyTax": {},
"stateTax": {},
"federalTax": {},
"enableSurchargeFeeTax": false
}
],
"tags": [],
"qbItemRef": "string",
"customWeight": 0,
"automaticReOrder": false,
"reOrderLevel": 0,
"leadTime": 0,
"minDaysOnHand": 0,
"maxDaysOnHand": 0,
"customGramType": "GRAM",
"pricingTemplateId": "abc123",
"companyPricingTemplateId": "abc123",
"productType": "REGULAR",
"bundleItems": [
{
"productId": "abc123",
"quantity": 0
}
],
"complianceId": "abc123",
"toleranceId": "abc123",
"producerMfg": "string",
"producerLicense": "string",
"producerAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"sellable": true,
"wmThreshold": "ZERO",
"salesPrice": 0,
"lastWMSyncTime": 1704067200000,
"lastLeaflySyncTime": 1704067200000,
"lastLeaflySyncStatus": false,
"overrideMetrcCategoryId": "abc123",
"wmOnlineSellable": true,
"totalCommittedQuantity": "ZERO",
"totalSellableQuantity": "ZERO",
"usableMarijuana": "ZERO",
"dispatchPrepackageItemId": "abc123",
"secondaryVendors": [],
"wmProductId": "abc123",
"wmBrandId": "abc123",
"wmTags": [],
"maxThc": 0,
"maxCbn": 0,
"maxCbd": 0,
"maxCbda": 0,
"maxThca": 0,
"complianceInfo": {
"statementIntendedUse": [],
"refrigeration": "string",
"form": "",
"ingredients": "",
"allergens": "",
"strain": "string",
"servingsPerContainer": 0
},
"totalConsumerOrderQuantity": "ZERO",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"brandName": "string",
"purchaseLimits": [],
"productInfoSourcingStrategy": "NONE",
"activeBatchId": "abc123",
"activeBatchSku": "string",
"externalId": "abc123",
"masterId": "abc123",
"companyProductId": "abc123",
"parentId": "abc123",
"globalProductId": "abc123",
"platformProductId": "abc123",
"shop": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
},
"sourceMap": {},
"shopsList": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
}
],
"menuApiBrandName": "string",
"menuApiProductName": "string",
"menuApiProductId": 0,
"menuApiVariantProductId": 0,
"menuApiBrandId": 0,
"metadataModifiedAt": 0,
"component": false,
"item": false,
"productFamilyId": "abc123",
"archived": false,
"isGiftCard": false,
"provider": "string",
"loyaltyAccrual": true,
"metadataMap": {}
}
Get product by SKU
GET /api/v1/partner/products/sku/{sku}
Look up a product by its SKU identifier. Returns the product if a match is found.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
sku | string | The sku |
Response
Returns a Product object.
- Fields
- JSON
| 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 |
checkSum | long | No | Check Sum |
importId | string | No | Import identifier |
importSrc | string | No | Import Src |
categoryId | string | No | Category identifier |
sku | string | No | Sku |
vendorId | string | No | Vendor identifier |
productSaleType | productsaletype | No | Product Sale Type (default: Both) |
name | string | Yes | Name |
description | string | No | Description (default: ``) |
flowerType | string | No | Flower Type |
unitPrice | number | No | Unit Price |
purchasePrice | number | No | Purchase Price |
weightPerUnit | weightperunit | No | Weight Per Unit (default: EACH) |
unitValue | number | No | Unit Value |
thc | double | No | Thc |
cbn | double | No | Cbn |
cbd | double | No | Cbd |
cbda | double | No | Cbda |
thca | double | No | Thca |
cbg | double | No | Cbg |
totalCannabinoids | double | No | Total Cannabinoids |
totalTerpenes | double | No | Total Terpenes |
terpenoids | object | No | Terpenoids |
active | boolean | No | Whether active (default: true) |
genetics | string | No | Genetics |
medicalConditions | MedicalCondition[] | No | Medical Conditions |
priceRanges | ProductPriceRange[] | No | Price Ranges |
priceBreaks | ProductPriceBreak[] | No | Price Breaks |
assets | CompanyAsset[] | No | Assets |
quantities | ProductQuantity[] | No | Quantities |
instock | boolean | No | Instock (default: false) |
brandId | string | No | Brand identifier |
category | ProductCategory | No | Category |
notes | Note[] | No | Notes |
enableMixMatch | boolean | No | Enable Mix Match (default: false) |
enableWeedmap | boolean | No | Enable Weedmap (default: false) |
showInWidget | boolean | No | Show In Widget (default: true) |
customTaxInfo | TaxInfo | No | Custom Tax Info |
discountable | boolean | No | Discountable (default: true) |
discountEnabled | boolean | No | Discount Enabled (default: true) |
brand | Brand | No | Brand |
lowThreshold | number | No | Low Threshold |
lowInventoryNotification | boolean | No | Low Inventory Notification (default: false) |
medicinal | boolean | No | Medicinal (default: true) |
byGram | boolean | No | By Gram (default: true) |
byPrepackage | boolean | No | By Prepackage (default: false) |
enableExciseTax | boolean | No | Enable Excise Tax (default: false) |
priceIncludesExcise | boolean | No | Price Includes Excise (default: false) |
priceIncludesALExcise | boolean | No | Price Includes A L Excise (default: false) |
cannabisType | cannabistype | No | Cannabis Type (default: DEFAULT) |
potencyAmount | PotencyMG | No | Potency Amount |
taxTables | CompoundTaxTable[] | No | Tax Tables |
tags | string[] | No | Tags |
qbItemRef | string | No | Qb Item Ref |
customWeight | number | No | Custom Weight |
automaticReOrder | boolean | No | Automatic Re Order (default: false) |
reOrderLevel | number | No | Re Order Level |
leadTime | integer | No | Lead timestamp (epoch ms) (default: 0) |
minDaysOnHand | integer | No | Min Days On Hand (default: 0) |
maxDaysOnHand | integer | No | Max Days On Hand (default: 0) |
customGramType | customgramtype | No | Custom Gram Type (default: GRAM) |
pricingTemplateId | string | No | Pricing Template identifier |
companyPricingTemplateId | string | No | Company Pricing Template identifier |
productType | producttype | No | Product Type (default: REGULAR) |
bundleItems | BundleItem[] | No | Bundle Items |
complianceId | string | No | Compliance identifier |
toleranceId | string | No | Tolerance identifier |
producerMfg | string | No | Producer Mfg |
producerLicense | string | No | Producer License |
producerAddress | Address | No | Producer Address |
sellable | boolean | No | Sellable (default: true) |
wmThreshold | number | No | Wm Threshold (default: ZERO) |
salesPrice | number | No | Sales Price |
lastWMSyncTime | long | No | Last W M Sync timestamp (epoch ms) |
lastLeaflySyncTime | long | No | Last Leafly Sync timestamp (epoch ms) |
lastLeaflySyncStatus | boolean | No | Last Leafly Sync Status (default: false) |
overrideMetrcCategoryId | string | No | Override Metrc Category identifier |
wmOnlineSellable | boolean | No | Wm Online Sellable (default: true) |
totalCommittedQuantity | number | No | Total Committed Quantity (default: ZERO) |
totalSellableQuantity | number | No | Total Sellable Quantity (default: ZERO) |
usableMarijuana | number | No | Usable Marijuana (default: ZERO) |
dispatchPrepackageItemId | string | No | Dispatch Prepackage Item identifier |
secondaryVendors | string[] | No | Secondary Vendors |
wmProductId | string | No | Wm Product identifier |
wmBrandId | string | No | Wm Brand identifier |
wmTags | string[] | No | Wm Tags |
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 |
complianceInfo | ComplianceProductInfo | No | Compliance Info |
totalConsumerOrderQuantity | number | No | Total Consumer Order Quantity (default: ZERO) |
metadata | Metadata[] | No | Metadata |
brandName | string | No | Brand Name |
purchaseLimits | purchaselimit[] | No | Purchase Limits |
productInfoSourcingStrategy | productinfosourcingstrategy | No | Product Info Sourcing Strategy (default: NONE) |
activeBatchId | string | No | Active Batch identifier |
activeBatchSku | string | No | Active Batch Sku |
externalId | string | No | External system identifier |
masterId | string | No | Master identifier |
companyProductId | string | No | Company Product identifier |
parentId | string | No | Parent identifier |
globalProductId | string | No | Global Product identifier |
platformProductId | string | No | Platform Product identifier |
shop | Shop | No | Shop |
sourceMap | object | No | Source Map |
shopsList | Shop[] | No | Shops List |
menuApiBrandName | string | No | Menu Api Brand Name |
menuApiProductName | string | No | Menu Api Product Name |
menuApiProductId | integer | No | Menu Api Product identifier |
menuApiVariantProductId | integer | No | Menu Api Variant Product identifier |
menuApiBrandId | integer | No | Menu Api Brand identifier |
metadataModifiedAt | long | No | Metadata Modified At |
component | boolean | No | Component (default: false) |
item | boolean | No | Item (default: false) |
productFamilyId | string | No | Product Family identifier |
archived | boolean | No | Archived (default: false) |
isGiftCard | boolean | No | Is Gift Card |
provider | string | No | Provider |
loyaltyAccrual | boolean | No | Loyalty Accrual (default: true) |
metadataMap | object | No | Metadata Map |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"checkSum": 0,
"importId": "abc123",
"importSrc": "string",
"categoryId": "abc123",
"sku": "string",
"vendorId": "abc123",
"productSaleType": "Both",
"name": "string",
"description": "",
"flowerType": "string",
"unitPrice": 0,
"purchasePrice": 0,
"weightPerUnit": "EACH",
"unitValue": 0,
"thc": 0,
"cbn": 0,
"cbd": 0,
"cbda": 0,
"thca": 0,
"cbg": 0,
"totalCannabinoids": 0,
"totalTerpenes": 0,
"terpenoids": {},
"active": true,
"genetics": "string",
"medicalConditions": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"priceRanges": [
{
"id": "abc123",
"weightToleranceId": "abc123",
"price": 0,
"priority": 0,
"weightTolerance": {},
"salePrice": 0
}
],
"priceBreaks": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"priceBreakType": "None",
"name": "string",
"displayName": "string",
"price": 0,
"quantity": 1,
"active": true,
"priority": 0,
"salePrice": 0
}
],
"assets": [
{
"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"
}
],
"quantities": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"inventoryId": "abc123",
"quantity": 0
}
],
"instock": false,
"brandId": "abc123",
"category": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"cannabis": false,
"blazeCategoryId": "abc123",
"active": true,
"unitType": "units",
"lowThreshold": "ZERO",
"complianceId": "abc123",
"archived": false,
"topLevelCategoryId": "abc123",
"normalizedCategoryId": "abc123",
"shopIds": [],
"parentCategoryId": "abc123",
"companyCategoryId": "abc123",
"wmCategory": "string",
"externalId": "abc123",
"priority": 0,
"masterId": "abc123",
"platformCategoryId": "abc123",
"platformParentCategoryId": "abc123",
"sourceMap": {},
"photo": {},
"labelTemplateId": "abc123",
"categoryApp": "DISTRO",
"unitTrackingEnabled": false,
"isGiftCard": false
},
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"enableMixMatch": false,
"enableWeedmap": false,
"showInWidget": true,
"customTaxInfo": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"cityTax": 0,
"stateTax": 0,
"federalTax": 0,
"activeCDTFATax": false
},
"discountable": true,
"discountEnabled": true,
"brand": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"email": "user@example.com",
"description": "string",
"brandLogo": {},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
},
"lowThreshold": 0,
"lowInventoryNotification": false,
"medicinal": true,
"byGram": true,
"byPrepackage": false,
"enableExciseTax": false,
"priceIncludesExcise": false,
"priceIncludesALExcise": false,
"cannabisType": "DEFAULT",
"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"
},
"taxTables": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"taxType": "Inherit",
"taxOrder": "PostTaxed",
"consumerType": "AdultUse",
"cityTax": {},
"countyTax": {},
"stateTax": {},
"federalTax": {},
"enableSurchargeFeeTax": false
}
],
"tags": [],
"qbItemRef": "string",
"customWeight": 0,
"automaticReOrder": false,
"reOrderLevel": 0,
"leadTime": 0,
"minDaysOnHand": 0,
"maxDaysOnHand": 0,
"customGramType": "GRAM",
"pricingTemplateId": "abc123",
"companyPricingTemplateId": "abc123",
"productType": "REGULAR",
"bundleItems": [
{
"productId": "abc123",
"quantity": 0
}
],
"complianceId": "abc123",
"toleranceId": "abc123",
"producerMfg": "string",
"producerLicense": "string",
"producerAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"sellable": true,
"wmThreshold": "ZERO",
"salesPrice": 0,
"lastWMSyncTime": 1704067200000,
"lastLeaflySyncTime": 1704067200000,
"lastLeaflySyncStatus": false,
"overrideMetrcCategoryId": "abc123",
"wmOnlineSellable": true,
"totalCommittedQuantity": "ZERO",
"totalSellableQuantity": "ZERO",
"usableMarijuana": "ZERO",
"dispatchPrepackageItemId": "abc123",
"secondaryVendors": [],
"wmProductId": "abc123",
"wmBrandId": "abc123",
"wmTags": [],
"maxThc": 0,
"maxCbn": 0,
"maxCbd": 0,
"maxCbda": 0,
"maxThca": 0,
"complianceInfo": {
"statementIntendedUse": [],
"refrigeration": "string",
"form": "",
"ingredients": "",
"allergens": "",
"strain": "string",
"servingsPerContainer": 0
},
"totalConsumerOrderQuantity": "ZERO",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"brandName": "string",
"purchaseLimits": [],
"productInfoSourcingStrategy": "NONE",
"activeBatchId": "abc123",
"activeBatchSku": "string",
"externalId": "abc123",
"masterId": "abc123",
"companyProductId": "abc123",
"parentId": "abc123",
"globalProductId": "abc123",
"platformProductId": "abc123",
"shop": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
},
"sourceMap": {},
"shopsList": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
}
],
"menuApiBrandName": "string",
"menuApiProductName": "string",
"menuApiProductId": 0,
"menuApiVariantProductId": 0,
"menuApiBrandId": 0,
"metadataModifiedAt": 0,
"component": false,
"item": false,
"productFamilyId": "abc123",
"archived": false,
"isGiftCard": false,
"provider": "string",
"loyaltyAccrual": true,
"metadataMap": {}
}
Create product
POST /api/v1/partner/products
Create a new product in the catalog. Send a ProductAddRequest in the request body with the product details.
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
importId | string | No | Import identifier |
categoryId | string | No | Category identifier |
categoryName | string | No | Category Name |
sku | string | No | Sku |
metadataModifiedAt | long | No | Metadata Modified At (default: 0) |
vendorId | string | No | Vendor identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
vendorImportId | string | No | Vendor Import identifier |
brandId | string | No | Brand identifier |
name | string | Yes | Name |
description | string | No | Description (default: ``) |
flowerType | string | No | Flower Type |
unitPrice | number | No | Unit Price |
purchasePrice | number | No | Purchase Price |
totalCannabinoids | double | No | Total Cannabinoids |
totalTerpenes | double | No | Total Terpenes |
terpenoids | object | No | Terpenoids |
genetics | string | No | Genetics |
priceRanges | ProductPriceRange[] | No | Price Ranges |
assets | CompanyAsset[] | No | Assets |
medicalConditions | MedicalCondition[] | No | Medical Conditions |
enableMixMatch | boolean | No | Enable Mix Match (default: false) |
lowThreshold | number | No | Low Threshold |
lowInventoryNotification | boolean | No | Low Inventory Notification (default: false) |
showInWidget | boolean | No | Show In Widget (default: true) |
medicinal | boolean | No | Medicinal (default: true) |
byGram | boolean | No | By Gram (default: true) |
byPrepackage | boolean | No | By Prepackage (default: false) |
tags | string[] | No | Tags |
enableExciseTax | boolean | No | Enable Excise Tax (default: false) |
active | boolean | No | Whether active |
priceIncludesExcise | boolean | No | Price Includes Excise (default: false) |
priceIncludesALExcise | boolean | No | Price Includes A L Excise (default: true) |
customWeight | number | No | Custom Weight |
automaticReOrder | boolean | No | Automatic Re Order (default: false) |
reOrderLevel | number | No | Re Order Level |
leadTime | integer | No | Lead timestamp (epoch ms) (default: 0) |
minDaysOnHand | integer | No | Min Days On Hand (default: 0) |
maxDaysOnHand | integer | No | Max Days On Hand (default: 0) |
bundleItems | BundleItem[] | No | Bundle Items |
externalId | string | No | External system identifier |
producerMfg | string | No | Producer Mfg |
producerLicense | string | No | Producer License |
producerAddress | Address | No | Producer Address |
pricingTemplateId | string | No | Pricing Template identifier |
secondaryVendors | string[] | No | Secondary Vendors |
wmProductId | string | No | Wm Product identifier |
wmThreshold | number | No | Wm Threshold (default: ZERO) |
toleranceId | string | No | Tolerance identifier |
sellable | boolean | No | Sellable (default: true) |
overrideMetrcCategoryId | string | No | Override Metrc Category identifier |
usableMarijuana | number | No | Usable Marijuana (default: ZERO) |
masterId | string | No | Master identifier |
platformProductId | string | No | Platform Product identifier |
globalProductId | string | No | Global Product identifier |
menuApiBrandId | integer | No | Menu Api Brand identifier |
menuApiProductId | integer | No | Menu Api Product identifier |
menuApiVariantProductId | integer | No | Menu Api Variant Product identifier |
syncToThirdParty | boolean | No | Sync To Third Party (default: false) |
menuApiBrandName | string | No | Menu Api Brand Name |
menuApiProductName | string | No | Menu Api Product Name |
thc | double | No | Thc |
cbd | double | No | Cbd |
cbn | double | No | Cbn |
thca | double | No | Thca |
cbda | double | No | Cbda |
cbg | double | No | Cbg |
sourceMap | object | No | Source Map (default: null) |
enableWeedmap | boolean | No | Enable Weedmap (default: false) |
isPotency | boolean | No | Is Potency |
mfgProduct | boolean | No | Mfg Product (default: false) |
item | boolean | No | Item (default: false) |
component | boolean | No | Component (default: false) |
potencyAmount | PotencyMG | No | Potency Amount |
complianceInfo | ComplianceProductInfo | No | Compliance Info |
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 |
complianceId | string | No | Compliance identifier |
discountable | boolean | No | Discountable (default: true) |
discountEnabled | boolean | No | Discount Enabled (default: true) |
{
"importId": "abc123",
"categoryId": "abc123",
"categoryName": "string",
"sku": "string",
"metadataModifiedAt": 0,
"vendorId": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"vendorImportId": "abc123",
"brandId": "abc123",
"name": "string",
"description": "",
"flowerType": "string",
"unitPrice": 0,
"purchasePrice": 0,
"totalCannabinoids": 0,
"totalTerpenes": 0,
"terpenoids": {},
"genetics": "string",
"priceRanges": [
{
"id": "abc123",
"weightToleranceId": "abc123",
"price": 0,
"priority": 0,
"weightTolerance": {},
"salePrice": 0
}
],
"assets": [
{
"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"
}
],
"medicalConditions": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"enableMixMatch": false,
"lowThreshold": 0,
"lowInventoryNotification": false,
"showInWidget": true,
"medicinal": true,
"byGram": true,
"byPrepackage": false,
"tags": [],
"enableExciseTax": false,
"active": false,
"priceIncludesExcise": false,
"priceIncludesALExcise": true,
"customWeight": 0,
"automaticReOrder": false,
"reOrderLevel": 0,
"leadTime": 0,
"minDaysOnHand": 0,
"maxDaysOnHand": 0,
"bundleItems": [
{
"productId": "abc123",
"quantity": 0
}
],
"externalId": "abc123",
"producerMfg": "string",
"producerLicense": "string",
"producerAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"pricingTemplateId": "abc123",
"secondaryVendors": [],
"wmProductId": "abc123",
"wmThreshold": "ZERO",
"toleranceId": "abc123",
"sellable": true,
"overrideMetrcCategoryId": "abc123",
"usableMarijuana": "ZERO",
"masterId": "abc123",
"platformProductId": "abc123",
"globalProductId": "abc123",
"menuApiBrandId": 0,
"menuApiProductId": 0,
"menuApiVariantProductId": 0,
"syncToThirdParty": false,
"menuApiBrandName": "string",
"menuApiProductName": "string",
"thc": 0,
"cbd": 0,
"cbn": 0,
"thca": 0,
"cbda": 0,
"cbg": 0,
"sourceMap": "null",
"enableWeedmap": false,
"isPotency": false,
"mfgProduct": false,
"item": false,
"component": false,
"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"
},
"complianceInfo": {
"statementIntendedUse": [],
"refrigeration": "string",
"form": "",
"ingredients": "",
"allergens": "",
"strain": "string",
"servingsPerContainer": 0
},
"maxThc": 0,
"maxCbn": 0,
"maxCbd": 0,
"maxCbda": 0,
"maxThca": 0,
"complianceId": "abc123",
"discountable": true,
"discountEnabled": true
}
Response
Returns a Product object.
- Fields
- JSON
| 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 |
checkSum | long | No | Check Sum |
importId | string | No | Import identifier |
importSrc | string | No | Import Src |
categoryId | string | No | Category identifier |
sku | string | No | Sku |
vendorId | string | No | Vendor identifier |
productSaleType | productsaletype | No | Product Sale Type (default: Both) |
name | string | Yes | Name |
description | string | No | Description (default: ``) |
flowerType | string | No | Flower Type |
unitPrice | number | No | Unit Price |
purchasePrice | number | No | Purchase Price |
weightPerUnit | weightperunit | No | Weight Per Unit (default: EACH) |
unitValue | number | No | Unit Value |
thc | double | No | Thc |
cbn | double | No | Cbn |
cbd | double | No | Cbd |
cbda | double | No | Cbda |
thca | double | No | Thca |
cbg | double | No | Cbg |
totalCannabinoids | double | No | Total Cannabinoids |
totalTerpenes | double | No | Total Terpenes |
terpenoids | object | No | Terpenoids |
active | boolean | No | Whether active (default: true) |
genetics | string | No | Genetics |
medicalConditions | MedicalCondition[] | No | Medical Conditions |
priceRanges | ProductPriceRange[] | No | Price Ranges |
priceBreaks | ProductPriceBreak[] | No | Price Breaks |
assets | CompanyAsset[] | No | Assets |
quantities | ProductQuantity[] | No | Quantities |
instock | boolean | No | Instock (default: false) |
brandId | string | No | Brand identifier |
category | ProductCategory | No | Category |
notes | Note[] | No | Notes |
enableMixMatch | boolean | No | Enable Mix Match (default: false) |
enableWeedmap | boolean | No | Enable Weedmap (default: false) |
showInWidget | boolean | No | Show In Widget (default: true) |
customTaxInfo | TaxInfo | No | Custom Tax Info |
discountable | boolean | No | Discountable (default: true) |
discountEnabled | boolean | No | Discount Enabled (default: true) |
brand | Brand | No | Brand |
lowThreshold | number | No | Low Threshold |
lowInventoryNotification | boolean | No | Low Inventory Notification (default: false) |
medicinal | boolean | No | Medicinal (default: true) |
byGram | boolean | No | By Gram (default: true) |
byPrepackage | boolean | No | By Prepackage (default: false) |
enableExciseTax | boolean | No | Enable Excise Tax (default: false) |
priceIncludesExcise | boolean | No | Price Includes Excise (default: false) |
priceIncludesALExcise | boolean | No | Price Includes A L Excise (default: false) |
cannabisType | cannabistype | No | Cannabis Type (default: DEFAULT) |
potencyAmount | PotencyMG | No | Potency Amount |
taxTables | CompoundTaxTable[] | No | Tax Tables |
tags | string[] | No | Tags |
qbItemRef | string | No | Qb Item Ref |
customWeight | number | No | Custom Weight |
automaticReOrder | boolean | No | Automatic Re Order (default: false) |
reOrderLevel | number | No | Re Order Level |
leadTime | integer | No | Lead timestamp (epoch ms) (default: 0) |
minDaysOnHand | integer | No | Min Days On Hand (default: 0) |
maxDaysOnHand | integer | No | Max Days On Hand (default: 0) |
customGramType | customgramtype | No | Custom Gram Type (default: GRAM) |
pricingTemplateId | string | No | Pricing Template identifier |
companyPricingTemplateId | string | No | Company Pricing Template identifier |
productType | producttype | No | Product Type (default: REGULAR) |
bundleItems | BundleItem[] | No | Bundle Items |
complianceId | string | No | Compliance identifier |
toleranceId | string | No | Tolerance identifier |
producerMfg | string | No | Producer Mfg |
producerLicense | string | No | Producer License |
producerAddress | Address | No | Producer Address |
sellable | boolean | No | Sellable (default: true) |
wmThreshold | number | No | Wm Threshold (default: ZERO) |
salesPrice | number | No | Sales Price |
lastWMSyncTime | long | No | Last W M Sync timestamp (epoch ms) |
lastLeaflySyncTime | long | No | Last Leafly Sync timestamp (epoch ms) |
lastLeaflySyncStatus | boolean | No | Last Leafly Sync Status (default: false) |
overrideMetrcCategoryId | string | No | Override Metrc Category identifier |
wmOnlineSellable | boolean | No | Wm Online Sellable (default: true) |
totalCommittedQuantity | number | No | Total Committed Quantity (default: ZERO) |
totalSellableQuantity | number | No | Total Sellable Quantity (default: ZERO) |
usableMarijuana | number | No | Usable Marijuana (default: ZERO) |
dispatchPrepackageItemId | string | No | Dispatch Prepackage Item identifier |
secondaryVendors | string[] | No | Secondary Vendors |
wmProductId | string | No | Wm Product identifier |
wmBrandId | string | No | Wm Brand identifier |
wmTags | string[] | No | Wm Tags |
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 |
complianceInfo | ComplianceProductInfo | No | Compliance Info |
totalConsumerOrderQuantity | number | No | Total Consumer Order Quantity (default: ZERO) |
metadata | Metadata[] | No | Metadata |
brandName | string | No | Brand Name |
purchaseLimits | purchaselimit[] | No | Purchase Limits |
productInfoSourcingStrategy | productinfosourcingstrategy | No | Product Info Sourcing Strategy (default: NONE) |
activeBatchId | string | No | Active Batch identifier |
activeBatchSku | string | No | Active Batch Sku |
externalId | string | No | External system identifier |
masterId | string | No | Master identifier |
companyProductId | string | No | Company Product identifier |
parentId | string | No | Parent identifier |
globalProductId | string | No | Global Product identifier |
platformProductId | string | No | Platform Product identifier |
shop | Shop | No | Shop |
sourceMap | object | No | Source Map |
shopsList | Shop[] | No | Shops List |
menuApiBrandName | string | No | Menu Api Brand Name |
menuApiProductName | string | No | Menu Api Product Name |
menuApiProductId | integer | No | Menu Api Product identifier |
menuApiVariantProductId | integer | No | Menu Api Variant Product identifier |
menuApiBrandId | integer | No | Menu Api Brand identifier |
metadataModifiedAt | long | No | Metadata Modified At |
component | boolean | No | Component (default: false) |
item | boolean | No | Item (default: false) |
productFamilyId | string | No | Product Family identifier |
archived | boolean | No | Archived (default: false) |
isGiftCard | boolean | No | Is Gift Card |
provider | string | No | Provider |
loyaltyAccrual | boolean | No | Loyalty Accrual (default: true) |
metadataMap | object | No | Metadata Map |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"checkSum": 0,
"importId": "abc123",
"importSrc": "string",
"categoryId": "abc123",
"sku": "string",
"vendorId": "abc123",
"productSaleType": "Both",
"name": "string",
"description": "",
"flowerType": "string",
"unitPrice": 0,
"purchasePrice": 0,
"weightPerUnit": "EACH",
"unitValue": 0,
"thc": 0,
"cbn": 0,
"cbd": 0,
"cbda": 0,
"thca": 0,
"cbg": 0,
"totalCannabinoids": 0,
"totalTerpenes": 0,
"terpenoids": {},
"active": true,
"genetics": "string",
"medicalConditions": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"priceRanges": [
{
"id": "abc123",
"weightToleranceId": "abc123",
"price": 0,
"priority": 0,
"weightTolerance": {},
"salePrice": 0
}
],
"priceBreaks": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"priceBreakType": "None",
"name": "string",
"displayName": "string",
"price": 0,
"quantity": 1,
"active": true,
"priority": 0,
"salePrice": 0
}
],
"assets": [
{
"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"
}
],
"quantities": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"inventoryId": "abc123",
"quantity": 0
}
],
"instock": false,
"brandId": "abc123",
"category": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"cannabis": false,
"blazeCategoryId": "abc123",
"active": true,
"unitType": "units",
"lowThreshold": "ZERO",
"complianceId": "abc123",
"archived": false,
"topLevelCategoryId": "abc123",
"normalizedCategoryId": "abc123",
"shopIds": [],
"parentCategoryId": "abc123",
"companyCategoryId": "abc123",
"wmCategory": "string",
"externalId": "abc123",
"priority": 0,
"masterId": "abc123",
"platformCategoryId": "abc123",
"platformParentCategoryId": "abc123",
"sourceMap": {},
"photo": {},
"labelTemplateId": "abc123",
"categoryApp": "DISTRO",
"unitTrackingEnabled": false,
"isGiftCard": false
},
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"enableMixMatch": false,
"enableWeedmap": false,
"showInWidget": true,
"customTaxInfo": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"cityTax": 0,
"stateTax": 0,
"federalTax": 0,
"activeCDTFATax": false
},
"discountable": true,
"discountEnabled": true,
"brand": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"email": "user@example.com",
"description": "string",
"brandLogo": {},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
},
"lowThreshold": 0,
"lowInventoryNotification": false,
"medicinal": true,
"byGram": true,
"byPrepackage": false,
"enableExciseTax": false,
"priceIncludesExcise": false,
"priceIncludesALExcise": false,
"cannabisType": "DEFAULT",
"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"
},
"taxTables": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"taxType": "Inherit",
"taxOrder": "PostTaxed",
"consumerType": "AdultUse",
"cityTax": {},
"countyTax": {},
"stateTax": {},
"federalTax": {},
"enableSurchargeFeeTax": false
}
],
"tags": [],
"qbItemRef": "string",
"customWeight": 0,
"automaticReOrder": false,
"reOrderLevel": 0,
"leadTime": 0,
"minDaysOnHand": 0,
"maxDaysOnHand": 0,
"customGramType": "GRAM",
"pricingTemplateId": "abc123",
"companyPricingTemplateId": "abc123",
"productType": "REGULAR",
"bundleItems": [
{
"productId": "abc123",
"quantity": 0
}
],
"complianceId": "abc123",
"toleranceId": "abc123",
"producerMfg": "string",
"producerLicense": "string",
"producerAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"sellable": true,
"wmThreshold": "ZERO",
"salesPrice": 0,
"lastWMSyncTime": 1704067200000,
"lastLeaflySyncTime": 1704067200000,
"lastLeaflySyncStatus": false,
"overrideMetrcCategoryId": "abc123",
"wmOnlineSellable": true,
"totalCommittedQuantity": "ZERO",
"totalSellableQuantity": "ZERO",
"usableMarijuana": "ZERO",
"dispatchPrepackageItemId": "abc123",
"secondaryVendors": [],
"wmProductId": "abc123",
"wmBrandId": "abc123",
"wmTags": [],
"maxThc": 0,
"maxCbn": 0,
"maxCbd": 0,
"maxCbda": 0,
"maxThca": 0,
"complianceInfo": {
"statementIntendedUse": [],
"refrigeration": "string",
"form": "",
"ingredients": "",
"allergens": "",
"strain": "string",
"servingsPerContainer": 0
},
"totalConsumerOrderQuantity": "ZERO",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"brandName": "string",
"purchaseLimits": [],
"productInfoSourcingStrategy": "NONE",
"activeBatchId": "abc123",
"activeBatchSku": "string",
"externalId": "abc123",
"masterId": "abc123",
"companyProductId": "abc123",
"parentId": "abc123",
"globalProductId": "abc123",
"platformProductId": "abc123",
"shop": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
},
"sourceMap": {},
"shopsList": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
}
],
"menuApiBrandName": "string",
"menuApiProductName": "string",
"menuApiProductId": 0,
"menuApiVariantProductId": 0,
"menuApiBrandId": 0,
"metadataModifiedAt": 0,
"component": false,
"item": false,
"productFamilyId": "abc123",
"archived": false,
"isGiftCard": false,
"provider": "string",
"loyaltyAccrual": true,
"metadataMap": {}
}
Update Product
PUT /api/v1/partner/products/{productId}
Update an existing product by ID. Send a PartnerProductUpdateRequest in the request body with the fields to update.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
productId | string | The product i d |
Request Body
- Fields
- JSON
| 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 |
checkSum | long | No | Check Sum |
importId | string | No | Import identifier |
importSrc | string | No | Import Src |
categoryId | string | No | Category identifier |
sku | string | No | Sku |
vendorId | string | No | Vendor identifier |
productSaleType | productsaletype | No | Product Sale Type (default: Both) |
name | string | Yes | Name |
description | string | No | Description (default: ``) |
flowerType | string | No | Flower Type |
unitPrice | number | No | Unit Price |
purchasePrice | number | No | Purchase Price |
weightPerUnit | weightperunit | No | Weight Per Unit (default: EACH) |
unitValue | number | No | Unit Value |
thc | double | No | Thc |
cbn | double | No | Cbn |
cbd | double | No | Cbd |
cbda | double | No | Cbda |
thca | double | No | Thca |
cbg | double | No | Cbg |
totalCannabinoids | double | No | Total Cannabinoids |
totalTerpenes | double | No | Total Terpenes |
terpenoids | object | No | Terpenoids |
active | boolean | No | Whether active (default: true) |
genetics | string | No | Genetics |
medicalConditions | MedicalCondition[] | No | Medical Conditions |
priceRanges | ProductPriceRange[] | No | Price Ranges |
priceBreaks | ProductPriceBreak[] | No | Price Breaks |
assets | CompanyAsset[] | No | Assets |
quantities | ProductQuantity[] | No | Quantities |
instock | boolean | No | Instock (default: false) |
brandId | string | No | Brand identifier |
category | ProductCategory | No | Category |
notes | Note[] | No | Notes |
enableMixMatch | boolean | No | Enable Mix Match (default: false) |
enableWeedmap | boolean | No | Enable Weedmap (default: false) |
showInWidget | boolean | No | Show In Widget (default: true) |
customTaxInfo | TaxInfo | No | Custom Tax Info |
discountable | boolean | No | Discountable (default: true) |
discountEnabled | boolean | No | Discount Enabled (default: true) |
brand | Brand | No | Brand |
lowThreshold | number | No | Low Threshold |
lowInventoryNotification | boolean | No | Low Inventory Notification (default: false) |
medicinal | boolean | No | Medicinal (default: true) |
byGram | boolean | No | By Gram (default: true) |
byPrepackage | boolean | No | By Prepackage (default: false) |
enableExciseTax | boolean | No | Enable Excise Tax (default: false) |
priceIncludesExcise | boolean | No | Price Includes Excise (default: false) |
priceIncludesALExcise | boolean | No | Price Includes A L Excise (default: false) |
cannabisType | cannabistype | No | Cannabis Type (default: DEFAULT) |
potencyAmount | PotencyMG | No | Potency Amount |
taxTables | CompoundTaxTable[] | No | Tax Tables |
tags | string[] | No | Tags |
qbItemRef | string | No | Qb Item Ref |
customWeight | number | No | Custom Weight |
automaticReOrder | boolean | No | Automatic Re Order (default: false) |
reOrderLevel | number | No | Re Order Level |
leadTime | integer | No | Lead timestamp (epoch ms) (default: 0) |
minDaysOnHand | integer | No | Min Days On Hand (default: 0) |
maxDaysOnHand | integer | No | Max Days On Hand (default: 0) |
customGramType | customgramtype | No | Custom Gram Type (default: GRAM) |
pricingTemplateId | string | No | Pricing Template identifier |
companyPricingTemplateId | string | No | Company Pricing Template identifier |
productType | producttype | No | Product Type (default: REGULAR) |
bundleItems | BundleItem[] | No | Bundle Items |
complianceId | string | No | Compliance identifier |
toleranceId | string | No | Tolerance identifier |
producerMfg | string | No | Producer Mfg |
producerLicense | string | No | Producer License |
producerAddress | Address | No | Producer Address |
sellable | boolean | No | Sellable (default: true) |
wmThreshold | number | No | Wm Threshold (default: ZERO) |
salesPrice | number | No | Sales Price |
lastWMSyncTime | long | No | Last W M Sync timestamp (epoch ms) |
lastLeaflySyncTime | long | No | Last Leafly Sync timestamp (epoch ms) |
lastLeaflySyncStatus | boolean | No | Last Leafly Sync Status (default: false) |
overrideMetrcCategoryId | string | No | Override Metrc Category identifier |
wmOnlineSellable | boolean | No | Wm Online Sellable (default: true) |
totalCommittedQuantity | number | No | Total Committed Quantity (default: ZERO) |
totalSellableQuantity | number | No | Total Sellable Quantity (default: ZERO) |
usableMarijuana | number | No | Usable Marijuana (default: ZERO) |
dispatchPrepackageItemId | string | No | Dispatch Prepackage Item identifier |
secondaryVendors | string[] | No | Secondary Vendors |
wmProductId | string | No | Wm Product identifier |
wmBrandId | string | No | Wm Brand identifier |
wmTags | string[] | No | Wm Tags |
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 |
complianceInfo | ComplianceProductInfo | No | Compliance Info |
totalConsumerOrderQuantity | number | No | Total Consumer Order Quantity (default: ZERO) |
metadata | Metadata[] | No | Metadata |
brandName | string | No | Brand Name |
purchaseLimits | purchaselimit[] | No | Purchase Limits |
productInfoSourcingStrategy | productinfosourcingstrategy | No | Product Info Sourcing Strategy (default: NONE) |
activeBatchId | string | No | Active Batch identifier |
activeBatchSku | string | No | Active Batch Sku |
externalId | string | No | External system identifier |
masterId | string | No | Master identifier |
companyProductId | string | No | Company Product identifier |
parentId | string | No | Parent identifier |
globalProductId | string | No | Global Product identifier |
platformProductId | string | No | Platform Product identifier |
shop | Shop | No | Shop |
sourceMap | object | No | Source Map |
shopsList | Shop[] | No | Shops List |
menuApiBrandName | string | No | Menu Api Brand Name |
menuApiProductName | string | No | Menu Api Product Name |
menuApiProductId | integer | No | Menu Api Product identifier |
menuApiVariantProductId | integer | No | Menu Api Variant Product identifier |
menuApiBrandId | integer | No | Menu Api Brand identifier |
metadataModifiedAt | long | No | Metadata Modified At |
component | boolean | No | Component (default: false) |
item | boolean | No | Item (default: false) |
productFamilyId | string | No | Product Family identifier |
archived | boolean | No | Archived (default: false) |
isGiftCard | boolean | No | Is Gift Card |
provider | string | No | Provider |
loyaltyAccrual | boolean | No | Loyalty Accrual (default: true) |
metadataMap | object | No | Metadata Map |
employeeId | string | No | Employee identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"checkSum": 0,
"importId": "abc123",
"importSrc": "string",
"categoryId": "abc123",
"sku": "string",
"vendorId": "abc123",
"productSaleType": "Both",
"name": "string",
"description": "",
"flowerType": "string",
"unitPrice": 0,
"purchasePrice": 0,
"weightPerUnit": "EACH",
"unitValue": 0,
"thc": 0,
"cbn": 0,
"cbd": 0,
"cbda": 0,
"thca": 0,
"cbg": 0,
"totalCannabinoids": 0,
"totalTerpenes": 0,
"terpenoids": {},
"active": true,
"genetics": "string",
"medicalConditions": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"priceRanges": [
{
"id": "abc123",
"weightToleranceId": "abc123",
"price": 0,
"priority": 0,
"weightTolerance": {},
"salePrice": 0
}
],
"priceBreaks": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"priceBreakType": "None",
"name": "string",
"displayName": "string",
"price": 0,
"quantity": 1,
"active": true,
"priority": 0,
"salePrice": 0
}
],
"assets": [
{
"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"
}
],
"quantities": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"inventoryId": "abc123",
"quantity": 0
}
],
"instock": false,
"brandId": "abc123",
"category": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"cannabis": false,
"blazeCategoryId": "abc123",
"active": true,
"unitType": "units",
"lowThreshold": "ZERO",
"complianceId": "abc123",
"archived": false,
"topLevelCategoryId": "abc123",
"normalizedCategoryId": "abc123",
"shopIds": [],
"parentCategoryId": "abc123",
"companyCategoryId": "abc123",
"wmCategory": "string",
"externalId": "abc123",
"priority": 0,
"masterId": "abc123",
"platformCategoryId": "abc123",
"platformParentCategoryId": "abc123",
"sourceMap": {},
"photo": {},
"labelTemplateId": "abc123",
"categoryApp": "DISTRO",
"unitTrackingEnabled": false,
"isGiftCard": false
},
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"enableMixMatch": false,
"enableWeedmap": false,
"showInWidget": true,
"customTaxInfo": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"cityTax": 0,
"stateTax": 0,
"federalTax": 0,
"activeCDTFATax": false
},
"discountable": true,
"discountEnabled": true,
"brand": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"email": "user@example.com",
"description": "string",
"brandLogo": {},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
},
"lowThreshold": 0,
"lowInventoryNotification": false,
"medicinal": true,
"byGram": true,
"byPrepackage": false,
"enableExciseTax": false,
"priceIncludesExcise": false,
"priceIncludesALExcise": false,
"cannabisType": "DEFAULT",
"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"
},
"taxTables": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"taxType": "Inherit",
"taxOrder": "PostTaxed",
"consumerType": "AdultUse",
"cityTax": {},
"countyTax": {},
"stateTax": {},
"federalTax": {},
"enableSurchargeFeeTax": false
}
],
"tags": [],
"qbItemRef": "string",
"customWeight": 0,
"automaticReOrder": false,
"reOrderLevel": 0,
"leadTime": 0,
"minDaysOnHand": 0,
"maxDaysOnHand": 0,
"customGramType": "GRAM",
"pricingTemplateId": "abc123",
"companyPricingTemplateId": "abc123",
"productType": "REGULAR",
"bundleItems": [
{
"productId": "abc123",
"quantity": 0
}
],
"complianceId": "abc123",
"toleranceId": "abc123",
"producerMfg": "string",
"producerLicense": "string",
"producerAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"sellable": true,
"wmThreshold": "ZERO",
"salesPrice": 0,
"lastWMSyncTime": 1704067200000,
"lastLeaflySyncTime": 1704067200000,
"lastLeaflySyncStatus": false,
"overrideMetrcCategoryId": "abc123",
"wmOnlineSellable": true,
"totalCommittedQuantity": "ZERO",
"totalSellableQuantity": "ZERO",
"usableMarijuana": "ZERO",
"dispatchPrepackageItemId": "abc123",
"secondaryVendors": [],
"wmProductId": "abc123",
"wmBrandId": "abc123",
"wmTags": [],
"maxThc": 0,
"maxCbn": 0,
"maxCbd": 0,
"maxCbda": 0,
"maxThca": 0,
"complianceInfo": {
"statementIntendedUse": [],
"refrigeration": "string",
"form": "",
"ingredients": "",
"allergens": "",
"strain": "string",
"servingsPerContainer": 0
},
"totalConsumerOrderQuantity": "ZERO",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"brandName": "string",
"purchaseLimits": [],
"productInfoSourcingStrategy": "NONE",
"activeBatchId": "abc123",
"activeBatchSku": "string",
"externalId": "abc123",
"masterId": "abc123",
"companyProductId": "abc123",
"parentId": "abc123",
"globalProductId": "abc123",
"platformProductId": "abc123",
"shop": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
},
"sourceMap": {},
"shopsList": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
}
],
"menuApiBrandName": "string",
"menuApiProductName": "string",
"menuApiProductId": 0,
"menuApiVariantProductId": 0,
"menuApiBrandId": 0,
"metadataModifiedAt": 0,
"component": false,
"item": false,
"productFamilyId": "abc123",
"archived": false,
"isGiftCard": false,
"provider": "string",
"loyaltyAccrual": true,
"metadataMap": {},
"employeeId": "abc123"
}
Response
Returns a Product object.
- Fields
- JSON
| 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 |
checkSum | long | No | Check Sum |
importId | string | No | Import identifier |
importSrc | string | No | Import Src |
categoryId | string | No | Category identifier |
sku | string | No | Sku |
vendorId | string | No | Vendor identifier |
productSaleType | productsaletype | No | Product Sale Type (default: Both) |
name | string | Yes | Name |
description | string | No | Description (default: ``) |
flowerType | string | No | Flower Type |
unitPrice | number | No | Unit Price |
purchasePrice | number | No | Purchase Price |
weightPerUnit | weightperunit | No | Weight Per Unit (default: EACH) |
unitValue | number | No | Unit Value |
thc | double | No | Thc |
cbn | double | No | Cbn |
cbd | double | No | Cbd |
cbda | double | No | Cbda |
thca | double | No | Thca |
cbg | double | No | Cbg |
totalCannabinoids | double | No | Total Cannabinoids |
totalTerpenes | double | No | Total Terpenes |
terpenoids | object | No | Terpenoids |
active | boolean | No | Whether active (default: true) |
genetics | string | No | Genetics |
medicalConditions | MedicalCondition[] | No | Medical Conditions |
priceRanges | ProductPriceRange[] | No | Price Ranges |
priceBreaks | ProductPriceBreak[] | No | Price Breaks |
assets | CompanyAsset[] | No | Assets |
quantities | ProductQuantity[] | No | Quantities |
instock | boolean | No | Instock (default: false) |
brandId | string | No | Brand identifier |
category | ProductCategory | No | Category |
notes | Note[] | No | Notes |
enableMixMatch | boolean | No | Enable Mix Match (default: false) |
enableWeedmap | boolean | No | Enable Weedmap (default: false) |
showInWidget | boolean | No | Show In Widget (default: true) |
customTaxInfo | TaxInfo | No | Custom Tax Info |
discountable | boolean | No | Discountable (default: true) |
discountEnabled | boolean | No | Discount Enabled (default: true) |
brand | Brand | No | Brand |
lowThreshold | number | No | Low Threshold |
lowInventoryNotification | boolean | No | Low Inventory Notification (default: false) |
medicinal | boolean | No | Medicinal (default: true) |
byGram | boolean | No | By Gram (default: true) |
byPrepackage | boolean | No | By Prepackage (default: false) |
enableExciseTax | boolean | No | Enable Excise Tax (default: false) |
priceIncludesExcise | boolean | No | Price Includes Excise (default: false) |
priceIncludesALExcise | boolean | No | Price Includes A L Excise (default: false) |
cannabisType | cannabistype | No | Cannabis Type (default: DEFAULT) |
potencyAmount | PotencyMG | No | Potency Amount |
taxTables | CompoundTaxTable[] | No | Tax Tables |
tags | string[] | No | Tags |
qbItemRef | string | No | Qb Item Ref |
customWeight | number | No | Custom Weight |
automaticReOrder | boolean | No | Automatic Re Order (default: false) |
reOrderLevel | number | No | Re Order Level |
leadTime | integer | No | Lead timestamp (epoch ms) (default: 0) |
minDaysOnHand | integer | No | Min Days On Hand (default: 0) |
maxDaysOnHand | integer | No | Max Days On Hand (default: 0) |
customGramType | customgramtype | No | Custom Gram Type (default: GRAM) |
pricingTemplateId | string | No | Pricing Template identifier |
companyPricingTemplateId | string | No | Company Pricing Template identifier |
productType | producttype | No | Product Type (default: REGULAR) |
bundleItems | BundleItem[] | No | Bundle Items |
complianceId | string | No | Compliance identifier |
toleranceId | string | No | Tolerance identifier |
producerMfg | string | No | Producer Mfg |
producerLicense | string | No | Producer License |
producerAddress | Address | No | Producer Address |
sellable | boolean | No | Sellable (default: true) |
wmThreshold | number | No | Wm Threshold (default: ZERO) |
salesPrice | number | No | Sales Price |
lastWMSyncTime | long | No | Last W M Sync timestamp (epoch ms) |
lastLeaflySyncTime | long | No | Last Leafly Sync timestamp (epoch ms) |
lastLeaflySyncStatus | boolean | No | Last Leafly Sync Status (default: false) |
overrideMetrcCategoryId | string | No | Override Metrc Category identifier |
wmOnlineSellable | boolean | No | Wm Online Sellable (default: true) |
totalCommittedQuantity | number | No | Total Committed Quantity (default: ZERO) |
totalSellableQuantity | number | No | Total Sellable Quantity (default: ZERO) |
usableMarijuana | number | No | Usable Marijuana (default: ZERO) |
dispatchPrepackageItemId | string | No | Dispatch Prepackage Item identifier |
secondaryVendors | string[] | No | Secondary Vendors |
wmProductId | string | No | Wm Product identifier |
wmBrandId | string | No | Wm Brand identifier |
wmTags | string[] | No | Wm Tags |
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 |
complianceInfo | ComplianceProductInfo | No | Compliance Info |
totalConsumerOrderQuantity | number | No | Total Consumer Order Quantity (default: ZERO) |
metadata | Metadata[] | No | Metadata |
brandName | string | No | Brand Name |
purchaseLimits | purchaselimit[] | No | Purchase Limits |
productInfoSourcingStrategy | productinfosourcingstrategy | No | Product Info Sourcing Strategy (default: NONE) |
activeBatchId | string | No | Active Batch identifier |
activeBatchSku | string | No | Active Batch Sku |
externalId | string | No | External system identifier |
masterId | string | No | Master identifier |
companyProductId | string | No | Company Product identifier |
parentId | string | No | Parent identifier |
globalProductId | string | No | Global Product identifier |
platformProductId | string | No | Platform Product identifier |
shop | Shop | No | Shop |
sourceMap | object | No | Source Map |
shopsList | Shop[] | No | Shops List |
menuApiBrandName | string | No | Menu Api Brand Name |
menuApiProductName | string | No | Menu Api Product Name |
menuApiProductId | integer | No | Menu Api Product identifier |
menuApiVariantProductId | integer | No | Menu Api Variant Product identifier |
menuApiBrandId | integer | No | Menu Api Brand identifier |
metadataModifiedAt | long | No | Metadata Modified At |
component | boolean | No | Component (default: false) |
item | boolean | No | Item (default: false) |
productFamilyId | string | No | Product Family identifier |
archived | boolean | No | Archived (default: false) |
isGiftCard | boolean | No | Is Gift Card |
provider | string | No | Provider |
loyaltyAccrual | boolean | No | Loyalty Accrual (default: true) |
metadataMap | object | No | Metadata Map |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"checkSum": 0,
"importId": "abc123",
"importSrc": "string",
"categoryId": "abc123",
"sku": "string",
"vendorId": "abc123",
"productSaleType": "Both",
"name": "string",
"description": "",
"flowerType": "string",
"unitPrice": 0,
"purchasePrice": 0,
"weightPerUnit": "EACH",
"unitValue": 0,
"thc": 0,
"cbn": 0,
"cbd": 0,
"cbda": 0,
"thca": 0,
"cbg": 0,
"totalCannabinoids": 0,
"totalTerpenes": 0,
"terpenoids": {},
"active": true,
"genetics": "string",
"medicalConditions": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"priceRanges": [
{
"id": "abc123",
"weightToleranceId": "abc123",
"price": 0,
"priority": 0,
"weightTolerance": {},
"salePrice": 0
}
],
"priceBreaks": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"priceBreakType": "None",
"name": "string",
"displayName": "string",
"price": 0,
"quantity": 1,
"active": true,
"priority": 0,
"salePrice": 0
}
],
"assets": [
{
"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"
}
],
"quantities": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"inventoryId": "abc123",
"quantity": 0
}
],
"instock": false,
"brandId": "abc123",
"category": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"cannabis": false,
"blazeCategoryId": "abc123",
"active": true,
"unitType": "units",
"lowThreshold": "ZERO",
"complianceId": "abc123",
"archived": false,
"topLevelCategoryId": "abc123",
"normalizedCategoryId": "abc123",
"shopIds": [],
"parentCategoryId": "abc123",
"companyCategoryId": "abc123",
"wmCategory": "string",
"externalId": "abc123",
"priority": 0,
"masterId": "abc123",
"platformCategoryId": "abc123",
"platformParentCategoryId": "abc123",
"sourceMap": {},
"photo": {},
"labelTemplateId": "abc123",
"categoryApp": "DISTRO",
"unitTrackingEnabled": false,
"isGiftCard": false
},
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"enableMixMatch": false,
"enableWeedmap": false,
"showInWidget": true,
"customTaxInfo": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"cityTax": 0,
"stateTax": 0,
"federalTax": 0,
"activeCDTFATax": false
},
"discountable": true,
"discountEnabled": true,
"brand": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"email": "user@example.com",
"description": "string",
"brandLogo": {},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
},
"lowThreshold": 0,
"lowInventoryNotification": false,
"medicinal": true,
"byGram": true,
"byPrepackage": false,
"enableExciseTax": false,
"priceIncludesExcise": false,
"priceIncludesALExcise": false,
"cannabisType": "DEFAULT",
"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"
},
"taxTables": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"taxType": "Inherit",
"taxOrder": "PostTaxed",
"consumerType": "AdultUse",
"cityTax": {},
"countyTax": {},
"stateTax": {},
"federalTax": {},
"enableSurchargeFeeTax": false
}
],
"tags": [],
"qbItemRef": "string",
"customWeight": 0,
"automaticReOrder": false,
"reOrderLevel": 0,
"leadTime": 0,
"minDaysOnHand": 0,
"maxDaysOnHand": 0,
"customGramType": "GRAM",
"pricingTemplateId": "abc123",
"companyPricingTemplateId": "abc123",
"productType": "REGULAR",
"bundleItems": [
{
"productId": "abc123",
"quantity": 0
}
],
"complianceId": "abc123",
"toleranceId": "abc123",
"producerMfg": "string",
"producerLicense": "string",
"producerAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"sellable": true,
"wmThreshold": "ZERO",
"salesPrice": 0,
"lastWMSyncTime": 1704067200000,
"lastLeaflySyncTime": 1704067200000,
"lastLeaflySyncStatus": false,
"overrideMetrcCategoryId": "abc123",
"wmOnlineSellable": true,
"totalCommittedQuantity": "ZERO",
"totalSellableQuantity": "ZERO",
"usableMarijuana": "ZERO",
"dispatchPrepackageItemId": "abc123",
"secondaryVendors": [],
"wmProductId": "abc123",
"wmBrandId": "abc123",
"wmTags": [],
"maxThc": 0,
"maxCbn": 0,
"maxCbd": 0,
"maxCbda": 0,
"maxThca": 0,
"complianceInfo": {
"statementIntendedUse": [],
"refrigeration": "string",
"form": "",
"ingredients": "",
"allergens": "",
"strain": "string",
"servingsPerContainer": 0
},
"totalConsumerOrderQuantity": "ZERO",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"brandName": "string",
"purchaseLimits": [],
"productInfoSourcingStrategy": "NONE",
"activeBatchId": "abc123",
"activeBatchSku": "string",
"externalId": "abc123",
"masterId": "abc123",
"companyProductId": "abc123",
"parentId": "abc123",
"globalProductId": "abc123",
"platformProductId": "abc123",
"shop": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
},
"sourceMap": {},
"shopsList": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
}
],
"menuApiBrandName": "string",
"menuApiProductName": "string",
"menuApiProductId": 0,
"menuApiVariantProductId": 0,
"menuApiBrandId": 0,
"metadataModifiedAt": 0,
"component": false,
"item": false,
"productFamilyId": "abc123",
"archived": false,
"isGiftCard": false,
"provider": "string",
"loyaltyAccrual": true,
"metadataMap": {}
}
Get list of products
GET /api/v1/partner/products
Retrieve a paginated list of products. Supports date-range filtering with startDate/endDate (strings), and boolean filters: syncToThirdPartyMenus, active, and instock. Use skip and limit for pagination.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | string | No | Start date filter |
endDate | string | No | End date filter |
skip | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
syncToThirdPartyMenus | boolean | No | sync to third party menus |
active | boolean | No | active |
instock | boolean | No | instock |
Response
Returns a paginated SearchResult of Product objects.
- Fields
- JSON
| 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 |
checkSum | long | No | Check Sum |
importId | string | No | Import identifier |
importSrc | string | No | Import Src |
categoryId | string | No | Category identifier |
sku | string | No | Sku |
vendorId | string | No | Vendor identifier |
productSaleType | productsaletype | No | Product Sale Type (default: Both) |
name | string | Yes | Name |
description | string | No | Description (default: ``) |
flowerType | string | No | Flower Type |
unitPrice | number | No | Unit Price |
purchasePrice | number | No | Purchase Price |
weightPerUnit | weightperunit | No | Weight Per Unit (default: EACH) |
unitValue | number | No | Unit Value |
thc | double | No | Thc |
cbn | double | No | Cbn |
cbd | double | No | Cbd |
cbda | double | No | Cbda |
thca | double | No | Thca |
cbg | double | No | Cbg |
totalCannabinoids | double | No | Total Cannabinoids |
totalTerpenes | double | No | Total Terpenes |
terpenoids | object | No | Terpenoids |
active | boolean | No | Whether active (default: true) |
genetics | string | No | Genetics |
medicalConditions | MedicalCondition[] | No | Medical Conditions |
priceRanges | ProductPriceRange[] | No | Price Ranges |
priceBreaks | ProductPriceBreak[] | No | Price Breaks |
assets | CompanyAsset[] | No | Assets |
quantities | ProductQuantity[] | No | Quantities |
instock | boolean | No | Instock (default: false) |
brandId | string | No | Brand identifier |
category | ProductCategory | No | Category |
notes | Note[] | No | Notes |
enableMixMatch | boolean | No | Enable Mix Match (default: false) |
enableWeedmap | boolean | No | Enable Weedmap (default: false) |
showInWidget | boolean | No | Show In Widget (default: true) |
customTaxInfo | TaxInfo | No | Custom Tax Info |
discountable | boolean | No | Discountable (default: true) |
discountEnabled | boolean | No | Discount Enabled (default: true) |
brand | Brand | No | Brand |
lowThreshold | number | No | Low Threshold |
lowInventoryNotification | boolean | No | Low Inventory Notification (default: false) |
medicinal | boolean | No | Medicinal (default: true) |
byGram | boolean | No | By Gram (default: true) |
byPrepackage | boolean | No | By Prepackage (default: false) |
enableExciseTax | boolean | No | Enable Excise Tax (default: false) |
priceIncludesExcise | boolean | No | Price Includes Excise (default: false) |
priceIncludesALExcise | boolean | No | Price Includes A L Excise (default: false) |
cannabisType | cannabistype | No | Cannabis Type (default: DEFAULT) |
potencyAmount | PotencyMG | No | Potency Amount |
taxTables | CompoundTaxTable[] | No | Tax Tables |
tags | string[] | No | Tags |
qbItemRef | string | No | Qb Item Ref |
customWeight | number | No | Custom Weight |
automaticReOrder | boolean | No | Automatic Re Order (default: false) |
reOrderLevel | number | No | Re Order Level |
leadTime | integer | No | Lead timestamp (epoch ms) (default: 0) |
minDaysOnHand | integer | No | Min Days On Hand (default: 0) |
maxDaysOnHand | integer | No | Max Days On Hand (default: 0) |
customGramType | customgramtype | No | Custom Gram Type (default: GRAM) |
pricingTemplateId | string | No | Pricing Template identifier |
companyPricingTemplateId | string | No | Company Pricing Template identifier |
productType | producttype | No | Product Type (default: REGULAR) |
bundleItems | BundleItem[] | No | Bundle Items |
complianceId | string | No | Compliance identifier |
toleranceId | string | No | Tolerance identifier |
producerMfg | string | No | Producer Mfg |
producerLicense | string | No | Producer License |
producerAddress | Address | No | Producer Address |
sellable | boolean | No | Sellable (default: true) |
wmThreshold | number | No | Wm Threshold (default: ZERO) |
salesPrice | number | No | Sales Price |
lastWMSyncTime | long | No | Last W M Sync timestamp (epoch ms) |
lastLeaflySyncTime | long | No | Last Leafly Sync timestamp (epoch ms) |
lastLeaflySyncStatus | boolean | No | Last Leafly Sync Status (default: false) |
overrideMetrcCategoryId | string | No | Override Metrc Category identifier |
wmOnlineSellable | boolean | No | Wm Online Sellable (default: true) |
totalCommittedQuantity | number | No | Total Committed Quantity (default: ZERO) |
totalSellableQuantity | number | No | Total Sellable Quantity (default: ZERO) |
usableMarijuana | number | No | Usable Marijuana (default: ZERO) |
dispatchPrepackageItemId | string | No | Dispatch Prepackage Item identifier |
secondaryVendors | string[] | No | Secondary Vendors |
wmProductId | string | No | Wm Product identifier |
wmBrandId | string | No | Wm Brand identifier |
wmTags | string[] | No | Wm Tags |
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 |
complianceInfo | ComplianceProductInfo | No | Compliance Info |
totalConsumerOrderQuantity | number | No | Total Consumer Order Quantity (default: ZERO) |
metadata | Metadata[] | No | Metadata |
brandName | string | No | Brand Name |
purchaseLimits | purchaselimit[] | No | Purchase Limits |
productInfoSourcingStrategy | productinfosourcingstrategy | No | Product Info Sourcing Strategy (default: NONE) |
activeBatchId | string | No | Active Batch identifier |
activeBatchSku | string | No | Active Batch Sku |
externalId | string | No | External system identifier |
masterId | string | No | Master identifier |
companyProductId | string | No | Company Product identifier |
parentId | string | No | Parent identifier |
globalProductId | string | No | Global Product identifier |
platformProductId | string | No | Platform Product identifier |
shop | Shop | No | Shop |
sourceMap | object | No | Source Map |
shopsList | Shop[] | No | Shops List |
menuApiBrandName | string | No | Menu Api Brand Name |
menuApiProductName | string | No | Menu Api Product Name |
menuApiProductId | integer | No | Menu Api Product identifier |
menuApiVariantProductId | integer | No | Menu Api Variant Product identifier |
menuApiBrandId | integer | No | Menu Api Brand identifier |
metadataModifiedAt | long | No | Metadata Modified At |
component | boolean | No | Component (default: false) |
item | boolean | No | Item (default: false) |
productFamilyId | string | No | Product Family identifier |
archived | boolean | No | Archived (default: false) |
isGiftCard | boolean | No | Is Gift Card |
provider | string | No | Provider |
loyaltyAccrual | boolean | No | Loyalty Accrual (default: true) |
metadataMap | object | No | Metadata Map |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"checkSum": 0,
"importId": "abc123",
"importSrc": "string",
"categoryId": "abc123",
"sku": "string",
"vendorId": "abc123",
"productSaleType": "Both",
"name": "string",
"description": "",
"flowerType": "string",
"unitPrice": 0,
"purchasePrice": 0,
"weightPerUnit": "EACH",
"unitValue": 0,
"thc": 0,
"cbn": 0,
"cbd": 0,
"cbda": 0,
"thca": 0,
"cbg": 0,
"totalCannabinoids": 0,
"totalTerpenes": 0,
"terpenoids": {},
"active": true,
"genetics": "string",
"medicalConditions": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"priceRanges": [
{
"id": "abc123",
"weightToleranceId": "abc123",
"price": 0,
"priority": 0,
"weightTolerance": {},
"salePrice": 0
}
],
"priceBreaks": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"priceBreakType": "None",
"name": "string",
"displayName": "string",
"price": 0,
"quantity": 1,
"active": true,
"priority": 0,
"salePrice": 0
}
],
"assets": [
{
"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"
}
],
"quantities": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"inventoryId": "abc123",
"quantity": 0
}
],
"instock": false,
"brandId": "abc123",
"category": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"cannabis": false,
"blazeCategoryId": "abc123",
"active": true,
"unitType": "units",
"lowThreshold": "ZERO",
"complianceId": "abc123",
"archived": false,
"topLevelCategoryId": "abc123",
"normalizedCategoryId": "abc123",
"shopIds": [],
"parentCategoryId": "abc123",
"companyCategoryId": "abc123",
"wmCategory": "string",
"externalId": "abc123",
"priority": 0,
"masterId": "abc123",
"platformCategoryId": "abc123",
"platformParentCategoryId": "abc123",
"sourceMap": {},
"photo": {},
"labelTemplateId": "abc123",
"categoryApp": "DISTRO",
"unitTrackingEnabled": false,
"isGiftCard": false
},
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"enableMixMatch": false,
"enableWeedmap": false,
"showInWidget": true,
"customTaxInfo": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"cityTax": 0,
"stateTax": 0,
"federalTax": 0,
"activeCDTFATax": false
},
"discountable": true,
"discountEnabled": true,
"brand": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"email": "user@example.com",
"description": "string",
"brandLogo": {},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
},
"lowThreshold": 0,
"lowInventoryNotification": false,
"medicinal": true,
"byGram": true,
"byPrepackage": false,
"enableExciseTax": false,
"priceIncludesExcise": false,
"priceIncludesALExcise": false,
"cannabisType": "DEFAULT",
"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"
},
"taxTables": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"taxType": "Inherit",
"taxOrder": "PostTaxed",
"consumerType": "AdultUse",
"cityTax": {},
"countyTax": {},
"stateTax": {},
"federalTax": {},
"enableSurchargeFeeTax": false
}
],
"tags": [],
"qbItemRef": "string",
"customWeight": 0,
"automaticReOrder": false,
"reOrderLevel": 0,
"leadTime": 0,
"minDaysOnHand": 0,
"maxDaysOnHand": 0,
"customGramType": "GRAM",
"pricingTemplateId": "abc123",
"companyPricingTemplateId": "abc123",
"productType": "REGULAR",
"bundleItems": [
{
"productId": "abc123",
"quantity": 0
}
],
"complianceId": "abc123",
"toleranceId": "abc123",
"producerMfg": "string",
"producerLicense": "string",
"producerAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"sellable": true,
"wmThreshold": "ZERO",
"salesPrice": 0,
"lastWMSyncTime": 1704067200000,
"lastLeaflySyncTime": 1704067200000,
"lastLeaflySyncStatus": false,
"overrideMetrcCategoryId": "abc123",
"wmOnlineSellable": true,
"totalCommittedQuantity": "ZERO",
"totalSellableQuantity": "ZERO",
"usableMarijuana": "ZERO",
"dispatchPrepackageItemId": "abc123",
"secondaryVendors": [],
"wmProductId": "abc123",
"wmBrandId": "abc123",
"wmTags": [],
"maxThc": 0,
"maxCbn": 0,
"maxCbd": 0,
"maxCbda": 0,
"maxThca": 0,
"complianceInfo": {
"statementIntendedUse": [],
"refrigeration": "string",
"form": "",
"ingredients": "",
"allergens": "",
"strain": "string",
"servingsPerContainer": 0
},
"totalConsumerOrderQuantity": "ZERO",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"brandName": "string",
"purchaseLimits": [],
"productInfoSourcingStrategy": "NONE",
"activeBatchId": "abc123",
"activeBatchSku": "string",
"externalId": "abc123",
"masterId": "abc123",
"companyProductId": "abc123",
"parentId": "abc123",
"globalProductId": "abc123",
"platformProductId": "abc123",
"shop": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
},
"sourceMap": {},
"shopsList": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
}
],
"menuApiBrandName": "string",
"menuApiProductName": "string",
"menuApiProductId": 0,
"menuApiVariantProductId": 0,
"menuApiBrandId": 0,
"metadataModifiedAt": 0,
"component": false,
"item": false,
"productFamilyId": "abc123",
"archived": false,
"isGiftCard": false,
"provider": "string",
"loyaltyAccrual": true,
"metadataMap": {}
}
Get list of products by modified date
GET /api/v1/partner/products/modified
Retrieve products modified within a date range, specified as epoch milliseconds (startDate/endDate). This is useful for incremental sync operations to detect changes since a known timestamp. Use skip and limit for pagination.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | long | No | Start date filter |
endDate | long | No | End date filter |
skip | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
Response
Returns a paginated SearchResult of Product objects.
- Fields
- JSON
| 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 |
checkSum | long | No | Check Sum |
importId | string | No | Import identifier |
importSrc | string | No | Import Src |
categoryId | string | No | Category identifier |
sku | string | No | Sku |
vendorId | string | No | Vendor identifier |
productSaleType | productsaletype | No | Product Sale Type (default: Both) |
name | string | Yes | Name |
description | string | No | Description (default: ``) |
flowerType | string | No | Flower Type |
unitPrice | number | No | Unit Price |
purchasePrice | number | No | Purchase Price |
weightPerUnit | weightperunit | No | Weight Per Unit (default: EACH) |
unitValue | number | No | Unit Value |
thc | double | No | Thc |
cbn | double | No | Cbn |
cbd | double | No | Cbd |
cbda | double | No | Cbda |
thca | double | No | Thca |
cbg | double | No | Cbg |
totalCannabinoids | double | No | Total Cannabinoids |
totalTerpenes | double | No | Total Terpenes |
terpenoids | object | No | Terpenoids |
active | boolean | No | Whether active (default: true) |
genetics | string | No | Genetics |
medicalConditions | MedicalCondition[] | No | Medical Conditions |
priceRanges | ProductPriceRange[] | No | Price Ranges |
priceBreaks | ProductPriceBreak[] | No | Price Breaks |
assets | CompanyAsset[] | No | Assets |
quantities | ProductQuantity[] | No | Quantities |
instock | boolean | No | Instock (default: false) |
brandId | string | No | Brand identifier |
category | ProductCategory | No | Category |
notes | Note[] | No | Notes |
enableMixMatch | boolean | No | Enable Mix Match (default: false) |
enableWeedmap | boolean | No | Enable Weedmap (default: false) |
showInWidget | boolean | No | Show In Widget (default: true) |
customTaxInfo | TaxInfo | No | Custom Tax Info |
discountable | boolean | No | Discountable (default: true) |
discountEnabled | boolean | No | Discount Enabled (default: true) |
brand | Brand | No | Brand |
lowThreshold | number | No | Low Threshold |
lowInventoryNotification | boolean | No | Low Inventory Notification (default: false) |
medicinal | boolean | No | Medicinal (default: true) |
byGram | boolean | No | By Gram (default: true) |
byPrepackage | boolean | No | By Prepackage (default: false) |
enableExciseTax | boolean | No | Enable Excise Tax (default: false) |
priceIncludesExcise | boolean | No | Price Includes Excise (default: false) |
priceIncludesALExcise | boolean | No | Price Includes A L Excise (default: false) |
cannabisType | cannabistype | No | Cannabis Type (default: DEFAULT) |
potencyAmount | PotencyMG | No | Potency Amount |
taxTables | CompoundTaxTable[] | No | Tax Tables |
tags | string[] | No | Tags |
qbItemRef | string | No | Qb Item Ref |
customWeight | number | No | Custom Weight |
automaticReOrder | boolean | No | Automatic Re Order (default: false) |
reOrderLevel | number | No | Re Order Level |
leadTime | integer | No | Lead timestamp (epoch ms) (default: 0) |
minDaysOnHand | integer | No | Min Days On Hand (default: 0) |
maxDaysOnHand | integer | No | Max Days On Hand (default: 0) |
customGramType | customgramtype | No | Custom Gram Type (default: GRAM) |
pricingTemplateId | string | No | Pricing Template identifier |
companyPricingTemplateId | string | No | Company Pricing Template identifier |
productType | producttype | No | Product Type (default: REGULAR) |
bundleItems | BundleItem[] | No | Bundle Items |
complianceId | string | No | Compliance identifier |
toleranceId | string | No | Tolerance identifier |
producerMfg | string | No | Producer Mfg |
producerLicense | string | No | Producer License |
producerAddress | Address | No | Producer Address |
sellable | boolean | No | Sellable (default: true) |
wmThreshold | number | No | Wm Threshold (default: ZERO) |
salesPrice | number | No | Sales Price |
lastWMSyncTime | long | No | Last W M Sync timestamp (epoch ms) |
lastLeaflySyncTime | long | No | Last Leafly Sync timestamp (epoch ms) |
lastLeaflySyncStatus | boolean | No | Last Leafly Sync Status (default: false) |
overrideMetrcCategoryId | string | No | Override Metrc Category identifier |
wmOnlineSellable | boolean | No | Wm Online Sellable (default: true) |
totalCommittedQuantity | number | No | Total Committed Quantity (default: ZERO) |
totalSellableQuantity | number | No | Total Sellable Quantity (default: ZERO) |
usableMarijuana | number | No | Usable Marijuana (default: ZERO) |
dispatchPrepackageItemId | string | No | Dispatch Prepackage Item identifier |
secondaryVendors | string[] | No | Secondary Vendors |
wmProductId | string | No | Wm Product identifier |
wmBrandId | string | No | Wm Brand identifier |
wmTags | string[] | No | Wm Tags |
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 |
complianceInfo | ComplianceProductInfo | No | Compliance Info |
totalConsumerOrderQuantity | number | No | Total Consumer Order Quantity (default: ZERO) |
metadata | Metadata[] | No | Metadata |
brandName | string | No | Brand Name |
purchaseLimits | purchaselimit[] | No | Purchase Limits |
productInfoSourcingStrategy | productinfosourcingstrategy | No | Product Info Sourcing Strategy (default: NONE) |
activeBatchId | string | No | Active Batch identifier |
activeBatchSku | string | No | Active Batch Sku |
externalId | string | No | External system identifier |
masterId | string | No | Master identifier |
companyProductId | string | No | Company Product identifier |
parentId | string | No | Parent identifier |
globalProductId | string | No | Global Product identifier |
platformProductId | string | No | Platform Product identifier |
shop | Shop | No | Shop |
sourceMap | object | No | Source Map |
shopsList | Shop[] | No | Shops List |
menuApiBrandName | string | No | Menu Api Brand Name |
menuApiProductName | string | No | Menu Api Product Name |
menuApiProductId | integer | No | Menu Api Product identifier |
menuApiVariantProductId | integer | No | Menu Api Variant Product identifier |
menuApiBrandId | integer | No | Menu Api Brand identifier |
metadataModifiedAt | long | No | Metadata Modified At |
component | boolean | No | Component (default: false) |
item | boolean | No | Item (default: false) |
productFamilyId | string | No | Product Family identifier |
archived | boolean | No | Archived (default: false) |
isGiftCard | boolean | No | Is Gift Card |
provider | string | No | Provider |
loyaltyAccrual | boolean | No | Loyalty Accrual (default: true) |
metadataMap | object | No | Metadata Map |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"checkSum": 0,
"importId": "abc123",
"importSrc": "string",
"categoryId": "abc123",
"sku": "string",
"vendorId": "abc123",
"productSaleType": "Both",
"name": "string",
"description": "",
"flowerType": "string",
"unitPrice": 0,
"purchasePrice": 0,
"weightPerUnit": "EACH",
"unitValue": 0,
"thc": 0,
"cbn": 0,
"cbd": 0,
"cbda": 0,
"thca": 0,
"cbg": 0,
"totalCannabinoids": 0,
"totalTerpenes": 0,
"terpenoids": {},
"active": true,
"genetics": "string",
"medicalConditions": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"priceRanges": [
{
"id": "abc123",
"weightToleranceId": "abc123",
"price": 0,
"priority": 0,
"weightTolerance": {},
"salePrice": 0
}
],
"priceBreaks": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"priceBreakType": "None",
"name": "string",
"displayName": "string",
"price": 0,
"quantity": 1,
"active": true,
"priority": 0,
"salePrice": 0
}
],
"assets": [
{
"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"
}
],
"quantities": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"inventoryId": "abc123",
"quantity": 0
}
],
"instock": false,
"brandId": "abc123",
"category": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"cannabis": false,
"blazeCategoryId": "abc123",
"active": true,
"unitType": "units",
"lowThreshold": "ZERO",
"complianceId": "abc123",
"archived": false,
"topLevelCategoryId": "abc123",
"normalizedCategoryId": "abc123",
"shopIds": [],
"parentCategoryId": "abc123",
"companyCategoryId": "abc123",
"wmCategory": "string",
"externalId": "abc123",
"priority": 0,
"masterId": "abc123",
"platformCategoryId": "abc123",
"platformParentCategoryId": "abc123",
"sourceMap": {},
"photo": {},
"labelTemplateId": "abc123",
"categoryApp": "DISTRO",
"unitTrackingEnabled": false,
"isGiftCard": false
},
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"enableMixMatch": false,
"enableWeedmap": false,
"showInWidget": true,
"customTaxInfo": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"cityTax": 0,
"stateTax": 0,
"federalTax": 0,
"activeCDTFATax": false
},
"discountable": true,
"discountEnabled": true,
"brand": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"email": "user@example.com",
"description": "string",
"brandLogo": {},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
},
"lowThreshold": 0,
"lowInventoryNotification": false,
"medicinal": true,
"byGram": true,
"byPrepackage": false,
"enableExciseTax": false,
"priceIncludesExcise": false,
"priceIncludesALExcise": false,
"cannabisType": "DEFAULT",
"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"
},
"taxTables": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"taxType": "Inherit",
"taxOrder": "PostTaxed",
"consumerType": "AdultUse",
"cityTax": {},
"countyTax": {},
"stateTax": {},
"federalTax": {},
"enableSurchargeFeeTax": false
}
],
"tags": [],
"qbItemRef": "string",
"customWeight": 0,
"automaticReOrder": false,
"reOrderLevel": 0,
"leadTime": 0,
"minDaysOnHand": 0,
"maxDaysOnHand": 0,
"customGramType": "GRAM",
"pricingTemplateId": "abc123",
"companyPricingTemplateId": "abc123",
"productType": "REGULAR",
"bundleItems": [
{
"productId": "abc123",
"quantity": 0
}
],
"complianceId": "abc123",
"toleranceId": "abc123",
"producerMfg": "string",
"producerLicense": "string",
"producerAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"sellable": true,
"wmThreshold": "ZERO",
"salesPrice": 0,
"lastWMSyncTime": 1704067200000,
"lastLeaflySyncTime": 1704067200000,
"lastLeaflySyncStatus": false,
"overrideMetrcCategoryId": "abc123",
"wmOnlineSellable": true,
"totalCommittedQuantity": "ZERO",
"totalSellableQuantity": "ZERO",
"usableMarijuana": "ZERO",
"dispatchPrepackageItemId": "abc123",
"secondaryVendors": [],
"wmProductId": "abc123",
"wmBrandId": "abc123",
"wmTags": [],
"maxThc": 0,
"maxCbn": 0,
"maxCbd": 0,
"maxCbda": 0,
"maxThca": 0,
"complianceInfo": {
"statementIntendedUse": [],
"refrigeration": "string",
"form": "",
"ingredients": "",
"allergens": "",
"strain": "string",
"servingsPerContainer": 0
},
"totalConsumerOrderQuantity": "ZERO",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"brandName": "string",
"purchaseLimits": [],
"productInfoSourcingStrategy": "NONE",
"activeBatchId": "abc123",
"activeBatchSku": "string",
"externalId": "abc123",
"masterId": "abc123",
"companyProductId": "abc123",
"parentId": "abc123",
"globalProductId": "abc123",
"platformProductId": "abc123",
"shop": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
},
"sourceMap": {},
"shopsList": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
}
],
"menuApiBrandName": "string",
"menuApiProductName": "string",
"menuApiProductId": 0,
"menuApiVariantProductId": 0,
"menuApiBrandId": 0,
"metadataModifiedAt": 0,
"component": false,
"item": false,
"productFamilyId": "abc123",
"archived": false,
"isGiftCard": false,
"provider": "string",
"loyaltyAccrual": true,
"metadataMap": {}
}
Get list of nearby products
GET /api/v1/partner/products/nearby
Search for products available near a geographic location. Provide lat and long coordinates. Set useRegion to true for region-based delivery zone filtering (also provide zipCode), or false for simple proximity search. Optionally filter by productIds and categoryIds.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
lat | double | No | Latitude coordinate |
long | double | No | Longitude coordinate |
useRegion | boolean | No | Whether to use region-based filtering |
overrideInventoryId | string | No | override inventory i d |
zipCode | string | No | ZIP code for location lookup |
skip | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
productIds | string[] | No | List of product IDs |
categoryIds | string[] | No | category ids |
Response
Returns a SearchRegionResult of Product objects.
- Fields
- JSON
| 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 |
checkSum | long | No | Check Sum |
importId | string | No | Import identifier |
importSrc | string | No | Import Src |
categoryId | string | No | Category identifier |
sku | string | No | Sku |
vendorId | string | No | Vendor identifier |
productSaleType | productsaletype | No | Product Sale Type (default: Both) |
name | string | Yes | Name |
description | string | No | Description (default: ``) |
flowerType | string | No | Flower Type |
unitPrice | number | No | Unit Price |
purchasePrice | number | No | Purchase Price |
weightPerUnit | weightperunit | No | Weight Per Unit (default: EACH) |
unitValue | number | No | Unit Value |
thc | double | No | Thc |
cbn | double | No | Cbn |
cbd | double | No | Cbd |
cbda | double | No | Cbda |
thca | double | No | Thca |
cbg | double | No | Cbg |
totalCannabinoids | double | No | Total Cannabinoids |
totalTerpenes | double | No | Total Terpenes |
terpenoids | object | No | Terpenoids |
active | boolean | No | Whether active (default: true) |
genetics | string | No | Genetics |
medicalConditions | MedicalCondition[] | No | Medical Conditions |
priceRanges | ProductPriceRange[] | No | Price Ranges |
priceBreaks | ProductPriceBreak[] | No | Price Breaks |
assets | CompanyAsset[] | No | Assets |
quantities | ProductQuantity[] | No | Quantities |
instock | boolean | No | Instock (default: false) |
brandId | string | No | Brand identifier |
category | ProductCategory | No | Category |
notes | Note[] | No | Notes |
enableMixMatch | boolean | No | Enable Mix Match (default: false) |
enableWeedmap | boolean | No | Enable Weedmap (default: false) |
showInWidget | boolean | No | Show In Widget (default: true) |
customTaxInfo | TaxInfo | No | Custom Tax Info |
discountable | boolean | No | Discountable (default: true) |
discountEnabled | boolean | No | Discount Enabled (default: true) |
brand | Brand | No | Brand |
lowThreshold | number | No | Low Threshold |
lowInventoryNotification | boolean | No | Low Inventory Notification (default: false) |
medicinal | boolean | No | Medicinal (default: true) |
byGram | boolean | No | By Gram (default: true) |
byPrepackage | boolean | No | By Prepackage (default: false) |
enableExciseTax | boolean | No | Enable Excise Tax (default: false) |
priceIncludesExcise | boolean | No | Price Includes Excise (default: false) |
priceIncludesALExcise | boolean | No | Price Includes A L Excise (default: false) |
cannabisType | cannabistype | No | Cannabis Type (default: DEFAULT) |
potencyAmount | PotencyMG | No | Potency Amount |
taxTables | CompoundTaxTable[] | No | Tax Tables |
tags | string[] | No | Tags |
qbItemRef | string | No | Qb Item Ref |
customWeight | number | No | Custom Weight |
automaticReOrder | boolean | No | Automatic Re Order (default: false) |
reOrderLevel | number | No | Re Order Level |
leadTime | integer | No | Lead timestamp (epoch ms) (default: 0) |
minDaysOnHand | integer | No | Min Days On Hand (default: 0) |
maxDaysOnHand | integer | No | Max Days On Hand (default: 0) |
customGramType | customgramtype | No | Custom Gram Type (default: GRAM) |
pricingTemplateId | string | No | Pricing Template identifier |
companyPricingTemplateId | string | No | Company Pricing Template identifier |
productType | producttype | No | Product Type (default: REGULAR) |
bundleItems | BundleItem[] | No | Bundle Items |
complianceId | string | No | Compliance identifier |
toleranceId | string | No | Tolerance identifier |
producerMfg | string | No | Producer Mfg |
producerLicense | string | No | Producer License |
producerAddress | Address | No | Producer Address |
sellable | boolean | No | Sellable (default: true) |
wmThreshold | number | No | Wm Threshold (default: ZERO) |
salesPrice | number | No | Sales Price |
lastWMSyncTime | long | No | Last W M Sync timestamp (epoch ms) |
lastLeaflySyncTime | long | No | Last Leafly Sync timestamp (epoch ms) |
lastLeaflySyncStatus | boolean | No | Last Leafly Sync Status (default: false) |
overrideMetrcCategoryId | string | No | Override Metrc Category identifier |
wmOnlineSellable | boolean | No | Wm Online Sellable (default: true) |
totalCommittedQuantity | number | No | Total Committed Quantity (default: ZERO) |
totalSellableQuantity | number | No | Total Sellable Quantity (default: ZERO) |
usableMarijuana | number | No | Usable Marijuana (default: ZERO) |
dispatchPrepackageItemId | string | No | Dispatch Prepackage Item identifier |
secondaryVendors | string[] | No | Secondary Vendors |
wmProductId | string | No | Wm Product identifier |
wmBrandId | string | No | Wm Brand identifier |
wmTags | string[] | No | Wm Tags |
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 |
complianceInfo | ComplianceProductInfo | No | Compliance Info |
totalConsumerOrderQuantity | number | No | Total Consumer Order Quantity (default: ZERO) |
metadata | Metadata[] | No | Metadata |
brandName | string | No | Brand Name |
purchaseLimits | purchaselimit[] | No | Purchase Limits |
productInfoSourcingStrategy | productinfosourcingstrategy | No | Product Info Sourcing Strategy (default: NONE) |
activeBatchId | string | No | Active Batch identifier |
activeBatchSku | string | No | Active Batch Sku |
externalId | string | No | External system identifier |
masterId | string | No | Master identifier |
companyProductId | string | No | Company Product identifier |
parentId | string | No | Parent identifier |
globalProductId | string | No | Global Product identifier |
platformProductId | string | No | Platform Product identifier |
shop | Shop | No | Shop |
sourceMap | object | No | Source Map |
shopsList | Shop[] | No | Shops List |
menuApiBrandName | string | No | Menu Api Brand Name |
menuApiProductName | string | No | Menu Api Product Name |
menuApiProductId | integer | No | Menu Api Product identifier |
menuApiVariantProductId | integer | No | Menu Api Variant Product identifier |
menuApiBrandId | integer | No | Menu Api Brand identifier |
metadataModifiedAt | long | No | Metadata Modified At |
component | boolean | No | Component (default: false) |
item | boolean | No | Item (default: false) |
productFamilyId | string | No | Product Family identifier |
archived | boolean | No | Archived (default: false) |
isGiftCard | boolean | No | Is Gift Card |
provider | string | No | Provider |
loyaltyAccrual | boolean | No | Loyalty Accrual (default: true) |
metadataMap | object | No | Metadata Map |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"checkSum": 0,
"importId": "abc123",
"importSrc": "string",
"categoryId": "abc123",
"sku": "string",
"vendorId": "abc123",
"productSaleType": "Both",
"name": "string",
"description": "",
"flowerType": "string",
"unitPrice": 0,
"purchasePrice": 0,
"weightPerUnit": "EACH",
"unitValue": 0,
"thc": 0,
"cbn": 0,
"cbd": 0,
"cbda": 0,
"thca": 0,
"cbg": 0,
"totalCannabinoids": 0,
"totalTerpenes": 0,
"terpenoids": {},
"active": true,
"genetics": "string",
"medicalConditions": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"priceRanges": [
{
"id": "abc123",
"weightToleranceId": "abc123",
"price": 0,
"priority": 0,
"weightTolerance": {},
"salePrice": 0
}
],
"priceBreaks": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"priceBreakType": "None",
"name": "string",
"displayName": "string",
"price": 0,
"quantity": 1,
"active": true,
"priority": 0,
"salePrice": 0
}
],
"assets": [
{
"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"
}
],
"quantities": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"inventoryId": "abc123",
"quantity": 0
}
],
"instock": false,
"brandId": "abc123",
"category": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"cannabis": false,
"blazeCategoryId": "abc123",
"active": true,
"unitType": "units",
"lowThreshold": "ZERO",
"complianceId": "abc123",
"archived": false,
"topLevelCategoryId": "abc123",
"normalizedCategoryId": "abc123",
"shopIds": [],
"parentCategoryId": "abc123",
"companyCategoryId": "abc123",
"wmCategory": "string",
"externalId": "abc123",
"priority": 0,
"masterId": "abc123",
"platformCategoryId": "abc123",
"platformParentCategoryId": "abc123",
"sourceMap": {},
"photo": {},
"labelTemplateId": "abc123",
"categoryApp": "DISTRO",
"unitTrackingEnabled": false,
"isGiftCard": false
},
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"enableMixMatch": false,
"enableWeedmap": false,
"showInWidget": true,
"customTaxInfo": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"cityTax": 0,
"stateTax": 0,
"federalTax": 0,
"activeCDTFATax": false
},
"discountable": true,
"discountEnabled": true,
"brand": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"email": "user@example.com",
"description": "string",
"brandLogo": {},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
},
"lowThreshold": 0,
"lowInventoryNotification": false,
"medicinal": true,
"byGram": true,
"byPrepackage": false,
"enableExciseTax": false,
"priceIncludesExcise": false,
"priceIncludesALExcise": false,
"cannabisType": "DEFAULT",
"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"
},
"taxTables": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"taxType": "Inherit",
"taxOrder": "PostTaxed",
"consumerType": "AdultUse",
"cityTax": {},
"countyTax": {},
"stateTax": {},
"federalTax": {},
"enableSurchargeFeeTax": false
}
],
"tags": [],
"qbItemRef": "string",
"customWeight": 0,
"automaticReOrder": false,
"reOrderLevel": 0,
"leadTime": 0,
"minDaysOnHand": 0,
"maxDaysOnHand": 0,
"customGramType": "GRAM",
"pricingTemplateId": "abc123",
"companyPricingTemplateId": "abc123",
"productType": "REGULAR",
"bundleItems": [
{
"productId": "abc123",
"quantity": 0
}
],
"complianceId": "abc123",
"toleranceId": "abc123",
"producerMfg": "string",
"producerLicense": "string",
"producerAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"sellable": true,
"wmThreshold": "ZERO",
"salesPrice": 0,
"lastWMSyncTime": 1704067200000,
"lastLeaflySyncTime": 1704067200000,
"lastLeaflySyncStatus": false,
"overrideMetrcCategoryId": "abc123",
"wmOnlineSellable": true,
"totalCommittedQuantity": "ZERO",
"totalSellableQuantity": "ZERO",
"usableMarijuana": "ZERO",
"dispatchPrepackageItemId": "abc123",
"secondaryVendors": [],
"wmProductId": "abc123",
"wmBrandId": "abc123",
"wmTags": [],
"maxThc": 0,
"maxCbn": 0,
"maxCbd": 0,
"maxCbda": 0,
"maxThca": 0,
"complianceInfo": {
"statementIntendedUse": [],
"refrigeration": "string",
"form": "",
"ingredients": "",
"allergens": "",
"strain": "string",
"servingsPerContainer": 0
},
"totalConsumerOrderQuantity": "ZERO",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"brandName": "string",
"purchaseLimits": [],
"productInfoSourcingStrategy": "NONE",
"activeBatchId": "abc123",
"activeBatchSku": "string",
"externalId": "abc123",
"masterId": "abc123",
"companyProductId": "abc123",
"parentId": "abc123",
"globalProductId": "abc123",
"platformProductId": "abc123",
"shop": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
},
"sourceMap": {},
"shopsList": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
}
],
"menuApiBrandName": "string",
"menuApiProductName": "string",
"menuApiProductId": 0,
"menuApiVariantProductId": 0,
"menuApiBrandId": 0,
"metadataModifiedAt": 0,
"component": false,
"item": false,
"productFamilyId": "abc123",
"archived": false,
"isGiftCard": false,
"provider": "string",
"loyaltyAccrual": true,
"metadataMap": {}
}
Update Product Meta Data
PUT /api/v1/partner/products/{productId}/metadata
Update only the metadata (custom key-value pairs) on a product without modifying the product's core fields. Send a MetadataUpdateRequest in the request body.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
productId | string | The product i d |
Request Body
Accepts a MetadataUpdateRequest object.
Response
Returns a Product object.
- Fields
- JSON
| 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 |
checkSum | long | No | Check Sum |
importId | string | No | Import identifier |
importSrc | string | No | Import Src |
categoryId | string | No | Category identifier |
sku | string | No | Sku |
vendorId | string | No | Vendor identifier |
productSaleType | productsaletype | No | Product Sale Type (default: Both) |
name | string | Yes | Name |
description | string | No | Description (default: ``) |
flowerType | string | No | Flower Type |
unitPrice | number | No | Unit Price |
purchasePrice | number | No | Purchase Price |
weightPerUnit | weightperunit | No | Weight Per Unit (default: EACH) |
unitValue | number | No | Unit Value |
thc | double | No | Thc |
cbn | double | No | Cbn |
cbd | double | No | Cbd |
cbda | double | No | Cbda |
thca | double | No | Thca |
cbg | double | No | Cbg |
totalCannabinoids | double | No | Total Cannabinoids |
totalTerpenes | double | No | Total Terpenes |
terpenoids | object | No | Terpenoids |
active | boolean | No | Whether active (default: true) |
genetics | string | No | Genetics |
medicalConditions | MedicalCondition[] | No | Medical Conditions |
priceRanges | ProductPriceRange[] | No | Price Ranges |
priceBreaks | ProductPriceBreak[] | No | Price Breaks |
assets | CompanyAsset[] | No | Assets |
quantities | ProductQuantity[] | No | Quantities |
instock | boolean | No | Instock (default: false) |
brandId | string | No | Brand identifier |
category | ProductCategory | No | Category |
notes | Note[] | No | Notes |
enableMixMatch | boolean | No | Enable Mix Match (default: false) |
enableWeedmap | boolean | No | Enable Weedmap (default: false) |
showInWidget | boolean | No | Show In Widget (default: true) |
customTaxInfo | TaxInfo | No | Custom Tax Info |
discountable | boolean | No | Discountable (default: true) |
discountEnabled | boolean | No | Discount Enabled (default: true) |
brand | Brand | No | Brand |
lowThreshold | number | No | Low Threshold |
lowInventoryNotification | boolean | No | Low Inventory Notification (default: false) |
medicinal | boolean | No | Medicinal (default: true) |
byGram | boolean | No | By Gram (default: true) |
byPrepackage | boolean | No | By Prepackage (default: false) |
enableExciseTax | boolean | No | Enable Excise Tax (default: false) |
priceIncludesExcise | boolean | No | Price Includes Excise (default: false) |
priceIncludesALExcise | boolean | No | Price Includes A L Excise (default: false) |
cannabisType | cannabistype | No | Cannabis Type (default: DEFAULT) |
potencyAmount | PotencyMG | No | Potency Amount |
taxTables | CompoundTaxTable[] | No | Tax Tables |
tags | string[] | No | Tags |
qbItemRef | string | No | Qb Item Ref |
customWeight | number | No | Custom Weight |
automaticReOrder | boolean | No | Automatic Re Order (default: false) |
reOrderLevel | number | No | Re Order Level |
leadTime | integer | No | Lead timestamp (epoch ms) (default: 0) |
minDaysOnHand | integer | No | Min Days On Hand (default: 0) |
maxDaysOnHand | integer | No | Max Days On Hand (default: 0) |
customGramType | customgramtype | No | Custom Gram Type (default: GRAM) |
pricingTemplateId | string | No | Pricing Template identifier |
companyPricingTemplateId | string | No | Company Pricing Template identifier |
productType | producttype | No | Product Type (default: REGULAR) |
bundleItems | BundleItem[] | No | Bundle Items |
complianceId | string | No | Compliance identifier |
toleranceId | string | No | Tolerance identifier |
producerMfg | string | No | Producer Mfg |
producerLicense | string | No | Producer License |
producerAddress | Address | No | Producer Address |
sellable | boolean | No | Sellable (default: true) |
wmThreshold | number | No | Wm Threshold (default: ZERO) |
salesPrice | number | No | Sales Price |
lastWMSyncTime | long | No | Last W M Sync timestamp (epoch ms) |
lastLeaflySyncTime | long | No | Last Leafly Sync timestamp (epoch ms) |
lastLeaflySyncStatus | boolean | No | Last Leafly Sync Status (default: false) |
overrideMetrcCategoryId | string | No | Override Metrc Category identifier |
wmOnlineSellable | boolean | No | Wm Online Sellable (default: true) |
totalCommittedQuantity | number | No | Total Committed Quantity (default: ZERO) |
totalSellableQuantity | number | No | Total Sellable Quantity (default: ZERO) |
usableMarijuana | number | No | Usable Marijuana (default: ZERO) |
dispatchPrepackageItemId | string | No | Dispatch Prepackage Item identifier |
secondaryVendors | string[] | No | Secondary Vendors |
wmProductId | string | No | Wm Product identifier |
wmBrandId | string | No | Wm Brand identifier |
wmTags | string[] | No | Wm Tags |
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 |
complianceInfo | ComplianceProductInfo | No | Compliance Info |
totalConsumerOrderQuantity | number | No | Total Consumer Order Quantity (default: ZERO) |
metadata | Metadata[] | No | Metadata |
brandName | string | No | Brand Name |
purchaseLimits | purchaselimit[] | No | Purchase Limits |
productInfoSourcingStrategy | productinfosourcingstrategy | No | Product Info Sourcing Strategy (default: NONE) |
activeBatchId | string | No | Active Batch identifier |
activeBatchSku | string | No | Active Batch Sku |
externalId | string | No | External system identifier |
masterId | string | No | Master identifier |
companyProductId | string | No | Company Product identifier |
parentId | string | No | Parent identifier |
globalProductId | string | No | Global Product identifier |
platformProductId | string | No | Platform Product identifier |
shop | Shop | No | Shop |
sourceMap | object | No | Source Map |
shopsList | Shop[] | No | Shops List |
menuApiBrandName | string | No | Menu Api Brand Name |
menuApiProductName | string | No | Menu Api Product Name |
menuApiProductId | integer | No | Menu Api Product identifier |
menuApiVariantProductId | integer | No | Menu Api Variant Product identifier |
menuApiBrandId | integer | No | Menu Api Brand identifier |
metadataModifiedAt | long | No | Metadata Modified At |
component | boolean | No | Component (default: false) |
item | boolean | No | Item (default: false) |
productFamilyId | string | No | Product Family identifier |
archived | boolean | No | Archived (default: false) |
isGiftCard | boolean | No | Is Gift Card |
provider | string | No | Provider |
loyaltyAccrual | boolean | No | Loyalty Accrual (default: true) |
metadataMap | object | No | Metadata Map |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"checkSum": 0,
"importId": "abc123",
"importSrc": "string",
"categoryId": "abc123",
"sku": "string",
"vendorId": "abc123",
"productSaleType": "Both",
"name": "string",
"description": "",
"flowerType": "string",
"unitPrice": 0,
"purchasePrice": 0,
"weightPerUnit": "EACH",
"unitValue": 0,
"thc": 0,
"cbn": 0,
"cbd": 0,
"cbda": 0,
"thca": 0,
"cbg": 0,
"totalCannabinoids": 0,
"totalTerpenes": 0,
"terpenoids": {},
"active": true,
"genetics": "string",
"medicalConditions": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"priceRanges": [
{
"id": "abc123",
"weightToleranceId": "abc123",
"price": 0,
"priority": 0,
"weightTolerance": {},
"salePrice": 0
}
],
"priceBreaks": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"priceBreakType": "None",
"name": "string",
"displayName": "string",
"price": 0,
"quantity": 1,
"active": true,
"priority": 0,
"salePrice": 0
}
],
"assets": [
{
"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"
}
],
"quantities": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"inventoryId": "abc123",
"quantity": 0
}
],
"instock": false,
"brandId": "abc123",
"category": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"cannabis": false,
"blazeCategoryId": "abc123",
"active": true,
"unitType": "units",
"lowThreshold": "ZERO",
"complianceId": "abc123",
"archived": false,
"topLevelCategoryId": "abc123",
"normalizedCategoryId": "abc123",
"shopIds": [],
"parentCategoryId": "abc123",
"companyCategoryId": "abc123",
"wmCategory": "string",
"externalId": "abc123",
"priority": 0,
"masterId": "abc123",
"platformCategoryId": "abc123",
"platformParentCategoryId": "abc123",
"sourceMap": {},
"photo": {},
"labelTemplateId": "abc123",
"categoryApp": "DISTRO",
"unitTrackingEnabled": false,
"isGiftCard": false
},
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"enableMixMatch": false,
"enableWeedmap": false,
"showInWidget": true,
"customTaxInfo": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"cityTax": 0,
"stateTax": 0,
"federalTax": 0,
"activeCDTFATax": false
},
"discountable": true,
"discountEnabled": true,
"brand": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"email": "user@example.com",
"description": "string",
"brandLogo": {},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
},
"lowThreshold": 0,
"lowInventoryNotification": false,
"medicinal": true,
"byGram": true,
"byPrepackage": false,
"enableExciseTax": false,
"priceIncludesExcise": false,
"priceIncludesALExcise": false,
"cannabisType": "DEFAULT",
"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"
},
"taxTables": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"taxType": "Inherit",
"taxOrder": "PostTaxed",
"consumerType": "AdultUse",
"cityTax": {},
"countyTax": {},
"stateTax": {},
"federalTax": {},
"enableSurchargeFeeTax": false
}
],
"tags": [],
"qbItemRef": "string",
"customWeight": 0,
"automaticReOrder": false,
"reOrderLevel": 0,
"leadTime": 0,
"minDaysOnHand": 0,
"maxDaysOnHand": 0,
"customGramType": "GRAM",
"pricingTemplateId": "abc123",
"companyPricingTemplateId": "abc123",
"productType": "REGULAR",
"bundleItems": [
{
"productId": "abc123",
"quantity": 0
}
],
"complianceId": "abc123",
"toleranceId": "abc123",
"producerMfg": "string",
"producerLicense": "string",
"producerAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"sellable": true,
"wmThreshold": "ZERO",
"salesPrice": 0,
"lastWMSyncTime": 1704067200000,
"lastLeaflySyncTime": 1704067200000,
"lastLeaflySyncStatus": false,
"overrideMetrcCategoryId": "abc123",
"wmOnlineSellable": true,
"totalCommittedQuantity": "ZERO",
"totalSellableQuantity": "ZERO",
"usableMarijuana": "ZERO",
"dispatchPrepackageItemId": "abc123",
"secondaryVendors": [],
"wmProductId": "abc123",
"wmBrandId": "abc123",
"wmTags": [],
"maxThc": 0,
"maxCbn": 0,
"maxCbd": 0,
"maxCbda": 0,
"maxThca": 0,
"complianceInfo": {
"statementIntendedUse": [],
"refrigeration": "string",
"form": "",
"ingredients": "",
"allergens": "",
"strain": "string",
"servingsPerContainer": 0
},
"totalConsumerOrderQuantity": "ZERO",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"brandName": "string",
"purchaseLimits": [],
"productInfoSourcingStrategy": "NONE",
"activeBatchId": "abc123",
"activeBatchSku": "string",
"externalId": "abc123",
"masterId": "abc123",
"companyProductId": "abc123",
"parentId": "abc123",
"globalProductId": "abc123",
"platformProductId": "abc123",
"shop": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
},
"sourceMap": {},
"shopsList": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"shortIdentifier": "string",
"name": "string",
"shopType": "Medicinal",
"address": {},
"phoneNumber": "string",
"emailAdress": "string",
"license": "string",
"deaNumber": "string",
"enableDeliveryFee": false,
"acceptAdultUseOrders": false,
"deliveryFee": 0,
"taxInfo": {},
"showWalkInQueue": true,
"showDeliveryQueue": true,
"showOnlineQueue": false,
"showSpecialQueue": false,
"walkInQueueDOV": "ByTerminal",
"deliveryQueueDOV": "ByTerminal",
"specialQueueDOV": "ByTerminal",
"enableCashInOut": false,
"timeZone": "DEFAULT_REQ_TIMEZONE",
"latitude": 0,
"longitude": 0,
"active": true,
"snapshopTime": 1704067200000,
"nextSnapshotTime": 1704067200000,
"defaultCountry": "string",
"onlineStoreInfo": {},
"deliveryFees": [],
"enableSaleLogout": false,
"assets": [],
"enableBCCReceipt": false,
"bccEmailAddress": "string",
"enableGPSTracking": false,
"receivingInventoryId": "abc123",
"defaultPinTimeout": "DEFAULT_PIN_TIMEOUT_DURATION",
"emailList": [],
"enableLowInventoryEmail": false,
"restrictedViews": false,
"emailMessage": "string",
"taxRoundOffType": "ONE_CENT",
"enforceCashDrawers": false,
"useAssignedEmployee": false,
"enforceBlindCashDrawer": false,
"termSalesOption": "DeviceTerminal",
"showProductByAvailableQuantity": false,
"autoCashDrawer": false,
"numAllowActiveTrans": 1,
"requireValidRecDate": false,
"enableDeliverySignature": false,
"restrictIncomingOrderNotifications": false,
"restrictedNotificationTerminals": [],
"roundOffType": "NONE",
"roundUpMessage": "string",
"membersCountSyncDate": "null",
"enableCannabisLimit": false,
"useComplexTax": false,
"taxTables": [],
"enableExciseTax": false,
"nalExciseFromRetailCost": false,
"nalExciseAfterCityTax": false,
"alExciseOnZeroPrice": false,
"marketingSources": [],
"productsTag": [],
"logo": {},
"hubId": "abc123",
"hubName": "string",
"enableOnFleet": false,
"onFleetApiKey": "string",
"onFleetOrganizationId": "abc123",
"onFleetOrganizationName": "string",
"onFleetTwoWay": false,
"onFleetTwoWayUpdateSchedule": false,
"onFleetTwoWayRevert": false,
"onFleetTwoAutoPack": false,
"onFleetAllowEmptyOrders": false,
"autoOnFleetTeam": "",
"enableUnAssignedOnfleetOrder": false,
"emailAttachment": {},
"receiptInfo": [],
"enablePinForCashDrawer": false,
"cashDrawerQuickStartEnabled": false,
"enableWooCommerce": false,
"cartMinimums": {},
"creditCardFeeList": [],
"blazePayFeeList": [],
"strongholdFeeList": [],
"achFeeList": [],
"twilioNumber": "string",
"enableAgeLimit": false,
"ageLimit": "DEFAULT_AGE_LIMIT",
"medicinalAge": "DEFAULT_AGE_LIMIT",
"enableMedicinalAge": false,
"deliveryRefundType": "NONE",
"creditFefundType": "NONE",
"enableSpringBig": false,
"enableGrowthLoyalty": false,
"enableDailySummaryEmail": false,
"enableHarvestTax": false,
"enableTookan": false,
"legalLanguage": "string",
"enableExciseTaxWarning": false,
"exciseTaxWarning": "string",
"orderTags": [],
"allowAnonymousOrders": false,
"membersTag": [],
"poTermCondition": "string",
"poNote": "string",
"invoiceTermCondition": "string",
"invoiceNote": "string",
"defaultHandOverMin": "DEFAULT_HANDOVER_DURATION",
"draftOrderTimeout": "DEFAULT_DRAFT_ORDER_TIMEOUT",
"enableTip": false,
"flowerType": [],
"enableRefundNote": false,
"enableAutoPrintAtFulfillment": false,
"nonCannabisTaxes": {},
"appendBrandNameWM": false,
"blazeConnections": [],
"enableLimitOnNetWeight": false,
"disableMedicalProductsForAdultUse": false,
"disableRecreationalProductsForMedical": false,
"enableDiscountNotes": false,
"enableCartDiscountNotes": false,
"enableAfterTaxDiscountNotes": false,
"checkDuplicateDl": false,
"onFleetRequired": false,
"enableColorPin": false,
"colorSameDay": "OnFleetAppearance.TriangleColor.ORANGE.name()",
"colorNextDay": "OnFleetAppearance.TriangleColor.TEAL.name()",
"colorBeyondNextDay": "OnFleetAppearance.TriangleColor.MAGENTA.name()",
"tookanRequired": false,
"enableDOBNameUniqueness": false,
"enableWaive": false,
"enableCustomerIdentification": false,
"enableComplianceTesting": false,
"requireEventTripExternalDeliveryLedgerId": false,
"onfleetOverrideUrl": "string",
"enableTipsBlazePay": false,
"enableIncomingOrders": false,
"enableCommittedValidation": false,
"enableAssignedOrdersCheckCommittedInventory": false,
"enableMfg": false,
"testShop": false,
"billable": true,
"validateRegion": false,
"overrideMemberLimits": false,
"enableQtyFlattening": false,
"productInfoSourcingStrategy": "NONE",
"nalTaxesOnly": false,
"enableSkipAssignValidation": false,
"website": "https://example.com",
"dispatchConfiguration": {},
"rollingCashDrawer": false,
"platformLocationId": "abc123",
"defaultPOCostSource": "COMPLIANCE_SYSTEM",
"memberAddressRequired": false,
"exciseTaxInfo": {},
"inventoryCostOption": "WEIGHTED_AVERAGE",
"purchaseFloorAmount": "PENNY",
"enableCannabisAdjustmentAfterRounding": false,
"usePackageDateForExpiration": false,
"requirePhoneNumber": false,
"requiredMemberPhone": false,
"deliveryMaxOrders": 1,
"enableDeferTransactions": false,
"pennyTransactionOption": "DISABLED",
"defaultMetrcLocation": "null",
"canAssignLocationsToPackages": false,
"canUpdateLocationsOnPackages": false,
"autoArchiveBatches": false,
"autoArchiveBatchesAfterNDays": 30,
"productPriceIncludeExciseTax": false,
"checkoutType": "Direct"
}
],
"menuApiBrandName": "string",
"menuApiProductName": "string",
"menuApiProductId": 0,
"menuApiVariantProductId": 0,
"menuApiBrandId": 0,
"metadataModifiedAt": 0,
"component": false,
"item": false,
"productFamilyId": "abc123",
"archived": false,
"isGiftCard": false,
"provider": "string",
"loyaltyAccrual": true,
"metadataMap": {}
}
Sync group pricing
GET /api/v1/partner/products/prices/sync
Sync pricing group data within a date range. Uses cursor-based pagination — provide afterDate, beforeDate, and cursor parameters. Returns pricing groups that have changed within the specified date window. The limit parameter controls page size.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
afterDate | long | No | after date |
beforeDate | long | No | before date |
cursor | string | No | cursor |
limit | integer | No | Maximum records to return |
Response
Returns a paginated SearchResult of PricingGroupRes objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
productId | string | No | Product identifier |
pricingTemplateId | string | No | Pricing Template identifier |
enabled | boolean | No | Enabled |
deleted | boolean | No | Whether the record is deleted |
rule | pricinggrouprule | No | Rule |
priceBreaks | PriceBreakRes[] | No | Price Breaks |
priceRanges | PriceRangeRes[] | No | Price Ranges |
modified | long | No | Last modified timestamp (epoch ms) |
created | long | No | Created timestamp (epoch ms) |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"productId": "abc123",
"pricingTemplateId": "abc123",
"enabled": false,
"deleted": false,
"rule": {},
"priceBreaks": [
{
"displayName": "string",
"quantity": 0,
"price": 0,
"salePrice": 0,
"enabled": false
}
],
"priceRanges": [
{
"weightToleranceId": "abc123",
"displayName": "string",
"weightValue": 0,
"price": 0,
"salePrice": 0,
"enabled": false
}
],
"modified": 1704067200000,
"created": 1704067200000
}