Skip to content
/
Get Inventory by Location

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

CRB Templates

Operations

CRB

Operations

Customers

Operations

Documents

Operations

Inventory

Operations

Get CRB inventory record by ID

Request

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

CRB Id

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

Inventory Id

Query
expandboolean

Expands the response by including product data related to this resource

curl -i -X GET \
  'https://developer.greencheckverified.com/_mock/apis/swagger/crbs/{crb_id}/inventory/{inventory_id}?expand=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
Any of:
idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
crb_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
pos_typestringrequired
Enum"Alleaves""Apex Trading Wholesale""Dutchie""Dutchie Wholesale""Cova""Meadow""MJ Freeway""MJ Freeway Wholesale""Greenbits""GrowFlow"
product_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
namestringrequired

Name of the product

skustring or nullrequired

SKU for the product. May or may not be provided by the POS

barcodestring or nullrequired

The tag from the track and trace system that uniquely identifies this product for tracking purposes. May or may not be provided by the POS

total_quantitynumber(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
location_dataArray of objects

Location specific quantities. Not all POS systems support location data.

location_data[].​namestring or nullrequired

Location name

location_data[].​quantityinteger(int32)>= 0required
location_data[].​location_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
location_data[].​pos_location_typestring or nullrequired

Type of location

Response
application/json
{
  "id": "B1e8af91-b802-C1fC-2B39-1DD503de8a65",
  "crb_id": "492ebB2c-0BfC-91a8-FAee-7A1309DeFaE7",
  "pos_type": "Cova",
  "product_id": null,
  "name": "Blue Raspberry Gummies - 10 Pieces",
  "sku": "30752973",
  "barcode": "99405575",
  "total_quantity": 20,
  "pos_updated_date": null,
  "pos_updated_date_local": "2023-10-31T15:18:22.652Z",
  "gc_created_date": "2023-02-28T14:01:33.000Z",
  "gc_updated_date": "2023-10-28T17:31:35.000Z",
  "location_data": [
    {
      "name": "Main Inventory",
      "quantity": 20,
      "location_id": "6185C49a-CB0a-e5a9-d9Ee-fDfD13dBfd81",
      "pos_location_type": "reprehenderit aute nulla laboris dolore"
    },
    {
      "name": "Store 3",
      "quantity": 39,
      "location_id": "f5C7b1cE-B21c-eE8A-aDcC-22F80cC45BE0",
      "pos_location_type": null
    },
    {
      "name": "Bulk Inventory",
      "quantity": 200,
      "location_id": "F72b17A2-DEbF-ADCD-0537-cDdC08D0b3d4",
      "pos_location_type": null
    }
  ]
}

Get Inventory by Location

Request

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

CRB Id

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

Location Id

Query
limitinteger(int32)[ 1 .. 1000 ]

The page size

Default 1000
offsetinteger(int32)>= 0

The page offset

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

Inventory snapshot date: yyyy-MM-dd

expandboolean

Expands the response by including product data related to this resource

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/crbs/{crb_id}/inventory-locations/{location_id}/inventory?limit=1000&offset=0&date=string&expand=true&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[].​crb_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
data[].​pos_typestringrequired
Enum"Alleaves""Apex Trading Wholesale""Dutchie""Dutchie Wholesale""Cova""Meadow""MJ Freeway""MJ Freeway Wholesale""Greenbits""GrowFlow"
data[].​product_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
data[].​namestringrequired

Name of the product

data[].​skustring or nullrequired

SKU for the product. May or may not be provided by the POS

data[].​barcodestring or nullrequired

The tag from the track and trace system that uniquely identifies this product for tracking purposes. May or may not be provided by the POS

data[].​total_quantitynumber(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[].​quantityinteger(int32)>= 0required
Response
application/json
{
  "data": [
    {
      "product": null,
      "id": "4974E13a-3acB-3a54-A3F3-00dc56c97068",
      "crb_id": "75C0a4ca-cf8B-cDDA-8Bef-Ae1cdb6daF8c",
      "pos_type": "Greenbits",
      "product_id": "Bb01CfcE-B58e-8CaC-1afB-A13DDB6Ba2d7",
      "name": "Bangin Blues  - 7g",
      "sku": "30752973",
      "barcode": "01506",
      "total_quantity": 70635619.5988006,
      "pos_updated_date": "2023-10-31T15:21:57.167Z",
      "pos_updated_date_local": null,
      "gc_created_date": "2023-02-28T14:01:33.000Z",
      "gc_updated_date": "2023-02-28T14:01:33.000Z",
      "quantity": 6
    },
    {
      "product": {
        "crb_id": "C7edEeDe-1bDe-AFb9-DFbD-Ff21fcf9ba0C",
        "id": "FbbbCcf5-b661-5595-5170-B4B67ddF85bd",
        "pos_product_id": "enim nostrud aliquip",
        "pos_type": {
          "description": "The POS system that this data is sourced from."
        },
        "name": "Bulk Batter (GG4)",
        "gc_product_category_name": null,
        "pos_product_category_name": "Vapes",
        "pos_product_subcategory_name": "Topical-Dermal-Balm",
        "pos_strain_name": "Rocket Pop",
        "pos_brand_name": "Lookah",
        "medicated": false,
        "sku": "64392902",
        "description": "Sunset Runtz, bred by Exotic Genetix, is a captivating indica-dominant hybrid.",
        "gc_net_weight_grams": null,
        "pos_unit_of_measure": "Wgt",
        "price": 19957135,
        "unit_cost": 53926185.60843639,
        "pos_updated_date": null,
        "pos_updated_date_local": null,
        "gc_created_date": "2023-10-28T17:31:35.000Z",
        "gc_updated_date": "2023-10-28T17:31:35.000Z",
        "price_tiers": [
          {
            "tier_name": "Bulk Flower Deals",
            "tier_price": 90289616,
            "pos_tier_type": "Quantity",
            "pos_tier_type_condition_value": "3.5 - 7",
            "tier_valid_until_date": {
              "description": "Datetime that this tier stops being valid, if applicable"
            },
            "tier_valid_until_date_local": null
          }
        ],
        "images": [
          {
            "url": "proident magna laborum",
            "description": "anim enim occaecat"
          }
        ]
      },
      "id": "4Af2ceB5-dbBe-6D6d-c8f3-beea71C93Be8",
      "crb_id": "4fEaABe9-Cf40-fe68-2Be8-b0632d82881e",
      "pos_type": "Cova",
      "product_id": null,
      "name": "Hypnos Cartridge",
      "sku": "64392902",
      "barcode": "01506",
      "total_quantity": 39526986.50200396,
      "pos_updated_date": null,
      "pos_updated_date_local": "2023-10-31T15:21:57.167Z",
      "gc_created_date": "2023-10-31T15:21:57.000Z",
      "gc_updated_date": "2023-02-28T14:01:33.000Z",
      "quantity": 6
    },
    {
      "product": null,
      "id": "d1E88bdd-A2Ed-447b-98B9-A6bbAC78bAFD",
      "crb_id": "a68FFB16-e5bA-E91a-7F14-E5fCA09ffA32",
      "pos_type": "Blaze",
      "product_id": "0e29F28b-daBE-BcBd-D9Fc-EEBC4abd954C",
      "name": "Preroll Bulk - GG2B",
      "sku": "64392902",
      "barcode": "1A40F0100000191000001750",
      "total_quantity": 76379953.22259521,
      "pos_updated_date": null,
      "pos_updated_date_local": "2023-10-31T15:21:57.167Z",
      "gc_created_date": "2023-10-31T15:18:22.000Z",
      "gc_updated_date": "2023-10-31T15:21:57.000Z",
      "quantity": 1000
    }
  ],
  "metadata": {
    "count": "100 - 172",
    "total": 1922285
  }
}

Inventory Locations

Operations

Products

Operations

Sales

Operations