Overview
The official viagogo API v2 connects your website or application with the world’s largest ticket marketplace. Your application can use the API to search for and view events, purchase tickets for an event or list tickets on the viagogo platform.
Quick Reference
Libraries are available in several languages.
API Root Endpoint:
https://api.viagogo.net/v2
All API access is over HTTPS, and accessed from the api.viagogo.net domain.
Request and response payloads are formatted as application/hal+json, which is
basically just plain old JSON with hyperlinks (see Media Type).
We support cross-origin resource sharing to allow you to interact
securely with our API from a client-side web application. OAuth2
is used for all authentication. All API requests must be authenticated or you
will receive a 401 Unauthorized error response (see
Authentication).
Before accessing viagogo APIs, you need to register your application. During the beta period, API access will be available by invitation only.
Buyer Entities
The main entities in the API related to buying tickets are events, listings and categories.
An Event is a show/festival/match/etc, taking place at a venue, for
which tickets can be bought and sold.
A Listing is a set of one or more tickets for an event.
A Category is a grouping of similar events or categories.
Categories in the viagogo platform are arranged in a tree hierarchy where
categories near the root of the tree (direct children of the root) are referred
to as genres (e.g. “Concerts”, “Threatre”, “Festival”, “Sports”) and categories
that are leaves of the tree are referred to as performers.
Seller Entities
The main entities in the API related to selling tickets are events, seller-listings and sales.
A SellerListing is a set of one or more tickets for sale on
the viagogo marketplace that belong to a seller.
A Sale is an order for one or more of a seller’s tickets that sold on
the viagogo marketplace.
Explorable API
The viagogo API v2 is an explorable API that uses hyperlinks to guide applications between resources. As such, the media type used in API responses and the structure of this documentation is intended to encourage developers to build applications that use hyperlinks to navigate between resources instead of using hard-coded URLs.
One of the main advantages of using hyperlinks is that API responses are able to better describe the current state of a resource by using links to represent the possible actions available on that resource. This should reduce (or hopefully remove) the need for your applications to implement logic for managing the various states of a resource.
Media Type
The API uses Hypertext Application Language (HAL) to hyperlink between resources. HAL is a simple format that provides a set of conventions for expressing hyperlinks in JSON - it’s basically just plain old JSON with hyperlinks!
All viagogo API resources are represented using the application/hal+json
media type. The following properties can be expected on every resource:
_links- a JSON object containing a set of hyperlinks to other resources_embedded- a JSON object containing other resources embedded inside the current resource- The regular properties of the resource
Use Link Relations instead of URLs
Link relations (the keys in the _links property of resources) are very
important in this API. They are a part of the contract between the API and your
application and we have documented the request parameters and response type that
are expected when your application follows a link
(see Link Relations. The idea is that applications will be
coded to understand the different link relations but will not care about the
actual URL of the link.
To get a feel for how this works, look at our Guides.
Root endpoint
curl -X GET "https://api.viagogo.net/v2"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var root = await api.Hypermedia.GetRootAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
root = api.get_root
$api = new Viagogo\ViagogoClient($clientId, $clientSecret);
$api->setToken($api->getOAuthClient()->getClientAccessToken());
root = api->getHalClient()->getRoot()
api = ViagogoClient(YOUR_CLIENT_ID, YOUR_CLIENT_SECRET)
api.set_token(api.oauth.get_client_access_token())
root = api.hal.get_root()
The above command returns an object structured like this:
{
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/",
"title": null,
"templated": false
},
"viagogo:user": {
"href": "https://api.viagogo.net/v2/user",
"title": "Account Settings",
"templated": false
},
"viagogo:search": {
"href": "https://api.viagogo.net/v2/search",
"title": "Search",
"templated": false
},
"viagogo:genres": {
"href": "https://api.viagogo.net/v2/categories/0/children",
"title": "Browse",
"templated": false
},
"viagogo:countries": {
"href": "https://api.viagogo.net/v2/countries",
"title": "Country",
"templated": false
},
"viagogo:currencies": {
"href": "https://api.viagogo.net/v2/currencies",
"title": "Currency",
"templated": false
},
"viagogo:languages": {
"href": "https://api.viagogo.net/v2/languages",
"title": "Language",
"templated": false
},
"viagogo:venues": {
"href": "https://api.viagogo.net/v2/venues",
"title": "Venue",
"templated": false
},
"viagogo:metroareas": {
"href": "https://api.viagogo.net/v2/metroareas",
"title": "Metro Area",
"templated": false
},
"viagogo:listingconstraints": {
"href": "https://api.viagogo.net/v2/listingconstraints",
"title": "Sell Tickets",
"templated": false
},
"viagogo:createsellerlisting": {
"href": "https://api.viagogo.net/v2/sellerlistings",
"title": "Sell Tickets",
"templated": false
}
}
}
The only URL that your application needs to know is the root endpoint, which is
like the “Home Page” of the API. You can issue a GET request to the root
endpoint of the API to get the root resource that links to all other API
resources.
GET https://api.viagogo.net/v2
Sandbox Environment
viagogo API v2 is supported in two environments. You can use our sandbox environment for testing purposes, before moving to the production. Use your sandbox credentials to make calls to the sandbox environment. When you’re set to go live, use your production credentials to make calls to the production environment.
- Sandbox API v2 root endpoint:
https://sandbox.api.viagogo.net/v2 - Sandbox OAuth2 token endpoint:
https://sandbox.account.viagogo.com/oauth2/token
Libraries
Use the viagogo API in your favourite language with one of our API libraries. Use the official GogoKit library, or choose between any of the available third party libraries.
GogoKit
- C# - gogokit.net
- Ruby - gogokit.rb
- PHP - gogokit.php
- Python - gogokit.py
Third-party libraries
Let us know about your libraries for the viagogo API and we will list them here.
HTTP Methods
Where possible, API v2 strives to use appropriate HTTP methods for each action.
| Method | Description |
|---|---|
GET |
Used for retrieving resources. |
POST |
Used for creating resources. |
PATCH |
Used for updating resources with partial JSON data. |
PUT |
Used for replacing resources. |
DELETE |
Used for deleting resources. |
HTTP Status Codes
API v2 attempts to return appropriate HTTP status codes for every request.
| Code | Description |
|---|---|
200 OK |
Success! |
201 Created |
The request succeeded and resulted in a new resource being created. The Location header of the response contains the URI of the new resource. |
202 Accepted |
The request has been accepted for processing, but processing has not been completed. |
204 No Content |
The request succeeded but the server is not returning any content. This is the response for most DELETE requests. |
400 Bad Request |
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
401 Unauthorized |
Authentication credentials were missing or incorrect. |
403 Forbidden |
The request is understood, but it has been refused or access is not allowed. An accompanying error message will explain why. |
404 Not Found |
The URI requested is invalid or the resource requested, such as an event, does not exist. |
405 Method Not Allowed |
A request was made of a resource using a request method not supported by that resource. |
409 Conflict |
The request could not be processed because of a conflict change in the request, such as an edit conflict in the case of multiple updates. |
429 Too Many Requests |
The client sent too many requests in a given amount of time and has been rate-limited. |
500 Internal Server Error |
Something is broken. Please email support so that the viagogo team can investigate. |
Error Responses
An error might look like this:
{
"code": "validation_failed",
"message": null,
"errors": {
"address.postal_code": [
"Zip Code is invalid"
]
}
}
When the viagogo API returns error messages, it includes a specific error code and possibly a localized error message that can be displayed to a user.
Error Codes
| Code | Status Code | Description |
|---|---|---|
https_required |
400 |
The request is not using an SSL connection. |
user_agent_required |
400 |
The request does not include a valid User-Agent header. |
invalid_request_body |
400 |
This request does not include a valid JSON body. |
insufficient_scope |
403 |
The access token used in the request does not have the scope required to access this resource. |
validation_failed |
400 |
The request data is not valid. errors will contain an object with a localized message that describes the validation error for each property of the data. |
invalid_purchase_action |
403 |
The request is attempting perform an operation on a Purchase that does not currently support that action. |
purchase_not_allowed |
403 |
The request is attempting to purchase tickets that cannot be purchased. |
listing_conflict |
409 |
The request is attempting to purchase tickets that have been modified or are no longer available. |
purchase_still_processing |
500 |
There was an error while purchasing the tickets but we are still processing the order. |
invalid_seller_listing_action |
403 |
The request is attempting perform an operation on a SellerListing that does not currently support that action. |
create_listing_not_allowed |
403 |
The request is attempting create a listing for an Event that tickets cannot currently be listed for. |
invalid_delete |
403 |
The request is attempting to delete a resource that cannot be deleted. |
internal_server_error |
500 |
Something is broken. Please contact support |
Pagination
Requests that return multiple results will be paginated to 100 items by default.
You can use the page parameter to specify which page of data to retrieve. You
can use page_size parameter to set custom page sizes on the API responses. API
responses return pre-built pagination links with rels first, prev, next
and last and client applications are encouraged to follow these links for
pagination.
GET https://api.viagogo.net/v2/addresses?page=1&page_size=30
Note that page numbering is 1-based and that omitting the page parameter will
return the first page.
Sorting
Paginated results can be sorted according to one of more criteria using the
sort param. Clients can specify sort criteria as a comma-separated list of the
names of fields that should be used to sort. The default sort order is ascending
but a - prefix on any sort field specifies a descending sort order.
GET https://api.viagogo.net/v2/categories/1207/events?sort=start_date,-ticket_price
The example request above sorts results by start_date ascending and then by
ticket_price descending.
Embedded Resources
curl -X GET "https://api.viagogo.net/v2/search?embed=category,event"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var request = new SearchResultRequest {Embed = new[] {SearchResultEmbed.Category, SearchResultEmbed.Event}};
var @searchResults = api.Search.GetAllAsync("One Dir", request);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
search_results = api.search('One Dir',
params: {
'embed' => 'category, event'
})
# TODO
The above command returns an object structured like this:
{
"total_items": 40,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/search?query=One%20Dir&embed=category%2Cevent&page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/search?query=One%20Dir&embed=category%2Cevent&page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/search?query=One%20Dir&embed=category%2Cevent&page=40&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"title": "One Direction",
"type": "Category",
"type_description": "Artist",
"_links": {
"searchresult:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
}
},
"_embedded": {
"category": {
"id": 20746,
"name": "One Direction",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"category:image": {
"href": "http://cdn1.viagogo.net/img/cat/20746/2/1.jpg",
"title": null,
"templated": false
}
}
}
}
}
]
}
}
The API uses Hypertext Application Language (HAL) to hyperlink between
resources. One of the features of HAL resources is that they contain a property
named _embedded that is a JSON object containing other related resources.
viagogo API v2 exposes two types of embedded resources:
1. Required Embedded Resources
Required embedded resources are always included in the resource in which they
are embedded. For example, the event property will always be embedded inside
of SellerListing resources.
2. Optional Embedded Resources
Optional embedded resources are only included in a resource when your
application includes the embedded property name(s) as a comma-separated value in
the embed parameter. For example, category and event are optional embedded
resources on SearchResult resources; To have these properties
included in the response of the viagogo:search link your
application would need to add the parameter ?embed=category,event to the
request.
Sparse Fieldsets
curl -X GET "https://api.viagogo.net/v2/events/735139?fields=id,name,_embedded&fields[venue]=city"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var request = new EventRequest();
request.Parameters.Add("fields", "id,name,_embedded");
request.Parameters.Add("fields[venue]", "city");
var @event = api.Events.GetAsync(735139, request);
var root = await api.Hypermedia.GetRootAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
event = event = api.get_event(735139,
params: {
'fields' => 'id,name,_embedded',
'fields[venue]' => 'city'
})
api = ViagogoClient(YOUR_CLIENT_ID, YOUR_CLIENT_SECRET)
api.set_token(api.oauth.get_client_access_token())
root = api.event.get_event(eventId,
{
"fields": "id,name"
"fields[venue]": "city"
})
The above command returns an object structured like this:
{
"id": 735139,
"name": "One Direction",
"_embedded": {
"venue": {
"city": "London"
}
}
}
Your application can request for the API to return only specific fields in the
response on a per-type basis by including a fields[TYPE] parameter. The value
of the fields parameter must be a comma-separated list of the name(s) of the
field(s) to be returned.
GET https://api.viagogo.net/v2/events/735139?fields=id,name,_embedded&fields[venue]=city
The example request above includes the id, name and _embedded fields in
the event resource and the city field in its embedded venue.
Localization
viagogo API v2 supports various request headers to return locale-specific content in responses.
Accept-Language Header
The Accept-Language header can be used to determine the language of the API
response content (e.g. event names and error messages). Content will be returned
in English if no Accept-Language header is provided, or viagogo does not
currently support the requested language codes.
Accept-Language: da, en-gb;q=0.8, en;q=0.7
In the example header above, the request is specifying “I prefer Danish, but will accept British English and other types of English.” See more information about the Accept-Language header.
Accept-Currency Header
The Accept-Currency header can be used to determine the currency of responses
that include monetary values. For example, Listing resources have a
ticket_display_price property that gives the price-per-ticket in the currency
requested by the application. The value of the Accept-Currency header should
be a three-letter currency code as defined by ISO 4217.
Accept-Currency: eur
In the example above, the request is specifying that it would like to receive monetary values in Euros where possible.
VGG-Country Header
Applications can include the VGG-Country header to change the
geography-context of requests. Each domain of the viagogo website is referred to
as a geography that has its own category-structure and language, currency and
content defaults. The value of the VGG-Country header should be a two-letter
country code as defined by ISO 3166. If an application does not
provide a VGG-Country header then the API will default to the US geography
(www.viagogo.com).
VGG-Country: FR
In the example above, the application is specifying that it would like make requests in the French geography (as if the client were using the www.viagogo.fr website).
HTTP Caching
Cache-Control Header
Most responses return a Cache-Control header with a max-age value that
indicates the number of seconds your application can cache a particular response
for. You don’t need to request a resource any more frequently than every
max-age seconds.
E-Tag Header
All responses return the ETag header. You can use the value of this header to
make subsequent requests to those resources using the If-None-Match header.
If the resource has not changed, the server will return a 304 Not Modified
response with an empty body.
Resource Changes
1. Check whether the Resource supports sorting by
resource_version
2. Request the resource sorted by
resource_version
curl -X GET "https://api.viagogo.net/v2/categories/3/eventssort=resource_version"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
// TODO
# TODO
The above command returns an object structured like this:
{
"total_items": 50000,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/1207/events?sort=resource_version&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/categories/1207/events?resource_version&min_resource_version=1234567890&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"deleted_items": [
{
"id": 635139,
"name": "One Direction",
"start_date": "2015-01-24T18:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/635139",
"title": null,
"templated": false
}
}
}
],
"items": [
{
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"notes_html": "General Notes \n • All sales are final \n • Ticket prices are set by the seller and may be above or below face value \n • Event dates and times are subject to change, it is up to you to check local listings for updates \n • After your purchase, you will receive a confirmation email with your ticket delivery details and timing",
"restrictions_html": "Everyone <strong>under 15</strong> must be accompanied by an adult.",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
},
"event:listings": {
"href": "https://api.viagogo.net/v2/events/735139/listings",
"title": "View Tickets",
"templated": false
},
"event:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"event:webpage": {
"href": "http://www.viagogo.com/E-735139",
"title": null,
"templated": false
},
"event:localwebpage": {
"href": "http://www.viagogo.co.uk/E-735139",
"title": null,
"templated": false
},
"event:listingconstraints": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
},
"event:createsellerlisting": {
"href": "https://api.viagogo.net/v2/events/735139/sellerlistings",
"title": "Sell Tickets",
"templated": false
}
},
"_embedded": {
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
]
}
}
3. Follow the
nextlink to get resources that have changed since your last request
4. Store the
nextlink in your database until the next time you want to get updates
API v2 makes it simple to request only the data that has changed since a previous request made by your application. This functionality is particularly useful for applications that are storing API response data in a database and can help any application to reduce the number of requests required to retrieve viagogo data.
1. Check whether the resource supports sorting by resource_version
Only certain resources such as Category, Event and
SellerListing resources support requesting data changes.
Check the resource documentation to see whether the resource can be sorted by
resource_version.
2. Request the resource sorted by resource_version
Request the resources you are interested in with the sort query
parameter set to resource_version. This will cause the resources returned in
the items property of the response to be ordered by the time they were last
updated (the oldest resource will be first). The deleted_items property will
contain items that have been deleted within the same time frame.
3. Follow the next link to get resources that have changed since your last request
With the items sorted by the time they were updated, the next link in the
response will always represent a request for resources that have changed since
your last request.
4. Store the next link in your database until the next time you want to get updates
The next link can be stored and used later (e.g. the next time your
application runs) to continue retrieving resources that have changed since the
last time you requested data.
Idempotent Requests
curl -X POST "https://api.viagogo.net/v2/events/735139/sellerlistings"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
-H "Idempotency-Key: f6d66920-636d-11e5-80f5-0002a5d5c51b"
-d '{"seating":{"section":"107","row":"A","seat_from":"1","seat_to":"4"},"ticket_price":{"amount":25.65,"currency_code":"USD"},"face_value":{"amount":22.62,"currency_code":"EUR"},"ticket_type":"ETicket","split_type":"Any","number_of_tickets":2,"guarantee_payment_method_id":95698}'
// TODO
# TODO
To safely retry an API request without accidently performing the same operation
twice, you can attach a unique key to any POST request via the
Idempotency-Key: <key> header.
For example, if a request to create a listing
fails due to a network connection error, you can retry the request with the same
key to guarantee that only a single listing is created.
The key can be any UUID value and the viagogo API will always send back the same response for requests made with the same key. Keys expire after 24 hours.
Announcements
Important announcements that relate to the usage of the viagogo api. We will announce upcoming changes that could effect you. Theses could be new features or deprecations of old features. We will link to these announcements with corresponding notifications to your registered email addresses.
TLS v1.0 Deprecation Notice [June 30, 2018]
viagogo will be disabling support for TLS v1.0 on our public facing api. We are providing advanced notice so that our customers and partners can prepare accordingly. If you are using unsupported clients to connect to the viagogo API after disabling TLS v1.0, you will begin receiving connection error messages.
Why are we disabling TLS v1.0?
We are disabling TLS v1.0 to ensure that viagogo software is providing our customers and partners with safe and secure protocols for our connections. This change is enforced throughout the industry to maintain secure connections that encrypt and protect your sensitive data from malicious breaches. The PCI Security Standards Council updated their guidance and will now require full deprecation of TLS 1.0 for applications that process payments. Although, we only support payments on the viagogo website application, we will be following the recommendation across all our inbound connections.
Am I affected?
Customers that have custom clients and are using clients that do not support TLS v1.1 and above will no longer be able to successfully connect to our public API.
Customer should ensure that they are using a supported client or else it will lead to downtime of any internal processes that utilize the viagogo API.
viagogo will be performing analysis of connections to our public API and performing proactive communications to affected customer to ensure a smooth transition. We still recommend that our customers do not rely solely on us to reach out to them, each customer that utilizes these APIs should ensure that they are prepared for the deprecation date.
You can use the following API to easily test the library you are using for API connections to viagogo to ensure it supports TLS v1.1 or greater.
https://www.howsmyssl.com/a/check
The HTTP response will contain a tls_version value which contains the highest version of TLS that is supported by the client.
Authentication
The viagogo API uses OAuth2 for all authentication. OAuth2 is a protocol that lets external applications access public viagogo resources and private viagogo user details without getting their password.
All developers need to register their application before getting started. Registered applications are assigned a unique Client ID and Client Secret that are required for authentication.
Basic Steps
All applications follow a basic pattern when accessing the viagogo API. At a high level, you follow three steps:
1. Obtain an access token
In order to make authenticated requests to the viagogo API, your application must first obtain an OAuth access token. The way you obtain an access token depends on your use case.
| If you… | Use… |
|---|---|
| Want to access public data like categories, events and listings… | Application-Only Flow |
| Want to manage user-specific data like payment methods, listings, purchases and sales… | User-Login Flow |
curl -X GET "https://api.viagogo.net/v2/search?query=lady%20gaga"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var token = await api.OAuth2.GetClientAccessTokenAsync();
await api.TokenStore.SetTokenAsync(token);
var searchResults = await api.Search.GetAllAsync("lady gaga");
api = GogoKit::Client.new(client_id: CLIENT_ID, client_secret: CLIENT_SECRET)
token = api.get_client_access_token
api.access_token = token.access_token
search_results = api.search 'lady gaga'
$api = new Viagogo\ViagogoClient($clientId, $clientSecret);
$api->setToken($api->getOAuthClient()->getClientAccessToken());
root = api->getHalClient()->getRoot()
api = ViagogoClient(YOUR_CLIENT_ID, YOUR_CLIENT_SECRET)
api.set_token(api.oauth.get_client_access_token())
root = api.hal.get_root()
2. Use the access token to call API v2
After your application obtains an access token, it sends the access_token
property in a token in an Bearer authorization header when making API
requests. Your application check the scope property in a token to make sure it
has been granted the scopes it needs before making requests. The
expires_in property in a token response represents the number of seconds
before the token expires. Tokens can be re-used in multiple requests up until
they expire.
3. Refresh the access token when it expires
Access tokens have limited lifetimes. If your application needs to make requests
beyond the lifetime of an access token, it should use the refresh_token value
from the token to obtain a new token. See Token Expiration
Application-Only Authentication Flow
Applications can use the client credentials grant type of the OAuth2 specification to get an access token that will provide access to public, non-user-specific data (events, listings, etc).
curl -X POST "https://account.viagogo.com/oauth2/token"
-u "clientId:clientSecret" --basic
-H "Content-Type: application/x-www-form-urlencoded"
-d "grant_type=client_credentials"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var token = await api.OAuth2.GetClientAccessTokenAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID, client_secret: CLIENT_SECRET)
token = api.get_client_access_token
1. Create a Basic Authorization header
- URL encode your application’s client id and client secret according to RFC 1738
- Concatenate the encoded client id, a colon character “:” and the encoded consumer secret into a single string
- Base64 encode the string from the previous step
The above command returns an object structured like this:
{
"access_token": "pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo",
"token_type": "bearer",
"expires_in": 86400,
"scope": ""
}
2. Obtain an access token
- The value calculated in Step 1 must be exchanged for an access token:
HTTP Request
POST https://account.viagogo.com/oauth2/token
Headers
| Name | Value |
|---|---|
Authorization |
Basic {value from step 1} |
Content-Type |
application/x-www-form-urlencoded |
Parameters
| Name | Type | Description |
|---|---|---|
grant_type |
string |
Required. Value should be client_credentials |
scope |
string |
Space-delimited string of the scopes you would like. |
User-Login Authentication Flow
Applications can use the authorization code grant type of the OAuth2 specification to obtain an access token by redirecting a user to viagogo and having them authorize your application. Access tokens obtained using this grant type will provide access to user-specific data (purchases, sales, seller-listings, etc) as well as public, non-user-specific data (events, listings, etc).
Authorization Endpoint:
https://account.viagogo.com/authorize
1. Obtain user’s consent
curl -X GET "https://account.viagogo.com/authorize?client_id=clientId&response_type=code&redirect_uri=https://myapp.com/callback&scope=read:user%20write:user&state=12345"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
// Redirect the user's user agent to this URL
var authorizationUrl = await api.OAuth2.GetAuthorizationUrl(
new Uri("https://myapp.com/callback"),
new[] { "read:user", "write:user" },
"12345");
You obtain a user’s consent to make API calls on their behalf by redirecting their user agent (browser, webview, etc) to the authorization endpoint with the parameters listed below.
HTTP Request
GET https://account.viagogo.com/authorize
Parameters
| Name | Type | Description |
|---|---|---|
client_id |
string |
Required Unique client identifier obtained through the application registration process |
response_type |
string |
Set to code to request that an authorization code be sent back to the application return URL |
redirect_uri |
string |
Application callback URL where the authorization code is sent. This must match the URL registered for your application |
scope |
string |
Space-delimited string of the scopes you would like |
state |
string |
An opaque value used to maintain state between the authorize request and the callback |
2. Process the authorize callback
Once the user authorizes your application, viagogo redirects (HTTP 302) the
user’s user-agent to the return URL with the authorization code appended in the
code query parameter.
3. Obtain an access token
curl -X POST "https://account.viagogo.com/oauth2/token"
-u "clientId:clientSecret" --basic
-H "Content-Type: application/x-www-form-urlencoded"
-d "grant_type=authorization_code"
-d "code=cddgafgfvawe"
--data-urlencode "redirect_uri=https://myapp.com/callback"
--data-urlencode "scope=read:user write:user"
var token = await _viagogoClient.OAuth2.GetAuthorizationCodeAccessTokenAsync(
"cddgafgfvawe",
new Uri("https://myapp.com/callback"),
new[] { "read:user", "write:user" });
# TODO
// TODO
# TODO
The above command returns an object structured like this:
{
"access_token": "pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo",
"token_type": "bearer",
"expires_in": 3600,
"refresh_token": "tGzv3JOkF0XG5Qx2TlKWIA",
"scope": "read:user write:user"
}
The authorization code received above can then be exchanged for an access token.
HTTP Request
POST https://account.viagogo.com/oauth2/token
Headers
| Name | Value |
|---|---|
Authorization |
Basic {value from step 1} |
Content-Type |
application/x-www-form-urlencoded |
Parameters
| Name | Type | Description |
|---|---|---|
grant_type |
string |
Required. Value should be authorization_code |
code |
string |
The authorization code that was sent to your application’s return URL |
redirect_uri |
string |
Application callback URL where the authorization code is sent. This must match the URL registered for your application |
scope |
string |
Space-delimited string of the scopes you would like. |
Token Expiration
You should write your applications to anticipate the possibility that a granted token may no longer work. Access tokens are short-lived but they are issued with a single-use, long-lived refresh token that can be used to get new tokens. Applications can use the refresh token grant of the OAuth2 specification to obtain additional access tokens in order to prolong the application’s access to a user’s data.
1. Obtain an access token
Use the User-Login Authentication Flow to obtain an initial access token.
2. Use the refresh token to obtain a new access token
curl -X POST "https://account.viagogo.com/oauth2/token"
-u "clientId:clientSecret" --basic
-H "Content-Type: application/x-www-form-urlencoded"
-d "grant_type=refresh_token"
-d "refresh_token=tGzv3JOkF0XG5Qx2TlKWIA"
--data-urlencode "scope=read:user write:user"
var token = await _viagogoClient.OAuth2.RefreshAccessTokenAsync(oldToken);
# TODO
// TODO
# TODO
The above command returns an object structured like this:
{
"access_token": "03807cb390319329bdf6c777d4dfae9c0d3b3c35",
"token_type": "bearer",
"expires_in": 3600,
"refresh_token": "2YotnFZFEjr1zCsicMWpAA",
"scope": "read:user write:user"
}
The refresh token from the previous access token can be exchanged for new one.
HTTP Request
POST https://account.viagogo.com/oauth2/token
Headers
| Name | Value |
|---|---|
Authorization |
Basic {value from step 1} |
Content-Type |
application/x-www-form-urlencoded |
Parameters
| Name | Type | Description |
|---|---|---|
grant_type |
string |
Required. Value should be refresh_token |
refresh_token |
string |
The refresh token received with a previous access token |
scope |
string |
Space-delimited string of the scopes you would like |
Scopes
Scopes allow your applications to specify exactly what type of access is needed.
| Name | Description |
|---|---|
(no scope) |
Grants read-only access to public information like events, listings. |
read:user |
Grants read access to the user’s account information, addresses, payment methods, purchases and sales. |
write:user |
Grants write access to the user’s account information, addresses, payment methods and sales. |
write:purchases |
Grants write access to the user’s purchases. This allows users to use your application to purchase listings. |
read:sellerlistings |
Grants read access to the user’s listings. |
write:sellerlistings |
Grants write access to the user’s listings. This allows users to use your application to create and update listings. |
read:webhooks |
Grants read access to the user’s webhooks. |
write:webhooks |
Grants write access to the user’s webhooks. |
write:requestedevents |
Grants write access to the user’s requested events. This allows users to use your application to request an event to be added to the viagogo platform. |
Managing Listings
Create Listings for viagogo Events
API v2 enables your application to create listings for events on the viagogo platform using the steps below. Creating listings directly against events already on the platform is the quickest way to get a user’s inventory active and available for purchase on the viagogo marketplace.
This example assumes that your application has an access token for a user and that the token has the appropriate scopes for read and write access to the user’s listings.
1. Find the Event that you want to list tickets for
curl -X GET "https://api.viagogo.net/v2/events/735139"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var @event = await api.Events.GetAsync(735139);
event = api.get_event 735139
2. Get the constraints for listings on that event
curl -X GET "https://api.viagogo.net/v2/events/735139/listingconstraints"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var constraints = await api.Hypermedia.GetAsync<ListingConstraints>(@event.ListingConstraintsLink);
# TODO
3. Create the listing
curl -X POST "https://api.viagogo.net/v2/events/735139/sellerlistings"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
-d '{"seating":{"section":"107","row":"A","seat_from":"1","seat_to":"4"},"ticket_price":{"amount":25.65,"currency_code":"USD"},"face_value":{"amount":22.62,"currency_code":"EUR"},"ticket_type":"ETicket","split_type":"Any","number_of_tickets":2,"guarantee_payment_method_id":95698}'
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
1. Find the Event that you want to list tickets for
Find the Event you are interested in using the steps outlined
here.
2. Get the constraints for listings on that event
Follow the event:listingconstraints link to get
the ListingConstraints that your listing must meet.
3. Create the listing
Follow the event:createsellerlisting link on the
Event resource to create your listing.
Create Listings for Events on the User’s Point of Sale
Your application can create listings directly from the user’s Point of Sale and API v2 will automatically map it to an event on the viagogo platform. Once the user’s listing is mapped it will automatically become available for purchase on the viagogo marketplace.
This example assumes that your application has an access token for a user and that the token has the appropriate scopes for read and write access to the user’s listings.
1. Get the Root resource:
curl -X GET "https://api.viagogo.net/v2"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var root = await api.Hypermedia.GetRootAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
root = api.get_root
$api = new Viagogo\ViagogoClient($clientId, $clientSecret);
$api->setToken($api->getOAuthClient()->getClientAccessToken());
root = api->getHalClient()->getRoot()
api = ViagogoClient(YOUR_CLIENT_ID, YOUR_CLIENT_SECRET)
api.set_token(api.oauth.get_client_access_token())
root = api.hal.get_root()
2. Create the listing:
curl -X POST "https://api.viagogo.net/v2/sellerlistings"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
-d '{"external_id": "495293", "seating":{"section":"107","row":"A","seat_from":"1","seat_to":"2"},"ticket_price":{"amount":25.65,"currency_code":"USD"},"face_value":{"amount":22.62,"currency_code":"EUR"},"ticket_type":"ETicket","split_type":"Any","number_of_tickets":2,"event":{"name":"One Direction","start_date":"2015-09-24T18:30:00+01:00"},"venue":{"name":"The O2 arena","city":"London"},"country": {"code": "GB"}}'
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var listing = await api.SellerListings.CreateAsync(
new NewRequestedEventSellerListing
{
ExternalId = "495293",
NumberOfTickets = "2",
Seating = new Seating
{
Section = "107",
Row = "A",
SeatFrom = "1",
SeatTo = "4"
},
TicketPrice = new Money { Amount = 25.65, Currency = "USD" },
FaceValue = new Money { Amount = 22.62, Currency = "EUR" },
TicketType = "ETicket",
SplitType = "Any",
Event = new Event
{
Name = "One Direction",
StartDate = DateTimeOffset.Parse("2015-09-24T18:30:00+01:00")
},
Venue = new Venue
{
Name = "The O2 arena",
City = "London"
},
Country = new Country { Code = "GB" }
});
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
1. Start at the Root
As is the case when retrieving most data in API v2, you should start by getting
the Root resource to find the hyperlink to the resource you care
about.
2. Create the listing
Follow the viagogo:createsellerlisting link on
the Root resource to create your listing.
Update Listings
API v2 enables your application to update listings on behalf of users. This example assumes that your application has an access token for a user and that the token has the appropriate scopes for read and write access to the user’s listings.
1. Find the SellerListing that you want to edit
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
2. Get the constraints for updating the listing
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065/constraints"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
3. Update the listing
curl -X PATCH "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
-d '{"ticket_price":{"amount":25.65,"currency_code":"USD"}}'
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
1. Find the SellerListing that you want to edit
Find the SellerListing you want to update.
2. Get the constraints for updating the listing
Follow the sellerlisting:constraints link to get
the ListingConstraints that your listing must meet.
3. Update the listing
Follow the link on the SellerListing resource that
corresponds to the update you want to make. For example, follow the
sellerlisting:updateseating to update the
seating information of a listing.
Handling Listing Errors
You should write your code to anticipate error responses while making requests to manage listings. Robust error handling helps to keep users’ inventory up-to-date on the viagogo platform and minimizes the chance of tickets being mis-sold.
Create Listings Using Idempotent Requests
Your application should use idempotent requests when creating listings so that the operation is retryable without creating any additional listings.
Handle Validation Errors
400 Bad Request responses with the validation_failed error code mean that
the data being passed by your application has failed viagogo’s validation. Your
application should handle these errors by trying to get the user to correct the
data and if that is not possible then your application should
delete the listing (for update requests).
Handle Invalid SellerListing Action Errors
403 Forbidden responses with the invalid_seller_listing_action error code
mean that the update you are trying to make is not currently allowed (updates to
listing properties may not be allowed for a variety of reasons). If your
application receives one of these errors when trying to do an update then it
it should delete the listing.
Handle Other Errors
Other errors, such as 500 Internal Server Error, mean that there was some
transient error and the request can be retried.
Managing Sales
Using API v2, your application can manage ticket sales on behalf of a user. The examples below assume that your application has an access token for a user and that the token has the appropriate scopes for read and write access to the user’s sales. Please see our Customer Service page for answers to any non-API questions you may have about selling, or shipping tickets on the viagogo platform.
Access Your Sales
Follow the user:sales link on the User resource to
get all of the Sale resources for your account.
Confirm Sales
When your tickets have sold, you should confirm your sale promptly by
using the sale:confirm link. If there is a problem with
your sale, you should use the sale:reject link.
Upload E-Tickets For Your Sale
As soon as you have your tickets and are ready to upload them, you can use the
sale:uploadetickets link to upload one or more files
containing one or more tickets. The files that you upload will be represented as
ETicketUpload resources that will contain separate
ETicket resources for each ticket in the file(s). You can then
submit the ids of the ETicket resources that you want to assign
to the sale in the sale:saveetickets link.
Ship Your Tickets
As soon as you have your tickets and are ready to ship them to your buyer, use
the sale:shipments link to get the Shipments
resource related to your sale. When you are ready to ship, follow the
shipment:create create a Shipment and then
follow the shipment:label link to get the full details on
how to ship the tickets.
Arrange Courier Collection
For some delivery methods, such as UPS, it is necessary to arrange a courier
collection. After creating a Shipment (see #4),
choose the collection address from the shipment’s pickup_addresses
property and follow the address:carrier link to view the pickup windows
available for the courier. Use the carrier:createpickup
link to create a Pickup for the given window.
Webhooks
Webhooks allow you to build or set up integrations that subscribe to certain
topics on the viagogo platform. When an occurrence of a topic happens we’ll send
a POST payload to the webhook’s configured URL. Once a webhook is created, it
will be triggered each time one or more of the subscribed topics occurs.
Topics
When configuring a webhook, you can choose the topics you would like to receive payloads for. You should only subscribe to the specific topics that you plan on handling so that you can limit the number of HTTP requests to your server.
The available topics are:
| Name | Description |
Sales |
Any time something happens that affects a Sale (e.g. you sell one or more tickets) |
ProvisionalSale |
Will notify you when a provisional sale comes in. The normal Sale webhook will confirm the Provisional Sale, and if you want to reject the provisional sale, just ignore it and reject the sale when it comes through as normal. |
CancelProvisionalSale |
Will notify you when a provisional sale is cancelled. |
Ping |
Any time a Webhook is pinged via its webhook:ping link. All webhooks are automatically subscribed to this topic so you can ping any webhook. |
Payloads
The payload for each topic has a similar JSON schema, but a unique piece of data that is relevant to that topic.
Delivery Headers
HTTP requests made to your webhook’s configured URL endpoint will contain several specific headers:
| Header | Description |
| VGG-Topic | Name of the topic that triggered this delivery |
| VGG-DeliveryId | Unique identifier for this delivery |
Also, the User-Agent for the requests will have the prefix Viagogo-Webhooks/.
SalesTopic
Webhook payload example:
POST /payload
HOST: myapplication.com
User-Agent: Viagogo-Webhooks/0.3.18.54687
Content-Type: application/hal+json
Content-Length: 1215
VGG-Topic: Sales
VGG-DeliveryId: 1993433
{
"action": "Created",
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"sale": {
"id": 1017322,
"created_at": "2015-09-21T16:02:39+00:00",
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"number_of_tickets": 2,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": null,
"templated": false
}
}
},
"seller_listing": {
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"external_id": "495293",
"number_of_tickets": 2,
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
Triggered when something happens that affects a Sale (e.g. you sell one or more tickets).
Properties
| Name | Type | Description |
topic |
string |
The topic of the webhook. Can be Sales. |
action |
string |
The action that triggered this webhook. Can be Created. |
Embedded
| Relation | Type | Optional | Description |
sale |
Sale |
No | The event for this sale. |
seller_listing |
SellerListing |
No | The listing from which the tickets were sold. |
event |
Event |
No | The event for this sale. |
venue |
Venue |
No | The venue where the event is taking place. |
ProvisionalSaleTopic
Webhook payload example:
POST /payload
HOST: myapplication.com
User-Agent: Viagogo-Webhooks/0.3.18.54687
Content-Type: application/hal+json
Content-Length: 1215
VGG-Topic: ProvisionalSale
VGG-DeliveryId: 1993433
{
"action": "Created",
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"sale": {
"id": 1017322,
"created_at": "2015-09-21T16:02:39+00:00",
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"number_of_tickets": 2,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": null,
"templated": false
}
}
},
"seller_listing": {
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"external_id": "495293",
"number_of_tickets": 2,
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
Will notify you when a provisional sale comes in. The normal Sale Webhook will confirm the Provisional Sale, and if you want to reject the provisional sale, just ignore it and reject the sale when it comes through as normal.
Properties
| Name | Type | Description |
topic |
string |
The topic of the webhook. Can be ProvisionalSale. |
action |
string |
The action that triggered this webhook. Can be Created. |
Embedded
| Relation | Type | Optional | Description |
sale |
Sale |
No | The event for this sale. |
seller_listing |
SellerListing |
No | The listing from which the tickets were sold. |
event |
Event |
No | The event for this sale. |
venue |
Venue |
No | The venue where the event is taking place. |
CancelProvisionalSaleTopic
Webhook payload example:
POST /payload
HOST: myapplication.com
User-Agent: Viagogo-Webhooks/0.3.18.54687
Content-Type: application/hal+json
Content-Length: 1215
VGG-Topic: CancelProvisionalSale
VGG-DeliveryId: 1993433
{
"action": "Cancelled",
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"sale": {
"id": 1017322,
"created_at": "2015-09-21T16:02:39+00:00",
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"number_of_tickets": 2,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": null,
"templated": false
}
}
},
"seller_listing": {
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"external_id": "495293",
"number_of_tickets": 2,
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
Will notify you when a provisional sale is cancelled.
Properties
| Name | Type | Description |
topic |
string |
The topic of the webhook. Can be CancelProvisionalSale. |
action |
string |
The action that triggered this webhook. Can be Cancelled. |
Embedded
| Relation | Type | Optional | Description |
sale |
Sale |
No | The event for this sale. |
seller_listing |
SellerListing |
No | The listing from which the tickets were sold. |
event |
Event |
No | The event for this sale. |
venue |
Venue |
No | The venue where the event is taking place. |
PingTopic
Webhook payload example:
POST /payload
HOST: myapplication.com
User-Agent: Viagogo-Webhooks/0.3.18.54687
Content-Type: application/hal+json
Content-Length: 1215
VGG-Topic: Ping
VGG-DeliveryId: 1993433
{
"action": "Created",
"_embedded": {
"webhook": {
"id": 48
}
}
}
Triggered any time a Webhook is pinged via its
webhook:ping link.
Properties
| Name | Type | Description |
topic |
string |
The topic of the webhook. Can be ping. |
action |
string |
The action that triggered this webhook. Can be Created. |
Embedded
| Relation | Type | Optional | Description |
webhook |
Webhook |
No | The webhook that was pinged |
Browsing Events
Search for Events
1. Get the Root resource:
curl -X GET "https://api.viagogo.net/v2"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var root = await api.Hypermedia.GetRootAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
root = api.get_root
$api = new Viagogo\ViagogoClient($clientId, $clientSecret);
$api->setToken($api->getOAuthClient()->getClientAccessToken());
root = api->getHalClient()->getRoot()
api = ViagogoClient(YOUR_CLIENT_ID, YOUR_CLIENT_SECRET)
api.set_token(api.oauth.get_client_access_token())
root = api.hal.get_root()
2. Search for the Team/Artist/Tournament/etc Category:
curl -X GET "https://api.viagogo.net/v2/search"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var searchResults = await api.Search.GetAllAsync("one direction");
search_results = api.search 'one direction'
$searchResults = $client->getSearchClient()->getSearch("FC Barcelona tickets");
search = client.search.get_search_results({ "query": "Real Madrid" })
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/search?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/search?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/search?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"title": "One Direction",
"type": "Category",
"type_description": "Artist",
"_links": {
"searchresult:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
}
}
}
]
}
}
3. Get the Details of the Category
curl -X GET "https://api.viagogo.net/v2/categories/20746"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var category = await api.Categories.GetAsync(searchResults[0].Id);
category = api.get_category search_results.items[0].id
$category = $client->getCategoryClient()->getCategory($searchResults->getItems()[0]->getId());
category = client.category.get_category(search.items[0].id)
4. Page through the Events in the Category
curl -X GET "https://api.viagogo.net/v2/categories/20746/events"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var events = await api.Events.GetAllByCategoryAsync(category.Id);
events = api.get_events_by_category category.id
$events = $client->getEventClient()->getEventsByCategory(category->getId());
events = client.event.get_events_by_category(category.id)
API v2 provides access to the same search features available on the viagogo website. Your application can use this search to quickly find a particular category, event, venue or metro area.
1. Start at the Root
As is the case when retrieving most data in API v2, you should start by getting
the Root resource to find the hyperlink to the resource you care
about.
2. Search for the Team/Artist/Tournament/etc Category
Follow the viagogo:search link to query for entities you are
interested in.
3. Get the Details of the Category
SearchResult resources only contain very basic entity
information so you should follow the link on the result that will get you more
information about the entity (see searchresult:category,
searchresult:event,
searchresult:metroarea and
searchresult:venue)
4. Page through the Events in the Category
Follow the category:events link to get the first page of
events under the category. Once we have the first page, we can follow the next
links to retrieve all pages (see pagination).
Getting All Events in a Genre
1. Get the Root resource:
curl -X GET "https://api.viagogo.net/v2"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var root = await api.Hypermedia.GetRootAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
root = api.get_root
$api = new Viagogo\ViagogoClient($clientId, $clientSecret);
$api->setToken($api->getOAuthClient()->getClientAccessToken());
root = api->getHalClient()->getRoot()
api = ViagogoClient(YOUR_CLIENT_ID, YOUR_CLIENT_SECRET)
api.set_token(api.oauth.get_client_access_token())
root = api.hal.get_root()
2. Get the Genres:
curl -X GET "https://api.viagogo.net/v2/categories/0/children"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var genres = await api.Categories.GetAllGenresAsync();
genres = api.get_genres
$genres = api->getCategoryClient()->getAllGenres()
genres = api.category.get_genres()
3. Page through the Events in the Genre
curl -X GET "https://api.viagogo.net/v2/categories/3/events"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var events = await api.Events.GetAllByCategoryAsync(genres[0].Id);
events = api.get_events_by_category genres.items[0].id
$events = api->getEventClient()->getEventsByCategory($genres->getItems()[0]->getId())
events = api.event.get_events_by_category(genres.items[0].id)
The above command returns an object structured like this:
{
"total_items": 50000,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/1207/events?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/categories/1207/events?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/categories/1207/events?page=50000&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"notes_html": "General Notes \n • All sales are final \n • Ticket prices are set by the seller and may be above or below face value \n • Event dates and times are subject to change, it is up to you to check local listings for updates \n • After your purchase, you will receive a confirmation email with your ticket delivery details and timing",
"restrictions_html": "Everyone <strong>under 15</strong> must be accompanied by an adult.",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
},
"event:listings": {
"href": "https://api.viagogo.net/v2/events/735139/listings",
"title": "View Tickets",
"templated": false
},
"event:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"event:webpage": {
"href": "http://www.viagogo.com/E-735139",
"title": null,
"templated": false
},
"event:localwebpage": {
"href": "http://www.viagogo.co.uk/E-735139",
"title": null,
"templated": false
},
"event:listingconstraints": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
},
"event:createsellerlisting": {
"href": "https://api.viagogo.net/v2/events/735139/sellerlistings",
"title": "Sell Tickets",
"templated": false
}
},
"_embedded": {
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
]
}
}
Retrieving all of the events in a particular genre (e.g. “Concert Tickets”, “Theatre Tickets”) is simple if you use the hyperlinks available in API responses.
1. Start at the Root
As is the case when retrieving most data in API v2, you should start by getting
the Root resource to find the hyperlink to the resource you care
about.
2. Find the Genre(s) that you care about
Follow the viagogo:genres link to get the genre you are
interested in.
3. Page through the Events in the Genre
Follow the category:events link to get the first page of
events. Once we have the first page, we can follow the next links to retrieve
all pages (see pagination). Since there will be lots of events
under a genre, we suggest using a large page_size to reduce the total number
of requests your application has to make.
Direct Users to the viagogo Website
Your application can use links on Category, Event and
Listing resources to direct users to the viagogo website. These
resources provide two types of links that you can use depending on your scenario.
User-Locale-Specific Website Links
Category, Event and Listing resources
provide category:webpage, event:webpage
and listing:webpage links respectively. You should use these
links to direct the user to a viagogo website domain that matches the user’s
locale. The viagogo website domain will match the
VGG-Country Header in your request. For example, if you
know that a user of your application is German, your application should be
requesting event data with VGG-Country header set to DE and you can use this
link to direct them to www.viagogo.de.
Event-Locale-Specific Website Links
Event and Listing resources provide
event:webpage and listing:webpage links
respectively. You should usse these links to direct the user to a viagogo
website domain that matches the event’s locale. For example, if you know that an
event is in Australia you can use this link to direct your user to
www.viagogo.com/au.
Affiliate Commission Tiers
viagogo affiliates can use API v2 to identify the commissions available for an
Event by checking its affiliate_commission_tier property. This
property will have one of the following values:
Low- Affiliates are eligible for lower commissions on mega events or events where viagogo is the official ticketing partnerNormal- Affiliates are eligible for standard commissions
Basic Types
API responses have standard formats for most object types - dates, monetary values, etc. We’ve documented all possible fields and their meanings.
DateTime
“2015-06-08T19:00:00+01:00”
A datetime represented as a string in ISO 8601 date format YYYY-MM-DDTHH:MM:SSZ.
Money
Example JSON:
{
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
}
Returned for monetary values, such as ticket prices, fees charged and tax amounts.
Properties
| Name | Type | Description |
amount |
decimal |
The decimal amount of the money. |
currency_code |
string |
The ISO 4217 currency code that the monetary value is represented in. |
display |
string |
A user-friendly string representing the monetary value. |
Seating
Example JSON:
{
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
}
Represents the seating information for a ticket(s) in a Venue.
Properties
| Name | Type | Description |
section |
string |
The section of the ticket(s). |
row |
string |
The row of the ticket(s). |
seat_from |
string |
The first in a contiguous block of seats to which the tickets have been allocated. |
seat_to |
string |
The last in a contiguous block of seats to which the tickets have been allocated. |
AddressSnapshot
Example JSON:
{
"full_name": "Joe Smith",
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"country_code": "GB",
"country": "United Kingdom"
}
Represents a snapshot of an Address resource at a particular point in time.
Properties
| Name | Type | Description |
full_name |
string |
The full name of the recipient. |
address_1 |
string |
The first line of the address. |
address_2 |
string |
The second line of the address. |
address_3 |
string |
The third line of the address. |
city |
string |
The name of the city where the address is located. |
state_province |
string |
The name of the State or Province where the address is located. |
postal_code |
string |
The postal code for the address. |
country_code |
string |
The two-letter ISO 3166 code for the country where the address is located. |
country_name |
string |
The name of the country where the address is located. |
Section
Properties
| Name | Type | Description |
name |
string |
The name of the section. |
free_text_row |
boolean |
True if this section allows any text for a row; Otherwise, false. |
rows |
Row[] |
The available rows in this section. |
Row
Properties
| Name | Type | Description |
name |
string |
The name of the row. |
PickupWindow
Represents a window of time when a courier pickup can be arranged.
Properties
| Name | Type | Description |
start_date |
datetime |
The date when the window starts. |
end_date |
datetime |
The date when the window ends. |
PaymentMethod Types
A string that signifies the type of a PaymentMethod. Can be one of CreditCard, or PayPal.
Resources
This section documents the resources returned by the API, the properties available on each resource and the links relations they have to other resources.
Address
An address is a delivery, pickup or billing address associated with the current user.
Properties
| Name | Type | Description |
id |
int |
The address identifier. |
full_name |
string |
The full name of the recipient. |
address_1 |
string |
The first line of the address. |
address_2 |
string |
The second line of the address. |
address_3 |
string |
The third line of the address. |
city |
string |
The name of the city where the address is located. |
state_province |
string |
The name of the State or Province where the address is located. |
postal_code |
string |
The postal code for the address. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A user’s address. |
address:carrier |
GET |
No | The pickup windows available for Carrier collection. |
address:update |
PATCH |
No | Update the details of the current user’s address. |
address:delete |
DELETE |
No | Delete the current user’s address. |
Embedded
| Relation | Type | Optional | Description |
country |
Country |
No | The Country where the address is located. |
Addresses
The Addresses resource is a collection resource that contains zero or more references to a set of addresses, and links that guide you on ways to interact with the addresses. The collection offers a paginated view of addresses.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the addresses. |
address:create |
POST |
No | Add a new Address for the current user. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
Address[] |
No | An array of the current page of Address resources. |
Carrier
A carrier (e.g. UPS) that will collect tickets that are to be delivered.
Properties
| Name | Type | Description |
id |
int |
The shipment identifier. |
name |
string |
The name of the carrier. |
pickup_windows |
PickupWindow[] |
The windows available for ticket collection. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A carrier. |
carrier:createpickup |
POST |
No | Creates a new pickup for the ticket(s). |
Categories
The Categories resource is a collection resource that contains zero or more references to a set of categories, and links that guide you on ways to interact with the categories. The collection offers a paginated view of categories.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current categories. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
Category[] |
No | An array of the current page of Category resources. |
Category
A Category represents some grouping of events or other categories. Examples are “Concerts”, “Rock and Pop” and “Lady Gaga”.
Properties
| Name | Type | Description |
id |
int |
The category identifier. |
name |
string |
The name of the category. |
description_html |
string |
The localized string containing HTML markup that describes the category. |
min_ticket_price |
money |
The minimum ticket price of the events in this category. |
min_event_date |
datetime |
The earliest start date of the events in this category. |
max_event_date |
datetime |
The latest start date of the events in this category. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A category. |
category:children |
GET |
No | The direct descendants of this category. |
category:events |
GET |
No | The events in this category. |
category:image |
GET |
No | The image for this category. |
category:parent |
GET |
No | The parent of this category. |
category:performers |
GET |
No | The leaf descendants this category. These categories will be direct parents of events. |
category:webpage |
GET |
No | The webpage on the viagogo website for this category. |
Embedded
| Relation | Type | Optional | Description |
top_performers |
Categories |
Yes | The most popular performers (leaf categories) that are children of this category. |
top_children |
Categories |
Yes | A preview of the categories that are direct children of this category. |
top_events |
Events |
Yes | The most popular events in this category. |
Countries
The Countries resource is a collection resource that contains zero or more references to a set of countries, and links that guide you on ways to interact with the countries. The collection offers a paginated view of countries.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current countries. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description | |
items |
Country[] |
No | An array of the current page of Country resources. |
Country
Properties
| Name | Type | Description |
code |
string |
The two-letter ISO 3166 code for the country. |
name |
string |
The name of the country. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A country. |
country:events |
GET |
No | The events taking place in a country. |
Currencies
The Currencies resource is a collection resource that contains zero or more references to a set of currencies, and links that guide you on ways to interact with the currencies. The collection offers a paginated view of currencies.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current currencies. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description | |
items |
Currency[] |
No | An array of the current page of Currency resources. |
Currency
Properties
| Name | Type | Description |
code |
string |
The ISO 4217 currency code that identifies the currency. |
name |
string |
The name of the currency. |
symbol |
string |
The symbol that identifies the currency |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A currency. |
DeliveryMethod
Properties
| Name | Type | Description |
id |
int |
The delivery method identifier |
name |
string |
The localised name of the payment method |
type |
string |
The type of delivery method. Can be ETicket, Post or Pickup |
ETicket
An electronic ticket that has been uploaded for a listing or a sale.
Properties
| Name | Type | Description |
id |
int |
The identifier of the E-Ticket. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | An electronic ticket |
eticket:delete |
GET |
No | Delete this E-Ticket. |
eticket:document |
GET |
No | A PDF file containing the E-Ticket. |
eticket:thumbnail |
GET |
No | An image file containing a thumbnail of the E-Ticket. |
ETickets
The ETickets resource is a collection resource that contains zero or more references to a set of E-Tickets, and links that guide you on ways to interact with the E-Tickets. The collection offers a paginated view of E-Tickets.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current E-Tickets. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description | |
items |
ETicket[] |
No | An array of the current page of ETicket resources. |
ETicketUpload
Represents an uploaded file that contains one or more E-Tickets.
Properties
| Name | Type | Description |
id |
int |
The identifier of the upload. |
file_name |
string |
The name of the file that was uploaded. |
status_description |
string |
A localised in-depth description of the current status of the upload. |
processed_at |
string |
The date when all of the E-Tickets in the uploaded file were processed. |
original_number_of_tickets |
int |
The original number of E-Tickets contained in the uploaded file. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | An uploaded file containing one or more E-Tickets |
eticketupload:document |
GET |
No | The original file that was uploaded. |
Embedded
| Relation | Type | Optional | Description |
etickets |
ETicket[] |
No | An array of the individual E-Tickets contained in the uploaded files. |
ETicketUploads
The ETicketUploads resource is a collection resource that contains zero or more references to a set of uploads, and links that guide you on ways to interact with the uploads. The collection offers a paginated view of uploads.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current uploads. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description | |
items |
ETicketUpload[] |
No | An array of the current page of ETicketUpload resources. |
Event
An event on the viagogo platform.
Properties
| Name | Type | Description |
id |
int |
The event identifier. |
name |
string |
The name of the event. |
start_date |
datetime |
The date when the event starts. |
end_date |
datetime |
The date when the event ends. |
on_sale_date |
datetime |
The date when tickets for the event will go onsale. |
number_of_tickets |
int |
The number of tickets currently available for this event. |
min_ticket_price |
money |
The minimum ticket price of the listings in this event. |
date_confirmed |
boolean |
True if the event start and end date have been confirmed; Otherwise, false. |
notes_html |
string |
Localized string containing HTML markup that describes the notes for the event. |
restrictions_html |
string |
Localized string containing HTML markup that describes the purchase restrictions on the event. |
affiliate_commission_tier |
string |
The tier of commission paid to affiliates that market this event. Can be Normal or Low (See Affiliate Commission Tiers). |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | An event. |
event:category |
GET |
No | The category that contains this event. |
event:listings |
GET |
No | The listings for this event. |
event:localwebpage |
GET |
No | The webpage on the local viagogo website for this event. |
event:webpage |
GET |
No | The webpage on the viagogo website for this event. |
event:listingconstraints |
GET |
No | The listing constraints for this event. |
event:createsellerlisting |
POST |
No | Create a SellerListing for this event. |
Embedded
| Relation | Type | Optional | Description | |
venue |
Venue |
No | The Venue where the event is taking place. | |
category |
Category |
Yes | The category for this event. |
Events
The Events resource is a collection resource that contains zero or more references to a set of events, and links that guide you on ways to interact with the events. The collection offers a paginated view of events.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current events. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description | |
items |
Event[] |
No | An array of the current page of Event resources. |
Language
Properties
| Name | Type | Description |
code |
string |
The ISO 639-1 language code that identifies the language. |
name |
string |
The name of the language. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A language. |
Languages
The Languages resource is a collection resource that contains zero or more references to a set of languages, and links that guide you on ways to interact with the languages. The collection offers a paginated view of languages.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of itemsÍ. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current languages. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description | |
items |
Language[] |
No | An array of the current page of Language resources. |
ListingConstraints
The constraints applied to a listing for a particular event on the viagogo
marketplace. All SellerListing resources created for the
associated Event must meet these constraints.
Properties
| Name | Type | Description |
min_ticket_price |
money |
The minimum price of a ticket. |
max_ticket_price |
money |
The maximum price of a ticket. |
min_number_of_tickets |
int |
The minimum number of tickets available for purchase. |
max_number_of_tickets |
int |
The maximum number of tickets available for purchase. |
ticket_location_required |
boolean |
True if a ticket location is required for tickets; Otherwise, false. |
seats_required |
boolean |
True if seat-level information (seat_to and seat_from) is required; Otherwise, false. |
sections |
Section[] |
The valid section and row information. If no sections are specified then any text will be accepted for section and row. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The constraints applied to a listing for an event. |
Embedded
| Relation | Type | Optional | Description |
ticket_type |
TicketType |
No | The valid types of tickets. |
split_type |
SplitType |
No | The way that tickets are allowed to be split up when sold. |
listing_notes |
ListingNote[] |
No | The available notes for this listing. |
currencies |
Currency[] |
No | The valid currencies for the listing ticket price. |
ListingNote
ListingNotes provide additional notes on a listing.
Properties
| Name | Type | Description |
id |
int |
The listing note identifier. |
note |
string |
The localized note. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A listing note. |
ListingNotes
The ListingNotes resource is a collection resource that contains zero or more references to a set of listing notes, and links that guide you on ways to interact with the listing notes. The collection offers a paginated view of listing notes.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current listing notes. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
ListingNote[] |
No | An array of the current page of ListingNote resources. |
Listing
A set of tickets for sale on the viagogo marketplace.
Properties
| Name | Type | Description |
id |
long |
The listing identifier. |
number_of_tickets |
int |
The number of tickets available for purchase. |
seating |
seating |
The seating information for the ticket(s) in this listing. |
pickup_available |
boolean |
True if the tickets can be picked up at the event; otherwise , false. |
download_available |
boolean |
True if the listing has a pre-uploaded E-Ticket; otherwise, false. |
ticket_price |
money |
The price of each ticket in the listing in the currency that they were listed in. |
estimated_ticket_price |
money |
The estimated price of each ticket in the currency requested by the client. |
estimated_total_ticket_price |
money |
The estimated total price for all tickets in the currency requested by the client. |
estimated_booking_fee |
money |
The estimated booking fee applied when the tickets are purchased, in the currency requested by the client. |
estimated_shipping |
money |
The estimated shipping charge applied when the tickets are purchased, in the currency requested by the client. |
estimated_vat |
money |
The estimated VAT charge applied when the tickets are purchased, in the currency requested by the client. |
estimated_total_charge |
money |
The estimated total charge applied when the tickets are purchased, in the currency requested by the client. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A listing for an event. |
listing:event |
GET |
No | The event for this listing. |
listing:localwebpage |
GET |
No | The webpage on the local viagogo website where a listing can be purchased. |
listing:webpage |
GET |
No | The webpage on the viagogo website for this listing. |
Embedded
| Relation | Type | Optional | Description |
listing_notes |
ListingNote[] |
No | The listing notes for this listing. |
ticket_type |
TicketType |
No | The type of ticket(s) in this listing. |
Listings
The Listings resource is a collection resource that contains zero or more references to a set of listings, and links that guide you on ways to interact with the listings. The collection offers a paginated view of listings.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current listings. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
Listing[] |
No | An array of the current page of Listing resources. |
MetroArea
A MetroArea is a metropolitan region that contains venues where events are taking place.
Properties
| Name | Type | Description |
id |
int |
The metro area identifier. |
name |
string |
The name of the metro area. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A metro area. |
metroarea:events |
GET |
No | The events taking place in a metro area. |
metroarea:venues |
GET |
No | The venues located in a metro area. |
MetroAreas
The MetroAreas resource is a collection resource that contains zero or more references to a set of metro areas, and links that guide you on ways to interact with the metro areas. The collection offers a paginated view of metro areas.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current metro areas. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
MetroArea[] |
No | An array of the current page of MetroArea resources. |
PaymentMethod
Properties
| Name | Type | Description |
id |
int |
The payment method identifier |
details |
string |
The obfuscated details of the payment method |
type |
string |
The type of the payment method. See PaymentMethod Types. |
type_description |
string |
A localised string describing the type of payment method. |
buyer_method |
boolean |
True if the payment method can be used for purchasing listings; otherwise, false. |
default_buyer_method |
boolean |
True if the payment method is the user’s default payment method for purchasing listings. |
seller_method |
boolean |
True if the payment method can be used for receiving payments; otherwise, false. |
default_seller_method |
boolean |
True if the payment method is the user’s default payment method for receiving payments. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A user’s payment method. |
paymentmethod:updatecreditcard |
PUT |
No | Update the current user’s credit card details. |
paymentmethod:updatepaypal |
PUT |
No | Update the current user’s PayPal details. |
paymentmethod:updatedefaults |
PATCH |
No | Update the default payment methods for the current user. |
paymentmethod:delete |
DELETE |
No | Delete the current user’s payment method. |
Embedded
| Relation | Type | Optional | Description |
billing_address |
Address |
No | The billing address for this payment method. |
PaymentMethods
The PaymentMethods resource is a collection resource that contains zero or more references to a set of payment methods, and links that guide you on ways to interact with the payment methods. The collection offers a paginated view of payment methods.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the payment methods. |
paymentmethod:createcreditcard |
POST |
No | Adds a new credit card for the current user. |
paymentmethod:createpaypal |
POST |
No | Adds a new PayPal account for the current user. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
PaymentMethod[] |
No | An array of the current page of PaymentMethod resources. |
Pickup
A scheduled courier pickup for a package.
Properties
| Name | Type | Description |
id |
int |
The pickup identifier. |
start_date |
datetime |
The earliest date that the courier will pickup the package. |
end_date |
datetime |
The latest date that the courier will pickup the package. |
address |
string |
The address where the courier will pickup the package. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A scheduled courier pickup. |
pickup:delete |
GET |
No | Cancel a scheduled courier pickup. |
Root
The root of the viagogo API service. Applications can use the links provided by this resource to find all other resources in the API.
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The root resource of the viagogo API. |
viagogo:countries |
GET |
No | The available countries. |
viagogo:currencies |
GET |
No | The available currencies. |
viagogo:genres |
GET |
No | The top-level categories that group all other categories and events. |
viagogo:languages |
GET |
No | The available languages. |
viagogo:metroareas |
GET |
No | The available metro areas. |
viagogo:search |
GET |
No | Search for events, categories, venues and metro areas. |
viagogo:user |
GET |
No | The currently authenticated user. |
viagogo:venues |
GET |
No | The available venues. |
viagogo:createsellerlisting |
POST |
No | Create a listing for an event. |
viagogo:listingconstraints |
PUT |
No | Retrieve the constraints for creating listings. |
Sale
A sale on the viagogo marketplace that belongs to the currently authenticated user.
Properties
| Name | Type | Description |
id |
int |
The sale identifier. |
created_at |
datetime |
The date when the sale was created. |
status |
string |
A short localised string describing the current status of the sale. |
status_description |
string |
A localised in-depth description of the current status of the sale. |
number_of_tickets |
int |
The number of tickets that have been sold. |
seating |
seating |
The seating information for the ticket(s) that have been sold. |
proceeds |
money |
The total amount that the seller will receive for the sale. |
confirm_by |
datetime |
The date by which the seller must confirm the sale. |
ship_by |
datetime |
The date by which the seller must ship the tickets. |
payment_type |
string |
The type of the payment method used for this sale. (see PaymentMethod Types) |
payment_type_description |
string |
A localised description of the type of PaymentMethod used for this sale. |
payment_details |
string |
A string showing the obscured details of the PaymentMethod used for this sale. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A sale of some tickets |
sale:autotrackshipment |
GET |
No | The webpage where a shipment of tickets can be tracked automatically. |
sale:confirm |
PATCH |
No | Confirm the sale. |
sale:etickets |
GET |
No | The uploaded E-Tickets that have been assigned to the tickets that have been sold. |
sale:eticketuploads |
GET |
No | The uploaded files containing E-Tickets that have not been assigned to the tickets that have been sold. |
sale:reject |
PATCH |
No | Report a problem with the sale. |
sale:saveetickets |
PATCH |
No | Assign uploaded E-Tickets to the tickets that have been sold. |
sale:shipments |
GET |
No | The shipments related to a sale. |
sale:trackshipment |
GET |
No | The webpage where a shipment of tickets can be tracked after entering the tracking_number. |
sale:uploadetickets |
POST |
No | Upload a file containing E-Tickets. |
Embedded
| Relation | Type | Optional | Description |
event |
Event |
No | The event for this sale. |
venue |
Venue |
No | The venue where the event is taking place. |
ticket_type |
TicketType |
No | The type of ticket(s) that was sold. |
delivery_method |
DeliveryMethod |
No | The delivery method for the ticket(s). |
Sales
The Sales resource is a collection resource that contains zero or more references to a set of sales, and links that guide you on ways to interact with the sales. The collection offers a paginated view of sales.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current sales. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
Sale[] |
No | An array of the current page of Sale resources. |
SearchResult
A SearchResult resource represents a single result of a search.
Properties
| Name | Type | Description |
title |
string |
The localized name of the result. |
type |
string |
The type of the result. Can be Event, Category, Venue or MetroArea. |
type_description |
string |
The localized text describing the type of the result. |
Links
| Relation | Method | Templated | Description |
searchresult:category |
GET |
No | The category that a search result represents. |
searchresult:event |
GET |
No | The event that a search result represents. |
searchresult:metroarea |
GET |
No | The metro area that a search result represents. |
searchresult:venue |
GET |
No | The venue that a search result represents. |
Embedded
| Relation | Type | Optional | Description |
category |
Category |
Yes | The category that a search result represents. |
event |
Event |
Yes | The event that a search result represents. |
metro_area |
MetroArea |
Yes | The metro area that a search result represents. |
venue |
Venue |
Yes | The venue that a search result represents. |
SearchResults
The SearchResults resource is a collection resource that contains zero or more references to a set of search results, and links that guide you on ways to interact with the search results. The collection offers a paginated view of search results.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current search results. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
SearchResult[] |
No | An array of the current page of SearchResult resources. |
SellerListing
A set of tickets for sale on the viagogo marketplace that belong to the currently authenticated user.
Properties
| Name | Type | Description |
id |
long |
The listing identifier. |
created_at |
datetime |
The date when the listing was created. |
updated_at |
datetime |
The date when the listing was last updated. |
external_id |
string |
An identifier that has been assigned to the listing in an external inventory management system |
number_of_tickets |
int |
The number of tickets available for purchase. |
display_number_of_tickets |
int |
The number of tickets that should be displayed to buyers as available for purchase. |
seating |
seating |
The seating information for the ticket(s) in this listing. |
seating |
display_seating |
The seating information that will be displayed to buyers for the ticket(s) in this listing. |
face_value |
money |
The price printed on the ticket, not including any booking fees. |
ticket_price |
money |
The price of each ticket in the listing. |
ticket_proceeds |
money |
The amount that the seller will receive for each ticket sold. |
in_hand_at |
datetime |
The date when the seller will have the tickets in hand. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A listing for an event. |
sellerlisting:constraints |
GET |
No | The constraints for the listing. |
sellerlisting:delete |
DELETE |
No | Delete a listing. |
sellerlisting:ticketlocation |
GET |
No | The address where the ticket(s) are located. |
sellerlisting:updatetickettype |
PATCH |
No | Update the type of ticket(s) for this listing. |
sellerlisting:updatesplittype |
PATCH |
No | Update the way the ticket(s) are allowed to be split up when sold. |
sellerlisting:updateticketprice |
PATCH |
No | Update the price of each ticket in this listing. |
sellerlisting:updatenumberoftickets |
PATCH |
No | Update the number of tickets available for purchase. |
sellerlisting:updateticketlocation |
PATCH |
No | Update the address where the ticket(s) are located. |
sellerlisting:updatenotes |
PATCH |
No | Update notes for this listing. |
sellerlisting:updatefacevalue |
PATCH |
No | Update face value for this listing. |
sellerlisting:updateinhandat |
PATCH |
No | Update the date the seller will have tickets for this listing in hand. |
sellerlisting:publish |
PATCH |
No | Make the listing available for purchase on the viagogo marketplace. |
sellerlisting:unpublish |
PATCH |
No | Make the listing unavailable for purchase on the viagogo marketplace. |
Embedded
| Relation | Type | Optional | Description |
event |
Event |
No | The event for this listing. |
venue |
Venue |
No | The venue where the event is taking place. |
ticket_type |
TicketType |
No | The type of ticket(s) in this listing. |
split_type |
SplitType |
No | The way that the ticket(s) are allowed to be split up when sold. |
listing_notes |
ListingNote[] |
No | The notes for this listing. |
SellerListings
The SellerListings resource is a collection resource that contains zero or more references to a set of listings, and links that guide you on ways to interact with the listings. The collection offers a paginated view of listings.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current listings. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
SellerListing[] |
No | An array of the current page of SellerListing resources. |
Shipment
A shipment of one or more tickets by a seller.
Properties
| Name | Type | Description |
id |
int |
The shipment identifier. |
tracking_number |
string |
The identifier used to track the shipment of the ticket(s) |
delivery_address |
string |
The address that the seller must ship the tickets to |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A shipment. |
shipment:label |
GET |
No | A courier shipping label. |
Embedded
| Relation | Type | Optional | Description |
delivery_method |
DeliveryMethod |
No | The delivery method for the ticket(s). |
pickup_addresses |
Address[] |
No | The addresses where courier pickups could be arranged. |
pickups |
Pickup[] |
No | The courier pickups that have been scheduled. |
Shipments
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.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the shipments. |
shipment:create |
PUT |
No | Creates a new shipment for the ticket(s). |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
Shipment[] |
No | An array of the current page of Shipment resources. |
SplitType
The way that the ticket(s) in a listing are allowed to be split up when sold.
Properties
| Name | Type | Description |
type |
string |
The type of split. Can be Any, None, AvoidOne, AvoidOneAndThree, or Pairs. |
name |
string |
The localized name of the type of split. |
description |
string |
The localized description of the split. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A split type. |
TicketType
The type of ticket(s) in a listing.
Properties
| Name | Type | Description |
type |
string |
The type of ticket. Can be PaperTicket, ETicket, PaperTicketNameChange, TesseraDelTifoso, SeasonCard, PaperTicketNameChange, ETicketNameChange or ETicketThirdPartyPreUpload. |
name |
string |
The localized name of the type of ticket. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A ticket type. |
TicketTypes
The TicketTypes resource is a collection resource that contains zero or more references to a set of ticket types, and links that guide you on ways to interact with the ticket types. The collection offers a paginated view of ticket types.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current ticket types. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
TicketType[] |
No | An array of the current page of TicketType resources. |
User
An authenticated user.
Properties
| Name | Type | Description |
full_name |
string |
The full name of the user. |
email |
string |
The email address of the user. |
primary_phone |
string |
The primary phone number of the user. |
email_optin |
boolean |
True if the user is signed up for the viagogo email newsletter; otherwise, false. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | An authenticated user. |
user:update |
PATCH |
No | Update the settings for this user. |
user:addresses |
GET |
No | The collection of Addresses associated with this user. |
user:paymentmethods |
GET |
No | The collection of PaymentMethods associated with this user. |
user:purchases |
GET |
No | The collection of Purchases associated with this user. |
user:sales |
GET |
No | The collection of Sales associated with this user. |
user:sellerlistings |
GET |
No | The collection of SellerListings associated with this user. |
user:webhooks |
GET |
No | The collection of Webhooks associated with this user. |
Venue
A venue is a location where an event takes place.
Properties
| Name | Type | Description |
id |
int |
The venue identifier. |
name |
string |
The name of the venue. |
address_1 |
string |
The first line of the address for the venue. |
address_2 |
string |
The second line of the address for the venue. |
city |
string |
The name of the city where the venue is located. |
state_province |
string |
The name of the State or Province where the venue is located. |
postal_code |
string |
The postal code for the venue. |
latitude |
float |
The latitude for the venue. |
longitude |
float |
The longitude for the venue. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A venue. |
venue:events |
GET |
No | The events taking place in a venue. |
venue:metroarea |
GET |
No | The metro area where a venue is located. |
Embedded
| Relation | Type | Optional | Description |
country |
Country |
No | The Country where the venue is located. |
Venues
The Venues resource is a collection resource that contains zero or more references to a set of venues, and links that guide you on ways to interact with the venues. The collection offers a paginated view of venues.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current venues. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
Venue[] |
No | An array of the current page of Venue resources. |
Webhook
A webhook is a subscription from a server application to certain topics on the
viagogo platform. When an occurrence of a topic is triggered, we’ll POST a
payload to the webhook’s configured url.
Properties
| Name | Type | Description |
id |
int |
The webhook identifier |
name |
string |
The name of the webhook |
url |
string |
The server endpoint that will receive the webhook payload |
topics |
string[] |
An array of the topics the webhook is trigger for |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | A webhook. |
webhook:delete |
DELETE |
No | Update the details of a webhooks. |
webhook:ping |
POST |
No | Ping a webhook. |
webhook:update |
PATCH |
No | Delete a webhook. |
Webhooks
The Webhooks resource is a collection resource that contains zero or more references to a set of webhooks, and links that guide you on ways to interact with the webhooks. The collection offers a paginated view of webhooks.
Properties
| Name | Type | Description |
page |
int |
The number of the current page of items. |
page_size |
int |
The number of items on each page. |
total_items |
int |
The total number of items on every page. |
Links
| Relation | Method | Templated | Description |
self |
GET |
No | The collection of the current webhooks. |
webhook:create |
POST |
No | Add a new Webhook for the current user. |
next |
GET |
No | The next page of items in a collection. |
prev |
GET |
No | The previous page of items in a collection. |
first |
GET |
No | The first page of items in a collection. |
last |
GET |
No | The last page of items in a collection. |
Embedded
| Relation | Type | Optional | Description |
items |
Webhook[] |
No | An array of the current page of webhook resources. |
Link Relations
The viagogo API v2 provides the following link relations that you can use to access and modify viagogo resources.
address:carrier
curl -X GET "https://api.viagogo.net/v2/addresses/34115/carriers/2"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
TODO
TODO
The above command returns an object structured like this:
{
"id": 2,
"name": "Ship via UPS",
"pickup_windows": [
{
"start_date": "2016-02-01T09:00:00+00:00",
"end_date": "2016-02-01T17:00:00+00:00"
},
{
"start_date": "2016-02-02T09:00:00+00:00",
"end_date": "2016-02-02T17:00:00+00:00"
},
{
"start_date": "2016-02-03T09:00:00+00:00",
"end_date": "2016-02-03T17:00:00+00:00"
},
{
"start_date": "2016-02-04T09:00:00+00:00",
"end_date": "2016-02-04T17:00:00+00:00"
}
],
"_links": {
"carrier:createpickup": {
"href": "https://api.viagogo.net/v2/addresses/34115/carriers/2/pickups",
"title": null,
"templated": false
}
}
}
You can GET the href of this link to retrieve the Carrier resource
that can collect tickets at this address.
Response
The Carrier resource.
address:create
curl -X POST "https://api.viagogo.net/v2/addresses"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:update": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:delete": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
You can use a POST request on the href of this link to add an address to the
current user’s addresses. This endpoint requires the write:user scope.
Parameters
| Name | Type | Required | Description |
full_name |
string |
Yes | The full name of the recipient. |
default |
boolean |
No | Specifies whether the address is the default address for this user. |
address_1 |
string |
Yes | The first line of the address. |
address_2 |
string |
No | The second line of the address. |
address_3 |
string |
No | The third line of the address. |
city |
string |
Yes | The name of the city where the address is located. |
state_province |
string |
Yes | The name of the State or Province where the address is located. |
postal_code |
string |
Yes | The postal code for the address. |
country_code |
string |
Yes | The 2 character ISO code that identifies the country in which the address is located. |
Response
The newly created Address.
address:delete
curl -X DELETE "https://api.viagogo.net/v2/addresses/34115"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
await api.Addresses.DeleteAsync(34115);
# TODO
You can use a DELETE request on the href of this link to delete an address for
the current user. This endpoint requires the write:user scope.
Response
No content (and 204 status code).
address:update
curl -X PATCH "https://api.viagogo.net/v2/addresses/34115"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:update": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:delete": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
You can use a PATCH request on the href of this link to update one of the
current user’s addresses. This endpoint requires the write:user scope.
Parameters
| Name | Type | Required | Description |
full_name |
string |
No | The full name of the recipient. |
default |
boolean |
No | Specifies whether the address is the default address for this user. |
address_1 |
string |
No | The first line of the address. |
address_2 |
string |
No | The second line of the address. |
address_3 |
string |
No | The third line of the address. |
city |
string |
No | The name of the city where the address is located. |
state_province |
string |
No | The name of the State or Province where the address is located. |
postal_code |
string |
No | The postal code for the address. |
country_code |
string |
No | The 2 character ISO code that identifies the country in which the address is located. |
Response
The updated Address.
carrier:createpickup
curl -X POST "https://api.viagogo.net/v2/addresses/34115/carriers/2/pickups"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
-d '{"start_date":"2015-09-24T09:00:00+00:00","end_date":"2015-09-24T17:00:00+00:00"}'
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 2109,
"start_date": "2015-09-24T09:00:00+00:00",
"end_date": "2015-09-24T17:00:00+00:00",
"address": {
"full_name": "Joe Smith",
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"country_code": "GB",
"country": "United Kingdom"
},
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/pickups/2109",
"title": null,
"templated": false
},
"pickup:delete": {
"href": "https://api.viagogo.net/v2/pickups/2109",
"title": null,
"templated": false
}
}
}
You can use a POST request on the href of this link to create a pickup for the
ticket(s) of a sale. This endpoint requires the write:user scope.
Response
The newly created Pickup.
category:children
curl -X GET "https://api.viagogo.net/v2/categories/3/children"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var children = await api.Categories.GetChildrenAsync(3);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
children = api.get_category_children 3
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/1207/children?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/categories/1207/children?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/categories/1207/children?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 1207,
"name": "Rock and Pop",
"description_html": "<p>Get your <b>Rock and Pop tickets</b> on viagogo, your online ticket marketplace. Choose an event to see the selection of tickets available or check the Rock and Pop tour on the map to locate the nearest event to you. You can also sell your spare tickets on viagogo, and listing tickets is free. All Rock and Pop tickets are covered by the viagogo Ticket Guarantee!</p>",
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"min_event_date": "2015-02-04T09:15:00+00:00",
"max_event_date": "2016-09-10T15:45:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/1207",
"title": null,
"templated": false
},
"category:parent": {
"href": "https://api.viagogo.net/v2/categories/3",
"title": null,
"templated": false
},
"category:children": {
"href": "https://api.viagogo.net/v2/categories/1207/children",
"title": null,
"templated": false
},
"category:performers": {
"href": "https://api.viagogo.net/v2/categories/1207/children?onlyLeafCategories=true",
"title": null,
"templated": false
},
"category:events": {
"href": "https://api.viagogo.net/v2/categories/1207/events",
"title": null,
"templated": false
},
"category:image": {
"href": "http://cdn1.viagogo.net/img/cat/1207/2/1.jpg",
"title": null,
"templated": false
},
"category:webpage": {
"href": "http://www.viagogo.com/Concert-Tickets/Rock-and-Pop",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the Categories
resource that contains the direct children of a category.
Parameters
| Name Type | Description | |
sort |
string |
Determines the ordering of items. A comma-separated string containing id, name, min_event_date, max_event_date or min_ticket_price. |
embed |
string |
A comma-separated set of properties that should be embedded in the Category resources. Can be top_performers, top_children or top_events. |
min_start_date |
datetime |
Filters results to only include categories that have events starting after the specified datetime. |
max_start_date |
datetime |
Filters results to only include categories that have events starting before the specified datetime. |
max_ticket_price |
decimal |
Filters results to only include categories that have events with tickets available for less than the specified amount. NOTE: This price is assumed to be in the currency code specified in the Accept-Currency |
only_with_events |
boolean |
Filters results to only include categories with events. |
only_with_tickets |
boolean |
Filters results to only include categories with events that have tickets. |
Response
Returns the Categories resource containing the direct children
of a category.
category:events
curl -X GET "https://api.viagogo.net/v2/categories/1207/events"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var events = await api.Events.GetAllByCategoryAsync(1207);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
children = api.get_events_by_category 1207
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/1207/events?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/categories/1207/events?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/categories/1207/events?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"notes_html": "General Notes \n • All sales are final \n • Ticket prices are set by the seller and may be above or below face value \n • Event dates and times are subject to change, it is up to you to check local listings for updates \n • After your purchase, you will receive a confirmation email with your ticket delivery details and timing",
"restrictions_html": "Everyone <strong>under 15</strong> must be accompanied by an adult.",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
},
"event:listings": {
"href": "https://api.viagogo.net/v2/events/735139/listings",
"title": "View Tickets",
"templated": false
},
"event:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"event:webpage": {
"href": "http://www.viagogo.com/E-735139",
"title": null,
"templated": false
},
"event:localwebpage": {
"href": "http://www.viagogo.co.uk/E-735139",
"title": null,
"templated": false
},
"event:listingconstraints": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
},
"event:createsellerlisting": {
"href": "https://api.viagogo.net/v2/events/735139/sellerlistings",
"title": "Sell Tickets",
"templated": false
}
},
"_embedded": {
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
]
}
}
You can GET the href of this link to retrieve the Events resource
that contains the events in a category.
Parameters
| Name Type | Description | |
sort |
string |
Determines the ordering of items. A comma-separated string containing id, name, min_start_date, min_ticket_price, or distance. |
embed |
string |
A comma-separated set of properties that should be embedded in the Event resources. Can be category. |
latitude |
float |
A user’s current latitude. |
longitude |
float |
A user’s current longitude. |
max_distance |
int |
Filters results to only include events located within the specfied number of meters from the user. |
min_start_date |
datetime |
Filters results to only include events starting after the specified datetime. |
max_start_date |
datetime |
Filters results to only include events starting before the specified datetime. |
max_ticket_price |
decimal |
Filters results to only include events with tickets available for less than the specified amount. NOTE: This price is assumed to be in the currency code specified in the Accept-Currency. |
time_frame |
string |
Filters results to only include events within a given timeframe. Can be one of Today, Tomorrow, ThisWeekend, ThisWeek, NextWeek, ThisMonth, NextMonth. |
days |
string |
Filters results to only include events that occur on any of the specified days. Can be a comma-separated string of the following values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. |
only_with_tickets |
boolean |
Filters results to only include events that have tickets. |
metro_area_id |
int |
Filters results to only include events located in a particular MetroArea. |
Response
Returns the Events resource containing the events in a category.
category:image
You can GET the href of this link to retrieve the image for a category.
Response
An jpeg or png image file.
category:parent
curl -X GET "https://api.viagogo.net/v2/categories/1207"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var category = await api.Categories.GetAsync(20746);
var parentCategory = await api.Hypermedia.GetAsync<Category>(category.ParentLink, null);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
category = api.get_category 20746
parent_category = api.get category.links['category:parent']
The above command returns an object structured like this:
{
"id": 1207,
"name": "Rock and Pop",
"description_html": "<p>Get your <b>Rock and Pop tickets</b> on viagogo, your online ticket marketplace. Choose an event to see the selection of tickets available or check the Rock and Pop tour on the map to locate the nearest event to you. You can also sell your spare tickets on viagogo, and listing tickets is free. All Rock and Pop tickets are covered by the viagogo Ticket Guarantee!</p>",
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"min_event_date": "2015-02-04T09:15:00+00:00",
"max_event_date": "2016-09-10T15:45:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/1207",
"title": null,
"templated": false
},
"category:parent": {
"href": "https://api.viagogo.net/v2/categories/3",
"title": null,
"templated": false
},
"category:children": {
"href": "https://api.viagogo.net/v2/categories/1207/children",
"title": null,
"templated": false
},
"category:performers": {
"href": "https://api.viagogo.net/v2/categories/1207/children?onlyLeafCategories=true",
"title": null,
"templated": false
},
"category:events": {
"href": "https://api.viagogo.net/v2/categories/1207/events",
"title": null,
"templated": false
},
"category:image": {
"href": "http://cdn1.viagogo.net/img/cat/1207/2/1.jpg",
"title": null,
"templated": false
},
"category:webpage": {
"href": "http://www.viagogo.com/Concert-Tickets/Rock-and-Pop",
"title": null,
"templated": false
}
}
}
You can GET the href of this link to retrieve the Category
resource that is a parent of a category.
Response
The parent Category resource.
category:performers
curl -X GET "https://api.viagogo.net/v2/categories/3/children?onlyLeafCategories=True"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var category = await client.Categories.GetAsync(3);
var performers = await client.Hypermedia.GetAsync<PagedResource<Category>>(
category.PerformersLink,
null);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
category = api.get_category 3
performers = api.get category.links['category:performers']
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/1207/children?onlyLeafCategories=true?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/categories/1207/children?onlyLeafCategories=true?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/categories/1207/children?onlyLeafCategories=true?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 20746,
"name": "One Direction",
"description_html": "One Direction (also known as 1D by their millions of fans worldwide) are Harry Styles, Liam Payne, Louis Tomlinson, Niall Horan and Zayn Malik. Their record breaking studio albums and massive hit tours have seen 1D become a global phenomenon and redefine the meaning of iconic status. With crowds swooning from all over the world to see this boy band live, One Direction are the most in-demand performers of today’s generation. Select a date to view the range of One Direction tickets available to an event near you. You can also sell your spare tickets on viagogo, and listing tickets is free. All One Direction ticket purchases are covered by the viagogo Ticket Guarantee and delivered electronically or via secure courier to more than a 100 countries in the world. viagogo provides choice, convenience and consumer protection so you can buy your One Direction tickets with 100% confidence.</p>",
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"min_event_date": "2015-02-07T07:00:00+00:00",
"max_event_date": "2015-10-31T18:30:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"category:parent": {
"href": "https://api.viagogo.net/v2/categories/1207",
"title": null,
"templated": false
},
"category:events": {
"href": "https://api.viagogo.net/v2/categories/20746/events",
"title": null,
"templated": false
},
"category:image": {
"href": "http://cdn1.viagogo.net/img/cat/20746/2/1.jpg",
"title": null,
"templated": false
},
"category:webpage": {
"href": "http://www.viagogo.com/Concert-Tickets/Rock-and-Pop/One-Direction-Tickets",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the Categories
resource that contains the leaf-descendants of a category.
Parameters
| Name Type | Description | |
sort |
string |
Determines the ordering of items. A comma-separated string containing id, name, min_event_date, max_event_date or min_ticket_price. |
embed |
string |
A comma-separated set of properties that should be embedded in the Category resources. Can be top_performers, top_children or top_events. |
min_start_date |
datetime |
Filters results to only include categories that have events starting after the specified datetime. |
max_start_date |
datetime |
Filters results to only include categories that have events starting before the specified datetime. |
max_ticket_price |
decimal |
Filters results to only include categories that have events with tickets available for less than the specified amount. NOTE: This price is assumed to be in the currency code specified in the Accept-Currency |
only_with_events |
boolean |
Filters results to only include categories with events. |
only_with_tickets |
boolean |
Filters results to only include categories with events that have tickets. |
Response
Returns the Categories resource containing the leaf descendants
of a category.
category:webpage
You can GET the href of this link to retrieve the viagogo website webpage for a category.
Response
An HTML web page.
country:events
curl -X GET "https://api.viagogo.net/v2/categories/0/events?country_code=GB"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var country = await api.Venues.GetAsync();
var events = await api.Hypermedia.GetAsync<PagedResource<Event>>(country.EventsLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
country = api.get_country
events = api.get country.links['country:events']
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"notes_html": "General Notes \n • All sales are final \n • Ticket prices are set by the seller and may be above or below face value \n • Event dates and times are subject to change, it is up to you to check local listings for updates \n • After your purchase, you will receive a confirmation email with your ticket delivery details and timing",
"restrictions_html": "Everyone <strong>under 15</strong> must be accompanied by an adult.",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
},
"event:listings": {
"href": "https://api.viagogo.net/v2/events/735139/listings",
"title": "View Tickets",
"templated": false
},
"event:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"event:webpage": {
"href": "http://www.viagogo.com/E-735139",
"title": null,
"templated": false
},
"event:localwebpage": {
"href": "http://www.viagogo.co.uk/E-735139",
"title": null,
"templated": false
},
"event:listingconstraints": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
},
"event:createsellerlisting": {
"href": "https://api.viagogo.net/v2/events/735139/sellerlistings",
"title": "Sell Tickets",
"templated": false
}
},
"_embedded": {
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
]
}
}
You can GET the href of this link to retrieve the Events resource
that contains the events taking place in a particular country.
Parameters
| Name Type | Description | |
sort |
string |
Determines the ordering of items. A comma-separated string containing id, name, min_start_date, min_ticket_price, or distance. |
embed |
string |
A comma-separated set of properties that should be embedded in the Event resources. Can be category. |
latitude |
float |
A user’s current latitude. |
longitude |
float |
A user’s current longitude. |
max_distance |
int |
Filters results to only include events located within the specfied number of meters from the user. |
min_start_date |
datetime |
Filters results to only include events starting after the specified datetime. |
max_start_date |
datetime |
Filters results to only include events starting before the specified datetime. |
max_ticket_price |
decimal |
Filters results to only include events with tickets available for less than the specified amount. NOTE: This price is assumed to be in the currency code specified in the Accept-Currency. |
time_frame |
string |
Filters results to only include events within a given timeframe. Can be one of Today, Tomorrow, ThisWeekend, ThisWeek, NextWeek, ThisMonth, NextMonth. |
days |
string |
Filters results to only include events that occur on any of the specified days. Can be a comma-separated string of the following values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. |
only_with_tickets |
boolean |
Filters results to only include events that have tickets. |
Response
Returns the Events resource containing the events taking place in a
particular country.
eticket:delete
curl -X DELETE "https://api.viagogo.net/v2/sales/1017322/etickets/25827"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
You can use a DELETE request on the href of this link to delete an E-Ticket.
This endpoint requires the write:user scope.
Response
No content (and 204 status code).
eticket:document
You can GET the href of this link to download a PDF file containing an E-Ticket.
This endpoint requires the read:user scope.
Response
The PDF file for an ETicket. The response will have content-type
application/pdf.
eticket:thumbnail
You can GET the href of this link to download an image file containing a
thumbnail of an E-Ticket. This endpoint requires the read:user scope.
Response
The thumbnail for an ETicket. The response will have content-type
image/jpeg or image/png.
eticketupload:document
You can GET the href of this link to download the original file that was
uploaded for an ETicketUpload. This endpoint requires the
read:user scope.
Response
The file for an ETicketUpload. The response will have
content-type application/pdf.
event:category
curl -X GET "https://api.viagogo.net/v2/categories/20746"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var @event = await api.Events.GetAsync(735139);
var eventCategory = await api.Hypermedia.GetAsync<Category>(@event.CategoryLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
event = api.get_event 735139
event_category = api.get event.links['event:category']
The above command returns an object structured like this:
{
"id": 20746,
"name": "One Direction",
"description_html": "One Direction (also known as 1D by their millions of fans worldwide) are Harry Styles, Liam Payne, Louis Tomlinson, Niall Horan and Zayn Malik. Their record breaking studio albums and massive hit tours have seen 1D become a global phenomenon and redefine the meaning of iconic status. With crowds swooning from all over the world to see this boy band live, One Direction are the most in-demand performers of today’s generation. Select a date to view the range of One Direction tickets available to an event near you. You can also sell your spare tickets on viagogo, and listing tickets is free. All One Direction ticket purchases are covered by the viagogo Ticket Guarantee and delivered electronically or via secure courier to more than a 100 countries in the world. viagogo provides choice, convenience and consumer protection so you can buy your One Direction tickets with 100% confidence.</p>",
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"min_event_date": "2015-02-07T07:00:00+00:00",
"max_event_date": "2015-10-31T18:30:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"category:parent": {
"href": "https://api.viagogo.net/v2/categories/1207",
"title": null,
"templated": false
},
"category:events": {
"href": "https://api.viagogo.net/v2/categories/20746/events",
"title": null,
"templated": false
},
"category:image": {
"href": "http://cdn1.viagogo.net/img/cat/20746/2/1.jpg",
"title": null,
"templated": false
},
"category:webpage": {
"href": "http://www.viagogo.com/Concert-Tickets/Rock-and-Pop/One-Direction-Tickets",
"title": null,
"templated": false
}
}
}
You can GET the href of this link to retrieve the Category
resource that contains an event.
Response
The Category resource.
event:createsellerlisting
curl -X POST "https://api.viagogo.net/v2/events/735139/sellerlistings"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
-d '{"external_id": "495293","seating":{"section":"107","row":"A","seat_from":"1","seat_to":"2"},"ticket_price":{"amount":25.65,"currency_code":"USD"},"face_value":{"amount":22.62,"currency_code":"EUR"},"ticket_type":"ETicket","split_type":"Any","number_of_tickets":2,"guarantee_payment_method_id":95698}'
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var listing = await api.SellerListings.CreateAsync(
735139,
new NewSellerListing
{
ExternalId = "495293",
NumberOfTickets = "2",
Seating = new Seating
{
Section = "107",
Row = "A",
SeatFrom = "1",
SeatTo = "4"
},
TicketPrice = new Money { Amount = 25.65, Currency = "USD" },
FaceValue = new Money { Amount = 22.62, Currency = "EUR" },
TicketType = "ETicket",
SplitType = "Any",
GuaranteePaymentMethodId = 95698
});
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a POST request on the href of this link to create a
SellerListing for this event. This endpoint requires the
write:sellerlistings scope.
Parameters
| Name | Type | Required | Description |
number_of_tickets |
int |
Yes | The number of tickets available for purchase. |
seating |
seating |
Yes | The seating information for the ticket(s) in this listing. |
ticket_price |
money |
Yes | The price of each ticket in the listing. |
ticket_type |
string |
Yes | The type of ticket(s) in this listing. Can be PaperTicket, ETicket, PaperTicketNameChange, TesseraDelTifoso, SeasonCard, PaperTicketNameChange, ETicketNameChange or ETicketThirdPartyPreUpload. |
split_type |
string |
Yes | The way that the ticket(s) are allowed to be split up when sold. Can be Any, None, AvoidOne, AvoidOneAndThree, or Pairs. |
guarantee_payment_method_id |
int |
Yes | The identifier of the credit card that should be used to guarantee your tickets. |
external_id |
string |
No | An identifier that has been assigned to the listing in an external inventory management system |
listing_note_ids |
int[] |
No | The identifiers of the [ListingNote] resources for this listing. |
face_value |
money |
No | The price printed on the ticket, not including any booking fees. |
display_number_of_tickets |
int |
No | The number of tickets that should be displayed to buyers as available for purchase. |
ticket_location_address_id |
int |
No | The identifier of the address where the ticket(s) are located. |
Response
Returns the SellerListing resource that is created for the
event.
event:listingconstraints
curl -X GET "https://api.viagogo.net/v2/events/735139/listingconstraints"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"max_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"min_number_of_tickets": 1,
"max_number_of_tickets": 99,
"ticket_location_required": true,
"seats_required": false,
"sections": [
{
"name": "General Admission",
"free_text_row": false,
"rows": [
]
}
],
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
}
},
"_embedded": {
"ticket_types": [
{
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
}
],
"split_types": [
{
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
}
],
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
],
"currencies": [
{
"code": "USD",
"name": "United States Dollar",
"symbol": "$",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/currencies/USD",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the
ListingConstraints resource for creating listings for
this event.
Response
The ListingConstraints resource.
event:listings
curl -X GET "https://api.viagogo.net/v2/events/735139/listings"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var listings = await api.Listings.GetAllByEventAsync(735139);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
listings = api.get_listings_by_event 735139
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139/listings?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/events/735139/listings?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/events/735139/listings?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 22096065,
"number_of_tickets": 1,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"pickup_available": false,
"download_available": false,
"ticket_price": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"estimated_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"estimated_total_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"estimated_booking_fee": {
"amount": 5.35,
"currency_code": "USD",
"display": "$5.35"
},
"estimated_shipping": {
"amount": 0,
"currency_code": "USD",
"display": "$0.00"
},
"estimated_vat": {
"amount": 0,
"currency_code": "USD",
"display": "$0.00"
},
"estimated_total_charge": {
"amount": 30,
"currency_code": "USD",
"display": "$30.00"
},
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listings/22096065",
"title": null,
"templated": false
},
"listing:event": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
},
"listing:purchasepreview": {
"href": "https://api.viagogo.net/v2/listings/22096065/purchasepreview",
"title": "Buy",
"templated": false
},
"listing:deliverymethods": {
"href": "https://api.viagogo.net/v2/listings/22096065/deliverymethods",
"title": null,
"templated": false
}
},
"_embedded": {
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
],
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
}
}
}
]
}
}
You can GET the href of this link to retrieve the Listings
resource that contains the listings in an event.
Parameters
| Name | Type | Description |
sort |
string |
Determines the ordering of items. A comma-separated string containing id, ticket_price, seating.section, or number_of_tickets. |
number_of_tickets |
int |
Filters results to only include listings that allow the specified number of tickets to be purchased. |
Response
Returns the Listings resource that contains the listings in an
event.
event:localwebpage
You can GET the href of this link to retrieve the local viagogo website webpage for a event. The domain of the viagogo webpage will match the country where the event is taking place. (e.g. www.viagogo.fr for an event taking place in France).
Response
An HTML web page.
event:webpage
You can GET the href of this link to retrieve the viagogo website webpage for an
event. The domain of the viagogo webpage will match the
VGG-Country Header in your request.
Response
An HTML web page.
listing:event
curl -X GET "https://api.viagogo.net/v2/events/735139"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var listing = await api.Listings.GetAsync(22096065);
var @event = await api.Hypermedia.GetAsync<Event>(listing.EventLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
listing = api.get_listing 22096065
event = api.get listing.links['listing:event']
The above command returns an object structured like this:
{
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"notes_html": "General Notes \n • All sales are final \n • Ticket prices are set by the seller and may be above or below face value \n • Event dates and times are subject to change, it is up to you to check local listings for updates \n • After your purchase, you will receive a confirmation email with your ticket delivery details and timing",
"restrictions_html": "Everyone <strong>under 15</strong> must be accompanied by an adult.",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
},
"event:listings": {
"href": "https://api.viagogo.net/v2/events/735139/listings",
"title": "View Tickets",
"templated": false
},
"event:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"event:webpage": {
"href": "http://www.viagogo.com/E-735139",
"title": null,
"templated": false
},
"event:localwebpage": {
"href": "http://www.viagogo.co.uk/E-735139",
"title": null,
"templated": false
},
"event:listingconstraints": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
},
"event:createsellerlisting": {
"href": "https://api.viagogo.net/v2/events/735139/sellerlistings",
"title": "Sell Tickets",
"templated": false
}
},
"_embedded": {
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
You can GET the href of this link to retrieve the Event resource
that a listing is for.
Response
The Event resource.
listing:localwebpage
You can GET the href of this link to retrieve the local viagogo website webpage where a listing can be purchased. The domain of the viagogo webpage will match the country where the event is taking place. (e.g. www.viagogo.fr for an event taking place in France).
Response
An HTML web page.
listing:webpage
You can GET the href of this link to retrieve the viagogo website webpage where
a listing can be purchased. The domain of the viagogo webpage will match the
VGG-Country Header in your request.
Response
An HTML web page.
metroarea:events
curl -X GET "https://api.viagogo.net/v2/categories/0/events?metro_area_id=65"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var metroArea = await api.MetroAreas.GetAsync(65);
var events = await api.Hypermedia.GetAsync<PagedResource<Event>>(metroArea.EventsLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
metro_area = api.get_metro_area 65
events = api.get metro_area.links['metroarea:events']
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/0/events?metro_area_id=65?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/categories/0/events?metro_area_id=65?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/categories/0/events?metro_area_id=65?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"notes_html": "General Notes \n • All sales are final \n • Ticket prices are set by the seller and may be above or below face value \n • Event dates and times are subject to change, it is up to you to check local listings for updates \n • After your purchase, you will receive a confirmation email with your ticket delivery details and timing",
"restrictions_html": "Everyone <strong>under 15</strong> must be accompanied by an adult.",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
},
"event:listings": {
"href": "https://api.viagogo.net/v2/events/735139/listings",
"title": "View Tickets",
"templated": false
},
"event:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"event:webpage": {
"href": "http://www.viagogo.com/E-735139",
"title": null,
"templated": false
},
"event:localwebpage": {
"href": "http://www.viagogo.co.uk/E-735139",
"title": null,
"templated": false
},
"event:listingconstraints": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
},
"event:createsellerlisting": {
"href": "https://api.viagogo.net/v2/events/735139/sellerlistings",
"title": "Sell Tickets",
"templated": false
}
},
"_embedded": {
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
]
}
}
You can GET the href of this link to retrieve the Events resource
that contains the events taking place in a particular metro area.
Parameters
| Name Type | Description | |
sort |
string |
Determines the ordering of items. A comma-separated string containing id, name, min_start_date, min_ticket_price, or distance. |
embed |
string |
A comma-separated set of properties that should be embedded in the Event resources. Can be category. |
latitude |
float |
A user’s current latitude. |
longitude |
float |
A user’s current longitude. |
max_distance |
int |
Filters results to only include events located within the specfied number of meters from the user. |
min_start_date |
datetime |
Filters results to only include events starting after the specified datetime. |
max_start_date |
datetime |
Filters results to only include events starting before the specified datetime. |
max_ticket_price |
decimal |
Filters results to only include events with tickets available for less than the specified amount. NOTE: This price is assumed to be in the currency code specified in the Accept-Currency. |
time_frame |
string |
Filters results to only include events within a given timeframe. Can be one of Today, Tomorrow, ThisWeekend, ThisWeek, NextWeek, ThisMonth, NextMonth. |
days |
string |
Filters results to only include events that occur on any of the specified days. Can be a comma-separated string of the following values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. |
only_with_tickets |
boolean |
Filters results to only include events that have tickets. |
Response
Returns the Events resource containing the events taking place in a
particular metro area.
metroarea:venues
curl -X GET "https://api.viagogo.net/v2/venues?metro_area_id=65"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var metroArea = await api.MetroAreas.GetAsync(65);
var venues = await api.Hypermedia.GetAsync<PagedResource<Venue>>(metroArea.VenuesLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
metro_area = api.get_metro_area 65
venues = api.get metro_area.links['metroarea:venues']
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues?metro_area_id=65?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/venues?metro_area_id=65?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/venues?metro_area_id=65?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 1364,
"name": "The O2 arena",
"address_1": "Peninsula Square",
"address_2": "",
"state_province": "",
"postal_code": "SE10 0DX",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
},
"venue:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?venue_id=1364",
"title": null,
"templated": false
},
"venue:metroarea": {
"href": "https://api.viagogo.net/v2/metroareas/65",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
]
}
}
You can GET the href of this link to retrieve the Venues resource
that contains the venues located in a metro area.
Response
Returns the Venues resource that contains the venues located in a
metro area.
paymentmethod:createcreditcard
curl -X POST "https://api.viagogo.net/v2/paymentmethods?paymentmethodtype=CreditCard"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 95698,
"details": "************1111",
"type": "CreditCard",
"type_description": "Credit or Debit Card",
"buyer_method": true,
"default_buyer_method": false,
"seller_method": false,
"default_seller_method": false,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatedefaults": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatecreditcard": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698?paymentMethodType=CreditCard",
"title": null,
"templated": false
},
"paymentmethod:delete": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
}
},
"_embedded": {
"billing_address": {
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:update": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:delete": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
You can use a POST request on the href of this link to add credit card to the
current user’s payment methods. This endpoint requires the write:user scope.
Parameters
| Name | Type | Required | Description |
full_name |
string |
Yes | The card holder’s full name. |
card_number |
string |
Yes | The long card number of the credit card. |
expiry_month |
int |
Yes | The month that the card expires. Must be a value between 1 and 12. |
expiry_year |
int |
Yes | The year that the card expires. |
start_month |
int |
No | The month that the card was issued. Must be a value between 1 and 12. |
start_year |
int |
No | The year that the card was issued. |
issue_number |
string |
No | The credit card’s issue number. |
billing_address_id |
int |
Yes | The identifier of the billing address for the credit card. |
default_buyer_method |
boolean |
No | If set to true, this will update the specified payment method to be the user’s default payment method for purchases. If set to false or null, this will field will be ignored. |
default_seller_method |
boolean |
No | If set to true, this will update the specified payment method to be the user’s default payment method for sales. If set to false or null, this will field will be ignored. |
Response
The newly created PaymentMethod.
paymentmethod:createpaypal
curl -X POST "https://api.viagogo.net/v2/paymentmethods?paymentmethodtype=Paypal"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 95698,
"details": "joe.smith@email.com",
"type": "PayPal",
"type_description": "PayPal",
"buyer_method": true,
"default_buyer_method": false,
"seller_method": false,
"default_seller_method": false,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatedefaults": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatecreditcard": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698?paymentMethodType=CreditCard",
"title": null,
"templated": false
},
"paymentmethod:delete": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
}
},
"_embedded": {
"billing_address": {
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:update": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:delete": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
You can use a POST request on the href of this link to add PayPal account to
the current user’s payment methods. This endpoint requires the write:user
scope.
Parameters
| Name | Type | Required | Description |
email |
string |
Yes | The email address of the PayPal account. |
billing_address_id |
int |
Yes | The identifier of the billing address for the credit card. |
default_buyer_method |
boolean |
No | If set to true, this will update the specified payment method to be the user’s default payment method for purchases. If set to false or null, this will field will be ignored. |
default_seller_method |
boolean |
No | If set to true, this will update the specified payment method to be the user’s default payment method for sales. If set to false or null, this will field will be ignored. |
Response
The newly created PaymentMethod.
paymentmethod:delete
curl -X DELETE "https://api.viagogo.net/v2/paymentmethods/95698"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
await api.PaymentMethods.DeleteAsync(95698);
# TODO
You can use a DELETE request on the href of this link to delete a
payment_method for the current user. This endpoint requires the write:user
scope.
Response
No content (and 204 status code).
paymentmethod:updatecreditcard
curl -X PUT "https://api.viagogo.net/v2/paymentmethods/95698?paymentMethodType=CreditCard"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 95698,
"details": "************1111",
"type": "CreditCard",
"type_description": "Credit or Debit Card",
"buyer_method": true,
"default_buyer_method": false,
"seller_method": false,
"default_seller_method": false,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatedefaults": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatecreditcard": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698?paymentMethodType=CreditCard",
"title": null,
"templated": false
},
"paymentmethod:delete": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
}
},
"_embedded": {
"billing_address": {
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:update": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:delete": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
You can use a PUT request on the href of this link to update the current
user’s credit card. This endpoint requires the write:user scope.
Parameters
| Name | Type | Required | Description |
full_name |
string |
Yes | The card holder’s full name. |
card_number |
string |
Yes | The long card number of the credit card. |
expiry_month |
int |
Yes | The month that the card expires. Must be a value between 1 and 12. |
expiry_year |
int |
Yes | The year that the card expires. |
start_month |
int |
No | The month that the card was issued. Must be a value between 1 and 12. |
start_year |
int |
No | The year that the card was issued. |
issue_number |
string |
No | The credit card’s issue number. |
billing_address_id |
int |
Yes | The identifier of the billing address for the credit card. |
default_buyer_method |
boolean |
No | If set to true, this will update the specified payment method to be the user’s default payment method for purchases. If set to false or null, this will field will be ignored. |
default_seller_method |
boolean |
No | If set to true, this will update the specified payment method to be the user’s default payment method for sales. If set to false or null, this will field will be ignored. |
Response
The updated PaymentMethod.
paymentmethod:updatedefaults
curl -X PUT "https://api.viagogo.net/v2/paymentmethods/95698"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 95698,
"details": "************1111",
"type": "CreditCard",
"type_description": "Credit or Debit Card",
"buyer_method": true,
"default_buyer_method": false,
"seller_method": false,
"default_seller_method": false,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatedefaults": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatecreditcard": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698?paymentMethodType=CreditCard",
"title": null,
"templated": false
},
"paymentmethod:delete": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
}
},
"_embedded": {
"billing_address": {
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:update": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:delete": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
You can use a PATHCH request on the href of this link to update whether a
payment method is the default for the current user. This endpoint requires the
write:user scope.
Parameters
| Name | Type | Required | Description |
default_buyer_method |
boolean |
No | If set to true, this will update the specified payment method to be the user’s default payment method for purchases. If set to false or null, this will field will be ignored. |
default_seller_method |
boolean |
No | If set to true, this will update the specified payment method to be the user’s default payment method for sales. If set to false or null, this will field will be ignored. |
Response
The updated PaymentMethod.
paymentmethod:updatepaypal
curl -X PUT "https://api.viagogo.net/v2/paymentmethods/95698?paymentmethodtype=Paypal"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 95698,
"details": "joe.smith@email.com",
"type": "PayPal",
"type_description": "PayPal",
"buyer_method": true,
"default_buyer_method": false,
"seller_method": false,
"default_seller_method": false,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatedefaults": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatecreditcard": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698?paymentMethodType=CreditCard",
"title": null,
"templated": false
},
"paymentmethod:delete": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
}
},
"_embedded": {
"billing_address": {
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:update": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:delete": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
You can use a PUT request on the href of this link to update the current
user’s PayPal account. This endpoint requires the write:user scope.
Parameters
| Name | Type | Required | Description |
email |
string |
Yes | The email address of the PayPal account. |
billing_address_id |
int |
Yes | The identifier of the billing address for the credit card. |
default_buyer_method |
boolean |
No | If set to true, this will update the specified payment method to be the user’s default payment method for purchases. If set to false or null, this will field will be ignored. |
default_seller_method |
boolean |
No | If set to true, this will update the specified payment method to be the user’s default payment method for sales. If set to false or null, this will field will be ignored. |
Response
The updated PaymentMethod.
pickup:delete
curl -X DELETE "https://api.viagogo.net/v2/pickups/2109"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
You can use a DELETE request on the href of this link to delete a scheduled
courier pickup. This endpoint requires the write:user scope.
Response
No content (and 204 status code).
sale:autotrackshipment
You can GET the href of this link to retrieve the webpage where the shipment of the ticket(s) for a sale can be tracked. The webpage provides automatic tracking information for the user’s order.
Response
An HTML web page.
sale:confirm
curl -X PATCH "https://api.viagogo.net/v2/sales/1017322"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 1017322,
"created_at": "2015-09-21T16:02:39+00:00",
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"number_of_tickets": 2,
"status": "Confirm Sales",
"status_description": null,
"confirm_by": "2015-09-23T16:02:43+00:00",
"ship_by": null,
"payment_details": "************1111",
"payment_type": "CreditCard",
"payment_type_description": "Credit or Debit Card",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": null,
"templated": false
},
"sale:confirm": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": "Confirm",
"templated": false
},
"sale:reject": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": "Report a problem",
"templated": false
},
"sale:listing": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
}
},
"_embedded": {
"delivery_method": {
"id": 0,
"name": "UPS (Express Saver) - United Kingdom Domestic",
"type": "Pickup"
},
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
You can use a PATCH request on the href of this link to confirm a sale of
tickets. This endpoint requires the write:user scope.
Parameters
| Name | Type | Required | Description |
confirmed |
boolean |
No | True when the sale should be confirmed; Otherwise, false. |
Response
The updated Sale resource.
sale:etickets
curl -X GET "https://api.viagogo.net/v2/sales/1017322/etickets"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322/etickets?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/sales/1017322/etickets?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/sales/1017322/etickets?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 25827,
"_links": {
"eticket:delete": {
"href": "https://api.viagogo.net/v2/sales/1017322/etickets/25827",
"title": null,
"templated": false
},
"eticket:document": {
"href": "https://api.viagogo.net/v2/etickets/25827/document",
"title": null,
"templated": false
},
"eticket:thumbnail": {
"href": "https://api.viagogo.net/v2/etickets/25827/thumbnail",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the ETickets
resource that contains uploaded E-Tickets that have been assigned to tickets
that have been sold. This endpoint requires the read:user scope.
Response
Returns the ETickets resource related to a sale.
sale:eticketuploads
curl -X GET "https://api.viagogo.net/v2/sales/1017322/eticketuploads"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322/eticketuploads?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/sales/1017322/eticketuploads?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/sales/1017322/eticketuploads?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 4059,
"file_name": "Ticket.pdf",
"processed_at": "2015-09-24T11:51:44+00:00",
"original_number_of_etickets": 1,
"status_description": "Processing Complete",
"_links": {
"eticketupload:document": {
"href": "https://api.viagogo.net/v2/eticketuploads/4059/document",
"title": null,
"templated": false
}
},
"_embedded": {
"etickets": [
{
"id": 25827,
"_links": {
"eticket:delete": {
"href": "https://api.viagogo.net/v2/sales/1017322/etickets/25827",
"title": null,
"templated": false
},
"eticket:document": {
"href": "https://api.viagogo.net/v2/etickets/25827/document",
"title": null,
"templated": false
},
"eticket:thumbnail": {
"href": "https://api.viagogo.net/v2/etickets/25827/thumbnail",
"title": null,
"templated": false
}
}
}
]
}
}
]
}
}
You can GET the href of this link to retrieve the
ETicketUploads the uploaded files that contain E-Tickets
that have not been assigned to the tickets that were sold. This endpoint
requires the read:user scope.
Response
Returns the ETicketUploads resource related to a sale.
sale:reject
curl -X PATCH "https://api.viagogo.net/v2/sales/1017322"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 1017322,
"created_at": "2015-09-21T16:02:39+00:00",
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"number_of_tickets": 2,
"status": "Confirm Sales",
"status_description": null,
"confirm_by": "2015-09-23T16:02:43+00:00",
"ship_by": null,
"payment_details": "************1111",
"payment_type": "CreditCard",
"payment_type_description": "Credit or Debit Card",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": null,
"templated": false
},
"sale:confirm": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": "Confirm",
"templated": false
},
"sale:reject": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": "Report a problem",
"templated": false
},
"sale:listing": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
}
},
"_embedded": {
"delivery_method": {
"id": 0,
"name": "UPS (Express Saver) - United Kingdom Domestic",
"type": "Pickup"
},
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
You can use a PATCH request on the href of this link to report a problem with a
sale of tickets. This endpoint requires the write:user scope.
Parameters
| Name | Type | Required | Description |
confirmed |
boolean |
No | False when the sale should be rejected; Otherwise, true. |
Response
The updated Sale resource.
sale:saveetickets
curl -X PATCH "https://api.viagogo.net/v2/sales/1017322"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 1017322,
"created_at": "2015-09-21T16:02:39+00:00",
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"number_of_tickets": 2,
"status": "Confirm Sales",
"status_description": null,
"confirm_by": "2015-09-23T16:02:43+00:00",
"ship_by": null,
"payment_details": "************1111",
"payment_type": "CreditCard",
"payment_type_description": "Credit or Debit Card",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": null,
"templated": false
},
"sale:confirm": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": "Confirm",
"templated": false
},
"sale:reject": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": "Report a problem",
"templated": false
},
"sale:listing": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
}
},
"_embedded": {
"delivery_method": {
"id": 0,
"name": "UPS (Express Saver) - United Kingdom Domestic",
"type": "Pickup"
},
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
You can use a PATCH request on the href of this link to assign uploaded
E-Tickets to the tickets that have been sold. This endpoint requires the
write:user scope.
Parameters
| Name | Type | Required | Description |
eticket_ids |
int[] |
No | A comma-separated string of the identifiers of the E-Tickets to be assigned. |
Response
The updated Sale resource.
sale:shipments
curl -X GET "https://api.viagogo.net/v2/sales/1017322/shipments"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322/shipments?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/sales/1017322/shipments?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/sales/1017322/shipments?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 1007247,
"tracking_number": "1ZX0565R0490161406",
"delivery_address": null,
"_links": {
"shipment:carrier": {
"href": "https://api.viagogo.net/v2/addresses/37073/carriers/2",
"title": null,
"templated": false
},
"shipment:label": {
"href": "https://api.viagogo.net/v2/sales/1017898/shipments/1007247/label",
"title": null,
"templated": false
}
},
"_embedded": {
"delivery_method": {
"id": 0,
"name": "UPS (Express Saver) - United Kingdom Domestic",
"type": "Pickup"
},
"pickup_addresses": [
{
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"address:carrier": {
"href": "https://api.viagogo.net/v2/addresses/34115/carriers/2",
"title": null,
"templated": false
}
},
"_embedded": null
}
],
"pickups": [
{
"id": 2109,
"start_date": "2015-09-24T09:00:00+00:00",
"end_date": "2015-09-24T17:00:00+00:00",
"address": {
"full_name": "Joe Smith",
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"country_code": "GB",
"country": "United Kingdom"
},
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/pickups/2109",
"title": null,
"templated": false
},
"pickup:delete": {
"href": "https://api.viagogo.net/v2/pickups/2109",
"title": null,
"templated": false
}
}
}
]
}
}
]
}
}
You can GET the href of this link to retrieve the Shipments
resource that contains shipments related to a sale. This endpoint requires the
read:user scope.
Response
Returns the Shipments resource related to a sale.
sale:trackshipment
You can GET the href of this link to retrieve the webpage where the shipment of the ticket(s) for a sale can be tracked. The user will need to enter the tracking number manually on this page.
Response
An HTML web page.
sale:uploadetickets
curl -X POST ""
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
-H "Content-Type: multipart/form-data; boundary=----CustomBoundary123456abcdef"
-F "File1=Ticket.pdf"
// TODO
# TODO
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322/eticketuploads?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/sales/1017322/eticketuploads?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/sales/1017322/eticketuploads?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 4059,
"file_name": "Ticket.pdf",
"processed_at": "2015-09-24T11:51:44+00:00",
"original_number_of_etickets": 1,
"status_description": "Processing Complete",
"_links": {
"eticketupload:document": {
"href": "https://api.viagogo.net/v2/eticketuploads/4059/document",
"title": null,
"templated": false
}
},
"_embedded": {
"etickets": [
{
"id": 25827,
"_links": {
"eticket:delete": {
"href": "https://api.viagogo.net/v2/sales/1017322/etickets/25827",
"title": null,
"templated": false
},
"eticket:document": {
"href": "https://api.viagogo.net/v2/etickets/25827/document",
"title": null,
"templated": false
},
"eticket:thumbnail": {
"href": "https://api.viagogo.net/v2/etickets/25827/thumbnail",
"title": null,
"templated": false
}
}
}
]
}
}
]
}
}
You can use a POST request on the href of this link upload one or more files
containing E-Tickets that will be assigned to the tickets that have been sold.
This endpoint requires the write:user scope.
Request
One or more PDF files containing E-Tickets must be uploaded using Form-based File Upload in HTML.
Response
Returns the ETicketUploads resource for the newly created
uploads.
searchresult:category
curl -X GET "https://api.viagogo.net/v2/categories/1207"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var searchResults = await api.Search.GetAsync("one direction");
var category = await api.Hypermedia.GetAsync<Category>(searchResults[0].CategoryLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
search_results = api.search 'one direction'
category = api.get search_results.items[0].links['searchresult:category']
The above command returns an object structured like this:
{
"id": 20746,
"name": "One Direction",
"description_html": "One Direction (also known as 1D by their millions of fans worldwide) are Harry Styles, Liam Payne, Louis Tomlinson, Niall Horan and Zayn Malik. Their record breaking studio albums and massive hit tours have seen 1D become a global phenomenon and redefine the meaning of iconic status. With crowds swooning from all over the world to see this boy band live, One Direction are the most in-demand performers of today’s generation. Select a date to view the range of One Direction tickets available to an event near you. You can also sell your spare tickets on viagogo, and listing tickets is free. All One Direction ticket purchases are covered by the viagogo Ticket Guarantee and delivered electronically or via secure courier to more than a 100 countries in the world. viagogo provides choice, convenience and consumer protection so you can buy your One Direction tickets with 100% confidence.</p>",
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"min_event_date": "2015-02-07T07:00:00+00:00",
"max_event_date": "2015-10-31T18:30:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"category:parent": {
"href": "https://api.viagogo.net/v2/categories/1207",
"title": null,
"templated": false
},
"category:events": {
"href": "https://api.viagogo.net/v2/categories/20746/events",
"title": null,
"templated": false
},
"category:image": {
"href": "http://cdn1.viagogo.net/img/cat/20746/2/1.jpg",
"title": null,
"templated": false
},
"category:webpage": {
"href": "http://www.viagogo.com/Concert-Tickets/Rock-and-Pop/One-Direction-Tickets",
"title": null,
"templated": false
}
}
}
You can GET the href of this link to retrieve the Category
resource that a search result represents.
Response
The Category resource.
searchresult:event
curl -X GET "https://api.viagogo.net/v2/events/735139"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var searchResults = await api.Search.GetAsync("one direction");
var event = await api.Hypermedia.GetAsync<Event>(searchResults[0].EventLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
search_results = api.search 'one direction'
event = api.get search_results.items[0].links['searchresult:event']
The above command returns an object structured like this:
{
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"notes_html": "General Notes \n • All sales are final \n • Ticket prices are set by the seller and may be above or below face value \n • Event dates and times are subject to change, it is up to you to check local listings for updates \n • After your purchase, you will receive a confirmation email with your ticket delivery details and timing",
"restrictions_html": "Everyone <strong>under 15</strong> must be accompanied by an adult.",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
},
"event:listings": {
"href": "https://api.viagogo.net/v2/events/735139/listings",
"title": "View Tickets",
"templated": false
},
"event:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"event:webpage": {
"href": "http://www.viagogo.com/E-735139",
"title": null,
"templated": false
},
"event:localwebpage": {
"href": "http://www.viagogo.co.uk/E-735139",
"title": null,
"templated": false
},
"event:listingconstraints": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
},
"event:createsellerlisting": {
"href": "https://api.viagogo.net/v2/events/735139/sellerlistings",
"title": "Sell Tickets",
"templated": false
}
},
"_embedded": {
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
You can GET the href of this link to retrieve the Event resource
that a search result represents.
Response
The Event resource.
searchresult:metroarea
curl -X GET "https://api.viagogo.net/v2/metroareas/65"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var searchResults = await api.Search.GetAsync("one direction");
var metroArea = await api.Hypermedia.GetAsync<MetroArea>(searchResults[0].MetroAreaLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
search_results = api.search 'one direction'
metro_area = api.get search_results.items[0].links['searchresult:metroarea']
The above command returns an object structured like this:
{
"id": 65,
"name": "London",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/metroareas/65",
"title": null,
"templated": false
},
"metroarea:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?metro_area_id=65",
"title": null,
"templated": false
},
"metroarea:venues": {
"href": "https://api.viagogo.net/v2/venues?metro_area_id=65",
"title": null,
"templated": false
}
}
}
You can GET the href of this link to retrieve the MetroArea
resource that a search result represents.
Response
The MetroArea resource.
searchresult:venue
curl -X GET "https://api.viagogo.net/v2/venues/1364"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var searchResults = await api.Search.GetAsync("one direction");
var venue = await api.Hypermedia.GetAsync<Venue>(searchResults[0].VenueLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
search_results = api.search 'one direction'
venue = api.get search_results.items[0].links['searchresult:venue']
The above command returns an object structured like this:
{
"id": 1364,
"name": "The O2 arena",
"address_1": "Peninsula Square",
"address_2": "",
"state_province": "",
"postal_code": "SE10 0DX",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
},
"venue:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?venue_id=1364",
"title": null,
"templated": false
},
"venue:metroarea": {
"href": "https://api.viagogo.net/v2/metroareas/65",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
You can GET the href of this link to retrieve the Venue resource
that a search result represents.
Response
The Venue resource.
sellerlisting:constraints
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065/constraints"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"max_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"min_number_of_tickets": 1,
"max_number_of_tickets": 99,
"ticket_location_required": true,
"seats_required": false,
"sections": [
{
"name": "General Admission",
"free_text_row": false,
"rows": [
]
}
],
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
}
},
"_embedded": {
"ticket_types": [
{
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
}
],
"split_types": [
{
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
}
],
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
],
"currencies": [
{
"code": "USD",
"name": "United States Dollar",
"symbol": "$",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/currencies/USD",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the
ListingConstraints resource for updating a
SellerListing. This endpoint requires the
write:sellerlistings scope.
Response
The ListingConstraints resource.
sellerlisting:delete
curl -X DELETE "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
await api.PaymentMethods.DeleteAsync(22096065);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
api.delete_seller_listing 22096065
You can use a DELETE request on the href of this link to delete a
sellerlisting for the current user. This endpoint requires the
write:sellerlistings scope.
Response
No content (and 204 status code).
sellerlisting:publish
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PATCH request on the href of this link to make a
SellerListing available for purchase on the viagogo
marketplace. This endpoint requires the write:sellerlistings scope.
Parameters
| Name | Type | Required | Description |
published |
boolean |
No | True when the listing should be published; Otherwise, false. |
Response
The updated SellerListing resource.
sellerlisting:ticketlocation
curl -X GET "https://api.viagogo.net/v2/addresses/34115"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:update": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:delete": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
You can GET the href of this link to retrieve the Address
resource where the tickets are located. This endpoint requires the read:user
scope.
Response
The Address resource.
sellerlisting:unpublish
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PATCH request on the href of this link to make a
SellerListing unavailable for purchase on the viagogo
marketplace. This endpoint requires the write:sellerlistings scope.
Parameters
| Name | Type | Required | Description |
published |
boolean |
No | False when the listing should be unpublished; Otherwise, true. |
Response
The updated SellerListing resource.
sellerlisting:updatefacevalue
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PATCH request on the href of this link to update the face value of
each ticket in a listing. This endpoint requires the write:sellerlistings
scope.
Parameters
| Name | Type | Required | Description |
face_value |
money |
No | The price printed on the ticket, not including any booking fees. |
Response
The updated SellerListing resource.
sellerlisting:updateinhandat
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PATCH request on the href of this link to update the date when the
tickets in the listing will be in hand. This endpoint requires the
write:sellerlistings scope.
Parameters
| Name | Type | Required | Description |
in_hand_at |
datetime |
No | The date when the ticket(s) in the listing will be in hand. |
Response
The updated SellerListing resource.
sellerlisting:updateticketlocation
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PATCH request on the href of this link to update the listing notes
for a SellerListing. This endpoint requires the
write:sellerlistings scope.
Parameters
| Name | Type | Required | Description |
listing_note_ids |
int[] |
No | The identifiers of the [ListingNote] resources for this listing. |
Response
The updated SellerListing resource.
sellerlisting:updatenumberoftickets
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PATCH request on the href of this link to update the number of
tickets available for purchase. This endpoint requires the
write:sellerlistings scope.
Parameters
| Name | Type | Required | Description |
number_of_tickets |
int |
No | The number of tickets available for purchase. |
display_number_of_tickets |
int |
No | The number of tickets that should be displayed to buyers as available for purchase. |
Response
The updated SellerListing resource.
sellerlisting:updatesplittype
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PATCH request on the href of this link to update the way that
tickets in the listing are allowed be split. This endpoint requires the
write:sellerlistings scope.
Parameters
| Name | Type | Required | Description |
split_type |
string |
No | The way that the ticket(s) are allowed to be split up when sold. Can be Any, None, AvoidOne, AvoidOneAndThree, or Pairs. |
Response
The updated SellerListing resource.
sellerlisting:updateticketlocation
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PATCH request on the href of this link to update the location
where the tickets are located. This endpoint requires the
write:sellerlistings scope.
Parameters
| Name | Type | Required | Description |
ticket_location_address_id |
int |
No | The identifier of the address where the ticket(s) are located. |
Response
The updated SellerListing resource.
sellerlisting:updateticketprice
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PATCH request on the href of this link to update the price of each
ticket in a listing. This endpoint requires the write:sellerlistings scope.
Parameters
| Name | Type | Required | Description |
ticket_price |
money |
No | The price of each ticket in the listing. |
Response
The updated SellerListing resource.
sellerlisting:updatetickettype
curl -X GET "https://api.viagogo.net/v2/sellerlistings/22096065"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PATCH request on the href of this link to update the type of
tickets in a listing. This endpoint requires the write:sellerlistings scope.
Parameters
| Name | Type | Required | Description |
ticket_type |
string |
No | The type of ticket(s) in this listing. Can be PaperTicket, ETicket, PaperTicketNameChange, TesseraDelTifoso, SeasonCard, PaperTicketNameChange, ETicketNameChange or ETicketThirdPartyPreUpload. |
Response
The updated SellerListing resource.
shipment:create
curl -X PUT "https://api.viagogo.net/v2/sales/1017322/shipments"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 1007247,
"tracking_number": "1ZX0565R0490161406",
"delivery_address": null,
"_links": {
"shipment:carrier": {
"href": "https://api.viagogo.net/v2/addresses/37073/carriers/2",
"title": null,
"templated": false
},
"shipment:label": {
"href": "https://api.viagogo.net/v2/sales/1017898/shipments/1007247/label",
"title": null,
"templated": false
}
},
"_embedded": {
"delivery_method": {
"id": 0,
"name": "UPS (Express Saver) - United Kingdom Domestic",
"type": "Pickup"
},
"pickup_addresses": [
{
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"address:carrier": {
"href": "https://api.viagogo.net/v2/addresses/34115/carriers/2",
"title": null,
"templated": false
}
},
"_embedded": null
}
],
"pickups": [
{
"id": 2109,
"start_date": "2015-09-24T09:00:00+00:00",
"end_date": "2015-09-24T17:00:00+00:00",
"address": {
"full_name": "Joe Smith",
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"country_code": "GB",
"country": "United Kingdom"
},
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/pickups/2109",
"title": null,
"templated": false
},
"pickup:delete": {
"href": "https://api.viagogo.net/v2/pickups/2109",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PUT request on the href of this link to create a shipping label
for the ticket(s) of a sale. This endpoint requires the write:user scope.
Response
The newly created Shipment.
shipment:label
You can GET the href of this link to download the courier shipping label. Once
you have downloaded the shipping label the courier will expect to receive your
package right away, so only download the label when your tickets are ready to be
shipped. This endpoint requires the read:user scope.
Response
The associated shipping label file for this sale. The response will have content-type “application/pdf”.
user:addresses
curl -X GET "https://api.viagogo.net/v2/addresses"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var addresses = await api.Addresses.GetAllAsync();
# TODO
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/addresses?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/addresses?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:update": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:delete": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
]
}
}
You can GET the href of this link to retrieve the Addresses
resource that contains the current user’s addresses. This endpoint requires the
read:user scope.
Response
Returns the Addresses resource that contains current user’s
addresses.
user:paymentmethods
curl -X GET "https://api.viagogo.net/v2/paymentmethods"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var paymentMethods = await api.PaymentMethods.GetAllAsync();
# TODO
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/paymentmethods?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/paymentmethods?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/paymentmethods?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 95698,
"details": "************1111",
"type": "CreditCard",
"type_description": "Credit or Debit Card",
"buyer_method": true,
"default_buyer_method": false,
"seller_method": false,
"default_seller_method": false,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatedefaults": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
},
"paymentmethod:updatecreditcard": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698?paymentMethodType=CreditCard",
"title": null,
"templated": false
},
"paymentmethod:delete": {
"href": "https://api.viagogo.net/v2/paymentmethods/95698",
"title": null,
"templated": false
}
},
"_embedded": {
"billing_address": {
"id": 34115,
"full_name": "Joe Smith",
"default": true,
"address_1": "Flat 16, Waterman's Quay",
"address_2": "33 William Morris Way",
"address_3": "Fulham",
"city": "London",
"state_province": "Greater London",
"postal_code": "SW6 2UU",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:update": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
},
"address:delete": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
]
}
}
You can GET the href of this link to retrieve the
PaymentMethods resource that contains the current user’s
payment methods. This endpoint requires the read:user scope.
Parameters
| Name Type | Description | |
type |
string |
Filters results to only include payment methods with the specified comma-separated list of types. See Payment Method Types. |
Response
Returns the PaymentMethods resource that contains current
user’s payment methods.
user:sales
curl -X GET "https://api.viagogo.net/v2/sales"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/sales?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/sales?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 1017322,
"created_at": "2015-09-21T16:02:39+00:00",
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"number_of_tickets": 2,
"status": "Confirm Sales",
"status_description": null,
"confirm_by": "2015-09-23T16:02:43+00:00",
"ship_by": null,
"payment_details": "************1111",
"payment_type": "CreditCard",
"payment_type_description": "Credit or Debit Card",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": null,
"templated": false
},
"sale:confirm": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": "Confirm",
"templated": false
},
"sale:reject": {
"href": "https://api.viagogo.net/v2/sales/1017322",
"title": "Report a problem",
"templated": false
},
"sale:listing": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
}
},
"_embedded": {
"delivery_method": {
"id": 0,
"name": "UPS (Express Saver) - United Kingdom Domestic",
"type": "Pickup"
},
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
]
}
}
You can GET the href of this link to retrieve the Sales resource
that contains the current user’s sales. This endpoint requires the read:user
scope.
Response
Returns the Sales resource that contains current user’s sales.
user:sellerlistings
curl -X GET "https://api.viagogo.net/v2/sellerlistings"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/sellerlistings?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/sellerlistings?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
]
}
}
You can GET the href of this link to retrieve the
SellerListings resource that contains the current user’s
listings. This endpoint requires the read:sellerlistings scope.
Response
Returns the SellerListings resource that contains current
user’s listings.
user:webhooks
curl -X GET "https://api.viagogo.net/v2/webhooks"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var webhooks = await api.Webhooks.GetAllAsync();
# TODO
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/webhooks?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/webhooks?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/webhooks?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 48,
"name": "My Webhook",
"created_at": "2015-10-19T13:21:32+00:00",
"topics": [
"Sales"
],
"url": "http://myapplication.com/payload",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/webhooks/48",
"title": null,
"templated": false
},
"webhook:delete": {
"href": "https://api.viagogo.net/v2/webhooks/48",
"title": null,
"templated": false
},
"webhook:ping": {
"href": "https://api.viagogo.net/v2/webhooks/48/ping",
"title": null,
"templated": false
},
"webhook:update": {
"href": "https://api.viagogo.net/v2/webhooks/48",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the Webhooks
resource that contains the current user’s webhooks. This endpoint requires the
read:webhooks scope.
Response
Returns the Webhooks resource that contains current user’s
webhooks.
venue:events
curl -X GET "https://api.viagogo.net/v2/categories/0/events?venue_id=1364"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var venue = await api.Venues.GetAsync(1364);
var events = await api.Hypermedia.GetAsync<PagedResource<Event>>(venue.EventsLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
venue = api.get_venue 1364
events = api.get venue.links['venue:events']
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/0/events?venue_id=1364?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/categories/0/events?venue_id=1364?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/categories/0/events?venue_id=1364?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"notes_html": "General Notes \n • All sales are final \n • Ticket prices are set by the seller and may be above or below face value \n • Event dates and times are subject to change, it is up to you to check local listings for updates \n • After your purchase, you will receive a confirmation email with your ticket delivery details and timing",
"restrictions_html": "Everyone <strong>under 15</strong> must be accompanied by an adult.",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
},
"event:listings": {
"href": "https://api.viagogo.net/v2/events/735139/listings",
"title": "View Tickets",
"templated": false
},
"event:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
},
"event:webpage": {
"href": "http://www.viagogo.com/E-735139",
"title": null,
"templated": false
},
"event:localwebpage": {
"href": "http://www.viagogo.co.uk/E-735139",
"title": null,
"templated": false
},
"event:listingconstraints": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
},
"event:createsellerlisting": {
"href": "https://api.viagogo.net/v2/events/735139/sellerlistings",
"title": "Sell Tickets",
"templated": false
}
},
"_embedded": {
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
}
}
]
}
}
You can GET the href of this link to retrieve the Events resource
that contains the events taking place in a particular venue.
Parameters
| Name Type | Description | |
sort |
string |
Determines the ordering of items. A comma-separated string containing id, name, min_start_date, min_ticket_price, or distance. |
embed |
string |
A comma-separated set of properties that should be embedded in the Event resources. Can be category. |
latitude |
float |
A user’s current latitude. |
longitude |
float |
A user’s current longitude. |
max_distance |
int |
Filters results to only include events located within the specfied number of meters from the user. |
min_start_date |
datetime |
Filters results to only include events starting after the specified datetime. |
max_start_date |
datetime |
Filters results to only include events starting before the specified datetime. |
max_ticket_price |
decimal |
Filters results to only include events with tickets available for less than the specified amount. NOTE: This price is assumed to be in the currency code specified in the Accept-Currency. |
time_frame |
string |
Filters results to only include events within a given timeframe. Can be one of Today, Tomorrow, ThisWeekend, ThisWeek, NextWeek, ThisMonth, NextMonth. |
days |
string |
Filters results to only include events that occur on any of the specified days. Can be a comma-separated string of the following values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. |
only_with_tickets |
boolean |
Filters results to only include events that have tickets. |
Response
Returns the Events resource containing the events taking place in a
particular venue.
venue:metroarea
curl -X GET "https://api.viagogo.net/v2/metroareas/65"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var venue = await api.Venues.GetAsync(1364);
var metroArea = await api.Hypermedia.GetAsync<MetroArea>(venue.MetroAreaLink);
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
venue = api.get_venue 1364
metro_area = api.get venue.links['venue:metroarea']
The above command returns an object structured like this:
{
"id": 65,
"name": "London",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/metroareas/65",
"title": null,
"templated": false
},
"metroarea:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?metro_area_id=65",
"title": null,
"templated": false
},
"metroarea:venues": {
"href": "https://api.viagogo.net/v2/venues?metro_area_id=65",
"title": null,
"templated": false
}
}
}
You can GET the href of this link to retrieve the MetroArea
resource that contains a venue.
Response
The MetroArea resource that contains a venue.
viagogo:countries
curl -X GET "https://api.viagogo.net/v2/countries"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var countries = await api.Countries.GetAllAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
countries = api.get_countries
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/countries?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/countries?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the Countries
resource that contains the available countries.
Parameters
| Name Type | Description | |
sort |
string |
Determines the ordering of items. A comma-separated string containing code, or name. |
Response
Returns the Countries resource that contains the available
countries.
viagogo:createsellerlisting
curl -X POST "https://api.viagogo.net/v2/sellerlistings"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
-d '{"external_id": "495293", "seating":{"section":"107","row":"A","seat_from":"1","seat_to":"2"},"ticket_price":{"amount":25.65,"currency_code":"USD"},"face_value":{"amount":22.62,"currency_code":"EUR"},"ticket_type":"ETicket","split_type":"Any","number_of_tickets":2,"event":{"name":"One Direction","start_date":"2015-09-24T18:30:00+01:00"},"venue":{"name":"The O2 arena","city":"London"},"country": {"code": "GB"}}'
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var listing = await api.SellerListings.CreateAsync(
new NewRequestedEventSellerListing
{
ExternalId = "495293",
NumberOfTickets = "2",
Seating = new Seating
{
Section = "107",
Row = "A",
SeatFrom = "1",
SeatTo = "4"
},
TicketPrice = new Money { Amount = 25.65, Currency = "USD" },
FaceValue = new Money { Amount = 22.62, Currency = "EUR" },
TicketType = "ETicket",
SplitType = "Any",
Event = new Event
{
Name = "One Direction",
StartDate = DateTimeOffset.Parse("2015-09-24T18:30:00+01:00")
},
Venue = new Venue
{
Name = "The O2 arena",
City = "London"
},
Country = new Country { Code = "GB" }
});
# TODO
The above command returns an object structured like this:
{
"id": 22096065,
"created_at": "2015-06-12T15:05:35+01:00",
"updated_at": "2015-06-13T08:37:20+00:00",
"external_id": "495293",
"number_of_tickets": 2,
"display_number_of_tickets": null,
"seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"display_seating": {
"section": "107",
"row": "A",
"seat_from": "1",
"seat_to": "4"
},
"face_value": {
"amount": 22.62,
"currency_code": "EUR",
"display": "€22.62"
},
"ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"ticket_proceeds": {
"amount": 22.58,
"currency_code": "USD",
"display": "$22.58"
},
"in_hand_at": "2015-06-20T08:00:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:constraints": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065/constraints",
"title": null,
"templated": false
},
"sellerlisting:delete": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": "Delete Listing",
"templated": false
},
"sellerlisting:updatetickettype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketprice": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatesplittype": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenumberoftickets": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateseating": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateticketlocation": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatenotes": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:unpublish": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updatefacevalue": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:updateinhandat": {
"href": "https://api.viagogo.net/v2/sellerlistings/22096065",
"title": null,
"templated": false
},
"sellerlisting:ticketlocation": {
"href": "https://api.viagogo.net/v2/addresses/34115",
"title": "Ticket Location Address",
"templated": false
}
},
"_embedded": {
"event": {
"id": 735139,
"name": "One Direction",
"start_date": "2015-09-24T18:30:00+01:00",
"end_date": null,
"on_sale_date": "2014-12-24T08:30:00+01:00",
"date_confirmed": true,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139",
"title": null,
"templated": false
}
}
},
"venue": {
"id": 1364,
"name": "The O2 arena",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
},
"ticket_type": {
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
},
"split_type": {
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
},
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a POST request on the href of this link to create a
SellerListing for an event. If the event information in your
request maps to an event already on the viagogo platform then the listing will be
created for that event. Otherwise, the listing will be created against your
“requested event” and it will automatically be mapped to an event on the viagogo
platform when your “requested event” is accepted. This endpoint requires the
write:sellerlistings and write:requestedevents scopes.
Parameters
| Name | Type | Required | Description |
event |
Event |
Yes | The name and start_date of the event this listing is for. |
venue |
Venue |
Yes | The name and city of the venue where the event is taking place. |
country |
Country |
Yes | The code of the country where the event is taking place. |
number_of_tickets |
int |
Yes | The number of tickets available for purchase. |
seating |
seating |
Yes | The seating information for the ticket(s) in this listing. |
ticket_price |
money |
Yes | The price of each ticket in the listing. |
ticket_type |
string |
Yes | The type of ticket(s) in this listing. Can be PaperTicket, ETicket, PaperTicketNameChange, TesseraDelTifoso, SeasonCard, PaperTicketNameChange, ETicketNameChange or ETicketThirdPartyPreUpload. |
split_type |
string |
Yes | The way that the ticket(s) are allowed to be split up when sold. Can be Any, None, AvoidOne, AvoidOneAndThree, or Pairs. |
external_id |
string |
No | An identifier that has been assigned to the listing in an external inventory management system |
guarantee_payment_method_id |
int |
No | The identifier of the credit card that should be used to guarantee your tickets. |
notes |
string |
No | A description of the features and/or restrictions of the tickets in the listing. |
face_value |
money |
No | The price printed on the ticket, not including any booking fees. |
display_number_of_tickets |
int |
No | The number of tickets that should be displayed to buyers as available for purchase. |
ticket_location_address_id |
int |
No | The identifier of the address where the ticket(s) are located. |
Response
Returns the SellerListing resource that is created. If the
event information in your request maps to an event on the viagogo platform, the
listing’s embedded event id will be an int. Otherwise, it
will be null.
viagogo:currencies
curl -X GET "https://api.viagogo.net/v2/currencies"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var currencies = await api.Currencies.GetAllAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
currencies = api.get_currencies
The above command returns an object structured like this:
{
"total_items": 100,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/currencies?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/currencies?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/currencies?page=100&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"code": "USD",
"name": "United States Dollar",
"symbol": "$",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/currencies/USD",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the Currencies
resource that contains the available currencies.
Parameters
| Name Type | Description | |
sort |
string |
Determines the ordering of items. A comma-separated string containing code, or name. |
Response
Returns the Currencies resource that contains the available
currencies.
viagogo:genres
curl -X GET "https://api.viagogo.net/v2/categories/0/children"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var genres = await api.Categories.GetAllGenresAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
genres = api.get_genres
The above command returns an object structured like this:
{
"total_items": 4,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/0/children?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/categories/0/children?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/categories/0/children?page=4&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 3,
"name": "Concert Tickets",
"description_html": "<p>Get your <b>Concert Tickets tickets</b> on viagogo, your online ticket marketplace. Choose an event to see the selection of tickets available or check the Concert Tickets tour on the map to locate the nearest event to you. You can also sell your spare tickets on viagogo, and listing tickets is free. All Concert Tickets tickets are covered by the viagogo Ticket Guarantee!</p>",
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"min_event_date": "2015-02-05T08:00:00+00:00",
"max_event_date": "2016-09-10T15:45:00+00:00",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/categories/3",
"title": null,
"templated": false
},
"category:parent": {
"href": "https://api.viagogo.net/v2/categories/0",
"title": null,
"templated": false
},
"category:children": {
"href": "https://api.viagogo.net/v2/categories/3/children",
"title": null,
"templated": false
},
"category:performers": {
"href": "https://api.viagogo.net/v2/categories/3/children?onlyLeafCategories=True",
"title": null,
"templated": false
},
"category:events": {
"href": "https://api.viagogo.net/v2/categories/3/events",
"title": null,
"templated": false
},
"category:image": {
"href": "http://cdn1.viagogo.net/img/cat/3/1/1.jpg",
"title": null,
"templated": false
},
"category:webpage": {
"href": "http://www.viagogo.com/Concert-Tickets",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the Categories
resource that contains the genre categories (e.g. “Sports”, “Concerts”).
Parameters
| Name Type | Description | |
sort |
string |
Determines the ordering of items. A comma-separated string containing id, name, min_event_date, max_event_date or min_ticket_price. |
embed |
string |
A comma-separated set of properties that should be embedded in the Category resources. Can be top_performers, top_children or top_events. |
min_start_date |
datetime |
Filters results to only include categories that have events starting after the specified datetime. |
max_start_date |
datetime |
Filters results to only include categories that have events starting before the specified datetime. |
max_ticket_price |
decimal |
Filters results to only include categories that have events with tickets available for less than the specified amount. NOTE: This price is assumed to be in the currency code specified in the Accept-Currency |
only_with_events |
boolean |
Filters results to only include categories with events. |
only_with_tickets |
boolean |
Filters results to only include categories with events that have tickets. |
Response
Returns the Categories resource that contains the genre
categories (e.g. “Sports”, “Concerts”).
viagogo:languages
curl -X GET "https://api.viagogo.net/v2/languages"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var languages = await api.Languages.GetAllAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
languages = api.get_languages
The above command returns an object structured like this:
{
"total_items": 32,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/languages?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/languages?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/languages?page=32&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"code": "en-us",
"name": "English (US)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/languages/en-us",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the Languages
resource that contains the available languages.
Parameters
| Name Type | Description | |
sort |
string |
Determines the ordering of items. A comma-separated string containing code, or name. |
Response
Returns the Languages resource that contains the available
languages.
viagogo:listingconstraints
curl -X PUT "https://api.viagogo.net/v2/listingconstraints"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
-d '{"event":{"name":"One Direction","start_date":"2015-09-24T18:30:00+01:00"},"venue":{"name":"The O2 arena","city":"London"},"country": {"code": "GB"}}'
// TODO
# TODO
The above command returns an object structured like this:
{
"min_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"max_ticket_price": {
"amount": 25.65,
"currency_code": "USD",
"display": "$25.65"
},
"min_number_of_tickets": 1,
"max_number_of_tickets": 99,
"ticket_location_required": true,
"seats_required": false,
"sections": [
{
"name": "General Admission",
"free_text_row": false,
"rows": [
]
}
],
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/events/735139/listingconstraints",
"title": null,
"templated": false
}
},
"_embedded": {
"ticket_types": [
{
"type": "ETicket",
"name": "Print at home / E-tickets (PDF)",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/tickettypes/ETicket",
"title": null,
"templated": false
}
}
}
],
"split_types": [
{
"type": "Any",
"name": "Any",
"description": "Allow the tickets to be split up in any way"
}
],
"listing_notes": [
{
"id": 11,
"note": "Includes VIP pass",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/listingnotes/11",
"title": null,
"templated": false
}
}
}
],
"currencies": [
{
"code": "USD",
"name": "United States Dollar",
"symbol": "$",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/currencies/USD",
"title": null,
"templated": false
}
}
}
]
}
}
You can use a PUT request on the href of this link to retrieve the
ListingConstraints for an event. This endpoint requires
the write:sellerlistings and write:requestedevents scopes.
Parameters
| Name | Type | Required | Description |
event |
Event |
Yes | The name and start_date of the event this listing is for. |
venue |
Venue |
Yes | The name and city of the venue where the event is taking place. |
country |
Country |
Yes | The code of the country where the event is taking place. |
Response
Returns the ListingConstraints resource for the
specified event.
viagogo:metroareas
curl -X GET "https://api.viagogo.net/v2/metroareas"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var metroAreas = await api.MetroAreas.GetAllAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
metro_areas = api.get_metro_areas
The above command returns an object structured like this:
{
"total_items": 464,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/metroareas?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/metroareas?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/metroareas?page=464&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 65,
"name": "London",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/metroareas/65",
"title": null,
"templated": false
},
"metroarea:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?metro_area_id=65",
"title": null,
"templated": false
},
"metroarea:venues": {
"href": "https://api.viagogo.net/v2/venues?metro_area_id=65",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to retrieve the MetroAreas
resource that contains the available metro areas.
Response
Returns the MetroAreas resource that contains the available
metro areas.
viagogo:search
curl -X GET "https://api.viagogo.net/v2/search"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var searchResults = await api.Search.GetAsync("One Dir")
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
search_results = api.search 'One Dir'
The above command returns an object structured like this:
{
"total_items": 40,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/search?query=One%20Dir&page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/search?query=One%20Dir&page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/search?query=One%20Dir&page=40&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"title": "One Direction",
"type": "Category",
"type_description": "Artist",
"_links": {
"searchresult:category": {
"href": "https://api.viagogo.net/v2/categories/20746",
"title": null,
"templated": false
}
}
}
]
}
}
You can GET the href of this link to search for entities that match a given
query.
Parameters
| Name Type | Description | |
query |
string |
The query text to be used to match entities. |
type |
string |
A comma-separated string of the different types of entities to return. Can be event, category, metro_area or venue. Note: If type is not specified then all types of entities will be returned. |
embed |
string |
A comma-separated string of the properties that should be embedded in each SearchResult resource. Can be event, category, metro_area, venue, or genre. |
Response
Returns the SearchResults resource containing the results of the query.
viagogo:user
curl -X GET "https://api.viagogo.net/v2/user"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var user = await api.User.GetAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
# TODO
The above command returns an object structured like this:
{
"full_name": "Joe Smith",
"email": "joe.smith@email.com",
"primary_phone": "+447654321098",
"email_optin": false,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/user",
"title": "Account Settings",
"templated": false
},
"user:update": {
"href": "https://api.viagogo.net/v2/user",
"title": null,
"templated": false
},
"user:addresses": {
"href": "https://api.viagogo.net/v2/addresses",
"title": "Addresses",
"templated": false
},
"user:paymentmethods": {
"href": "https://api.viagogo.net/v2/paymentmethods",
"title": "Payment Methods",
"templated": false
},
"user:purchases": {
"href": "https://api.viagogo.net/v2/purchases",
"title": "Purchases",
"templated": false
},
"user:sales": {
"href": "https://api.viagogo.net/v2/sales",
"title": "Sales",
"templated": false
},
"user:sellerlistings": {
"href": "https://api.viagogo.net/v2/sellerlistings",
"title": "Listings",
"templated": false
},
"user:webhooks": {
"href": "https://api.viagogo.net/v2/webhooks",
"title": "Webhooks",
"templated": false
}
}
}
You can GET the href of this link to retrieve the current authenticated user.
This endpoint requires the read:user scope.
Response
Returns the User resource for the currently authenticated user.
viagogo:venues
curl -X GET "https://api.viagogo.net/v2/venues"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
var venues = await api.Venues.GetAllAsync();
api = GogoKit::Client.new(client_id: CLIENT_ID,
client_secret: CLIENT_SECRET,
access_token: ACCESS_TOKEN)
venues = api.get_venues
The above command returns an object structured like this:
{
"total_items": 21727,
"page": 1,
"page_size": 1,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues?page=1&page_size=1",
"title": null,
"templated": false
},
"next": {
"href": "https://api.viagogo.net/v2/venues?page=2&page_size=1",
"title": null,
"templated": false
},
"last": {
"href": "https://api.viagogo.net/v2/venues?page=21727&page_size=1",
"title": null,
"templated": false
}
},
"_embedded": {
"items": [
{
"id": 1364,
"name": "The O2 arena",
"address_1": "Peninsula Square",
"address_2": "",
"state_province": "",
"postal_code": "SE10 0DX",
"city": "London",
"latitude": 51.5025,
"longitude": 0.0024,
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/venues/1364",
"title": null,
"templated": false
},
"venue:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?venue_id=1364",
"title": null,
"templated": false
},
"venue:metroarea": {
"href": "https://api.viagogo.net/v2/metroareas/65",
"title": null,
"templated": false
}
},
"_embedded": {
"country": {
"code": "GB",
"name": "United Kingdom",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/countries/GB",
"title": null,
"templated": false
},
"country:events": {
"href": "https://api.viagogo.net/v2/categories/0/events?country_code=GB",
"title": null,
"templated": false
}
}
}
}
}
]
}
}
You can GET the href of this link to retrieve the Venues resource
that contains the available venues.
Response
Returns the Venues resource that contains the available venues.
webhook:create
curl -X POST "https://api.viagogo.net/v2/webhooks"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 48,
"name": "My Webhook",
"created_at": "2015-10-19T13:21:32+00:00",
"topics": [
"Sales"
],
"url": "http://myapplication.com/payload",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/webhooks/48",
"title": null,
"templated": false
},
"webhook:delete": {
"href": "https://api.viagogo.net/v2/webhooks/48",
"title": null,
"templated": false
},
"webhook:ping": {
"href": "https://api.viagogo.net/v2/webhooks/48/ping",
"title": null,
"templated": false
},
"webhook:update": {
"href": "https://api.viagogo.net/v2/webhooks/48",
"title": null,
"templated": false
}
}
}
You can use a POST request on the href of this link to add a webhook to the
current user’s webhooks. This endpoint requires the write:webhooks scope.
Parameters
| Name | Type | Required | Description |
name |
string |
Yes | The name of the webhook |
url |
string |
Yes | The server endpoint that will receive the webhook payload |
topics |
string[] |
Yes | An array of the topics the webhook is trigger for |
Response
The newly created Webhook.
webhook:delete
curl -X DELETE "https://api.viagogo.net/v2/webhooks/48"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
await api.Webhooks.DeleteAsync(48);
# TODO
You can use a DELETE request on the href of this link to delete a webhook for
the current user. This endpoint requires the write:webhooks scope.
Response
No content (and 204 status code).
webhook:ping
curl -X POST "https://api.viagogo.net/v2/webhooks/48/ping"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
var api = new ViagogoClient("clientId",
"clientSecret",
new ProductHeaderValue("MyAwesomeApp"));
await api.Webhooks.PingAsync(48);
# TODO
You can use a POST request on the href of this link to trigger a Ping
payload to be sent to the URL of the webhook. This endpoint requires the
write:webhooks scope.
Response
A 202 Accepted response.
webhook:update
curl -X PATCH "https://api.viagogo.net/v2/webhooks/48"
-H "User-Agent: MyAwesomeApp"
-H "Authorization: Bearer pYXQiOjE0MjI1MzY0NjEsInNjb3BlIjo"
// TODO
# TODO
The above command returns an object structured like this:
{
"id": 48,
"name": "My Webhook",
"created_at": "2015-10-19T13:21:32+00:00",
"topics": [
"Sales"
],
"url": "http://myapplication.com/payload",
"_links": {
"self": {
"href": "https://api.viagogo.net/v2/webhooks/48",
"title": null,
"templated": false
},
"webhook:delete": {
"href": "https://api.viagogo.net/v2/webhooks/48",
"title": null,
"templated": false
},
"webhook:ping": {
"href": "https://api.viagogo.net/v2/webhooks/48/ping",
"title": null,
"templated": false
},
"webhook:update": {
"href": "https://api.viagogo.net/v2/webhooks/48",
"title": null,
"templated": false
}
}
}
You can use a PATCH request on the href of this link to update one of the
current user’s webhooks. This endpoint requires the write:webhooks scope.
Parameters
| Name | Type | Required | Description |
name |
string |
No | The name of the webhook |
url |
string |
No | The server endpoint that will receive the webhook payload |
topics |
string[] |
Yes | An array of the topics the webhook is trigger for |
Response
The updated Webhook.