Class MarketplaceApi

java.lang.Object

com.amilesend.discogs.api.ApiBase

com.amilesend.discogs.api.MarketplaceApi

public class MarketplaceApi
extends ApiBase

The Discogs Marketplace API.
API Documentation

See Also:

• ApiBase

Constructor Summary

Constructors

Constructor	Description
MarketplaceApi(DiscogsConnection connection)	Creates a new MarketplaceApi object.

Method Summary

Modifier and Type	Method	Description
AddOrderMessageResponse	addOrderMessage(@NonNull AddOrderMessageRequest request)	Adds a message to an order: Must be authenticated as the seller.
CreateListingResponse	createListing(@NonNull CreateListingRequest request)	Creates a new listing.
void	deleteListing(@NonNull DeleteListingRequest request)	Deletes a listing.
GetFeeResponse	getFee(@NonNull GetFeeRequest request)	Gets the fee when selling an item at a given price.
GetInventoryResponse	getInventory(@NonNull GetInventoryRequest request)	Gets the list of listing for a user's inventory.
GetListingResponse	getListing(@NonNull GetListingRequest request)	Gets a listing.
GetOrderResponse	getOrder(@NonNull GetOrderRequest request)	Gets information for a specific order.
GetOrderMessagesResponse	getOrderMessages(@NonNull GetOrderMessagesRequest request)	Gets the paginated list of messages associated with an order.
GetOrdersResponse	getOrders(@NonNull GetOrdersRequest request)	Gets the paginated list of orders for the authenticated user.
GetPriceSuggestionsResponse	getPriceSuggestions(@NonNull GetPriceSuggestionsRequest request)	Gets a map of prices suggestions foa given release.
GetReleaseStatisticsResponse	getReleaseStatistics(@NonNull GetReleaseStatisticsRequest request)	Gets the sales statistics for a release.
void	updateListing(@NonNull UpdateListingRequest request)	Updates a listing.
UpdateOrderResponse	updateOrder(@NonNull UpdateOrderRequest request)	Updates an order.

Methods inherited from class ApiBase

getConnection

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MarketplaceApi

public MarketplaceApi(DiscogsConnection connection)

Creates a new MarketplaceApi object.

Parameters:

connection - the underlying client connection

Method Details

getInventory

public GetInventoryResponse getInventory(@NonNull GetInventoryRequest request)

Gets the list of listing for a user's inventory.

Parameters:

request - the request

Returns:

the response

See Also:

• GetInventoryRequest
• GetInventoryResponse

getListing

public GetListingResponse getListing(@NonNull GetListingRequest request)

Gets a listing.

Parameters:

request - the request

Returns:

the response

See Also:

• GetListingRequest
• GetListingResponse

updateListing

public void updateListing(@NonNull UpdateListingRequest request)

Updates a listing. Note: Must be authenticated as the listing owner.

Parameters:

request - the request

See Also:

• UpdateListingRequest

deleteListing

public void deleteListing(@NonNull DeleteListingRequest request)

Deletes a listing. Note: Must be authenticated as the listing owner.

Parameters:

request - the request

createListing

public CreateListingResponse createListing(@NonNull CreateListingRequest request)

Creates a new listing. Note: Must be authenticated as the listing owner.

Parameters:

request - the request that describes the new listing

Returns:

the response containing the listing identifier

See Also:

• CreateListingRequest
• CreateListingResponse

getOrder

public GetOrderResponse getOrder(@NonNull GetOrderRequest request)

Gets information for a specific order. Note: Must be authenticated as the seller.

Parameters:

request - the request

Returns:

the response

See Also:

• GetOrderRequest
• GetOrderResponse

updateOrder

public UpdateOrderResponse updateOrder(@NonNull UpdateOrderRequest request)

Updates an order. Note: Must be authenticated as the seller.

Parameters:

request - the request with the attributes to update

Returns:

the response

See Also:

• UpdateOrderRequest
• UpdateOrderResponse

getOrders

public GetOrdersResponse getOrders(@NonNull GetOrdersRequest request)

Gets the paginated list of orders for the authenticated user.

Parameters:

request - the request

Returns:

the paginated list of orders

See Also:

• GetOrdersRequest
• GetOrdersResponse

getOrderMessages

public GetOrderMessagesResponse getOrderMessages(@NonNull GetOrderMessagesRequest request)

Gets the paginated list of messages associated with an order. Note: Must be authenticated as the seller.

Parameters:

request - the request

Returns:

the paginated list of messages.

See Also:

• GetOrderMessagesRequest
• GetOrderMessagesResponse

addOrderMessage

public AddOrderMessageResponse addOrderMessage(@NonNull AddOrderMessageRequest request)

Adds a message to an order: Must be authenticated as the seller.

Parameters:

request - the request

Returns:

the response

See Also:

• AddOrderMessageRequest
• AddOrderMessageResponse

getFee

public GetFeeResponse getFee(@NonNull GetFeeRequest request)

Gets the fee when selling an item at a given price.

Parameters:

request - the request

Returns:

the response

See Also:

• GetFeeRequest
• GetFeeResponse

getPriceSuggestions

public GetPriceSuggestionsResponse getPriceSuggestions(@NonNull GetPriceSuggestionsRequest request)

Gets a map of prices suggestions foa given release.

Parameters:

request - the request

Returns:

the response

See Also:

• GetPriceSuggestionsRequest
• GetPriceSuggestionsResponse

getReleaseStatistics

public GetReleaseStatisticsResponse getReleaseStatistics(@NonNull GetReleaseStatisticsRequest request)

Gets the sales statistics for a release. Note: Authentication is optional. Authenticated users will have the currency expressed by their configured preference. Unauthenticated users will have prices reflected in Currency.USD.

Parameters:

request - the request

Returns:

the response

See Also:

• GetReleaseStatisticsRequest
• GetReleaseStatisticsResponse