Skip to content

Green Check Access (1.0.0)

Green Check Access

Overview
Languages
Servers
Mock server
https://developer.greencheckverified.com/_mock/apis/swagger
Sandbox server
https://sandbox-api.greencheckverified.com
Production server
https://prod-api.greencheckverified.com

Authentication

Operations

Service Provider

Operations

CRB Info

Operations

CRB Customers

Operations

CRB Documents

Operations

CRB Inventory

Operations

CRB Inventory Locations

Operations

CRB Products

Operations

Get CRB products

Request

Security
access_auth
Path
sp_idstring^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required

Service Provider Id

crb_idstring^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required

CRB Id

Query
limitinteger(int32)[ 1 .. 1000 ]

The page size

Default 1000
offsetinteger(int32)>= 0

The page offset

Default 0
last_updated_fromstring^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|...

Last updated from date: yyyy-MM-dd

last_updated_tostring^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|...

Last updated to date: yyyy-MM-dd

curl -i -X GET \
  'https://developer.greencheckverified.com/_mock/apis/swagger/service-providers/{sp_id}/crbs/{crb_id}/products?limit=1000&offset=0&last_updated_from=string&last_updated_to=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
metadataobjectrequired
metadata.​totalinteger(int32)>= 0required
metadata.​countstringrequired

Range of items returned

dataArray of objectsrequired
data[].​crb_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
data[].​idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
data[].​pos_product_idstringrequired

Product ID in the POS system

data[].​pos_typestringrequired
Enum"Alleaves""Dutchie""Dutchie Wholesale""Cova""Meadow""MJ Freeway""MJ Freeway Wholesale""Greenbits""GrowFlow""GrowFlow Wholesale"
data[].​namestringrequired

The name of the product.

data[].​gc_product_category_namestring or nullrequired
Enum"flower""oil/concentrate""edible""other""seedling""seed""liquid""solid""extract""plant"
data[].​pos_product_category_namestring or nullrequired

Category name as given by the POS.

data[].​pos_product_subcategory_namestring or nullrequired

Subcategory name as given by the POS.

data[].​pos_strain_namestring or nullrequired

Strain name as given by the POS.

data[].​pos_brand_namestring or nullrequired

Brand name as given by the POS.

data[].​medicatedboolean or nullrequired

True or false if this is a THC having marijuana product.

data[].​skustring or nullrequired

The SKU for the product.

data[].​descriptionstring or nullrequired

Product description.

data[].​gc_net_weight_gramsnumber or null(double)>= 0required
data[].​pos_unit_of_measurestring or nullrequired

The unit of measure of the product as sold by the POS (weight, quantity, etc).

