Members
Manage customer/member records including creation, updates, and search functionality. Members represent the customers of a dispensary.
Base URL: /api/v1/partner/members
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
| GET | /{memberId} | Get Member By Id |
| GET | /email/{email} | Get Member By Email |
| POST | / | Add New Member |
| PUT | /{memberId} | Update Member |
| PUT | /{memberId}/metadata | Update Member Metadata |
| GET | / | Get member list |
| GET | /days | Get member list by days |
| GET | /{memberId}/limits/remaining | Get remaining member limit |
| GET | /search | Get members by licence number |
| GET | /search/dob | Get members by dob |
| GET | /search/phone | Get members by phone number |
| GET | /referral-qr/{consumerMemberId} | Create Label with consumerMemberId |
Get Member By Id
GET /api/v1/partner/members/{memberId}
Retrieve a single member by their ID. Returns the full member profile including contact information, loyalty points, and membership details.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
memberId | string | The member i d |
Response
Returns a Member object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": []
}
Get Member By Email
GET /api/v1/partner/members/email/{email}
Look up a member by their email address. Returns the member profile if a match is found.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
email | string | The email |
Response
Returns a Member object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": []
}
Add New Member
POST /api/v1/partner/members
Create a new member record. The request body must include firstName and lastName at minimum. The system validates for duplicate records based on email and phone number.
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
importId | string | No | Import identifier |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
id | string | No | Unique identifier |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
primaryPhone | string | No | Primary phone number |
textOptIn | boolean | No | Text Opt In (default: true) |
email | string | No | Email address |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
enableLoyalty | boolean | No | Enable Loyalty (default: false) |
banned | boolean | No | Banned (default: false) |
searchText | string | No | Search Text |
photoId | string | No | Photo identifier |
doctorImportId | string | No | Doctor Import identifier |
memberGroupId | string | No | Member Group identifier |
startDate | long | No | Start timestamp (epoch ms) |
marketingSource | string | No | Marketing Source |
loyaltyPoints | number | No | Loyalty Points |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
addresses | Address[] | No | Addresses |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
nickname | string | No | Nickname |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
dlExpired | boolean | No | Dl Expired |
alternateEmails | string[] | No | Alternate Emails |
alternatePhones | string[] | No | Alternate Phones |
anonymous | boolean | No | Anonymous (default: false) |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
enabledCannabisLimit | boolean | No | Enabled Cannabis Limit (default: false) |
tags | string[] | No | Tags |
careGivers | string[] | No | Care Givers |
allotmentOverride | allotmentoverride | No | Allotment Override |
{
"importId": "abc123",
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"id": "abc123",
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"dob": 1704067200000,
"birthdate": "string",
"primaryPhone": "555-0100",
"textOptIn": true,
"email": "user@example.com",
"emailOptIn": true,
"medical": false,
"enableLoyalty": false,
"banned": false,
"searchText": "string",
"photoId": "abc123",
"doctorImportId": "abc123",
"memberGroupId": "abc123",
"startDate": 1704067200000,
"marketingSource": "string",
"loyaltyPoints": 0,
"consumerType": "AdultUse",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"exemptFromLimits": false,
"nickname": "string",
"lastVisitDate": 1704067200000,
"dlExpired": false,
"alternateEmails": [],
"alternatePhones": [],
"anonymous": false,
"enabledCareGiver": false,
"enabledCannabisLimit": false,
"tags": [],
"careGivers": [],
"allotmentOverride": {}
}
Response
Returns a Member object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": []
}
Update Member
PUT /api/v1/partner/members/{memberId}
Update an existing member's profile information. Send a MembershipUpdateRequest with the fields you want to change. Fields not included in the request will remain unchanged.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
memberId | string | The member i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
membershipLevelId | long | No | Membership Level identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": [],
"membershipLevelId": 0
}
Response
Returns a Member object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": []
}
Update Member Metadata
PUT /api/v1/partner/members/{memberId}/metadata
Update only the metadata (custom key-value pairs) on a member record. Use this to store custom data without modifying the member's core profile fields.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
memberId | string | The member i d |
Request Body
Accepts a MetadataUpdateRequest object.
Response
Returns a Member object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": []
}
Get member list
GET /api/v1/partner/members
Retrieve a paginated list of members modified within a date range. Dates are epoch milliseconds. The maximum date range is 7 days and results are capped at 100 per page. If no dates are provided, defaults to the last 7 days.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | long | No | Start date filter |
endDate | long | No | End date filter |
skip | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
Response
Returns a paginated SearchResult of Member objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": []
}
Get member list by days
GET /api/v1/partner/members/days
Retrieve members modified starting from a given date for a specified number of days (1–7). This is a convenience alternative to the date-range endpoint where you specify startDate (epoch ms) and a days count instead of an explicit end date.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | long | No | Start date filter |
days | integer | No | Number of days to query (default: 1) |
skip | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
Response
Returns a paginated SearchResult of Member objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": []
}
Get remaining member limit
GET /api/v1/partner/members/{memberId}/limits/remaining
Retrieve the remaining purchase limits for a member — how much more they can purchase within the current regulatory period. This accounts for recent purchases deducted from the total limits.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
memberId | string | The member i d |
Response
Returns a MemberLimit object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
state | string | No | State. One of: NON_US, AL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, GU, PR, VI, DC |
concentrates | number | No | Concentrates |
nonConcentrates | number | No | Non Concentrates |
plants | number | No | Plants |
seeds | number | No | Seeds |
max | number | No | Max |
thc | number | No | Thc |
duration | integer | No | Duration (default: 1) |
{
"consumerType": "AdultUse",
"state": "NON_US",
"concentrates": 0,
"nonConcentrates": 0,
"plants": 0,
"seeds": 0,
"max": 0,
"thc": 0,
"duration": 1
}
Get members by licence number
GET /api/v1/partner/members/search
Search for members by their licence number. Returns all matching members without pagination. Use the licenceNumber query parameter.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
licenceNumber | string | No | licence number |
Response
Returns a ListResult<Member> object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": []
}
Get members by dob
GET /api/v1/partner/members/search/dob
Search for members by date of birth. Supports pagination with start and limit parameters. Pass the date of birth as a string in the dob query parameter.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
dob | string | No | dob |
start | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
Response
Returns a paginated SearchResult of Member objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": []
}
Get members by phone number
GET /api/v1/partner/members/search/phone
Search for members by phone number. Set isByShop to true to limit results to the current shop, or false to search across all shops in the company.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
phoneNumber | string | No | phone number |
isByShop | boolean | No | is by shop |
start | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
Response
Returns a ListResult<Member> object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
address | Address | No | Address |
uppercaseCity | string | No | Uppercase City |
email | string | No | Email address |
dob | long | No | Dob |
birthdate | string | No | Birthdate |
localDob | string | No | Local Dob |
localDobUTC | long | No | Local Dob U T C |
primaryPhone | string | No | Primary phone number |
cpn | string | No | Cpn |
textOptIn | boolean | No | Text Opt In (default: true) |
emailOptIn | boolean | No | Email Opt In (default: true) |
medical | boolean | No | Medical |
searchText | string | No | Search Text |
metadata | Metadata[] | No | Metadata |
nickname | string | No | Nickname |
sex | gender | No | Sex (default: OTHER) |
anonymous | boolean | No | Anonymous (default: false) |
status | string | No | Status. One of: Active, Pending, Inactive (default: Inactive) |
notes | Note[] | No | Notes |
contracts | SignedContract[] | No | Contracts |
preferences | Preference[] | No | Preferences |
identifications | Identification[] | No | Identifications |
recommendations | Recommendation[] | No | Recommendations |
lastVisitDate | long | No | Last Visit timestamp (epoch ms) |
startDate | long | No | Start timestamp (epoch ms) |
importId | string | No | Import identifier |
memberGroupId | string | No | Member Group identifier |
memberGroup | MemberGroup | No | Member Group |
recentProducts | string[] | No | Recent Products |
dlExpired | boolean | No | Dl Expired |
recommendationExpired | boolean | No | Recommendation Expired |
agreementExpired | boolean | No | Agreement Expired |
emailVerified | boolean | No | Email Verified |
consumerUserId | string | No | Consumer User identifier |
marketingSource | string | No | Marketing Source |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse) |
alternateEmails | string[] | No | Alternate Emails |
enableLoyalty | boolean | No | Enable Loyalty (default: true) |
loyaltyPoints | number | No | Loyalty Points |
lifetimePoints | number | No | Lifetime Points |
enabledCareGiver | boolean | No | Enabled Care Giver (default: false) |
careGivers | string[] | No | Care Givers |
regionId | string | No | Region identifier |
addresses | Address[] | No | Addresses |
eligibleForFTMPromos | boolean | No | Eligible For F T M Promos (default: true) |
banPatient | boolean | No | Ban Patient (default: false) |
tags | string[] | No | Tags |
recommendationExpiryLeft | long | No | Recommendation Expiry Left |
referralCode | string | No | Referral Code |
complianceCardSessionId | string | No | Compliance Card Session identifier |
sbid | long | No | Sbid |
exemptFromLimits | boolean | No | Exempt From Limits (default: false) |
alternatePhones | string[] | No | Alternate Phones |
strongholdCustomerId | string | No | Stronghold Customer identifier |
consumerUserIdHistory | ConsumerUserAttachEvent[] | No | Consumer User Id History |
allotmentOverride | allotmentoverride | No | Allotment Override |
expStatuses | string[] | No | Exp Statuses |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false
}
],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
}
],
"contracts": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"contractId": "abc123",
"membershipId": "abc123",
"signedDate": 1704067200000,
"signaturePhoto": {},
"signedDigitally": false,
"consumerId": "abc123",
"memberName": "string",
"employeeName": "string",
"employeeSignaturePhoto": {},
"witnessName": "string",
"witnessSignaturePhoto": {}
}
],
"preferences": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string"
}
],
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"typeName": "string",
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"recommendations": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"recommendationNumber": "string",
"registryId": "abc123",
"verifyWebsite": "string",
"verifyPhoneNumber": "string",
"state": "CA",
"issueDate": 1704067200000,
"expirationDate": 1704067200000,
"frontPhoto": {},
"assets": [],
"doctorId": "abc123",
"temporary": false,
"limitExemption": false,
"verified": false,
"verifyMethod": "MANUAL",
"doctor": {},
"refillsAuthorized": 0,
"directions": "string"
}
],
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"discount": 0,
"defaultGroup": false,
"active": true,
"memberCount": 0,
"memberCountTextOptIn": 0,
"memberCountEmailOptIn": 0,
"enablePromotion": false,
"promotionId": "abc123"
},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [
{}
],
"allotmentOverride": {},
"expStatuses": []
}
Create Label with consumerMemberId
GET /api/v1/partner/members/referral-qr/{consumerMemberId}
Generate a referral QR code image for a consumer member. Returns a PNG image (not JSON). The response is cacheable for 30 days. Requires both user and store authentication.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
consumerMemberId | string | The consumer member i d |