References

Full Object Index

A comprehensive reference of every resource type, schema, enum, query parameter, and header in the Blaze ECOM Storefront API.

What you'll learn

  • Every JSON type value the API returns and what it represents
  • All schemas defined in the OpenAPI spec, grouped by domain, with their fields and types
  • Every enum value used across the API
  • Common query parameters available for filtering and pagination
  • Required and optional headers for API requests

Prerequisites

  • Familiarity with the JSON specification
  • Read the Quick Start guide to understand the basic request/response flow
  • A valid X-Store header value (store UUID) — most endpoints are store-scoped

Resource Types

Every response from the API wraps data in JSON resource objects. The type field identifies the kind of resource. Here is a complete list of all resource types the API returns.

Core Commerce

Type Description Key endpoint(s)
stores A retail store with location, hours, and configuration GET /api/v1/store, GET /api/v1/groups/stores
store_products A product available at a store GET /api/v1/products, GET /api/v2/products/{id}
product_categories A product category (e.g. Flower, Edibles) GET /api/v1/products/categories, GET /api/v2/products/categories
product_brands A store-level product brand GET /api/v1/products/brands, GET /api/v2/products/brands
global_brands A global brand (cross-store), sideloaded via included GET /api/v2/products/{id} (included)
product_types A product type classification (e.g. Hybrid, Indica) GET /api/v1/products/types
product_images A product image, sideloaded via included GET /api/v2/products/{id} (included)
tags A product tag (e.g. new-arrival, staff-pick) GET /api/v1/products/tags
price_ranges Min/max price range for the store catalog GET /api/v1/products/price-ranges
filters Filter catalog metadata (categories, types, brands, weights, potency ranges) GET /api/v1/products/filters, GET /api/v2/products/filters
showcased_products A curated product showcase group GET /api/v1/products/showcased

Cart & Orders

Type Description Key endpoint(s)
carts A shopping cart POST /api/v5/carts, GET /api/v5/carts/{uuid}
cart_items An item within a cart, sideloaded via included POST /api/v5/carts/{cart_uuid}/items
orders A placed order POST /api/v4/orders, GET /api/v1/orders/{uuid}
order_items An item within an order, sideloaded via included GET /api/v1/orders/{uuid} (included)

User & Account

Type Description Key endpoint(s)
users A user account GET /api/v1/users/me, POST /api/v1/auth/login
billing User billing information GET /api/v1/users/me/billing
loyalty User loyalty points and tier GET /api/v3/users/me/loyalty
rewards A redeemable reward GET /api/v1/users/me/rewards, GET /api/v1/store/deals/rewards
identity_verifications Identity verification status GET /api/v1/users/me/identity-verification

Payments

Type Description Key endpoint(s)
payment_options A payment method available at the store GET /api/v1/store/payment-options
payment_sources A saved payment source (card, bank account) GET /api/v1/store/payments/{service}/sources
payment_tokens A client-side payment provider token GET /api/v1/store/payments/{service}/token
payment_sessions A payment session for client-side initialization POST /api/v1/store/payments/{service}/sessions
payments A payment charge result POST /api/v1/store/payments/{service}/orders/{uuid}/pay
payment_promotions A payment-service-specific promotion GET /api/v1/store/payments/{service}/promotions
payment_redeemable_promotions Request type for checking redeemable promotions POST /api/v1/store/payments/{service}/promotions/redeemable
tips A tip charge result POST /api/v1/store/payments/{service}/tip

Deals

Type Description Key endpoint(s)
promotions A store promotion or deal GET /api/v1/store/deals/promotions

Store Content

Type Description Key endpoint(s)
store_settings Store settings and feature flags GET /api/v1/store/settings
store_configurations Store configuration including group and site info GET /api/v1/store/configuration
schedules Weekly schedule entries for a store GET /api/v1/store/schedules/{schedule_type}
availabilities Available time slots for pickup or delivery GET /api/v1/store/availabilities/{schedule_type}
promotional_banners A promotional banner for the storefront GET /api/v1/store/site/promotional-banners
social_networks A store social network link GET /api/v1/store/socials
store_pages A custom store page (About, FAQ, etc.) GET /api/v1/store/pages

Delivery

