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

Interface InventoryResource

@Path("/inventory") @Produces("application/json") @Consumes("application/json") public interface InventoryResource

  • Method Summary

    Modifier and Type
    Method
    Description
    org.oxerr.stubhub.client.model.BulkProcessingResultSummaryResponse
    bulkUpdate(org.oxerr.stubhub.client.model.BulkInventoryRequest bulkInventoryRequest)
    Bulk Update Listings.
    org.oxerr.stubhub.client.model.ListingResponse
    createInventory(org.oxerr.stubhub.client.model.InventoryCreateRequest inventoryCreateRequest)
    Create inventory.
    List<org.oxerr.stubhub.client.model.ListingResponse>
    deleteInventory(Long inventoryId)
    Delete Inventory by ID (Inventory must not be connected to any purchase orders)
    org.oxerr.stubhub.client.model.InventoryExportResponse
    export(OffsetDateTime updatedDateSince, Integer pageSize, Long paginationToken, Boolean includePastEvents, Boolean includeBuyerCommissionsPerTicket, OffsetDateTime createDateFrom, OffsetDateTime createDateTo, OffsetDateTime updatedDateTo)
    Exports inventory for exchange integration.
    org.oxerr.stubhub.client.model.InventoryExportLeanResponse
    exportLean()
     
    org.oxerr.stubhub.client.model.BulkProcessingResultSummaryResponse
    getBulkUpdateStatus(UUID bulkProcessingId)
    Get Bulk Update Listings Status.
    org.oxerr.stubhub.client.model.ListingResponse
    getByExternalId(String externalId, Boolean includeBuyerCommissionsPerTicket)
    Get inventory by External ID.
    List<org.oxerr.stubhub.client.model.ListingResponse>
    getByExternalIds(String externalId, Boolean includeBuyerCommissionsPerTicket)
    Get multiple inventories by External ID.
    List<org.oxerr.stubhub.client.model.ListingResponse>
    getInventory(Long inventoryId, Boolean includeBuyerCommissionsPerTicket)
    Get inventory by ID.
    org.oxerr.stubhub.client.model.InventoryExportResponse
    search(List<Integer> eventIds, List<Integer> categoryIds, List<String> includeTags, List<String> excludeTags, OffsetDateTime purchaseStartDate, OffsetDateTime purchaseEndDate, Integer maxPageSize, Long paginationToken, Boolean includePastEvents, Boolean includeBuyerCommissionsPerTicket, UUID eventMappingId, String vendorName, String eventSearchText, String tagKey, String tagValue)
    Search inventory.
    List<org.oxerr.stubhub.client.model.SearchListingsResponse>
    seek(List<Long> inventoryIds, Boolean includeBuyerCommissionsPerTicket, org.oxerr.stubhub.client.model.SeekListingsRequest seekListingsRequest)
    Seek inventory
    org.oxerr.stubhub.client.model.ListingResponse
    updateInventory(Long inventoryId, org.oxerr.stubhub.client.model.InventoryUpdateRequest inventoryUpdateRequest)
    Update listing prices, barcodes, and price settings.

  • Method Details

    • createInventory

      @POST org.oxerr.stubhub.client.model.ListingResponse createInventory(org.oxerr.stubhub.client.model.InventoryCreateRequest inventoryCreateRequest)
      Create inventory.

      201 - Created

      400 - Bad Request

      403 - Forbidden

      Parameters:
      inventoryCreateRequest - (optional)
      Returns:
      the created inventory.

    • getInventory

      @GET @Path("/{inventoryId}") List<org.oxerr.stubhub.client.model.ListingResponse> getInventory(@PathParam("inventoryId") Long inventoryId, @QueryParam("includeBuyerCommissionsPerTicket") Boolean includeBuyerCommissionsPerTicket)
      Get inventory by ID.

      200 - Success

      Parameters:
      inventoryId - The ID of the inventory to return (required)
      includeBuyerCommissionsPerTicket - To include buyerCommissionsArray per Ticket. Default is false (optional)
      Returns:
      the inventory for the given ID.

    • deleteInventory

      @DELETE @Path("/{inventoryId}") List<org.oxerr.stubhub.client.model.ListingResponse> deleteInventory(@PathParam("inventoryId") Long inventoryId)
      Delete Inventory by ID (Inventory must not be connected to any purchase orders)

      200 - Success

      Parameters:
      inventoryId - The ID of the inventory to return (required)
      Returns:
      the deleted inventory for the given ID.

    • updateInventory

      @PATCH @Path("/{inventoryId}") org.oxerr.stubhub.client.model.ListingResponse updateInventory(@PathParam("inventoryId") Long inventoryId, org.oxerr.stubhub.client.model.InventoryUpdateRequest inventoryUpdateRequest)
      Update listing prices, barcodes, and price settings.

      400 - Bad Request

      200 - Success

      Parameters:
      inventoryId - (required)
      inventoryUpdateRequest - (optional)
      Returns:
      the updated inventory for the given ID.

    • search

      @GET @Path("/search") org.oxerr.stubhub.client.model.InventoryExportResponse search(@QueryParam("eventIds") List<Integer> eventIds, @QueryParam("categoryIds") List<Integer> categoryIds, @QueryParam("includeTags") List<String> includeTags, @QueryParam("excludeTags") List<String> excludeTags, @QueryParam("purchaseStartDate") OffsetDateTime purchaseStartDate, @QueryParam("purchaseEndDate") OffsetDateTime purchaseEndDate, @QueryParam("maxPageSize") Integer maxPageSize, @QueryParam("paginationToken") Long paginationToken, @QueryParam("includePastEvents") Boolean includePastEvents, @QueryParam("includeBuyerCommissionsPerTicket") Boolean includeBuyerCommissionsPerTicket, @QueryParam("eventMappingId") UUID eventMappingId, @QueryParam("vendorName") String vendorName, @QueryParam("eventSearchText") String eventSearchText, @QueryParam("tagKey") String tagKey, @QueryParam("tagValue") String tagValue)
      Search inventory.

      200 - Success

      Parameters:
      eventIds - Viagogo Event IDs to include (optional)
      categoryIds - Viagogo Event Categories to include (optional)
      includeTags - Tags to include (optional)
      excludeTags - Tags to exclude (optional)
      purchaseStartDate - Inclusive starting purchase order date. The quantity of tickets considered for the listings will only consider tickets associated to valid purchase. (optional)
      purchaseEndDate - Inclusive ending purchase order date. The quantity of tickets considered for the listings will only consider tickets associated to valid purchase. (optional)
      maxPageSize - The max number of items returned per api call (default 500; min 1; max 5000) (optional)
      paginationToken - Values used to continue iteration for an equivalent query where last left off (optional)
      includePastEvents - To include inventory from past events in the results. Default is false (optional)
      includeBuyerCommissionsPerTicket - To include buyerCommissionsArray per Ticket. Default is false (optional)
      eventMappingId - (optional)
      vendorName - any purchase that match the vendor name (optional)
      eventSearchText - search event name or venue name or performer name by this search text (optional)
      tagKey - Tag key name (optional)
      tagValue - Tag value name (optional)
      Returns:
      inventories.

    • seek

      @GET @Path("/seek") List<org.oxerr.stubhub.client.model.SearchListingsResponse> seek(@QueryParam("inventoryIds") List<Long> inventoryIds, @QueryParam("includeBuyerCommissionsPerTicket") Boolean includeBuyerCommissionsPerTicket, org.oxerr.stubhub.client.model.SeekListingsRequest seekListingsRequest)
      Seek inventory

      200 - Success

      Parameters:
      inventoryIds - Inventory or Listing IDs to query and return (optional)
      includeBuyerCommissionsPerTicket - To include buyerCommissionsArray per Ticket. Default is false (optional)
      seekListingsRequest - (optional)
      Returns:
      inventories.

    • export

      @GET @Path("/export") org.oxerr.stubhub.client.model.InventoryExportResponse export(@QueryParam("updatedDateSince") OffsetDateTime updatedDateSince, @QueryParam("pageSize") Integer pageSize, @QueryParam("paginationToken") Long paginationToken, @QueryParam("includePastEvents") Boolean includePastEvents, @QueryParam("includeBuyerCommissionsPerTicket") Boolean includeBuyerCommissionsPerTicket, @QueryParam("createDateFrom") OffsetDateTime createDateFrom, @QueryParam("createDateTo") OffsetDateTime createDateTo, @QueryParam("updatedDateTo") OffsetDateTime updatedDateTo)
      Exports inventory for exchange integration. The results from this method are sorted by reverse mutation date order.

      200 - Success

      Parameters:
      updatedDateSince - The beginning update date to be used for looking up inventory. Must be in format yyyy-MM-ddTHH:mm:ss. (optional)
      pageSize - The number of results per page. (optional) Default page size is 100. Max page size is 5000. (optional)
      paginationToken - Token used to paginate result set. (optional)
      includePastEvents - To include inventory from past events in the results. Default is false. (optional)
      includeBuyerCommissionsPerTicket - o include buyerCommissionsArray per Ticket. Default is false. (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:
      inventories.

    • exportLean

      @GET @Path("/export/lean") org.oxerr.stubhub.client.model.InventoryExportLeanResponse exportLean()

    • bulkUpdate

      @POST @Path("/bulk") org.oxerr.stubhub.client.model.BulkProcessingResultSummaryResponse bulkUpdate(org.oxerr.stubhub.client.model.BulkInventoryRequest bulkInventoryRequest)
      Bulk Update Listings.

      400 - Bad Request

      200 - Success

      Parameters:
      bulkInventoryRequest - (optional)
      Returns:
      the bulk processing result summary response which contains the bulk processing id to track the status of the bulk update request.

    • getBulkUpdateStatus

      @GET @Path("/bulk/{bulkProcessingId}") org.oxerr.stubhub.client.model.BulkProcessingResultSummaryResponse getBulkUpdateStatus(@PathParam("bulkProcessingId") UUID bulkProcessingId)
      Get Bulk Update Listings Status.

      200 - Success

      Parameters:
      bulkProcessingId - (required)
      Returns:
      the bulk processing result summary response which contains the status of the bulk update request and the result of the bulk update when the processing is completed.

    • getByExternalId

      @GET @Path("/external/{externalId}") org.oxerr.stubhub.client.model.ListingResponse getByExternalId(@PathParam("externalId") String externalId, @QueryParam("includeBuyerCommissionsPerTicket") Boolean includeBuyerCommissionsPerTicket)
      Get inventory by External ID.

      200 - Success

      Parameters:
      externalId - The external ID of the inventory to look up (required)
      includeBuyerCommissionsPerTicket - To include buyerCommissionsArray per Ticket. Default is false (optional)
      Returns:
      the inventory for the given External ID.

    • getByExternalIds

      @GET @Path("/externals/{externalId}") List<org.oxerr.stubhub.client.model.ListingResponse> getByExternalIds(@PathParam("externalId") String externalId, @QueryParam("includeBuyerCommissionsPerTicket") Boolean includeBuyerCommissionsPerTicket)
      Get multiple inventories by External ID.

      200 - Success

      Parameters:
      externalId - The external ID of the inventories to look up (required)
      includeBuyerCommissionsPerTicket - To include buyerCommissionsArray per Ticket. Default is false (optional)
      Returns:
      the inventories for the given External ID.