Skip to main content
logo
Documentation Powered by ReDoc

viagogo Inventory API (2.249.0.0)

SellerListings

List tickets, update your listings and search your inventory.

Update a seller listing

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
listingId
required
integer <int64>
Request Body schema: application/json
One of
(Money (object or null))

The price of each ticket in the listing.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

(SeatingRequest (object or null))

The seating information for the ticket(s) in this listing. For PATCH Requests, you need to pass in all the fields of a Seating to update, even when you only need to update some of the fields. Otherwise the rest of the fields will be set to empty.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

ticket_type
string or null

The type of ticket(s) in this listing.

split_type
string or null

The way that the ticket(s) are allowed to be split up when sold.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

ticket_location_address_id
integer or null <int32>

The identifier of the address where the ticket(s) are located.

listing_note_ids
Array of integers or null <int32>

An array of listing note identifiers that provides additional notes on the listing

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

notes
string or null

A comma-separated string of additional notes about the listing

instant_delivery
boolean or null
published
boolean or null

True when the listing should be published; Otherwise, false.

lms_optin
boolean or null

True when the listing should be opted into Last Minute Sales; Otherwise, false.

eticket_ids
Array of integers or null <int32>

A array of the identifiers of the E-Tickets to be assigned to the listing.

Array of objects or null (SellerListingExternalEventInformation)

Information about the listing's event on other platforms.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

Array of objects or null (BarcodeInformation2)

Barcode(s) for the ticket(s) in this listing.

Responses

Response Schema: application/hal+json
id
integer or null <int64>

The listing identifier.

created_at
string or null <date-time>

The date when the listing was created.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

(SeatingDetail (object or null))

The seating information for the ticket(s) in this listing.

(SeatingDetail (object or null))

The seating information that will be displayed to buyers for the ticket(s) in this listing.

(Money (object or null))

The price of each ticket in the listing.

updated_at
string or null <date-time>

The date when the listing was last updated.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

expires_at
string or null <date-time>

The date when the listing will be automatically unpublished from the marketplace.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

is_ticket_concierge
boolean

Whether the listing represents a shorted ticket

is_auto_po
boolean

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation)

Barcode(s) for the ticket(s) in this listing.

instant_delivery
boolean or null
undeliverable
boolean or null

Shipment of the ticket to the buyer cannot be guaranteed before the event. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

(SellerListingLinks (object or null))
(SellerListingEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "ticket_price": {
    },
  • "ticket_proceeds": {
    },
  • "seating": {
    },
  • "face_value": {
    },
  • "ticket_type": "string",
  • "split_type": "string",
  • "number_of_tickets": 0,
  • "display_number_of_tickets": 0,
  • "ticket_location_address_id": 0,
  • "listing_note_ids": [
    ],
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "notes": "string",
  • "instant_delivery": true,
  • "published": true,
  • "lms_optin": true,
  • "eticket_ids": [
    ],
  • "external_event_information": [
    ],
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "barcodes": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "number_of_tickets": 0,
  • "seating": {
    },
  • "display_seating": {
    },
  • "ticket_price": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "display_number_of_tickets": 0,
  • "face_value": {
    },
  • "ticket_proceeds": {
    },
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "instant_delivery": true,
  • "undeliverable": true,
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

Get a seller listing

Authorizations:
OAuth2 (read:sellerlistings)
path Parameters
listingId
required
integer <int64>

Responses

Response Schema: application/hal+json
id
integer or null <int64>

The listing identifier.

created_at
string or null <date-time>

The date when the listing was created.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

(SeatingDetail (object or null))

The seating information for the ticket(s) in this listing.

(SeatingDetail (object or null))

The seating information that will be displayed to buyers for the ticket(s) in this listing.

(Money (object or null))

The price of each ticket in the listing.

updated_at
string or null <date-time>

The date when the listing was last updated.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

expires_at
string or null <date-time>

The date when the listing will be automatically unpublished from the marketplace.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

is_ticket_concierge
boolean

Whether the listing represents a shorted ticket

is_auto_po
boolean

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation)

Barcode(s) for the ticket(s) in this listing.

instant_delivery
boolean or null
undeliverable
boolean or null

Shipment of the ticket to the buyer cannot be guaranteed before the event. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

