List Memberships

GET /v2/b2b/memberships

Inputs:

  • updatedStartTime: (optional) only return memberships updated after this start time.
  • updatedEndTime: (optional) only return memberships updated before this time.
  • program: (optional) only return memberships of this program type.
  • category: (optional) only return memberships of this category.
  • subCategory: (optional) only return memberships of this sub category.
  • updatedBy: (optional) only return memberships updated by this userId.

Returns:

A list of Membership Objects


Get Membership

GET /v2/b2b/memberships/{id}

Returns:

The Membership object with the specified membership id.


Update a Membership

PUT /v2/b2b/memberships

Body:

The updated Membership object, must contain the importId of the object being updated. This will update only the cardholder / demographic information. To delete a cardholder, set the cardStatus to "dropped"

Returns:

The updated Membership object.


Membership Object

Field
Description
idA unique ID for this membership. Read Only 
program

The program for this membership.

category

Name of the membership (e.g. Individual, Dual, Family)

subcategoryA sub category for this membership.
levelA numeric level for this category
importIdA unique value that does not change.
fund

The specific financial purposes of gifts. Read Only

campaignThe overall objective to raise money. Read Only
appeal

The solicitations and promotions that bring in gifts. Read Only

externalMembershipIdExternal Membership Number
membershipJoinedDateThe date of the membership acquisition

membershipStartDate

The date the current membership term began.
membershipExpirationDateThe date the current membership term will expire.
membershipStandingThe standing of the membership (active, lapsed)
membershipCategoryMembership Level Name
categoryIdMembership Level Id
externalIdID from external source (such as the CRM system)
membershipTypeIdA linking back to our membership_types table with the type of membership.
cardholdersThe list of cardholders for this membership.
cardholders[x].idMembership Card Holder ID
cardholders[x].visitorIdn/a - ACME internal only field - do not use
cardholders[x].membershipIdMaps to id from the membership table.
cardholders[x].externalCustomerIdCustomer ID from external source (e.g. CRM system)
cardholders[x].externalContactIdContact ID from external source (e.g. CRM system) 
cardholders[x].constituentId
cardholders[x].acmeCustomerNumber
cardholders[x].constituentImportIdThe import id for the constituent.
cardholders[x].cardImportIdThe import id for this card.
cardholders[x].cardTypeThe type of card holder, one of (primary or other)
cardholders[x].nameThe name on the card.
cardholders[x].barcodeThe value on the barcode.
cardholders[x].acmeBarcodeACME's barcode for the cardholder
cardholders[x].emailThe member's email address.
cardholders[x].prefixThe prefix for the name. e.g. Mr. or Mrs.
cardholders[x].suffixThe suffix for the name. e.g. Jr.
cardholders[x].firstNameThe member's first name.
cardholders[x].lastNameThe member's last name.
cardholders[x].orgNamethe name of the organization when this membership is an organization membership.
cardholders[x].phoneNumberThe member's phone number.
cardholders[x].phoneNotes
cardholders[x].streetAddress1The member's street address.
cardholders[x].streetAddress2The member's extended street address.
cardholders[x].cityThe member's city.
cardholders[x].stateThe member's state.
cardholders[x].zipCodeThe member's zipCode.
cardholders[x].countryThe country that the member lives in.
cardholders[x].orgNameOrganization Name
cardholders[x].orgIdOrganization ID
cardholders[x].addressId
cardholders[x].deceasedBoolean value to denote deceased
cardholders[x].suburb
cardholders[x].primaryCardBoolean value to denote the card is the primary
cardholders[x].solicitationCodesList of Solicitation messages for the members
cardholders[x].details
cardholders[x].details[y].admits
cardholders[x].details[y].filmPlusExpirationDate
cardholders[x].details[y].filmPlusStatus
cardholders[x].details[y].juniorAssociateCategory
cardholders[x].details[y].juniorAssociateExpirationDate
cardholders[x].details[y].juniorAssociateStatus
cardholders[x].details[y].ps1PlusStatus
cardholders[x].details[y].ps1ExpirationDate
cardholders[x].cardHolderAttributes
cardholders[x].cardHolderAttributes[y].membershipIdMembership ID
cardholders[x].cardHolderAttributes[y].cardHolderIdMembership Card Holder ID
cardholders[x].cardHolderAttributes[y].categoryMembership Category
cardholders[x].cardHolderAttributes[y].description
cardholders[x].cardHolderAttributes[y].notes
cardholders[x].cardHolderAttributes[y].dateMembership Joined Date
cardholders[x].startDateMembership start date
cardholders[x].expirationDateMembership expiration date
cardholders[x].cardStatusLimit events to those that support the specified card status. Valid card status are:
  • new
  • active
  • dropped 
  • lapsed
  • noMembership
  • replaced