Type Description Key endpoint(s)
delivery_stores Delivery availability result for a store (v4) POST /api/v4/deliveries/stores
addresses Request type for delivery store checks POST /api/v3/deliveries/stores

Notifications

Type Description Key endpoint(s)
devices A registered push notification device POST /api/v1/users/me/devices
notifications An informational/notification message Verification and recovery responses

Ads

Type Description Key endpoint(s)
recommendations Request type for sponsored product endpoints POST /api/v1/products/sponsored

Schemas

All schemas defined in components/schemas of the OpenAPI specification, grouped by domain.

JSON Envelope

These schemas define the standard JSON document structure used by all endpoints.

JsonApiDocument

Standard JSON response document.

  • data — JsonApiResource | JsonApiResource[] — The primary resource(s)
  • included — JsonApiResource[] — Sideloaded related resources
  • meta — JsonApiMeta — Pagination metadata

JsonApiResource

A single JSON resource object.

  • id — string — Unique identifier (UUID). Required
  • type — string — Resource type name (e.g. "products", "carts"). Required
  • attributes — object — Resource-specific fields. Required
  • relationships — object<string, JsonApiRelationship> — Related resources

JsonApiRelationship

A JSON relationship.

  • data — JsonApiResourceIdentifier | JsonApiResourceIdentifier[] | null — Related resource identifier(s)

JsonApiResourceIdentifier

A JSON resource identifier (type + id only).

  • id — string — Required
  • type — string — Required

JsonApiMeta

Pagination metadata.

  • total — integer — Total number of matching results
  • limit — integer — Maximum results per page
  • offset — integer — Current offset

JsonApiRequestBody

Standard JSON request body.

  • data.id — string — Resource ID (required for updates)
  • data.type — string — Resource type name. Required
  • data.attributes — object — Resource fields to create or update. Required
  • data.relationships — object<string, JsonApiRelationship> — Related resources

JsonApiErrorResponse

Standard JSON error response.

  • errors — JsonApiError[] — Array of error objects

JsonApiError

A single JSON error object.

  • code — string — Machine-readable error code (e.g. "bad_login", "not_found")
  • status — string — HTTP status code as a string (e.g. "400")
  • detail — string — Human-readable error message
  • source.pointer — string — JSON pointer to the field that caused the error (e.g. "/data/attributes/email")
  • extra_info — object — Additional error context (e.g. api_error_code, items)

Authentication

LoginRequest

  • data.type — string — Must be "users". Required
  • data.attributes.email — string (email) — User email (provide email OR phone_number)
  • data.attributes.phone_number — string — Phone number with country code (e.g. "+15551234567")
  • data.attributes.password — string (password) — User password. Required

LoginResponse

  • data.id — string
  • data.type — string — "users"
  • data.attributes.token — string — JWT access token
  • data.attributes.email — string
  • data.attributes.first_name — string
  • data.attributes.last_name — string

VerificationRequest

  • data.type — string — Must be "users". Required
  • data.attributes.phone_number — string — Phone number with country code
  • data.attributes.email — string (email) — Email address

VerificationCheckRequest

  • data.type — string — Must be "users". Required
  • data.attributes.code — string — Verification code received via SMS or email. Required
  • data.attributes.email — string (email)
  • data.attributes.phone_number — string
  • data.attributes.verification_mode — string — Verification mode (e.g. "sms", "email")
  • data.attributes.password — string (password)
  • data.attributes.password_confirmation — string (password)
  • data.attributes.first_name — string
  • data.attributes.last_name — string
  • data.attributes.date_of_birth — integer — Unix timestamp in milliseconds
  • data.attributes.marketing_source — string
  • data.attributes.marketing_email_opt_in — boolean
  • data.attributes.marketing_sms_opt_in — boolean
  • data.attributes.state_residency — string
  • data.attributes.identity_verification_id — string | null

RecoverPasswordRequest

  • data.type — string — Must be "users". Required
  • data.attributes.email — string (email) — Email address (provide email OR phone_number)
  • data.attributes.phone_number — string — Phone number with country code

ResetPasswordRequest

  • data.type — string — Must be "users". Required
  • data.attributes.password — string (password) — Required
  • data.attributes.password_confirmation — string (password) — Required
  • data.attributes.email — string (email)
  • data.attributes.phone_number — string
  • data.attributes.code — string — Verification code (when resetting via phone)

