ebay-api
Version:
eBay API for Node and Browser
142 lines (141 loc) • 5.03 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const index_js_1 = __importDefault(require("../../index.js"));
/**
* The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
* category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
* and fields values.
*/
class Browse extends index_js_1.default {
get basePath() {
return '/buy/browse/v1';
}
//
// Item
// Client Credentials: https://api.ebay.com/oauth/api_scope
//
/**
* This method searches for eBay items by various query parameters and retrieves summaries of the items.
*
* @param {BrowseSearchParams} params
*/
search(params) {
return this.get(`/item_summary/search`, {
params
});
}
/**
* This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
* the items.
*
* @param {BrowseSearchParams} params
* @param {Object} body The container for the image information fields.
*/
searchByImage(params, body = {}) {
return this.post(`/item_summary/search_by_image`, body, {
params
});
}
/**
* This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
*
* @param itemIds A list of item IDs. Item IDs are the eBay RESTful identifier of items.
* @param itemGroupIds A list of item group IDs.
*/
getItems({ itemIds: item_ids, itemGroupIds: item_group_ids }) {
return this.get(`/item/`, {
params: {
item_ids,
item_group_ids
}
});
}
/**
* This method retrieves the details of a specific item, such as description, price, category, all item aspects,
* condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
* and other information the buyer needs to make a purchasing decision.
*
* @param {String} itemId The eBay RESTful identifier of an item.
* @param {String} fieldgroups
*/
getItem(itemId, fieldgroups) {
const id = encodeURIComponent(itemId);
return this.get(`/item/${id}`, {
params: {
fieldgroups
}
});
}
/**
* This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
*
* @param {LegacyItemParams} params
*/
getItemByLegacyId(params) {
return this.get(`/item/get_item_by_legacy_id`, {
params
});
}
/**
* This method retrieves the details of the individual items in an item group.
*
* @param itemGroupId
*/
getItemsByItemGroup(itemGroupId) {
return this.get(`/item/get_items_by_item_group`, {
params: {
item_group_id: itemGroupId
}
});
}
/**
* This method checks if a product is compatible with the specified item.
* @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
* @param {Object} body CompatibilityPayload
*/
checkCompatibility(itemId, body) {
const id = encodeURIComponent(itemId);
return this.post(`/item/${id}/check_compatibility`, body);
}
//
// Shopping Cart
//
/**
* This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
* adds items to that cart.
*
* @param {Object} item AddCartItemInput
*/
addItem(item) {
return this.post(`/shopping_cart/add_item`, item);
}
/**
* This is an experimental method. This method retrieves all the items in the eBay member's cart;
* items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
*/
getShoppingCart() {
return this.get(`/shopping_cart/`);
}
/**
* This is an experimental method. This method removes a specific item from the eBay member's cart.
*
* @param {Object} item RemoveCartItemInput
*/
removeItem(item) {
return this.post(`/shopping_cart/remove_item`, item);
}
/**
* This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
* cart.
*
* @param {UpdateCartItemInput} item UpdateCartItemInput
*/
updateQuantity(item) {
return this.post(`/shopping_cart/update_quantity`, item);
}
}
exports.default = Browse;
Browse.id = 'Browse';