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:read

Retrieve a list of all items for an event specified using the eventId path parameter.

name	type	description
GET: https://api.constantcontact.com/v2/eventspot/events/{eventId}/items
Test API
api_key	query	REQUIRED; The API key for the application
eventId	path	Unique ID of the event for which to retrieve items

Response CodesTOP

code	description
200	Request was successful
401	Authentication failure
404	An event could not be found for the eventId provided
406	Unsupported Accept Header value, must be 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

id	string (100)	The attribute's unique ID
name	string (100)	Name of attribute being sold
quantity_available	integer	Number of item attributes that are still available for sale (quantityTotal - quantitySold)
quantity_total	integer	Number of attributes offered for sale

default_quantity_available

integer

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

default_quantity_total

integer

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

string (100)

Unique ID of the item

name

string (100)

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

per_registrant_limit

integer

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

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":"9k7uXp6Hgyiq7BCC11zFc4PJUvBGM9P1V53KQcYO8Aw",
    "name":"Running Belt",
    "description":"Moisture Wicking, holds 2 bottles",
    "price":20.25,
    "attributes":[
        {
        "id":"9k7uXp6Hgyiq7BCC11zFc0XQU2aR_wPmDNJVddPgGWM",
        "name":"Royal Blue",
        "quantity_total":175,
        "quantity_available":175
        },
        {
        "id":"9k7uXp6Hgyiq7BCC11zFc476STDHQ_sadfwfRCYGMSU",
        "name":"Hi-Vis Green",
        "quantity_total":75,
        "quantity_available":75
        }
    ],
    "per_registrant_limit":1,
    "show_quantity_available":true,
    "default_quantity_total":250
    },
    {
    "id":"9k7uXp6Hgyiq7BCC11zFc7IwqpZ7nzW2Y09fUs00t3Q",
    "name":"Golf Shirt w/logo",
    "description":"Underarmour moisture wicking material",
    "price":32.0,
    "attributes":[
    ],
    "per_registrant_limit":2,
    "show_quantity_available":true,
    "default_quantity_total":300,
    "default_quantity_available":300
    }
]