data[].​priceinteger or null(int32)>= 0required
data[].​unit_costnumber or null(double)>= 0required
data[].​pos_updated_datestring or null(date-time)required
data[].​pos_updated_date_localstring or null^[2][0][0-9]{2}[-]([0][0-9]|[1][0-2])[-]([0-2...required
data[].​gc_created_datestring(date-time)required
data[].​gc_updated_datestring(date-time)required
data[].​price_tiersArray of objects or nullrequired

Price tiers applied to this product. May or may not be provided by the POS system.

data[].​price_tiers[].​tier_namestring or nullrequired

Price Tier name, if any

data[].​price_tiers[].​tier_priceinteger(int32)>= 0required
data[].​price_tiers[].​pos_tier_typestringrequired

The type of tier condition from the pos system (like quantity or volume)

data[].​price_tiers[].​pos_tier_type_condition_valuestringrequired

The condition(s) required (based on the tier type) to apply this tier on the product

data[].​price_tiers[].​tier_valid_until_datestring or null(date-time)required
data[].​price_tiers[].​tier_valid_until_date_localstring or null^[2][0][0-9]{2}[-]([0][0-9]|[1][0-2])[-]([0-2...required
data[].​imagesArray of objects or nullrequired

A list of any images associated with this product.

data[].​images[].​urlstringrequired

URL to the image file

data[].​images[].​descriptionstring or nullrequired

Any description provided by the POS like file name, dimensions, product description

Response
application/json
{ "data": [ { "crb_id": "a0a470C5-FC6d-DBF4-aD92-1d12DDe6bdaD", "id": "fBFb3EBB-85F7-59fc-B156-FC34248C7AED", "pos_product_id": "dolore dolor", "pos_type": "MJ Freeway Wholesale", "name": "Bulk Batter (GG4)", "gc_product_category_name": "seed", "pos_product_category_name": "Infused Flower", "pos_product_subcategory_name": "Candy Bar", "pos_strain_name": "Purple Haze", "pos_brand_name": "Hill Fire Cannabis", "medicated": true, "sku": "12894689", "description": "Night Rider is a hybrid strain created by Greenpoint Seeds.", "gc_net_weight_grams": 53400647.73727114, "pos_unit_of_measure": "Wgt", "price": null, "unit_cost": 85480502.20644382, "pos_updated_date": null, "pos_updated_date_local": "2023-09-18T20:57:34.917Z", "gc_created_date": "2023-09-18T20:57:34.000Z", "gc_updated_date": "2023-09-18T20:57:34.000Z", "price_tiers": null, "images": [ { "url": "aute laborum ut incididunt anim", "description": "dolor aliqua in non" }, { "url": "in nulla Lorem ullamco", "description": null }, { "url": "non elit qui aute", "description": "amet incididunt magna quis" } ] }, { "crb_id": "CAFeb07A-BF12-ae4f-Fe6C-1334A64eb27e", "id": "5db4FBCf-D2c8-7598-aA52-c6585FAfF8Be", "pos_product_id": "eiusmod ut", "pos_type": "Flourish Wholesale", "name": "Kief Bulk - Blissful Wizard", "gc_product_category_name": null, "pos_product_category_name": "Infused Flower", "pos_product_subcategory_name": "Concentrate-Chemical-Cured Badder", "pos_strain_name": "Kush Berry", "pos_brand_name": "Hill Fire Cannabis", "medicated": false, "sku": "23895623", "description": "A 20 pack of 5mg sativa gummies.", "gc_net_weight_grams": 83476801.59819597, "pos_unit_of_measure": "Qty", "price": null, "unit_cost": 56903494.744833805, "pos_updated_date": "2023-10-28T17:31:35.563Z", "pos_updated_date_local": "2023-10-31T15:21:57.167Z", "gc_created_date": "2023-10-28T17:31:35.000Z", "gc_updated_date": "2023-02-28T14:01:33.000Z", "price_tiers": null, "images": null }, { "crb_id": "69BE49Ae-bF05-4dCB-2fbf-B79f10b665Ee", "id": "45C9ec2e-1DDF-C1d5-0A95-b7A1D6bDa761", "pos_product_id": "quis anim laborum non", "pos_type": "Blaze", "name": "Blue Raspberry Gummies - 10 Pieces", "gc_product_category_name": null, "pos_product_category_name": "Infused Flower", "pos_product_subcategory_name": "Packaging - Infusions", "pos_strain_name": "Pineapple Upside Down Cake x Fisheye OG", "pos_brand_name": "Verano", "medicated": null, "sku": "12385689", "description": "These pre-rolls are perfect for a portable smoking experience", "gc_net_weight_grams": null, "pos_unit_of_measure": "Qty", "price": null, "unit_cost": null, "pos_updated_date": null, "pos_updated_date_local": null, "gc_created_date": "2023-09-18T20:57:34.000Z", "gc_updated_date": "2023-02-28T14:01:33.000Z", "price_tiers": [ { "tier_name": "Bulk Flower Deals", "tier_price": 48971419, "pos_tier_type": "Quantity", "pos_tier_type_condition_value": "3.5 - 7", "tier_valid_until_date": "2023-10-31T15:18:22.650Z", "tier_valid_until_date_local": null }, { "tier_name": "Weight Tiers", "tier_price": 24346141, "pos_tier_type": "Weight", "pos_tier_type_condition_value": "10", "tier_valid_until_date": null, "tier_valid_until_date_local": null }, { "tier_name": "Free Offers", "tier_price": 90152257, "pos_tier_type": "Quantity", "pos_tier_type_condition_value": "Special Offer", "tier_valid_until_date": "2023-10-31T15:18:22.650Z", "tier_valid_until_date_local": "2023-10-31T15:18:22.652Z" } ], "images": [] }, { "crb_id": "0d5108b8-17dd-bC78-aFaB-8De6DD0050F9", "id": "b9bE6BcE-D26E-Da19-bef7-Ebf15Acdd5A0", "pos_product_id": "id proident voluptate", "pos_type": "Proteus420", "name": "Plant Material - Cuvée", "gc_product_category_name": "edible_liquid", "pos_product_category_name": "Infused Flower", "pos_product_subcategory_name": "Mad Terps - Terpstix", "pos_strain_name": "Pineapple Upside Down Cake x Fisheye OG", "pos_brand_name": "Avexia", "medicated": null, "sku": "12894689", "description": "Grand Daddy Purple (or GDP) is a famous indica cross between Purple Urkle and Big Bud. This California staple has a complex grape and berry aroma, with potent effects that deliver a fusion of cerebral euphoria and physical relaxation.", "gc_net_weight_grams": { "description": "Our calculated net weight of the product in grams." }, "pos_unit_of_measure": "Qty", "price": null, "unit_cost": { "description": "Unit cost of the product in cents. Can be null if not supplied by the POS." }, "pos_updated_date": { "description": "The timestamp reported by the POS for the last update to this record in UTC." }, "pos_updated_date_local": { "description": "The timestamp reported by the POS for the last update to this record in the CRB local time." }, "gc_created_date": "2023-10-31T15:18:22.000Z", "gc_updated_date": "2023-02-28T14:01:33.000Z", "price_tiers": null, "images": [] } ], "metadata": { "count": "100 - 172", "total": 31151383 } }

Get CRB product record by ID

Request

Security
access_auth
Path
sp_idstring^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required

Service Provider Id

crb_idstring^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required

CRB Id

product_idstring^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required

Product Id

curl -i -X GET \
  'https://developer.greencheckverified.com/_mock/apis/swagger/service-providers/{sp_id}/crbs/{crb_id}/products/{product_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
crb_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
pos_product_idstringrequired

Product ID in the POS system

pos_typestringrequired
Enum"Alleaves""Dutchie""Dutchie Wholesale""Cova""Meadow""MJ Freeway""MJ Freeway Wholesale""Greenbits""GrowFlow""GrowFlow Wholesale"
namestringrequired

The name of the product.

gc_product_category_namestring or nullrequired
Enum"flower""oil/concentrate""edible""other""seedling""seed""liquid""solid""extract""plant"
pos_product_category_namestring or nullrequired

Category name as given by the POS.

pos_product_subcategory_namestring or nullrequired

Subcategory name as given by the POS.

pos_strain_namestring or nullrequired

Strain name as given by the POS.

pos_brand_namestring or nullrequired

Brand name as given by the POS.

medicatedboolean or nullrequired

True or false if this is a THC having marijuana product.

skustring or nullrequired

The SKU for the product.

descriptionstring or nullrequired

Product description.

gc_net_weight_gramsnumber or null(double)>= 0required
pos_unit_of_measurestring or nullrequired

The unit of measure of the product as sold by the POS (weight, quantity, etc).

priceinteger or null(int32)>= 0required
unit_costnumber or null(double)>= 0required
pos_updated_datestring or null(date-time)required
pos_updated_date_localstring or null^[2][0][0-9]{2}[-]([0][0-9]|[1][0-2])[-]([0-2...required
gc_created_datestring(date-time)required
gc_updated_datestring(date-time)required
price_tiersArray of objects or nullrequired

Price tiers applied to this product. May or may not be provided by the POS system.

price_tiers[].​tier_namestring or nullrequired

Price Tier name, if any

price_tiers[].​tier_priceinteger(int32)>= 0required
price_tiers[].​pos_tier_typestringrequired

The type of tier condition from the pos system (like quantity or volume)

price_tiers[].​pos_tier_type_condition_valuestringrequired

The condition(s) required (based on the tier type) to apply this tier on the product

price_tiers[].​tier_valid_until_datestring or null(date-time)required
price_tiers[].​tier_valid_until_date_localstring or null^[2][0][0-9]{2}[-]([0][0-9]|[1][0-2])[-]([0-2...required
imagesArray of objects or nullrequired

A list of any images associated with this product.

images[].​urlstringrequired

URL to the image file

images[].​descriptionstring or nullrequired

Any description provided by the POS like file name, dimensions, product description

Response
application/json
{ "crb_id": "cfB07ECA-B4B8-F28C-5C1a-4D947d9aeCd0", "id": "C3616F4d-1bC4-F15c-D4cB-f5cf3CD3b6fe", "pos_product_id": "ex nostrud officia veniam dolor", "pos_type": "Flourish Wholesale", "name": "Rudeboi OG", "gc_product_category_name": "marijuana_product", "pos_product_category_name": "Non-Cannabis Retail", "pos_product_subcategory_name": "Candy Bar", "pos_strain_name": "Kush Berry", "pos_brand_name": "RAD", "medicated": null, "sku": "10563228", "description": "Night Rider is a hybrid strain created by Greenpoint Seeds.", "gc_net_weight_grams": null, "pos_unit_of_measure": "Qty", "price": 99695789, "unit_cost": 31465209.30971566, "pos_updated_date": null, "pos_updated_date_local": null, "gc_created_date": "2023-10-31T15:18:22.000Z", "gc_updated_date": "2023-09-18T20:57:34.000Z", "price_tiers": [ { "tier_name": "Bulk Flower Deals", "tier_price": 67298294, "pos_tier_type": "Quantity", "pos_tier_type_condition_value": "1 - 3.5", "tier_valid_until_date": null, "tier_valid_until_date_local": "2023-10-31T15:21:57.167Z" } ], "images": null }

CRB Sales

Operations

CRB Templates

Operations

CRB

Operations

Customers

Operations

Documents

Operations

Inventory

Operations

Inventory Locations

Operations

Products

Operations

Sales

Operations