TABLE OF CONTENTS

Add-Ons

Add ons are fixed-price inventory that can be added on to events.  These include everything from an Audio Guide to a Cheese Pizza to a Service Charge.


In ACME, Donations are a type of Add-On and use the same endpoints as the Add-On object. To flag an Add-On as a donation, set the type attribute to donation for a variable donation or fixedDonation for a regular donation.


List add-ons

GET /v2/b2b/addons

returns a paginated list of add-on objects

  • page: Optional. The page that you want returned, default is 1.
  • pageSize: Optional. The number of items you want returned in a page.  Default is 100. Setting this to -1 will return everything.
  • sortField: Optional. The field that you want to sort by 
  • sortDirection : Optional. Can be asc or desc based on the required direction of sorting. 
  • search:  Optional. The add-on you are looking for. 
  • addOnTypes: Optional. The type of add-ons you are looking for. Comma separated values. When not set, returns everything.


Sample Request:
v2/b2b/addons?addonTypes=donation,fixedDonation,membershipCardReplacement


Get a single Add-On object

GET /v2/b2b/addons/{id}

input:  

  • id:  the id of the add-on object.

returns the add-on object associated to id

Add an Add-On object

POST /v2/b2b/addons

input: 

  • An add-on Object to be added

Returns

  • The resulting add-on object with the id filled in.

Update an Add-On object

PUT /v2/b2b/addons

input: 

  • The add-on object to be updated

Returns

  • The resulting add-on object.

Consume an Add-On object

PUT /v2/b2b/addons/consume

input: 

  • The consume add-on object

Returns

  • The resulting add-on object.

Recharge an Add-On object

PUT /v2/b2b/addons/fill

input: 

  • The consume add-on object

Returns

  • The resulting add-on object.

Delete ad Add-On object

DELETE /v2/b2b/addons/{id}

input: 

  • id:  the id of the item to be deleted

Returns

  • the add-on object of the item that was deleted.


AddOns Object

Field
Description
Notes
idUnique id of the inventory item.
nameThe name of the inventory Item.
descriptionThe description of the inventory Item.
skuThe SKU (Stock Keeping Unit) for the inventory item.
priceThe price of the inventory item.
quantityThe number of inventory items available.
typeThe type of inventory item one of: doNotTrack, consumable, resource, donation, fixedDonation, membershipCardReplacementdonation= variable donation
displayOrderThe order you want this item displayed in when you list the add ons.
activeWhether the add-on item is active or not (true or false)
createdOnThe date that this item was created.
updatedOnThe time that this item was created.
salesChannelsA list of sales channels specifying which sales channels are enabled for this add on.
.salesChannels[x].nameName of the channel.
salesChannels[x].channelLabel of the channel.
salesChannels[x].enabledBoolean value, true if enabled otherwise false.

There are different types of add-on objects:

  • Consumables 
    • catalog
    • brochure
    • t-shirt
    • cheese pizza
    • gift box
    • cd
  • Resources
    • audio guide
    • meet the scientist/athlete/giraffe 
  • Donation
  • Fixed Donation
  • Membership Card Replacement

Consume Add-On Object

  • id:  Add-on id of item to be consumed
  • quantity: number of items to consume

Recharge Add-On Object

  • id:  Add-on id of item to be recharged
  • quantity: number of items to be added