ebay-api/dist/api/restful/sell/metadata/index.js

eBay API for Node and Browser

import Restful from '../../index.js';
/**
 * The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces.
 */
export default class Metadata extends Restful {
    get basePath() {
        return '/sell/metadata/v1';
    }
    /**
     * This method retrieves all the sales tax jurisdictions for the country that you specify in the countryCode path
     * parameter.
     *
     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 country code for the country
     *     whose jurisdictions you want to retrieve.
     */
    getSalesTaxJurisdictions(countryCode) {
        countryCode = encodeURIComponent(countryCode);
        return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
    }
    /**
     * This method returns the eBay policies that define how to list automotive-parts-compatibility items in the
     * categories of a specific marketplace.
     *
     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
     *     retrieved.
     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
     *     categories specified by this parameter.
     */
    getAutomotivePartsCompatibilityPolicies(marketplaceId, filter) {
        marketplaceId = encodeURIComponent(marketplaceId);
        return this.get(`/marketplace/${marketplaceId}/get_automotive_parts_compatibility_policies`, {
            params: {
                filter
            }
        });
    }
    /**
     * This method returns the eBay policies that define how to specify item conditions in the categories of a specific
     * marketplace.
     *
     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
     *     retrieved.
     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
     *     categories specified by this parameter.
     */
    getItemConditionPolicies(marketplaceId, filter) {
        marketplaceId = encodeURIComponent(marketplaceId);
        return this.get(`/marketplace/${marketplaceId}/get_item_condition_policies`, {
            params: {
                filter
            }
        });
    }
    /**
     * This method returns the eBay policies that define the allowed listing structures for the categories of a
     * specific marketplace.
     *
     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
     *     retrieved.
     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
     *     categories specified by this parameter.
     */
    getListingStructurePolicies(marketplaceId, filter) {
        marketplaceId = encodeURIComponent(marketplaceId);
        return this.get(`/marketplace/${marketplaceId}/get_listing_structure_policies`, {
            params: {
                filter
            }
        });
    }
    /**
     * This method returns the eBay policies that define the supported negotiated price features (like "best
     * offer") for the categories of a specific marketplace.
     *
     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
     *     retrieved.
     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
     *     categories specified by this parameter.
     */
    getNegotiatedPricePolicies(marketplaceId, filter) {
        marketplaceId = encodeURIComponent(marketplaceId);
        return this.get(`/marketplace/${marketplaceId}/get_negotiated_price_policies`, {
            params: {
                filter
            }
        });
    }
    /**
     * This method retrieves a list of leaf categories for a marketplace and identifies the categories that require
     * items to have an eBay product ID value in order to be listed in those categories.
     *
     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
     *     retrieved.
     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
     *     categories specified by this parameter.
     */
    getProductAdoptionPolicies(marketplaceId, filter) {
        marketplaceId = encodeURIComponent(marketplaceId);
        return this.get(`/marketplace/${marketplaceId}/get_product_adoption_policies`, {
            params: {
                filter
            }
        });
    }
    /**
     * This method returns the eBay policies that define whether or not you must include a return policy for the
     * items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and
     * international return policies in the different eBay categories.
     *
     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
     *     retrieved.
     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
     *     categories specified by this parameter.
     */
    getReturnPolicies(marketplaceId, filter) {
        marketplaceId = encodeURIComponent(marketplaceId);
        return this.get(`/marketplace/${marketplaceId}/get_return_policies`, {
            params: {
                filter
            }
        });
    }
}
Metadata.id = 'Metadata';