Venue API V1

Info

1 endpoints

Endpoints

GET /api/{token}/v1/info

GET /api/{token}/v1/info

Venue Info

Example

curl -X GET "https://app.posabit.com/api/YOUR_API_TOKEN/v1/info" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/YOUR_API_TOKEN/v1/info")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/YOUR_API_TOKEN/v1/info", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/YOUR_API_TOKEN/v1/info", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/YOUR_API_TOKEN/v1/info");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
400	Bad Request
422	Invalid parameters
500	Internal Server Error

Coupons

1 endpoints

Endpoints

GET /api/{token}/v1/coupons

GET /api/{token}/v1/coupons

Venue Coupons

Example

curl -X GET "https://app.posabit.com/api/YOUR_API_TOKEN/v1/coupons" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/YOUR_API_TOKEN/v1/coupons")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/YOUR_API_TOKEN/v1/coupons", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/YOUR_API_TOKEN/v1/coupons", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/YOUR_API_TOKEN/v1/coupons");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
400	Bad Request
422	Invalid parameters
500	Internal Server Error

Incoming Orders

2 endpoints

The Online Orders page is where you can view and manage all of your incoming online orders. This page is designed to give you a better overview of all of your incoming orders in one place. You can easily see important information such as the order source, order status, and order details. Additionally, you can filter and sort through your orders to find exactly what you're looking for.

Endpoints

POST /api/{token}/v1/incoming_orders
GET /api/{token}/v1/incoming_orders/{id}

POST /api/{token}/v1/incoming_orders

Create an incoming order

Example

curl -X POST "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_orders" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "incoming_order": {
    "order_type": "pickup",
    "first_name": "John",
    "last_name": "Doe",
    "email": "test@posabit.com",
    "telephone": "5551112222",
    "address": "",
    "city": "",
    "state_abbrev": "",
    "zipcode": "",
    "reference_no": "12345-86-123",
    "notes": "Gets free lighter",
    "requested_payment_method": "cash",
    "source": "online_store",
    "order_items_attributes": [
      {
        "product_parent_id": "Treehawk Farms - Wifi OG Pre-Roll 2pk (1g)",
        "product_id": 808542,
        "quantity": 2
      }
    ]
  }
}'

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_orders")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = {"incoming_order":{"order_type":"pickup","first_name":"John","last_name":"Doe","email":"test@posabit.com","telephone":"5551112222","address":"","city":"","state_abbrev":"","zipcode":"","reference_no":"12345-86-123","notes":"Gets free lighter","requested_payment_method":"cash","source":"online_store","order_items_attributes":[{"product_parent_id":"Treehawk Farms - Wifi OG Pre-Roll 2pk (1g)","product_id":808542,"quantity":2}]}}.to_json

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}

payload = {
      "incoming_order": {
        "order_type": "pickup",
        "first_name": "John",
        "last_name": "Doe",
        "email": "test@posabit.com",
        "telephone": "5551112222",
        "address": "",
        "city": "",
        "state_abbrev": "",
        "zipcode": "",
        "reference_no": "12345-86-123",
        "notes": "Gets free lighter",
        "requested_payment_method": "cash",
        "source": "online_store",
        "order_items_attributes": [
          {
            "product_parent_id": "Treehawk Farms - Wifi OG Pre-Roll 2pk (1g)",
            "product_id": 808542,
            "quantity": 2
          }
        ]
      }
    }

response = requests.post("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_orders", headers=headers, json=payload)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
)