TokenResponse

  • data.id — string
  • data.type — string
  • data.attributes.token — string — JWT access token

NotificationResponse

  • data.id — string
  • data.type — string — "notifications"
  • data.attributes.message — string
  • data.attributes.level — string — One of: info, warning, error

Store

StoreAttributes

  • name — string — Store display name
  • slug — string — URL-friendly store identifier
  • address — string
  • city — string
  • state — string
  • zip_code — string
  • country — string
  • latitude — number (double)
  • longitude — number (double)
  • phone — string
  • email — string
  • is_active — boolean
  • point_of_sales — string — POS provider (blaze, treez, leaflogix, greenline, cova)
  • delivery_enabled — boolean
  • pickup_enabled — boolean
  • timezone — string — e.g. "America/Los_Angeles"

StoreSettingsResponse

  • data.type — string — "store_settings"
  • data.attributes — object — Dynamic key-value settings (varies per store configuration)

StoreConfigurationResponse

  • data.type — string — "store_configurations"
  • data.attributes — object — Store configuration fields including group and site data

ScheduleEntry

  • id — string
  • type — string — "schedules"
  • attributes.weekday — string — Day of the week (e.g. "monday")
  • attributes.is_closed — boolean
  • attributes.intervals — array — Open/close time intervals
    • start — string — Start time in HH format
    • end — string — End time in HH format

PaymentOptionAttributes

  • id — string
  • name — string
  • service — string — Payment provider service name
  • is_active — boolean
  • is_default — boolean
  • payment_type — string — Payment type (e.g. "credit_card", "debit", "cash")

SocialNetworkAttributes

  • name — string — Social network name (e.g. "instagram", "facebook")
  • url — string (uri)

StorePageAttributes

  • id — string
  • title — string
  • slug — string
  • content — string — Page content (may contain HTML)
  • is_active — boolean
  • position — integer

PromotionalBannerAttributes

  • id — string
  • title — string | null
  • subtitle — string | null
  • image_url — string (uri)
  • link_url — string | null
  • position — integer
  • is_active — boolean

AvailabilitySlot

  • date — string (date)
  • slots — array — Time slot list
    • start — string — Slot start time in HH format
    • end — string — Slot end time in HH format
    • available — boolean

Products

ProductAttributes

  • name — string — Product display name
  • slug — string — URL-friendly product identifier
  • sku — string — Stock keeping unit code
  • description — string — Product description (may contain HTML)
  • external_id — string — External ID from the POS system
  • type — string — Product type (e.g. "Hybrid", "Indica", "Sativa")
  • strain — string | null — Cannabis strain name
  • flower_type — string | null — Flower type classification
  • composition — string | null — Product form (e.g. "Flower", "Edible", "Concentrate")
  • thc — string | null — THC percentage or range
  • cbd — string | null — CBD percentage or range
  • min_cbd — number (double) | null — Minimum CBD percentage
  • potency — string | null — Overall potency level
  • terpenoids — string[] — List of terpenoid profiles
  • cannabis_weight — number (double) | null — Cannabis net weight
  • size — string | null — Product size label
  • main_image — string (uri) | null — URL to the main product image
  • in_stock — boolean — Whether the product is currently in stock
  • is_promoted — boolean — Whether the product is promoted/featured
  • discount — number (double) | null — Discount percentage
  • unit_price — number (double) | null — Base unit price
  • unit_prices — UnitPriceItem[] — Detailed pricing per unit/quantity
  • weight_prices — WeightPriceItem[] — Pricing per weight tier

UnitPriceItem

  • display_name — string — Human-readable label (e.g. "1 unit", "1/8 oz")
  • quantity — number (double)
  • price.amount — number (double)
  • price.currency — string — e.g. "USD"
  • discount_price — number (double) | null
  • savings_per_unit — number (double) | null

WeightPriceItem

  • weight — number (double)
  • weight_unit — string
  • price — number (double)
  • original_price — number (double) | null
  • in_stock — boolean

ProductVariant

  • id — string
  • name — string
  • price — number (double)
  • original_price — number (double)
  • weight — number (double)
  • weight_unit — string
  • in_stock — boolean
  • quantity_available — integer