(SellerListingLinks (object or null))
(SellerListingEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "number_of_tickets": 0,
  • "seating": {
    },
  • "display_seating": {
    },
  • "ticket_price": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "display_number_of_tickets": 0,
  • "face_value": {
    },
  • "ticket_proceeds": {
    },
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "instant_delivery": true,
  • "undeliverable": true,
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

Delete a seller listing

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
listingId
required
integer <int64>

Responses

Response samples

Content type
application/hal+json
{
  • "code": "string",
  • "message": "string",
  • "errors": {
    }
}

List seller listings (recent updates)

List seller listings for the authenticated user that have been created or updated over a certain period of time.

Authorizations:
OAuth2 (read:sellerlistings)
query Parameters
updated_since
string <date-time>

Filters the response to only return items that have been updated since the given timestamp

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(SellerListingsLinks (object or null))
(SellerListingsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

List seller listings

List seller listings for the authenticated user.

Authorizations:
OAuth2 (read:sellerlistings)
query Parameters
event_id
integer or null <int32>
requested_event_id
string or null <guid>
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

updated_since
string <date-time>

Filters the response to only return items that have been updated since the given timestamp

sort
string

Determines the ordering of items. A comma-separated string containing available_tickets, created_at, event_date, event_name, expiration_date, price, resource_version, orticket_availability_date.

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(SellerListingsLinks (object or null))
(SellerListingsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Create a seller listing for a requested event

Creates a seller listing for an event requested by the current user.

Authorizations:
OAuth2 (write:sellerlistingswrite:requestedevents)
Request Body schema: application/json
One of
(Money (object or null))

The price of each ticket in the listing.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

required
(SeatingRequest (object or null))

The seating information for the ticket(s) in this listing. For PATCH Requests, you need to pass in all the fields of a Seating to update, even when you only need to update some of the fields. Otherwise the rest of the fields will be set to empty.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

ticket_type
required
string or null

The type of ticket(s) in this listing.

split_type
required
string or null

The way that the ticket(s) are allowed to be split up when sold.

number_of_tickets
required
integer or null <int32>

The number of tickets available for purchase.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

ticket_location_address_id
integer or null <int32>

The identifier of the address where the ticket(s) are located.

listing_note_ids
Array of integers or null <int32>

An array of listing note identifiers that provides additional notes on the listing

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

notes
string or null

A comma-separated string of additional notes about the listing

instant_delivery
boolean or null
published
boolean or null

True when the listing should be published; Otherwise, false.

lms_optin
boolean or null

True when the listing should be opted into Last Minute Sales; Otherwise, false.

eticket_ids
Array of integers or null <int32>

A array of the identifiers of the E-Tickets to be assigned to the listing.

relist_transaction_id
integer or null <int32>

Used when relisting tickets previously purchased on Stubhub marketplace. Include the transaction ID in the id value field.

Array of objects or null (SellerListingExternalEventInformation)

Information about the listing's event on other platforms.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

is_ticket_concierge
boolean or null

Whether the listing represents a shorted ticket

is_auto_po
boolean or null

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation2)

Barcode(s) for the ticket(s) in this listing.

(EventRequest (object or null))

The event information.

(VenueRequest (object or null))

The venue where the event will take place.

(CountryRequest (object or null))

The country where the event will take place.

Responses

Response Schema: application/hal+json
id
integer or null <int64>

The listing identifier.

created_at
string or null <date-time>

The date when the listing was created.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

(SeatingDetail (object or null))

The seating information for the ticket(s) in this listing.

(SeatingDetail (object or null))

The seating information that will be displayed to buyers for the ticket(s) in this listing.

(Money (object or null))

The price of each ticket in the listing.

updated_at
string or null <date-time>

The date when the listing was last updated.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

expires_at
string or null <date-time>

The date when the listing will be automatically unpublished from the marketplace.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

is_ticket_concierge
boolean

Whether the listing represents a shorted ticket

is_auto_po
boolean

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation)

Barcode(s) for the ticket(s) in this listing.

instant_delivery
boolean or null
undeliverable
boolean or null

Shipment of the ticket to the buyer cannot be guaranteed before the event. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

(SellerListingLinks (object or null))
(SellerListingEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "ticket_price": {
    },
  • "ticket_proceeds": {
    },
  • "seating": {
    },
  • "face_value": {
    },
  • "ticket_type": "string",
  • "split_type": "string",
  • "number_of_tickets": 0,
  • "display_number_of_tickets": 0,
  • "ticket_location_address_id": 0,
  • "listing_note_ids": [
    ],
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "notes": "string",
  • "instant_delivery": true,
  • "published": true,
  • "lms_optin": true,
  • "eticket_ids": [
    ],
  • "relist_transaction_id": 0,
  • "external_event_information": [
    ],
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "event": {
    },
  • "venue": {
    },
  • "country": {
    }
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "number_of_tickets": 0,
  • "seating": {
    },
  • "display_seating": {
    },
  • "ticket_price": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "display_number_of_tickets": 0,
  • "face_value": {
    },
  • "ticket_proceeds": {
    },
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "instant_delivery": true,
  • "undeliverable": true,
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

Create a seller listing

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
eventId
required
integer <int32>
Request Body schema: application/json
One of
(Money (object or null))

The price of each ticket in the listing.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

required
(SeatingRequest (object or null))

The seating information for the ticket(s) in this listing. For PATCH Requests, you need to pass in all the fields of a Seating to update, even when you only need to update some of the fields. Otherwise the rest of the fields will be set to empty.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

ticket_type
required
string or null

The type of ticket(s) in this listing.

split_type
required
string or null

The way that the ticket(s) are allowed to be split up when sold.

number_of_tickets
required
integer or null <int32>

The number of tickets available for purchase.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

ticket_location_address_id
integer or null <int32>

The identifier of the address where the ticket(s) are located.

listing_note_ids
Array of integers or null <int32>

An array of listing note identifiers that provides additional notes on the listing

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

notes
string or null

A comma-separated string of additional notes about the listing

instant_delivery
boolean or null
published
boolean or null

True when the listing should be published; Otherwise, false.

lms_optin
boolean or null

True when the listing should be opted into Last Minute Sales; Otherwise, false.

eticket_ids
Array of integers or null <int32>

A array of the identifiers of the E-Tickets to be assigned to the listing.

relist_transaction_id
integer or null <int32>

Used when relisting tickets previously purchased on Stubhub marketplace. Include the transaction ID in the id value field.

Array of objects or null (SellerListingExternalEventInformation)

Information about the listing's event on other platforms.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

is_ticket_concierge
boolean or null

Whether the listing represents a shorted ticket

is_auto_po
boolean or null

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation2)

Barcode(s) for the ticket(s) in this listing.

Responses

Response Schema: application/hal+json
id
integer or null <int64>

The listing identifier.

created_at
string or null <date-time>

The date when the listing was created.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

(SeatingDetail (object or null))

The seating information for the ticket(s) in this listing.

(SeatingDetail (object or null))

The seating information that will be displayed to buyers for the ticket(s) in this listing.

(Money (object or null))

The price of each ticket in the listing.

updated_at
string or null <date-time>

The date when the listing was last updated.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

expires_at
string or null <date-time>

The date when the listing will be automatically unpublished from the marketplace.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

is_ticket_concierge
boolean

Whether the listing represents a shorted ticket

is_auto_po
boolean

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation)

