Package org.oxerr.stubhub.client.cxf.resource

Interface PurchaseResource

@Path("/purchases")
@Produces("application/json")
@Consumes("application/json")
public interface PurchaseResource

Method Summary

Modifier and Type	Method	Description
PurchaseResponse	getPurchaseOrder(Long purchaseOrderId, Boolean includeBuyerCommissionsPerTicket)	Get a purchase order.
PurchaseExportResponse	getPurchases(Long paginationToken, Integer maxPageSize, Boolean includeBuyerCommissionsPerTicket, OffsetDateTime updatedDateSince, Boolean onlyDeleted, String deletedState, OffsetDateTime createDateFrom, OffsetDateTime createDateTo, OffsetDateTime updatedDateTo)	Get purchase orders.

Method Details

getPurchaseOrder

@GET
@Path("/{purchaseOrderId}")
PurchaseResponse getPurchaseOrder(@PathParam("purchaseOrderId")
 Long purchaseOrderId,
 @QueryParam("includeBuyerCommissionsPerTicket")
 Boolean includeBuyerCommissionsPerTicket)

Get a purchase order.

200 - Success

Parameters:

purchaseOrderId - (required)

includeBuyerCommissionsPerTicket - To include buyerCommissionsArray per Ticket. Default is false (optional)

Returns:

the purchase order for the given ID.

getPurchases

@GET
PurchaseExportResponse getPurchases(@QueryParam("paginationToken")
 Long paginationToken,
 @QueryParam("maxPageSize")
 Integer maxPageSize,
 @QueryParam("includeBuyerCommissionsPerTicket")
 Boolean includeBuyerCommissionsPerTicket,
 @QueryParam("updatedDateSince")
 OffsetDateTime updatedDateSince,
 @QueryParam("onlyDeleted")
 Boolean onlyDeleted,
 @QueryParam("deletedState")
 String deletedState,
 @QueryParam("createDateFrom")
 OffsetDateTime createDateFrom,
 @QueryParam("createDateTo")
 OffsetDateTime createDateTo,
 @QueryParam("updatedDateTo")
 OffsetDateTime updatedDateTo)

Get purchase orders.

400 - Bad Request

200 - Success

Parameters:

paginationToken - (optional)

maxPageSize - (optional)

includeBuyerCommissionsPerTicket - To include buyerCommissionsArray per Ticket. Default is false (optional)

updatedDateSince - The beginning update date to be used for looking up inventory. Must be in format yyyy-MM-ddTHH:mm:ss. (optional)

onlyDeleted - To include only deleted purchase orders. Default is false (optional)

deletedState - Optional param to filter for a specific deleted state, Cancelled or Void. (optional)

createDateFrom - The beginning create date to be used for looking up inventory. Must be in format yyyy-MM-ddTHH:mm:ss. (optional)

createDateTo - The ending create date to be used for looking up inventory. Must be in format yyyy-MM-ddTHH:mm:ss. (optional)

updatedDateTo - The ending update date to be used for looking up inventory. Must be in format yyyy-MM-ddTHH:mm:ss. (optional)

Returns:

the purchase orders matching the given criteria.