Get the store info for a ticket event.
The attachment_type indicates where the item can be purchased.
For example, an item might be sold only in the standalone store or only when registering for an event.
The current possible value are listed below, but your integration should gracefully handle the additional of other attachment types in the future.
standalonewith_event_registrationstandalone_or_with_event_registrationper_event_registrationstandalone_or_per_event_registration
{
"ticketable_event_name": "My Ticketable Event Name",
"store_items": [
{
"store_item_id": 32,
"item_name": "T-Shirt",
"price_in_cents": 200,
"faux_price_in_cents": 300,
"num_variants": 2,
"available_start_ts": 1571025600,
"available_end_ts": 1605329999,
"min_quantity_per_order": 0,
"max_quantity_per_order": 999999999,
"total_quantity_available": null,
"attachment_type": "with_event_registration",
"min_quantity_per_attachment": 0,
"max_quantity_per_attachment": 999999999,
"sort_order": 1,
"deleted": "F",
"images": [
{
"small": "https://example.com/small.png",
"medium": "https://example.com/medium.png",
"large": "https://example.com/large.png"
}
],
"store_item_variants": [
{
"store_item_variant_id": 216,
"variant_num": 1,
"item_variant_name": "Small",
"sort_order": 1,
"deleted": "F"
},
{
"store_item_variant_id": 219,
"variant_num": 2,
"item_variant_name": "Red",
"sort_order": 1,
"deleted": "F"
},
{
"store_item_variant_id": 217,
"variant_num": 1,
"item_variant_name": "Medium",
"sort_order": 2,
"deleted": "F"
},
{
"store_item_variant_id": 220,
"variant_num": 2,
"item_variant_name": "White",
"sort_order": 2,
"deleted": "F"
},
{
"store_item_variant_id": 218,
"variant_num": 1,
"item_variant_name": "Large",
"sort_order": 3,
"deleted": "F"
},
{
"store_item_variant_id": 221,
"variant_num": 2,
"item_variant_name": "Blue",
"sort_order": 3,
"deleted": "F"
}
],
"store_item_variant_labels": [
{
"variant_num": 1,
"variant_label": "Size"
},
{
"variant_num": 2,
"variant_label": "Color"
}
],
"store_item_variant_combinations": [
{
"store_item_variant_combination_id": 708,
"price_in_cents": null,
"faux_price_in_cents": null,
"total_quantity_available": null,
"deleted": "F",
"variant_store_item_variant_ids": [
216,
219
]
},
{
"store_item_variant_combination_id": 709,
"price_in_cents": null,
"faux_price_in_cents": null,
"total_quantity_available": null,
"deleted": "F",
"variant_store_item_variant_ids": [
216,
220
]
},
{
"store_item_variant_combination_id": 710,
"price_in_cents": null,
"faux_price_in_cents": null,
"total_quantity_available": null,
"deleted": "F",
"variant_store_item_variant_ids": [
216,
221
]
},
{
"store_item_variant_combination_id": 711,
"price_in_cents": null,
"faux_price_in_cents": null,
"total_quantity_available": null,
"deleted": "F",
"variant_store_item_variant_ids": [
217,
219
]
},
{
"store_item_variant_combination_id": 712,
"price_in_cents": null,
"faux_price_in_cents": null,
"total_quantity_available": null,
"deleted": "F",
"variant_store_item_variant_ids": [
217,
220
]
},
{
"store_item_variant_combination_id": 713,
"price_in_cents": null,
"faux_price_in_cents": null,
"total_quantity_available": null,
"deleted": "F",
"variant_store_item_variant_ids": [
217,
221
]
},
{
"store_item_variant_combination_id": 714,
"price_in_cents": null,
"faux_price_in_cents": null,
"total_quantity_available": null,
"deleted": "F",
"variant_store_item_variant_ids": [
218,
219
]
},
{
"store_item_variant_combination_id": 715,
"price_in_cents": null,
"faux_price_in_cents": null,
"total_quantity_available": null,
"deleted": "F",
"variant_store_item_variant_ids": [
218,
220
]
},
{
"store_item_variant_combination_id": 716,
"price_in_cents": null,
"faux_price_in_cents": null,
"total_quantity_available": null,
"deleted": "F",
"variant_store_item_variant_ids": [
218,
221
]
}
]
}
]
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
ticket_event_idRequired |
GET | ID of ticket event. | uint |
|
rsu_api_key |
GET | API key. | string |
|
X-RSU-API-SECRET |
HTTP Header | API secret. | string |
{
"openapi": "3.0.3",
"info": {
"title": "Get Ticket Event Store Info",
"description": "Get store info for a ticket event.",
"version": "1.0.0",
"contact": {
"name": "RunSignup API Support",
"url": "https://runsignup.com/API",
"email": "info@runsignup.com"
}
},
"servers": [
{
"url": "https://runsignup.com/API",
"description": "Production API Server"
}
],
"tags": [
{
"name": "Ticket Events",
"description": "APIs related to Ticket Events"
}
],
"components": {
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error message"
}
},
"required": [
"error"
]
},
"BadRequestError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating invalid request parameters or structure"
}
]
},
"UnauthorizedError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating authentication failure"
}
]
},
"ForbiddenError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the authenticated user lacks required permissions"
}
]
},
"NotFoundError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the requested resource does not exist"
}
]
},
"ServerError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating an unexpected server-side issue"
}
]
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "query",
"name": "api_key",
"description": "RunSignup API Key"
},
"apiSecret": {
"type": "apiKey",
"in": "query",
"name": "api_secret",
"description": "RunSignup API Secret"
}
}
},
"paths": {
"/v2/tickets/get-ticket-event-store-info.json": {
"get": {
"tags": [
"Ticket Events"
],
"summary": "Get Ticket Event Store Info",
"description": "Get store info for a ticket event.",
"operationId": "v2_tickets_get_ticket_event_store_info_json",
"parameters": [
{
"name": "ticket_event_id",
"in": "query",
"description": "ID of ticket event.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "checkin_api_key",
"in": "query",
"description": "Checkin API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-CHECKIN-API-SECRET",
"in": "header",
"description": "Checkin API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "rsu_api_key",
"in": "query",
"description": "API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-SECRET",
"in": "header",
"description": "API secret.",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKey": []
},
{
"apiSecret": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerError"
}
}
}
}
},
"x-permissions": []
}
}
}
}
