ebay-api 8.4.1 → 8.5.1

package/dist/types/restful/specs/sell_negotiation_v1_oas3.d.ts

@@ -0,0 +1,225 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/find_eligible_items": {
+        /** @description This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer. A listing ID is returned only when one or more buyers have shown an "interest" in the listing. If any buyers have shown interest in a listing, the seller can initiate a "negotiation" with them by calling sendOfferToInterestedBuyers, which sends all interested buyers a message that offers the listing at a discount. For details about how to create seller offers to buyers, see Sending offers to buyers. */
+        get: operations["findEligibleItems"];
+    };
+    "/send_offer_to_interested_buyers": {
+        /** @description This method sends eligible buyers offers to purchase items in a listing at a discount. When a buyer has shown interest in a listing, they become "eligible" to receive a seller-initiated offer to purchase the item(s). Sellers use findEligibleItems to get the set of listings that have interested buyers. If a listing has interested buyers, sellers can use this method (sendOfferToInterestedBuyers) to send an offer to the buyers who are interested in the listing. The offer gives buyers the ability to purchase the associated listings at a discounted price. For details about how to create seller offers to buyers, see Sending offers to buyers. */
+        post: operations["sendOfferToInterestedBuyers"];
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** @description A complex type that describes the value of a monetary amount as represented by a global currency. */
+        Amount: {
+            /** @description The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO4217 currency code. For example, the code for the Canadian Dollar is CAD. Default: The default currency of the eBay marketplace that hosts the listing. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/negotiation/types/bas:CurrencyCodeEnum'>eBay API documentation</a> */
+            currency?: string;
+            /** @description The monetary amount in the specified currency. */
+            value?: string;
+        };
+        /** @description This complex type contains the fields needed to create an offer to a buyer that is initiated by the seller. */
+        CreateOffersRequest: {
+            /** @description If set to true, the buyer is allowed to make a counter-offer to the seller's offer. Note: Currently, you must set this field to false; counter-offers are not supported in this release. Default: false */
+            allowCounterOffer?: boolean;
+            /** @description A seller-defined message related to the offer being made. This message is sent to the list of &quot;interested&quot; buyers. To increase the conversion rate of the offers a seller makes to buyers, eBay recommends you always add a customized message to your offers. Maximum length: 2,000 characters */
+            message?: string;
+            /** @description The length of time the offer is valid from when it is created. The duration of the offer begins at the date and time denoted by creationDate. When the span of time specified by offerDuration passes beyond the creationDate, the offer expires. Note: offerDuration currently defaults to 2 days and you cannot set it to any other value (if specified, the unit and value fields in TimeDuration must be set to DAY and 2, respectively). Default: 2 Days */
+            offerDuration?: components["schemas"]["TimeDuration"];
+            /** @description An array of objects where each object contains the details of an offer and the ID of the listing on which the offer is being made. Note that the service does not currently support the creation of multiple offers with a single call to sendOfferToInterestedBuyer. With this, each request can target only one listing at a time and you must populate this array with a single element that contains the details of one offer. */
+            offeredItems?: (components["schemas"]["OfferedItem"])[];
+        };
+        /** @description A listing that is eligible for a seller-initiated offer to a buyer. Listings are identified by a listingId value that is generated and assigned by eBay when a seller lists an item using the Trading API. Note: The Negotiation API does not currently support listings that are managed with the Inventory API. */
+        EligibleItem: {
+            /** @description The unique eBay-assigned ID for an eBay listing. A listingId is assigned by eBay when a seller creates a listing with the Trading API. */
+            listingId?: string;
+        };
+        /** @description This type defines the fields that can be returned in an error. */
+        Error: {
+            /** @description Identifies the type of erro. */
+            category?: string;
+            /** @description Name for the primary system where the error occurred. This is relevant for application errors. */
+            domain?: string;
+            /**
+             * Format: int32
+             * @description A unique number to identify the error.
+             */
+            errorId?: number;
+            /** @description An array of request elements most closely associated to the error. */
+            inputRefIds?: (string)[];
+            /** @description A more detailed explanation of the error. */
+            longMessage?: string;
+            /** @description Information on how to correct the problem, in the end user's terms and language where applicable. */
+            message?: string;
+            /** @description An array of request elements most closely associated to the error. */
+            outputRefIds?: (string)[];
+            /** @description An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. */
+            parameters?: (components["schemas"]["ErrorParameter"])[];
+            /** @description Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc. */
+            subdomain?: string;
+        };
+        ErrorParameter: {
+            /** @description The object of the error. */
+            name?: string;
+            /** @description The value of the object. */
+            value?: string;
+        };
+        /** @description A complex type that defines an offer that a seller makes to eligible buyers. */
+        Offer: {
+            /** @description If set to true, the buyer is allowed to make a counter-offer to the seller's offer. */
+            allowCounterOffer?: boolean;
+            /** @description The buyer who has been sent the offer. */
+            buyer?: components["schemas"]["User"];
+            /** @description The date and time when the seller's offer was created. The returned timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2018-08-20T07:09:00.000Z */
+            creationDate?: string;
+            /** @description The eBay UserName of the user (seller) who initiated the offer. */
+            initiatedBy?: string;
+            /** @description The date and time when the offer was last modified. The returned timestamp is formatted as an ISO 8601 string. */
+            lastModifiedDate?: string;
+            /** @description A seller-defined message related to the offer being made. This message is sent to the list of &quot;interested&quot; buyers along with the offer message from eBay. */
+            message?: string;
+            /** @description The length of time that the offer is valid. The duration of the offer begins at the date and time denoted by creationDate. When the span of time specified by offerDuration passes beyond the creationDate, the offer expires. */
+            offerDuration?: components["schemas"]["TimeDuration"];
+            /** @description The list of items associated with the offer. Currently, the offer list is restricted to a single offer. */
+            offeredItems?: (components["schemas"]["OfferedItem"])[];
+            /** @description A unique eBay-assigned identifier for the offer. */
+            offerId?: string;
+            /** @description The current state, or status, of an offer. Status states include PENDING, COUNTERED, ACCEPTED, and DECLINED. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/negotiation/types/api:OfferStatusEnum'>eBay API documentation</a> */
+            offerStatus?: string;
+            /** @description The type of offer being made. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/negotiation/types/api:OfferTypeEnum'>eBay API documentation</a> */
+            offerType?: string;
+            /** @description A unique, eBay-assigned ID for the revision of the offer. */
+            revision?: string;
+        };
+        /** @description A complex type that defines the offer being made to an &quot;interested&quot; buyer. */
+        OfferedItem: {
+            /** @description This value denotes the percentage that the listing in the offer will be discounted from its original listed price. The seller can specify either the exact price of the discounted items with the price field or they can use this field to specify the percentage that the listing will be discounted, but not both. Minimum: 5 Required if you do not specify a price value. */
+            discountPercentage?: string;
+            /** @description This value is a unique eBay-assigned ID that identifies the listing to which the offer pertains. A listingId value is generated by eBay when you list an item with the Trading API. */
+            listingId?: string;
+            /** @description This value denotes the final discounted price of the listing in the offer being made to the buyer. This value must be lower than the original price of the item as stated in the original listing. The seller can use either this field to specify the exact discounted price of the listing or they can use the discountPercentage field to specify the percentage that the listing will be discounted, but not both. Required if you do not specify a discountPercentage value. */
+            price?: components["schemas"]["Amount"];
+            /**
+             * Format: int32
+             * @description This integer value indicates the number of items in the eBay listing for which the offer is being made. The offer being made by the seller is an &quot;all or nothing&quot; offer, meaning the buyer must purchase the indicated quantity of items in order to receive the discount on the transaction. Default: 1
+             */
+            quantity?: number;
+        };
+        /** @description This complex type defines a collection of listings that are eligible for an offer to a buyer. */
+        PagedEligibleItemCollection: {
+            /** @description A list of items that are eligible for a seller-initiated offer to a buyer. Each element in the list contains the listing ID of a listed item. These IDs represent the listings for which buyers have shown an interest. */
+            eligibleItems?: (components["schemas"]["EligibleItem"])[];
+            /** @description The URI of the current page of results from the result set. */
+            href?: string;
+            /**
+             * Format: int32
+             * @description The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.
+             */
+            limit?: number;
+            /** @description The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. Max length: 2048 */
+            next?: string;
+            /**
+             * Format: int32
+             * @description The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.
+             */
+            offset?: number;
+            /** @description The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. Max length: 2048 */
+            prev?: string;
+            /**
+             * Format: int32
+             * @description The total number of items retrieved in the result set. If no items match the search criteria, the server returns the HTTP status code 204 No Content.
+             */
+            total?: number;
+        };
+        /** @description The response object returned from a SendOfferToInterestedBuyers request. */
+        SendOfferToInterestedBuyersCollectionResponse: {
+            /** @description The offers container returns a list of the offers sent to buyers who have shown an interest in listings included in the offer. */
+            offers?: (components["schemas"]["Offer"])[];
+        };
+        /** @description A complex type that specifies a period of time using a specified time-measurement unit. */
+        TimeDuration: {
+            /** @description A time-measurement unit that specifies a singular period of time. A span of time is defined when you apply the value specified in the value field to the value specified for unit. Time-measurement units can be YEAR, MONTH, DAY, and so on. See TimeDurationUnitEnum for a complete list of possible time-measurement units. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/negotiation/types/bas:TimeDurationUnitEnum'>eBay API documentation</a> */
+            unit?: string;
+            /**
+             * Format: int32
+             * @description An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.
+             */
+            value?: number;
+        };
+        /** @description This complex type identifies an eBay user. */
+        User: {
+            /** @description The masked user name is a user name that has certain characters hidden for privacy of the user. */
+            maskedUsername?: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type external = Record<string, never>;
+export interface operations {
+    /** @description This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer. A listing ID is returned only when one or more buyers have shown an &quot;interest&quot; in the listing. If any buyers have shown interest in a listing, the seller can initiate a &quot;negotiation&quot; with them by calling sendOfferToInterestedBuyers, which sends all interested buyers a message that offers the listing at a discount. For details about how to create seller offers to buyers, see Sending offers to buyers. */
+    findEligibleItems: {
+        parameters: {
+            query?: {
+                /** @description This query parameter specifies the maximum number of items to return from the result set on a page in the paginated response. Minimum: 1 &nbsp; &nbsp;Maximum: 200 Default: 10 */
+                limit?: string;
+                /** @description This query parameter specifies the number of results to skip in the result set before returning the first result in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 results from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. Default: 0 */
+                offset?: string;
+            };
+            header: {
+                /** @description The eBay marketplace on which you want to search for eligible listings. For a complete list of supported marketplaces, see Negotiation API requirements and restrictions. */
+                "X-EBAY-C-MARKETPLACE-ID": string;
+            };
+        };
+        responses: {
+            /** @description Success */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["PagedEligibleItemCollection"];
+                };
+            };
+            /** @description No Content */
+            204: never;
+            /** @description Bad Request */
+            400: never;
+            /** @description Internal Server Error */
+            500: never;
+        };
+    };
+    /** @description This method sends eligible buyers offers to purchase items in a listing at a discount. When a buyer has shown interest in a listing, they become &quot;eligible&quot; to receive a seller-initiated offer to purchase the item(s). Sellers use findEligibleItems to get the set of listings that have interested buyers. If a listing has interested buyers, sellers can use this method (sendOfferToInterestedBuyers) to send an offer to the buyers who are interested in the listing. The offer gives buyers the ability to purchase the associated listings at a discounted price. For details about how to create seller offers to buyers, see Sending offers to buyers. */
+    sendOfferToInterestedBuyers: {
+        parameters: {
+            header: {
+                /** @description The eBay marketplace on which your listings with &quot;eligible&quot; buyers appear. For a complete list of supported marketplaces, see Negotiation API requirements and restrictions. */
+                "X-EBAY-C-MARKETPLACE-ID": string;
+            };
+        };
+        /** @description Send offer to eligible items request. */
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["CreateOffersRequest"];
+            };
+        };
+        responses: {
+            /** @description Success */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["SendOfferToInterestedBuyersCollectionResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: never;
+            /** @description Conflict */
+            409: never;
+            /** @description Internal Server Error */
+            500: never;
+        };
+    };
+}

