Sample Responses

Ticket API

GET Endpoints

{
    "resultCode": "SUCCESS",
    "resultReason": null,
    "resultDetail": null,
    "ticketList": [
        {
            "type": "DELIVERY",
            "ticket_id": "dacea4af-ee76-40dd-b452-a690b4e41687",
            "order_number": "V3Q97K",
            "external_order_number": null,
            "order_source": "ECOMMERCE",
            "created_by_employee": {
                "employee_id": "f42ba95f-db7b-11e9-a587-0a1adb07b79e",
                "name": "ADMIN_TREEZ",
                "role": "manager"
            },
            "customer_id": 5471,
            "ticket_patient_type": "ADULT",
            "cash_register_id": "0e06acdc-d60a-4827-b77e-41d2f4b617dd",
            "order_status": "COMPLETED",
            "payment_status": "PAID",
            "date_created": "2021-01-11T15:00:03.000-08:00",
            "last_updated_at": "2021-01-11T15:02:11.000-08:00",
            "date_closed": "2021-01-11T15:02:11.000-08:00",
            "post_tax_pricing": false,
            "sub_total": 35.0,
            "tax_total": 12.8,
            "discount_total": -10.0,
            "total": 47.8,
            "ticket_note": null,
            "refund_reason": null,
            "original_ticket_id": null,
            "delivery_address": {
                "id": 2669,
                "street": "2654 WILLOW AVE",
                "street2": null,
                "city": "SAN_JOSE",
                "county": "Santa Clara",
                "state": "CA",
                "zip": "94536"
            },
            "scheduled_date": "2019-11-28T17:00:00.000-08:00",
            "items": [
                {
                    "product_id": "8ef5c1d7-9f4e-47c2-8344-9c852e06b633",
                    "barcodes": [
                        "23432"
                    ],
                    "inventory_barcodes": [
                        "oYk"
                    ],
                    "location_name": "SOUTH BAY",
                    "inventory_type": "ADULT",
                    "inventory_id": "ADfaq13092",
                    "inventory_batch_id": "394W5",
                    "size_id": "8ef5c1d7-9f4e-47c2-8344-9c852e06b633",
                    "product_size_name": "ESPRESSO BEANS SAMPLE3 T",
                    "product_type": "EDIBLE",
                    "product_brand": "KIVA",
                    "quantity": 1.0,
                    "price_total": 47.8,
                    "price_sell": 35.0,
                    "product_unit": "GRAMS",
                    "apply_automatic_discounts": true,
                    "POS_discounts": [],
                    "discounts": [
                        {
                            "id": null,
                            "discount_title": "$10 DISCOUNT",
                            "discount_amount": 10.0,
                            "discount_method": "DOLLAR",
                            "savings": 10.0,
                            "discount_category": "AUTOMATIC_DISCOUNT",
                            "cart": false
                        }
                    ],
                    "tax": [
                        {
                            "id": "78f91924-abb3-4585-b094-e6e9ff01f4b6",
                            "rate": 0.1,
                            "tax_name": "City Tax",
                            "amount": 3.5
                        },
                        {
                            "id": "2bef0a5f-1470-4a78-9758-912a0acb892c",
                            "rate": 0.0925,
                            "tax_name": "Dynamic Sales Tax",
                            "amount": 4.05
                        },
                        {
                            "id": "d2eded44-d5b9-4432-95f4-9b83705d4c1c",
                            "rate": 0.15,
                            "tax_name": "Excise Tax",
                            "amount": 5.25
                        }
                    ],
                    "price_target": null,
                    "price_target_note": null
                }
            ],
            "fees": [],
            "payments": [
                {
                    "payment_id": "b9297b6c-4056-4ba6-bbd0-9cf2ff01e018",
                    "payment_source": "IN_STORE",
                    "payment_method": "CASH",
                    "amount_paid": 48.0,
                    "payment_date": "2021-01-11T15:02:11.000-08:00"
                },
                {
                    "payment_id": "b9297b6c-4056-4ba6-bbd0-9cf2ff01e018",
                    "payment_source": "IN_STORE",
                    "payment_method": "CASH",
                    "amount_paid": -0.2,
                    "payment_date": "2021-01-11T15:02:11.000-08:00"
                }
            ],
            "reward_eligible": true,
            "reward_points_earned": 350,
            "reward_points_used": 0,
            "purchase_limit": null,
            "employee_id": null,
            "cash_drawer_name": "TREEZ TEST (DO NOT USE)",
            "delivery_route": {
                "driver_name": "John Doe",
                "driver_occupational_license_number": "42523451",
                "driver_vehicle_license_number": "F1214231234",
                "phone_number_for_questions": "9252820913",
                "vehicle_make": "Honda",
                "vehicle_model": "Civic",
                "vehicle_license_plate_number": "45HG29",
                "estimated_departure_datetime": "2020-10-24T11:00:00.000",
                "estimated_arrival_datetime": "2020-10-24T13:00:00.000",
                "planned_route": null,
                "vin": "123123SDSSDFSDSFSF"
            },
            "payment_authorization": false
        }
    ]
}