func main() {
    body := []byte(`{"incoming_order":{"order_type":"pickup","first_name":"John","last_name":"Doe","email":"test@posabit.com","telephone":"5551112222","address":"","city":"","state_abbrev":"","zipcode":"","reference_no":"12345-86-123","notes":"Gets free lighter","requested_payment_method":"cash","source":"online_store","order_items_attributes":[{"product_parent_id":"Treehawk Farms - Wifi OG Pre-Roll 2pk (1g)","product_id":808542,"quantity":2}]}}`)
    req, _ := http.NewRequest("POST", "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_orders", bytes.NewBuffer(body))
    req.Header.Set("Accept", "application/json")
    req.Header.Set("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var json = @"{""incoming_order"":{""order_type"":""pickup"",""first_name"":""John"",""last_name"":""Doe"",""email"":""test@posabit.com"",""telephone"":""5551112222"",""address"":"""",""city"":"""",""state_abbrev"":"""",""zipcode"":"""",""reference_no"":""12345-86-123"",""notes"":""Gets free lighter"",""requested_payment_method"":""cash"",""source"":""online_store"",""order_items_attributes"":[{""product_parent_id"":""Treehawk Farms - Wifi OG Pre-Roll 2pk (1g)"",""product_id"":808542,""quantity"":2}]}}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_orders", content);

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Request Body

{
  "incoming_order": {
    "order_type": "pickup",
    "first_name": "John",
    "last_name": "Doe",
    "email": "test@posabit.com",
    "telephone": "5551112222",
    "address": "",
    "city": "",
    "state_abbrev": "",
    "zipcode": "",
    "reference_no": "12345-86-123",
    "notes": "Gets free lighter",
    "requested_payment_method": "cash",
    "source": "online_store",
    "order_items_attributes": [
      {
        "product_parent_id": "Treehawk Farms - Wifi OG Pre-Roll 2pk (1g)",
        "product_id": 808542,
        "quantity": 2
      }
    ]
  }
}

Responses

Status	Description
400	Bad Request
422	Invalid parameters
500	Internal Server Error

GET /api/{token}/v1/incoming_orders/{id}

Find an incoming order

Parameters

Name	Type	In	Required	Description
`id`	integer	path	Yes

Example

curl -X GET "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_orders/{id}" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_orders/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_orders/{id}", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_orders/{id}", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_orders/{id}");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
404	Requested reference number or id not found
422	Invalid parameters
500	Internal Server Error

Response Fields

Field	Type	Required	Description
`reference_no`	string	No
`customer_type`	string	No	Default: recreational
`terminal_id`	integer	No
`customer_id`	integer	No
`local_order_id`	string	No
`driver_id`	integer	No
`vehicle_id`	integer	No
`aasm_state`	string	No	Default: pending
`pos_status`	string	No
`source`	string(30)	No	Default: online_store
`first_name`	string	No
`last_name`	string	No
`telephone`	string	No
`email`	string	No
`processed_by`	string	No
`saved_order_data`	text	No
`created_at`	datetime	Yes
`updated_at`	datetime	Yes
`processed_at`	datetime	No
`order_type`	string	No	Default: pickup
`requested_payment_method`	string	No
`address`	string	No	Default:
`city`	string	No	Default:
`state_abbrev`	string	No	Default:
`zipcode`	string	No	Default:
`country`	string	No	Default: US
`lat`	float	No
`lng`	float	No
`notes`	text	No
`internal_notes`	text	No
`departured_at`	datetime	No
`delivered_at`	datetime	No
`requested_date`	date	No
`requested_window_start_time`	string(100)	No
`requested_window_end_time`	string(100)	No
`planned_route`	text	No
`delivery_status`	string	No
`sts_error`	text	No
`total`	integer	No
`tip_amount`	integer	No	Default: 0
`tip_type`	string	No
`created_by`	string	No
`status_callback`	text	No
`payment_prepaid`	boolean	No	Default: false
`payment_source`	string(80)	No
`payment_reference_id`	string(80)	No
`payment_amount`	integer	No
`proc_time`	integer	No	Default: 0
`reason`	string	No
`payment_verified`	boolean	No	Default: false
`curbside`	boolean	No	Default: false
`third_party_request_id`	integer	No
`api_id`	string(64)	No
`cancellation_notes`	text	No
`external_error`	text	No
`payment_auth_id`	string	No
`refresh_token`	string	No
`token_expires_at`	datetime	No
`tip_calculated`	integer	No	Default: 0
`processing_fee`	integer	No	Default: 0
`ip`	string	No
`oauth_token`	text	No
`otp`	string	No
`client_type`	string(20)	No
`fulfillment_method`	string(20)	No
`fulfillment_sub_type`	string(30)	No
`integrator_id`	integer	No
`api_version`	string(10)	No

Response Example

{
  "code": 1,
  "incoming_order": {
    "id": 19798,
    "aasm_state": "processing",
    "reference_no": "3221-1727814981-bb1314bf",
    "first_name": "A",
    "last_name": "A",
    "source": "posabit_v2",
    "order_type": "pickup",
    "notes": null,
    "delivered_at": null,
    "requested_date": null,
    "requested_window_start_time": {},
    "requested_window_end_time": {},
    "requested_payment_method": "cash",
    "payment_verified": false,
    "curbside": false,
    "created_at": "2024-10-01T20:39:23.000Z",
    "updated_at": "2024-10-01T20:41:19.000Z"
  },
  "order_items": [
    {
      "item_id": 32713,
      "product_id": 800583,
      "sku_id": 107907,
      "manifest_item_id": null,
      "product_name": "'oh' McDonald Farms - Nuken (1g)",
      "product_brand": "'oh' McDonald Farms",
      "product_strain": "Nuken",
      "weight": "1.1g",
      "quantity": 1,
      "unit_quantity": "1.1",
      "price": 1500,
      "discount": 0,
      "tax": 473,
      "tier_weight_id": null,
      "coupons": [],
      "taxes": [],
      "created_at": "2024-10-01T20:36:21.000Z",
      "updated_at": "2024-10-01T20:36:21.000Z"
    }
  ]
}

Incoming Quotes

4 endpoints

Endpoints

PUT /api/{token}/v1/incoming_quotes/{id}/finalize
POST /api/{token}/v1/incoming_quotes
GET /api/{token}/v1/incoming_quotes/{id}
PATCH /api/{token}/v1/incoming_quotes/{id}

PUT /api/{token}/v1/incoming_quotes/{id}/finalize

Finalize an incoming quote. Submits an Order.

Parameters

Name	Type	In	Required	Description
`id`	integer	path	Yes

Example

curl -X PUT "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}/finalize" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{...}'

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}/finalize")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Put.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}

response = requests.put("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}/finalize", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("PUT", "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}/finalize", nil)
    req.Header.Set("Accept", "application/json")
    req.Header.Set("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var json = @"{...}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PutAsync("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}/finalize", content);

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
204	Record not found
400	Bad Request

POST /api/{token}/v1/incoming_quotes

Create an incoming quote

Example

curl -X POST "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "quote": {
    "incoming_order_id": null,
    "venue_id": 3221,
    "fulfillment": {
      "source": "posabit_v2",
      "order_type": "pickup",
      "requested_date": null,
      "requested_window_start_time": null,
      "requested_window_end_time": null,
      "tip_amount": 0,
      "tip_type": null,
      "processing_fee": 300,
      "tip_calculated": 0,
      "delivery_address": {
        "address": "",
        "city": "",
        "state_abbrev": "",
        "zipcode": ""
      }
    },
    "customer": {
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "test@posabit.com",
      "telephone": "5551112222",
      "customer_type": "recreational"
    },
    "payment": {
      "requested_payment_method": "cash"
    },
    "items": [
      {
        "sku_id": 107907,
        "quantity": 1,
        "product_id": 800583,
        "name": "'oh' McDonald Farms - Nuken (1g)",
        "unit_type": "g",
        "unit": "1.1",
        "variant_id": "k107907",
        "quantity_on_hand": 30,
        "test_results": {
          "thc": {
            "current": 4.2,
            "low": 4.2,
            "high": 4.2,
            "unit_type": "%"
          },
          "cbd": {
            "current": 10,
            "low": 10,
            "high": 10,
            "unit_type": "%"
          },
          "thca": null,
          "cbda": null,
          "total_thc": {
            "current": 4.2,
            "low": 4.2,
            "high": 4.2,
            "unit_type": "%"
          },
          "total_cbd": null,
          "thcv": null,
          "cbdv": null,
          "cbc": null,
          "cbca": null,
          "cbcv": null,
          "cbn": null,
          "cbg": null,
          "cbga": null,
          "cbgv": null
        },
        "terpene_results": [],
        "product_image": {
          "is_product_specific_image": true,
          "lg": "https://pbit-staging.s3.amazonaws.com/images/image/210/large_image.jpg",
          "md": "https://pbit-staging.s3.amazonaws.com/images/image/210/medium_image.jpg"
        },
        "discount": 0,
        "price": 1500,
        "discount_ids": []
      }
    ]
  }
}'

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = {"quote":{"incoming_order_id":null,"venue_id":3221,"fulfillment":{"source":"posabit_v2","order_type":"pickup","requested_date":null,"requested_window_start_time":null,"requested_window_end_time":null,"tip_amount":0,"tip_type":null,"processing_fee":300,"tip_calculated":0,"delivery_address":{"address":"","city":"","state_abbrev":"","zipcode":""}},"customer":{"first_name":"Jane","last_name":"Doe","email":"test@posabit.com","telephone":"5551112222","customer_type":"recreational"},"payment":{"requested_payment_method":"cash"},"items":[{"sku_id":107907,"quantity":1,"product_id":800583,"name":"'oh' McDonald Farms - Nuken (1g)","unit_type":"g","unit":"1.1","variant_id":"k107907","quantity_on_hand":30,"test_results":{"thc":{"current":4.2,"low":4.2,"high":4.2,"unit_type":"%"},"cbd":{"current":10,"low":10,"high":10,"unit_type":"%"},"thca":null,"cbda":null,"total_thc":{"current":4.2,"low":4.2,"high":4.2,"unit_type":"%"},"total_cbd":null,"thcv":null,"cbdv":null,"cbc":null,"cbca":null,"cbcv":null,"cbn":null,"cbg":null,"cbga":null,"cbgv":null},"terpene_results":[],"product_image":{"is_product_specific_image":true,"lg":"https://pbit-staging.s3.amazonaws.com/images/image/210/large_image.jpg","md":"https://pbit-staging.s3.amazonaws.com/images/image/210/medium_image.jpg"},"discount":0,"price":1500,"discount_ids":[]}]}}.to_json

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}

payload = {
      "quote": {
        "incoming_order_id": null,
        "venue_id": 3221,
        "fulfillment": {
          "source": "posabit_v2",
          "order_type": "pickup",
          "requested_date": null,
          "requested_window_start_time": null,
          "requested_window_end_time": null,
          "tip_amount": 0,
          "tip_type": null,
          "processing_fee": 300,
          "tip_calculated": 0,
          "delivery_address": {
            "address": "",
            "city": "",
            "state_abbrev": "",
            "zipcode": ""
          }
        },
        "customer": {
          "first_name": "Jane",
          "last_name": "Doe",
          "email": "test@posabit.com",
          "telephone": "5551112222",
          "customer_type": "recreational"
        },
        "payment": {
          "requested_payment_method": "cash"
        },
        "items": [
          {
            "sku_id": 107907,
            "quantity": 1,
            "product_id": 800583,
            "name": "'oh' McDonald Farms - Nuken (1g)",
            "unit_type": "g",
            "unit": "1.1",
            "variant_id": "k107907",
            "quantity_on_hand": 30,
            "test_results": {
              "thc": {
                "current": 4.2,
                "low": 4.2,
                "high": 4.2,
                "unit_type": "%"
              },
              "cbd": {
                "current": 10,
                "low": 10,
                "high": 10,
                "unit_type": "%"
              },
              "thca": null,
              "cbda": null,
              "total_thc": {
                "current": 4.2,
                "low": 4.2,
                "high": 4.2,
                "unit_type": "%"
              },
              "total_cbd": null,
              "thcv": null,
              "cbdv": null,
              "cbc": null,
              "cbca": null,
              "cbcv": null,
              "cbn": null,
              "cbg": null,
              "cbga": null,
              "cbgv": null
            },
            "terpene_results": [],
            "product_image": {
              "is_product_specific_image": true,
              "lg": "https://pbit-staging.s3.amazonaws.com/images/image/210/large_image.jpg",
              "md": "https://pbit-staging.s3.amazonaws.com/images/image/210/medium_image.jpg"
            },
            "discount": 0,
            "price": 1500,
            "discount_ids": []
          }
        ]
      }
    }

response = requests.post("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes", headers=headers, json=payload)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
)