Barcode(s) for the ticket(s) in this listing.

instant_delivery
boolean or null
undeliverable
boolean or null

Shipment of the ticket to the buyer cannot be guaranteed before the event. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

(SellerListingLinks (object or null))
(SellerListingEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "ticket_price": {
    },
  • "ticket_proceeds": {
    },
  • "seating": {
    },
  • "face_value": {
    },
  • "ticket_type": "string",
  • "split_type": "string",
  • "number_of_tickets": 0,
  • "display_number_of_tickets": 0,
  • "ticket_location_address_id": 0,
  • "listing_note_ids": [
    ],
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "notes": "string",
  • "instant_delivery": true,
  • "published": true,
  • "lms_optin": true,
  • "eticket_ids": [
    ],
  • "relist_transaction_id": 0,
  • "external_event_information": [
    ],
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "number_of_tickets": 0,
  • "seating": {
    },
  • "display_seating": {
    },
  • "ticket_price": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "display_number_of_tickets": 0,
  • "face_value": {
    },
  • "ticket_proceeds": {
    },
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "instant_delivery": true,
  • "undeliverable": true,
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

SellerListings (External Id)

Manage your inventory using identifiers from an external inventory management system.

Get a seller listing by external ID

Get a seller listing by identifier that has been assigned to the listing in an external inventory management system.

Authorizations:
OAuth2 (read:sellerlistings)
path Parameters
externallistingId
required
string or null

Responses

Response Schema: application/hal+json
id
integer or null <int64>

The listing identifier.

created_at
string or null <date-time>

The date when the listing was created.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

(SeatingDetail (object or null))

The seating information for the ticket(s) in this listing.

(SeatingDetail (object or null))

The seating information that will be displayed to buyers for the ticket(s) in this listing.

(Money (object or null))

The price of each ticket in the listing.

updated_at
string or null <date-time>

The date when the listing was last updated.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

expires_at
string or null <date-time>

The date when the listing will be automatically unpublished from the marketplace.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

is_ticket_concierge
boolean

Whether the listing represents a shorted ticket

is_auto_po
boolean

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation)

Barcode(s) for the ticket(s) in this listing.

instant_delivery
boolean or null
undeliverable
boolean or null

Shipment of the ticket to the buyer cannot be guaranteed before the event. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

(SellerListingLinks (object or null))
(SellerListingEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "number_of_tickets": 0,
  • "seating": {
    },
  • "display_seating": {
    },
  • "ticket_price": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "display_number_of_tickets": 0,
  • "face_value": {
    },
  • "ticket_proceeds": {
    },
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "instant_delivery": true,
  • "undeliverable": true,
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

Update a seller listing by external ID

Update a seller listing by identifier that has been assigned to the listing in an external inventory management system.

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
externalId
required
string or null
Request Body schema: application/json
One of
(Money (object or null))

The price of each ticket in the listing.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

(SeatingRequest (object or null))

The seating information for the ticket(s) in this listing. For PATCH Requests, you need to pass in all the fields of a Seating to update, even when you only need to update some of the fields. Otherwise the rest of the fields will be set to empty.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

ticket_type
string or null

The type of ticket(s) in this listing.

split_type
string or null

The way that the ticket(s) are allowed to be split up when sold.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

ticket_location_address_id
integer or null <int32>

The identifier of the address where the ticket(s) are located.

listing_note_ids
Array of integers or null <int32>

An array of listing note identifiers that provides additional notes on the listing

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

notes
string or null

A comma-separated string of additional notes about the listing

instant_delivery
boolean or null
published
boolean or null

True when the listing should be published; Otherwise, false.

lms_optin
boolean or null

True when the listing should be opted into Last Minute Sales; Otherwise, false.

eticket_ids
Array of integers or null <int32>

A array of the identifiers of the E-Tickets to be assigned to the listing.

Array of objects or null (SellerListingExternalEventInformation)

Information about the listing's event on other platforms.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

Array of objects or null (BarcodeInformation2)

Barcode(s) for the ticket(s) in this listing.

Responses

Response Schema: application/hal+json
id
integer or null <int64>

The listing identifier.

created_at
string or null <date-time>

The date when the listing was created.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

(SeatingDetail (object or null))

The seating information for the ticket(s) in this listing.

(SeatingDetail (object or null))

The seating information that will be displayed to buyers for the ticket(s) in this listing.

(Money (object or null))

The price of each ticket in the listing.

updated_at
string or null <date-time>

The date when the listing was last updated.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

expires_at
string or null <date-time>

The date when the listing will be automatically unpublished from the marketplace.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

is_ticket_concierge
boolean

Whether the listing represents a shorted ticket

is_auto_po
boolean

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation)

Barcode(s) for the ticket(s) in this listing.

instant_delivery
boolean or null
undeliverable
boolean or null

Shipment of the ticket to the buyer cannot be guaranteed before the event. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

