Convention Cart

Carts are used to hold purchases from a Convention. You must have the pos ConventionPrivilege to access carts, or be the User that owns the cart. Convention Carts are accessed via /api/conventioncart.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in ConventionCartProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

convention

The Convention this convention cart belongs to.

user

The User this convention cart belongs to.

Relationships

See "Relationships" in Introduction for how to use them.

badges

Queryable
Qualifiers

boothaddons

Queryable
Qualifiers

booths

Queryable
Qualifiers

soldproducts

Queryable
Qualifiers

tickets

Queryable
Qualifiers

Services

The services used to fetch and manipulate convention carts.

Search Convention Carts

This will search across all conventions, and return the carts created by the user who's session is used to make this request. To search on a single convention see "Relationships" in Convention.

 GET /api/conventioncart
Optional Params
query

Searches a partial name.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "user_id" : "xxx",
          ...
        },
        ...
    ]
 }

Create Convention Cart

You don't need to explicitly create a cart. If you don't have one when you make these other requests, then one will be created for you.

Read Convention Cart

 GET /api/conventioncart/xxx

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention id passed as a parameter.

 GET /api/conventioncart/
Optional Params
convention_id
user_id

Returns:

 {
   "id" : "xxx",
   "name" : "The Captain is Dead",
   ...
 }

Update Convention Cart

 PUT /api/conventioncart/xxx

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention id passed as a parameter.

 PUT /api/conventioncart/
Optional Params
convention_id
user_id

Returns the same as a normal read.

Delete ConventionCart

 DELETE /api/conventioncart/xxx

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention id passed as a parameter.

 DELETE /api/conventioncart/
Optional Params
convention_id
user_id

Returns:

 {
   "success" : 1
 }

Add a Booth to the Convention Cart

 POST /api/conventioncart/xxx/booth

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention id passed as a parameter.

 POST /api/conventioncart//booth
Required Params
booth_id
exhibitor_id
Optional Params
convention_id
user_id
discount_code

Returns the same as a normal read.

Add a Booth Add On to the Convention Cart

 POST /api/conventioncart/xxx/boothaddon

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention id passed as a parameter.

 POST /api/conventioncart//boothaddon
Required Params
booth_id
exhibitor_id
boothoption_id
Optional Params
convention_id
user_id
discount_code

Returns the same as a normal read.

Add a Badge to the Convention Cart

 POST /api/conventioncart/xxx/badge

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention id passed as a parameter.

 POST /api/conventioncart//badge
Required Params
badgetype_id
name
Optional Params
convention_id
user_id
discount_code
email
booth_id
custom_fields

Returns the same as a normal read.

Add a Sold Product to the Convention Cart

 POST /api/conventioncart/xxx/soldproduct

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention id passed as a parameter.

 POST /api/conventioncart//soldproduct
Required Params
productvariant_id
badge_id
Optional Params
convention_id
user_id

Returns the same as a normal read.

Add a Ticket to the Convention Cart

 POST /api/conventioncart/xxx/ticket

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention id passed as a parameter.

 POST /api/conventioncart//ticket
Required Params
badge_id
event_id
Optional Params
convention_id
user_id

Returns the same as a normal read.

Add Multiple Tickets to Convention Cart

Add a single ticket for more than one event to a cart. For badge complimentary tickets.

 POST /api/conventioncart/xxx/ticket/multiple

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention ID passed as a parameter.

 POST /api/conventioncart//ticket/multiple
Required Params
badge_id
event_id

Pass as many event_ids as you want tickets for.

Optional Params
convention_id

For cart identification if cart ID omitted in URI.

Returns the same as a normal read.

Add Multiple Generic Tickets to Convention Cart

Add multiple generic tickets to a cart.

 POST /api/conventioncart/xxx/ticket/multiple-generic

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention ID passed as a parameter.

 POST /api/conventioncart//ticket/multiple-generic
Required Params
badge_id
quantity
Optional Params
convention_id

For cart identification if cart ID omitted in URI.

discount_code

Code for a Discount to apply to the Ticket price.

Checkout / Pay via Cash

This payment method is used with the Point of Sale system and requires a CashDrawer.

 POST /api/conventioncart/xxx/pay/cash

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention ID passed as a parameter.

 POST /api/conventioncart//pay/cash
Required Params
cashdrawer_id
Optional Params
convention_id
user_id

Returns the same as a normal read.

Checkout / Pay via Free

This payment method is used with the when the contents of the cart total zero.

 POST /api/conventioncart/xxx/pay/free

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention id passed as a parameter.

 POST /api/conventioncart//pay/free
Optional Params
convention_id
user_id

Returns the same as a normal read.

Checkout / Pay via Stripe

This payment method is used for credit card transactions, and requires that you have updated the cart with a stripe_card_id, which is not stored on our servers.

 POST /api/conventioncart/xxx/pay/stripe

You can also make the request without the ID and then the system will just use the user's cart associated with the Convention id passed as a parameter.

 POST /api/conventioncart//pay/stripe
Optional Params
convention_id
user_id
postal_code

Used to verify against the credit card's billing address.

Returns the same as a normal read.