Our v3 API is now available! Learn more by visiting the v3 developer portal.

Event Item Collection

Event Items are products that are associated with an event that may be for sale or available at no cost. They are listed on an event registration page so that registrants can access them during the registration process. Use this API endpoint to create (POST) a new item and retrieve (GET) all existing items associated with an event.

Methods:

Click a method to view its documentation

GET POST

DescriptionTOP

Privileges required: campaign:write

Create a new item for an event specified using the eventId path parameter. To create an item, include the following items in the JSON request body:

  • name - each item for an event must have a unique name, with mininum length of 1 character
  • price - if an item is available at no cost to registrants and guest, set = 0.00
  • default_quantity_total - starting quantity of this item available to registrants and guests
  • per_registrant_limit - maximum quantity available to each registrant or guest
  • show_quantity_available - use this setting to display, or not, the remaining quantity available on the registration page.

Optionally you can include a description of the item in the request body as well.

After you create an item, you can then add attributes to it, such as sizes, colors, just to name a few, using the Item Attribute Collection endpoint.

POST: https://api.constantcontact.com/v2/eventspot/events/{eventId}/items

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

eventId

path

Unique ID of the event for which to create the item

Example JSON Request BodyTOP

{
    "name": "Golf Shirt w/logo",
    "description":"Underarmour moisture wicking material",
    "price":32.0,
    "per_registrant_limit": 2,
    "show_quantity_available": false,
    "default_quantity_total": 300
}

Response CodesTOP

code

description

201

Item was successfully created

400

Bad Request: Either JSON was malformed or there was a data validation error

401

Authentication failure

404

An event with specified ID not found

406

Unsupported accept header value, must be application/json

409

Item name already in use

415

Unsupported content-type in the header, use application/json

500

Internal server error occurred

StructureTOP

property

type(max length)

description

+ attributes

array

An array of item attributes and options, add attributes after the item is created, see Item Attribute Collection POST (Read Only)

default_quantity_available

integer

Number of items available for sale, displayed on the registration page if show_quantity_available = true. (Read Only)

default_quantity_total

integer

REQUIRED. The total quantity of items offered, minimum = 0, cannot leave blank. If the item has attributes, the summation of the quantity_total for all attributes automatically overwrites the value you enter here.

description

string (2048)

The item description shown on the registration page

id

string (100)

Unique ID of the item (Read Only)

name

string (100)

REQUIRED. Name of the item shown on the registration page, minimum length = 1.

per_registrant_limit

integer

REQUIRED. The maximum number of this item that registrants and guests can purchase, minimum = 0, cannot leave blank; value cannot be greater than the value of default_quantity_available

price

number

REQUIRED. The item cost, minimum = 0.00

show_quantity_available

boolean

If true, displays the remaining quantity of this item for purchase on the registration page

Example ResponseTOP

{
    "id":"9k7uXp6Hgyiq7BCC11zFc7IwqpZ7nzW2Y09fUs00t3Q",
    "name":"Golf Shirt w/logo",
    "description":"Underarmour moisture wicking material",
    "price":32.0,
    "attributes":[
    ],
    "per_registrant_limit":2,
    "show_quantity_available":false,
    "default_quantity_total":300,
    "default_quantity_available":300
}