CategoryAttributes

  • id — string
  • name — string
  • slug — string
  • description — string | null
  • count — integer — Number of products in this category
  • position — integer
  • is_active — boolean
  • icon_url — string (uri) | null
  • parent_category_id — string | null

BrandAttributes

  • id — string
  • name — string
  • slug — string
  • description — string | null
  • external_id — string | null
  • logo_url — string (uri) | null
  • count — integer — Number of products for this brand
  • is_promoted — boolean

TagAttributes

  • name — string
  • title — string | null
  • description — string | null
  • count — integer
  • position — integer
  • is_active — boolean
  • is_featured — boolean
  • is_hidden — boolean

TypeAttributes

  • id — string — Type identifier (e.g. "Hybrid")
  • name — string
  • count — integer

PriceRangeAttributes

  • min — number (double)
  • max — number (double)

ShowcasedGroupAttributes

  • name — string
  • slug — string
  • type — string — Showcase grouping type
  • description — string | null

Filters

FiltersV2Response

  • data.type — string — "filters"
  • data.attributes.price_ranges — PriceRangeAttributes — Min/max price range
  • data.attributes.weights — number[] — Available weight options
  • data.attributes.thc_ranges — object — THC range filter
    • min — number
    • max — number
    • unit — string
  • data.attributes.cbd_ranges — object — CBD range filter
    • min — number
    • max — number
    • unit — string
  • data.attributes.on_sale — object
    • count — integer
  • data.relationships.types — JsonApiRelationship
  • data.relationships.tags — JsonApiRelationship
  • data.relationships.categories — JsonApiRelationship
  • data.relationships.brands — JsonApiRelationship
  • included — JsonApiResource[] — Sideloaded types, tags, categories, brands

Cart

CartAttributes

  • status — string — Cart status (e.g. "open", "validated", "submitted")
  • delivery_type — string | null — Selected delivery type (e.g. "pickup", "delivery")
  • promo_codes — string[] — Applied promotional codes
  • reward_id — string | null — Applied reward ID
  • subtotal — number (double) | null — Cart subtotal before taxes and fees
  • total — number (double) | null — Cart total including taxes and fees
  • tax — number (double) | null — Total tax amount
  • discount — number (double) | null — Total discount amount
  • delivery_fee — number (double) | null — Delivery fee
  • item_count — integer — Number of items in the cart
  • delivery_specification — object | null — Delivery specification (address, time slot, delivery type)

CartCreateRequest

  • data.type — string — Must be "carts". Required
  • data.attributes.delivery_specification — object | null — Initial delivery specification
  • data.attributes.inventory_type — string | null — Inventory type preference (e.g. "delivery", "pickup")
  • data.attributes.conversion_breadcrumb — string | null — Conversion tracking breadcrumb
  • data.attributes.item — object — First item to add. Required
    • product_id — string — Product UUID. Required
    • quantity — integer — Quantity (minimum: 1). Required
    • weight — number (double) | null — Weight selection for weight-based products

CartUpdateRequest

  • data.id — string — Cart UUID. Required
  • data.type — string — Must be "carts". Required
  • data.attributes.promo_codes — string[] — Promotional codes to apply
  • data.attributes.reward_id — string | null — Reward ID to apply

CartItemRequest

  • data.id — string — Cart item UUID (required for updates)
  • data.type — string — Must be "cart_items". Required
  • data.attributes.product_id — string — Product UUID. Required
  • data.attributes.quantity — integer — Item quantity (minimum: 1). Required
  • data.attributes.weight — number (double) | null — Weight for weight-based products

CartItemAttributes

  • product_id — string — Product UUID
  • quantity — integer — Item quantity
  • weight — number (double) | null — Weight for weight-based products
  • unit_price — number (double) | null — Unit price
  • total_price — number (double) | null — Total price (unit_price × quantity)
  • discount — number (double) | null — Discount applied to this item