func main() {
    body := []byte(`{"quote":{"incoming_order_id":null,"venue_id":3221,"fulfillment":{"source":"posabit_v2","order_type":"pickup","requested_date":null,"requested_window_start_time":null,"requested_window_end_time":null,"tip_amount":0,"tip_type":null,"processing_fee":300,"tip_calculated":0,"delivery_address":{"address":"","city":"","state_abbrev":"","zipcode":""}},"customer":{"first_name":"Jane","last_name":"Doe","email":"test@posabit.com","telephone":"5551112222","customer_type":"recreational"},"payment":{"requested_payment_method":"cash"},"items":[{"sku_id":107907,"quantity":1,"product_id":800583,"name":"'oh' McDonald Farms - Nuken (1g)","unit_type":"g","unit":"1.1","variant_id":"k107907","quantity_on_hand":30,"test_results":{"thc":{"current":4.2,"low":4.2,"high":4.2,"unit_type":"%"},"cbd":{"current":10,"low":10,"high":10,"unit_type":"%"},"thca":null,"cbda":null,"total_thc":{"current":4.2,"low":4.2,"high":4.2,"unit_type":"%"},"total_cbd":null,"thcv":null,"cbdv":null,"cbc":null,"cbca":null,"cbcv":null,"cbn":null,"cbg":null,"cbga":null,"cbgv":null},"terpene_results":[],"product_image":{"is_product_specific_image":true,"lg":"https://pbit-staging.s3.amazonaws.com/images/image/210/large_image.jpg","md":"https://pbit-staging.s3.amazonaws.com/images/image/210/medium_image.jpg"},"discount":0,"price":1500,"discount_ids":[]}]}}`)
    req, _ := http.NewRequest("POST", "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes", bytes.NewBuffer(body))
    req.Header.Set("Accept", "application/json")
    req.Header.Set("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var json = @"{""quote"":{""incoming_order_id"":null,""venue_id"":3221,""fulfillment"":{""source"":""posabit_v2"",""order_type"":""pickup"",""requested_date"":null,""requested_window_start_time"":null,""requested_window_end_time"":null,""tip_amount"":0,""tip_type"":null,""processing_fee"":300,""tip_calculated"":0,""delivery_address"":{""address"":"""",""city"":"""",""state_abbrev"":"""",""zipcode"":""""}},""customer"":{""first_name"":""Jane"",""last_name"":""Doe"",""email"":""test@posabit.com"",""telephone"":""5551112222"",""customer_type"":""recreational""},""payment"":{""requested_payment_method"":""cash""},""items"":[{""sku_id"":107907,""quantity"":1,""product_id"":800583,""name"":""'oh' McDonald Farms - Nuken (1g)"",""unit_type"":""g"",""unit"":""1.1"",""variant_id"":""k107907"",""quantity_on_hand"":30,""test_results"":{""thc"":{""current"":4.2,""low"":4.2,""high"":4.2,""unit_type"":""%""},""cbd"":{""current"":10,""low"":10,""high"":10,""unit_type"":""%""},""thca"":null,""cbda"":null,""total_thc"":{""current"":4.2,""low"":4.2,""high"":4.2,""unit_type"":""%""},""total_cbd"":null,""thcv"":null,""cbdv"":null,""cbc"":null,""cbca"":null,""cbcv"":null,""cbn"":null,""cbg"":null,""cbga"":null,""cbgv"":null},""terpene_results"":[],""product_image"":{""is_product_specific_image"":true,""lg"":""https://pbit-staging.s3.amazonaws.com/images/image/210/large_image.jpg"",""md"":""https://pbit-staging.s3.amazonaws.com/images/image/210/medium_image.jpg""},""discount"":0,""price"":1500,""discount_ids"":[]}]}}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes", content);

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Request Body

{
  "quote": {
    "incoming_order_id": null,
    "venue_id": 3221,
    "fulfillment": {
      "source": "posabit_v2",
      "order_type": "pickup",
      "requested_date": null,
      "requested_window_start_time": null,
      "requested_window_end_time": null,
      "tip_amount": 0,
      "tip_type": null,
      "processing_fee": 300,
      "tip_calculated": 0,
      "delivery_address": {
        "address": "",
        "city": "",
        "state_abbrev": "",
        "zipcode": ""
      }
    },
    "customer": {
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "test@posabit.com",
      "telephone": "5551112222",
      "customer_type": "recreational"
    },
    "payment": {
      "requested_payment_method": "cash"
    },
    "items": [
      {
        "sku_id": 107907,
        "quantity": 1,
        "product_id": 800583,
        "name": "'oh' McDonald Farms - Nuken (1g)",
        "unit_type": "g",
        "unit": "1.1",
        "variant_id": "k107907",
        "quantity_on_hand": 30,
        "test_results": {
          "thc": {
            "current": 4.2,
            "low": 4.2,
            "high": 4.2,
            "unit_type": "%"
          },
          "cbd": {
            "current": 10,
            "low": 10,
            "high": 10,
            "unit_type": "%"
          },
          "thca": null,
          "cbda": null,
          "total_thc": {
            "current": 4.2,
            "low": 4.2,
            "high": 4.2,
            "unit_type": "%"
          },
          "total_cbd": null,
          "thcv": null,
          "cbdv": null,
          "cbc": null,
          "cbca": null,
          "cbcv": null,
          "cbn": null,
          "cbg": null,
          "cbga": null,
          "cbgv": null
        },
        "terpene_results": [],
        "product_image": {
          "is_product_specific_image": true,
          "lg": "https://pbit-staging.s3.amazonaws.com/images/image/210/large_image.jpg",
          "md": "https://pbit-staging.s3.amazonaws.com/images/image/210/medium_image.jpg"
        },
        "discount": 0,
        "price": 1500,
        "discount_ids": []
      }
    ]
  }
}

Responses

Status	Description
400	Bad Request
422	Invalid parameters
500	Internal Server Error

GET /api/{token}/v1/incoming_quotes/{id}

Find an incoming quote

Parameters

Name	Type	In	Required	Description
`id`	integer	path	Yes

Example

curl -X GET "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
404	Requested reference number or id not found
422	Invalid parameters
500	Internal Server Error

Response Fields

Field	Type	Required	Description
`customer_type`	string	No	Default: recreational
`reference_no`	string	No
`subtotal`	integer	No	Default: 0
`tax`	integer	No	Default: 0
`discount`	integer	No	Default: 0
`total`	integer	No	Default: 0
`tip_amount`	integer	No	Default: 0
`tip_type`	string	No
`created_at`	datetime	Yes
`updated_at`	datetime	Yes
`telephone`	string	No
`customer_id`	integer	No
`order_type`	string	No	Default: pickup
`address`	string	No	Default:
`city`	string	No	Default:
`state_abbrev`	string	No	Default:
`zipcode`	string	No	Default:
`country`	string	No	Default: US
`last_name`	string	No
`first_name`	string	No
`email`	string	No
`payment_source`	string	No
`requested_payment_method`	string	No
`source`	string	No	Default: posabit_v2
`requested_date`	date	No
`requested_window_start_time`	time	No
`requested_window_end_time`	time	No
`auto_apply_coupons`	boolean	No	Default: false
`payment_auth_id`	string	No
`refresh_token`	string	No
`token_expires_at`	datetime	No
`tip_calculated`	integer	No	Default: 0
`processing_fee`	integer	No	Default: 0
`payment_amount`	integer	No	Default: 0
`notes`	text	No
`ip`	string	No
`oauth_token`	text	No
`otp`	string	No
`client_type`	string(20)	No
`fulfillment_method`	string(20)	No
`fulfillment_sub_type`	string(30)	No
`integrator_id`	integer	No
`api_version`	string(10)	No

Response Example

{
  "code": 1,
  "quote": {
    "reference_no": "3221-1727814981-bb1314bf",
    "incoming_order_id": null,
    "venue_id": 3221,
    "fulfillment": {
      "source": "posabit_v2",
      "order_type": "pickup",
      "requested_date": null,
      "requested_window_start_time": null,
      "requested_window_end_time": null,
      "tip_amount": 0,
      "tip_type": null,
      "processing_fee": 300,
      "tip_calculated": 0,
      "delivery_address": {
        "address": "",
        "city": "",
        "state_abbrev": "",
        "zipcode": ""
      }
    },
    "customer": {
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "test@posabit.com",
      "telephone": "5551111111",
      "customer_type": "recreational"
    },
    "payment": {
      "requested_payment_method": "cash"
    },
    "items": [
      {
        "sku_id": 107907,
        "quantity": 1,
        "product_id": 800583,
        "name": "'oh' McDonald Farms - Nuken (1g)",
        "unit_type": "g",
        "unit": "1.1",
        "variant_id": "k107907",
        "quantity_on_hand": 30,
        "test_results": {
          "thc": {
            "current": 4.2,
            "low": 4.2,
            "high": 4.2,
            "unit_type": "%"
          },
          "cbd": {
            "current": 10,
            "low": 10,
            "high": 10,
            "unit_type": "%"
          },
          "thca": null,
          "cbda": null,
          "total_thc": {
            "current": 4.2,
            "low": 4.2,
            "high": 4.2,
            "unit_type": "%"
          },
          "total_cbd": null,
          "thcv": null,
          "cbdv": null,
          "cbc": null,
          "cbca": null,
          "cbcv": null,
          "cbn": null,
          "cbg": null,
          "cbga": null,
          "cbgv": null
        },
        "terpene_results": [],
        "product_image": {
          "is_product_specific_image": true,
          "lg": "https://pbit-staging.s3.amazonaws.com/images/image/210/large_image.jpg",
          "md": "https://pbit-staging.s3.amazonaws.com/images/image/210/medium_image.jpg"
        },
        "discount": 0,
        "price": 1500,
        "discount_ids": []
      }
    ],
    "taxes": [],
    "totals": {
      "discount_ids": [],
      "subtotal": 1500,
      "discount": 0,
      "tax": 473,
      "total": 1500
    },
    "limits": {
      "exceeded_limits": [],
      "sum_per_limit": {
        "recreational_flower": 1.1
      }
    }
  }
}

PATCH /api/{token}/v1/incoming_quotes/{id}

["Update an incoming quote", "Update an incoming quote items"]

Parameters

Name	Type	In	Required	Description
`id`	integer	path	Yes
`id`	integer	path	Yes

Example

curl -X PATCH "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{...}'

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}

response = requests.patch("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("PATCH", "https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}", nil)
    req.Header.Set("Accept", "application/json")
    req.Header.Set("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var json = @"{...}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PatchAsync("https://app.posabit.com/api/YOUR_API_TOKEN/v1/incoming_quotes/{id}", content);

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
204	Record not found
400	Bad Request
200	Success
204	Record not found
400	Bad Request

Menu Feeds

2 endpoints

Endpoints

GET /api/{token}/v1/menu_feeds/{menu_feed_id}/options
GET /api/{token}/v1/menu_feeds/{id}

GET /api/{token}/v1/menu_feeds/{menu_feed_id}/options

Show a Menu Feed Configuration

Parameters

Name	Type	In	Required	Description
`menu_feed_id`	integer	path	Yes	Feed Key

Example

curl -X GET "https://app.posabit.com/api/YOUR_API_TOKEN/v1/menu_feeds/{menu_feed_id}/options" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/YOUR_API_TOKEN/v1/menu_feeds/{menu_feed_id}/options")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/YOUR_API_TOKEN/v1/menu_feeds/{menu_feed_id}/options", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/YOUR_API_TOKEN/v1/menu_feeds/{menu_feed_id}/options", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/YOUR_API_TOKEN/v1/menu_feeds/{menu_feed_id}/options");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
400	Bad Request
422	Invalid parameters
500	Internal Server Error

GET /api/{token}/v1/menu_feeds/{id}

Show a Menu Feed

Parameters

Name	Type	In	Required	Description
`id`	integer	path	Yes	Feed Key

Example

curl -X GET "https://app.posabit.com/api/YOUR_API_TOKEN/v1/menu_feeds/{id}" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/YOUR_API_TOKEN/v1/menu_feeds/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/YOUR_API_TOKEN/v1/menu_feeds/{id}", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/YOUR_API_TOKEN/v1/menu_feeds/{id}", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/YOUR_API_TOKEN/v1/menu_feeds/{id}");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
400	Bad Request
422	Invalid parameters
500	Internal Server Error

Employees

1 endpoints

Employee management through the POSaBIT web portal allows you to easily create and manage all employees. This includes creating or changing their employee PIN number or adjusting their access level. Using the employee groups feature you can easily specify exactly how much access each employee should be given in the web portal.

Endpoints

GET /api/v1/venue/employees

Models

Employee

GET /api/v1/venue/employees

Get all users for a venue

Parameters

Name	Type	In	Required	Description
`page`	integer	query	No	Page Number
`per_page`	integer	query	No	Results per page (default 1000)
`q[updated_at_gt]`	datestring	query	No	Limit results using ransack syntax (e.g. q[updated_at_gt]='2019-07-01' would return employees updated since 2019-07-01)

Example

curl -X GET "https://app.posabit.com/api/v1/venue/employees" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/v1/venue/employees")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/v1/venue/employees", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/v1/venue/employees", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/v1/venue/employees");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
401	Unauthorized

Models

Employee

An Employee.

Property	Type	Required	Description
`id`	integer	Yes	Employee Id
`first_name`	string	No	First Name
`created_at`	datetime	No	Created At
`updated_at`	datetime	No	Updated At

Customers

1 endpoints

POSaBIT offers custom profiles for each of your loyalty customers. With just the scan of the customer's ID, the point of sale pulls up the customer’s favorite types of products, displays their purchase history, shows their available loyalty points/rewards, and even has an area where you can easily make notes about the customer.

Endpoints

GET /api/v1/venue/customers

Models

Customer

GET /api/v1/venue/customers

Get all customers for a venue

Parameters

Name	Type	In	Required	Description
`page`	integer	query	No	Page Number
`per_page`	integer	query	No	Results per page (default 1000)
`q[updated_at_gt]`	datestring	query	No	Filter results using ransack syntax (e.g. q[updated_at_gt]='2019-07-01' would return employees updated since 2019-07-01)

Example

curl -X GET "https://app.posabit.com/api/v1/venue/customers" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/v1/venue/customers")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/v1/venue/customers", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/v1/venue/customers", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/v1/venue/customers");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
401	Unauthorized

Response Fields

Field	Type	Required	Description
`customer_type`	string	No	Default: recreational
`active`	boolean	No	Default: true
`gender`	string(15)	No
`loyalty`	boolean	No	Default: false
`loyalty_number`	string	No
`customer_level_id`	integer	No
`points`	integer	Yes	Default: 0
`lifetime_points`	integer	Yes	Default: 0
`birthday`	date	No
`first_name`	string	No
`full_name`	string	No
`id_number`	string	No
`id_expiration`	date	No
`id_type`	string	No	Default: drivers_license
`profile_image`	string	No
`last_name`	string	No
`telephone`	string	No
`created_at`	datetime	No
`updated_at`	datetime	No
`zipcode`	string(10)	No
`address`	string	No
`city`	string	No	Default:
`apns`	boolean	No	Default: false
`referral_code`	string	No	Default:
`state`	string	No	Default:
`email`	string	No
`was_first_created_on_pos`	boolean	No	Default: false
`country`	string(2)	No	Default: US
`sms_opt_out`	boolean	No	Default: true
`status`	string	No
`employee_hire_date`	date	No
`medical_card`	string	No
`medical_card_exp`	date	No
`caregiver_id`	string	No
`caregiver_id_exp`	date	No
`loyalty_member_since`	date	No
`sms_reachable`	boolean	Yes	Default: true
`sms_sent_at`	datetime	No
`coupons_count`	integer	Yes	Default: 0
`reviewed`	boolean	No	Default: false
`terms_agreed`	boolean	No	Default: false
`referral_source`	string	No
`ext_signature_src`	string	No
`certifying_provider`	string	No
`sms_opt_source`	string	No
`custom_allotment`	string	No
`medical_card_state`	string	No
`token`	string	No
`token_expires_at`	datetime	No
`medical_card_effective`	date	No
`core_token`	string	No
`one_time_pin`	string	No
`otp_expires_at`	datetime	No
`core_consumer_ref`	string	No
`last_online_login`	datetime	No
`online_account_created_at`	datetime	No
`sms_first_message_sent_at`	datetime	No

Response Example

{
  "total_records": 475,
  "current_page": 1,
  "total_pages": 475,
  "per_page": 1,
  "customers": [
    {
      "customerId": 279159,
      "firstName": "JANE",
      "created_at": "2019-10-21T20:21:19.000Z",
      "updated_at": "2021-10-05T19:31:24.000Z",
      "birthyear": 1992,
      "gender": "female",
      "phone": "5551111111"
    }
  ]
}

Models

Customer

An Employee.

Property	Type	Required	Description
`customerId`	integer	Yes	Customer Id
`first_name`	string	No	First Name
`birthyear`	string	No	Birth Year
`gender`	string	No	Gender
`telephone`	string	No	Telephone
`created_at`	datetime	No	Created At
`updated_at`	datetime	No	Updated At

Inventories

1 endpoints

The default view of the inventory page will show you all of your active inventory, from lowest to highest number of units (or grams) on hand - this is so you can easily see which products are running low. Using the filters on the left side of the page, you can narrow down your search results by a particular product type, brand, supplier, etc.

Endpoints

GET /api/v1/venue/inventories

GET /api/v1/venue/inventories

Get all inventories for a venue

Parameters

Name	Type	In	Required	Description
`page`	integer	query	No	Page Number
`per_page`	integer	query	No	Results per page (default 1000)
`q[updated_at_gt]`	datestring	query	No	Limit results using ransack syntax (e.g. q[updated_at_gt]='2019-07-01' would return employees updated since 2019-07-01)

Example

curl -X GET "https://app.posabit.com/api/v1/venue/inventories" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/v1/venue/inventories")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/v1/venue/inventories", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/v1/venue/inventories", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/v1/venue/inventories");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
401	Unauthorized

Response Fields

Field	Type	Required	Description
`product_id`	integer	Yes
`tier_id`	integer	No
`barcode`	string	No
`price`	integer	Yes	Default: 0
`last_price`	integer	No
`cost`	integer	Yes	Default: 0
`discountable`	boolean	Yes	Default: true
`quantity_on_hand`	decimal	Yes	Default: 0.0
`optimum_level`	integer	No	Default: 0
`reorder_threshold`	integer	No
`calc_threshold`	integer	No
`last_replenish_date`	datetime	No
`velocity`	decimal	Yes	Default: 0.0
`sold`	integer	Yes	Default: 0
`days_supply`	integer	Yes	Default: 0
`avg_cost`	integer	No
`avg_price`	integer	No
`sync_expires_at`	datetime	No
`last_order`	datetime	No
`created_at`	datetime	No
`updated_at`	datetime	No
`supplier_id`	integer	No
`updated_by`	string	No
`unit`	string(15)	Yes	Default: units
`weight`	decimal	Yes	Default: 0.0
`weight_unit`	string(15)	No
`is_active`	boolean	No	Default: true
`notes`	text	No
`sellable_quantity`	decimal	Yes	Default: 0.0
`ecomm_quantity`	decimal	Yes	Default: 0.0
`allow_undercost`	boolean	Yes	Default: false
`manifest_items_count`	integer	No	Default: 0
`thc`	decimal	No
`cbd`	decimal	No
`cbn`	decimal	No
`equivalent_weight`	decimal	No
`equivalent_unit`	string	No
`thc_min`	decimal	No
`thc_max`	decimal	No
`cbd_min`	decimal	No
`cbd_max`	decimal	No
`cbn_min`	decimal	No
`cbn_max`	decimal	No
`api_id`	string	No
`inheritor_id`	integer	No
`med_price`	integer	No
`terpenes`	text	No
`manifest_transfer_date`	date	No
`thca`	decimal	No
`thca_min`	decimal	No
`thca_max`	decimal	No
`cbda`	decimal	No
`cbda_min`	decimal	No
`cbda_max`	decimal	No
`total_thc`	decimal	No
`total_thc_min`	decimal	No
`total_thc_max`	decimal	No
`producer_id`	integer	No
`doh_compliant`	boolean	No	Default: false
`total_cbd`	decimal	No
`total_cbd_min`	decimal	No
`total_cbd_max`	decimal	No
`last_received_quantity`	decimal	No	Default: 0.0

Response Example

{
  "total_records": 1182,
  "current_page": 1,
  "total_pages": 1182,
  "per_page": 1,
  "products": [
    {
      "productId": 210111,
      "internal_product_identifier": "800566",
      "name": "High Five Farms - Ghost Train Haze",
      "display_name": "Ghost Train Haze",
      "unit": "280.0 gm",
      "price": 1300,
      "quantityInStock": "0.0",
      "vendor": "High Five Farms",
      "vendor_license": null,
      "brand": "High Five Farms",
      "category": "Bulk Flower",
      "flowertype": "hybrid",
      "concentratetype": null,
      "producttype": "hybrid",
      "productfamily": "Flower",
      "tags": [
        "Test Tag",
        "Sale Day"
      ],
      "description": "Conducive to concentration and creativity, this sati...",
      "image": [
        null
      ],
      "active": false,
      "bulkitem": true,
      "strain": "Ghost Train Haze",
      "thcMeasure": "0.0%",
      "cbdMeasure": "0.0%",
      "sku": "3264-902427",
      "discountable": true,
      "tier_name": "Top Tier",
      "doh_compliant": false,
      "effects": [
        "Relaxed",
        "Creative"
      ],
      "flavors": [
        "Flowery"
      ],
      "rooms": [],
      "created_at": "2019-10-16T20:37:49.000Z",
      "updated_at": "2022-06-14T19:37:38.000Z"
    }
  ]
}

Manifest Items

1 endpoints

Endpoints

GET /api/v1/venue/manifest_items

GET /api/v1/venue/manifest_items

Get all manifest items for a venue

Parameters

Name	Type	In	Required	Description
`page`	integer	query	No	Page Number
`per_page`	integer	query	No	Results per page (default 1000)
`q[updated_at_gt]`	datestring	query	No	Limit results using ransack syntax (e.g. q[updated_at_gt]='2019-07-01' would return employees updated since 2019-07-01)

Example

curl -X GET "https://app.posabit.com/api/v1/venue/manifest_items" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/v1/venue/manifest_items")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/v1/venue/manifest_items", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/v1/venue/manifest_items", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/v1/venue/manifest_items");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
401	Unauthorized