cardholders[x].printCountTotal Membership card printed
cardholders[x].printStatusLimit events to those that support the specified print status. Valid print status are:
  • printed
  • notPrinted
  • doNotPrint
  • lost

cardholders[x].orgImportIdorganization ID from import
cardholders[x].middleNamecardholder's middle name
cardholders[x].acmeCustomerNumberUnique ACME customer number
cardholders[x].excludeCardOnMemberCreationboolean value to exclude card while member creation
cardholders[x].customerId
entitlementsList of entitlements. Fields is only populated if entitlements were imported with the membership
entitlements[x].idUnique ID for this entitlement. (READ ONLY)
entitlements[x].benefitThe name of the benefit.
entitlements[x].memberIdMembership ID
entitlements[x].visitorIdn/a. ACME internal only field - do not use
entitlements[x].countThe number of these benefits the member has.
entitlements[x].importIdThe import id for this entitlement.
entitlements[x].commentA comment about the benefit.
offeringIdMembership Offering ID
pricePointIdPrice Point ID for the membership purchase
organizationIdOrganization Id
orgImportId
organizationNameOrganization Name
isGiftboolean to denote the membership purchase is a gift
auxiliaryMembershipboolean to denote auxiliary membership
membershipLevelCollectionIdMembership Level Group ID
membershipLevelCollectionNameMembership Level Group Name
offeringNameMembership Offering ID
updatedOnUpdated on date
updatedByUser id that last updated the record, matching the users the tenant has.  Will show the ACME system user (340) in the case the operation was done by ACME (ie - changing the standing from active to lapsed)


Example Payloads


Get Membership Info by ID

GET /v2/b2b/memberships/6911520
Sample JSON Response

{

    "id": 6911520,

    "importId": "ACMEACS314670906",

    "program": "golden2_program",

    "category": "golden2_category",

    "subcategory": "golden2_subcategory",

    "membershipTypeId": 616,

    "externalMembershipId": "ACS314670906",

    "membershipJoinedDate": "2016-12-23T00:00:00-08:00",

    "membershipStartDate": "2024-02-28T04:16:13-08:00",

    "membershipExpirationDate": "2025-02-28T23:59:59-08:00",

    "membershipStanding": "active",

    "cardholders": [

        {

            "id": 22800544,

            "membershipId": 6911520,

            "constituentImportId": "ACMEACS269150004",

            "constituentId": "ACS269150004",

            "cardImportId": "ACMEACS369056059",

            "cardType": "primary",

            "name": "Vanor Zhang",

            "barcode": "ACS369056059",

            "acmeBarcode": "ACS369056059",

            "firstName": "Vanor",

            "lastName": "Zhang",

            "streetAddress1": "46380 Sentinel",

            "city": "Fremont",

            "state": "Arizona",

            "zipCode": "95678",

            "country": "United States",

            "deceased": "no",

            "primaryCard": "yes",

            "solicitationCodes": "",

            "startDate": "2024-02-28T04:16:13-08:00",

            "expirationDate": "2025-02-28T23:59:59-08:00",

            "cardStatus": "active",

            "printCount": 0,

            "printStatus": "notPrinted",

            "acmeCustomerNumber": "ACS269150004",

            "addressId": 1104236,

            "excludeCardOnMemberCreation": false,

            "customerId": 1229417,

            "ignoreUpdates": false

        },

        {

            "id": 22800545,

            "membershipId": 6911520,

            "cardImportId": "ACMEACS374959567",

            "cardType": "secondary",

            "name": "Guest of Vanor Zhang",

            "barcode": "ACS374959567",

            "acmeBarcode": "ACS374959567",

            "deceased": "no",

            "primaryCard": "no",

            "solicitationCodes": "",

            "startDate": "2024-02-28T04:16:13-08:00",

            "expirationDate": "2025-02-28T23:59:59-08:00",

            "cardStatus": "active",

            "printCount": 0,

            "printStatus": "notPrinted",

            "excludeCardOnMemberCreation": false,

            "ignoreUpdates": false

        }

    ],

    "entitlements": [],

    "membershipCategory": "SFDC Level A",

    "categoryId": "584f7aa179e71d507664059c",

    "acmeMembershipNumber": "ACS314670906",

    "isGift": false,

    "auxiliaryMembership": false,

    "offeringName": "SFDC Level A Offering",

    "updatedOn": "2024-02-28T04:16:14-08:00",

    "updatedBy": 2258,

    "offeringId": "069e1a4051aa45ebb53e3705455cb31b",

    "pricePointId": "598a50281f021633a8691405"

}

