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

CRB Sales

Operations

Get sales for service provider's CRB

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
start_datestring^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|...

Start Date: yyyy-MM-dd

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

End Date: yyyy-MM-dd

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

Customer ID, our internal customer ID available on retail POS only

pos_customer_idstring

POS Customer ID, the customer ID internal to the specific POS, works available for both retail and wholesale POS

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}/sales?limit=1000&offset=0&start_date=string&end_date=string&customer_id=string&pos_customer_id=string&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
Any of:
data[].​idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
data[].​pos_sale_idstring or nullrequired

Sale ID in the POS system

data[].​crb_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
data[].​subtotalnumber or null(double)required

Pre-tax dollar amount in cents

data[].​total_discountsnumber or null(double)required

Total discount amount in cents

data[].​tax_paidnumber or null(double)required

Tax amount in cents

data[].​total_paidnumber or null(double)required

Price + Tax in cents

data[].​datestring(date-time)required
data[].​local_datestring^[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[].​transaction_typestring or nullrequired

Transaction Type provided by point of sale

Enum"sale""return""adjustment"
data[].​pos_namestringrequired
Enum"Alleaves""Dutchie""Dutchie Wholesale""Cova""Meadow""MJ Freeway""MJ Freeway Wholesale""Greenbits""GrowFlow""GrowFlow Wholesale"
data[].​typestringrequired
Value"retail"
data[].​line_itemsArray of objectsrequired

Sale Line Items

data[].​line_items[].​product_idstring or null(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required

The unique ID of the product, can be accessed with /product endpoints

data[].​line_items[].​pos_product_idstring or nullrequired

The product ID in the POS system

data[].​line_items[].​product_namestring or nullrequired

Name in POS system

data[].​line_items[].​num_unitsnumber or null(double)required

Number of units bought

data[].​line_items[].​price_per_unitnumber or null(double)required

Price per individual unit

data[].​line_items[].​gramsnumber or null(double)required

Weight of product in grams

data[].​line_items[].​product_typestring or nullrequired

GCV mapped product type

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

Whether product contains cannabis

data[].​line_items[].​line_item_discountsArray of objectsrequired

Line item specific discounts

data[].​line_items[].​line_item_discounts[].​flat_amountnumber or null(double)required

Discount amount in cents

data[].​line_items[].​line_item_discounts[].​pct_amountnumber or null(double)required

Discount percentage as a real number

data[].​line_items[].​line_item_discounts[].​namestring or nullrequired

Name of discount

data[].​line_items[].​line_item_taxesArray of objectsrequired

Line item specific taxes

data[].​line_items[].​line_item_taxes[].​flat_amountnumber or null(double)required

Tax amount in cents

data[].​line_items[].​line_item_taxes[].​pct_amountnumber or null(double)required

Tax percentage as a real number

data[].​line_items[].​line_item_taxes[].​namestring or nullrequired

Name of tax

data[].​line_items[].​line_item_feesArray of objectsrequired

Line item specific fees

data[].​line_items[].​line_item_fees[].​fee_namestring or nullrequired

Name of the fee

data[].​line_items[].​line_item_fees[].​percent_amountnumber or null(double)required

Fee percentage as a real number

data[].​line_items[].​line_item_fees[].​flat_amountnumber or null(double)required

Flat amount of fee in cents

data[].​line_items[].​line_item_fees[].​included_in_subtotalboolean or nullrequired

True if this fee's calculation is included in the subtotal

data[].​discountsArray of objectsrequired

Sale Discounts

data[].​discounts[].​flat_amountnumber or null(double)required

Discount amount in cents

data[].​discounts[].​pct_amountnumber or null(double)required

Discount percentage as a real number

data[].​discounts[].​namestring or nullrequired

Name of discount

data[].​taxesArray of objectsrequired

Sale Taxes

data[].​taxes[].​flat_amountnumber or null(double)required

Tax amount in cents

data[].​taxes[].​pct_amountnumber or null(double)required

Tax percentage as a real number

data[].​taxes[].​namestring or nullrequired

Name of tax

data[].​paymentsArray of objectsrequired

Payment type and amount

data[].​payments[].​typestringrequired
Enum"cash""check""debit""credit""multiple""ach""wire""other""unknown"
data[].​payments[].​amount_paidnumber(double)required

Amount in cents for this payment type

data[].​customerobjectrequired
data[].​customer.​customer_idstring or null(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required

Green Check Customer ID

data[].​customer.​pos_customer_idstring or nullrequired

The customer ID in the POS system

data[].​customer.​typestring or nullrequired

Is Sale Medical or Adult Use

Enum"medical""rec"
data[].​customer.​dobstring or nullrequired

Customer Date of Birth yyyy-MM-dd

data[].​customer.​id_typestring or nullrequired

Customer ID Type

Enum"drivers""medical""ssn""passport""medical_with_rec""medical_with_state_card""caregiver""minor_medical""temporary_minor_medical""temporary_adult"
data[].​customer.​id_expiration_datestring or nullrequired

Customer ID Expiration Date

data[].​feesArray of objectsrequired

Sale Fees

data[].​fees[].​fee_namestring or nullrequired

Name of the fee

data[].​fees[].​percent_amountnumber or null(double)required

Fee percentage as a real number

data[].​fees[].​flat_amountnumber or null(double)required

Flat amount of fee in cents

data[].​fees[].​included_in_subtotalboolean or nullrequired

True if this fee's calculation is included in the subtotal

data[].​compliance_statusstring or nullrequired

Green Check Verified compliance status

Enum"unchecked""red_flag""green_checked""warning"
data[].​compliance_exceptionsArray of strings or nullrequired

Compliance Exceptions

data[].​compliance_warningsArray of strings or nullrequired

Compliance Warnings

data[].​employee_idstring or null

Employee ID

Response
application/json
{
  "data": [
    {
      "type": "retail",
      "customer": {
        "customer_id": null,
        "pos_customer_id": "sint in cupidatat in elit",
        "type": "rec",
        "dob": "1960-07-29T00:00:00.000Z",
        "id_type": "medical",
        "id_expiration_date": "2025-11-08T00:00:00.000Z"
      },
      "compliance_status": "warning",
      "compliance_exceptions": [
        "Excepteur culpa commodo sit voluptate",
        "proident nisi officia Excepteur eu",
        "irure consequat in nisi aute"
      ],
      "compliance_warnings": [
        "velit voluptate",
        "cupidatat in nisi esse do"
      ],
      "id": "870cb44e-A5A4-dED8-BA29-BdBeEB1eD677",
      "pos_sale_id": null,
      "crb_id": "F9F6F024-A7CB-8154-0cb2-3Ca5EBE7Fd37",
      "subtotal": 4050,
      "total_discounts": 10300,
      "tax_paid": 49,
      "total_paid": 10000,
      "date": "2023-10-30T13:57:30.000Z",
      "local_date": "2023-10-31T15:21:57.167Z",
      "gc_created_date": "2023-10-31T15:18:22.000Z",
      "gc_updated_date": "2023-09-18T20:57:34.000Z",
      "transaction_type": "return",
      "pos_name": "Treez",
      "employee_id": null,
      "line_items": [
        {
          "product_id": null,
          "pos_product_id": "qui ullamco dolor fugiat",
          "product_name": "Preroll Bulk - GG2B",
          "num_units": 2,
          "price_per_unit": 12500,
          "grams": 1,
          "product_type": "flower",
          "cannabis_product": null,
          "line_item_discounts": [
            {
              "flat_amount": 19000,
              "pct_amount": 0.08,
              "name": "Employee"
            }
          ],
          "line_item_taxes": [
            {
              "flat_amount": 22914,
              "pct_amount": 0.95,
              "name": "County - 2.5"
            }
          ],
          "line_item_fees": [
            {
              "fee_name": "Card fee",
              "percent_amount": 0.95,
              "flat_amount": 375,
              "included_in_subtotal": null
            },
            {
              "fee_name": "Card fee",
              "percent_amount": 0.08,
              "flat_amount": 375,
              "included_in_subtotal": null
            },
            {
              "fee_name": "Donation",
              "percent_amount": 0.95,
              "flat_amount": 500,
              "included_in_subtotal": null
            },
            {
              "fee_name": "Donation",
              "percent_amount": 0.25,
              "flat_amount": 375,
              "included_in_subtotal": null
            },
            {
              "fee_name": "Card fee",
              "percent_amount": 0.95,
              "flat_amount": 500,
              "included_in_subtotal": false
            }
          ]
        },
        {
          "product_id": "in eu",
          "pos_product_id": "in minim reprehenderit consectetur cillum",
          "product_name": "Rocket Fuel .85 Cart",
          "num_units": 7,
          "price_per_unit": 4500,
          "grams": 3.5,
          "product_type": "other",
          "cannabis_product": null,
          "line_item_discounts": [
            {
              "flat_amount": 22914,
              "pct_amount": 0.08,
              "name": "Buy two - $5 discount"
            },
            {
              "flat_amount": 6480,
              "pct_amount": 0.95,
              "name": "Employee"
            }
          ],
          "line_item_taxes": [
            {
              "flat_amount": 10000,
              "pct_amount": 0.08,
              "name": "State"
            },
            {
              "flat_amount": 22914,
              "pct_amount": 0.25,
              "name": "County - 2.5"
            },
            {
              "flat_amount": 4050,
              "pct_amount": 0.25,
              "name": "County - 2.5"
            }
          ],
          "line_item_fees": [
            {
              "fee_name": "Card fee",
              "percent_amount": 0.95,
              "flat_amount": 375,
              "included_in_subtotal": null
            }
          ]
        }
      ],
      "discounts": [],
      "taxes": [
        {
          "flat_amount": 6480,
          "pct_amount": 0.25,
          "name": "State"
        },
        {
          "flat_amount": 4880,
          "pct_amount": 0.25,
          "name": "County - 2.5"
        },
        {
          "flat_amount": 5240,
          "pct_amount": 0.25,
          "name": "State"
        },
        {
          "flat_amount": 10000,
          "pct_amount": 0.95,
          "name": "State"
        },
        {
          "flat_amount": 6480,
          "pct_amount": 0.25,
          "name": "State"
        }
      ],
      "payments": [
        {
          "type": "store_credit",
          "amount_paid": 6176
        },
        {
          "type": "cash",
          "amount_paid": 23046
        },
        {
          "type": "check",
          "amount_paid": 35000
        }
      ],
      "fees": []
    }
  ],
  "metadata": {
    "count": "100 - 172",
    "total": 40836116
  }
}

CRB Templates

Operations

CRB

Operations

Customers

Operations

Documents

Operations

Inventory

Operations

Inventory Locations

Operations

Products

Operations

Sales

Operations