Get the ticket store purchases for a ticket event.
Please note that this API returns results in pages.
The page and num parameters can be used to control paging.
You should consider using modified_since_timestamp to download ticket store purchases since the last API request when you download ticket store purchases over time.
If include_purchase_refunds is enabled, purchases will include store_purchase_refunds and/or store_purchase_cancelled_items arrays if they include refunds or cancelled items.
If include_fulfillment_info is enabled, purchases will include store_purchase_fulfillments if the items is marked as fulfilled/shipped.
Fulfilled items are items marked as shipped, but that do not include a shipping address.
Note that quantity_fulfilled may be negative, which indicates that a shipment was cancelled or otherwise unfulfilled (e.g. if someone accidentally marked an item as fulfilled, then needed to undo).
Additionally, the response will include an entered_shipping_address.
{
"store_purchases": [
{
"store_purchase_id": 43,
"ticketable_event_purchase_id": 334,
"store_purchase_ts": 1578434161,
"purchaser_first_name": "John",
"purchaser_last_name": "Smith",
"last_modified_ts": 1637700119,
"store_purchase_confirmation_code": "SEk6NhDjJzA1",
"store_purchased_items": [
{
"quantity_purchased": 1,
"store_item_id": 32,
"purchased_item_num": 1,
"store_item_variant_combination_id": 714,
"amount_paid_in_cents": 242,
"processing_fee_in_cents": 42,
"ticketable_event_ticket_id": 1333,
"item_transferred_from": [],
"item_transferred_to": []
},
{
"quantity_purchased": 3,
"store_item_id": 34,
"purchased_item_num": 2,
"store_item_variant_combination_id": 708,
"amount_paid_in_cents": 2420,
"processing_fee_in_cents": 420,
"ticketable_event_ticket_id": 1332,
"item_transferred_from": [],
"item_transferred_to": []
},
{
"quantity_purchased": 4,
"store_item_id": 36,
"purchased_item_num": 3,
"store_item_variant_combination_id": null,
"amount_paid_in_cents": 550,
"processing_fee_in_cents": 50,
"ticketable_event_ticket_id": null,
"item_transferred_from": [
{
"store_purchase_id": 44,
"purchased_item_num": 3,
"transferred_quantity": 4
}
],
"item_transferred_to": []
},
{
"quantity_purchased": 5,
"store_item_id": 38,
"purchased_item_num": 4,
"store_item_variant_combination_id": null,
"amount_paid_in_cents": 550,
"processing_fee_in_cents": 50,
"ticketable_event_ticket_id": null,
"item_transferred_from": [
{
"store_purchase_id": 22,
"purchased_item_num": 2,
"transferred_quantity": 1
},
{
"store_purchase_id": 23,
"purchased_item_num": 2,
"transferred_quantity": 4
}
],
"item_transferred_to": [
{
"store_purchase_id": 55,
"purchased_item_num": 2,
"transferred_quantity": 5
}
]
}
],
"store_purchase_refunds": [
{
"refund_id": 1,
"refunded_amount_in_cents": 2420,
"refunded_ts": 1637700110
},
{
"refund_id": 2,
"refunded_amount_in_cents": 242,
"refunded_ts": 1637700119
}
],
"store_purchase_cancelled_items": [
{
"cancelled_item_num": 1,
"cancellation_ts": 1637700110,
"store_item_id": 32,
"store_item_variant_combination_id": 714,
"quantity_cancelled": 1
},
{
"cancelled_item_num": 2,
"cancellation_ts": 1637700119,
"store_item_id": 34,
"store_item_variant_combination_id": 708,
"quantity_cancelled": 3
}
],
"store_purchase_fulfillments": [
{
"purchased_item_num": 3,
"fulfillment_ts": 1662040675,
"quantity_fulfilled": 1,
"expected_delivery_date": "2022-09-06",
"shipping_tracking_num": "ABC123",
"shipping_address": {
"full_name": "Customer Name",
"address1": "300 Mill St.",
"address2": "Suite 200",
"city": "Moorestown",
"state": "NJ",
"zipcode": "08057",
"countrycode": "US"
}
},
{
"purchased_item_num": 4,
"fulfillment_ts": 1662041000,
"quantity_fulfilled": 1,
"expected_delivery_date": null,
"shipping_tracking_num": null,
"shipping_address": null
}
],
"entered_shipping_address": {
"full_name": "Customer Name",
"address1": "300 Mill St.",
"address2": "Suite 200",
"city": "Moorestown",
"state": "NJ",
"zipcode": "08057",
"countrycode": "US"
}
},
{
"store_purchase_id": 44,
"ticketable_event_purchase_id": 335,
"store_purchase_ts": 1578434163,
"purchaser_first_name": "Jane",
"purchaser_last_name": "Smith",
"last_modified_ts": 1637696518,
"store_purchased_items": [
{
"quantity_purchased": 1,
"store_item_id": 32,
"purchased_item_num": 1,
"store_item_variant_combination_id": 712,
"amount_paid_in_cents": 242,
"processing_fee_in_cents": 42,
"ticketable_event_ticket_id": 1334,
"item_transferred_from": [],
"item_transferred_to": []
}
],
"store_purchase_refunds": [
{
"refund_id": 3,
"refunded_amount_in_cents": 242,
"refunded_ts": 1637696518
}
],
"store_purchase_cancelled_items": [
{
"cancelled_item_num": 1,
"cancellation_ts": 1637696518,
"store_item_id": 32,
"store_item_variant_combination_id": 712,
"quantity_cancelled": 1
}
],
"entered_shipping_address": {
"full_name": "Jane Smith",
"address1": "300 Mill St.",
"address2": null,
"city": "Moorestown",
"state": "NJ",
"zipcode": "08057",
"countrycode": "US"
}
}
]
}
| 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 |
|
num |
GET | 100 | Number of results per page (max 1,250). | uint |
page |
GET | 1 | Number of pages. | uint |
modified_since_timestamp |
GET | Get ticket store purchases modified on or after a given time. | uint |
|
include_cleared_purchases |
GET | F | Should cleared purchases be included? | bool |
include_purchase_refunds |
GET | F | Should purchase refunds be included? | bool |
include_fulfillment_info |
GET | F | Should purchase fulfillment/shipment info be included? | bool |
include_transfer_info |
GET | F | Should transfer info be included? | bool |
{
"openapi": "3.0.3",
"info": {
"title": "Get Ticket Store Purchases",
"description": "Get ticket store purchases 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://api.runsignup.com/rest",
"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"
},
"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"
}
}
},
"paths": {
"/v2/tickets/get-ticket-event-store-purchases.json": {
"get": {
"tags": [
"Ticket Events"
],
"summary": "Get Ticket Store Purchases",
"description": "Get ticket store purchases for a ticket event.",
"operationId": "v2_tickets_get_ticket_event_store_purchases_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"
}
},
{
"name": "num",
"in": "query",
"description": "Number of results per page (max 1,250).",
"required": false,
"schema": {
"type": "integer",
"default": "100"
}
},
{
"name": "page",
"in": "query",
"description": "Number of pages.",
"required": false,
"schema": {
"type": "integer",
"default": "1"
}
},
{
"name": "modified_since_timestamp",
"in": "query",
"description": "Get ticket store purchases modified on or after a given time.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "include_cleared_purchases",
"in": "query",
"description": "Should cleared purchases be included?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_purchase_refunds",
"in": "query",
"description": "Should purchase refunds be included?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_fulfillment_info",
"in": "query",
"description": "Should purchase fulfillment/shipment info be included?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_transfer_info",
"in": "query",
"description": "Should transfer info be included?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
}
],
"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": []
}
}
}
}
