This API returns every giveaway option on an event with the quantity remaining in its inventory.
quantity_remaining is the inventory’s total quantity minus the registrations assigned to that inventory.
Options that share a giveaway_option_inventory_id return the same quantity_remaining.
quantity_remaining is null when the option has no inventory.
0 means none are left, and a negative number means the inventory is oversold.
{
"giveaway_options": [
{
"giveaway_option_id": 1,
"giveaway_option_inventory_id": 10,
"quantity_remaining": 4
},
{
"giveaway_option_id": 2,
"giveaway_option_inventory_id": 10,
"quantity_remaining": 4
},
{
"giveaway_option_id": 3,
"giveaway_option_inventory_id": null,
"quantity_remaining": null
}
]
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
rsu_api_reg |
GET | API caller token. If used, you must send the API caller password in an HTTP header named X-RSU-API-REG-SECRET. | string |
|
X-RSU-API-REG-SECRET |
HTTP Header | API caller password. | string |
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
api_key |
GET | Race API key. | string |
|
api_secret |
GET | Race API secret. | string |
|
rsu_api_key |
GET | API key | string |
|
X-RSU-API-SECRET |
HTTP Header | API secret | string |
|
Authorization |
HTTP Header | OAuth 2.0 Authorization header (e.g. `Bearer ...`). | string |
|
race_idRequired |
GET | Race ID. | uint |
|
event_idRequired |
GET | Event ID. | uint |
{
"openapi": "3.0.3",
"info": {
"title": "Get Giveaway Inventories",
"description": "Get the remaining inventory for each giveaway option on an event.",
"version": "1.0.0",
"contact": {
"name": "RunSignup API Support",
"url": "https://runsignup.com/API",
"email": "info@runsignup.com"
}
},
"servers": [
{
"url": "https://api.runsignup.com/rest",
"description": "Production API Server"
}
],
"tags": [
{
"name": "CheckIn",
"description": "APIs related to CheckIn"
}
],
"components": {
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error message"
},
"details": {
"type": "object",
"description": "Additional error details",
"additionalProperties": true
}
},
"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"
},
"apiCaller": {
"type": "apiKey",
"in": "query",
"name": "rsu_api_reg",
"description": "API caller token (format: <id>.<token>)"
},
"apiCallerSecret": {
"type": "apiKey",
"in": "header",
"name": "X-RSU-API-REG-SECRET",
"description": "API caller password"
}
}
},
"paths": {
"/v2/giveaway-inventories.json": {
"get": {
"tags": [
"CheckIn"
],
"summary": "Get Giveaway Inventories",
"description": "Get the remaining inventory for each giveaway option on an event.",
"operationId": "v2_giveaway_inventories_json",
"parameters": [
{
"name": "rsu_api_reg",
"in": "query",
"description": "API caller token. If used, you must send the API caller password in an HTTP header named X-RSU-API-REG-SECRET.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-REG-SECRET",
"in": "header",
"description": "API caller password.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "api_key",
"in": "query",
"description": "Race API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "api_secret",
"in": "query",
"description": "Race API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"name": "Authorization",
"in": "header",
"description": "OAuth 2.0 Authorization header (e.g. `Bearer ...`).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "race_id",
"in": "query",
"description": "Race ID.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "event_id",
"in": "query",
"description": "Event ID.",
"required": true,
"schema": {
"type": "integer"
}
}
],
"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": [
"affiliates",
"partners",
"race_directors",
"timers"
]
}
}
}
}
Log in and register as an API caller to get the most out of the API documentation.
