MarketPlace | discojs

Hierarchy

MarketPlace
- Discojs

Index

Marketplace Methods

createListing

createListing(this: Discojs, options: ListingOptions): Promise<{} & {}>

- Defined in src/marketplace.ts:140
Create a Marketplace listing.

label

New Listing

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-new-listing

Parameters
- this: Discojs
- options: ListingOptions
Returns Promise<{} & {}>

deleteListing

deleteListing(this: Discojs, listingId: number): Promise<EmptyResponse>

- Defined in src/marketplace.ts:128
Permanently remove a listing from the Marketplace.

label

Listing

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-listing

Parameters
- this: Discojs
- listingId: number
Returns Promise<EmptyResponse>

editListing

editListing(this: Discojs, listingId: number, options: ListingOptions, currency?: CurrenciesEnum): Promise<EmptyResponse>

- Defined in src/marketplace.ts:116
Edit the data associated with a listing.

remarks

If the listing’s status is not For Sale, Draft, or Expired, it cannot be modified – only deleted.

label

Listing

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-listing

Parameters
- this: Discojs
- listingId: number
- options: ListingOptions
- Optional currency: CurrenciesEnum
Returns Promise<EmptyResponse>

editOrder

editOrder(this: Discojs, orderId: number, status?: EditOrderStatusesEnum, shipping?: undefined | number): Promise<{} & {}>

- Defined in src/marketplace.ts:164
Edit the data associated with an order.

label

Order

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-order

Parameters
- this: Discojs
- orderId: number
- Optional status: EditOrderStatusesEnum
- Optional shipping: undefined | number
Returns Promise<{} & {}>

getInventory

getInventory(this: Discojs, status?: InventoryStatusesEnum, sort?: SortOptions<InventorySortEnum>, pagination?: Pagination): Promise<{}>

- Defined in src/marketplace.ts:79
Get authenticated user’s inventory.

label

Inventory

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-inventory

Parameters
- this: Discojs
- Optional status: InventoryStatusesEnum
- Optional sort: SortOptions<InventorySortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

getInventoryForUser

getInventoryForUser(this: Discojs, username: string, status?: InventoryStatusesEnum, sort?: SortOptions<InventorySortEnum>, pagination?: Pagination): Promise<{}>

- Defined in src/marketplace.ts:57
Get a seller’s inventory.

remarks

If you are not authenticated as the inventory owner, only items that have a status of For Sale will be visible. If you are authenticated as the inventory owner you will get additional weight, format_quantity, external_id, and location keys. If the user is authorized, the listing will contain a in_cart boolean field indicating whether or not this listing is in their cart.

label

Inventory

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-inventory

Parameters
- this: Discojs
- username: string
- Default value status: InventoryStatusesEnum = InventoryStatusesEnum.ALL
- Optional sort: SortOptions<InventorySortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

getListing

getListing(this: Discojs, listingId: number, currency?: CurrenciesEnum): Promise<{} & {} & {}>

- Defined in src/marketplace.ts:101
View the data associated with a listing.

remarks

If the authorized user is the listing owner the listing will include the weight, format_quantity, external_id, and location keys. If the user is authorized, the listing will contain a in_cart boolean field indicating whether or not this listing is in their cart.

label

Listing

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-listing

Parameters
- this: Discojs
- listingId: number
- Optional currency: CurrenciesEnum
Returns Promise<{} & {} & {}>

getMarketplaceStatistics

getMarketplaceStatistics(this: Discojs, releaseId: number, currency?: CurrenciesEnum): Promise<{}>

- Defined in src/marketplace.ts:268
Retrieve marketplace statistics for the provided Release ID.

remarks

These statistics reflect the state of the release in the marketplace currently, and include the number of items currently for sale, lowest listed price of any item for sale, and whether the item is blocked for sale in the marketplace.

label

Release Statistics

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-release-statistics

Parameters
- this: Discojs
- releaseId: number
- Optional currency: CurrenciesEnum
Returns Promise<{}>

getOrder

getOrder(this: Discojs, orderId: number): Promise<{} & {}>

