TABLE OF CONTENTS
- List Membership Cards
- Get Membership Cards
- Send Membership Card Email (Coming Soon!)
- Membership Card Object
These are two endpoints to retrieve membership card data. There is currently no way to directly edit membership card data through the API.
List Membership Cards
Get all membership cards for a specific membership version.
GET v1/b2b/membership/cards
Request Parameters
Field | Type | Description | Required |
|---|---|---|---|
| membershipId | string | Database id of the membership version | yes |
Sample Request
GET https://sand10-api.acmeticketing.net/v1/b2b/membership/cards?memberId=2244527
Response Parameters
Returns a non-paginated list of membership card objects (see below).
Get Membership Cards
Get a single membership card by id
GET v1/b2b/membership/cards/{id}Path Variables
Field | Type | Description | Required |
|---|---|---|---|
| id | string | Database id of the membership card | yes |
Sample Request
GET https://sand10-api.acmeticketing.net/v1/b2b/membership/cards/236799
Response Parameters
Returns a single membership card object (see below).
Send Membership Card Email (Coming Soon!)
Send the Membership Card email to the Primary Cardholder on the membership.
POST /v2/b2b/membership/{membershipId}/emailPath Variables
Field | Type | Description | Required |
|---|---|---|---|
| id | string | Database id of the membership | yes |
Sample Request
POST 'https://sand6-api.acmeticketing.net/v2/b2b/membership/4425558/email'
Response
Includes details about the card and the email sent.
Membership Card Object
- Customer fields are only applicable if the membership card is associated with a customer.
- Address fields are only applicable if the associated cardholder has an associated address.
- Organization fields are only applicable if the membership is associated with an org
Field | Type | Description |
|---|---|---|
| id | Long | Database id of the membership card |
| visitorId | Long | ACME internal only field - do not use |
| membershipId | Long | Database id of the parent membership |
| externalCustomerId | String | |
| externalContactId | String | External id of the associated contact, when applicable |
| constituentId | String | Customer import id |
| acmeCustomerNumber | String | |
| cardImportId | String | |
| cardType | String | primary or secondary |
| name | String | Name on the card. Typically the first and last name of a customer. |
| barcode | String | |
| acmeBarcode | String | |
| String | Customer email | |
| prefix | String | Customer prefix |
| suffix | String | Customer suffix |
| firstName | String | Customer first name |
| lastName | String | Customer last name |
| phoneNumber | String | Customer phone number |
| phoneNotes | String | Customer phone notes |
| streetAddress1 | String | Customer address1 |
| streetAddress2 | String | Customer address2 |
| city | String | Customer city |
| state | String | Customer state |
| zipCode | String | Customer zip code |
| country | String | Customer country |
| orgName | String | Organization name |
| orgId | Long | Database id of the organization |
| deceased | boolean | Imported data |
| suburb | String | imported data |
| primaryCard | boolean | true if cardType is primary |
| solicitationCodes | List<String> | imported data |
| details | MembershipCardholderDetails Object | imported data |
| cardholderAttributes | List<MembershipAttribute Object> | imported data |
| startDate | Date | |
| expirationDate | Date | |
| cardStatus | MembershipStanding | The standing of the card: can be one of the following values
|
| printCount | Integer | Number of times the card was printed on ACME Sales |
| printStatus | PrintStatus | Can be one of the following values
|
| customerId | Long | Database id of the associated customer |
| orgImportId | String | |
| excludeCardOnMembershipCreation | boolean | internal use |
| ignoreUpdates | boolean | internal use |