(SellerListingLinks (object or null))
(SellerListingEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "ticket_price": {
    },
  • "ticket_proceeds": {
    },
  • "seating": {
    },
  • "face_value": {
    },
  • "ticket_type": "string",
  • "split_type": "string",
  • "number_of_tickets": 0,
  • "display_number_of_tickets": 0,
  • "ticket_location_address_id": 0,
  • "listing_note_ids": [
    ],
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "notes": "string",
  • "instant_delivery": true,
  • "published": true,
  • "lms_optin": true,
  • "eticket_ids": [
    ],
  • "external_event_information": [
    ],
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "barcodes": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "number_of_tickets": 0,
  • "seating": {
    },
  • "display_seating": {
    },
  • "ticket_price": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "display_number_of_tickets": 0,
  • "face_value": {
    },
  • "ticket_proceeds": {
    },
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "instant_delivery": true,
  • "undeliverable": true,
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

Delete a seller listing by external ID

Delete a seller listing by identifier that has been assigned to the listing in an external inventory management system.

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
externalId
required
string or null

Responses

Response samples

Content type
application/hal+json
{
  • "code": "string",
  • "message": "string",
  • "errors": {
    }
}

SellerListings (Preview)

Preview the changes you want to make to your inventory.

Preview a seller listing

Creates a preview of a seller listing. The listing will not have an id and will not actually be created on the viagogo marketplace.

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
eventId
required
integer <int32>
Request Body schema: application/json
One of
(Money (object or null))

The price of each ticket in the listing.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

required
(SeatingRequest (object or null))

The seating information for the ticket(s) in this listing. For PATCH Requests, you need to pass in all the fields of a Seating to update, even when you only need to update some of the fields. Otherwise the rest of the fields will be set to empty.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

ticket_type
required
string or null

The type of ticket(s) in this listing.

split_type
required
string or null

The way that the ticket(s) are allowed to be split up when sold.

number_of_tickets
required
integer or null <int32>

The number of tickets available for purchase.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

ticket_location_address_id
integer or null <int32>

The identifier of the address where the ticket(s) are located.

listing_note_ids
Array of integers or null <int32>

An array of listing note identifiers that provides additional notes on the listing

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

notes
string or null

A comma-separated string of additional notes about the listing

instant_delivery
boolean or null
published
boolean or null

True when the listing should be published; Otherwise, false.

lms_optin
boolean or null

True when the listing should be opted into Last Minute Sales; Otherwise, false.

eticket_ids
Array of integers or null <int32>

A array of the identifiers of the E-Tickets to be assigned to the listing.

Array of objects or null (SellerListingExternalEventInformation)

Information about the listing's event on other platforms.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

Array of objects or null (BarcodeInformation2)

Barcode(s) for the ticket(s) in this listing.

Responses

Response Schema: application/hal+json
id
integer or null <int64>

The listing identifier.

created_at
string or null <date-time>

The date when the listing was created.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

(SeatingDetail (object or null))

The seating information for the ticket(s) in this listing.

(SeatingDetail (object or null))

The seating information that will be displayed to buyers for the ticket(s) in this listing.

(Money (object or null))

The price of each ticket in the listing.

updated_at
string or null <date-time>

The date when the listing was last updated.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

expires_at
string or null <date-time>

The date when the listing will be automatically unpublished from the marketplace.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

is_ticket_concierge
boolean

Whether the listing represents a shorted ticket

is_auto_po
boolean

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation)

Barcode(s) for the ticket(s) in this listing.

instant_delivery
boolean or null
undeliverable
boolean or null

Shipment of the ticket to the buyer cannot be guaranteed before the event. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

(SellerListingLinks (object or null))
(SellerListingEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "ticket_price": {
    },
  • "ticket_proceeds": {
    },
  • "seating": {
    },
  • "face_value": {
    },
  • "ticket_type": "string",
  • "split_type": "string",
  • "number_of_tickets": 0,
  • "display_number_of_tickets": 0,
  • "ticket_location_address_id": 0,
  • "listing_note_ids": [
    ],
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "notes": "string",
  • "instant_delivery": true,
  • "published": true,
  • "lms_optin": true,
  • "eticket_ids": [
    ],
  • "external_event_information": [
    ],
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "barcodes": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "number_of_tickets": 0,
  • "seating": {
    },
  • "display_seating": {
    },
  • "ticket_price": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "display_number_of_tickets": 0,
  • "face_value": {
    },
  • "ticket_proceeds": {
    },
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "instant_delivery": true,
  • "undeliverable": true,
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

Preview a seller listing update

Creates a preview of an update to a seller listing. The updates will not actually be applied to the listing on the viagogo marketplace.

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
listingId
required
integer <int64>
Request Body schema: application/json
One of
(Money (object or null))

The price of each ticket in the listing.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

required
(SeatingRequest (object or null))

The seating information for the ticket(s) in this listing. For PATCH Requests, you need to pass in all the fields of a Seating to update, even when you only need to update some of the fields. Otherwise the rest of the fields will be set to empty.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

ticket_type
required
string or null

The type of ticket(s) in this listing.

split_type
required
string or null

The way that the ticket(s) are allowed to be split up when sold.

number_of_tickets
required
integer or null <int32>

The number of tickets available for purchase.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

ticket_location_address_id
integer or null <int32>

The identifier of the address where the ticket(s) are located.

listing_note_ids
Array of integers or null <int32>

An array of listing note identifiers that provides additional notes on the listing

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

notes
string or null

A comma-separated string of additional notes about the listing

instant_delivery
boolean or null
published
boolean or null

True when the listing should be published; Otherwise, false.

lms_optin
boolean or null

True when the listing should be opted into Last Minute Sales; Otherwise, false.

eticket_ids
Array of integers or null <int32>

A array of the identifiers of the E-Tickets to be assigned to the listing.

Array of objects or null (SellerListingExternalEventInformation)

Information about the listing's event on other platforms.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

Array of objects or null (BarcodeInformation2)

Barcode(s) for the ticket(s) in this listing.

Responses

Response Schema: application/hal+json
id
integer or null <int64>

The listing identifier.

created_at
string or null <date-time>

The date when the listing was created.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

(SeatingDetail (object or null))

The seating information for the ticket(s) in this listing.

(SeatingDetail (object or null))

The seating information that will be displayed to buyers for the ticket(s) in this listing.

(Money (object or null))

The price of each ticket in the listing.

updated_at
string or null <date-time>

The date when the listing was last updated.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

expires_at
string or null <date-time>

The date when the listing will be automatically unpublished from the marketplace.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

is_ticket_concierge
boolean

Whether the listing represents a shorted ticket

is_auto_po
boolean

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation)

