TABLE OF CONTENTS
- TABLE OF CONTENTS
Membership Object
Field | Description | Required |
|---|---|---|
| id | A unique ID for this membership. | Required Read Only |
| importId | A unique value that does not change. | Required Read Only |
| membershipStanding | The standing of the membership (active, lapsed) | Required |
| membershipJoinedDate | The date the current membership term began. | Optional |
membershipStartDate | The date the current membership term began. | Optional |
| membershipExpirationDate | The date the current membership term will expire. | Required |
| acmeMembershipNumber | The membership number generated by ACME upon creation. | Read Only |
| externalMembershipId | Corresponds to an external Membership Number. Can be specified in the Checkout API for a Membership purchase. | Read Only |
| externalId | ID from external source (such as the CRM system). Must be unique per membership version. Can be specified in the Checkout API for a Membership purchase. | Read Only |
| membershipCategory | Membership Level Name | Read Only |
| categoryId | Membership Level Id | Read Only |
| offeringName | Membership Offering Name | Read Only |
| offeringId | Membership Offering ID | Read Only |
| pricePointId | Price Point ID for the membership purchase | Read Only |
| isGift | Boolean to denote if the membership purchase is a gift | Read Only |
| auxiliaryMembership | Boolean to denote auxiliary membership | Read Only |
| membershipLevelCollectionName | Name of the Auxiliary group, if applicable | Read Only |
| membershipLevelCollectionId | ID of the Auxiliary group, if applicable | Read Only |
| cardholders[] | The list of cardholders for this membership. | Required Must send at least the primary card |
| cardholders[x].id | Membership Cardholder ID | Required Read Only |
| cardholders[x].constituentImportId | The Constituent Import ID for the customer associated with the cardholder.
| < Depends on if new or existing cardholder |
| cardholders[x].customerId | The ACME Database ID of the Customer | Read Only |
| cardholders[x].cardType | The type of card holder, one of (primary or secondary) | Required Case sensitive (must be 'primary' or 'secondary') |
| cardholders[x].cardStatus | Valid card status are:
| Required |
| cardholders[x].expirationDate | Cardholder expiration date. Validation will ensure that is is not after the membership expiration date | Required |
| cardholders[x].startDate | Cardholder start date. | Optional |
| cardholders[x].firstName | The member's first name. | Optional** |
| cardholders[x].lastName | The member's last name. | Optional** |
| cardholders[x].name | The name on the card.
| < Depends on type of cardholder |
| cardholders[x].email | The member's email address. | Optional** |
| cardholders[x].phoneNumber | The member's phone number. | Optional** |
| cardholders[x].addressId | ID of the member's address. | Optional** |
| cardholders[x].streetAddress1 | The member's street address. | Optional** |
| cardholders[x].streetAddress2 | The member's extended street address. | Optional** |
| cardholders[x].city | The member's city. | Optional** |
| cardholders[x].state | The member's state. | Optional** |
| cardholders[x].zipCode | The member's ZIP or Postal Code. | Optional** |
| cardholders[x].country | The member's country. | Optional** |
| cardholders[x].membershipId | The ID of the membership. | Read Only |
| cardholders[x].customerExternalId | Customer ID from external source (e.g. CRM system) | Optional |
| cardholders[x].acmeCustomerNumber | The Customer Number that ACME assigns. | Read Only |
| cardholders[x].cardImportId | The import id for this card. | Read Only |
| cardholders[x].barcode | The value on the barcode. | Optional |
| cardholders[x].acmeBarcode | ACME's barcode for the cardholder | Read Only |
| cardholders[x].orgName | the name of the organization when this membership is an organization membership. | Read Only |
| cardholders[x].orgName | Organization Name | Read Only |
| cardholders[x].orgId | Organization ID | Read Only |
| cardholders[x].deceased | Boolean value to denote deceased | Optional |
| cardholders[x].primaryCard | Boolean value to denote the card is the primary | Read Only |
| cardholders[x].solicitationCodes | List of Solicitation messages for the members | Read Only |
| cardholders[x].printCount | Total Membership card printed | Read Only |
| cardholders[x].printStatus | Limit events to those that support the specified print status. Valid print status are:
| Read Only |
| cardholders[x].orgImportId | organization ID from import | Read Only |
| cardholders[x].excludeCardOnMemberCreation | boolean value to exclude card while member creation | Read Only |
| entitlements[ ] | List of entitlements. Fields is only populated if entitlements were imported with the membership | |
| entitlements[x].id | Unique ID for this entitlement. (READ ONLY) | |
| entitlements[x].benefit | The name of the benefit. | |
| entitlements[x].memberId | Membership ID | |
| entitlements[x].visitorId | n/a. ACME internal only field - do not use | |
| entitlements[x].count | The number of these benefits the member has. | |
| entitlements[x].importId | The import id for this entitlement. | |
| entitlements[x].comment | A comment about the benefit. | |
| organizationId | Organization Id | |
| orgImportId | ||
| organizationName | Organization Name | |
| updatedOn | Updated on date | Read Only |
| updatedBy | User id that last updated the record, matching the users the tenant has. Will show the ACME system user in the case the operation was done by ACME (ie - changing the standing from active to lapsed) | Read Only |
** These optional fields must be provided to retain their current value.
Membership Info Object
| membershipCategoryId (Required) The published ID of the selected membership category | Example: 5db23799142c4af6d682187a |
| membershipOfferingId (Required) The ID of the selected membership offering | Example: f9767e088edd42209ad1af659c9c7d3e |
| pricePointId (Required) The ID of the selected price point | Example: c22e7a599eb049fe9e17d102 |
| membershipCards[ ] (Required for checkout: Primary Cardholder) A list of membership cards. The number of cards may not exceed the limit specified on the offering in backoffice. Requires one primary cardholder with first name, last name, and one of: email, address, or phone number. For a full list of membership card fields see Membership Cards. Do not include a constituent import id field unless a matching customer already exists. | |
| isGift (Boolean) If the membership is a gift, mark as true. If so, gifterInfo is required. | Example:
|
| gifterInfo (Required when isGift is true) A Customer object representing the gift giver. You may either search for an existing customer and use that object, or create a new customer for the gifter. In order to create a new customer you must populate Customer Source, First, Last and one of (email, address, phone). | |
| notifyGiftRecipient If the membership is a gift, setting this flag will send a correspondence to the gift recipient. Setting the flag to False will result in the email going to the gift giver Setting the flag to True will result in the email going to the gift recipient (This is the default behavior if no flag value is set) | Example:
|
| giftMessage If the membership is a gift, the gift giver can add a message for the recipient which appears on the member card email, if configured to send in Backoffice. Note: The gift membership is only used in sending the email at the time of purchase and is not stored in ACME. | Example: Donated in honor of your birthday! Hope you have a wonderful day. |
| isAutorenew (Boolean) If the membership offering is configured as Auto Renew Optional, setting this flag to true will opt the member into Auto Renew and generate a subscription. The default value is false, which will not opt the user into Auto Renew and will not create a subscription. | Example:
|
Entitlement Result Object
POST /v2/b2c/entitlements/validate| valid (Boolean) False means there is a violation in the shopping cart. | Example:
|
| messages[ ] List of short descriptions (string format) of violations. | |
| results[ ] List of detailed results of the validation | |
| violations[ ] List of detailed descriptions (Entitlements Result Summary) of the violations | |