Response Fields

Field	Type	Required	Description
`manifest_id`	integer	No
`sts_license_id`	integer	No
`lot_number`	string	No
`item_type`	string	No
`strain`	string	No
`name`	text	No
`description`	text	No
`expires_on`	date	No
`barcode`	string	No
`barcode_dupe`	boolean	Yes	Default: false
`barcode_image`	string	No
`inventory_sku_id`	integer	No
`venue_room_id`	integer	No
`aasm_state`	string	No	Default: pending
`position`	integer	No	Default: 0
`quantity`	decimal	Yes	Default: 0.0
`weight`	decimal	Yes	Default: 0.0
`net_weight`	decimal	No
`weight_unit`	string(15)	No	Default: grams
`testing_lab`	string	No
`testing_date`	datetime	No
`testing_lab_license`	string	No
`test_results`	text	No
`test_contaminants_pass`	boolean	No
`test_cannabinoids_pass`	boolean	No
`test_pesticides_pass`	boolean	No
`thc`	decimal	No
`cbd`	decimal	No
`cbn`	decimal	No
`old_harvest_date`	datetime	No
`cost`	integer	No	Default: 0
`received_cost`	integer	No	Default: 0
`tax`	integer	No
`created_at`	datetime	No
`updated_at`	datetime	No
`last_sold`	datetime	No
`updated_by`	string	No
`is_sample`	boolean	No	Default: false
`is_medical_only`	boolean	No	Default: false
`ancestry`	string	No
`a_split`	boolean	No	Default: false
`quantity_on_hand`	decimal	Yes	Default: 0.0
`api_id`	string	No
`received_quantity`	decimal	Yes	Default: 0.0
`batch_number`	string	No
`return_manifest_id`	integer	No
`pre_return_state`	string	No
`pre_return_quantity`	decimal	No
`custom_barcode_image`	string	No
`sample_type`	string	No
`product_sample_type`	string	No
`custom_barcode_image_version`	string	No
`transformed_from_id`	integer	No
`transformed_conversion`	decimal	Yes	Default: 0.0
`transformed_from_quantity`	decimal	Yes	Default: 0.0
`transformed_conversion_weight`	string	No
`original_sts_quantity`	decimal	Yes	Default: 0.0
`original_sts_unit`	string	No
`sts_quantity`	decimal	No
`sts_category`	string	No
`sts_state`	string	No
`sts_last_modified`	string	No
`quantity_adj`	decimal	Yes	Default: 0.0
`discrepancy_detected`	datetime	No
`last_audit`	datetime	No
`number_of_doses`	decimal	No
`coa_file`	string	No
`coa_url`	text	No
`excise_tax`	integer	No
`thca`	decimal	No
`cbda`	decimal	No
`total_thc`	decimal	No
`growth_method`	string	No
`total_terpene`	decimal	No
`weight_in_grams`	decimal	No
`cbc`	decimal	No
`cbg`	decimal	No
`cbga`	decimal	No
`cbca`	decimal	No
`cbgv`	decimal	No
`thcv`	decimal	No
`cbdv`	decimal	No
`cbcv`	decimal	No
`harvest_date`	string	No
`custom_field_1`	string	No
`custom_field_2`	string	No
`custom_field_3`	string	No
`accepted_date`	date	No
`sdp_category`	string	No
`sdp_compass`	string	No
`lab_result_link`	text	No
`doh_compliant`	boolean	No	Default: false
`total_cbd`	decimal	No
`doh_type`	string	No
`has_unique_barcodes`	boolean	No	Default: false