Barcode(s) for the ticket(s) in this listing.

instant_delivery
boolean or null
undeliverable
boolean or null

Shipment of the ticket to the buyer cannot be guaranteed before the event. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

(SellerListingLinks (object or null))
(SellerListingEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "ticket_price": {
    },
  • "ticket_proceeds": {
    },
  • "seating": {
    },
  • "face_value": {
    },
  • "ticket_type": "string",
  • "split_type": "string",
  • "number_of_tickets": 0,
  • "display_number_of_tickets": 0,
  • "ticket_location_address_id": 0,
  • "listing_note_ids": [
    ],
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "notes": "string",
  • "instant_delivery": true,
  • "published": true,
  • "lms_optin": true,
  • "eticket_ids": [
    ],
  • "external_event_information": [
    ],
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "barcodes": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "number_of_tickets": 0,
  • "seating": {
    },
  • "display_seating": {
    },
  • "ticket_price": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "display_number_of_tickets": 0,
  • "face_value": {
    },
  • "ticket_proceeds": {
    },
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "instant_delivery": true,
  • "undeliverable": true,
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

Preview a seller listing for a requested event

Creates a preview of a seller listing for an event requested by the current user. The listing will not have an id and will not actually be created on the viagogo marketplace.

Authorizations:
OAuth2 (write:sellerlistingswrite:requestedevents)
Request Body schema: application/json
One of
(EventRequest (object or null))

The event information.

(VenueRequest (object or null))

The venue where the event will take place.

(CountryRequest (object or null))

The country where the event will take place.

(Money (object or null))

The price of each ticket in the listing.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

required
(SeatingRequest (object or null))

The seating information for the ticket(s) in this listing. For PATCH Requests, you need to pass in all the fields of a Seating to update, even when you only need to update some of the fields. Otherwise the rest of the fields will be set to empty.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

ticket_type
required
string or null

The type of ticket(s) in this listing.

split_type
required
string or null

The way that the ticket(s) are allowed to be split up when sold.

number_of_tickets
required
integer or null <int32>

The number of tickets available for purchase.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

ticket_location_address_id
integer or null <int32>

The identifier of the address where the ticket(s) are located.

listing_note_ids
Array of integers or null <int32>

An array of listing note identifiers that provides additional notes on the listing

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

notes
string or null

A comma-separated string of additional notes about the listing

instant_delivery
boolean or null
published
boolean or null

True when the listing should be published; Otherwise, false.

lms_optin
boolean or null

True when the listing should be opted into Last Minute Sales; Otherwise, false.

eticket_ids
Array of integers or null <int32>

A array of the identifiers of the E-Tickets to be assigned to the listing.

relist_transaction_id
integer or null <int32>

Used when relisting tickets previously purchased on Stubhub marketplace. Include the transaction ID in the id value field.

Array of objects or null (SellerListingExternalEventInformation)

Information about the listing's event on other platforms.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

is_ticket_concierge
boolean or null

Whether the listing represents a shorted ticket

is_auto_po
boolean or null

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation2)

Barcode(s) for the ticket(s) in this listing.

Responses

Response Schema: application/hal+json
id
integer or null <int64>

The listing identifier.

created_at
string or null <date-time>

The date when the listing was created.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

(SeatingDetail (object or null))

The seating information for the ticket(s) in this listing.

(SeatingDetail (object or null))

The seating information that will be displayed to buyers for the ticket(s) in this listing.

(Money (object or null))

The price of each ticket in the listing.

updated_at
string or null <date-time>

The date when the listing was last updated.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

expires_at
string or null <date-time>

The date when the listing will be automatically unpublished from the marketplace.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

is_ticket_concierge
boolean

Whether the listing represents a shorted ticket

is_auto_po
boolean

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation)

Barcode(s) for the ticket(s) in this listing.

instant_delivery
boolean or null
undeliverable
boolean or null

Shipment of the ticket to the buyer cannot be guaranteed before the event. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

