Core Integration

7min
Level
Features including all previous integration levels
Core
- Ability to get transaction history
- Ability to get and update contacts
- Ability to get inventory levels, cost/ margin
﻿
﻿
﻿Core integration guide:﻿
AIQ offers two integration methods for point-of-sale (POS) systems:
Option 1: Provide AIQ with REST API endpoints
Option 2: Send our endpoints data at your leisure using our public REST API endpoints
Please reach out to us to determine which integration method best suits your needs!
Option 1: Provide AIQ with REST API endpoints to:
Get transactions & customer records by time range
It is preferred to make sure that we have inventory stock/ margin/ cost within those calls in order to calculate advanced analytics + facilitate automated recommendations of products to customers/staff
After we integrate those features all POS systems have the premium option to integrate our loyalty wallet and redemptions of discounts directly within the POS native UI. You can see an example of these endpoints in action both within Dutchie & LeafLogix (videos on page): 
﻿Send us your REST API docu/ endpoints﻿
﻿Move to next steps with our Tier 3+ guide﻿
﻿
Option 2: Send our endpoints data at your leisure using the endpoints below
If needed, our team is also well versed in pulling the required data in from other sources (Database tables, flat files such as CSV's, daily OneDrive drops, etc.
Add/ update POS transactions
Use this endpoint to post transactions that are occuring on your service to AIQ. We will handle accruing points for loyalty programs, analyzing, updating inventory, etc. We leverage pos_user to map to a full contact ("Persona") we should attribute the sale to.
JS
curl -X POST   https://lab.alpineiq.com/api/v1.1/createUpdateSale/:uid -H 'content-type: application/json' -H 'x-apikey: PeArOcIfWGA9MC9mtSbRmuiZ60Dl0xxcgQ9vL4CBboWw7Kz92aKcs4M1xg' -d '{
	"visit": {
		"pos_id": "120-receipt-id-120", // Receipt ID of the sale being submitted
		"pos_user": "1239uOiejaiofje", // Primary key of the persona attached to the transaction
		"sendNotification": 0,
		"transaction_date": "2014-04-20 04:03:53 +0000", // Date transaction occurred
		"transaction_total": 40.0, // Transaction total amount
		"location": "Muffins Miami", //Name of your store. Map this to a friendly name for analysis at Configure AIQ -> Retail Stores once you submit some sales.
		"visit_details_attributes": [ // The quantity within this object should be a negative value if it is a refund.
			{
				"sku": "AUR932k",
				"price": 40.0,
				"quantity": 1.0,
				"category": "PRE-ROLL",
				"brand": "Tweed",
				"name": "12g White Widow rollup",
				"discount": 12.0,
				"size": "12g",
				"strain": "Blueberry OG",
				"grade": "A",
				"species": "hybrid",
			}
		]
	}' --compressed

curl -X POST   https://lab.alpineiq.com/api/v1.1/createUpdateSale/:uid -H 'content-type: application/json' -H 'x-apikey: PeArOcIfWGA9MC9mtSbRmuiZ60Dl0xxcgQ9vL4CBboWw7Kz92aKcs4M1xg' -d '{
	"visit": {
		"pos_id": "120-receipt-id-120", // Receipt ID of the sale being submitted
		"pos_user": "1239uOiejaiofje", // Primary key of the persona attached to the transaction
		"sendNotification": 0,
		"transaction_date": "2014-04-20 04:03:53 +0000", // Date transaction occurred
		"transaction_total": 40.0, // Transaction total amount
		"location": "Muffins Miami", //Name of your store. Map this to a friendly name for analysis at Configure AIQ -> Retail Stores once you submit some sales.
		"visit_details_attributes": [ // The quantity within this object should be a negative value if it is a refund.
			{
				"sku": "AUR932k",
				"price": 40.0,
				"quantity": 1.0,
				"category": "PRE-ROLL",
				"brand": "Tweed",
				"name": "12g White Widow rollup",
				"discount": 12.0,
				"size": "12g",
				"strain": "Blueberry OG",
				"grade": "A",
				"species": "hybrid",
			}
		]
	}' --compressed
﻿
Submit personas attached to transactions
Use this endpoint so that AIQ can "attach" order details to the customer that made the transaction. This allows for deep analysis and segmentation on customer preferences. AIQ can also fire off new optin requests to join loyalty/ member club programs. The response will include the contactID and the srcID which you can store to use when submitting sales/redeeming discounts. 
AIQ recommends using /api/v2/loyalty as these are completed in real time and are queryable instantly. 
JS
curl -X POST https://lab.alpineiq.com/api/v2/loyalty \
-H 'Content-Type: application/json' \
-H 'x-apikey: PeArOcIfWGA9MC9mtSbRmuiZ60Dl0xxcgQ9vL4CBboWw7Kz92aKcs4M1xg' \
-d '{
    "firstName": "Drake",
    "lastName": "Ross",
    "mobilePhone": "3125555555",
    "email": "[email protected]",
    "address": "2205 W 136th Avenue, Broomfield, CO, 80023",
    "favoriteStore": "AIQ Denver",
    "loyalty": true //Should be true 99% of the time. False allows receiving messages, but disables point accrual.
}' --compressed
curl -X POST https://lab.alpineiq.com/api/v2/loyalty \
-H 'Content-Type: application/json' \
-H 'x-apikey: PeArOcIfWGA9MC9mtSbRmuiZ60Dl0xxcgQ9vL4CBboWw7Kz92aKcs4M1xg' \
-d '{
    "firstName": "Drake",
    "lastName": "Ross",
    "mobilePhone": "3125555555",
    "email": "drake@gmail.com",
    "address": "2205 W 136th Avenue, Broomfield, CO, 80023",
    "favoriteStore": "AIQ Denver",
    "loyalty": true //Should be true 99% of the time. False allows receiving messages, but disables point accrual.
}' --compressed
﻿
Alternatively, you can use this v1.1 endpoint. Submissions to this endpoint are subject to your capture process which can take up to 24 hours to process. 
JS
curl -X POST   https://lab.alpineiq.com/api/v1.1/createUpdateMember/:uid -H 'content-type: application/json' -H 'x-apikey: PeArOcIfWGA9MC9mtSbRmuiZ60Dl0xxcgQ9vL4CBboWw7Kz92aKcs4M1xg' -d '{
	"member": {
		"pos_user": "1239uOiejaiofje",
		"pos_type": "Online",
		"email": "[email protected]",
		"first_name": "Drake",
		"last_name": "Ross",
		"address1": "4461 Prosper dr",
    "address2": "Apt 2217",
    "city": "Dallas",
    "state": "TX",
    "zip": "76008",
    "birthday": "05/16/1985",
    "phone_number": "##########",
    "gender": "F",
    "loyalty": false, // do not set this to true unless the user expects to receive an SMS to double optin to loyalty. Duplicates will be ignored.
	}
}' --compressed