DeliverySpecificationRequest

  • data.id — string — Cart UUID. Required
  • data.type — string — Must be "carts". Required
  • data.attributes.delivery_specification — object — Required
    • type — string — Fulfillment type: "pickup", "delivery", or "kiosk". Required
    • mode — string — Delivery mode: "asap", "scheduled", or "express". Required (default: "asap")
    • address — object | null — Customer delivery address (required for delivery type)
      • address — string — Street address
      • address_line2 — string | null — Apartment, suite, unit
      • city — string
      • state — string | null
      • zip_code — string
      • country — string — (default: "US")
      • lat — number (double) | null — Required for geo-zone stores
      • lng — number (double) | null — Required for geo-zone stores
    • scheduled_start_time — string (date-time) | null — Required when mode is "scheduled"
    • scheduled_end_time — string (date-time) | null — Required when mode is "scheduled"
    • delivery_inventories — integer[] | null — Optional inventory IDs (for express delivery)

Delivery

DeliveryStoresRequest

  • data.type — string — Must be "addresses". Required
  • data.attributes.address — object — Delivery address
    • address — string — Street address
    • address_line2 — string | null
    • city — string
    • country — string
    • state — string
    • zip_code — string
    • lat — number (double) | null
    • lng — number (double) | null
  • data.attributes.preferred_inventories — string[] | null — Preferred inventory types
  • data.attributes.mode — string | null — Delivery mode filter

DeliveryStoreAttributes

Returned by the v4 delivery stores endpoint with detailed availability info.

  • delivery_zip_code — string | null — The zip code that was checked
  • available_products_at_zip_code_count — integer — Products available for delivery
  • open_schedule — boolean — Whether the delivery schedule is currently open
  • delivers_to_zip_code — boolean — Whether the store delivers to the given address
  • mode — string | null — Delivery mode this result applies to ("express", "scheduled", or null)
  • unavailable_reason — string | null — Reason the store cannot deliver ("not_delivering", "closed", "no_products", or null)
  • alternative_mode — string | null — An alternative delivery mode that is available
  • next_open_schedule — string (date-time) | null — Next time the delivery schedule opens
  • chosen_delivery_inventories — integer[] | null — Inventory IDs chosen for this delivery
  • available_delivery_inventories — integer[] | null — All inventory IDs available

Orders

OrderCreateRequest

  • data.type — string — Must be "orders". Required
  • data.attributes.cart_uuid — string — Cart UUID to convert into an order. Required
  • data.attributes.notes — string | null — Customer order notes

OrderAttributes

  • status — string — Order status (e.g. "pending", "confirmed", "completed", "cancelled")
  • order_number — string | null — Human-readable order number
  • subtotal — number (double) | null
  • total — number (double) | null
  • tax — number (double) | null
  • discount — number (double) | null
  • delivery_fee — number (double) | null
  • delivery_type — string | null — "pickup" or "delivery"
  • delivery_date — string | null — Scheduled delivery/pickup date
  • delivery_time_slot — string | null — Scheduled time slot
  • notes — string | null — Customer notes
  • created_at — string (date-time)
  • updated_at — string (date-time)

User

UserAttributes

  • email — string (email) | null
  • phone_number — string | null
  • first_name — string | null
  • last_name — string | null
  • zip_code — string | null
  • address — object | null — User address
  • billing_address — object | null — Billing address
  • date_of_birth — integer | null — Unix timestamp in milliseconds
  • marketing_email_opt_in — boolean | null
  • marketing_sms_opt_in — boolean | null
  • medical_id — object | null
    • number — string
    • expiration_date — string (date) | null
  • drivers_license_id — object | null
    • number — string
    • expiration_date — string (date) | null
  • customer_type — string | null
  • is_confirmed — boolean
  • is_active — boolean
  • token — string | null — JWT token (included in login/register responses)

UserUpdateRequest

  • data.type — string — Must be "users". Required
  • data.attributes.first_name — string
  • data.attributes.last_name — string
  • data.attributes.zip_code — string
  • data.attributes.address — object
  • data.attributes.billing_address — object
  • data.attributes.date_of_birth — integer — Unix timestamp in milliseconds
  • data.attributes.marketing_email_opt_in — boolean
  • data.attributes.marketing_sms_opt_in — boolean
  • data.attributes.medical_id — object — { number, expiration_date }
  • data.attributes.drivers_license_id — object — { number, expiration_date }

BillingAttributes

  • address — object | null
    • address — string
    • address_line2 — string | null
    • city — string
    • state — string
    • zip_code — string
    • country — string

