TABLE OF CONTENTS

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
membershipIdstringDatabase id of the membership versionyes


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
idstringDatabase id of the membership cardyes



Sample Request

GET https://sand10-api.acmeticketing.net/v1/b2b/membership/cards/{236799}



Response Parameters


Returns a single membership card object (see below).


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
idLongDatabase id of the membership card
visitorIdLong Internal use
membershipIdLong Database id of the parent membership
externalCustomerIdString
externalContactIdStringExternal id of the associated contact, when applicable
constituentIdStringCustomer import id
acmeCustomerNumberString
cardImportIdString
cardTypeStringprimary or secondary
nameString Name on the card. Typically the first and last name of a customer.
barcodeString 
acmeBarcodeString 
emailString Customer email
prefixString Customer prefix
suffixString Customer suffix
firstNameStringCustomer first name
lastNameString Customer last name
phoneNumberString Customer phone number
phoneNotesString Customer phone notes
streetAddress1StringCustomer address1
streetAddress2StringCustomer address2 
cityString Customer city
stateString Customer state
zipCodeString Customer zip code
countryStringCustomer country
orgNameStringOrganization name
orgIdLongDatabase id of the organization
deceasedbooleanImported data
suburbStringimported data
primaryCardbooleantrue if cardType is primary
solicitationCodesList<String>imported data
detailsMembershipCardholderDetails Objectimported data
cardholderAttributesList<MembershipAttribute Object>imported data
startDateDate
expirationDateDate
cardStatusMembershipStandingThe standing of the card: can be one of the following values
  • New
  • Active
  • Dropped
  • Lapsed
  • Replaced
printCountIntegerNumber of times the card was printed on ACME Sales
printStatusPrintStatusCan be one of the following values
  • printed
  • notPrinted
  • doNotPrint
  • lost
customerIdLongDatabase id of the associated customer
orgImportIdString
excludeCardOnMembershipCreationbooleaninternal use
ignoreUpdatesbooleaninternal use