Sample Responses

Customer API

GET Endpoints

{
    "resultCode": "SUCCESS",
    "resultReason": null,
    "resultDetail": null,
    "data": {
        "status": "ACTIVE",
        "verification_status": "VERIFIED",
        "verification_reasons": [],
        "customer_id": "121",
        "first_name": "Sample",
        "middle_name": "",
        "nickname": "",
        "last_name": "TEST",
        "birthday": "1992-04-07",
        "drivers_license": "C1234567",
        "drivers_license_expiration": "2022-04-07",
        "state_medical_id": "N/A",
        "permit_expiration": "N/A",
        "email": "[email protected]",
        "phone": "6282032916",
        "notes": "loyal customer\nprefers flower - indica dominant hybrids",
        "physician_first_name": null,
        "physician_last_name": null,
        "physician_license": null,
        "physician_address": null,
        "physician_phone": null,
        "is_caregiver": false,
        "caregiver_license_number": "",
        "caregiver_name_1": "N/A",
        "caregiver_name_2": "N/A",
        "caregiver_details": [],
        "rewards_balance": 275,
        "rewards_type": "POINTS",
        "gender": "M",
        "signup_date": "2019-04-10T23:44:07.000-07:00",
        "last_visit_date": "2020-04-23 07:42:29.000",
        "last_update": "2020-05-09T09:41:43.000-07:00",
        "opt_out": null,
        "referral_source": "Other",
        "banned": false,
        "warning_1": false,
        "warning_2": false,
        "addresses": [
            {
                "type": "address_of_record",
                "street1": "1611 TELEGRAPH AVE",
                "street2": "",
                "city": "OAKLAND",
                "state": "CA",
                "zipcode": "94612",
                "primary": true
            },
            {
                "type": "alternative_address",
                "street1": "7000 COLISEUM WAY",
                "street2": "",
                "city": "OAKLAND",
                "state": "CA",
                "zipcode": "94621",
                "primary": false
            },
            {
                "type": "secondary_address",
                "street1": "9500 STERN AVE",
                "street2": "",
                "city": "OAKLAND",
                "state": "CA",
                "zipcode": "94605",
                "primary": false
            }
        ],
        "merged_customer_ids": [],
        "merged_into_customer_id": null,
        "patient_type": "ADULT",
        "customer_groups": [
            "INDUSTRY"
        ]
    }
}

POST/PUT Endpoints

{
    "resultCode": "SUCCESS",
    "resultReason": null,
    "resultDetail": null,
    "data": {
        "status": "ACTIVE",
        "verification_status": "VERIFICATION_PENDING",
        "verification_reasons": [
            {
                "verification_reason": "EXPIRATION",
                "verification_reason_description": "DRIVER_LICENSE_EXPIRATION"
            }
        ],
        "customer_id": "3456",
        "first_name": "Treez",
        "middle_name": null,
        "nickname": null,
        "last_name": "Sample",
        "birthday": "1990-04-07",
        "drivers_license": "D7654321",
        "drivers_license_expiration": "2021-04-07",
        "state_medical_id": "N/A",
        "permit_expiration": "N/A",
        "email": "[email protected]",
        "phone": "",
        "notes": "friend of owner",
        "physician_first_name": null,
        "physician_last_name": null,
        "physician_license": null,
        "physician_address": null,
        "physician_phone": null,
        "is_caregiver": false,
        "caregiver_license_number": "",
        "caregiver_name_1": "N/A",
        "caregiver_name_2": "N/A",
        "caregiver_details": [],
        "rewards_balance": 0,
        "rewards_type": "POINTS",
        "gender": "M",
        "signup_date": "2020-04-07T17:58:17.000-07:00",
        "last_visit_date": "2000-01-01 00:00:00.000",
        "last_update": "2021-08-04T07:53:32.000-07:00",
        "opt_out": "true",
        "referral_source": null,
        "banned": false,
        "warning_1": false,
        "warning_2": false,
        "addresses": [
            {
                "type": "address_of_record",
                "street1": "7000 Coliseum Way",
                "street2": "",
                "city": "Oakland",
                "state": "CA",
                "zipcode": "",
                "primary": true
            }
        ],
        "merged_customer_ids": [],
        "merged_into_customer_id": null,
        "patient_type": "ADULT",
        "customer_groups": []
    }
}

What’s Next

Check the Parameter Explained page for definitions of each field

Did this page help you?