BillingUpdateRequest

  • data.type — string — Must be "billing". Required
  • data.attributes.address — object
    • address — string
    • address_line2 — string | null
    • city — string
    • state — string
    • zip_code — string
    • country — string

LoyaltyAttributes

  • points — number | null — Current loyalty points balance
  • tier — string | null — Current loyalty tier
  • lifetime_points — number | null — Total points earned lifetime

IdentityVerificationAttributes

  • service — string — Verification service (e.g. "berbix")
  • status — string | null — Verification status
  • identity_verification_id — string | null — External verification ID
  • client_token — string | null — Client-side token for verification SDK

IdentityVerificationCreateRequest

  • data.type — string — Must be "identity_verifications". Required
  • data.attributes.identity_verification_id — string | null

Payments

PaymentSourceAttributes

  • external_id — string | null — External payment provider ID
  • token — string | null — Payment source token
  • last_four — string | null — Last four digits of card number
  • card_type — string | null — Card brand (e.g. "visa", "mastercard")
  • expiration_month — integer | null
  • expiration_year — integer | null
  • is_default — boolean — Whether this is the default payment source

PaymentSourceRequest

  • data.type — string — Must be "payment_sources". Required
  • data.attributes — object — Payment source fields (vary by provider)

PaymentChargeRequest

  • data.type — string — Must be "payments_charge". Required
  • data.attributes — object — Payment charge fields (vary by provider — may include source_id, token, nonce, amount)

TipRequest

  • data.type — string — Must be "payment_sources". Required
  • data.attributes.external_id — string — Order external ID
  • data.attributes.percentage — number — Tip percentage

RedeemablePromotionsRequest

  • data.type — string — Must be "payment_redeemable_promotions". Required
  • data.attributes.charge_amount — number — Charge amount to check promotions against

Deals

PromotionAttributes

  • name — string — Promotion name
  • slug — string — URL-friendly promotion identifier
  • description — string | null
  • image_url — string (uri) | null
  • discount_type — string | null — e.g. "percentage", "fixed_amount"
  • discount_value — number (double) | null
  • is_active — boolean
  • start_date — string (date-time) | null
  • end_date — string (date-time) | null

RewardAttributes

  • name — string — Reward name
  • slug — string — URL-friendly reward identifier
  • description — string | null
  • image_url — string (uri) | null
  • points_required — integer | null — Points required to redeem
  • discount_type — string | null — e.g. "percentage", "fixed_amount"
  • discount_value — number (double) | null
  • is_active — boolean

Notifications

DeviceRegistrationRequest

  • data.type — string — Must be "devices". Required
  • data.attributes.device_token — string — Push notification device token
  • data.attributes.platform — string — Device platform (e.g. "ios", "android", "web")

Ads & Sponsored

SponsoredRequestBody

Request body for sponsored product endpoints.

  • data.type — string — Must be "recommendations". Required
  • data.attributes.url — string — Current page URL
  • data.attributes.screen — object
    • height — integer
    • width — integer
  • data.attributes.navigator — object
    • user_agent — string
    • language — string
  • data.attributes.mobile — boolean
  • data.attributes.account_id — string | null
  • data.attributes.site_id — string | null
  • data.attributes.channel_id — string | null
  • data.attributes.channel_type — string | null
  • data.attributes.zone_id — string | null
  • data.attributes.client_ip — string | null
  • data.attributes.surfside_domain_id — string | null
  • data.attributes.session_id — string | null
  • data.attributes.store_location_data — object | null
  • data.attributes.location_data — object | null
    • zip — string | null
    • country — string | null
    • city — string | null
    • region — string | null
    • utc_offset — string | null
    • timezone — string | null
    • coords — object
      • latitude — number | null
      • longitude — number | null
      • accuracy — number | null

Webhooks

WebhookPayload

Generic webhook inbound payload. Content varies by event type — the schema uses additionalProperties: true.

Enums

All enumerated values used across the API.

delivery_type

Fulfillment type for carts and orders.

  • pickup — Customer picks up at the store
  • delivery — Store delivers to the customer's address
  • kiosk — Order placed at an in-store kiosk

delivery_mode

Delivery timing mode.

  • asap — Fulfill as soon as possible
  • scheduled — Fulfill at a chosen time slot (requires scheduled_start_time and scheduled_end_time)
  • express — Express delivery (requires geo-zone support)

