ebay-api/dist/api/restful/buy/deal/index.js

eBay API for Node and Browser

import Restful from '../../index.js';
/**
 * This API allows third-party developers to search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.
 */
export default class Deal extends Restful {
    get basePath() {
        return '/buy/deal/v1';
    }
    /**
     * This method retrieves a paginated set of deal items.
     *
     * @param categoryIds The unique identifier of the eBay category for the search.
     * @param commissionable A filter for commissionable deals. Restriction: This filter is currently only supported for the US marketplace.
     * @param deliveryCountry A filter for items that can be shipped to the specified country.
     * @param limit The maximum number of items, from the current result set, returned on a single page.
     * @param offset The number of items that will be skipped in the result set.
     */
    getDealItems({ categoryIds, commissionable, deliveryCountry, limit, offset }) {
        return this.get(`/deal_item`, {
            params: {
                category_ids: categoryIds,
                commissionable,
                delivery_country: deliveryCountry,
                limit,
                offset
            }
        });
    }
    /**
     * This method retrieves the details for an eBay event.
     *
     * @param eventId The unique identifier for the eBay event.
     */
    getEvent(eventId) {
        eventId = encodeURIComponent(eventId);
        return this.get(`/event/${eventId}`);
    }
    /**
     * This method returns paginated results containing all eBay events for the specified marketplace.
     *
     * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
     * @param offset The number of items that will be skipped in the result set.
     */
    getEvents({ limit, offset }) {
        return this.get(`/event`, {
            params: {
                limit,
                offset
            }
        });
    }
    /**
     * This method returns paginated results containing all eBay events for the specified marketplace.
     *
     * @param eventIds The unique identifiers for the eBay events. Maximum Value: 1
     * @param categoryIds The unique identifier of the eBay category for the search. Maximum Value: 1
     * @param deliveryCountry A filter for items that can be shipped to the specified country.
     * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
     * @param offset The number of items that will be skipped in the result set.
     */
    getEventItems(eventIds, { categoryIds, deliveryCountry, limit, offset } = {}) {
        return this.get(`/event_item`, {
            params: {
                event_ids: eventIds,
                limit,
                offset,
                category_ids: categoryIds,
                delivery_country: deliveryCountry
            }
        });
    }
}
Deal.id = 'Deal';