Store

Access store information including store details, terminals, inventories, doctors, taxes, and webhooks.

Base URL: /api/v1/partner/store

Endpoints Overview

Method	Endpoint	Description
GET	/	Get Store Info
GET	/doctors	Get Store Info
GET	/terminals	Get all active terminals
GET	/inventories	Get all active Inventories
POST	/webHook	Create web hook for plugin
GET	/taxes	Get tax information

---

Get Store Info

GET /api/v1/partner/store

Retrieve the store's configuration and details. The store is determined by the authentication headers — no parameters are needed.

Response

Returns a StoreInfoResult object.

Fields

Field	Type	Required	Description
shop	Shop	No	Shop
contract	Contract	No	Contract
companyLogoURL	string	No	Company Logo U R L

JSON

{
  "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,
    "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,
    "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,
    "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,
    "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,
    "onfleetOverrideUrl": "string",
    "enableTipsBlazePay": false,
    "enableIncomingOrders": false,
    "enableCommittedValidation": 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,
    "requirePhoneNumber": false,
    "requiredMemberPhone": false,
    "deliveryMaxOrders": 1,
    "enableDeferTransactions": false,
    "pennyTransactionOption": "DISABLED",
    "defaultMetrcLocation": "null",
    "canAssignLocationsToPackages": false,
    "canUpdateLocationsOnPackages": false,
    "autoArchiveBatches": false,
    "autoArchiveBatchesAfterNDays": 30,
    "productPriceIncludeExciseTax": false,
    "checkoutType": "Direct"
  },
  "contract": {
    "id": "abc123",
    "companyId": "abc123",
    "shopId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "name": "string",
    "active": false,
    "text": "string",
    "version": 0,
    "required": false,
    "pdfFile": {},
    "enableWitnessSignature": false,
    "enableEmployeeSignature": false,
    "contentType": "TEXT"
  },
  "companyLogoURL": "string"
}

---

Get Store Info

GET /api/v1/partner/store/doctors

Search for doctors associated with the store. Use the term query parameter for free-text search.

Query Parameters

Parameter	Type	Required	Description
term	string	No	term

Response

Returns a paginated SearchResult of Doctor objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company 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
importId	string	No	Import identifier
firstName	string	Yes	First name
lastName	string	Yes	Last name
license	string	Yes	License
website	string	No	Website URL
phoneNumber	string	No	Phone Number
email	string	No	Email address
fax	string	No	Fax
degree	string	No	Degree
state	string	No	State
searchText	string	No	Search Text
address	Address	No	Address
active	boolean	No	Whether active
notes	Note[]	No	Notes
assets	CompanyAsset[]	No	Assets
deaNumber	string	No	Dea Number
npiNumber	string	No	Npi Number

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "importId": "abc123",
  "firstName": "John",
  "lastName": "Doe",
  "license": "string",
  "website": "https://example.com",
  "phoneNumber": "string",
  "email": "user@example.com",
  "fax": "string",
  "degree": "string",
  "state": "CA",
  "searchText": "string",
  "address": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "address": "",
    "city": "",
    "state": "",
    "zipCode": "",
    "addressLine2": "",
    "country": "DEFAULT_COUNTRY",
    "latitude": 0,
    "longitude": 0
  },
  "active": false,
  "notes": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "writerId": "abc123",
      "writerName": "string",
      "message": "string",
      "enableOnFleet": false
    }
  ],
  "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"
    }
  ],
  "deaNumber": "string",
  "npiNumber": "string"
}

---

Get all active terminals

GET /api/v1/partner/store/terminals

Retrieve all active POS terminals for the store. Supports pagination with start and limit parameters.

Query Parameters

Parameter	Type	Required	Description
start	integer	No	Number of records to skip
limit	integer	No	Maximum records to return

Response

