Home → API Documentation → Miscellaneous API Calls → api/UserBasket

11.1. api/UserBasket

This API call returns any items currently waiting for payment/action in the user’s basket.

 

---

 

Parameters To Submit

All parameters are required and cannot be empty.

Parameter	Parameter Help
uid	Contact’s uid.
Item	Options available for this item are Bookings, Subscriptions or an empty string (to return "All" items)
API key

 

---

 

Return Response

This API call will return an array of any items requiring action by the user. ItemGUIDs returned in this array should be used when making a payment. Subscriptions in the user’s basket may include "Join" or "Renew" subscriptions.

ResponseMessage will return the following fields of data.

Item Type “Booking”

Field	Field Help
ItemGUID	bid.
Item	Returns that the item is a “Booking”.
ItemDetails	The event name.
ItemContact	The contact attending the event the booking is associated with.
ItemValue	The booking price, excluding tax.
ItemTax	The booking tax.
ItemTaxRate	The booking tax rate.
ItemTotal	The booking price includes tax.
ItemSaving	The actual saving made on the booking.
ItemPotentialSaving	The savings set for the price type.
ItemRateType	Price type used for booking.
ItemInfo1	Special requests made.
ItemInfo2	Booking notes made. Normally, for internal purposes for the client.
eid	The event’s eid the booking was made for.
NamedGuestOrg	Named guest organisation (if a named guest was set).
NamedGuestName	Named guest name (if a named guest was set).
NamedGuestEmail	Named guest email (if a named guest was set).
ExcludeFromDelegateList	Depending on the client’s configuration, this will indicate whether the attendee on the booking has been specifically marked as excluded from the delegate list, or whether the contact associated as the attendee’s general preference is to not appear on delegate lists.

 

Item Type “Subscription”

Field	Field Help
ItemGUID	Sale GUID.
Item	Returns that the item is a “Subscription”.
ItemDetails	The sale service.
ItemContact	The contact the sale pipeline item is associated with.
ItemValue	The sale pipeline price excluding tax.
ItemTax	The sale pipeline tax.
ItemTaxRate	The sale pipeline tax rate.
ItemTotal	The sale pipeline price including tax.
ItemSaving	N/A
ItemPotentialSaving	N/A
ItemRateType	N/A
ItemInfo1	N/A
ItemInfo2	N/A
eid	N/A