Response Example

{
  "total_records": 1325,
  "current_page": 1,
  "total_pages": 1325,
  "per_page": 1,
  "restocks": [
    {
      "restockId": 261876,
      "parent_id": null,
      "utcDate": "2019-10-16T20:37:49.000Z",
      "quantity": "396.0",
      "quantityInStock": "-1755.422",
      "costPerUnit": 275,
      "productId": 210111,
      "inventoryId": "WAR414871.IN5SAJM",
      "thcMeasure": "19.2%",
      "cbdMeasure": "0.0%",
      "created_at": "2019-10-16T20:37:49.000Z",
      "updated_at": "2022-06-14T19:37:31.000Z"
    }
  ]
}

Sales Histories

1 endpoints

The Sales window, is where you can see and sort through all of your previous transactions. Use the filters on the left side of the page to sort the transactions however you'd like. You can use this tab when looking for a return or if you'd like to dive into the details of a specific transaction.

Endpoints

GET /api/v1/venue/sales_histories

GET /api/v1/venue/sales_histories

Get all sales histories for a venue

Parameters

Name	Type	In	Required	Description
`page`	integer	query	No	Page Number
`per_page`	integer	query	No	Results per page (default 1000)
`q[updated_at_gt]`	datestring	query	No	Limit results using ransack syntax (e.g. q[updated_at_gt]='2019-07-01' would return employees updated since 2019-07-01)