Returns a paginated SearchResult of Terminal objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
active	boolean	No	Whether active
deviceId	string	No	Device identifier
name	string	No	Name
deviceModel	string	No	Device Model
deviceVersion	string	No	Device Version
deviceName	string	No	Device Name
appVersion	string	No	App Version
deviceToken	string	No	Device Token
deviceType	string	No	Device Type
assignedInventoryId	string	No	Assigned Inventory identifier
cvAccountId	string	No	Cv Account identifier
currentEmployeeId	string	No	Current Employee identifier
terminalType	string	No	Terminal Type. One of: NotAssigned, WalkIn, Delivery, SelfCheckout (default: NotAssigned)
posTerminal	string	No	Pos Terminal
regionId	string	No	Region identifier
creditCardReader	CreditCardReader	No	Credit Card Reader
onPremEnabled	boolean	No	On Prem Enabled (default: false)
brandIds	string[]	No	Brand Ids
terminalLocations	TerminalLocation[]	No	Terminal Locations
deviceDetails	devicedetail[]	No	Device Details
deviceId	string	No	Device identifier
version	string	No	Version (default: 1.0.0)
deviceToken	string	No	Device Token
deviceType	string	No	Device Type. One of: Android, iOS, Desktop, Web (default: iOS)
deviceVersion	string	No	Device Version
sdkVersion	string	No	Sdk Version
deviceModel	string	No	Device Model
deviceName	string	No	Device Name
active	boolean	No	Whether active

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "active": false,
  "deviceId": "abc123",
  "name": "string",
  "deviceModel": "string",
  "deviceVersion": "string",
  "deviceName": "string",
  "appVersion": "string",
  "deviceToken": "string",
  "deviceType": "iOS",
  "assignedInventoryId": "abc123",
  "cvAccountId": "abc123",
  "currentEmployeeId": "abc123",
  "terminalType": "NotAssigned",
  "posTerminal": "string",
  "regionId": "abc123",
  "creditCardReader": {
    "encryptionType": "BlazeSymmetricEncryption",
    "secretKey": "string"
  },
  "onPremEnabled": false,
  "brandIds": [],
  "terminalLocations": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "shopId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "terminalId": "abc123",
      "employeeId": "abc123",
      "timeCardId": "abc123",
      "deviceId": "abc123",
      "name": "string",
      "loc": []
    }
  ],
  "deviceDetails": [],
  "version": "1.0.0",
  "sdkVersion": "string"
}

---

Get all active Inventories

GET /api/v1/partner/store/inventories

Retrieve all active inventory rooms/locations for the store. Supports pagination with start and limit parameters.

Query Parameters

Parameter	Type	Required	Description
start	integer	No	Number of records to skip
limit	integer	No	Maximum records to return

Response

Returns a paginated SearchResult of Inventory objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
type	string	No	Type. One of: Storage, Field, Quarantine (default: Field)
name	string	No	Name
active	boolean	No	Whether active (default: true)
regionIds	string[]	No	Region Ids
externalId	string	No	External system identifier
dryRoom	boolean	No	Dry Room (default: true)
quantity	number	No	Quantity
complianceInvRoomName	string	No	Compliance Inv Room Name
complianceInvRoomId	integer	No	Compliance Inv Room identifier

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "type": "Field",
  "name": "string",
  "active": true,
  "regionIds": [],
  "externalId": "abc123",
  "dryRoom": true,
  "quantity": 0,
  "complianceInvRoomName": "string",
  "complianceInvRoomId": 0
}

---

Create web hook for plugin

POST /api/v1/partner/store/webHook

Create one or more webhook registrations for a partner plugin. Send a JSON array of PartnerWebHookAddRequest objects to register multiple webhooks in a single call.

Request Body

Accepts an array of PartnerWebHookAddRequest objects.

Fields

Field	Type	Required	Description
url	string	No	Url
shopId	string	No	Shop identifier
webHookUrls	string[]	Yes	Web Hook Urls

JSON

{
  "url": "string",
  "shopId": "abc123",
  "webHookUrls": []
}

Response

Returns a list of PartnerWebHook objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
url	string	No	Url
webHookType	string	No	Web Hook Type. One of: NEW_CONSUMER_ORDER, NEW_CONSUMER_SIGNUP, UPDATE_CONSUMER_ORDER, UPDATE_CONSUMER_USER, NEW_MEMBER, UPDATE_MEMBER, CREATE_TRANSACTION, UPDATE_TRANSACTION, CANCEL_TRANSACTION, COMPLETE_TRANSACTION, UPDATE_PRODUCT
webHookUrls	string[]	No	Web Hook Urls

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "url": "string",
  "webHookType": "NEW_CONSUMER_ORDER",
  "webHookUrls": []
}

---

Get tax information

GET /api/v1/partner/store/taxes

Retrieve the store's tax configuration, including tax names, rates, and display settings.

Response

Returns a list of TaxInfoResult objects.

Fields

Field	Type	Required	Description
name	string	No	Name

JSON

{
  "name": "string"
}