Update Membership
Scenario: Update the Start Date and Expiration date of the above membership & cardholders

POST /v2/b2b/memberships/
Sample JSON Payload

{

    "id":6911520,

    "importId":"ACMEACS314670906",

    "membershipJoinedDate": "2016-12-23T00:00:00-08:00",

    "membershipStartDate": "2024-02-20T04:16:13-08:00",

    "membershipExpirationDate": "2025-03-31T23:59:59-07:00",

    "membershipStanding":"active",

    "cardholders":[

        {

            "id":22800544,

            "constituentImportId":"ACMEACS269150004",  

            "cardType":"primary",

            "startDate": "2024-02-20T04:16:13-08:00",

            "expirationDate": "2025-03-31T23:59:59-07:00",

            "cardStatus":"active",

            "name": "Vanor Zhang",

            "firstName": "Vanor",

            "lastName": "Zhang",

            "streetAddress1": "46380 Sentinel",

            "city": "Fremont",

            "state": "Arizona",

            "zipCode": "95678",

            "country": "United States"

        },

        {

            "id": 22800545,

            "cardType": "secondary",

            "name": "Guest of Vanor Zhang",

            "startDate": "2024-02-20T04:16:13-08:00",

            "expirationDate": "2025-03-31T23:59:59-07:00",

            "cardStatus": "active"

        }

    ]

Response


Sample JSON Response

{

    "id": 6911520,

    "importId": "ACMEACS314670906",

    "membershipTypeId": 616,

    "externalMembershipId": "ACS314670906",

    "membershipJoinedDate": "2016-12-23T00:00:00-08:00",

    "membershipStartDate": "2024-02-20T00:00:00-08:00",

    "membershipExpirationDate": "2025-03-31T23:59:59-07:00",

    "membershipStanding": "active",

    "cardholders": [

        {

            "id": 22800544,

            "membershipId": 6911520,

            "constituentImportId": "ACMEACS269150004",

            "cardImportId": "ACMEACS369056059",

            "cardType": "primary",

            "name": "Vanor Zhang",

            "barcode": "ACS369056059",

            "acmeBarcode": "ACS369056059",

            "firstName": "Vanor",

            "lastName": "Zhang",

            "streetAddress1": "46380 Sentinel",

            "city": "Fremont",

            "state": "Arizona",

            "zipCode": "95678",

            "country": "United States",

            "deceased": "no",

            "primaryCard": "yes",

            "solicitationCodes": "",

            "startDate": "2024-02-20T00:00:00-08:00",

            "expirationDate": "2025-03-31T23:59:59-07:00",

            "cardStatus": "active",

            "printCount": 0,

            "printStatus": "notPrinted",

            "acmeCustomerNumber": "ACS269150004",

            "addressId": 1104236,

            "excludeCardOnMemberCreation": false,

            "customerId": 1229417,

            "ignoreUpdates": false

        },

        {

            "id": 22800545,

            "membershipId": 6911520,

            "cardImportId": "ACMEACS374959567",

            "cardType": "secondary",

            "name": "Guest of Vanor Zhang",

            "barcode": "ACS374959567",

            "acmeBarcode": "ACS374959567",

            "deceased": "no",

            "primaryCard": "no",

            "solicitationCodes": "",

            "startDate": "2024-02-20T00:00:00-08:00",

            "expirationDate": "2025-03-31T23:59:59-07:00",

            "cardStatus": "active",

            "printCount": 0,

            "printStatus": "notPrinted",

            "excludeCardOnMemberCreation": false,

            "ignoreUpdates": false

        }

    ],

    "entitlements": [],

    "membershipCategory": "SFDC Level A",

    "categoryId": "584f7aa179e71d507664059c",

    "acmeMembershipNumber": "ACS314670906",

    "isGift": false,

    "auxiliaryMembership": false,

    "offeringName": "SFDC Level A Offering",

    "updatedOn": "2024-02-28T04:32:38-08:00",

    "updatedBy": 340,

    "offeringId": "069e1a4051aa45ebb53e3705455cb31b",

    "pricePointId": "598a50281f021633a8691405"

}