Sample Responses

Ticket API

GET Endpoints

{
    "resultCode": "SUCCESS",
    "resultReason": null,
    "resultDetail": null,
    "data": {
        "type": "DELIVERY",
        "ticket_id": "02b0db6d-b118-4e50-9cd5-8dfba0166fd2",
        "order_number": "42FOUZ",
        "external_order_number": null,
        "order_source": "ECOMMERCE",
        "created_by_employee": {
            "employee_id": "Default",
            "name": "Default",
            "role": "employee"
        },
        "packed_by_employee": null,
        "customer_id": 5016,
        "ticket_patient_type": "ADULT",
        "cash_register_id": null,
        "order_status": "AWAITING_PROCESSING",
        "payment_status": "UNPAID",
        "payment_authorization": false,
        "date_created": "2022-11-01T17:05:13.000-07:00",
        "last_updated_at": "2022-11-01T17:05:14.000-07:00",
        "date_closed": null,
        "post_tax_pricing": false,
        "sub_total": 8.0,
        "tax_total": 15.1,
        "discount_total": -20.0,
        "total": 28.1,
        "ticket_note": null,
        "refund_reason": null,
        "original_ticket_id": null,
        "delivery_address": {
            "id": 6229,
            "street": "1611 telegraph ave",
            "street2": null,
            "city": "OAKLAND",
            "county": "ALAMEDA",
            "state": "CA",
            "zip": "94612"
        },
        "delivery_route": null,
        "scheduled_date": "2022-11-15T17:13:00.000-08:00",
        "items": [
            {
                "product_id": "83e1a132-ed63-40da-951a-cdb4183acc86",
                "barcodes": [
                    "123ABC"
                ],
                "inventory_barcodes": [
                    "glf"
                ],
                "location_name": "WJ",
                "inventory_type": "ADULT",
                "inventory_id": "123",
                "inventory_batch_id": "94ODW",
                "size_id": "83e1a132-ed63-40da-951a-cdb4183acc86",
                "product_size_name": "CARBON FIBER",
                "product_type": "FLOWER",
                "product_brand": "BLUE CHIP GENETICS",
                "product_subtype": "PRE-PACK",
                "quantity": 1.0,
                "price_total": 23.1,
                "price_sell": 8.0,
                "product_unit": "GRAMS",
                "product_amount": 3.5,
                "state_tracking_uom": null,
                "apply_automatic_discounts": true,
                "POS_discounts": [
                    {
                        "id": "f6ffac7f-4672-41ad-a2c2-35751eee2333",
                        "discount_title": "CUSTOM PRICE ADJUSTMENT",
                        "discount_amount": 5.0,
                        "discount_method": "DOLLAR",
                        "cart": false
                    }
                ],
                "discounts": [
                    {
                        "id": "f6ffac7f-4672-41ad-a2c2-35751eee2333",
                        "discount_title": "CUSTOM PRICE ADJUSTMENT",
                        "discount_amount": 5.0,
                        "discount_method": "DOLLAR",
                        "savings": 5.0,
                        "discount_category": "POS_DISCOUNT",
                        "cart": false
                    },
                    {
                        "id": null,
                        "discount_title": "TREEZ",
                        "discount_amount": 15.0,
                        "discount_method": "DOLLAR",
                        "savings": 15.0,
                        "discount_category": "AUTOMATIC_DISCOUNT",
                        "cart": false
                    }
                ],
                "tax": [
                    {
                        "id": "65b889d6-22f3-40c1-b6ad-e65fb8388fdc",
                        "rate": 0.15,
                        "tax_name": "Excise Tax",
                        "amount": 12.15
                    },
                    {
                        "id": "7d22b4bf-3b56-42d0-8ae3-c8dc70e9fdb9",
                        "rate": 0.1,
                        "tax_name": "City Tax",
                        "amount": 0.8
                    },
                    {
                        "id": "fd240b50-7c60-4a1a-ac98-9160f21c7a64",
                        "rate": 0.1025,
                        "tax_name": "Sales Tax - Oakland, Alameda",
                        "amount": 2.15
                    }
                ],
                "price_target": null,
                "price_target_note": null
            }
        ],
        "fees": [
            {
                "type": "Delivery Fee",
                "total_amount": 5.0
            }
        ],
        "payments": [],
        "reward_eligible": true,
        "reward_points_earned": 0,
        "reward_points_used": 0,
        "purchase_limit": {
            "concentrated": "0.011/8",
            "non_concentrated": "14/28.5",
            "plant": "0/6"
        },
        "employee_id": null,
        "cash_drawer_name": null,
        "revenue_source": "Treez",
        "webhook": {
            "webhook_id": "a51ddd83-40ba-484c-bf43-c80440067b1b",
            "shared_secret": "JTUHMP1C49OJWA2YPC9OPQIN",
            "listener_url": "https://en0xy121gm7m6j.x.pipedream.net/"
        },
         "delivery_route": {
                "driver_name": "Lewis Hamilton",
                "driver_occupational_license_number": "4634636",
                "driver_vehicle_license_number": "123456",
                "phone_number_for_questions": "4153422032",
                "vehicle_make": "W",
                "vehicle_model": "10",
                "vehicle_license_plate_number": "123456",
                "estimated_departure_datetime": "2022-11-03T20:04:59.000Z",
                "estimated_arrival_datetime": "2022-11-05T11:55:14.000Z",
                "planned_route": "Turn right (137 ft, 0 minutes)\nTurn left toward Discovery (164 ft, 0 minutes)\nTurn right onto Discovery (492 ft, 0 minutes)\nTurn left onto Irvine Center Dr (0.54 mi, 1 minute)\nTurn right onto Barranca Pkwy (0.32 mi, 0 minutes)\nTake ramp onto I-5 N (Santa Ana Fwy) (4.81 mi, 5 minutes)\nTake exit 100 toward Jamboree Rd (0.29 mi, 0 minutes)\nTurn right onto Jamboree Rd (0.79 mi, 1 minute)\nTurn right onto Irvine Blvd (0.63 mi, 1 minute)\nTurn left and take ramp onto CA-261 N (Eastern Transportation Corridor) (4.05 mi, 4 minutes)\nTake the left exit onto CA-241 (Eastern Transportation Corridor) (5.43 mi, 5 minutes)\nTake exit 39A toward Riverside onto CA-91 E (Riverside Fwy) (25.49 mi, 25 minutes)\nTake exit 65B toward I-215 S/San Diego/Indio onto CA-60 E (Moreno Valley Fwy) (0.90 mi, 1 minute)\nContinue on I-215 (Moreno Valley Fwy) (4.38 mi, 4 minutes)\nKeep left onto CA-60 E (Moreno Valley Fwy) toward Indio (17.96 mi, 17 minutes)\nTake left ramp onto I-10 (San Bernardino Fwy) toward CA-79 (149.07 mi, 2 hours, 11 minutes)\nContinue on I-10 (123.74 mi, 1 hour, 42 minutes)\nTake exit 124A onto AZ-303-LOOP N (Bob Stump Memorial Pkwy) (36.12 mi, 36 minutes)\nTurn left and take ramp onto I-17 N (Arizona Veterans Memorial Hwy) (117.62 mi, 1 hour, 40 minutes)\nKeep right toward I-40 E/Albuquerque (0.47 mi, 0 minutes)\nContinue on I-40 (Purple Heart Trl) (163.69 mi, 2 hours, 17 minutes)\nContinue on I-40 (372.90 mi, 5 hours, 15 minutes)\nContinue on I-40 (Old Route 66) (176.92 mi, 2 hours, 31 minutes)\nContinue on I-40 (152.76 mi, 2 hours, 11 minutes)\nKeep left onto I-40 E toward US-270 E/Ft (177.76 mi, 2 hours, 33 minutes)\nContinue on I-40 (11.84 mi, 10 minutes)\nContinue on I-40 (267.74 mi, 3 hours, 44 minutes)\nKeep left onto I-40 E toward Memphis/Nashville (4.82 mi, 4 minutes)\nContinue on I-40 (Hernando Desoto Brg) (13.17 mi, 14 minutes)\nTake the left exit toward Nashville onto I-40 E (197.79 mi, 2 hours, 57 minutes)\nTake exit 208A toward Knoxville/Huntsville onto I-40 E/I-65 S (2.22 mi, 2 minutes)\nContinue on I-40 E toward Knoxville/I-24 E/Chattanooga/Airport (3.07 mi, 3 minutes)\nKeep left onto I-40 E toward Knoxville/Airport (171.85 mi, 2 hours, 33 minutes)\nContinue on I-40 E toward Knoxville (36.47 mi, 33 minutes)\nTake left exit 421 toward Bristol onto I-81 N (Troy A McGill Memorial Hwy) (75.63 mi, 1 hour, 7 minutes)\nContinue on I-81 (81.26 mi, 1 hour, 12 minutes)\nContinue on I-81 N toward US-11 N/Roanoke (140.04 mi, 2 hours, 6 minutes)\nContinue on I-81 N toward Winchester (78.91 mi, 1 hour, 10 minutes)\nTake exit 300 toward Front Royal/Washington onto I-66 E (43.37 mi, 38 minutes)\nKeep right onto I-66 (21.13 mi, 22 minutes)\nTake exit 64A toward Richmond/Alexandria onto I-495 S (Capital Beltway) (7.70 mi, 8 minutes)\nTake exit 57B toward Washington onto I-395 N (Henry G Shirley Memorial Hwy) (10.18 mi, 12 minutes)\nContinue on I-395 (Arland D Williams Jr Memorial Brg) (0.46 mi, 0 minutes)\nKeep left onto US-1 N toward 14th Street/Nat'l Mall (1.06 mi, 2 minutes)\nContinue on 14th St NW (0.89 mi, 3 minutes)\nTurn right toward 14th St NW (147 ft, 0 minutes)\nTake the 3rd exit from Thomas Cir NW roundabout onto Vermont Ave NW (0.25 mi, 1 minute)\nTurn right onto O St NW (173 ft, 0 minutes)\nTurn left toward 13th St NW (249 ft, 0 minutes)\nTake the 2nd exit from Logan Cir NW roundabout onto Rhode Island Ave NW (0.27 mi, 1 minute)\nTurn right onto Q St NW (0.16 mi, 0 minutes)",
                "vin": "null"
            }
    }
}