package/dist/types/restful/specs/sell_negotiation_v1_oas3.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};

package/dist/types/restful/specs/sell_recommendation_v1_oas3.d.ts

@@ -0,0 +1,148 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/find": {
+        /** @description The find method currently returns information for a single recommendation type (AD) which contains information that sellers can use to configure Promoted Listings ad campaigns. The response from this method includes an array of the seller's listing IDs, where each element in the array contains recommendations related to the associated listing ID. For details on how to use this method, see Using the Recommendation API to help configure campaigns. The AD recommendation type The AD type contains two sets of information: The promoteWithAd indicator The promoteWithAd response field indicates whether or not eBay recommends you place the associated listing in a Promoted Listings ad campaign. The returned value is set to either RECOMMENDED or UNDETERMINED, where RECOMMENDED identifies the listings that will benefit the most from having them included in an ad campaign. The bid percentage Also known as the "ad rate," the bidPercentage field provides the current trending bid percentage of similarly promoted items in the marketplace. The ad rate is a user-specified value that indicates the level of promotion that eBay applies to the campaign across the marketplace. The value is also used to calculate the Promotion Listings fee, which is assessed to the seller if a Promoted Listings action results in the sale of an item. Configuring the request You can configure a request to review all of a seller's currently active listings, or just a subset of them. All active listings – If you leave the request body empty, the request targets all the items currently listed by the seller. Here, the response is filtered to contain only the items where promoteWithAd equals RECOMMENDED. In this case, eBay recommends that all the returned listings should be included in a Promoted Listings ad campaign. Selected listing IDs – If you populate the request body with a set of listingIds, the response contains data for all the specified listing IDs. In this scenario, the response provides you with information on listings where the promoteWithAd can be either RECOMMENDED or UNDETERMINED. The paginated response Because the response can contain many listing IDs, the findListingRecommendations method paginates the response set. You can control size of the returned pages, as well as an offset that dictates where to start the pagination, using query parameters in the request. */
+        post: operations["findListingRecommendations"];
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** @description A complex type that contains recommendations and information on how to configure Promoted Listings ad campaigns. */
+        Ad: {
+            /** @description This field returns information that you can use to configure the bidPercentage field in a Promoted Listings campaign. Note: Currently, ITEM and TRENDING are the only supported bid percentage types. The ITEM suggested bid percentages are tailored to each of your items and are designed to help you stay competitive while finding an optimal balance between performance and cost. The recommendations are calculated based on a variety of factors that may include item attributes, seasonality, past performance, and current competition for each of your listings. The TRENDING suggested bid percentages are calculated by reviewing the category level average ad rates in the marketplace. Setting the bidPercentage of your ad campaign based on these rate recommendations will help the items in the campaign be competitive with other items in the marketplace by improving their chances of being displayed more often in the marketplace. */
+            bidPercentages?: (components["schemas"]["BidPercentages"])[];
+            /** @description An enum whose values describe whether or not eBay recommends you place the associated listing in a Promoted Listings ad campaign. IDs deemed RECOMMENDED by eBay are the listings with the highest potential of benefiting from being promoted. The recommendation calculation is based on marketplace trends, like buyer demand and the competition in the item&rsquo;s category. Note: A promoteWithAd value cannot be calculated for listings that are part of Promoted Listings campaigns. Because of this, if you call findListingRecommendations with a specific set of listing IDs, the promoteWithAd field is not returned for any of the listings that are involved in a promotion. However, as long as they are eligible, the trending bidPercentage is returned for all specified listings, even if they are part of an ad campaign. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/recommendation/types/api:PromoteWithAd'>eBay API documentation</a> */
+            promoteWithAd?: string;
+        };
+        /** @description A complex type that returns data related to Promoted Listings bid percentages. */
+        BidPercentages: {
+            /** @description The basis by which the ad rate is calculated. Valid Values: ITEM and TRENDING For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/recommendation/types/api:Basis'>eBay API documentation</a> */
+            basis?: string;
+            /** @description The bid percentage data is a single precision value, as calculated by the associated basis. In Promoted listings ad campaigns, the bid percentage (also known as the ad rate) is a user-defined value that sets the level that eBay raises the visibility of the listing in the marketplace. It is also the rate that is used to calculate the Promoted Listings fee. Minimum value: 1.0 &nbsp; Maximum value: 100.0 */
+            value?: string;
+        };
+        /** @description This type defines the fields that can be returned in an error. */
+        Error: {
+            /** @description Identifies the type of erro. */
+            category?: string;
+            /** @description Name for the primary system where the error occurred. This is relevant for application errors. */
+            domain?: string;
+            /**
+             * Format: int32
+             * @description A unique number to identify the error.
+             */
+            errorId?: number;
+            /** @description An array of request elements most closely associated to the error. */
+            inputRefIds?: (string)[];
+            /** @description A more detailed explanation of the error. */
+            longMessage?: string;
+            /** @description Information on how to correct the problem, in the end user's terms and language where applicable. */
+            message?: string;
+            /** @description An array of request elements most closely associated to the error. */
+            outputRefIds?: (string)[];
+            /** @description An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. */
+            parameters?: (components["schemas"]["ErrorParameter"])[];
+            /** @description Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc. */
+            subdomain?: string;
+        };
+        ErrorParameter: {
+            /** @description The object of the error. */
+            name?: string;
+            /** @description The value of the object. */
+            value?: string;
+        };
+        /** @description An list of listing ID values for which you want Promoted Listings ad configuration information. */
+        FindListingRecommendationRequest: {
+            /** @description A comma-separated list of listing IDs for which you want Promoted Listings ad configuration information. Currently, this method accepts only listingId values from the Trading API. Max: 500 listing IDs */
+            listingIds?: (string)[];
+        };
+        /** @description A complex type that contains the ID of an actively listed item and a set of related listing recommendations. The recommendations contain information the seller can use to optimize their listing configurations. */
+        ListingRecommendation: {
+            /** @description An ID that identifies the active listing associated with the eBay recommendations. */
+            listingId?: string;
+            /** @description This return object provides the eBay recommendations and information related to the associated listing ID. The container currently returns the AD recommendation type, which contains information that sellers can use to configure Promoted Listings ad campaigns. This container is returned with each ListingRecommendation object, except when: The listing ID is not eligible for Promoted Listings The listing ID is currently in a Promoted Listings campaign The listing ID is invalid */
+            marketing?: components["schemas"]["MarketingRecommendation"];
+        };
+        /** @description A complex type that contains information about how a seller can improve their listing configurations. The AD object contains Promoted Listings recommendations and information, which the seller can use to improve buyer conversions. The response can also contain an optional message about the returned data. */
+        MarketingRecommendation: {
+            /** @description An object that contains Promoted Listings recommendations and information related to the associated listing ID. */
+            ad?: components["schemas"]["Ad"];
+            /** @description A message that can conditionally accompany the listing information. */
+            message?: string;
+        };
+        /** @description The high-level object used to return a set of Promoted Listings ad recommendations. */
+        PagedListingRecommendationCollection: {
+            /** @description The URI of the current page of results from the result set. */
+            href?: string;
+            /**
+             * Format: int32
+             * @description The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.
+             */
+            limit?: number;
+            /** @description Returns a list of listingRecommendations, where each element in the list offers recommendations for the associated listingId. Which elements are returned depend on how you structure the request. For example, if you request recommendations for all of a sellers listings (by leaving the request payload empty), ad recommendations are returned only for those listings where promoteWithAd is set to RECOMMENDED. */
+            listingRecommendations?: (components["schemas"]["ListingRecommendation"])[];
+            /** @description The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. Max length: 2048 */
+            next?: string;
+            /**
+             * Format: int32
+             * @description The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.
+             */
+            offset?: number;
+            /** @description The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. Max length: 2048 */
+            prev?: string;
+            /**
+             * Format: int32
+             * @description The total number of items retrieved in the result set. If no items are found, this field is returned with a value of 0.
+             */
+            total?: number;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type external = Record<string, never>;
+export interface operations {
+    /** @description The find method currently returns information for a single recommendation type (AD) which contains information that sellers can use to configure Promoted Listings ad campaigns. The response from this method includes an array of the seller's listing IDs, where each element in the array contains recommendations related to the associated listing ID. For details on how to use this method, see Using the Recommendation API to help configure campaigns. The AD recommendation type The AD type contains two sets of information: The promoteWithAd indicator The promoteWithAd response field indicates whether or not eBay recommends you place the associated listing in a Promoted Listings ad campaign. The returned value is set to either RECOMMENDED or UNDETERMINED, where RECOMMENDED identifies the listings that will benefit the most from having them included in an ad campaign. The bid percentage Also known as the &quot;ad rate,&quot; the bidPercentage field provides the current trending bid percentage of similarly promoted items in the marketplace. The ad rate is a user-specified value that indicates the level of promotion that eBay applies to the campaign across the marketplace. The value is also used to calculate the Promotion Listings fee, which is assessed to the seller if a Promoted Listings action results in the sale of an item. Configuring the request You can configure a request to review all of a seller's currently active listings, or just a subset of them. All active listings &ndash; If you leave the request body empty, the request targets all the items currently listed by the seller. Here, the response is filtered to contain only the items where promoteWithAd equals RECOMMENDED. In this case, eBay recommends that all the returned listings should be included in a Promoted Listings ad campaign. Selected listing IDs &ndash; If you populate the request body with a set of listingIds, the response contains data for all the specified listing IDs. In this scenario, the response provides you with information on listings where the promoteWithAd can be either RECOMMENDED or UNDETERMINED. The paginated response Because the response can contain many listing IDs, the findListingRecommendations method paginates the response set. You can control size of the returned pages, as well as an offset that dictates where to start the pagination, using query parameters in the request. */
+    findListingRecommendations: {
+        parameters: {
+            query?: {
+                /** @description Provide a list of key-value pairs to specify the criteria you want to use to filter the response. In the list, separate each filter key from its associated value with a colon (&quot;:&quot;). Currently, the only supported filter value is recommendationTypes and it supports only the (&quot;AD&quot;) type. Follow the recommendationTypes specifier with the filter type(s) enclosed in curly braces (&quot;{ }&quot;), and separate multiple types with commas. Example: filter=recommendationTypes:{AD} Default: recommendationTypes:{AD} */
+                filter?: string;
+                /** @description Use this query parameter to set the maximum number of ads to return on a page from the paginated response. Default: 10 Maximum: 500 */
+                limit?: string;
+                /** @description Specifies the number of ads to skip in the result set before returning the first ad in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. Default: 0 */
+                offset?: string;
+            };
+            header: {
+                /** @description Use this header to specify the eBay marketplace where you list the items for which you want to get recommendations. */
+                "X-EBAY-C-MARKETPLACE-ID": string;
+            };
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["FindListingRecommendationRequest"];
+            };
+        };
+        responses: {
+            /** @description Success */
+            200: {
+                content: {
+                    "application/json;charset=UTF-8": components["schemas"]["PagedListingRecommendationCollection"];
+                };
+            };
+            /** @description No Content */
+            204: never;
+            /** @description Bad Request */
+            400: never;
+            /** @description Internal Server Error */
+            500: never;
+        };
+    };
+}

package/dist/types/restful/specs/sell_recommendation_v1_oas3.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};