POST/PUT Endpoints

{
    "resultCode": "SUCCESS",
    "resultReason": null,
    "resultDetail": null,
    "ticketList": [
        {
            "type": "DELIVERY",
            "ticket_id": "f2e7faa6-6893-4f70-b11e-f3bccbac6c31",
            "order_number": "LYIK1B",
            "external_order_number": null,
            "order_source": "ECOMMERCE",
            "created_by_employee": {
                "employee_id": "Default",
                "name": "Default",
                "role": "employee"
            },
            "customer_id": 3075,
            "ticket_patient_type": "MEDICAL-REGULAR",
            "cash_register_id": null,
            "order_status": "CANCELED",
            "payment_status": "UNPAID",
            "date_created": "2021-01-11T15:22:11.000-08:00",
            "last_updated_at": "2021-01-11T15:22:11.000-08:00",
            "date_closed": null,
            "post_tax_pricing": true,
            "sub_total": 4.57,
            "tax_total": 0.43,
            "discount_total": -4.57,
            "total": 5.0,
            "ticket_note": null,
            "refund_reason": null,
            "original_ticket_id": null,
            "delivery_address": {
                "id": 2671,
                "street": "4770 Lincoln Ave",
                "street2": null,
                "city": "Oakland",
                "county": "Alameda",
                "state": "CA",
                "zip": "94602"
            },
            "scheduled_date": null,
            "items": [
                {
                    "product_id": "65629d9e-0621-11e8-b4e9-02429027d658",
                    "barcodes": [
                        "I63j"
                    ],
                    "inventory_barcodes": [
                        "7AZ"
                    ],
                    "location_name": "FRONT OF HOUSE",
                    "inventory_type": "ALL",
                    "inventory_id": "E17027076FF711E9B6850280",
                    "inventory_batch_id": "KING-5EED-229A-2",
                    "size_id": "65629d9e-0621-11e8-b4e9-02429027d658",
                    "product_size_name": "KING LOUIS QWEQWE111111",
                    "product_type": "FLOWER",
                    "product_brand": "SAMPLE",
                    "quantity": 1.0,
                    "price_total": 5.0,
                    "price_sell": 4.57,
                    "product_unit": "MILLIGRAMS",
                    "apply_automatic_discounts": false,
                    "POS_discounts": [
                        {
                            "id": "42475cd0-de4a-4033-9829-cd0c4d4bc029",
                            "discount_title": "edmund test",
                            "discount_amount": 5.0,
                            "discount_method": "DOLLAR",
                            "cart": false
                        }
                    ],
                    "discounts": [
                        {
                            "id": "42475cd0-de4a-4033-9829-cd0c4d4bc029",
                            "discount_title": "edmund test",
                            "discount_amount": 5.0,
                            "discount_method": "DOLLAR",
                            "savings": 5.0,
                            "discount_category": "POS_DISCOUNT",
                            "cart": false
                        }
                    ],
                    "tax": [
                        {
                            "id": "533242b9-1999-462c-b3f0-41658a408de3",
                            "rate": 0.09375,
                            "tax_name": "Sales Tax w/ MMID Cannabis Exemption",
                            "amount": 0.43
                        }
                    ],
                    "price_target": null,
                    "price_target_note": null
                }
            ],
            "fees": [],
            "payments": [],
            "reward_eligible": true,
            "reward_points_earned": 0,
            "reward_points_used": 0,
            "purchase_limit": {
                "concentrated": "0/24.3495",
                "non_concentrated": "0.000/228",
                "plant": "0/12"
            },
            "employee_id": null,
            "cash_drawer_name": null,
            "delivery_route": null,
            "payment_authorization": false
        }
    ]
}

What’s Next

Check the Parameter Explained page for definitions of each field

Did this page help you?