POST/PUT Endpoints

{
    "resultCode": "SUCCESS",
    "resultReason": null,
    "resultDetail": null,
    "data": {
        "type": "PICKUP",
        "ticket_id": "158faa24-51c7-4e42-b46b-eeadbaafc6b9",
        "order_number": "CYGVEK",
        "external_order_number": null,
        "order_source": "ECOMMERCE",
        "created_by_employee": {
            "employee_id": "Default",
            "name": "Default",
            "role": "employee"
        },
        "packed_by_employee": null,
        "customer_id": 5016,
        "ticket_patient_type": "ADULT",
        "cash_register_id": null,
        "order_status": "AWAITING_PROCESSING",
        "payment_status": "UNPAID",
        "payment_authorization": false,
        "date_created": "2022-11-01T17:27:08.000-07:00",
        "last_updated_at": "2022-11-01T17:27:08.000-07:00",
        "date_closed": null,
        "post_tax_pricing": false,
        "sub_total": 13.0,
        "tax_total": 16.62,
        "discount_total": -15.0,
        "total": 29.62,
        "ticket_note": null,
        "refund_reason": null,
        "original_ticket_id": null,
        "delivery_address": null,
        "delivery_route": null,
        "scheduled_date": null,
        "items": [
            {
                "product_id": "83e1a132-ed63-40da-951a-cdb4183acc86",
                "barcodes": [
                    "123ABC"
                ],
                "inventory_barcodes": [
                    "glf"
                ],
                "location_name": "WJ",
                "inventory_type": "ADULT",
                "inventory_id": "123",
                "inventory_batch_id": "94ODW",
                "size_id": "83e1a132-ed63-40da-951a-cdb4183acc86",
                "product_size_name": "CARBON FIBER",
                "product_type": "FLOWER",
                "product_brand": "BLUE CHIP GENETICS",
                "product_subtype": "PRE-PACK",
                "quantity": 1.0,
                "price_total": 29.62,
                "price_sell": 13.0,
                "product_unit": "GRAMS",
                "product_amount": 3.5,
                "state_tracking_uom": null,
                "apply_automatic_discounts": true,
                "POS_discounts": [],
                "discounts": [
                    {
                        "id": null,
                        "discount_title": "TREEZ",
                        "discount_amount": 15.0,
                        "discount_method": "DOLLAR",
                        "savings": 15.0,
                        "discount_category": "AUTOMATIC_DISCOUNT",
                        "cart": false
                    }
                ],
                "tax": [
                    {
                        "id": "65b889d6-22f3-40c1-b6ad-e65fb8388fdc",
                        "rate": 0.15,
                        "tax_name": "Excise Tax",
                        "amount": 12.15
                    },
                    {
                        "id": "7d22b4bf-3b56-42d0-8ae3-c8dc70e9fdb9",
                        "rate": 0.1,
                        "tax_name": "City Tax",
                        "amount": 1.3
                    },
                    {
                        "id": "1d5f46b5-150b-4003-b534-bc74d17e5efc",
                        "rate": 0.12,
                        "tax_name": "Dynamic Sales Tax",
                        "amount": 3.17
                    }
                ],
                "price_target": null,
                "price_target_note": null
            }
        ],
        "fees": [],
        "payments": [],
        "reward_eligible": true,
        "reward_points_earned": 0,
        "reward_points_used": 0,
        "purchase_limit": {
            "concentrated": "0.011/8",
            "non_concentrated": "17.5/28.5",
            "plant": "0/6"
        },
        "employee_id": null,
        "cash_drawer_name": null,
        "revenue_source": null
    }
}

What’s Next

Check the Parameter Explained page for definitions of each field