curl -X POST   https://lab.alpineiq.com/api/v1.1/createUpdateMember/:uid -H 'content-type: application/json' -H 'x-apikey: PeArOcIfWGA9MC9mtSbRmuiZ60Dl0xxcgQ9vL4CBboWw7Kz92aKcs4M1xg' -d '{
	"member": {
		"pos_user": "1239uOiejaiofje",
		"pos_type": "Online",
		"email": "drake@gmail.com",
		"first_name": "Drake",
		"last_name": "Ross",
		"address1": "4461 Prosper dr",
    "address2": "Apt 2217",
    "city": "Dallas",
    "state": "TX",
    "zip": "76008",
    "birthday": "05/16/1985",
    "phone_number": "##########",
    "gender": "F",
    "loyalty": false, // do not set this to true unless the user expects to receive an SMS to double optin to loyalty. Duplicates will be ignored.
	}
}' --compressed
﻿
Create and Update Inventory
To update inventory sent POST requests with an array of items. Max items per call is 100 with SKU/ product ID as required params.
JS
curl -X POST   https://lab.alpineiq.com/api/v1.1/createUpdateInventory/:uid -H 'content-type: application/json' -H 'x-apikey: PeArOcIfWGA9MC9mtSbRmuiZ60Dl0xxcgQ9vL4CBboWw7Kz92aKcs4M1xg' -d '[
  {
    "sku": "100050",
    "productId": "MU-CH-PR-100050",
    "category": "Muffins Pre-Rolls",
    "parentCate": "Pre-Rolls",
    "name": "Chemdawg 2g",
    "brand": "Muffins",
    "variant": "string",
    "barcode": "string",
    "url": "https://google.com",
    "imageUrl": "string",
    "description": "string",
    "supplierNa": "string",
    "currency": "string",
    "customAttr": [
      {
        "parent": "string",
        "key": "string",
        "value": "string"
      },
      {
        "parent": "string",
        "key": "string",
        "value": "string"
      }
    ],
    "supplierId": "int",
    "totalTax": "15.50",
    "dateUpdated": "1660073955",
    "MSRP": "12.56",
    "quantity": "5",
    "thc": "12.0",
    "cbd": "1.0",
    "dateAdded": "1660073953",
    "salesPrice": "30.00",
    "inStock": true,
    "isSaleable": true,
    "isArchived": false
  }
]' --compressed

// Returns
{
  "code":  200,
  "success" : true,
  "data": [] // no data returned for this endpoint
}
curl -X POST   https://lab.alpineiq.com/api/v1.1/createUpdateInventory/:uid -H 'content-type: application/json' -H 'x-apikey: PeArOcIfWGA9MC9mtSbRmuiZ60Dl0xxcgQ9vL4CBboWw7Kz92aKcs4M1xg' -d '[
  {
    "sku": "100050",
    "productId": "MU-CH-PR-100050",
    "category": "Muffins Pre-Rolls",
    "parentCate": "Pre-Rolls",
    "name": "Chemdawg 2g",
    "brand": "Muffins",
    "variant": "string",
    "barcode": "string",
    "url": "https://google.com",
    "imageUrl": "string",
    "description": "string",
    "supplierNa": "string",
    "currency": "string",
    "customAttr": [
      {
        "parent": "string",
        "key": "string",
        "value": "string"
      },
      {
        "parent": "string",
        "key": "string",
        "value": "string"
      }
    ],
    "supplierId": "int",
    "totalTax": "15.50",
    "dateUpdated": "1660073955",
    "MSRP": "12.56",
    "quantity": "5",
    "thc": "12.0",
    "cbd": "1.0",
    "dateAdded": "1660073953",
    "salesPrice": "30.00",
    "inStock": true,
    "isSaleable": true,
    "isArchived": false
  }
]' --compressed

// Returns
{
  "code":  200,
  "success" : true,
  "data": [] // no data returned for this endpoint
}
﻿
Next: Integrate Tier 3-4
﻿
﻿
Level	Features including all previous integration levels
Core	- Ability to get transaction history - Ability to get and update contacts - Ability to get inventory levels, cost/ margin
Updated 18 Dec 2024
Did this page help you?
Point-of-Sale integration
Enhanced Integration
Core Integration

﻿Core integration guide:﻿

Option 1: Provide AIQ with REST API endpoints to:

Option 2: Send our endpoints data at your leisure using the endpoints below

Core integration guide:
