Get Ticket Store Purchases

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).

Response Format

	
		{
			"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
						},
						{
							"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
						},
						{
							"quantity_purchased": 1,
							"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
						},
						{
							"quantity_purchased": 1,
							"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
						}
					],
					"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
						}
					]
				},
				{
					"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
						}
					],
					"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
						}
					]
				}
			]
		}
	

URL

https://www.givesignup.org/rest/v2/tickets/get-ticket-event-store-purchases.json

HTTP Method

GET

Parameters

Parameter HTTP Method Default Description Datatype
ticket_event_id
Required
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

If you continue to use this site, you consent to use all cookies. We use cookies to offer you a better browsing experience. Read how we use cookies and how you can control them by visiting our Privacy Policy.

If you continue to use this site, you consent to use all cookies.