Update fulfillment info on ticket store purchases.
The API request JSON should include a store_purchases array that includes the details on up to 100 purchases to update shipping information on.
Each purchase must have a store_purchase_fulfillments array with at least one fulfilled item.
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).
{
"store_purchases": [
{
"store_purchase_id": 43,
"store_purchase_fulfillments": [
{
"purchased_item_num": 3,
"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,
"quantity_fulfilled": 1,
"expected_delivery_date": null,
"shipping_tracking_num": null,
"shipping_address": null
}
]
},
{
"store_purchase_id": 44,
"store_purchase_fulfillments": [
{
"purchased_item_num": 1,
"quantity_fulfilled": -1,
"expected_delivery_date": null,
"shipping_tracking_num": null,
"shipping_address": null
}
]
}
]
}
The API response will include a list of store purchases with the remaining quantities for the items that were updated.
{
"store_purchases": [
{
"store_purchase_id": 43,
"remaining_quantities": [
{
"purchased_item_num": 3,
"new_quantity_remaining": 1
},
{
"purchased_item_num": 4,
"new_quantity_remaining": 0
}
]
},
{
"store_purchase_id": 44,
"remaining_quantities": [
{
"purchased_item_num": 1,
"new_quantity_remaining": 1
}
]
}
]
}
| 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 |
|
requestRequired |
POST | JSON containing request data. | string |
{
"openapi": "3.0.3",
"info": {
"title": "Update Ticket Store Purchase Fulfillment Info",
"description": "Update ticket store purchase fulfillment (e.g. shipping) 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/store/fulfillment.json": {
"post": {
"tags": [
"Ticket Events"
],
"summary": "Update Ticket Store Purchase Fulfillment Info",
"description": "Update ticket store purchase fulfillment (e.g. shipping) for a ticket event.",
"operationId": "v2_tickets_store_fulfillment_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": [],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"request": {
"type": "string"
}
},
"required": [
"request"
]
}
}
}
}
}
}
}
}
