viagogo Sales API (2.249.0.0)
List sales (recent updates)
List sales for the authenticated user that have been created or updated over a certain period of time.
Authorizations:
read:user
read:sales
) query Parameters
updated_since | string <date-time> Filters the response to only return items that have been updated since the given timestamp |
Responses
Response Schema: application/hal+json
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(SalesLinks (object or null)) | |
(SalesEmbeddedResources (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "status": "string",
- "status_description": "string",
- "display_proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "confirm_by": "2019-08-24T14:15:22Z",
- "ship_by": "2019-08-24T14:15:22Z",
- "external_listing_id": "string",
- "is_legacy_stubhub_order": true,
- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "in_hand_at": "2019-08-24T14:15:22Z",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:autotrackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:changepapertickettoeticket": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:confirm": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:contactuswebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:etickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:eticketuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:listing": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:reject": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:saveetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:savetransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:shipments": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:ticketholders": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:trackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:transferreceiptuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadeticketurls": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadtransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:webpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticket_type": {
- "type": "string",
- "name": "string",
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticketholders": [
- {
- "id": 0,
- "title": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "city_of_birth": "string",
- "province_of_birth": "string",
- "city_of_residence": "string",
- "province_of_residence": "string",
- "club_issuer": "string",
- "card_number": "string",
- "document_type": "string",
- "document_number": "string",
- "fiscal_code": "string",
- "security_code": "string",
- "generic_answer": "string",
- "email_address": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "document_issuing_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": null,
- "country:events": null,
- "country:localwebpage": null
}
}, - "nationality_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": null,
- "country:events": null,
- "country:localwebpage": null
}
}
}
}
], - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:events": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:localwebpage": {
- "href": null,
- "title": null,
- "templated": null
}
}
}
}
}
}
}
]
}
}
List sales
List sales for the authenticated user.
Authorizations:
read:user
read:sales
) query Parameters
page | integer <int32> Specifies which page of data to retrieve. |
page_size | integer <int32> Set custom page sizes on response. |
updated_since | string <date-time> Filters the response to only return items that have been updated since the given timestamp |
sort | string Determines the ordering of items. A comma-separated string containing |
Responses
Response Schema: application/hal+json
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(SalesLinks (object or null)) | |
(SalesEmbeddedResources (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "status": "string",
- "status_description": "string",
- "display_proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "confirm_by": "2019-08-24T14:15:22Z",
- "ship_by": "2019-08-24T14:15:22Z",
- "external_listing_id": "string",
- "is_legacy_stubhub_order": true,
- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "in_hand_at": "2019-08-24T14:15:22Z",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:autotrackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:changepapertickettoeticket": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:confirm": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:contactuswebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:etickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:eticketuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:listing": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:reject": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:saveetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:savetransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:shipments": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:ticketholders": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:trackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:transferreceiptuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadeticketurls": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadtransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:webpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticket_type": {
- "type": "string",
- "name": "string",
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticketholders": [
- {
- "id": 0,
- "title": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "city_of_birth": "string",
- "province_of_birth": "string",
- "city_of_residence": "string",
- "province_of_residence": "string",
- "club_issuer": "string",
- "card_number": "string",
- "document_type": "string",
- "document_number": "string",
- "fiscal_code": "string",
- "security_code": "string",
- "generic_answer": "string",
- "email_address": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "document_issuing_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": null,
- "country:events": null,
- "country:localwebpage": null
}
}, - "nationality_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": null,
- "country:events": null,
- "country:localwebpage": null
}
}
}
}
], - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:events": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:localwebpage": {
- "href": null,
- "title": null,
- "templated": null
}
}
}
}
}
}
}
]
}
}
Get a sale
Authorizations:
read:user
read:sales
) path Parameters
saleId required | integer <int32> |
Responses
Response Schema: application/hal+json
id | integer or null <int32> The sale identifier. |
created_at | string or null <date-time> The date when the sale was created. |
(Seating (object or null)) The seating information for the ticket(s) that have been sold. | |
(Money (object or null)) The total amount that the seller will receive for the sale. | |
number_of_tickets | integer or null <int32> The number of tickets that have been sold. |
status | string or null A short localised string describing the current status of the sale. |
status_description | string or null A localised in-depth description of the current status of the sale. |
(Money (object or null)) The total amount that the seller will receive for the sale. | |
confirm_by | string or null <date-time> The date by which the seller must confirm the sale. |
ship_by | string or null <date-time> The date by which the seller must ship the tickets. |
external_listing_id | string or null The listing identifier assigned by an external system, typically generated by the seller's inventory management software. |
is_legacy_stubhub_order | boolean Boolean value that is set to true for legacy stubhub orders. |
Array of objects or null (BarcodeInformation) The barcode(s) for the ticket(s). | |
in_hand_at | string or null <date-time> The date and time that the seller has the tickets 'in hand' to deliver to the buyer. |
(SaleLinks (object or null)) | |
(SaleEmbeddedResources (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "status": "string",
- "status_description": "string",
- "display_proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "confirm_by": "2019-08-24T14:15:22Z",
- "ship_by": "2019-08-24T14:15:22Z",
- "external_listing_id": "string",
- "is_legacy_stubhub_order": true,
- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "in_hand_at": "2019-08-24T14:15:22Z",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:autotrackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:changepapertickettoeticket": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:confirm": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:contactuswebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:etickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:eticketuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:listing": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:reject": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:saveetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:savetransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:shipments": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:ticketholders": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:trackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:transferreceiptuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadeticketurls": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadtransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:webpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticket_type": {
- "type": "string",
- "name": "string",
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticketholders": [
- {
- "id": 0,
- "title": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "city_of_birth": "string",
- "province_of_birth": "string",
- "city_of_residence": "string",
- "province_of_residence": "string",
- "club_issuer": "string",
- "card_number": "string",
- "document_type": "string",
- "document_number": "string",
- "fiscal_code": "string",
- "security_code": "string",
- "generic_answer": "string",
- "email_address": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "document_issuing_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "nationality_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
], - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
}
}
Update a sale
Authorizations:
write:user
write:sales
) path Parameters
saleId required | integer <int32> |
Request Body schema: application/json
confirmed | boolean or null True when the sale should be confirmed; Otherwise, false. |
eticket_ids | Array of integers or null <int32> A array of the identifiers of the E-Tickets or proof of transfer to be assigned to the sale. |
transfer_confirmation_number | string or null Transfer confirmation number. |
Array of objects or null (ETicketUrlRequest) Urls with which the buyers can access the etickets. | |
change_paper_ticket_to_eticket | boolean or null True when the ticket(s) should be changed from paper to E-ticket; Otherwise, false. |
confirm_same_day_shipment | boolean or null True when same-day shipment is confirmed; Otherwise, false |
in_hand_at | string or null <date-time> The date and time that the seller has the tickets 'in hand' to deliver to the buyer. |
eticket_type | string or null The type of ticket(s) that was sold. |
tracking_number | string or null Tacking number of the ticket shipment. |
(Seating (object or null)) Any updated seating information about the tickets sold | |
Array of objects or null (BarcodeInformation2) The barcode(s) for the ticket(s). | |
mobile_provider | string or null The vendor being used to transfer the mobile ticket. Can be one of the following values: StubHub, Viagogo, Ticketmaster, AXS, SeatGeek, Ticketmaster Account Manager, MLB Ballpark, MPV, Paciolan, Tickets.com, Tickets.com RDP, Vivenu, Ticketmaster CA, Eventbrite, Livenation, Broadway, Telecharge, Ticketon, Seetickets, Etix, Tixr, Festicket, Insomniac, DiceImport, MGMResorts, Tickeri, SmithCenterImport, Stubwire, Computicket, |
Responses
Response Schema: application/hal+json
id | integer or null <int32> The sale identifier. |
created_at | string or null <date-time> The date when the sale was created. |
(Seating (object or null)) The seating information for the ticket(s) that have been sold. | |
(Money (object or null)) The total amount that the seller will receive for the sale. | |
number_of_tickets | integer or null <int32> The number of tickets that have been sold. |
status | string or null A short localised string describing the current status of the sale. |
status_description | string or null A localised in-depth description of the current status of the sale. |
(Money (object or null)) The total amount that the seller will receive for the sale. | |
confirm_by | string or null <date-time> The date by which the seller must confirm the sale. |
ship_by | string or null <date-time> The date by which the seller must ship the tickets. |
external_listing_id | string or null The listing identifier assigned by an external system, typically generated by the seller's inventory management software. |
is_legacy_stubhub_order | boolean Boolean value that is set to true for legacy stubhub orders. |
Array of objects or null (BarcodeInformation) The barcode(s) for the ticket(s). | |
in_hand_at | string or null <date-time> The date and time that the seller has the tickets 'in hand' to deliver to the buyer. |
(SaleLinks (object or null)) | |
(SaleEmbeddedResources (object or null)) |
Request samples
- Payload
{- "confirmed": true,
- "eticket_ids": [
- 0
], - "transfer_confirmation_number": "string",
- "eticket_urls": [
- {
- "url": "string",
- "index": 0
}
], - "change_paper_ticket_to_eticket": true,
- "confirm_same_day_shipment": true,
- "in_hand_at": "2019-08-24T14:15:22Z",
- "eticket_type": "string",
- "tracking_number": "string",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "barcode_values": [
- "string"
]
}
], - "mobile_provider": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 500
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "status": "string",
- "status_description": "string",
- "display_proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "confirm_by": "2019-08-24T14:15:22Z",
- "ship_by": "2019-08-24T14:15:22Z",
- "external_listing_id": "string",
- "is_legacy_stubhub_order": true,
- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "in_hand_at": "2019-08-24T14:15:22Z",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:autotrackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:changepapertickettoeticket": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:confirm": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:contactuswebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:etickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:eticketuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:listing": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:reject": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:saveetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:savetransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:shipments": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:ticketholders": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:trackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:transferreceiptuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadeticketurls": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadtransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:webpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticket_type": {
- "type": "string",
- "name": "string",
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticketholders": [
- {
- "id": 0,
- "title": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "city_of_birth": "string",
- "province_of_birth": "string",
- "city_of_residence": "string",
- "province_of_residence": "string",
- "club_issuer": "string",
- "card_number": "string",
- "document_type": "string",
- "document_number": "string",
- "fiscal_code": "string",
- "security_code": "string",
- "generic_answer": "string",
- "email_address": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "document_issuing_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "nationality_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
], - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
}
}
Reject a sale
Report a problem with a sale of tickets.
Authorizations:
write:user
write:sales
) path Parameters
saleId required | integer <int32> |
Responses
Response samples
- 401
- 403
- 500
{- "code": "string",
- "message": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Upload e-tickets or proof of transfer for a sale
Once the PDFs has been successfully been uploaded, you must also patch the sale confirming which pages of each PDF should be saved against the order. To do this, the Ids of the etickets property embedded in the EticketUploadEmbeddedResources of each upload, and patch the sale with those Ids.
Authorizations:
write:user
write:sales
) path Parameters
saleId required | integer <int32> |
query Parameters
page | integer <int32> Specifies which page of data to retrieve. |
page_size | integer <int32> Set custom page sizes on response. |
Responses
Response Schema: application/hal+json
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(ETicketUploadsLinks (object or null)) | |
(ETicketUploadsEmbeddedResources (object or null)) |
Response samples
- 200
- 400
- 401
- 403
- 500
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "file_name": "string",
- "processed_at": "2019-08-24T14:15:22Z",
- "original_number_of_etickets": 0,
- "status_description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticketupload:document": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "etickets": [
- {
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:document": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:thumbnail": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
]
}
}
]
}
}
List e-ticket uploads for a sale
Authorizations:
read:user
read:sales
) path Parameters
saleId required | integer <int32> |
query Parameters
page | integer <int32> Specifies which page of data to retrieve. |
page_size | integer <int32> Set custom page sizes on response. |
Responses
Response Schema: application/hal+json
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(ETicketUploadsLinks (object or null)) | |
(ETicketUploadsEmbeddedResources (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "file_name": "string",
- "processed_at": "2019-08-24T14:15:22Z",
- "original_number_of_etickets": 0,
- "status_description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticketupload:document": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "etickets": [
- {
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:document": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:thumbnail": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
]
}
}
]
}
}
List e-tickets for a sale
Authorizations:
read:user
read:sales
) path Parameters
saleId required | integer <int32> |
query Parameters
page | integer <int32> Specifies which page of data to retrieve. |
page_size | integer <int32> Set custom page sizes on response. |
Responses
Response Schema: application/hal+json
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(ETicketsLinks (object or null)) | |
(ETicketsEmbeddedResources (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:document": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:thumbnail": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
]
}
}
Upload and save e-tickets for a sale
Authorizations:
write:user
write:sales
) path Parameters
saleId required | integer <int32> |
Responses
Response Schema: application/hal+json
id | integer or null <int32> The sale identifier. |
created_at | string or null <date-time> The date when the sale was created. |
(Seating (object or null)) The seating information for the ticket(s) that have been sold. | |
(Money (object or null)) The total amount that the seller will receive for the sale. | |
number_of_tickets | integer or null <int32> The number of tickets that have been sold. |
status | string or null A short localised string describing the current status of the sale. |
status_description | string or null A localised in-depth description of the current status of the sale. |
(Money (object or null)) The total amount that the seller will receive for the sale. | |
confirm_by | string or null <date-time> The date by which the seller must confirm the sale. |
ship_by | string or null <date-time> The date by which the seller must ship the tickets. |
external_listing_id | string or null The listing identifier assigned by an external system, typically generated by the seller's inventory management software. |
is_legacy_stubhub_order | boolean Boolean value that is set to true for legacy stubhub orders. |
Array of objects or null (BarcodeInformation) The barcode(s) for the ticket(s). | |
in_hand_at | string or null <date-time> The date and time that the seller has the tickets 'in hand' to deliver to the buyer. |
(SaleLinks (object or null)) | |
(SaleEmbeddedResources (object or null)) |
Response samples
- 200
- 400
- 401
- 403
- 500
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "status": "string",
- "status_description": "string",
- "display_proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "confirm_by": "2019-08-24T14:15:22Z",
- "ship_by": "2019-08-24T14:15:22Z",
- "external_listing_id": "string",
- "is_legacy_stubhub_order": true,
- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "in_hand_at": "2019-08-24T14:15:22Z",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:autotrackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:changepapertickettoeticket": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:confirm": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:contactuswebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:etickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:eticketuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:listing": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:reject": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:saveetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:savetransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:shipments": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:ticketholders": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:trackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:transferreceiptuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadeticketurls": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadtransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:webpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticket_type": {
- "type": "string",
- "name": "string",
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticketholders": [
- {
- "id": 0,
- "title": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "city_of_birth": "string",
- "province_of_birth": "string",
- "city_of_residence": "string",
- "province_of_residence": "string",
- "club_issuer": "string",
- "card_number": "string",
- "document_type": "string",
- "document_number": "string",
- "fiscal_code": "string",
- "security_code": "string",
- "generic_answer": "string",
- "email_address": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "document_issuing_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "nationality_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
], - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
}
}
Delete e-ticket from a sale
Authorizations:
write:user
write:sales
) path Parameters
saleId required | integer <int32> |
eticketId required | integer <int32> |
Responses
Response samples
- 401
- 403
- 500
{- "code": "string",
- "message": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Get e-ticket thumbnail file
Download an image file containing a thumbnail of an E-Ticket
Authorizations:
read:user
) path Parameters
eticketId required | integer <int32> |
Responses
Response Schema: application/octet-stream
Response samples
- 401
- 403
- 404
- 500
{- "code": "string",
- "message": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Get e-ticket upload file
Download the original file that was uploaded.
Authorizations:
read:user
) path Parameters
eticketUploadId required | integer <int32> |
Responses
Response Schema: application/octet-stream
Response samples
- 401
- 403
- 404
- 500
{- "code": "string",
- "message": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Get e-ticket file
Download a PDF file containing an E-Ticket.
Authorizations:
read:user
) path Parameters
eticketId required | integer <int32> |
Responses
Response Schema: application/octet-stream
Response samples
- 401
- 403
- 404
- 500
{- "code": "string",
- "message": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
List payments
Lists payments for the authenticated user.
Authorizations:
read:user
read:payment
) Responses
Response Schema: application/octet-stream
Response samples
- 401
- 403
- 404
- 500
{- "code": "string",
- "message": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Get a payment
Authorizations:
read:user
read:payment
) path Parameters
paymentId required | integer <int32> |
Responses
Response Schema: application/hal+json
id | integer or null <int32> The payment identifier |
created_at | string or null <date-time> Date when the payment was created. |
number_of_sales | integer <int32> Total number of sales associated to the payment. |
(Money (object or null)) Net amount the user will receive in this payment. | |
(Money (object or null)) Non-proceeds credits applied to the user's account, paid out in this payment. | |
(Money (object or null)) Charges applied to the user's account, settled in this payment. | |
(Money (object or null)) Money owed to the user from sale(s) of a ticket(s), paid out in this payment. | |
(PaymentLinks (object or null)) | |
(PaymentEmbeddedResources (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "number_of_sales": 0,
- "payment_amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "credits": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "charges": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "payment_method": {
- "details": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sales": [
- {
- "proceeds": [
- {
- "amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "reason_description": "string"
}
], - "charges": [
- {
- "amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "reason_description": "string"
}
], - "credits": [
- {
- "amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "reason_description": "string"
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sale": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:events": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:localwebpage": {
- "href": null,
- "title": null,
- "templated": null
}
}
}
}
}
}
}
]
}
}
Preview next payment
Previews the next payment for the authenticated user. The payment will not have an id
and is subject to changes.
Authorizations:
read:user
read:payment
) Responses
Response Schema: application/hal+json
id | integer or null <int32> The payment identifier |
created_at | string or null <date-time> Date when the payment was created. |
number_of_sales | integer <int32> Total number of sales associated to the payment. |
(Money (object or null)) Net amount the user will receive in this payment. | |
(Money (object or null)) Non-proceeds credits applied to the user's account, paid out in this payment. | |
(Money (object or null)) Charges applied to the user's account, settled in this payment. | |
(Money (object or null)) Money owed to the user from sale(s) of a ticket(s), paid out in this payment. | |
(PaymentLinks (object or null)) | |
(PaymentEmbeddedResources (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "number_of_sales": 0,
- "payment_amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "credits": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "charges": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "payment_method": {
- "details": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sales": [
- {
- "proceeds": [
- {
- "amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "reason_description": "string"
}
], - "charges": [
- {
- "amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "reason_description": "string"
}
], - "credits": [
- {
- "amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "reason_description": "string"
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sale": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:events": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:localwebpage": {
- "href": null,
- "title": null,
- "templated": null
}
}
}
}
}
}
}
]
}
}
Get shipping label for a sale
Authorizations:
read:user
read:sales
) path Parameters
saleId required | integer <int32> |
shipmentId required | integer <int32> |
Responses
Response Schema: application/octet-stream
Response samples
- 401
- 403
- 404
- 500
{- "code": "string",
- "message": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
List shipments for a sale
Authorizations:
read:user
read:sales
) path Parameters
saleId required | integer <int32> |
query Parameters
page | integer <int32> Specifies which page of data to retrieve. |
page_size | integer <int32> Set custom page sizes on response. |
Responses
Response Schema: application/hal+json
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(ShipmentsLinks (object or null)) | |
(ShipmentsEmbeddedResources (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:create": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "tracking_number": "string",
- "delivery_address": {
- "full_name": "string",
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "country": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:entertrackingnumber": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:label": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "pickup_addresses": [
- {
- "id": 0,
- "full_name": "string",
- "default": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:carrier": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": null,
- "country:events": null,
- "country:localwebpage": null
}
}
}
}
], - "pickups": [
- {
- "id": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "address": {
- "full_name": "string",
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "country": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "pickup:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "carrier": {
- "id": 0,
- "name": "string",
- "pickup_windows": [
- null
], - "_links": {
- "self": null,
- "carrier:createpickup": null
}
}
}
}
], - "shipment_state": {
- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string"
}
}
}
]
}
}
Print a shipping label for a sale
Authorizations:
write:user
write:sales
) path Parameters
saleId required | integer <int32> |
Responses
Response Schema: application/hal+json
id | integer <int32> The shipment identifier. |
tracking_number | string or null The identifier used to track the shipment of the ticket(s). |
(Address (object or null)) The address that the seller must ship the tickets to. | |
(ShipmentLinks (object or null)) | |
(ShipmentEmbeddedResources (object or null)) |
Response samples
- 200
- 400
- 401
- 403
- 500
{- "id": 0,
- "tracking_number": "string",
- "delivery_address": {
- "full_name": "string",
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "country": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:entertrackingnumber": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:label": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "pickup_addresses": [
- {
- "id": 0,
- "full_name": "string",
- "default": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:carrier": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
], - "pickups": [
- {
- "id": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "address": {
- "full_name": "string",
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "country": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "pickup:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "carrier": {
- "id": 0,
- "name": "string",
- "pickup_windows": [
- {
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z"
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "carrier:createpickup": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
], - "shipment_state": {
- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string"
}
}
}
Update a shipment for a sale
Authorizations:
write:user
write:sales
) path Parameters
saleId required | integer <int32> |
shipmentId required | integer <int32> |
Request Body schema: application/json
tracking_number | string or null The identifier used to track the shipment of the ticket(s). |
Responses
Response Schema: application/hal+json
id | integer <int32> The shipment identifier. |
tracking_number | string or null The identifier used to track the shipment of the ticket(s). |
(Address (object or null)) The address that the seller must ship the tickets to. | |
(ShipmentLinks (object or null)) | |
(ShipmentEmbeddedResources (object or null)) |
Request samples
- Payload
{- "tracking_number": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 500
{- "id": 0,
- "tracking_number": "string",
- "delivery_address": {
- "full_name": "string",
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "country": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:entertrackingnumber": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:label": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "pickup_addresses": [
- {
- "id": 0,
- "full_name": "string",
- "default": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:carrier": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
], - "pickups": [
- {
- "id": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "address": {
- "full_name": "string",
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "country": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "pickup:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "carrier": {
- "id": 0,
- "name": "string",
- "pickup_windows": [
- {
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z"
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "carrier:createpickup": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
], - "shipment_state": {
- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string"
}
}
}
List ticket holder details for a sale
Authorizations:
read:user
read:sales
) path Parameters
saleId required | integer <int32> |
Responses
Response Schema: application/hal+json
id | integer or null <int32> |
title | string or null |
full_name | string or null |
date_of_birth | string or null <date-time> |
city_of_birth | string or null |
province_of_birth | string or null |
city_of_residence | string or null |
province_of_residence | string or null |
club_issuer | string or null |
card_number | string or null |
document_type | string or null |
document_number | string or null |
fiscal_code | string or null |
security_code | string or null |
generic_answer | string or null |
email_address | string or null |
(TicketHolderLinks (object or null)) | |
(TicketHolderEmbeddedResources (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "title": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "city_of_birth": "string",
- "province_of_birth": "string",
- "city_of_residence": "string",
- "province_of_residence": "string",
- "club_issuer": "string",
- "card_number": "string",
- "document_type": "string",
- "document_number": "string",
- "fiscal_code": "string",
- "security_code": "string",
- "generic_answer": "string",
- "email_address": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "document_issuing_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "nationality_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
Returned for monetary values, such as ticket prices, fees charged and tax amounts.
amount required | number or null <decimal> The decimal amount of the money. |
currency_code required | string or null The ISO 4217 currency code that the monetary value is represented in. |
display | string or null A user-friendly string representing the monetary value. |
{- "amount": 0,
- "currency_code": "string",
- "display": "string"
}
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(ETicketsLinks (object or null)) | |
(ETicketsEmbeddedResources (object or null)) |
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:document": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:thumbnail": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
]
}
}
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(ETicketUploadsLinks (object or null)) | |
(ETicketUploadsEmbeddedResources (object or null)) |
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "file_name": "string",
- "processed_at": "2019-08-24T14:15:22Z",
- "original_number_of_etickets": 0,
- "status_description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticketupload:document": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "etickets": [
- {
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:document": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "eticket:thumbnail": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
]
}
}
]
}
}
A payment on the viagogo marketplace that belongs to the currently authenticated user.
id | integer or null <int32> The payment identifier |
created_at | string or null <date-time> Date when the payment was created. |
number_of_sales | integer <int32> Total number of sales associated to the payment. |
(Money (object or null)) Net amount the user will receive in this payment. | |
(Money (object or null)) Non-proceeds credits applied to the user's account, paid out in this payment. | |
(Money (object or null)) Charges applied to the user's account, settled in this payment. | |
(Money (object or null)) Money owed to the user from sale(s) of a ticket(s), paid out in this payment. | |
(PaymentLinks (object or null)) | |
(PaymentEmbeddedResources (object or null)) |
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "number_of_sales": 0,
- "payment_amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "credits": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "charges": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "payment_method": {
- "details": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sales": [
- {
- "proceeds": [
- {
- "amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "reason_description": "string"
}
], - "charges": [
- {
- "amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "reason_description": "string"
}
], - "credits": [
- {
- "amount": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "reason_description": "string"
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sale": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:events": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:localwebpage": {
- "href": null,
- "title": null,
- "templated": null
}
}
}
}
}
}
}
]
}
}
A sale on the viagogo marketplace that belongs to the currently authenticated user.
id | integer or null <int32> The sale identifier. |
created_at | string or null <date-time> The date when the sale was created. |
(Seating (object or null)) The seating information for the ticket(s) that have been sold. | |
(Money (object or null)) The total amount that the seller will receive for the sale. | |
number_of_tickets | integer or null <int32> The number of tickets that have been sold. |
status | string or null A short localised string describing the current status of the sale. |
status_description | string or null A localised in-depth description of the current status of the sale. |
(Money (object or null)) The total amount that the seller will receive for the sale. | |
confirm_by | string or null <date-time> The date by which the seller must confirm the sale. |
ship_by | string or null <date-time> The date by which the seller must ship the tickets. |
external_listing_id | string or null The listing identifier assigned by an external system, typically generated by the seller's inventory management software. |
is_legacy_stubhub_order | boolean Boolean value that is set to true for legacy stubhub orders. |
Array of objects or null (BarcodeInformation) The barcode(s) for the ticket(s). | |
in_hand_at | string or null <date-time> The date and time that the seller has the tickets 'in hand' to deliver to the buyer. |
(SaleLinks (object or null)) | |
(SaleEmbeddedResources (object or null)) |
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "status": "string",
- "status_description": "string",
- "display_proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "confirm_by": "2019-08-24T14:15:22Z",
- "ship_by": "2019-08-24T14:15:22Z",
- "external_listing_id": "string",
- "is_legacy_stubhub_order": true,
- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "in_hand_at": "2019-08-24T14:15:22Z",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:autotrackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:changepapertickettoeticket": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:confirm": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:contactuswebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:etickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:eticketuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:listing": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:reject": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:saveetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:savetransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:shipments": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:ticketholders": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:trackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:transferreceiptuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadeticketurls": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadtransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:webpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticket_type": {
- "type": "string",
- "name": "string",
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticketholders": [
- {
- "id": 0,
- "title": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "city_of_birth": "string",
- "province_of_birth": "string",
- "city_of_residence": "string",
- "province_of_residence": "string",
- "club_issuer": "string",
- "card_number": "string",
- "document_type": "string",
- "document_number": "string",
- "fiscal_code": "string",
- "security_code": "string",
- "generic_answer": "string",
- "email_address": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "document_issuing_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "nationality_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
], - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
}
}
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(SalesLinks (object or null)) | |
(SalesEmbeddedResources (object or null)) |
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "status": "string",
- "status_description": "string",
- "display_proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "confirm_by": "2019-08-24T14:15:22Z",
- "ship_by": "2019-08-24T14:15:22Z",
- "external_listing_id": "string",
- "is_legacy_stubhub_order": true,
- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "in_hand_at": "2019-08-24T14:15:22Z",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:autotrackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:changepapertickettoeticket": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:confirm": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:contactuswebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:etickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:eticketuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:listing": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:reject": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:saveetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:savetransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:shipments": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:ticketholders": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:trackshipment": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:transferreceiptuploads": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadetickets": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadeticketurls": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:uploadtransferreceipts": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "sale:webpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticket_type": {
- "type": "string",
- "name": "string",
- "id": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "ticketholders": [
- {
- "id": 0,
- "title": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "city_of_birth": "string",
- "province_of_birth": "string",
- "city_of_residence": "string",
- "province_of_residence": "string",
- "club_issuer": "string",
- "card_number": "string",
- "document_type": "string",
- "document_number": "string",
- "fiscal_code": "string",
- "security_code": "string",
- "generic_answer": "string",
- "email_address": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "document_issuing_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": null,
- "country:events": null,
- "country:localwebpage": null
}
}, - "nationality_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": null,
- "country:events": null,
- "country:localwebpage": null
}
}
}
}
], - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:events": {
- "href": null,
- "title": null,
- "templated": null
}, - "country:localwebpage": {
- "href": null,
- "title": null,
- "templated": null
}
}
}
}
}
}
}
]
}
}
A shipment of one or more tickets by a seller.
id | integer <int32> The shipment identifier. |
tracking_number | string or null The identifier used to track the shipment of the ticket(s). |
(Address (object or null)) The address that the seller must ship the tickets to. | |
(ShipmentLinks (object or null)) | |
(ShipmentEmbeddedResources (object or null)) |
{- "id": 0,
- "tracking_number": "string",
- "delivery_address": {
- "full_name": "string",
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "country": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:entertrackingnumber": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:label": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "pickup_addresses": [
- {
- "id": 0,
- "full_name": "string",
- "default": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:carrier": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
], - "pickups": [
- {
- "id": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "address": {
- "full_name": "string",
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "country": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "pickup:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "carrier": {
- "id": 0,
- "name": "string",
- "pickup_windows": [
- {
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z"
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "carrier:createpickup": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
], - "shipment_state": {
- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string"
}
}
}
The Shipments resource is a collection resource that contains zero or more references to a set of shipments, and links that guide you on ways to interact with the shipments. The collection offers a paginated view of shipments.
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(ShipmentsLinks (object or null)) | |
(ShipmentsEmbeddedResources (object or null)) |
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:create": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "tracking_number": "string",
- "delivery_address": {
- "full_name": "string",
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "country": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:entertrackingnumber": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "shipment:label": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "delivery_method": {
- "id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "deliverymethod:logo": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "pickup_addresses": [
- {
- "id": 0,
- "full_name": "string",
- "default": true,
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:carrier": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "address:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": null,
- "country:events": null,
- "country:localwebpage": null
}
}
}
}
], - "pickups": [
- {
- "id": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "address": {
- "full_name": "string",
- "address_1": "string",
- "address_2": "string",
- "address_3": "string",
- "city": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "country": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "pickup:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "carrier": {
- "id": 0,
- "name": "string",
- "pickup_windows": [
- null
], - "_links": {
- "self": null,
- "carrier:createpickup": null
}
}
}
}
], - "shipment_state": {
- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string"
}
}
}
]
}
}
id | integer or null <int32> |
title | string or null |
full_name | string or null |
date_of_birth | string or null <date-time> |
city_of_birth | string or null |
province_of_birth | string or null |
city_of_residence | string or null |
province_of_residence | string or null |
club_issuer | string or null |
card_number | string or null |
document_type | string or null |
document_number | string or null |
fiscal_code | string or null |
security_code | string or null |
generic_answer | string or null |
email_address | string or null |
(TicketHolderLinks (object or null)) | |
(TicketHolderEmbeddedResources (object or null)) |
{- "id": 0,
- "title": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "city_of_birth": "string",
- "province_of_birth": "string",
- "city_of_residence": "string",
- "province_of_residence": "string",
- "club_issuer": "string",
- "card_number": "string",
- "document_type": "string",
- "document_number": "string",
- "fiscal_code": "string",
- "security_code": "string",
- "generic_answer": "string",
- "email_address": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "document_issuing_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "nationality_country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}