Example

curl -X GET "https://app.posabit.com/api/v1/venue/sales_histories" \
  -H "Accept: application/json"

require 'net/http'
require 'json'

uri = URI("https://app.posabit.com/api/v1/venue/sales_histories")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"

response = http.request(request)
puts JSON.parse(response.body)

import requests

headers = {
    "Accept": "application/json",
}

response = requests.get("https://app.posabit.com/api/v1/venue/sales_histories", headers=headers)
print(response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.posabit.com/api/v1/venue/sales_histories", nil)
    req.Header.Set("Accept", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://app.posabit.com/api/v1/venue/sales_histories");

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Responses

Status	Description
200	Success
401	Unauthorized

Response Fields

Field	Type	Required	Description
`order_type`	string	No	Default: regular
`order_source`	string	No	Default: walk_in
`incoming_order_id`	integer	No
`order_origin`	string(30)	No
`customer_id`	integer	No
`age`	integer	No
`gender`	string	No
`terminal_till_id`	integer	No
`order_id`	integer	No
`venue_name`	string	No
`customer_name`	string	No
`payment_source`	string	No
`payment_type`	string	No
`ordered_at`	datetime	No
`local_time`	datetime	No
`fulfilled_at`	datetime	No
`discount`	integer	No
`service_charge`	integer	No
`delivery_charge`	integer	No
`gratuity`	integer	No
`tax`	integer	No
`total`	integer	No
`open_credits`	integer	No
`restricted_credits`	integer	No
`promo_credits`	integer	No
`gopago_credits`	integer	No
`merchant_credits`	integer	No
`location`	string	No
`subtotal`	integer	No
`adjusted_time`	datetime	No
`venue_timezone`	string	No
`employee_name`	string	No
`status`	string	No
`local_order_id`	string	No
`fraction_of_day`	string	No
`bag_fee`	integer	No	Default: 0
`terminal_id`	integer	No
`tuid`	string	No
`order_discount`	integer	No	Default: 0
`pos_coupon_id`	integer	No
`pos_coupon_value`	integer	No
`cc_type`	string	No
`full_credit`	integer	No	Default: 0
`full_discount`	integer	No	Default: 0
`coupon_count`	integer	Yes	Default: 0
`created_at`	datetime	Yes
`updated_at`	datetime	Yes
`revisions`	integer	Yes	Default: 0
`description`	string	No
`proc_time`	integer	No	Default: 0
`cost`	integer	No	Default: 0
`sts_status`	string	No
`medical_card`	string	No
`medical_card_exp`	date	No
`api_id`	string	No
`breadcrumbs`	text	No
`is_caregiver`	boolean	No	Default: false
`medical_card_effective`	date	No
`client_type`	string(20)	No
`fulfillment_method`	string(20)	No
`fulfillment_sub_type`	string(30)	No
`integrator_id`	integer	No
`api_version`	string(10)	No
`client_version`	string	No

Response Example

{
  "total_records": 197,
  "current_page": 1,
  "total_pages": 197,
  "per_page": 1,
  "tickets": [
    {
      "ticketId": 49052949,
      "isMedical": true,
      "utcDate": "2022-01-14T23:52:34.000Z",
      "localTime": "2022-01-14T15:52:34.000-08:00",
      "ticketType": "sale",
      "customerId": 279560,
      "employeeId": 12777,
      "paymentType": "",
      "subTotal": 9498,
      "discount": 1900,
      "tax": 0,
      "total": 7857,
      "items": [
        {
          "ticketItemId": 91311967,
          "ticketId": 49052949,
          "productId": 318604,
          "inventoryId": "WAR421642.INOLNTM",
          "quantity": 1,
          "weight": "1.0",
          "cost": 800,
          "subTotal": 2500,
          "tax": 0,
          "discount": 500,
          "discountList": [
            {
              "couponId": 47831,
              "couponName": "buy more than $30 of whatever"
            }
          ],
          "total": 2000
        }
      ],
      "created_at": "2022-01-14T23:52:36.000Z",
      "updated_at": "2022-01-14T23:52:36.000Z"
    }
  ]
}

Guides

Venue API

Vendor API

Authentication

Resources

Info

Endpoints

Example

Responses

Coupons

Endpoints

Example

Responses

Incoming Orders

Endpoints

Example

Request Body

Responses

Parameters

Example

Responses

Response Fields

Response Example

Incoming Quotes

Endpoints

Parameters

Example

Responses

Example

Request Body

Responses

Parameters

Example

Responses

Response Fields

Response Example

Parameters

Example

Responses

Menu Feeds

Endpoints

Parameters

Example

Responses

Parameters

Example

Responses

Employees

Endpoints

Models

Parameters

Example

Responses

Models

Employee

Customers

Endpoints

Models

Parameters

Example

Responses

Response Fields

Response Example

Models

Customer

Inventories

Endpoints

Parameters

Example

Responses

Response Fields

Response Example

Manifest Items

Endpoints

Parameters

Example

Responses

Response Fields

Response Example