order_status

Order lifecycle status values.

  • pending — Order placed, awaiting confirmation
  • confirmed — Order confirmed by the store
  • ready_for_pickup — Order is ready for customer pickup
  • completed — Order fulfilled
  • cancelled — Order cancelled

cart_status

Cart lifecycle status values.

  • open — Cart is active and editable
  • validated — Cart has been validated and is ready for checkout
  • submitted — Cart has been converted to an order

schedule_type

Type of schedule to query.

  • pickup — Pickup schedule
  • delivery — Delivery schedule
  • operating — General operating hours

point_of_sales

Supported POS (Point of Sale) providers.

  • blaze — Blaze POS
  • treez — Treez POS
  • leaflogix — LeafLogix POS
  • greenline — Greenline POS
  • cova — Cova POS

payment_type

Payment method types.

  • credit_card — Credit card
  • debit — Debit card
  • cash — Cash payment

payment_service

Payment provider service names.

  • stronghold — Stronghold
  • moneris — Moneris
  • adyen — Adyen
  • aeropay — Aeropay
  • swifter — Swifter
  • ledgergreen — LedgerGreen
  • greenbax — Greenbax
  • merrco — Merrco
  • spence — Spence
  • cash — Cash (no provider)

discount_type

Discount calculation types.

  • percentage — Percentage discount (e.g. 20% off)
  • fixed_amount — Fixed dollar amount discount (e.g. $5 off)

notification_level

Notification severity levels.

  • info — Informational message
  • warning — Warning message
  • error — Error message

unavailable_reason

Reasons a store cannot deliver to an address.

  • not_delivering — Store does not deliver to this area
  • closed — Store delivery schedule is currently closed
  • no_products — No products available for delivery at this address

device_platform

Push notification device platforms.

  • ios — Apple iOS
  • android — Android
  • web — Web browser

identity_verification_service

Supported identity verification services.

  • berbix — Berbix identity verification

Common Query Parameters

Parameters available across multiple endpoints for filtering, sorting, and pagination.

Pagination

  • limit — integer — Maximum number of results to return. Default: 20. Min: 1, Max: 100
  • offset — integer — Number of results to skip. Default: 0. Min: 0

Sorting

  • order — string — Sort order for results. Common values:
    • name_asc — Sort by name ascending
    • name_desc — Sort by name descending
    • price_asc — Sort by price ascending
    • price_desc — Sort by price descending

Product Filters

These parameters are available on product listing endpoints (GET /api/v1/products, POST /api/v1/products/sponsored):

  • category — string — Filter by category slug or ID
  • subcategory — string — Filter by subcategory
  • product_type — string — Filter by product type (e.g. "flower", "edible")
  • brand — string — Filter by brand slug or ID
  • tags — string — Filter by tag (comma-separated for multiple)
  • min_price — number — Minimum price filter
  • max_price — number — Maximum price filter
  • search — string — Full-text search query

Available on sponsored product endpoints:

  • type — string — Filter by product type
  • tag — string — Filter by tag
  • q — string — Full-text search query

Other Filters

  • delivery_type — string — Filter payment options by delivery type (pickup or delivery). Used on GET /api/v1/store/payment-options

Headers

Required Headers

  • X-Store — string (uuid) — The UUID of the store to scope the request to. Required on all store-scoped endpoints.

    • Example: X-Store: e87437f2-3e35-4738-af5e-6307e368255c

  • Content-Type — string — Must be application/vnd.api+json for all request bodies.

  • Accept — string — Should be application/vnd.api+json for all requests.

Conditional Headers

  • Authorization — string — JWT Bearer token for authenticated endpoints. Format: Bearer {token}.

    • Example: Authorization: Bearer eyJhbGciOiJIUzI1NiJ9...

  • X-Group — string (uuid) — The UUID of the group. Required on group-scoped endpoints (e.g. GET /api/v1/groups/stores).

    • Example: X-Group: a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • X-Kiosk — string (uuid) — The UUID of the kiosk device. Required for kiosk-specific endpoints.

    • Example: X-Kiosk: k1o2s3k4-u5u6-i7d8-9012-abcdef123456
Previous
Error Catalog