Sample Responses

Ticket API

GET Endpoints

{
            "type": "DELIVERY",
            "ticket_id": "2cbd8424-5f4c-428e-b6b1-c59074b64489",
            "order_number": "2ACQJV",
            "external_order_number": "asd2123d",
            "order_source": "ECOMMERCE",
            "created_by_employee": {
                "employee_id": "Default",
                "name": "Default",
                "role": "employee"
            },
            "packed_by_employee": null,
            "customer_id": 29114,
            "ticket_patient_type": "ADULT",
            "cash_register_id": null,
            "order_status": "IN_PROCESS",
            "payment_status": "UNPAID",
            "date_created": "2022-03-31T10:40:52.000-07:00",
            "last_updated_at": "2022-03-31T10:40:54.000-07:00",
            "date_closed": null,
            "post_tax_pricing": false,
            "sub_total": 3.0,
            "tax_total": 0.9,
            "discount_total": -7.0,
            "total": 4.9,
            "ticket_note": "THIS IS THE NEW TICKET NOTE.",
            "refund_reason": null,
            "original_ticket_id": null,
            "delivery_address": {
                "id": 5062,
                "street": "1611 telegraph ave",
                "street2": null,
                "city": "OAKLAND",
                "county": "ALAMEDA",
                "state": "CA",
                "zip": "94612"
            },
            "scheduled_date": "2022-04-28T17:00:00.000-08:00",
            "items": [
                {
                    "product_id": "65629d9e-0621-11e8-b4e9-02429027d658",
                    "barcodes": [
                        "I63j"
                    ],
                    "inventory_barcodes": [
                        "liq"
                    ],
                    "location_name": "FRONT OF HOUSE",
                    "inventory_type": "ADULT",
                    "inventory_id": "testing123",
                    "inventory_batch_id": "LVG4U-ADJ-001",
                    "size_id": "65629d9e-0621-11e8-b4e9-02429027d658",
                    "product_size_name": "KING LOUIS QWEQWE111111",
                    "product_type": "FLOWER",
                    "product_brand": "SAMPLE",
                    "product_subtype": "PRE-PACK",
                    "quantity": 1.0,
                    "price_total": 3.9,
                    "price_sell": 3.0,
                    "product_unit": "MILLIGRAMS",
                    "product_amount": 14.0,
                    "state_tracking_uom": null,
                    "apply_automatic_discounts": true,
                    "POS_discounts": [],
                    "discounts": [
                        {
                            "id": "c9fa77e2-8254-4885-a197-1c42b5f470b6",
                            "discount_title": "CUSTOM PRICE ADJUSTMENT",
                            "discount_amount": 7.0,
                            "discount_method": "DOLLAR",
                            "savings": 7.0,
                            "discount_category": "CUSTOM_PRICING",
                            "cart": false
                        }
                    ],
                    "tax": [
                        {
                            "id": "65b889d6-22f3-40c1-b6ad-e65fb8388fdc",
                            "rate": 0.15,
                            "tax_name": "Excise Tax",
                            "amount": 0.27
                        },
                        {
                            "id": "7d22b4bf-3b56-42d0-8ae3-c8dc70e9fdb9",
                            "rate": 0.1,
                            "tax_name": "City Tax",
                            "amount": 0.3
                        },
                        {
                            "id": "1d5f46b5-150b-4003-b534-bc74d17e5efc",
                            "rate": 0.09375,
                            "tax_name": "Sales Tax",
                            "amount": 0.33
                        }
                    ],
                    "price_target": 3.0,
                    "price_target_note": "I've set the price target, now."
                }
            ],
            "fees": [
                {
                    "type": "Delivery Fee",
                    "total_amount": 1.0
                }
            ],
            "payments": [],
            "reward_eligible": true,
            "reward_points_earned": 0,
            "reward_points_used": 0,
            "purchase_limit": {
                "concentrated": "0/24.3495",
                "non_concentrated": "0.042/28.5",
                "plant": "0/6"
            },
            "employee_id": null,
            "cash_drawer_name": null,
            "revenue_source": "weedmaps",
            "delivery_route": null,
            "payment_authorization": null
        }

POST/PUT Endpoints

{
    "resultCode": "SUCCESS",
    "resultReason": null,
    "resultDetail": null,
    "ticketList": [
        {
            "type": "PICKUP",
            "ticket_id": "faabae97-8cf3-468e-a6ae-2e0e1e936331",
            "order_number": "QQN4SI",
            "external_order_number": null,
            "order_source": "ECOMMERCE",
            "created_by_employee": {
                "employee_id": "Default",
                "name": "Default",
                "role": "employee"
            },
            "packed_by_employee": {
                "name": "John Smith"
            },
            "customer_id": 5016,
            "ticket_patient_type": "MEDICAL-REGULAR",
            "cash_register_id": null,
            "order_status": "COMPLETED",
            "payment_status": "PAID",
            "date_created": "2022-03-31T11:53:58.000-07:00",
            "last_updated_at": "2022-03-31T12:00:17.000-07:00",
            "date_closed": "2022-03-31T12:00:17.000-07:00",
            "post_tax_pricing": false,
            "sub_total": 49.491,
            "tax_total": 4.64,
            "discount_total": -5.5,
            "total": 54.13,
            "ticket_note": null,
            "refund_reason": null,
            "original_ticket_id": null,
            "delivery_address": null,
            "scheduled_date": null,
            "items": [
                {
                    "product_id": "83e1a132-ed63-40da-951a-cdb4183acc86",
                    "barcodes": [
                        "123ABC"
                    ],
                    "inventory_barcodes": [
                        "glf"
                    ],
                    "location_name": "FRONT OF HOUSE",
                    "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": 54.13,
                    "price_sell": 49.49,
                    "product_unit": "GRAMS",
                    "product_amount": 3.5,
                    "state_tracking_uom": null,
                    "apply_automatic_discounts": true,
                    "POS_discounts": [],
                    "discounts": [
                        {
                            "id": null,
                            "discount_title": "TEST DISCOUNT",
                            "discount_amount": 5.5,
                            "discount_method": "PERCENT",
                            "savings": 5.5,
                            "discount_category": "AUTOMATIC_DISCOUNT",
                            "cart": false
                        }
                    ],
                    "tax": [
                        {
                            "id": "533242b9-1999-462c-b3f0-41658a408de3",
                            "rate": 0.09375,
                            "tax_name": "Sales Tax w/ MMID Cannabis Exemption",
                            "amount": 4.64
                        }
                    ],
                    "price_target": null,
                    "price_target_note": null
                }
            ],
            "fees": [],
            "payments": [
                {
                    "payment_id": "df663f63-f7f2-44d9-8fef-9eba083eebc4",
                    "payment_source": "ECOMMERCE",
                    "payment_method": "ACH",
                    "amount_paid": 54.13,
                    "payment_date": "2022-03-31T00:00:00.000-07:00"
                }
            ],
            "reward_eligible": false,
            "reward_points_earned": 54,
            "reward_points_used": 0,
            "purchase_limit": null,
            "employee_id": null,
            "cash_drawer_name": null,
            "revenue_source": "weedmaps",
            "delivery_route": null,
            "payment_authorization": false
        }
    ]
}

What’s Next

Check the Parameter Explained page for definitions of each field

Did this page help you?