- Defined in src/marketplace.ts:152
View the data associated with an order.

label

Order

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-order

Parameters
- this: Discojs
- orderId: number
Returns Promise<{} & {}>

getPriceSuggestions

getPriceSuggestions(this: Discojs, releaseId: number): Promise<{}>

- Defined in src/marketplace.ts:251
Retrieve price suggestions for the provided Release ID.

remarks

Suggested prices will be denominated in the user’s selling currency.

label

Price Suggestions

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-price-suggestions

Parameters
- this: Discojs
- releaseId: number
Returns Promise<{}>

listOrderMessages

listOrderMessages(this: Discojs, orderId: number): Promise<{}>

- Defined in src/marketplace.ts:199
Returns a list of the order’s messages with the most recent first.

label

Order Messages

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-list-order-messages

Parameters
- this: Discojs
- orderId: number
Returns Promise<{}>

listOrders

listOrders(this: Discojs, status?: OrderStatusesEnum, archived?: undefined | false | true, sort?: SortOptions<OrderSortEnum>, pagination?: Pagination): Promise<OrdersResponse>

- Defined in src/marketplace.ts:176
Returns a list of the authenticated user’s orders.

label

List Orders

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-list-orders

Parameters
- this: Discojs
- Optional status: OrderStatusesEnum
- Optional archived: undefined | false | true
- Optional sort: SortOptions<OrderSortEnum>
- Optional pagination: Pagination
Returns Promise<OrdersResponse>

sendOrderMessage

sendOrderMessage(this: Discojs, orderId: number, message?: undefined | string, status?: OrderStatusesEnum): Promise<{} & {} & {} & {} & {}>

- Defined in src/marketplace.ts:216
Adds a new message to the order’s message log.

remarks

When posting a new message, you can simultaneously change the order status. If you do, the message will automatically be prepended with: "Seller changed status from Old Status to New Status" While message and status are each optional, one or both must be present.

label

Order Messages

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-list-order-messages

Parameters
- this: Discojs
- orderId: number
- Optional message: undefined | string
- Optional status: OrderStatusesEnum
Returns Promise<{} & {} & {} & {} & {}>

Generated using TypeDoc

Hierarchy

Index

Marketplace Methods

Marketplace Methods

createListing

Parameters

this: Discojs

options: ListingOptions

Returns Promise<{} & {}>

deleteListing

Parameters

this: Discojs

listingId: number

Returns Promise<EmptyResponse>

editListing

Parameters

this: Discojs

listingId: number

options: ListingOptions

Optional currency: CurrenciesEnum

Returns Promise<EmptyResponse>

editOrder

Parameters

this: Discojs

orderId: number

Optional status: EditOrderStatusesEnum

Optional shipping: undefined | number

Returns Promise<{} & {}>

getInventory

Parameters

this: Discojs

Optional status: InventoryStatusesEnum

Optional sort: SortOptions<InventorySortEnum>

Optional pagination: Pagination

Returns Promise<{}>

getInventoryForUser

Parameters

this: Discojs

username: string

Default value status: InventoryStatusesEnum = InventoryStatusesEnum.ALL

Optional sort: SortOptions<InventorySortEnum>

Optional pagination: Pagination

Returns Promise<{}>

getListing

Parameters

this: Discojs

listingId: number

Optional currency: CurrenciesEnum

Returns Promise<{} & {} & {}>

getMarketplaceStatistics

Parameters

this: Discojs

releaseId: number

Optional currency: CurrenciesEnum

Returns Promise<{}>

getOrder

Parameters

this: Discojs

orderId: number

Returns Promise<{} & {}>

getPriceSuggestions

Parameters

this: Discojs

releaseId: number

Returns Promise<{}>

listOrderMessages

Parameters

this: Discojs

orderId: number

Returns Promise<{}>

listOrders

Parameters

this: Discojs

Optional status: OrderStatusesEnum

Optional archived: undefined | false | true

Optional sort: SortOptions<OrderSortEnum>

Optional pagination: Pagination

Returns Promise<OrdersResponse>

sendOrderMessage

Parameters