ebay-api 9.1.1 → 9.2.0

package/dist/errors/index.js

@@ -177,9 +177,17 @@ export const handleEBayError = (error) => {
     throw new EBayApiError(message, description, meta, errorCode, firstError);
 };
 export const checkEBayTraditionalResponse = (apiResponse, data) => {
+    if (!data) {
+        log('checkEBayTraditionalResponse: No data found in response.');
+        return;
+    }
     if (!('Errors' in data) && !('errorMessage' in data)) {
         return;
     }
+    if ('Errors' in data && data.Ack !== 'Failure') {
+        log(`checkEBayTraditionalResponse: eBay API returned ${data.Ack}`);
+        return;
+    }
     const { message, meta, description, errorCode, firstError } = extractEBayError(apiResponse, data);
     if (typeof errorCode === 'undefined') {
         throw new EBayApiError(message, description, meta, errorCode, firstError);

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

@@ -0,0 +1,154 @@
+export interface paths {
+    "/rate_table/{rate_table_id}": {
+        get: operations["getRateTable"];
+    };
+    "/rate_table/{rate_table_id}/update_shipping_cost": {
+        post: operations["updateShippingCost"];
+    };
+    "/payout_settings": {
+        get: operations["getPayoutSettings"];
+    };
+    "/payout_settings/update_percentage": {
+        post: operations["updatePayoutPercentage"];
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        Amount: {
+            currency?: string;
+            value?: string;
+        };
+        Error: {
+            category?: string;
+            domain?: string;
+            errorId?: number;
+            inputRefIds?: (string)[];
+            longMessage?: string;
+            message?: string;
+            outputRefIds?: (string)[];
+            parameters?: (components["schemas"]["ErrorParameter"])[];
+            subdomain?: string;
+        };
+        ErrorParameter: {
+            name?: string;
+            value?: string;
+        };
+        PayoutInstrument: {
+            accountLastFourDigits?: string;
+            instrumentId?: string;
+            instrumentStatus?: string;
+            instrumentType?: string;
+            nickname?: string;
+            payoutPercentage?: string;
+        };
+        PayoutSettingsResponse: {
+            payoutInstruments?: (components["schemas"]["PayoutInstrument"])[];
+        };
+        Rate: {
+            additionalCost?: components["schemas"]["Amount"];
+            rateId?: string;
+            shippingCategory?: string;
+            shippingCost?: components["schemas"]["Amount"];
+            shippingRegionNames?: (string)[];
+            shippingServiceCode?: string;
+        };
+        RateTableDetails: {
+            marketplaceId?: string;
+            name?: string;
+            rates?: (components["schemas"]["Rate"])[];
+            rateTableBasis?: string;
+            rateTableId?: string;
+            shippingOptionType?: string;
+        };
+        RateTableUpdate: {
+            rates?: (components["schemas"]["RateUpdate"])[];
+        };
+        RateUpdate: {
+            additionalCost?: components["schemas"]["Amount"];
+            rateId?: string;
+            shippingCost?: components["schemas"]["Amount"];
+        };
+        UpdatePayoutPercentage: {
+            instrumentId?: string;
+            payoutPercentage?: string;
+        };
+        UpdatePayoutPercentageRequest: {
+            payoutInstruments?: (components["schemas"]["UpdatePayoutPercentage"])[];
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type external = Record<string, never>;
+export interface operations {
+    getRateTable: {
+        parameters: {
+            path: {
+                rate_table_id: string;
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": components["schemas"]["RateTableDetails"];
+                };
+            };
+            400: never;
+            404: never;
+            500: never;
+        };
+    };
+    updateShippingCost: {
+        parameters: {
+            header: {
+                "Content-Type": string;
+            };
+            path: {
+                rate_table_id: string;
+            };
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["RateTableUpdate"];
+            };
+        };
+        responses: {
+            204: never;
+            400: never;
+            404: never;
+            409: never;
+            500: never;
+        };
+    };
+    getPayoutSettings: {
+        responses: {
+            200: {
+                content: {
+                    "application/json": components["schemas"]["PayoutSettingsResponse"];
+                };
+            };
+            500: never;
+        };
+    };
+    updatePayoutPercentage: {
+        parameters: {
+            header: {
+                "Content-Type": string;
+            };
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["UpdatePayoutPercentageRequest"];
+            };
+        };
+        responses: {
+            204: never;
+            400: never;
+            500: never;
+        };
+    };
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -29,6 +29,11 @@ export interface paths {
     "/bulk_migrate_listing": {
         post: operations["bulkMigrateListing"];
     };
+    "/listing/{listingId}/sku/{sku}/locations": {
+        get: operations["getSkuLocationMapping"];
+        put: operations["createOrReplaceSkuLocationMapping"];
+        delete: operations["deleteSkuLocationMapping"];
+    };
     "/bulk_create_offer": {
         post: operations["bulkCreateOffer"];
     };
@@ -47,10 +52,10 @@ export interface paths {
     "/offer/get_listing_fees": {
         post: operations["getListingFees"];
     };
-    "/offer/{offerId}/publish/": {
+    "/offer/{offerId}/publish": {
         post: operations["publishOffer"];
     };
-    "/offer/publish_by_inventory_item_group/": {
+    "/offer/publish_by_inventory_item_group": {
         post: operations["publishOfferByInventoryItemGroup"];
     };
     "/offer/{offerId}/withdraw": {
@@ -169,12 +174,19 @@ export interface components {
             name?: string;
             values?: (string)[];
         };
+        CountryPolicy: {
+            country?: string;
+            policyIds?: (string)[];
+        };
         Dimension: {
             height?: number;
             length?: number;
             unit?: string;
             width?: number;
         };
+        Document: {
+            documentId?: string;
+        };
         EbayOfferDetailsWithAll: {
             availableQuantity?: number;
             categoryId?: string;
@@ -288,6 +300,9 @@ export interface components {
             auction?: number;
             fixedPrice?: number;
         };
+        FulfillmentCenterSpecifications: {
+            sameDayShippingCutOffTimes?: components["schemas"]["SameDayShippingCutOffTimes"];
+        };
         GeoCoordinates: {
             latitude?: number;
             longitude?: number;
@@ -385,13 +400,17 @@ export interface components {
             total?: number;
         };
         InventoryLocation: {
+            location?: components["schemas"]["LocationDetails"];
             locationAdditionalInformation?: string;
             locationInstructions?: string;
+            locationTypes?: (string)[];
             locationWebUrl?: string;
             name?: string;
             operatingHours?: (components["schemas"]["OperatingHours"])[];
             phone?: string;
             specialHours?: (components["schemas"]["SpecialHours"])[];
+            timeZoneId?: string;
+            fulfillmentCenterSpecifications?: components["schemas"]["FulfillmentCenterSpecifications"];
         };
         InventoryLocationFull: {
             location?: components["schemas"]["LocationDetails"];
@@ -404,6 +423,8 @@ export interface components {
             operatingHours?: (components["schemas"]["OperatingHours"])[];
             phone?: string;
             specialHours?: (components["schemas"]["SpecialHours"])[];
+            timeZoneId?: string;
+            fulfillmentCenterSpecifications?: components["schemas"]["FulfillmentCenterSpecifications"];
         };
         InventoryLocationResponse: {
             location?: components["schemas"]["Location"];
@@ -417,9 +438,12 @@ export interface components {
             operatingHours?: (components["schemas"]["OperatingHours"])[];
             phone?: string;
             specialHours?: (components["schemas"]["SpecialHours"])[];
+            timeZoneId?: string;
+            fulfillmentCenterSpecifications?: components["schemas"]["FulfillmentCenterSpecifications"];
         };
         ListingDetails: {
             listingId?: string;
+            listingOnHold?: boolean;
             listingStatus?: string;
             soldQuantity?: number;
         };
@@ -440,10 +464,16 @@ export interface components {
             geoCoordinates?: components["schemas"]["GeoCoordinates"];
             locationId?: string;
         };
+        LocationAvailabilityDetails: {
+            merchantLocationKey?: string;
+        };
         LocationDetails: {
             address?: components["schemas"]["Address"];
             geoCoordinates?: components["schemas"]["GeoCoordinates"];
         };
+        LocationMapping: {
+            locations?: (components["schemas"]["LocationAvailabilityDetails"])[];
+        };
         LocationResponse: {
             href?: string;
             limit?: number;
@@ -453,6 +483,17 @@ export interface components {
             total?: number;
             locations?: (components["schemas"]["InventoryLocationResponse"])[];
         };
+        Manufacturer: {
+            addressLine1?: string;
+            addressLine2?: string;
+            city?: string;
+            companyName?: string;
+            country?: string;
+            email?: string;
+            phone?: string;
+            postalCode?: string;
+            stateOrProvince?: string;
+        };
         MigrateListing: {
             listingId?: string;
         };
@@ -513,9 +554,15 @@ export interface components {
             dayOfWeekEnum?: string;
             intervals?: (components["schemas"]["Interval"])[];
         };
+        Overrides: {
+            cutOffTime?: string;
+            endDate?: string;
+            startDate?: string;
+        };
         PackageWeightAndSize: {
             dimensions?: components["schemas"]["Dimension"];
             packageType?: string;
+            shippingIrregular?: boolean;
             weight?: components["schemas"]["Weight"];
         };
         PickupAtLocationAvailability: {
@@ -571,6 +618,11 @@ export interface components {
             gtin?: string;
             ktype?: string;
         };
+        ProductSafety: {
+            component?: string;
+            pictograms?: (string)[];
+            statements?: (string)[];
+        };
         PublishByInventoryItemGroupRequest: {
             inventoryItemGroupKey?: string;
             marketplaceId?: string;
@@ -580,15 +632,35 @@ export interface components {
             warnings?: (components["schemas"]["Error"])[];
         };
         RegionalProductCompliancePolicies: {
-            countryPolicies?: (string)[];
+            countryPolicies?: (components["schemas"]["CountryPolicy"])[];
         };
         RegionalTakeBackPolicies: {
-            countryPolicies?: (string)[];
+            countryPolicies?: (components["schemas"]["CountryPolicy"])[];
         };
         Regulatory: {
+            documents?: (components["schemas"]["Document"])[];
             energyEfficiencyLabel?: components["schemas"]["EnergyEfficiencyLabel"];
             hazmat?: components["schemas"]["Hazmat"];
+            manufacturer?: components["schemas"]["Manufacturer"];
+            productSafety?: components["schemas"]["ProductSafety"];
             repairScore?: number;
+            responsiblePersons?: (components["schemas"]["ResponsiblePerson"])[];
+        };
+        ResponsiblePerson: {
+            addressLine1?: string;
+            addressLine2?: string;
+            city?: string;
+            companyName?: string;
+            country?: string;
+            email?: string;
+            phone?: string;
+            postalCode?: string;
+            stateOrProvince?: string;
+            types?: (string)[];
+        };
+        SameDayShippingCutOffTimes: {
+            overrides?: (components["schemas"]["Overrides"])[];
+            weeklySchedule?: (components["schemas"]["WeeklySchedule"])[];
         };
         ShipToLocationAvailability: {
             availabilityDistributions?: (components["schemas"]["AvailabilityDistribution"])[];
@@ -631,6 +703,10 @@ export interface components {
             instance?: components["schemas"]["Version"];
             version?: string;
         };
+        WeeklySchedule: {
+            cutOffTime?: string;
+            dayOfWeekEnum?: (string)[];
+        };
         Weight: {
             unit?: string;
             value?: number;
@@ -960,6 +1036,59 @@ export interface operations {
             500: never;
         };
     };
+    getSkuLocationMapping: {
+        parameters: {
+            path: {
+                listingId: string;
+                sku: string;
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": components["schemas"]["LocationMapping"];
+                };
+            };
+            400: never;
+            404: never;
+            500: never;
+        };
+    };
+    createOrReplaceSkuLocationMapping: {
+        parameters: {
+            header: {
+                "Content-Type": string;
+            };
+            path: {
+                listingId: string;
+                sku: string;
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LocationMapping"];
+            };
+        };
+        responses: {
+            204: never;
+            400: never;
+            500: never;
+        };
+    };
+    deleteSkuLocationMapping: {
+        parameters: {
+            path: {
+                listingId: string;
+                sku: string;
+            };
+        };
+        responses: {
+            204: never;
+            400: never;
+            404: never;
+            500: never;
+        };
+    };
     bulkCreateOffer: {
         parameters: {
             header: {

package/dist/types/restfulTypes.d.ts

@@ -7,7 +7,8 @@ import { operations as commerceCatalogOperations } from './restful/specs/commerc
 import { components as commerceMedia } from './restful/specs/commerce_media_v1_beta_oas3.js';
 import { components as commerceNotification } from './restful/specs/commerce_notification_v1_oas3.js';
 import { components as commerceTranslation } from './restful/specs/commerce_translation_v1_beta_oas3.js';
-import { components as sellAccount } from './restful/specs/sell_account_v1_oas3.js';
+import { components as sellAccountV1 } from './restful/specs/sell_account_v1_oas3.js';
+import { components as sellAccountV2 } from './restful/specs/sell_account_v2_oas3.js';
 import { components as sellCompliance } from './restful/specs/sell_compliance_v1_oas3.js';
 import { components as sellFulfillment } from './restful/specs/sell_fulfillment_v1_oas3.js';
 import { components as sellInventory } from './restful/specs/sell_inventory_v1_oas3.js';
@@ -380,13 +381,15 @@ export type UpdatePaymentInformation = buyOrder['schemas']['UpdatePaymentInforma
 export type UpdateQuantity = buyOrder['schemas']['UpdateQuantity'];
 export type UpdateShippingOption = buyOrder['schemas']['UpdateShippingOption'];
 export type SuppressViolationRequest = sellCompliance['schemas']['SuppressViolationRequest'];
-export type CustomPolicyCreateRequest = sellAccount['schemas']['CustomPolicyCreateRequest'];
-export type CustomPolicyRequest = sellAccount['schemas']['CustomPolicyRequest'];
-export type FulfillmentPolicyRequest = sellAccount['schemas']['FulfillmentPolicyRequest'];
-export type FulfillmentSellAccountProgram = sellAccount['schemas']['Program'];
-export type PaymentPolicyRequest = sellAccount['schemas']['PaymentPolicyRequest'];
-export type ReturnPolicyRequest = sellAccount['schemas']['ReturnPolicyRequest'];
-export type SalesTaxBase = sellAccount['schemas']['SalesTaxBase'];
+export type CustomPolicyCreateRequest = sellAccountV1['schemas']['CustomPolicyCreateRequest'];
+export type CustomPolicyRequest = sellAccountV1['schemas']['CustomPolicyRequest'];
+export type FulfillmentPolicyRequest = sellAccountV1['schemas']['FulfillmentPolicyRequest'];
+export type FulfillmentSellAccountProgram = sellAccountV1['schemas']['Program'];
+export type PaymentPolicyRequest = sellAccountV1['schemas']['PaymentPolicyRequest'];
+export type ReturnPolicyRequest = sellAccountV1['schemas']['ReturnPolicyRequest'];
+export type SalesTaxBase = sellAccountV1['schemas']['SalesTaxBase'];
+export type RateTableUpdate = sellAccountV2['schemas']['RateTableUpdate'];
+export type UpdatePayoutPercentageRequest = sellAccountV2['schemas']['UpdatePayoutPercentageRequest'];
 export type LineItemReference = sellFulfillment['schemas']['LineItemReference'];
 export type UpdateEvidencePaymentDisputeRequest = sellFulfillment['schemas']['UpdateEvidencePaymentDisputeRequest'];
 export type RefundItem = sellFulfillment['schemas']['RefundItem'];
@@ -410,6 +413,7 @@ export type OfferKeysWithId = sellInventory['schemas']['OfferKeysWithId'];
 export type PublishByInventoryItemGroupRequest = sellInventory['schemas']['PublishByInventoryItemGroupRequest'];
 export type WithdrawByInventoryItemGroupRequest = sellInventory['schemas']['WithdrawByInventoryItemGroupRequest'];
 export type InventoryItem = sellInventory['schemas']['InventoryItem'];
+export type LocationMapping = sellInventory['schemas']['LocationMapping'];
 export type BulkCreateAdRequest = sellMarketing['schemas']['BulkCreateAdRequest'];
 export type BulkCreateAdsByInventoryReferenceRequest = sellMarketing['schemas']['BulkCreateAdsByInventoryReferenceRequest'];
 export type BulkCreateKeywordRequest = sellMarketing['schemas']['BulkCreateKeywordRequest'];

package/lib/api/apiFactory.js

@@ -53,7 +53,8 @@ class ApiFactory extends index_js_1.default {
     }
     createSellApi() {
         return {
-            account: this.createRestfulApi(index_js_6.Account),
+            account: this.createRestfulApi(index_js_6.AccountV1),
+            accountV2: this.createRestfulApi(index_js_6.AccountV2),
             analytics: this.createRestfulApi(index_js_6.Analytics),
             compliance: this.createRestfulApi(index_js_6.Compliance),
             fulfillment: this.createRestfulApi(index_js_6.Fulfillment),

package/lib/api/restful/developer/analytics/index.d.ts

@@ -3,6 +3,6 @@ import Restful, { OpenApi } from '../../index.js';
 export default class Analytics extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    getRateLimits(apiContext: string, apiName: string): Promise<any>;
+    getRateLimits(apiContext?: string, apiName?: string): Promise<any>;
     getUserRateLimits(apiContext: string, apiName: string): Promise<any>;
 }

package/lib/api/restful/sell/account/{index.d.ts → v1.d.ts}

@@ -2,7 +2,7 @@ import { PaymentsProgramType } from '../../../../enums/index.js';
 import { CustomPolicyCreateRequest, CustomPolicyRequest, FulfillmentPolicyRequest, FulfillmentSellAccountProgram, InventoryLocation, InventoryLocationFull, PaymentPolicyRequest, ReturnPolicyRequest, SalesTaxBase } from '../../../../types/index.js';
 import { operations } from '../../../../types/restful/specs/sell_account_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-export default class Account extends Restful implements OpenApi<operations> {
+export default class AccountV1 extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
     getCustomPolicies(policyTypes: string): Promise<any>;

package/lib/api/restful/sell/account/{index.js → v1.js}

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../index.js"));
-class Account extends index_js_1.default {
+class AccountV1 extends index_js_1.default {
     get basePath() {
         return '/sell/account/v1';
     }
@@ -221,5 +221,5 @@ class Account extends index_js_1.default {
         return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
     }
 }
-Account.id = 'Account';
-exports.default = Account;
+AccountV1.id = 'AccountV1';
+exports.default = AccountV1;

package/lib/api/restful/sell/account/v2.d.ts

@@ -0,0 +1,11 @@
+import { RateTableUpdate, UpdatePayoutPercentageRequest } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/sell_account_v2_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+export default class AccountV2 extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    getRateTable(rateTableId: string): Promise<any>;
+    updateShippingCost(rateTableId: string, body: RateTableUpdate): Promise<any>;
+    getPayoutSettings(): Promise<any>;
+    updatePayoutPercentage(body: UpdatePayoutPercentageRequest): Promise<any>;
+}

package/lib/api/restful/sell/account/v2.js

@@ -0,0 +1,27 @@
+"use strict";
+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"));
+class AccountV2 extends index_js_1.default {
+    get basePath() {
+        return '/sell/account/v2';
+    }
+    getRateTable(rateTableId) {
+        rateTableId = encodeURIComponent(rateTableId);
+        return this.get(`/rate_table/${rateTableId}`);
+    }
+    updateShippingCost(rateTableId, body) {
+        rateTableId = encodeURIComponent(rateTableId);
+        return this.post(`/rate_table/${rateTableId}/update_shipping_cost`, body);
+    }
+    getPayoutSettings() {
+        return this.get('/payout_settings');
+    }
+    updatePayoutPercentage(body) {
+        return this.post(`/payout_settings/update_percentage`, body);
+    }
+}
+AccountV2.id = 'AccountV2';
+exports.default = AccountV2;

package/lib/api/restful/sell/feed/index.js

@@ -73,7 +73,10 @@ class Feed extends index_js_1.default {
     }
     getLatestResultFile(scheduleId) {
         scheduleId = encodeURIComponent(scheduleId);
-        return this.get(`/schedule/${scheduleId}/download_result_file`);
+        return this.get(`/schedule/${scheduleId}/download_result_file`, {
+            responseType: 'arraybuffer',
+            responseEncoding: 'binary',
+        });
     }
     getScheduleTemplate(scheduleTemplateId) {
         scheduleTemplateId = encodeURIComponent(scheduleTemplateId);
@@ -109,7 +112,10 @@ class Feed extends index_js_1.default {
     }
     getResultFile(taskId) {
         taskId = encodeURIComponent(taskId);
-        return this.get(`/task/${taskId}/download_result_file`);
+        return this.get(`/task/${taskId}/download_result_file`, {
+            responseType: 'arraybuffer',
+            responseEncoding: 'binary',
+        });
     }
     getTask(taskId) {
         taskId = encodeURIComponent(taskId);

package/lib/api/restful/sell/fulfillment/index.d.ts

@@ -12,7 +12,7 @@ export default class Fulfillment extends Restful implements OpenApi<operations>
         limit?: number;
         offset?: number;
         orderIds?: string | string[];
-        fieldGroups?: string[];
+        fieldGroups?: string;
     }): Promise<any>;
     issueRefund(orderId: string, body?: IssueRefundRequest): Promise<any>;
     getShippingFulfillments(orderId: string): Promise<any>;

package/lib/api/restful/sell/index.d.ts

@@ -1,4 +1,5 @@
-import Account from './account/index.js';
+import AccountV1 from './account/v1.js';
+import AccountV2 from './account/v2.js';
 import Analytics from './analytics/index.js';
 import Compliance from './compliance/index.js';
 import Finances from './finances/index.js';
@@ -12,7 +13,8 @@ import Logistics from './logistics/index.js';
 import Negotiation from './negotiation/index.js';
 import Listing from './listing/index.js';
 export type Sell = {
-    account: Account;
+    account: AccountV1;
+    accountV2: AccountV2;
     analytics: Analytics;
     compliance: Compliance;
     fulfillment: Fulfillment;
@@ -26,4 +28,4 @@ export type Sell = {
     negotiation: Negotiation;
     listing: Listing;
 };
-export { Account, Compliance, Analytics, Fulfillment, Inventory, Marketing, Metadata, Recommendation, Finances, Feed, Logistics, Negotiation, Listing };
+export { AccountV1, AccountV2, Compliance, Analytics, Fulfillment, Inventory, Marketing, Metadata, Recommendation, Finances, Feed, Logistics, Negotiation, Listing };