Get products for offer

skip

number | null

≥ 0

For use with paging. Number of records to skip when returning.

i.e., if there are 20 records and you want 5 at a time, your first skip would be 0, second would be 5, third would be 10, etc.

limit

number | null

0 to 250

For use with paging. Total number of records to return. Default limit is 100 and max limit is 250

sort

enum

Enables sorting of products in response. A - indicates descending order.

venueId

string

required

cannabisComplianceType

enum

categoryId

Filter by the category id of the product

featured

boolean

Filter by products with a featured flag

new

boolean

Filter by products with a new flag

group

boolean

Filter by products associated with a group

subType

Filter by the product's sub-category

brand

Filter by the name of product's brand

Can be a string or array of strings

cannabisStrain

Filter by the cannabis strain of the product

terpenes

enum

Filter by the terpene content of the product.

cannabisType

enum

Filter by the cannabis type. i.e., HYBRID, INDICA.

Can be a string or array of strings

effects

enum

Filter by the effects associated with the products

active

boolean

Filter by products active/inactive status

quantityMax

number

Filter by products with at most this many in stock

weightFormatted

Filter by the formatted weight of the product. i.e., 3.5g, 100mg

Can be a string or array of strings

tagId

Filter by the product tag id of the product

createdStart

string

Filter by products created on or after this date

To filter for a specific date, use a combination of createdStart and createdEnd. For example, to query for only 1/1/2023, you would pass ?createdStart=2023-01-01T00:00&createdEnd=2023-01-01T23:59.

To query for a range of dates, you would pass the starting date for createdStart and ending date for createdEnd. For example, to query for the range 1/1/2023-1/5/2023, you would pass ?createdStart=2023-01-01T00:00&createdEnd=2023-01-05T23:59

createdEnd

string

Filter by products created on or before this date

To filter for a specific date, use a combination of createdStart and createdEnd. For example, to query for only 1/1/2023, you would pass ?createdStart=2023-01-01T00:00&createdEnd=2023-01-01T23:59.

To query for a range of dates, you would pass the starting date for createdStart and ending date for createdEnd. For example, to query for the range 1/1/2023-1/5/2023, you would pass ?createdStart=2023-01-01T00:00&createdEnd=2023-01-05T23:59

modifiedStart

string

Filter by products modified on or after this date

To filter for a specific date, use a combination of modifiedStart and modifiedEnd. For example, to query for only 1/1/2023, you would pass ?modifiedStart=2023-01-01T00:00&modifiedEnd=2023-01-01T23:59.

To query for a range of dates, you would pass the starting date for modifiedStart and ending date for modifiedEnd. For example, to query for the range 1/1/2023-1/5/2023, you would pass ?modifiedStart=2023-01-01T00:00&modifiedEnd=2023-01-05T23:59

modifiedEnd

string

Filter by products modified on or before this date

To filter for a specific date, use a combination of modifiedStart and modifiedEnd. For example, to query for only 1/1/2023, you would pass ?modifiedStart=2023-01-01T00:00&modifiedEnd=2023-01-01T23:59.

To query for a range of dates, you would pass the starting date for modifiedStart and ending date for modifiedEnd. For example, to query for the range 1/1/2023-1/5/2023, you would pass ?modifiedStart=2023-01-01T00:00&modifiedEnd=2023-01-05T23:59

200Products

defaultunexpected error