UNPKG

@whitebox-co/walmart-marketplace-api

Version:

A fully typed TypeScript, Javascript, and Node.js API library for the Walmart Marketplace API

2,025 lines 137 kB
/** * Insights Management * The Insights Management API provides sellers with actionable information to optimize their listings: * Sellers can locate best-selling items with Trending Items API so they can add those to their catalog of item offerings. * Sellers can find out reasons why items go unpublished, fix the issue and republish those items. * Sellers can use Listing Quality APIs to gather listing quality metrics about their items and find out any post-production issues that they can fix. * Sellers can obtain their overall Listing Quality score, and locate any categories that show items with listing quality issues. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * * @export * @interface Cancellations */ export interface Cancellations { /** * * @type {number} * @memberof Cancellations */ defectedOrder?: number; /** * * @type {number} * @memberof Cancellations */ totalOrder?: number; /** * * @type {number} * @memberof Cancellations */ rate?: number; } /** * * @export * @interface ContentAndDiscoverability */ export interface ContentAndDiscoverability { /** * * @type {number} * @memberof ContentAndDiscoverability */ issueCount?: number; /** * * @type {Array<InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1>} * @memberof ContentAndDiscoverability */ issues?: Array<InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1>; } /** * * @export * @interface ContentDiscoverabilityIssue */ export interface ContentDiscoverabilityIssue { /** * * @type {number} * @memberof ContentDiscoverabilityIssue */ score?: number; /** * * @type {boolean} * @memberof ContentDiscoverabilityIssue */ isEditable?: boolean; /** * * @type {string} * @memberof ContentDiscoverabilityIssue */ attributeValue?: string; /** * * @type {boolean} * @memberof ContentDiscoverabilityIssue */ isSpecAttribute?: boolean; /** * * @type {string} * @memberof ContentDiscoverabilityIssue */ attributeName?: string; /** * * @type {number} * @memberof ContentDiscoverabilityIssue */ issueCount?: number; /** * * @type {Array<InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues>} * @memberof ContentDiscoverabilityIssue */ issues?: Array<InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues>; } /** * * @export * @interface ContentDiscoverabilityIssuesDesc */ export interface ContentDiscoverabilityIssuesDesc { /** * * @type {string} * @memberof ContentDiscoverabilityIssuesDesc */ title?: string; /** * * @type {string} * @memberof ContentDiscoverabilityIssuesDesc */ value?: string; } /** * Shows the criteria for the Pro Seller badge. * @export * @interface CriteriaData */ export interface CriteriaData { /** * Number of orders received during the last 90 days. * @type {number} * @memberof CriteriaData */ orders?: number; /** * Delivery Defect rate in the given timeframe. * @type {string} * @memberof CriteriaData */ deliveryDefectRate?: string; /** * Cancellation rate in the given timeframe. * @type {string} * @memberof CriteriaData */ cancellationRate?: string; /** * Trending Catalog Quality Score coverage. * @type {number} * @memberof CriteriaData */ listingQualityCatalog?: number; /** * Days active on the platform. * @type {number} * @memberof CriteriaData */ activeDays?: number; } /** * * @export * @interface Filter */ export interface Filter { /** * | Attribute | Description | Data Type | --- | ----------- | ------- | contentDiscoverabilityPercentage | Item\'s content and discoverability score expressed as a percentage. | string | | qualityScorePercentage | Item\'s overall Listing Quality score, rated as a percentage. | string | | offerPercentage | Item\'s offer score, based on: item price, shipping price and speed, and in-stock rate.| string | | ratingReviewsPercentage | Rating and reviews score, as a percentage. | string | | viewTrendingItems | Indicates to return details for trending items that have non-zero page views. Acceptable values are \"true\" if pageView > 0, or \"false\" if pageView >= 0. | string | | viewPostPurchaseItems | Show items with post-purchase quality issues. If item has post-purchase value >= 1, it filters all items greater or equal based on post purchase value. | string | | wfsFlag | Show WFS-eligible items. Value of this parameter can be true or false. | string | | categoryName | Item\'s category name. | string | | hasIssues | Provides a count of item with issues. | integer | | productType | Product type to classify the item (e.g. Pants). | string| | attributeList | List of all available filter attributes. | string | | productTypes | List of all available product. | List<String> | | brandList | List of all available brand. | List<String> | | oos | Filter using out of stock offer based on days. Min value = 0, Max Value = 7. | integer | | fastAndFreeShipping | Possible values are 1 for offers eligible for free shipping and 0 for offers not eligible for free shipping. No value shows all the offers. | integer | | priceMeetBeatFlag | Possible values are -1 for no match, 0 for lose, 1 for meets and 2 for beats. No value shows all the offers. | integer | * @type {string} * @memberof Filter */ field?: FilterFieldEnum; /** * * @type {string} * @memberof Filter */ op?: FilterOpEnum; /** * * @type {Array<number>} * @memberof Filter */ values?: Array<number>; } /** * @export * @enum {string} */ export declare enum FilterFieldEnum { ContentDiscoverabilityPercentage = "contentDiscoverabilityPercentage", QualityScorePercentage = "qualityScorePercentage", OfferPercentage = "offerPercentage", RatingReviewsPercentage = "ratingReviewsPercentage", ViewTrendingItems = "viewTrendingItems", ViewPostPurchaseItems = "viewPostPurchaseItems", WfsFlag = "wfsFlag", CategoryName = "categoryName", HasIssues = "hasIssues", ProductType = "productType", AttributeList = "attributeList", ProductTypes = "productTypes", BrandList = "brandList", Oos = "oos", FastAndFreeShipping = "fastAndFreeShipping", PriceMeetBeatFlag = "priceMeetBeatFlag" } /** * @export * @enum {string} */ export declare enum FilterOpEnum { Equals = "equals", Between = "between" } /** * * @export * @interface GetCategoriesPayload */ export interface GetCategoriesPayload { /** * * @type {string} * @memberof GetCategoriesPayload */ name?: string; /** * * @type {number} * @memberof GetCategoriesPayload */ count?: number; /** * productType is only applicable for categories * @type {Array<InlineResponse2006ProductType>} * @memberof GetCategoriesPayload */ productType?: Array<InlineResponse2006ProductType>; } /** * * @export * @interface GetCategoriesResponse */ export interface GetCategoriesResponse { /** * * @type {Array<InlineResponse2006Payload>} * @memberof GetCategoriesResponse */ payload?: Array<InlineResponse2006Payload>; } /** * * @export * @interface GetListingQualityScore */ export interface GetListingQualityScore { /** * * @type {InlineResponse2005Payload} * @memberof GetListingQualityScore */ payload?: InlineResponse2005Payload; } /** * * @export * @interface GetTrendingResult */ export interface GetTrendingResult { /** * * @type {InlineResponse2004Payload} * @memberof GetTrendingResult */ payload?: InlineResponse2004Payload; /** * * @type {string} * @memberof GetTrendingResult */ status?: string; } /** * * @export * @interface GetTrendingResultPayload */ export interface GetTrendingResultPayload { /** * Total count of qualified items * @type {number} * @memberof GetTrendingResultPayload */ totalCount?: number; /** * List of Qualified Items * @type {Array<InlineResponse2004PayloadItems>} * @memberof GetTrendingResultPayload */ items?: Array<InlineResponse2004PayloadItems>; } /** * * @export * @interface GetUnpublishedItem */ export interface GetUnpublishedItem { /** * * @type {Array<InlineResponse2002Payload>} * @memberof GetUnpublishedItem */ payload?: Array<InlineResponse2002Payload>; /** * total number of unpublished items * @type {number} * @memberof GetUnpublishedItem */ totalCount?: number; /** * * @type {InlineResponse2002TotalGmvAmount} * @memberof GetUnpublishedItem */ totalGmvAmount?: InlineResponse2002TotalGmvAmount; } /** * * @export * @interface GetUnpublishedItemsCount */ export interface GetUnpublishedItemsCount { /** * * @type {Array<InlineResponse2003Payload>} * @memberof GetUnpublishedItemsCount */ payload?: Array<InlineResponse2003Payload>; } /** * * @export * @interface GetUnpublishedItemsPayload */ export interface GetUnpublishedItemsPayload { /** * The GTIN-compatible Product ID (i.e. UPC or EAN) * @type {string} * @memberof GetUnpublishedItemsPayload */ gtin?: string; /** * * @type {InlineResponse200ScoreDetailsOfferPrice} * @memberof GetUnpublishedItemsPayload */ marketPrice?: InlineResponse200ScoreDetailsOfferPrice; /** * The Date when item becomes available to sell in Walmart * @type {string} * @memberof GetUnpublishedItemsPayload */ offerStartDate?: string; /** * If item is trending in walmart * @type {string} * @memberof GetUnpublishedItemsPayload */ marketTrending?: string; /** * The lifecycle status of an item describes where the item listing is in the overall lifecycle * @type {string} * @memberof GetUnpublishedItemsPayload */ lifecycleStatus?: string; /** * It outlines the reason for an item when unpublished * @type {string} * @memberof GetUnpublishedItemsPayload */ unpublishReasons?: string; /** * Percentage of number of items that are converted into sales * @type {number} * @memberof GetUnpublishedItemsPayload */ conversionRate?: number; /** * A seller-specified, alphanumeric string uniquely identifying the product name * @type {string} * @memberof GetUnpublishedItemsPayload */ productName?: string; /** * * @type {InlineResponse2002GmvAmount} * @memberof GetUnpublishedItemsPayload */ gmvAmount?: InlineResponse2002GmvAmount; /** * Specifies the item identifier generated by Walmart * @type {string} * @memberof GetUnpublishedItemsPayload */ itemId?: string; /** * An average rating number for the item from customers * @type {string} * @memberof GetUnpublishedItemsPayload */ customerRating?: string; /** * number of times this item is viewed by customers * @type {number} * @memberof GetUnpublishedItemsPayload */ pageViews?: number; /** * * @type {InlineResponse200ScoreDetailsOfferPrice} * @memberof GetUnpublishedItemsPayload */ price?: InlineResponse200ScoreDetailsOfferPrice; /** * The Date item becomes to Unpublished * @type {string} * @memberof GetUnpublishedItemsPayload */ unpublishedDate?: string; /** * Specifies the item brand * @type {string} * @memberof GetUnpublishedItemsPayload */ brand?: string; /** * String of letters and/or numbers a partner uses to identify the item * @type {string} * @memberof GetUnpublishedItemsPayload */ sku?: string; /** * A seller-specified, alphanumeric string uniquely identifying the Product Type * @type {string} * @memberof GetUnpublishedItemsPayload */ productType?: string; /** * The Date when item becomes unavailable to sell in Walmart * @type {string} * @memberof GetUnpublishedItemsPayload */ offerEndDate?: string; /** * The status of an item when the item is in the submission process * @type {string} * @memberof GetUnpublishedItemsPayload */ publishStatus?: string; } /** * * @export * @interface Gmv */ export interface Gmv { /** * * @type {string} * @memberof Gmv */ amount?: string; /** * * @type {string} * @memberof Gmv */ currency?: string; } /** * * @export * @interface GmvAmount */ export interface GmvAmount { /** * The numerical value of the price * @type {number} * @memberof GmvAmount */ amount?: number; /** * The currency type * @type {string} * @memberof GmvAmount */ currency?: string; } /** * * @export * @interface InlineObject */ export interface InlineObject { /** * * @type {V3InsightsItemsListingQualityItemsQuery} * @memberof InlineObject */ query?: V3InsightsItemsListingQualityItemsQuery; /** * * @type {Array<V3InsightsItemsListingQualityItemsFilters>} * @memberof InlineObject */ filters?: Array<V3InsightsItemsListingQualityItemsFilters>; } /** * * @export * @interface InlineResponse200 */ export interface InlineResponse200 { /** * * @type {string} * @memberof InlineResponse200 */ nextCursor?: string; /** * * @type {string} * @memberof InlineResponse200 */ totalItems?: string; /** * * @type {Array<InlineResponse200Payload>} * @memberof InlineResponse200 */ payload?: Array<InlineResponse200Payload>; /** * * @type {string} * @memberof InlineResponse200 */ status?: string; } /** * * @export * @interface InlineResponse2001 */ export interface InlineResponse2001 { /** * Specifies if the seller has the badge * @type {boolean} * @memberof InlineResponse2001 */ hasBadge?: boolean; /** * Specifies if the seller is eligible for the badge in the next refresh * @type {boolean} * @memberof InlineResponse2001 */ isEligible?: boolean; /** * Specifies when the seller received their badge * @type {string} * @memberof InlineResponse2001 */ badgedSince?: string; /** * Specifies whether the seller is prohibited from participating in the Pro Seller badge program. * @type {boolean} * @memberof InlineResponse2001 */ isProhibited?: boolean; /** * Specifies the seller\'s badge status in detail. The possible values are \"Become a Pro Seller\", \"You are a Pro Seller\", \"Pro Seller Badge at risk\", \"Eligible starting from YYYY-MM-DD\", and \"Not eligible for the Pro Seller Badge\" * @type {string} * @memberof InlineResponse2001 */ badgeStatus?: string; /** * * @type {InlineResponse2001MeetsCriteria} * @memberof InlineResponse2001 */ meetsCriteria?: InlineResponse2001MeetsCriteria; /** * * @type {InlineResponse2001CriteriaData} * @memberof InlineResponse2001 */ criteriaData?: InlineResponse2001CriteriaData; /** * * @type {InlineResponse2001Recommendations} * @memberof InlineResponse2001 */ recommendations?: InlineResponse2001Recommendations; } /** * Shows the criteria for the Pro Seller badge. * @export * @interface InlineResponse2001CriteriaData */ export interface InlineResponse2001CriteriaData { /** * Number of orders received during the last 90 days. * @type {number} * @memberof InlineResponse2001CriteriaData */ orders?: number; /** * Delivery Defect rate in the given timeframe. * @type {string} * @memberof InlineResponse2001CriteriaData */ deliveryDefectRate?: string; /** * Cancellation rate in the given timeframe. * @type {string} * @memberof InlineResponse2001CriteriaData */ cancellationRate?: string; /** * Trending Catalog Quality Score coverage. * @type {number} * @memberof InlineResponse2001CriteriaData */ listingQualityCatalog?: number; /** * Days active on the platform. * @type {number} * @memberof InlineResponse2001CriteriaData */ activeDays?: number; } /** * Shows whether the seller has met the requirements for the badge. * @export * @interface InlineResponse2001MeetsCriteria */ export interface InlineResponse2001MeetsCriteria { /** * Indicates whether the seller has met the minimum number of orders required. * @type {boolean} * @memberof InlineResponse2001MeetsCriteria */ isOrdersCriteriaMet?: boolean; /** * Indicates whether the seller has a low delivery defect, meeting the threshold for the badge. * @type {boolean} * @memberof InlineResponse2001MeetsCriteria */ isDeliveryDefectCriteriaMet?: boolean; /** * Indicates whether the seller has a low cancellation rate, meeting the threshold for the badge. * @type {boolean} * @memberof InlineResponse2001MeetsCriteria */ isCancellationCriteriaMet?: boolean; /** * Indicates whether the seller is meeting the trending catalog requirement. * @type {boolean} * @memberof InlineResponse2001MeetsCriteria */ isListingQualityCatalogCriteriaMet?: boolean; /** * Indicates whether the seller has met the minimum number of active days required. * @type {boolean} * @memberof InlineResponse2001MeetsCriteria */ isActiveDaysCriteriaMet?: boolean; } /** * Recommendations on how to increase chances of Pro Seller Badge eligibility * @export * @interface InlineResponse2001Recommendations */ export interface InlineResponse2001Recommendations { /** * Recommendations on reducing the delivery defect rate * @type {string} * @memberof InlineResponse2001Recommendations */ deliveryDefectRate?: string; /** * Recommendations on reducing the Cancellation rate * @type {string} * @memberof InlineResponse2001Recommendations */ cancellationRate?: string; /** * Recommendations on increasing the trending item catalog coverage * @type {string} * @memberof InlineResponse2001Recommendations */ listingQualityCatalog?: string; } /** * * @export * @interface InlineResponse2002 */ export interface InlineResponse2002 { /** * * @type {Array<InlineResponse2002Payload>} * @memberof InlineResponse2002 */ payload?: Array<InlineResponse2002Payload>; /** * total number of unpublished items * @type {number} * @memberof InlineResponse2002 */ totalCount?: number; /** * * @type {InlineResponse2002TotalGmvAmount} * @memberof InlineResponse2002 */ totalGmvAmount?: InlineResponse2002TotalGmvAmount; } /** * * @export * @interface InlineResponse2002GmvAmount */ export interface InlineResponse2002GmvAmount { /** * The numerical value of the price * @type {number} * @memberof InlineResponse2002GmvAmount */ amount?: number; /** * The currency type * @type {string} * @memberof InlineResponse2002GmvAmount */ currency?: string; } /** * * @export * @interface InlineResponse2002Payload */ export interface InlineResponse2002Payload { /** * The GTIN-compatible Product ID (i.e. UPC or EAN) * @type {string} * @memberof InlineResponse2002Payload */ gtin?: string; /** * * @type {InlineResponse200ScoreDetailsOfferPrice} * @memberof InlineResponse2002Payload */ marketPrice?: InlineResponse200ScoreDetailsOfferPrice; /** * The Date when item becomes available to sell in Walmart * @type {string} * @memberof InlineResponse2002Payload */ offerStartDate?: string; /** * If item is trending in walmart * @type {string} * @memberof InlineResponse2002Payload */ marketTrending?: string; /** * The lifecycle status of an item describes where the item listing is in the overall lifecycle * @type {string} * @memberof InlineResponse2002Payload */ lifecycleStatus?: string; /** * It outlines the reason for an item when unpublished * @type {string} * @memberof InlineResponse2002Payload */ unpublishReasons?: string; /** * Percentage of number of items that are converted into sales * @type {number} * @memberof InlineResponse2002Payload */ conversionRate?: number; /** * A seller-specified, alphanumeric string uniquely identifying the product name * @type {string} * @memberof InlineResponse2002Payload */ productName?: string; /** * * @type {InlineResponse2002GmvAmount} * @memberof InlineResponse2002Payload */ gmvAmount?: InlineResponse2002GmvAmount; /** * Specifies the item identifier generated by Walmart * @type {string} * @memberof InlineResponse2002Payload */ itemId?: string; /** * An average rating number for the item from customers * @type {string} * @memberof InlineResponse2002Payload */ customerRating?: string; /** * number of times this item is viewed by customers * @type {number} * @memberof InlineResponse2002Payload */ pageViews?: number; /** * * @type {InlineResponse200ScoreDetailsOfferPrice} * @memberof InlineResponse2002Payload */ price?: InlineResponse200ScoreDetailsOfferPrice; /** * The Date item becomes to Unpublished * @type {string} * @memberof InlineResponse2002Payload */ unpublishedDate?: string; /** * Specifies the item brand * @type {string} * @memberof InlineResponse2002Payload */ brand?: string; /** * String of letters and/or numbers a partner uses to identify the item * @type {string} * @memberof InlineResponse2002Payload */ sku?: string; /** * A seller-specified, alphanumeric string uniquely identifying the Product Type * @type {string} * @memberof InlineResponse2002Payload */ productType?: string; /** * The Date when item becomes unavailable to sell in Walmart * @type {string} * @memberof InlineResponse2002Payload */ offerEndDate?: string; /** * The status of an item when the item is in the submission process * @type {string} * @memberof InlineResponse2002Payload */ publishStatus?: string; } /** * Gross Merchandise Value of the total result set * @export * @interface InlineResponse2002TotalGmvAmount */ export interface InlineResponse2002TotalGmvAmount { /** * The numerical value of the price * @type {string} * @memberof InlineResponse2002TotalGmvAmount */ amount?: string; /** * The currency type * @type {string} * @memberof InlineResponse2002TotalGmvAmount */ currency?: string; } /** * * @export * @interface InlineResponse2003 */ export interface InlineResponse2003 { /** * * @type {Array<InlineResponse2003Payload>} * @memberof InlineResponse2003 */ payload?: Array<InlineResponse2003Payload>; } /** * * @export * @interface InlineResponse2003Payload */ export interface InlineResponse2003Payload { /** * total count for unpublished Item * @type {string} * @memberof InlineResponse2003Payload */ unpublishedCount?: string; /** * total value for unpublished Item * @type {string} * @memberof InlineResponse2003Payload */ unpublishedValue?: string; /** * the reason why item is unpublished * @type {string} * @memberof InlineResponse2003Payload */ unpublishedReasonCode?: string; } /** * * @export * @interface InlineResponse2004 */ export interface InlineResponse2004 { /** * * @type {InlineResponse2004Payload} * @memberof InlineResponse2004 */ payload?: InlineResponse2004Payload; /** * * @type {string} * @memberof InlineResponse2004 */ status?: string; } /** * * @export * @interface InlineResponse2004Payload */ export interface InlineResponse2004Payload { /** * Total count of qualified items * @type {number} * @memberof InlineResponse2004Payload */ totalCount?: number; /** * List of Qualified Items * @type {Array<InlineResponse2004PayloadItems>} * @memberof InlineResponse2004Payload */ items?: Array<InlineResponse2004PayloadItems>; } /** * List of Qualified Items * @export * @interface InlineResponse2004PayloadItems */ export interface InlineResponse2004PayloadItems { /** * The categories this item belongs to * @type {string} * @memberof InlineResponse2004PayloadItems */ categoryName?: string; /** * The department this product belongs to * @type {string} * @memberof InlineResponse2004PayloadItems */ departmentName?: string; /** * International Standard Book Number * @type {string} * @memberof InlineResponse2004PayloadItems */ isbn?: string; /** * A seller-specified, alphanumeric string uniquely identifying the product name * @type {string} * @memberof InlineResponse2004PayloadItems */ productName?: string; /** * if the item can be shipped in two days * @type {number} * @memberof InlineResponse2004PayloadItems */ isTwoDayEligible?: number; /** * Specifies the item identifier generated by Walmart * @type {string} * @memberof InlineResponse2004PayloadItems */ itemId?: string; /** * Total number of item stored by seller * @type {number} * @memberof InlineResponse2004PayloadItems */ totalOffers?: number; /** * International Standard Serial Number * @type {string} * @memberof InlineResponse2004PayloadItems */ issn?: string; /** * if seller is selling this item * @type {number} * @memberof InlineResponse2004PayloadItems */ existsForSeller?: number; /** * Level of trending for this item * @type {number} * @memberof InlineResponse2004PayloadItems */ rank?: number; /** * Specifies the item brand * @type {string} * @memberof InlineResponse2004PayloadItems */ brand?: string; /** * The superDepartmentName this item belongs to * @type {string} * @memberof InlineResponse2004PayloadItems */ superDepartmentName?: string; /** * The subCategoryName this item belongs to * @type {string} * @memberof InlineResponse2004PayloadItems */ subCategoryName?: string; } /** * * @export * @interface InlineResponse2005 */ export interface InlineResponse2005 { /** * * @type {InlineResponse2005Payload} * @memberof InlineResponse2005 */ payload?: InlineResponse2005Payload; } /** * * @export * @interface InlineResponse2005Payload */ export interface InlineResponse2005Payload { /** * Over All Quality * @type {number} * @memberof InlineResponse2005Payload */ overAllQuality?: number; /** * * @type {InlineResponse2005PayloadScore} * @memberof InlineResponse2005Payload */ score?: InlineResponse2005PayloadScore; /** * * @type {InlineResponse2005PayloadPostPurchaseQuality} * @memberof InlineResponse2005Payload */ postPurchaseQuality?: InlineResponse2005PayloadPostPurchaseQuality; } /** * Post Purchase Quality * @export * @interface InlineResponse2005PayloadPostPurchaseQuality */ export interface InlineResponse2005PayloadPostPurchaseQuality { /** * Defect Ratio * @type {number} * @memberof InlineResponse2005PayloadPostPurchaseQuality */ defectRatio?: number; /** * Item Defect Count * @type {number} * @memberof InlineResponse2005PayloadPostPurchaseQuality */ itemDefectCnt?: number; } /** * Score * @export * @interface InlineResponse2005PayloadScore */ export interface InlineResponse2005PayloadScore { /** * Offer Score * @type {number} * @memberof InlineResponse2005PayloadScore */ offerScore?: number; /** * Content Score * @type {number} * @memberof InlineResponse2005PayloadScore */ contentScore?: number; /** * Rating Review Score * @type {number} * @memberof InlineResponse2005PayloadScore */ ratingReviewScore?: number; } /** * * @export * @interface InlineResponse2006 */ export interface InlineResponse2006 { /** * * @type {Array<InlineResponse2006Payload>} * @memberof InlineResponse2006 */ payload?: Array<InlineResponse2006Payload>; } /** * * @export * @interface InlineResponse2006Payload */ export interface InlineResponse2006Payload { /** * * @type {string} * @memberof InlineResponse2006Payload */ name?: string; /** * * @type {number} * @memberof InlineResponse2006Payload */ count?: number; /** * productType is only applicable for categories * @type {Array<InlineResponse2006ProductType>} * @memberof InlineResponse2006Payload */ productType?: Array<InlineResponse2006ProductType>; } /** * productType is only applicable for categories * @export * @interface InlineResponse2006ProductType */ export interface InlineResponse2006ProductType { /** * * @type {string} * @memberof InlineResponse2006ProductType */ name?: string; /** * * @type {number} * @memberof InlineResponse2006ProductType */ count?: number; } /** * * @export * @interface InlineResponse200Payload */ export interface InlineResponse200Payload { /** * * @type {string} * @memberof InlineResponse200Payload */ productId?: string; /** * * @type {InlineResponse200ScoreDetails} * @memberof InlineResponse200Payload */ scoreDetails?: InlineResponse200ScoreDetails; /** * * @type {string} * @memberof InlineResponse200Payload */ wfsEnabled?: string; /** * * @type {string} * @memberof InlineResponse200Payload */ priority?: string; /** * * @type {string} * @memberof InlineResponse200Payload */ productName?: string; /** * * @type {string} * @memberof InlineResponse200Payload */ itemId?: string; /** * * @type {string} * @memberof InlineResponse200Payload */ sellerId?: string; /** * * @type {string} * @memberof InlineResponse200Payload */ pageViews?: string; /** * * @type {InlineResponse200Stats} * @memberof InlineResponse200Payload */ stats?: InlineResponse200Stats; /** * * @type {string} * @memberof InlineResponse200Payload */ imageUrL?: string; /** * * @type {InlineResponse200QualityScore} * @memberof InlineResponse200Payload */ qualityScore?: InlineResponse200QualityScore; /** * * @type {string} * @memberof InlineResponse200Payload */ offerId?: string; /** * * @type {string} * @memberof InlineResponse200Payload */ sku?: string; /** * * @type {string} * @memberof InlineResponse200Payload */ category?: string; /** * * @type {string} * @memberof InlineResponse200Payload */ postPurchaseIssues?: string; /** * * @type {string} * @memberof InlineResponse200Payload */ productType?: string; } /** * * @export * @interface InlineResponse200QualityScore */ export interface InlineResponse200QualityScore { /** * * @type {number} * @memberof InlineResponse200QualityScore */ score?: number; /** * * @type {Array<InlineResponse200QualityScoreValues>} * @memberof InlineResponse200QualityScore */ values?: Array<InlineResponse200QualityScoreValues>; } /** * * @export * @interface InlineResponse200QualityScoreValues */ export interface InlineResponse200QualityScoreValues { /** * * @type {string} * @memberof InlineResponse200QualityScoreValues */ scoreType?: string; /** * * @type {number} * @memberof InlineResponse200QualityScoreValues */ scoreValue?: number; /** * * @type {string} * @memberof InlineResponse200QualityScoreValues */ impact?: string; } /** * * @export * @interface InlineResponse200ScoreDetails */ export interface InlineResponse200ScoreDetails { /** * * @type {InlineResponse200ScoreDetailsOffer} * @memberof InlineResponse200ScoreDetails */ offer?: InlineResponse200ScoreDetailsOffer; /** * * @type {InlineResponse200ScoreDetailsRatingReviews} * @memberof InlineResponse200ScoreDetails */ ratingReviews?: InlineResponse200ScoreDetailsRatingReviews; /** * * @type {InlineResponse200ScoreDetailsPostPurchase} * @memberof InlineResponse200ScoreDetails */ postPurchase?: InlineResponse200ScoreDetailsPostPurchase; /** * * @type {InlineResponse200ScoreDetailsContentAndDiscoverability} * @memberof InlineResponse200ScoreDetails */ contentAndDiscoverability?: InlineResponse200ScoreDetailsContentAndDiscoverability; } /** * * @export * @interface InlineResponse200ScoreDetailsContentAndDiscoverability */ export interface InlineResponse200ScoreDetailsContentAndDiscoverability { /** * * @type {number} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverability */ issueCount?: number; /** * * @type {Array<InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1>} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverability */ issues?: Array<InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1>; } /** * * @export * @interface InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues */ export interface InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues { /** * * @type {string} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues */ title?: string; /** * * @type {string} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues */ value?: string; } /** * * @export * @interface InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1 */ export interface InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1 { /** * * @type {number} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1 */ score?: number; /** * * @type {boolean} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1 */ isEditable?: boolean; /** * * @type {string} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1 */ attributeValue?: string; /** * * @type {boolean} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1 */ isSpecAttribute?: boolean; /** * * @type {string} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1 */ attributeName?: string; /** * * @type {number} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1 */ issueCount?: number; /** * * @type {Array<InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues>} * @memberof InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues1 */ issues?: Array<InlineResponse200ScoreDetailsContentAndDiscoverabilityIssues>; } /** * * @export * @interface InlineResponse200ScoreDetailsOffer */ export interface InlineResponse200ScoreDetailsOffer { /** * * @type {number} * @memberof InlineResponse200ScoreDetailsOffer */ issueCount?: number; /** * * @type {InlineResponse200ScoreDetailsOfferPrice} * @memberof InlineResponse200ScoreDetailsOffer */ price?: InlineResponse200ScoreDetailsOfferPrice; /** * * @type {InlineResponse200ScoreDetailsOfferShippingSpeed} * @memberof InlineResponse200ScoreDetailsOffer */ shippingSpeed?: InlineResponse200ScoreDetailsOfferShippingSpeed; /** * * @type {InlineResponse200ScoreDetailsOfferPublishAndTransactable} * @memberof InlineResponse200ScoreDetailsOffer */ publishAndTransactable?: InlineResponse200ScoreDetailsOfferPublishAndTransactable; } /** * * @export * @interface InlineResponse200ScoreDetailsOfferPrice */ export interface InlineResponse200ScoreDetailsOfferPrice { /** * The numerical value of the price * @type {string} * @memberof InlineResponse200ScoreDetailsOfferPrice */ amount?: string; /** * The currency type * @type {string} * @memberof InlineResponse200ScoreDetailsOfferPrice */ currency?: string; } /** * * @export * @interface InlineResponse200ScoreDetailsOfferPublishAndTransactable */ export interface InlineResponse200ScoreDetailsOfferPublishAndTransactable { /** * * @type {string} * @memberof InlineResponse200ScoreDetailsOfferPublishAndTransactable */ issueTitle?: string; /** * * @type {number} * @memberof InlineResponse200ScoreDetailsOfferPublishAndTransactable */ totalIssue?: number; /** * * @type {number} * @memberof InlineResponse200ScoreDetailsOfferPublishAndTransactable */ maxIssue?: number; /** * * @type {Array<InlineResponse200ScoreDetailsOfferPublishAndTransactableIssues>} * @memberof InlineResponse200ScoreDetailsOfferPublishAndTransactable */ issues?: Array<InlineResponse200ScoreDetailsOfferPublishAndTransactableIssues>; /** * * @type {number} * @memberof InlineResponse200ScoreDetailsOfferPublishAndTransactable */ score?: number; } /** * * @export * @interface InlineResponse200ScoreDetailsOfferPublishAndTransactableIssues */ export interface InlineResponse200ScoreDetailsOfferPublishAndTransactableIssues { /** * * @type {string} * @memberof InlineResponse200ScoreDetailsOfferPublishAndTransactableIssues */ date?: string; /** * * @type {boolean} * @memberof InlineResponse200ScoreDetailsOfferPublishAndTransactableIssues */ publishFlag?: boolean; /** * * @type {boolean} * @memberof InlineResponse200ScoreDetailsOfferPublishAndTransactableIssues */ transactableFlag?: boolean; } /** * * @export * @interface InlineResponse200ScoreDetailsOfferShippingSpeed */ export interface InlineResponse200ScoreDetailsOfferShippingSpeed { /** * * @type {string} * @memberof InlineResponse200ScoreDetailsOfferShippingSpeed */ shippingType?: string; /** * * @type {string} * @memberof InlineResponse200ScoreDetailsOfferShippingSpeed */ issueTitle?: string; /** * * @type {string} * @memberof InlineResponse200ScoreDetailsOfferShippingSpeed */ issueDesc?: string; /** * * @type {number} * @memberof InlineResponse200ScoreDetailsOfferShippingSpeed */ score?: number; } /** * * @export * @interface InlineResponse200ScoreDetailsPostPurchase */ export interface InlineResponse200ScoreDetailsPostPurchase { /** * * @type {InlineResponse200ScoreDetailsPostPurchaseCancellations} * @memberof InlineResponse200ScoreDetailsPostPurchase */ cancellations?: InlineResponse200ScoreDetailsPostPurchaseCancellations; /** * * @type {object} * @memberof InlineResponse200ScoreDetailsPostPurchase */ returns?: object; /** * * @type {string} * @memberof InlineResponse200ScoreDetailsPostPurchase */ issueCount?: string; /** * * @type {InlineResponse200ScoreDetailsPostPurchaseCancellations} * @memberof InlineResponse200ScoreDetailsPostPurchase */ otd?: InlineResponse200ScoreDetailsPostPurchaseCancellations; } /** * * @export * @interface InlineResponse200ScoreDetailsPostPurchaseCancellations */ export interface InlineResponse200ScoreDetailsPostPurchaseCancellations { /** * * @type {number} * @memberof InlineResponse200ScoreDetailsPostPurchaseCancellations */ defectedOrder?: number; /** * * @type {number} * @memberof InlineResponse200ScoreDetailsPostPurchaseCancellations */ totalOrder?: number; /** * * @type {number} * @memberof InlineResponse200ScoreDetailsPostPurchaseCancellations */ rate?: number; } /** * * @export * @interface InlineResponse200ScoreDetailsRatingReviews */ export interface InlineResponse200ScoreDetailsRatingReviews { /** * * @type {string} * @memberof InlineResponse200ScoreDetailsRatingReviews */ maxRating?: string; /** * * @type {string} * @memberof InlineResponse200ScoreDetailsRatingReviews */ ratingCount?: string; } /** * * @export * @interface InlineResponse200Stats */ export interface InlineResponse200Stats { /** * * @type {InlineResponse200StatsGmv} * @memberof InlineResponse200Stats */ gmv?: InlineResponse200StatsGmv; /** * * @type {string} * @memberof InlineResponse200Stats */ pageViews?: string; /** * * @type {string} * @memberof InlineResponse200Stats */ orders?: string; /** * * @type {string} * @memberof InlineResponse200Stats */ conversionRate?: string; /** * * @type {string} * @memberof InlineResponse200Stats */ totalUnits?: string; } /** * * @export * @interface InlineResponse200StatsGmv */ export interface InlineResponse200StatsGmv { /** * * @type {string} * @memberof InlineResponse200StatsGmv */ amount?: string; /** * * @type {string} * @memberof InlineResponse200StatsGmv */ currency?: string; } /** * * @export * @interface Issue */ export interface Issue { /** * * @type {string} * @memberof Issue */ date?: string; /** * * @type {boolean} * @memberof Issue */ publishFlag?: boolean; /** * * @type {boolean} * @memberof Issue */ transactableFlag?: boolean; } /** * * @export * @interface ItemDetailsForListingQualityPayload */ export interface ItemDetailsForListingQualityPayload { /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ productId?: string; /** * * @type {InlineResponse200ScoreDetails} * @memberof ItemDetailsForListingQualityPayload */ scoreDetails?: InlineResponse200ScoreDetails; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ wfsEnabled?: string; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ priority?: string; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ productName?: string; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ itemId?: string; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ sellerId?: string; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ pageViews?: string; /** * * @type {InlineResponse200Stats} * @memberof ItemDetailsForListingQualityPayload */ stats?: InlineResponse200Stats; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ imageUrL?: string; /** * * @type {InlineResponse200QualityScore} * @memberof ItemDetailsForListingQualityPayload */ qualityScore?: InlineResponse200QualityScore; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ offerId?: string; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ sku?: string; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ category?: string; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ postPurchaseIssues?: string; /** * * @type {string} * @memberof ItemDetailsForListingQualityPayload */ productType?: string; } /** * * @export * @interface ItemDetailsLQRequestPayload */ export interface ItemDetailsLQRequestPayload { /** * * @type {V3InsightsItemsListingQualityItemsQuery} * @memberof ItemDetailsLQRequestPayload */ query?: V3InsightsItemsListingQualityItemsQuery; /** * * @type {Array<V3InsightsItemsListingQualityItemsFilters>} * @memberof ItemDetailsLQRequestPayload */ filters?: Array<V3InsightsItemsListingQualityItemsFilters>; } /** * * @export * @interface ItemDetailsLQResponsePayload */ export interface ItemDetailsLQResponsePayload { /** * * @type {string} * @memberof ItemDetailsLQResponsePayload */ nextCursor?: string; /** * * @type {string} * @memberof ItemDetailsLQResponsePayload */ totalItems?: string; /** * * @type {Array<InlineResponse200Payload>} * @memberof ItemDetailsLQResponsePayload */ payload?: Array<InlineResponse200Payload>; /** * * @type {string} * @memberof ItemDetailsLQResponsePayload */ status?: string; } /** * * @export * @interface ListingQualityScorePayload */ export interface ListingQualityScorePayload { /** * Over All Quality * @type {number} * @memberof ListingQualityScorePayload */ overAllQuality?: number; /** * * @type {InlineResponse2005PayloadScore} * @memberof ListingQualityScorePayload */ score?: InlineResponse2005PayloadScore; /** * * @type {InlineResponse2005PayloadPostPurchaseQuality} * @memberof ListingQualityScorePayload */ postPurchaseQuality?: InlineResponse2005PayloadPostPurchaseQuality; } /** * * @export * @interface MarketPrice */ export interface MarketPrice { /** * The numerical value of the price * @type {string} * @memberof MarketPrice */ amount?: string; /** * The currency type * @type {string} * @memberof MarketPrice */ currency?: string; } /** * Shows whether the seller has met the requirements for the badge. * @export * @interface MeetsCriteria */ export interface MeetsCriteria { /** * Indicates whether the seller has met the minimum number of orders required. * @type {boolean} * @memberof MeetsCriteria */ isOrdersCriteriaMet?: boolean; /** * Indicates whether the seller has a low delivery defect, meeting the threshold for the badge. * @type {boolean} * @memberof MeetsCriteria */ isDeliveryDefectCriteriaMet?: boolean; /** * Indicates whether the seller has a low cancellation rate, meeting the threshold for the badge. * @type {boolean} * @memberof MeetsCriteria */ isCancellationCriteriaMet?: boolean; /** * Indicates whether the seller is meeting the trending catalog requirement. * @type {boolean} * @memberof MeetsCriteria */ isListingQualityCatalogCriteriaMet?: boolean; /** * Indicates whether the seller has met the minimum number of active days required. * @type {boolean} * @memberof MeetsCriteria */ isActiveDaysCriteriaMet?: boolean; } /** * * @export * @interface Offer */ export interface Offer { /** * * @type {number} * @memberof Offer */ issueCount?: number; /** * * @type {InlineResponse200ScoreDetailsOfferPrice} * @memberof Offer */ price?: InlineResponse200ScoreDetailsOfferPrice; /** * * @type {InlineResponse200ScoreDetailsOfferShippingSpeed} * @memberof Offer */ shippingSpeed?: InlineResponse200ScoreDetailsOfferShippingSpeed; /** * * @type {InlineResponse200ScoreDetailsOfferPublishAndTransactable} * @memberof Offer */ publishAndTransactable?: InlineResponse200ScoreDetailsOfferPublishAndTransactable; } /** * * @export * @interf