Individual Event Item Endpoint

Use Event Items to make products associated with an event available to registrants and their guests (if applicable) for purchase or at no cost, on the event registration page. Use this API endpoint to retrieve (GET), update (PUT), and DELETE a specific event item.

Methods:

Click a method to view its documentation

GET PUT DELETE

DescriptionTOP

Privileges required: campaign:read

Retrieve an event item by using the eventId and itemId path parameters to specify the event and item. 

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

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 retrieve the item

itemId

path

Unique ID of the item to retrieve

Response CodesTOP

code

description

200

Request was successful

401

Authentication failure

404

Could not find either an event or an item for the eventId or the itemId 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

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 for sale, 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 that is shown on the registration page

id

string (100)

The items unique ID

name

string (100)

Item name that is shown on the registration page

per_registrant_limit

integer

The maximum quantity of this item that a registrant, as well as any of their 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
}