ebay-api 1.13.7 → 6.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +18 -19
- package/README.md +512 -118
- package/lib/api/apiFactory.d.ts +27 -0
- package/lib/api/apiFactory.js +100 -0
- package/lib/api/apiFactory.js.map +1 -0
- package/lib/api/base.d.ts +13 -0
- package/lib/api/base.js +25 -0
- package/lib/api/base.js.map +1 -0
- package/lib/api/index.d.ts +11 -0
- package/lib/api/index.js +18 -0
- package/lib/api/index.js.map +1 -0
- package/lib/api/restful/buy/browse/index.d.ts +84 -0
- package/lib/api/restful/buy/browse/index.js +142 -0
- package/lib/api/restful/buy/browse/index.js.map +1 -0
- package/lib/api/restful/buy/deal/index.d.ts +55 -0
- package/lib/api/restful/buy/deal/index.js +80 -0
- package/lib/api/restful/buy/deal/index.js.map +1 -0
- package/lib/api/restful/buy/feed/index.d.ts +43 -0
- package/lib/api/restful/buy/feed/index.js +85 -0
- package/lib/api/restful/buy/feed/index.js.map +1 -0
- package/lib/api/restful/buy/index.d.ts +17 -0
- package/lib/api/restful/buy/index.js +21 -0
- package/lib/api/restful/buy/index.js.map +1 -0
- package/lib/api/restful/buy/marketing/index.d.ts +27 -0
- package/lib/api/restful/buy/marketing/index.js +51 -0
- package/lib/api/restful/buy/marketing/index.js.map +1 -0
- package/lib/api/restful/buy/marketplaceInsights/index.d.ts +28 -0
- package/lib/api/restful/buy/marketplaceInsights/index.js +51 -0
- package/lib/api/restful/buy/marketplaceInsights/index.js.map +1 -0
- package/lib/api/restful/buy/offer/index.d.ts +23 -0
- package/lib/api/restful/buy/offer/index.js +37 -0
- package/lib/api/restful/buy/offer/index.js.map +1 -0
- package/lib/api/restful/buy/order/index.d.ts +264 -0
- package/lib/api/restful/buy/order/index.js +369 -0
- package/lib/api/restful/buy/order/index.js.map +1 -0
- package/lib/api/restful/commerce/catalog/index.d.ts +73 -0
- package/lib/api/restful/commerce/catalog/index.js +108 -0
- package/lib/api/restful/commerce/catalog/index.js.map +1 -0
- package/lib/api/restful/commerce/charity/index.d.ts +34 -0
- package/lib/api/restful/commerce/charity/index.js +56 -0
- package/lib/api/restful/commerce/charity/index.js.map +1 -0
- package/lib/api/restful/commerce/identity/index.d.ts +14 -0
- package/lib/api/restful/commerce/identity/index.js +27 -0
- package/lib/api/restful/commerce/identity/index.js.map +1 -0
- package/lib/api/restful/commerce/index.d.ts +15 -0
- package/lib/api/restful/commerce/index.js +19 -0
- package/lib/api/restful/commerce/index.js.map +1 -0
- package/lib/api/restful/commerce/notification/index.d.ts +117 -0
- package/lib/api/restful/commerce/notification/index.js +187 -0
- package/lib/api/restful/commerce/notification/index.js.map +1 -0
- package/lib/api/restful/commerce/taxonomy/index.d.ts +78 -0
- package/lib/api/restful/commerce/taxonomy/index.js +135 -0
- package/lib/api/restful/commerce/taxonomy/index.js.map +1 -0
- package/lib/api/restful/commerce/translation/index.d.ts +15 -0
- package/lib/api/restful/commerce/translation/index.js +25 -0
- package/lib/api/restful/commerce/translation/index.js.map +1 -0
- package/lib/api/restful/developer/analytics/index.d.ts +22 -0
- package/lib/api/restful/developer/analytics/index.js +45 -0
- package/lib/api/restful/developer/analytics/index.js.map +1 -0
- package/lib/api/restful/developer/index.d.ts +5 -0
- package/lib/api/restful/developer/index.js +9 -0
- package/lib/api/restful/developer/index.js.map +1 -0
- package/lib/api/restful/index.d.ts +63 -0
- package/lib/api/restful/index.js +165 -0
- package/lib/api/restful/index.js.map +1 -0
- package/lib/api/restful/postOrder/cancellation/index.d.ts +57 -0
- package/lib/api/restful/postOrder/cancellation/index.js +95 -0
- package/lib/api/restful/postOrder/cancellation/index.js.map +1 -0
- package/lib/api/restful/postOrder/case/index.d.ts +63 -0
- package/lib/api/restful/postOrder/case/index.js +97 -0
- package/lib/api/restful/postOrder/case/index.js.map +1 -0
- package/lib/api/restful/postOrder/index.d.ts +11 -0
- package/lib/api/restful/postOrder/index.js +15 -0
- package/lib/api/restful/postOrder/index.js.map +1 -0
- package/lib/api/restful/postOrder/inquiry/index.d.ts +82 -0
- package/lib/api/restful/postOrder/inquiry/index.js +131 -0
- package/lib/api/restful/postOrder/inquiry/index.js.map +1 -0
- package/lib/api/restful/postOrder/return/index.d.ts +231 -0
- package/lib/api/restful/postOrder/return/index.js +361 -0
- package/lib/api/restful/postOrder/return/index.js.map +1 -0
- package/lib/api/restful/sell/account/index.d.ts +217 -0
- package/lib/api/restful/sell/account/index.js +337 -0
- package/lib/api/restful/sell/account/index.js.map +1 -0
- package/lib/api/restful/sell/analytics/index.d.ts +41 -0
- package/lib/api/restful/sell/analytics/index.js +61 -0
- package/lib/api/restful/sell/analytics/index.js.map +1 -0
- package/lib/api/restful/sell/compliance/index.d.ts +37 -0
- package/lib/api/restful/sell/compliance/index.js +57 -0
- package/lib/api/restful/sell/compliance/index.js.map +1 -0
- package/lib/api/restful/sell/feed/index.d.ts +151 -0
- package/lib/api/restful/sell/feed/index.js +255 -0
- package/lib/api/restful/sell/feed/index.js.map +1 -0
- package/lib/api/restful/sell/finances/index.d.ts +74 -0
- package/lib/api/restful/sell/finances/index.js +105 -0
- package/lib/api/restful/sell/finances/index.js.map +1 -0
- package/lib/api/restful/sell/fulfillment/index.d.ts +137 -0
- package/lib/api/restful/sell/fulfillment/index.js +199 -0
- package/lib/api/restful/sell/fulfillment/index.js.map +1 -0
- package/lib/api/restful/sell/index.d.ts +29 -0
- package/lib/api/restful/sell/index.js +33 -0
- package/lib/api/restful/sell/index.js.map +1 -0
- package/lib/api/restful/sell/inventory/index.d.ts +248 -0
- package/lib/api/restful/sell/inventory/index.js +346 -0
- package/lib/api/restful/sell/inventory/index.js.map +1 -0
- package/lib/api/restful/sell/listing/index.d.ts +14 -0
- package/lib/api/restful/sell/listing/index.js +25 -0
- package/lib/api/restful/sell/listing/index.js.map +1 -0
- package/lib/api/restful/sell/logistics/index.d.ts +44 -0
- package/lib/api/restful/sell/logistics/index.js +66 -0
- package/lib/api/restful/sell/logistics/index.js.map +1 -0
- package/lib/api/restful/sell/marketing/index.d.ts +443 -0
- package/lib/api/restful/sell/marketing/index.js +609 -0
- package/lib/api/restful/sell/marketing/index.js.map +1 -0
- package/lib/api/restful/sell/metadata/index.d.ts +77 -0
- package/lib/api/restful/sell/metadata/index.js +131 -0
- package/lib/api/restful/sell/metadata/index.js.map +1 -0
- package/lib/api/restful/sell/negotiation/index.d.ts +24 -0
- package/lib/api/restful/sell/negotiation/index.js +39 -0
- package/lib/api/restful/sell/negotiation/index.js.map +1 -0
- package/lib/api/restful/sell/recommendation/index.d.ts +26 -0
- package/lib/api/restful/sell/recommendation/index.js +39 -0
- package/lib/api/restful/sell/recommendation/index.js.map +1 -0
- package/lib/api/traditional/XMLRequest.d.ts +98 -0
- package/lib/api/traditional/XMLRequest.js +191 -0
- package/lib/api/traditional/XMLRequest.js.map +1 -0
- package/lib/api/traditional/clientAlerts/index.d.ts +9 -0
- package/lib/api/traditional/clientAlerts/index.js +15 -0
- package/lib/api/traditional/clientAlerts/index.js.map +1 -0
- package/lib/api/traditional/clientAlerts/types.d.ts +31 -0
- package/lib/api/traditional/clientAlerts/types.js +36 -0
- package/lib/api/traditional/clientAlerts/types.js.map +1 -0
- package/lib/api/traditional/fields.d.ts +1948 -0
- package/lib/api/traditional/fields.js +1949 -0
- package/lib/api/traditional/fields.js.map +1 -0
- package/lib/api/traditional/finding/index.d.ts +12 -0
- package/lib/api/traditional/finding/index.js +16 -0
- package/lib/api/traditional/finding/index.js.map +1 -0
- package/lib/api/traditional/index.d.ts +17 -0
- package/lib/api/traditional/index.js +207 -0
- package/lib/api/traditional/index.js.map +1 -0
- package/lib/api/traditional/merchandising/index.d.ts +7 -0
- package/lib/api/traditional/merchandising/index.js +11 -0
- package/lib/api/traditional/merchandising/index.js.map +1 -0
- package/lib/api/traditional/shopping/index.d.ts +11 -0
- package/lib/api/traditional/shopping/index.js +16 -0
- package/lib/api/traditional/shopping/index.js.map +1 -0
- package/lib/api/traditional/trading/index.d.ts +142 -0
- package/lib/api/traditional/trading/index.js +146 -0
- package/lib/api/traditional/trading/index.js.map +1 -0
- package/lib/auth/authNAuth.d.ts +49 -0
- package/lib/auth/authNAuth.js +122 -0
- package/lib/auth/authNAuth.js.map +1 -0
- package/lib/auth/index.d.ts +17 -0
- package/lib/auth/index.js +32 -0
- package/lib/auth/index.js.map +1 -0
- package/lib/auth/oAuth2.d.ts +90 -0
- package/lib/auth/oAuth2.js +258 -0
- package/lib/auth/oAuth2.js.map +1 -0
- package/lib/ebay-api.min.js +2 -0
- package/lib/ebay-api.min.js.map +1 -0
- package/lib/enums/apiEnums.d.ts +49 -0
- package/lib/enums/apiEnums.js +55 -0
- package/lib/enums/apiEnums.js.map +1 -0
- package/lib/enums/index.d.ts +2 -0
- package/lib/enums/index.js +15 -0
- package/lib/enums/index.js.map +1 -0
- package/lib/enums/restfulEnums.d.ts +966 -0
- package/lib/enums/restfulEnums.js +1012 -0
- package/lib/enums/restfulEnums.js.map +1 -0
- package/lib/errors/index.d.ts +66 -0
- package/lib/errors/index.js +208 -0
- package/lib/errors/index.js.map +1 -0
- package/lib/index.d.ts +56 -0
- package/lib/index.js +99 -0
- package/lib/index.js.map +1 -0
- package/lib/request.d.ts +26 -0
- package/lib/request.js +51 -0
- package/lib/request.js.map +1 -0
- package/lib/types/apiTypes.d.ts +28 -0
- package/lib/types/apiTypes.js +3 -0
- package/lib/types/apiTypes.js.map +1 -0
- package/lib/types/index.d.ts +3 -0
- package/lib/types/index.js +16 -0
- package/lib/types/index.js.map +1 -0
- package/lib/types/restfulTypes.d.ts +1082 -0
- package/lib/types/restfulTypes.js +3 -0
- package/lib/types/restfulTypes.js.map +1 -0
- package/lib/types/traditonalTypes.d.ts +34 -0
- package/lib/types/traditonalTypes.js +3 -0
- package/lib/types/traditonalTypes.js.map +1 -0
- package/package.json +115 -21
- package/.npmignore +0 -17
- package/.travis.yml +0 -7
- package/examples/Finding-FindItemsByKeywords.js +0 -46
- package/examples/Merchandising-GetMostWatchedItemsRequest.js +0 -16
- package/examples/Shopping-GetSingleItem.js +0 -18
- package/examples/Trading-GetOrders.js +0 -26
- package/index.js +0 -10
- package/lib/deep-to-array.js +0 -42
- package/lib/defaults.js +0 -69
- package/lib/errors.js +0 -44
- package/lib/json-parser.js +0 -336
- package/lib/key-lists.js +0 -64
- package/lib/urls.js +0 -64
- package/lib/versions.js +0 -35
- package/lib/xml-converter.js +0 -21
- package/lib/xml-request.js +0 -207
- package/scripts/parse-input-xml.js +0 -41
- package/test/deep-to-array.test.js +0 -100
- package/test/errors.test.js +0 -75
- package/test/helpers.js +0 -22
- package/test/mocha.opts +0 -1
- package/test/mocks/GetMultipleItems.xml +0 -115
- package/test/mocks/GetOrders-empty.xml +0 -17
- package/test/mocks/GetOrders.xml +0 -463
- package/test/pagination.test.js +0 -5
- package/test/parsing.test.js +0 -248
- package/test/xml-request.test.js +0 -447
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
import Restful from '../../';
|
|
2
|
+
import { AddEvidencePaymentDisputeRequest, ContestPaymentDisputeRequest, IssueRefundRequest, PaymentParams, ShippingFulfillmentDetails, UpdateEvidencePaymentDisputeRequest } from '../../../../types';
|
|
3
|
+
/**
|
|
4
|
+
* Use the Fulfillment API to complete the process of packaging, addressing, handling, and shipping each order on
|
|
5
|
+
* behalf of the seller, in accordance with the payment method and timing specified at checkout.
|
|
6
|
+
*
|
|
7
|
+
* https://api.ebay.com/oauth/api_scope/sell.fulfillment
|
|
8
|
+
* https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly
|
|
9
|
+
*
|
|
10
|
+
*/
|
|
11
|
+
export default class Fulfillment extends Restful {
|
|
12
|
+
static id: string;
|
|
13
|
+
get basePath(): string;
|
|
14
|
+
/**
|
|
15
|
+
* Use this call to retrieve the contents of an order based on its unique identifier, orderId.
|
|
16
|
+
*
|
|
17
|
+
* @param orderId The unique identifier of the order.
|
|
18
|
+
* @param fieldGroups The response type associated with the order. The only presently supported value is <code>TAX_BREAKDOWN</code>.
|
|
19
|
+
*/
|
|
20
|
+
getOrder(orderId: string, { fieldGroups }?: {
|
|
21
|
+
fieldGroups?: string[];
|
|
22
|
+
}): Promise<any>;
|
|
23
|
+
/**
|
|
24
|
+
* Use this call to search for and retrieve one or more orders based on their creation date, last modification
|
|
25
|
+
* date,
|
|
26
|
+
* or fulfillment status using the filter parameter.
|
|
27
|
+
*
|
|
28
|
+
* @param filter One or more comma-separated criteria for narrowing down the collection of orders returned by this
|
|
29
|
+
* call.
|
|
30
|
+
* @param limit The number of orders to return per page of the result set.
|
|
31
|
+
* @param offset Specifies the number of orders to skip in the result set before returning the first order in the
|
|
32
|
+
* paginated response.
|
|
33
|
+
* @param orderIds A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50).
|
|
34
|
+
*/
|
|
35
|
+
getOrders({ filter, limit, offset, orderIds, fieldGroups, }?: {
|
|
36
|
+
filter?: string;
|
|
37
|
+
limit?: number;
|
|
38
|
+
offset?: number;
|
|
39
|
+
orderIds?: string | string[];
|
|
40
|
+
fieldGroups?: string[];
|
|
41
|
+
}): Promise<any>;
|
|
42
|
+
/**
|
|
43
|
+
* This method allows a seller (opted in to eBay Managed Payments) to issue a full or partial refund to a buyer for
|
|
44
|
+
* an order. auth: https://api.ebay.com/oauth/api_scope/sell.finances
|
|
45
|
+
*
|
|
46
|
+
* @param orderId The unique identifier of the order. Order IDs are returned in the getOrders method (and GetOrders
|
|
47
|
+
* call of Trading API).
|
|
48
|
+
* @param body IssueRefundRequest
|
|
49
|
+
*/
|
|
50
|
+
issueRefund(orderId: string, body?: IssueRefundRequest): Promise<any>;
|
|
51
|
+
/**
|
|
52
|
+
* Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the
|
|
53
|
+
* order's unique identifier, orderId.
|
|
54
|
+
*
|
|
55
|
+
* @param orderId The unique identifier of the order.
|
|
56
|
+
*/
|
|
57
|
+
getShippingFulfillments(orderId: string): Promise<any>;
|
|
58
|
+
/**
|
|
59
|
+
* Create a Shipping Fulfillment
|
|
60
|
+
*
|
|
61
|
+
* @param orderId The unique identifier of the order.
|
|
62
|
+
* @param body fulfillment payload
|
|
63
|
+
*/
|
|
64
|
+
createShippingFulfillment(orderId: string, body: ShippingFulfillmentDetails): Promise<any>;
|
|
65
|
+
/**
|
|
66
|
+
* Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined
|
|
67
|
+
* with the associated order's orderId).
|
|
68
|
+
*
|
|
69
|
+
* @param orderId The unique identifier of the order.
|
|
70
|
+
* @param fulfillmentId The unique identifier of the fulfillment.
|
|
71
|
+
*/
|
|
72
|
+
getShippingFulfillment(orderId: string, fulfillmentId: string): Promise<any>;
|
|
73
|
+
/**
|
|
74
|
+
* This method retrieves detailed information on a specific payment dispute.
|
|
75
|
+
*
|
|
76
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
77
|
+
*/
|
|
78
|
+
getPaymentDispute(paymentDisputeId: string): Promise<any>;
|
|
79
|
+
/**
|
|
80
|
+
* This call retrieves a specific evidence file for a payment dispute.
|
|
81
|
+
*
|
|
82
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
83
|
+
*/
|
|
84
|
+
fetchEvidenceContent(paymentDisputeId: string): Promise<any>;
|
|
85
|
+
/**
|
|
86
|
+
* This method retrieve a log of activity for a payment dispute.
|
|
87
|
+
*
|
|
88
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
89
|
+
*/
|
|
90
|
+
getActivities(paymentDisputeId: string): Promise<any>;
|
|
91
|
+
/**
|
|
92
|
+
* This method is used retrieve one or more payment disputes filed against the seller.
|
|
93
|
+
*
|
|
94
|
+
* @param orderId This filter is used if the seller wishes to retrieve one or more payment disputes filed against a specific order.
|
|
95
|
+
* @param buyerUsername This filter is used if the seller wishes to retrieve one or more payment disputes opened by a specific seller.
|
|
96
|
+
* @param openDateFrom The <b>open_date_from</b> and/or <b>open_date_to</b> date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range.
|
|
97
|
+
* @param paymentDisputeStatus The <b>open_date_from</b> and/or <b>open_date_to</b> date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range.
|
|
98
|
+
* @param paymentDisputeStatus his filter is used if the seller wishes to only retrieve payment disputes in a specific state.
|
|
99
|
+
* @param limit The value passed in this query parameter sets the maximum number of payment disputes to return per page of data.
|
|
100
|
+
* @param offset This field is used to specify the number of records to skip in the result set before returning the first payment dispute in the paginated response.
|
|
101
|
+
*/
|
|
102
|
+
getPaymentDisputeSummaries({ orderId: order_id, buyerUsername: buyer_username, openDateFrom: open_date_from, openDateTo: open_date_to, paymentDisputeStatus: payment_dispute_status, limit, offset }: PaymentParams): Promise<any>;
|
|
103
|
+
/**
|
|
104
|
+
* This method is used if the seller wishes to contest a payment dispute initiated by the buyer.
|
|
105
|
+
*
|
|
106
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
107
|
+
* @param body This is the unique identifier of the payment dispute.
|
|
108
|
+
*/
|
|
109
|
+
contestPaymentDispute(paymentDisputeId: string, body: ContestPaymentDisputeRequest): Promise<any>;
|
|
110
|
+
/**
|
|
111
|
+
* This method is used if the seller wishes to accept a payment dispute.
|
|
112
|
+
*
|
|
113
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
114
|
+
*/
|
|
115
|
+
acceptPaymentDispute(paymentDisputeId: string): Promise<any>;
|
|
116
|
+
/**
|
|
117
|
+
* This method is used to upload an evidence file for a contested payment dispute.
|
|
118
|
+
*
|
|
119
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
120
|
+
* @param data uploads an encrypted, binary image file (using multipart/form-data HTTP request header)
|
|
121
|
+
*/
|
|
122
|
+
uploadEvidenceFile(paymentDisputeId: string, data: any): Promise<any>;
|
|
123
|
+
/**
|
|
124
|
+
* This method is used by the seller to add one or more evidence files to address a payment dispute initiated by the buyer.
|
|
125
|
+
*
|
|
126
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
127
|
+
* @param body AddEvidencePaymentDisputeRequest
|
|
128
|
+
*/
|
|
129
|
+
addEvidence(paymentDisputeId: string, body: AddEvidencePaymentDisputeRequest): Promise<any>;
|
|
130
|
+
/**
|
|
131
|
+
* This method is used by the seller to update an existing evidence set for a payment dispute with one or more evidence files.
|
|
132
|
+
*
|
|
133
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
134
|
+
* @param body AddEvidencePaymentDisputeRequest
|
|
135
|
+
*/
|
|
136
|
+
updateEvidence(paymentDisputeId: string, body: UpdateEvidencePaymentDisputeRequest): Promise<any>;
|
|
137
|
+
}
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
const __1 = __importDefault(require("../../"));
|
|
7
|
+
const request_1 = require("../../../../request");
|
|
8
|
+
/**
|
|
9
|
+
* Use the Fulfillment API to complete the process of packaging, addressing, handling, and shipping each order on
|
|
10
|
+
* behalf of the seller, in accordance with the payment method and timing specified at checkout.
|
|
11
|
+
*
|
|
12
|
+
* https://api.ebay.com/oauth/api_scope/sell.fulfillment
|
|
13
|
+
* https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly
|
|
14
|
+
*
|
|
15
|
+
*/
|
|
16
|
+
class Fulfillment extends __1.default {
|
|
17
|
+
get basePath() {
|
|
18
|
+
return '/sell/fulfillment/v1';
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Use this call to retrieve the contents of an order based on its unique identifier, orderId.
|
|
22
|
+
*
|
|
23
|
+
* @param orderId The unique identifier of the order.
|
|
24
|
+
* @param fieldGroups The response type associated with the order. The only presently supported value is <code>TAX_BREAKDOWN</code>.
|
|
25
|
+
*/
|
|
26
|
+
getOrder(orderId, { fieldGroups } = {}) {
|
|
27
|
+
return this.get(`/order/${orderId}`, {
|
|
28
|
+
params: {
|
|
29
|
+
fieldGroups
|
|
30
|
+
}
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Use this call to search for and retrieve one or more orders based on their creation date, last modification
|
|
35
|
+
* date,
|
|
36
|
+
* or fulfillment status using the filter parameter.
|
|
37
|
+
*
|
|
38
|
+
* @param filter One or more comma-separated criteria for narrowing down the collection of orders returned by this
|
|
39
|
+
* call.
|
|
40
|
+
* @param limit The number of orders to return per page of the result set.
|
|
41
|
+
* @param offset Specifies the number of orders to skip in the result set before returning the first order in the
|
|
42
|
+
* paginated response.
|
|
43
|
+
* @param orderIds A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50).
|
|
44
|
+
*/
|
|
45
|
+
getOrders({ filter, limit, offset, orderIds, fieldGroups, } = {}) {
|
|
46
|
+
return this.get(`/order`, {
|
|
47
|
+
params: {
|
|
48
|
+
filter,
|
|
49
|
+
limit,
|
|
50
|
+
offset,
|
|
51
|
+
orderIds: Array.isArray(orderIds) ? orderIds.join() : orderIds,
|
|
52
|
+
fieldGroups
|
|
53
|
+
},
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* This method allows a seller (opted in to eBay Managed Payments) to issue a full or partial refund to a buyer for
|
|
58
|
+
* an order. auth: https://api.ebay.com/oauth/api_scope/sell.finances
|
|
59
|
+
*
|
|
60
|
+
* @param orderId The unique identifier of the order. Order IDs are returned in the getOrders method (and GetOrders
|
|
61
|
+
* call of Trading API).
|
|
62
|
+
* @param body IssueRefundRequest
|
|
63
|
+
*/
|
|
64
|
+
issueRefund(orderId, body) {
|
|
65
|
+
orderId = encodeURIComponent(orderId);
|
|
66
|
+
return this.post(`/order/${orderId}/issue_refund`, body);
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the
|
|
70
|
+
* order's unique identifier, orderId.
|
|
71
|
+
*
|
|
72
|
+
* @param orderId The unique identifier of the order.
|
|
73
|
+
*/
|
|
74
|
+
getShippingFulfillments(orderId) {
|
|
75
|
+
orderId = encodeURIComponent(orderId);
|
|
76
|
+
return this.get(`/order/${orderId}/shipping_fulfillment`);
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Create a Shipping Fulfillment
|
|
80
|
+
*
|
|
81
|
+
* @param orderId The unique identifier of the order.
|
|
82
|
+
* @param body fulfillment payload
|
|
83
|
+
*/
|
|
84
|
+
createShippingFulfillment(orderId, body) {
|
|
85
|
+
orderId = encodeURIComponent(orderId);
|
|
86
|
+
return this.post(`/order/${orderId}/shipping_fulfillment`, body);
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined
|
|
90
|
+
* with the associated order's orderId).
|
|
91
|
+
*
|
|
92
|
+
* @param orderId The unique identifier of the order.
|
|
93
|
+
* @param fulfillmentId The unique identifier of the fulfillment.
|
|
94
|
+
*/
|
|
95
|
+
getShippingFulfillment(orderId, fulfillmentId) {
|
|
96
|
+
orderId = encodeURIComponent(orderId);
|
|
97
|
+
fulfillmentId = encodeURIComponent(fulfillmentId);
|
|
98
|
+
return this.get(`/order/${orderId}/shipping_fulfillment/${fulfillmentId}`);
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* This method retrieves detailed information on a specific payment dispute.
|
|
102
|
+
*
|
|
103
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
104
|
+
*/
|
|
105
|
+
getPaymentDispute(paymentDisputeId) {
|
|
106
|
+
return this.get(`/payment_dispute/${paymentDisputeId}`);
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* This call retrieves a specific evidence file for a payment dispute.
|
|
110
|
+
*
|
|
111
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
112
|
+
*/
|
|
113
|
+
fetchEvidenceContent(paymentDisputeId) {
|
|
114
|
+
return this.get(`/payment_dispute/${paymentDisputeId}/fetch_evidence_content`);
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* This method retrieve a log of activity for a payment dispute.
|
|
118
|
+
*
|
|
119
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
120
|
+
*/
|
|
121
|
+
getActivities(paymentDisputeId) {
|
|
122
|
+
return this.get(`/payment_dispute/${paymentDisputeId}/activity`);
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* This method is used retrieve one or more payment disputes filed against the seller.
|
|
126
|
+
*
|
|
127
|
+
* @param orderId This filter is used if the seller wishes to retrieve one or more payment disputes filed against a specific order.
|
|
128
|
+
* @param buyerUsername This filter is used if the seller wishes to retrieve one or more payment disputes opened by a specific seller.
|
|
129
|
+
* @param openDateFrom The <b>open_date_from</b> and/or <b>open_date_to</b> date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range.
|
|
130
|
+
* @param paymentDisputeStatus The <b>open_date_from</b> and/or <b>open_date_to</b> date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range.
|
|
131
|
+
* @param paymentDisputeStatus his filter is used if the seller wishes to only retrieve payment disputes in a specific state.
|
|
132
|
+
* @param limit The value passed in this query parameter sets the maximum number of payment disputes to return per page of data.
|
|
133
|
+
* @param offset This field is used to specify the number of records to skip in the result set before returning the first payment dispute in the paginated response.
|
|
134
|
+
*/
|
|
135
|
+
getPaymentDisputeSummaries({ orderId: order_id, buyerUsername: buyer_username, openDateFrom: open_date_from, openDateTo: open_date_to, paymentDisputeStatus: payment_dispute_status, limit, offset }) {
|
|
136
|
+
return this.get(`/payment_dispute_summary`, {
|
|
137
|
+
params: {
|
|
138
|
+
order_id,
|
|
139
|
+
buyer_username,
|
|
140
|
+
open_date_from,
|
|
141
|
+
open_date_to,
|
|
142
|
+
payment_dispute_status,
|
|
143
|
+
limit,
|
|
144
|
+
offset
|
|
145
|
+
}
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* This method is used if the seller wishes to contest a payment dispute initiated by the buyer.
|
|
150
|
+
*
|
|
151
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
152
|
+
* @param body This is the unique identifier of the payment dispute.
|
|
153
|
+
*/
|
|
154
|
+
contestPaymentDispute(paymentDisputeId, body) {
|
|
155
|
+
return this.post(`/payment_dispute/${paymentDisputeId}/contest`, body);
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* This method is used if the seller wishes to accept a payment dispute.
|
|
159
|
+
*
|
|
160
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
161
|
+
*/
|
|
162
|
+
acceptPaymentDispute(paymentDisputeId) {
|
|
163
|
+
return this.post(`/payment_dispute/${paymentDisputeId}/accept`);
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* This method is used to upload an evidence file for a contested payment dispute.
|
|
167
|
+
*
|
|
168
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
169
|
+
* @param data uploads an encrypted, binary image file (using multipart/form-data HTTP request header)
|
|
170
|
+
*/
|
|
171
|
+
uploadEvidenceFile(paymentDisputeId, data) {
|
|
172
|
+
return this.post(`/payment_dispute/${paymentDisputeId}/upload_evidence_file`, data, {
|
|
173
|
+
headers: {
|
|
174
|
+
...request_1.multipartHeader
|
|
175
|
+
}
|
|
176
|
+
});
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* This method is used by the seller to add one or more evidence files to address a payment dispute initiated by the buyer.
|
|
180
|
+
*
|
|
181
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
182
|
+
* @param body AddEvidencePaymentDisputeRequest
|
|
183
|
+
*/
|
|
184
|
+
addEvidence(paymentDisputeId, body) {
|
|
185
|
+
return this.post(`/payment_dispute/${paymentDisputeId}/add_evidence`, body);
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* This method is used by the seller to update an existing evidence set for a payment dispute with one or more evidence files.
|
|
189
|
+
*
|
|
190
|
+
* @param paymentDisputeId This is the unique identifier of the payment dispute.
|
|
191
|
+
* @param body AddEvidencePaymentDisputeRequest
|
|
192
|
+
*/
|
|
193
|
+
updateEvidence(paymentDisputeId, body) {
|
|
194
|
+
return this.post(`/payment_dispute/${paymentDisputeId}/update_evidence`, body);
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
exports.default = Fulfillment;
|
|
198
|
+
Fulfillment.id = 'Fulfillment';
|
|
199
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/sell/fulfillment/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAC7B,iDAAoD;AAQpD;;;;;;;GAOG;AACH,MAAqB,WAAY,SAAQ,WAAO;IAI9C,IAAI,QAAQ;QACV,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,OAAe,EAAE,EAAC,WAAW,KAAgC,EAAE;QAC7E,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,EAAE;YACnC,MAAM,EAAE;gBACN,WAAW;aACZ;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACI,SAAS,CAAC,EACE,MAAM,EACN,KAAK,EACL,MAAM,EACN,QAAQ,EACR,WAAW,MAO1B,EAAE;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE;YACxB,MAAM,EAAE;gBACN,MAAM;gBACN,KAAK;gBACL,MAAM;gBACN,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,QAAQ;gBAC9D,WAAW;aACZ;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,WAAW,CAAC,OAAe,EAAE,IAAyB;QAC3D,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,OAAO,eAAe,EAAE,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,uBAAuB,CAAC,OAAe;QAC5C,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,OAAO,uBAAuB,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,yBAAyB,CAC9B,OAAe,EACf,IAAgC;QAEhC,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,OAAO,uBAAuB,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACI,sBAAsB,CAAC,OAAe,EAAE,aAAqB;QAClE,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACtC,aAAa,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,OAAO,yBAAyB,aAAa,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,gBAAwB;QAC/C,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,gBAAgB,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,gBAAwB;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,gBAAgB,yBAAyB,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,gBAAwB;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,gBAAgB,WAAW,CAAC,CAAC;IACnE,CAAC;IAGD;;;;;;;;;;OAUG;IACI,0BAA0B,CAAC,EACE,OAAO,EAAE,QAAQ,EACjB,aAAa,EAAE,cAAc,EAC7B,YAAY,EAAE,cAAc,EAC5B,UAAU,EAAE,YAAY,EACxB,oBAAoB,EAAE,sBAAsB,EAC5C,KAAK,EACL,MAAM,EACQ;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,EAAE;YAC1C,MAAM,EAAE;gBACN,QAAQ;gBACR,cAAc;gBACd,cAAc;gBACd,YAAY;gBACZ,sBAAsB;gBACtB,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,qBAAqB,CAAC,gBAAwB,EAAE,IAAkC;QACvF,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,gBAAgB,UAAU,EAAE,IAAI,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,gBAAwB;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,gBAAgB,SAAS,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,gBAAwB,EAAE,IAAS;QAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,gBAAgB,uBAAuB,EAAE,IAAI,EAAE;YAClF,OAAO,EAAE;gBACP,GAAG,yBAAe;aACnB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,gBAAwB,EAAE,IAAsC;QACjF,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,gBAAgB,eAAe,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,gBAAwB,EAAE,IAAyC;QACvF,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,gBAAgB,kBAAkB,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;;AA7NH,8BA8NC;AA5NQ,cAAE,GAAG,aAAa,CAAC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import Account from './account';
|
|
2
|
+
import Analytics from './analytics';
|
|
3
|
+
import Compliance from './compliance';
|
|
4
|
+
import Finances from './finances';
|
|
5
|
+
import Fulfillment from './fulfillment';
|
|
6
|
+
import Inventory from './inventory';
|
|
7
|
+
import Marketing from './marketing';
|
|
8
|
+
import Metadata from './metadata';
|
|
9
|
+
import Recommendation from './recommendation';
|
|
10
|
+
import Feed from './feed';
|
|
11
|
+
import Logistics from './logistics';
|
|
12
|
+
import Negotiation from './negotiation';
|
|
13
|
+
import Listing from './listing';
|
|
14
|
+
export declare type Sell = {
|
|
15
|
+
account: Account;
|
|
16
|
+
analytics: Analytics;
|
|
17
|
+
compliance: Compliance;
|
|
18
|
+
fulfillment: Fulfillment;
|
|
19
|
+
inventory: Inventory;
|
|
20
|
+
marketing: Marketing;
|
|
21
|
+
metadata: Metadata;
|
|
22
|
+
recommendation: Recommendation;
|
|
23
|
+
finances: Finances;
|
|
24
|
+
feed: Feed;
|
|
25
|
+
logistics: Logistics;
|
|
26
|
+
negotiation: Negotiation;
|
|
27
|
+
listing: Listing;
|
|
28
|
+
};
|
|
29
|
+
export { Account, Compliance, Analytics, Fulfillment, Inventory, Marketing, Metadata, Recommendation, Finances, Feed, Logistics, Negotiation, Listing };
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Listing = exports.Negotiation = exports.Logistics = exports.Feed = exports.Finances = exports.Recommendation = exports.Metadata = exports.Marketing = exports.Inventory = exports.Fulfillment = exports.Analytics = exports.Compliance = exports.Account = void 0;
|
|
7
|
+
const account_1 = __importDefault(require("./account"));
|
|
8
|
+
exports.Account = account_1.default;
|
|
9
|
+
const analytics_1 = __importDefault(require("./analytics"));
|
|
10
|
+
exports.Analytics = analytics_1.default;
|
|
11
|
+
const compliance_1 = __importDefault(require("./compliance"));
|
|
12
|
+
exports.Compliance = compliance_1.default;
|
|
13
|
+
const finances_1 = __importDefault(require("./finances"));
|
|
14
|
+
exports.Finances = finances_1.default;
|
|
15
|
+
const fulfillment_1 = __importDefault(require("./fulfillment"));
|
|
16
|
+
exports.Fulfillment = fulfillment_1.default;
|
|
17
|
+
const inventory_1 = __importDefault(require("./inventory"));
|
|
18
|
+
exports.Inventory = inventory_1.default;
|
|
19
|
+
const marketing_1 = __importDefault(require("./marketing"));
|
|
20
|
+
exports.Marketing = marketing_1.default;
|
|
21
|
+
const metadata_1 = __importDefault(require("./metadata"));
|
|
22
|
+
exports.Metadata = metadata_1.default;
|
|
23
|
+
const recommendation_1 = __importDefault(require("./recommendation"));
|
|
24
|
+
exports.Recommendation = recommendation_1.default;
|
|
25
|
+
const feed_1 = __importDefault(require("./feed"));
|
|
26
|
+
exports.Feed = feed_1.default;
|
|
27
|
+
const logistics_1 = __importDefault(require("./logistics"));
|
|
28
|
+
exports.Logistics = logistics_1.default;
|
|
29
|
+
const negotiation_1 = __importDefault(require("./negotiation"));
|
|
30
|
+
exports.Negotiation = negotiation_1.default;
|
|
31
|
+
const listing_1 = __importDefault(require("./listing"));
|
|
32
|
+
exports.Listing = listing_1.default;
|
|
33
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/restful/sell/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AA+B9B,kBA/BK,iBAAO,CA+BL;AA9BT,4DAAoC;AAgClC,oBAhCK,mBAAS,CAgCL;AA/BX,8DAAsC;AA8BpC,qBA9BK,oBAAU,CA8BL;AA7BZ,0DAAkC;AAoChC,mBApCK,kBAAQ,CAoCL;AAnCV,gEAAwC;AA8BtC,sBA9BK,qBAAW,CA8BL;AA7Bb,4DAAoC;AA8BlC,oBA9BK,mBAAS,CA8BL;AA7BX,4DAAoC;AA8BlC,oBA9BK,mBAAS,CA8BL;AA7BX,0DAAkC;AA8BhC,mBA9BK,kBAAQ,CA8BL;AA7BV,sEAA8C;AA8B5C,yBA9BK,wBAAc,CA8BL;AA7BhB,kDAA0B;AA+BxB,eA/BK,cAAI,CA+BL;AA9BN,4DAAoC;AA+BlC,oBA/BK,mBAAS,CA+BL;AA9BX,gEAAwC;AA+BtC,sBA/BK,qBAAW,CA+BL;AA9Bb,wDAAgC;AA+B9B,kBA/BK,iBAAO,CA+BL"}
|
|
@@ -0,0 +1,248 @@
|
|
|
1
|
+
import Restful from '../../';
|
|
2
|
+
import { BulkEbayOfferDetailsWithKeys, BulkInventoryItem, BulkMigrateListing, BulkOffer, BulkPriceQuantity, Compatibility, EbayOfferDetailsWithId, EbayOfferDetailsWithKeys, InventoryItemGroup, InventoryLocation, InventoryLocationFull, OfferKeysWithId, PublishByInventoryItemGroupRequest, SellInventoryItem, WithdrawByInventoryItemGroupRequest } from '../../../../types';
|
|
3
|
+
/**
|
|
4
|
+
* The Inventory API is used to create and manage inventory, and then to publish and manage this inventory on an eBay
|
|
5
|
+
* marketplace.
|
|
6
|
+
*/
|
|
7
|
+
export default class Inventory extends Restful {
|
|
8
|
+
static id: string;
|
|
9
|
+
get basePath(): string;
|
|
10
|
+
/**
|
|
11
|
+
* This call retrieves all defined details of the inventory location that is specified by the
|
|
12
|
+
* <b>merchantLocationKey</b> path parameter.
|
|
13
|
+
*
|
|
14
|
+
* @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
|
|
15
|
+
*/
|
|
16
|
+
getInventoryLocation(merchantLocationKey: string): Promise<any>;
|
|
17
|
+
/**
|
|
18
|
+
* <p>This call disables the inventory location that is specified in the <code>merchantLocationKey</code> path
|
|
19
|
+
* parameter.
|
|
20
|
+
*
|
|
21
|
+
* @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
|
|
22
|
+
*/
|
|
23
|
+
disableInventoryLocation(merchantLocationKey: string): Promise<any>;
|
|
24
|
+
/**
|
|
25
|
+
* <p>This call enables a disabled inventory location that is specified in the <code>merchantLocationKey</code>
|
|
26
|
+
* path parameter.
|
|
27
|
+
*
|
|
28
|
+
* @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
|
|
29
|
+
*/
|
|
30
|
+
enableInventoryLocation(merchantLocationKey: string): Promise<any>;
|
|
31
|
+
/**
|
|
32
|
+
* This call retrieves all defined details for every inventory location associated with the seller's account.
|
|
33
|
+
*
|
|
34
|
+
* @param limit The value passed in this query parameter sets the maximum number of records to return per page of
|
|
35
|
+
* data.
|
|
36
|
+
* @param offset The value passed in this query parameter sets the page number to retrieve.
|
|
37
|
+
*/
|
|
38
|
+
getInventoryLocations({ limit, offset, }?: {
|
|
39
|
+
limit?: number;
|
|
40
|
+
offset?: number;
|
|
41
|
+
}): Promise<any>;
|
|
42
|
+
/**
|
|
43
|
+
* <p>Use this call to create a new inventory location.
|
|
44
|
+
*
|
|
45
|
+
* @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
|
|
46
|
+
* @param body Inventory Location details
|
|
47
|
+
*/
|
|
48
|
+
createInventoryLocation(merchantLocationKey: string, body: InventoryLocationFull): Promise<any>;
|
|
49
|
+
/**
|
|
50
|
+
* <p>This call deletes the inventory location that is specified in the <code>merchantLocationKey</code> path
|
|
51
|
+
* parameter.
|
|
52
|
+
*
|
|
53
|
+
* @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
|
|
54
|
+
*/
|
|
55
|
+
deleteInventoryLocation(merchantLocationKey: string): Promise<any>;
|
|
56
|
+
/**
|
|
57
|
+
* <p>Use this call to update non-physical location details for an existing inventory location.
|
|
58
|
+
*
|
|
59
|
+
* @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
|
|
60
|
+
* @param body The inventory location details to be updated (other than the address and geo co-ordinates).
|
|
61
|
+
*/
|
|
62
|
+
updateInventoryLocation(merchantLocationKey: string, body?: InventoryLocation): Promise<any>;
|
|
63
|
+
/**
|
|
64
|
+
* This call retrieves the inventory item record for a given SKU.
|
|
65
|
+
*
|
|
66
|
+
* @param sku his is the seller-defined SKU value of the product whose inventory item record you wish to
|
|
67
|
+
* retrieve.<br/><br/><strong>Max length</strong>: 50.
|
|
68
|
+
*/
|
|
69
|
+
getInventoryItem(sku: string): Promise<any>;
|
|
70
|
+
/**
|
|
71
|
+
* This call creates a new inventory item record or replaces an existing inventory item record.
|
|
72
|
+
*
|
|
73
|
+
* @param sku The seller-defined SKU value for the inventory item is required whether the seller is creating a new
|
|
74
|
+
* inventory item, or updating an existing inventory item.
|
|
75
|
+
* @param body Details of the inventory item record.
|
|
76
|
+
*/
|
|
77
|
+
createOrReplaceInventoryItem(sku: string, body: SellInventoryItem): Promise<any>;
|
|
78
|
+
/**
|
|
79
|
+
* This call is used to delete an inventory item record associated with a specified SKU.
|
|
80
|
+
*
|
|
81
|
+
* @param sku The seller-defined SKU value for the inventory item is required whether the seller is creating a new
|
|
82
|
+
* inventory item, or updating an existing inventory item.
|
|
83
|
+
*/
|
|
84
|
+
deleteInventoryItem(sku: string): Promise<any>;
|
|
85
|
+
/**
|
|
86
|
+
* This call retrieves all inventory item records defined for the seller's account.
|
|
87
|
+
*
|
|
88
|
+
* @param limit The value passed in this query parameter sets the maximum number of records to return per page of
|
|
89
|
+
* data.
|
|
90
|
+
* @param offset The value passed in this query parameter sets the page number to retrieve.
|
|
91
|
+
*/
|
|
92
|
+
getInventoryItems({ limit, offset, }?: {
|
|
93
|
+
limit?: number;
|
|
94
|
+
offset?: number;
|
|
95
|
+
}): Promise<any>;
|
|
96
|
+
/**
|
|
97
|
+
* This call is used by the seller to update the total ship-to-home quantity of one inventory item,
|
|
98
|
+
* and/or to update the price and/or quantity of one or more offers associated with one inventory item.
|
|
99
|
+
*
|
|
100
|
+
* @param body BulkPriceQuantity
|
|
101
|
+
*/
|
|
102
|
+
bulkUpdatePriceQuantity(body: BulkPriceQuantity): Promise<any>;
|
|
103
|
+
/**
|
|
104
|
+
* This call can be used to create and/or update up to 25 new inventory item records.
|
|
105
|
+
*
|
|
106
|
+
* @param body BulkInventoryItem
|
|
107
|
+
*/
|
|
108
|
+
bulkCreateOrReplaceInventoryItem(body: BulkInventoryItem): Promise<any>;
|
|
109
|
+
/**
|
|
110
|
+
* This call retrieves up to 25 inventory item records. The SKU value of each inventory item record to retrieve is
|
|
111
|
+
* specified in the request payload.
|
|
112
|
+
*
|
|
113
|
+
* @param body BulkInventoryItem
|
|
114
|
+
*/
|
|
115
|
+
bulkGetInventoryItem(body: BulkInventoryItem): Promise<any>;
|
|
116
|
+
/**
|
|
117
|
+
* This call is used by the seller to retrieve the list of products that are compatible with the inventory item.
|
|
118
|
+
*
|
|
119
|
+
* @param sku A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
|
|
120
|
+
*/
|
|
121
|
+
getProductCompatibility(sku: string): Promise<any>;
|
|
122
|
+
/**
|
|
123
|
+
* This call is used by the seller to create or replace a list of products that are compatible with the inventory
|
|
124
|
+
* item.
|
|
125
|
+
*
|
|
126
|
+
* @param sku A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
|
|
127
|
+
* @param body Details of the compatibility
|
|
128
|
+
*/
|
|
129
|
+
createOrReplaceProductCompatibility(sku: string, body: Compatibility): Promise<any>;
|
|
130
|
+
/**
|
|
131
|
+
* This call is used by the seller to delete the list of products that are compatible with the inventory item that
|
|
132
|
+
* is associated with the compatible product list.
|
|
133
|
+
*
|
|
134
|
+
* @param sku A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
|
|
135
|
+
*/
|
|
136
|
+
deleteProductCompatibility(sku: string): Promise<any>;
|
|
137
|
+
/**
|
|
138
|
+
* This call retrieves all existing offers for the specified SKU value.
|
|
139
|
+
*
|
|
140
|
+
* @param sku The seller-defined SKU value is passed in as a query parameter.
|
|
141
|
+
* @param marketplace_id The unique identifier of the eBay marketplace.
|
|
142
|
+
* @param format This enumeration value sets the listing format for the offer.
|
|
143
|
+
* @param limit The value passed in this query parameter sets the maximum number of records to return per page of
|
|
144
|
+
* data.
|
|
145
|
+
* @param offset The value passed in this query parameter sets the page number to retrieve.
|
|
146
|
+
*/
|
|
147
|
+
getOffers({ sku, marketplaceId, format, limit, offset, }?: {
|
|
148
|
+
sku?: string;
|
|
149
|
+
marketplaceId?: string;
|
|
150
|
+
format?: string;
|
|
151
|
+
limit?: number;
|
|
152
|
+
offset?: number;
|
|
153
|
+
}): Promise<any>;
|
|
154
|
+
/**
|
|
155
|
+
* This call retrieves a specific published or unpublished offer.
|
|
156
|
+
*
|
|
157
|
+
* @param offerId The unique identifier of the offer that is to be retrieved.
|
|
158
|
+
*/
|
|
159
|
+
getOffer(offerId: string): Promise<any>;
|
|
160
|
+
/**
|
|
161
|
+
* This call creates an offer for a specific inventory item on a specific eBay marketplace.
|
|
162
|
+
*
|
|
163
|
+
* @param body Details of the offer for the channel
|
|
164
|
+
*/
|
|
165
|
+
createOffer(body: EbayOfferDetailsWithKeys): Promise<any>;
|
|
166
|
+
/**
|
|
167
|
+
* This call updates an existing offer.
|
|
168
|
+
*
|
|
169
|
+
* @param offerId The unique identifier of the offer that is being updated.
|
|
170
|
+
* @param body Details of the offer for the channel
|
|
171
|
+
*/
|
|
172
|
+
updateOffer(offerId: string, body: EbayOfferDetailsWithId): Promise<any>;
|
|
173
|
+
/**
|
|
174
|
+
* If used against an unpublished offer, this call will permanently delete that offer.
|
|
175
|
+
*
|
|
176
|
+
* @param offerId The unique identifier of the offer to delete.
|
|
177
|
+
*/
|
|
178
|
+
deleteOffer(offerId: string): Promise<any>;
|
|
179
|
+
/**
|
|
180
|
+
* This call is used to convert an unpublished offer into a published offer, or live eBay listing.
|
|
181
|
+
*
|
|
182
|
+
* @param offerId The unique identifier of the offer that is to be published.
|
|
183
|
+
*/
|
|
184
|
+
publishOffer(offerId: string): Promise<any>;
|
|
185
|
+
/**
|
|
186
|
+
* This call is used to convert all unpublished offers associated with an inventory item group into an active,
|
|
187
|
+
* multiple-variation listing.
|
|
188
|
+
*
|
|
189
|
+
* @param body PublishByInventoryItemGroupRequest
|
|
190
|
+
*/
|
|
191
|
+
publishOfferByInventoryItemGroup(body: PublishByInventoryItemGroupRequest): Promise<any>;
|
|
192
|
+
/**
|
|
193
|
+
* This call is used to end a multiple-variation eBay listing that is associated with the specified inventory item
|
|
194
|
+
* group.
|
|
195
|
+
*
|
|
196
|
+
* @param body WithdrawByInventoryItemGroupRequest
|
|
197
|
+
*/
|
|
198
|
+
withdrawOfferByInventoryItemGroup(body: WithdrawByInventoryItemGroupRequest): Promise<any>;
|
|
199
|
+
/**
|
|
200
|
+
* This call is used to retrieve the expected listing fees for up to 250 unpublished offers.
|
|
201
|
+
*
|
|
202
|
+
* @param body OfferKeysWithId
|
|
203
|
+
*/
|
|
204
|
+
getListingFees(body: OfferKeysWithId): Promise<any>;
|
|
205
|
+
/**
|
|
206
|
+
* This call creates multiple offers (up to 25) for specific inventory items on a specific eBay marketplace.
|
|
207
|
+
*
|
|
208
|
+
* @param body BulkEbayOfferDetailsWithKeys
|
|
209
|
+
*/
|
|
210
|
+
bulkCreateOffer(body: BulkEbayOfferDetailsWithKeys): Promise<any>;
|
|
211
|
+
/**
|
|
212
|
+
* This call is used to convert unpublished offers (up to 25) into published offers, or live eBay listings.
|
|
213
|
+
*
|
|
214
|
+
* @param body BulkOffer
|
|
215
|
+
*/
|
|
216
|
+
bulkPublishOffer(body: BulkOffer): Promise<any>;
|
|
217
|
+
/**
|
|
218
|
+
* This call is used to end a single-variation listing that is associated with the specified offer.
|
|
219
|
+
*
|
|
220
|
+
* @param offerId he unique identifier of the offer that is to be withdrawn.
|
|
221
|
+
*/
|
|
222
|
+
withdrawOffer(offerId: string): Promise<any>;
|
|
223
|
+
/**
|
|
224
|
+
* This call retrieves the inventory item group for a given <strong>inventoryItemGroupKey</strong> value.
|
|
225
|
+
*
|
|
226
|
+
* @param inventoryItemGroupKey The unique identifier of an inventory item group.
|
|
227
|
+
*/
|
|
228
|
+
getInventoryItemGroup(inventoryItemGroupKey: string): Promise<any>;
|
|
229
|
+
/**
|
|
230
|
+
* This call creates a new inventory item group or updates an existing inventory item group.
|
|
231
|
+
*
|
|
232
|
+
* @param inventoryItemGroupKey Unique identifier of the inventory item group.
|
|
233
|
+
* @param body Details of the inventory Item Group
|
|
234
|
+
*/
|
|
235
|
+
createOrReplaceInventoryItemGroup(inventoryItemGroupKey: string, body: InventoryItemGroup): Promise<any>;
|
|
236
|
+
/**
|
|
237
|
+
* This call deletes the inventory item group for a given <strong>inventoryItemGroupKey</strong> value.
|
|
238
|
+
*
|
|
239
|
+
* @param inventoryItemGroupKey Unique identifier of the inventory item group.
|
|
240
|
+
*/
|
|
241
|
+
deleteInventoryItemGroup(inventoryItemGroupKey: string): Promise<any>;
|
|
242
|
+
/**
|
|
243
|
+
* This call is used to convert existing eBay Listings to the corresponding Inventory API objects.
|
|
244
|
+
*
|
|
245
|
+
* @param body BulkMigrateListing
|
|
246
|
+
*/
|
|
247
|
+
bulkMigrateListing(body: BulkMigrateListing): Promise<any>;
|
|
248
|
+
}
|