(SellerListingLinks (object or null))
(SellerListingEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "event": {
    },
  • "venue": {
    },
  • "country": {
    },
  • "ticket_price": {
    },
  • "ticket_proceeds": {
    },
  • "seating": {
    },
  • "face_value": {
    },
  • "ticket_type": "string",
  • "split_type": "string",
  • "number_of_tickets": 0,
  • "display_number_of_tickets": 0,
  • "ticket_location_address_id": 0,
  • "listing_note_ids": [
    ],
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "notes": "string",
  • "instant_delivery": true,
  • "published": true,
  • "lms_optin": true,
  • "eticket_ids": [
    ],
  • "relist_transaction_id": 0,
  • "external_event_information": [
    ],
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "number_of_tickets": 0,
  • "seating": {
    },
  • "display_seating": {
    },
  • "ticket_price": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "display_number_of_tickets": 0,
  • "face_value": {
    },
  • "ticket_proceeds": {
    },
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "instant_delivery": true,
  • "undeliverable": true,
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

E-Tickets

Upload e-tickets for a seller listing

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
listingId
required
integer <int64>
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(ETicketUploadsLinks (object or null))
(ETicketUploadsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

List e-ticket uploads for a seller listing

Authorizations:
OAuth2 (read:sellerlistings)
path Parameters
listingId
required
integer <int64>
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(ETicketUploadsLinks (object or null))
(ETicketUploadsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Upload e-tickets for an event

Authorizations:
OAuth2 (write:user)
path Parameters
eventId
required
integer <int32>
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(ETicketUploadsLinks (object or null))
(ETicketUploadsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

List e-ticket uploads for an event

Authorizations:
OAuth2 (read:user)
path Parameters
eventId
required
integer <int32>

Responses

Response Schema: application/hal+json
id
integer <int32>

The identifier of the upload.

file_name
string or null

The name of the file that was uploaded.

processed_at
string <date-time>

The date when all of the E-Tickets in the uploaded file were processed.

original_number_of_etickets
integer <int32>

The original number of E-Tickets contained in the uploaded file.

status_description
string or null

A localised in-depth description of the current status of the upload.

(ETicketUploadLinks (object or null))
(ETicketUploadEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "file_name": "string",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "original_number_of_etickets": 0,
  • "status_description": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

List e-tickets for a seller listing

Authorizations:
OAuth2 (read:sellerlistings)
path Parameters
listingId
required
integer <int64>
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(ETicketsLinks (object or null))
(ETicketsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Mark-back e-tickets from a seller listing

Removes a certain number of e-tickets that you no longer wish to sell from your listing.

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
listingId
required
integer <int64>
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

Request Body schema: application/json
One of
quantity
integer <int32>

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(ETicketsLinks (object or null))
(ETicketsEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "quantity": 0
}

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Upload and save e-tickets for a seller listing

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
listingId
required
integer <int64>
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(ETicketsLinks (object or null))
(ETicketsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Delete e-ticket from a seller listing

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
listingId
required
integer <int64>
eticketId
required
integer <int32>

Responses

Response samples

Content type
application/hal+json
{
  • "code": "string",
  • "message": "string",
  • "errors": {
    }
}

Delete e-ticket from an event

Authorizations:
OAuth2 (write:user)
path Parameters
eventId
required
integer <int32>
eticketId
required
integer <int32>

Responses

Response samples

Content type
application/hal+json
{
  • "code": "string",
  • "message": "string",
  • "errors": {
    }
}

Get marked back e-ticket file for seller listing

Authorizations:
OAuth2 (read:sellerlistings)
path Parameters
listingId
required
integer <int64>
markedBackETicketId
required
integer <int32>

Responses

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/hal+json
{
  • "code": "string",
  • "message": "string",
  • "errors": {
    }
}

ListingConstraints

List listing constraints for an event

Authorizations:
OAuth2 (read:salesread:sellerlistingsread:userwrite:requestedeventswrite:saleswrite:sellerlistingswrite:user)
path Parameters
eventId
required
integer <int32>

Responses

Response Schema: application/hal+json
(Money (object or null))
(Money (object or null))
min_number_of_tickets
integer or null <int32>

The minimum number of tickets available for purchase.

max_number_of_tickets
integer or null <int32>

The maximum number of tickets available for purchase.

ticket_location_required
boolean or null

True if a ticket location is required for tickets; Otherwise, false.

seats_required
boolean or null

True if seat-level information (seat_to and seat_from) is required; Otherwise, false.

Array of objects or null (Section)

The valid section and row information. If no sections are specified then any text will be accepted for section and row.

primary_order_id_required
boolean or null
home_or_away_required
boolean or null
(ListingConstraintsLinks (object or null))
(ListingConstraintsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "min_ticket_price": {
    },
  • "max_ticket_price": {
    },
  • "min_number_of_tickets": 0,
  • "max_number_of_tickets": 0,
  • "ticket_location_required": true,
  • "seats_required": true,
  • "sections": [
    ],
  • "primary_order_id_required": true,
  • "home_or_away_required": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

Get listing constraints for a seller listing

Authorizations:
OAuth2 (write:sellerlistings)
path Parameters
listingId
required
integer <int64>

Responses

Response Schema: application/hal+json
(Money (object or null))
(Money (object or null))
min_number_of_tickets
integer or null <int32>

The minimum number of tickets available for purchase.

max_number_of_tickets
integer or null <int32>

The maximum number of tickets available for purchase.

ticket_location_required
boolean or null

True if a ticket location is required for tickets; Otherwise, false.

seats_required
boolean or null

True if seat-level information (seat_to and seat_from) is required; Otherwise, false.

Array of objects or null (Section)

The valid section and row information. If no sections are specified then any text will be accepted for section and row.

primary_order_id_required
boolean or null
home_or_away_required
boolean or null
(ListingConstraintsLinks (object or null))
(ListingConstraintsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "min_ticket_price": {
    },
  • "max_ticket_price": {
    },
  • "min_number_of_tickets": 0,
  • "max_number_of_tickets": 0,
  • "ticket_location_required": true,
  • "seats_required": true,
  • "sections": [
    ],
  • "primary_order_id_required": true,
  • "home_or_away_required": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

Get listing constraints for a requested event

Get listings constraints for an event requested by the current user.

Authorizations:
OAuth2 (write:sellerlistingswrite:requestedevents)
Request Body schema: application/json
One of
(EventRequest (object or null))

The event information.

(VenueRequest (object or null))

The venue where the event will take place.

(CountryRequest (object or null))

The country where the event will take place.

Responses

Response Schema: application/hal+json
(Money (object or null))
(Money (object or null))
min_number_of_tickets
integer or null <int32>

The minimum number of tickets available for purchase.

max_number_of_tickets
integer or null <int32>

The maximum number of tickets available for purchase.

ticket_location_required
boolean or null

True if a ticket location is required for tickets; Otherwise, false.

seats_required
boolean or null

True if seat-level information (seat_to and seat_from) is required; Otherwise, false.

Array of objects or null (Section)

The valid section and row information. If no sections are specified then any text will be accepted for section and row.

primary_order_id_required
boolean or null
home_or_away_required
boolean or null
(ListingConstraintsLinks (object or null))
(ListingConstraintsEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "event": {
    },
  • "venue": {
    },
  • "country": {
    }
}

Response samples

Content type
application/hal+json
{
  • "min_ticket_price": {
    },
  • "max_ticket_price": {
    },
  • "min_number_of_tickets": 0,
  • "max_number_of_tickets": 0,
  • "ticket_location_required": true,
  • "seats_required": true,
  • "sections": [
    ],
  • "primary_order_id_required": true,
  • "home_or_away_required": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

SellerEvents

List seller events

List events with listings that belong to the authenticated user.

Authorizations:
OAuth2 (read:sellerlistings)
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

updated_since
string <date-time>

Filters the response to only return items that have been updated since the given timestamp

sort
string

Determines the ordering of items. A comma-separated string containing id, number_of_tickets, orresource_version.

Responses

Response Schema: application/hal+json
One of
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(SellerEventsLinks (object or null))
(SellerEventsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Create a seller event

Request for an event to be created on the viagogo marketplace.

Authorizations:
OAuth2 (write:requestedevents)
Request Body schema: application/json
One of
(EventRequest (object or null))

The event information.

(VenueRequest (object or null))

The venue where the event will take place.

(CountryRequest (object or null))

The country where the event will take place.

Responses

Response Schema: application/hal+json
id
integer or null <int32>

The event identifier.

name
string or null

The name of the event.

start_date
string or null <date-time>

The date when the event starts.

end_date
string or null <date-time>

The date when the event ends.

on_sale_date
string or null <date-time>

The date when tickets for the event will go onsale.

date_confirmed
boolean or null

True if the event start and end date have been confirmed; Otherwise, false.

Array of objects or null (MergedEntity)

The list of event ids that are merged into this event.

(SellerEventLinks (object or null))
lms
boolean or null

True if the event is a last minute sale event; otherwise, false.

(SellerEventEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "event": {
    },
  • "venue": {
    },
  • "country": {
    }
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "name": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "on_sale_date": "2019-08-24T14:15:22Z",
  • "date_confirmed": true,
  • "merged_events": [
    ],
  • "_links": {
    },
  • "lms": true,
  • "_embedded": {
    }
}

Get a seller event

Get an event with listings belonging to the current user

Authorizations:
OAuth2 (read:sellerlistings)
path Parameters
eventIdOrRequestedEventId
required
string or null

Responses

Response Schema: application/hal+json
id
integer or null <int32>

The event identifier.

name
string or null

The name of the event.

start_date
string or null <date-time>

The date when the event starts.

end_date
string or null <date-time>

The date when the event ends.

on_sale_date
string or null <date-time>

The date when tickets for the event will go onsale.

date_confirmed
boolean or null

True if the event start and end date have been confirmed; Otherwise, false.

Array of objects or null (MergedEntity)

The list of event ids that are merged into this event.

(SellerEventLinks (object or null))
lms
boolean or null

True if the event is a last minute sale event; otherwise, false.

(SellerEventEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "name": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "on_sale_date": "2019-08-24T14:15:22Z",
  • "date_confirmed": true,
  • "merged_events": [
    ],
  • "_links": {
    },
  • "lms": true,
  • "_embedded": {
    }
}

Shipments

Get a shipping label for a seller listing

Authorizations:
OAuth2 (read:userread:sellerlistings)
path Parameters
listingId
required
integer <int64>
shipmentId
required
integer <int32>

Responses

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/hal+json
{
  • "code": "string",
  • "message": "string",
  • "errors": {
    }
}

List shipments for a seller listing

Authorizations:
OAuth2 (read:userread:sellerlistings)
path Parameters
listingId
required
integer <int64>
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(ShipmentsLinks (object or null))
(ShipmentsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Print a shipping label for a seller listing

Authorizations:
OAuth2 (write:userwrite:sellerlistings)
path Parameters
listingId
required
integer <int64>

Responses

Response Schema: application/hal+json
id
integer <int32>

The shipment identifier.

tracking_number
string or null

The identifier used to track the shipment of the ticket(s).

(Address (object or null))

The address that the seller must ship the tickets to.

(ShipmentLinks (object or null))
(ShipmentEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "tracking_number": "string",
  • "delivery_address": {
    },
  • "_links": {
    },
  • "_embedded": {
    }
}

Update a shipment for a seller listing

Authorizations:
OAuth2 (write:userwrite:sellerlistings)
path Parameters
listingId
required
integer <int64>
shipmentId
required
integer <int32>
Request Body schema: application/json
One of
tracking_number
string or null

The identifier used to track the shipment of the ticket(s).

Responses

Response Schema: application/hal+json
id
integer <int32>

The shipment identifier.

tracking_number
string or null

The identifier used to track the shipment of the ticket(s).

(Address (object or null))

The address that the seller must ship the tickets to.

(ShipmentLinks (object or null))
(ShipmentEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "tracking_number": "string"
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "tracking_number": "string",
  • "delivery_address": {
    },
  • "_links": {
    },
  • "_embedded": {
    }
}

Money

Returned for monetary values, such as ticket prices, fees charged and tax amounts.

amount
required
number or null <decimal>

The decimal amount of the money.

currency_code
required
string or null

The ISO 4217 currency code that the monetary value is represented in.

display
string or null

A user-friendly string representing the monetary value.

{
  • "amount": 0,
  • "currency_code": "string",
  • "display": "string"
}

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.

total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(ETicketsLinks (object or null))
(ETicketsEmbeddedResources (object or null))
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

ETicketUpload

Represents an uploaded file that contains one or more E-Tickets.

id
integer <int32>

The identifier of the upload.

file_name
string or null

The name of the file that was uploaded.

processed_at
string <date-time>

The date when all of the E-Tickets in the uploaded file were processed.

original_number_of_etickets
integer <int32>

The original number of E-Tickets contained in the uploaded file.

status_description
string or null

A localised in-depth description of the current status of the upload.

(ETicketUploadLinks (object or null))
(ETicketUploadEmbeddedResources (object or null))
{
  • "id": 0,
  • "file_name": "string",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "original_number_of_etickets": 0,
  • "status_description": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

ETicketUploads

total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(ETicketUploadsLinks (object or null))
(ETicketUploadsEmbeddedResources (object or null))
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

ListingConstraints

The constraints applied to a listing for a particular event on the viagogo marketplace.

(Money (object or null))
(Money (object or null))
min_number_of_tickets
integer or null <int32>

The minimum number of tickets available for purchase.

max_number_of_tickets
integer or null <int32>

The maximum number of tickets available for purchase.

ticket_location_required
boolean or null

True if a ticket location is required for tickets; Otherwise, false.

seats_required
boolean or null

True if seat-level information (seat_to and seat_from) is required; Otherwise, false.

Array of objects or null (Section)

The valid section and row information. If no sections are specified then any text will be accepted for section and row.

primary_order_id_required
boolean or null
home_or_away_required
boolean or null
(ListingConstraintsLinks (object or null))
(ListingConstraintsEmbeddedResources (object or null))
{
  • "min_ticket_price": {
    },
  • "max_ticket_price": {
    },
  • "min_number_of_tickets": 0,
  • "max_number_of_tickets": 0,
  • "ticket_location_required": true,
  • "seats_required": true,
  • "sections": [
    ],
  • "primary_order_id_required": true,
  • "home_or_away_required": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

SellerEvent

An event on the viagogo marketplace with listings that belong to the currently authenticated user.

id
integer or null <int32>

The event identifier.

name
string or null

The name of the event.

start_date
string or null <date-time>

The date when the event starts.

end_date
string or null <date-time>

The date when the event ends.

on_sale_date
string or null <date-time>

The date when tickets for the event will go onsale.

date_confirmed
boolean or null

True if the event start and end date have been confirmed; Otherwise, false.

Array of objects or null (MergedEntity)

The list of event ids that are merged into this event.

(SellerEventLinks (object or null))
lms
boolean or null

True if the event is a last minute sale event; otherwise, false.

(SellerEventEmbeddedResources (object or null))
{
  • "id": 0,
  • "name": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "on_sale_date": "2019-08-24T14:15:22Z",
  • "date_confirmed": true,
  • "merged_events": [
    ],
  • "_links": {
    },
  • "lms": true,
  • "_embedded": {
    }
}

SellerEvents

total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(SellerEventsLinks (object or null))
(SellerEventsEmbeddedResources (object or null))
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

SellerListing

A set of tickets for sale on the viagogo marketplace that belong to the currently authenticated user.

id
integer or null <int64>

The listing identifier.

created_at
string or null <date-time>

The date when the listing was created.

number_of_tickets
integer or null <int32>

The number of tickets available for purchase.

(SeatingDetail (object or null))

The seating information for the ticket(s) in this listing.

(SeatingDetail (object or null))

The seating information that will be displayed to buyers for the ticket(s) in this listing.

(Money (object or null))

The price of each ticket in the listing.

updated_at
string or null <date-time>

The date when the listing was last updated.

external_id
string or null

An identifier that has been assigned to the listing in an external inventory management system.

expires_at
string or null <date-time>

The date when the listing will be automatically unpublished from the marketplace.

display_number_of_tickets
integer or null <int32>

The number of tickets that should be displayed to buyers as available for purchase.

(Money (object or null))

The price printed on the ticket, not including any booking fees.

(Money (object or null))

The amount that the seller will receive for each ticket sold.

in_hand_at
string or null <date-time>

The date when the seller will have the tickets in hand.

is_ticket_concierge
boolean

Whether the listing represents a shorted ticket

is_auto_po
boolean

Whether a listing was automatically generated from a purchase order

Array of objects or null (BarcodeInformation)

Barcode(s) for the ticket(s) in this listing.

instant_delivery
boolean or null
undeliverable
boolean or null

Shipment of the ticket to the buyer cannot be guaranteed before the event. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.

(Money (object or null))

The purchase price paid by the seller for each ticket in the listing.

(Money (object or null))

The total purchase price paid by the seller.

sales_tax_paid
boolean or null

True if the seller already paid sales tax for the ticket(s); otherwise, false.

(SellerListingLinks (object or null))
(SellerListingEmbeddedResources (object or null))
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "number_of_tickets": 0,
  • "seating": {
    },
  • "display_seating": {
    },
  • "ticket_price": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "display_number_of_tickets": 0,
  • "face_value": {
    },
  • "ticket_proceeds": {
    },
  • "in_hand_at": "2019-08-24T14:15:22Z",
  • "is_ticket_concierge": true,
  • "is_auto_po": true,
  • "barcodes": [
    ],
  • "instant_delivery": true,
  • "undeliverable": true,
  • "purchase_price_per_ticket": {
    },
  • "total_purchase_price": {
    },
  • "sales_tax_paid": true,
  • "_links": {
    },
  • "_embedded": {
    }
}

SellerListings

total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(SellerListingsLinks (object or null))
(SellerListingsEmbeddedResources (object or null))
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Shipment

A shipment of one or more tickets by a seller.

id
integer <int32>

The shipment identifier.

tracking_number
string or null

The identifier used to track the shipment of the ticket(s).

(Address (object or null))

The address that the seller must ship the tickets to.

(ShipmentLinks (object or null))
(ShipmentEmbeddedResources (object or null))
{
  • "id": 0,
  • "tracking_number": "string",
  • "delivery_address": {
    },
  • "_links": {
    },
  • "_embedded": {
    }
}

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.

total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(ShipmentsLinks (object or null))
(ShipmentsEmbeddedResources (object or null))
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}