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,1082 @@
|
|
|
1
|
+
import { CancelReason, CaseSearchFieldGroup, CaseStatusFilter, CategoryType as CategoryTypeEnum, Condition, CountryCode, CurrencyCode, Decision, EscalateReason, FilePurpose, FormatType, InquirySearchFieldGroup, InquiryStatusFilter, LengthUnitOfMeasure, Locale, Marketplace, MarketplaceId, PackageType, PaymentMethodType, ReasonForRefund, RecipientAccountReferenceType, RefundFeeType, RegionType, RequestType, ReturnCountFilter, ReturnMethod, ReturnReason, ReturnShippingCostPayer, ReturnState, ReturnType, ShippingCarrier, ShippingCostType, ShippingOptionType, StoreType, TimeDurationUnit, UserRoleFilter, WeightUnitOfMeasure } from '../enums';
|
|
2
|
+
export declare type AttributeNameValue = {
|
|
3
|
+
name: string;
|
|
4
|
+
value: string;
|
|
5
|
+
};
|
|
6
|
+
export declare type CompatibilityPayload = {
|
|
7
|
+
compatibilityProperties: AttributeNameValue[];
|
|
8
|
+
};
|
|
9
|
+
export declare type CatalogSearchParams = {
|
|
10
|
+
aspect_filter?: string;
|
|
11
|
+
category_ids?: string;
|
|
12
|
+
fieldgroups?: string;
|
|
13
|
+
gtin?: string;
|
|
14
|
+
limit?: number;
|
|
15
|
+
offset?: number;
|
|
16
|
+
q?: string;
|
|
17
|
+
};
|
|
18
|
+
export declare type BrowseSearchParams = {
|
|
19
|
+
aspect_filter?: string;
|
|
20
|
+
category_ids?: string;
|
|
21
|
+
charity_ids?: string;
|
|
22
|
+
compatibility_filter?: string;
|
|
23
|
+
epid?: string;
|
|
24
|
+
fieldgroups?: string;
|
|
25
|
+
filter?: string;
|
|
26
|
+
gtin?: string;
|
|
27
|
+
limit?: number;
|
|
28
|
+
offset?: number;
|
|
29
|
+
q?: string;
|
|
30
|
+
sort?: string;
|
|
31
|
+
};
|
|
32
|
+
export declare type SearchByImageParams = {
|
|
33
|
+
aspect_filter?: string;
|
|
34
|
+
category_ids?: string;
|
|
35
|
+
epid?: string;
|
|
36
|
+
filter?: string;
|
|
37
|
+
limit?: number;
|
|
38
|
+
offset?: number;
|
|
39
|
+
sort?: string;
|
|
40
|
+
};
|
|
41
|
+
export declare type LegacyItemParams = {
|
|
42
|
+
legacy_item_id: string;
|
|
43
|
+
fieldgroups?: string;
|
|
44
|
+
legacy_variation_id?: string;
|
|
45
|
+
legacy_variation_sku?: string;
|
|
46
|
+
};
|
|
47
|
+
export declare type AddCartItemInput = {
|
|
48
|
+
itemId: string;
|
|
49
|
+
quantity: number;
|
|
50
|
+
};
|
|
51
|
+
export declare type RemoveCartItemInput = {
|
|
52
|
+
cartItemId: string;
|
|
53
|
+
};
|
|
54
|
+
export declare type UpdateCartItemInput = {
|
|
55
|
+
cartItemId: string;
|
|
56
|
+
quantity: number;
|
|
57
|
+
};
|
|
58
|
+
export declare type SimpleAmount = {
|
|
59
|
+
currency: string;
|
|
60
|
+
value: string;
|
|
61
|
+
};
|
|
62
|
+
export declare type Amount = {
|
|
63
|
+
convertedFromCurrency?: CurrencyCode;
|
|
64
|
+
convertedFromValue?: number;
|
|
65
|
+
currency?: CurrencyCode;
|
|
66
|
+
value: string;
|
|
67
|
+
};
|
|
68
|
+
export declare type BuyFeedParams = {
|
|
69
|
+
feed_scope: string;
|
|
70
|
+
category_id: string;
|
|
71
|
+
date: string;
|
|
72
|
+
};
|
|
73
|
+
export declare type AlsoBoughtByProductParams = {
|
|
74
|
+
name?: string;
|
|
75
|
+
epid?: string;
|
|
76
|
+
gtin?: string;
|
|
77
|
+
mpn?: string;
|
|
78
|
+
};
|
|
79
|
+
export declare type AlsoViewedByProductParams = {
|
|
80
|
+
brand?: string;
|
|
81
|
+
epid?: string;
|
|
82
|
+
gtin?: string;
|
|
83
|
+
mpn?: string;
|
|
84
|
+
};
|
|
85
|
+
export declare type MerchandisedProductsParams = {
|
|
86
|
+
aspect_filter?: false;
|
|
87
|
+
category_id: string;
|
|
88
|
+
limit?: number;
|
|
89
|
+
metric_name: string;
|
|
90
|
+
};
|
|
91
|
+
export declare type UserConsent = {
|
|
92
|
+
adultOnlyItem: boolean;
|
|
93
|
+
};
|
|
94
|
+
export declare type PlaceProxyBidRequest = {
|
|
95
|
+
maxAmount: Amount;
|
|
96
|
+
userConsent: UserConsent;
|
|
97
|
+
};
|
|
98
|
+
export declare type CouponRequest = {
|
|
99
|
+
redemptionCode: string;
|
|
100
|
+
};
|
|
101
|
+
export declare type CreditCard = {
|
|
102
|
+
accountHolderName: string;
|
|
103
|
+
billingAddress: BillingAddress;
|
|
104
|
+
brand: string;
|
|
105
|
+
cardNumber: string;
|
|
106
|
+
cvvNumber: string;
|
|
107
|
+
expireMonth: number;
|
|
108
|
+
expireYear: number;
|
|
109
|
+
};
|
|
110
|
+
export declare type BillingAddress = {
|
|
111
|
+
addressLine1: string;
|
|
112
|
+
addressLine2: string;
|
|
113
|
+
city: string;
|
|
114
|
+
country: CountryCode;
|
|
115
|
+
county: string;
|
|
116
|
+
firstName: string;
|
|
117
|
+
lastName: string;
|
|
118
|
+
postalCode: string;
|
|
119
|
+
stateOrProvince: string;
|
|
120
|
+
};
|
|
121
|
+
export declare type Wallet = {
|
|
122
|
+
paymentToken: string;
|
|
123
|
+
};
|
|
124
|
+
export declare type LineItemInput = {
|
|
125
|
+
itemId: string;
|
|
126
|
+
quantity: number;
|
|
127
|
+
};
|
|
128
|
+
export declare type ShippingAddress = {
|
|
129
|
+
addressLine1: string;
|
|
130
|
+
addressLine2: string;
|
|
131
|
+
city: string;
|
|
132
|
+
country: CountryCode;
|
|
133
|
+
county: string;
|
|
134
|
+
phoneNumber: string;
|
|
135
|
+
postalCode: string;
|
|
136
|
+
recipient: string;
|
|
137
|
+
stateOrProvince: string;
|
|
138
|
+
};
|
|
139
|
+
export declare type CreateSignInCheckoutSessionRequest = {
|
|
140
|
+
creditCard: CreditCard;
|
|
141
|
+
lineItemInputs: LineItemInput;
|
|
142
|
+
shippingAddress: ShippingAddress;
|
|
143
|
+
};
|
|
144
|
+
export declare type UpdatePaymentInformation = {
|
|
145
|
+
creditCard: CreditCard;
|
|
146
|
+
wallet: Wallet;
|
|
147
|
+
};
|
|
148
|
+
export declare type UpdateQuantity = {
|
|
149
|
+
lineItemId: string;
|
|
150
|
+
quantity: number;
|
|
151
|
+
};
|
|
152
|
+
export declare type ShippingAddressImpl = {
|
|
153
|
+
addressLine1: string;
|
|
154
|
+
addressLine2: string;
|
|
155
|
+
city: string;
|
|
156
|
+
country: CountryCode;
|
|
157
|
+
county: string;
|
|
158
|
+
phoneNumber: string;
|
|
159
|
+
postalCode: string;
|
|
160
|
+
recipient: Recipient;
|
|
161
|
+
stateOrProvince: string;
|
|
162
|
+
};
|
|
163
|
+
export declare type Recipient = {
|
|
164
|
+
firstName: string;
|
|
165
|
+
lastName: string;
|
|
166
|
+
};
|
|
167
|
+
export declare type UpdateShippingOption = {
|
|
168
|
+
lineItemId: string;
|
|
169
|
+
shippingOptionId: string;
|
|
170
|
+
};
|
|
171
|
+
export declare type CheckoutSessionRequest = {
|
|
172
|
+
contactEmail: string;
|
|
173
|
+
contactFirstName: string;
|
|
174
|
+
contactLastName: string;
|
|
175
|
+
creditCard: string;
|
|
176
|
+
lineItemInputs: LineItemInput;
|
|
177
|
+
shippingAddress: ShippingAddress;
|
|
178
|
+
};
|
|
179
|
+
export declare type InitiatePaymentRequest = {
|
|
180
|
+
paymentMethodBrandType: string;
|
|
181
|
+
paymentMethodType: string;
|
|
182
|
+
};
|
|
183
|
+
export declare type MarketingTerms = {
|
|
184
|
+
marketingChannels: string[];
|
|
185
|
+
marketingTermsAccepted: boolean;
|
|
186
|
+
marketingTypes: string[];
|
|
187
|
+
};
|
|
188
|
+
export declare type GuestPlaceOrderRequest = {
|
|
189
|
+
marketingTerms: MarketingTerms[];
|
|
190
|
+
};
|
|
191
|
+
export declare type Program = {
|
|
192
|
+
programType: string;
|
|
193
|
+
};
|
|
194
|
+
export declare type LegacyReference = {
|
|
195
|
+
legacyItemId: string;
|
|
196
|
+
legacyTransactionId: string;
|
|
197
|
+
};
|
|
198
|
+
export declare type RefundItem = {
|
|
199
|
+
refundAmount: Amount;
|
|
200
|
+
lineItemId: string;
|
|
201
|
+
legacyReference?: LegacyReference;
|
|
202
|
+
};
|
|
203
|
+
export declare type IssueRefundRequest = {
|
|
204
|
+
reasonForRefund: ReasonForRefund;
|
|
205
|
+
comment?: string;
|
|
206
|
+
refundItems?: RefundItem[];
|
|
207
|
+
orderLevelRefundAmount?: SimpleAmount;
|
|
208
|
+
};
|
|
209
|
+
export declare type PaymentParams = {
|
|
210
|
+
orderId?: string;
|
|
211
|
+
buyerUsername?: string;
|
|
212
|
+
openDateFrom?: string;
|
|
213
|
+
openDateTo?: string;
|
|
214
|
+
paymentDisputeStatus?: string;
|
|
215
|
+
limit?: string;
|
|
216
|
+
offset?: string;
|
|
217
|
+
};
|
|
218
|
+
export declare type Phone = {
|
|
219
|
+
countryCode: string;
|
|
220
|
+
number: number;
|
|
221
|
+
};
|
|
222
|
+
export declare type ReturnAddress = {
|
|
223
|
+
addressLine1: string;
|
|
224
|
+
addressLine2: string;
|
|
225
|
+
city: string;
|
|
226
|
+
country: string;
|
|
227
|
+
county: string;
|
|
228
|
+
fullName: string;
|
|
229
|
+
postalCode: string;
|
|
230
|
+
primaryPhone: Phone;
|
|
231
|
+
stateOrProvince: string;
|
|
232
|
+
};
|
|
233
|
+
export declare type ContestPaymentDisputeRequest = {
|
|
234
|
+
returnAddress: ReturnAddress;
|
|
235
|
+
revision: number;
|
|
236
|
+
};
|
|
237
|
+
export declare type FileEvidence = {
|
|
238
|
+
fileId: string;
|
|
239
|
+
};
|
|
240
|
+
export declare type OrderLineItems = {
|
|
241
|
+
itemId: string;
|
|
242
|
+
lineItemId: string;
|
|
243
|
+
};
|
|
244
|
+
export declare type AddEvidencePaymentDisputeRequest = {
|
|
245
|
+
evidenceType: string;
|
|
246
|
+
files: FileEvidence[];
|
|
247
|
+
lineItems: OrderLineItems[];
|
|
248
|
+
};
|
|
249
|
+
export declare type UpdateEvidencePaymentDisputeRequest = AddEvidencePaymentDisputeRequest & {
|
|
250
|
+
evidenceId: string;
|
|
251
|
+
};
|
|
252
|
+
export declare type Comments = {
|
|
253
|
+
content: string;
|
|
254
|
+
language?: string;
|
|
255
|
+
translatedFromContent?: string;
|
|
256
|
+
translatedFromLanguage?: string;
|
|
257
|
+
};
|
|
258
|
+
export declare type PostOrderItemizedRefundDetailType = {
|
|
259
|
+
refundAmount: Amount;
|
|
260
|
+
refundFeeType: RefundFeeType;
|
|
261
|
+
restockingFeePercentage?: string;
|
|
262
|
+
};
|
|
263
|
+
export declare type RefundDetail = {
|
|
264
|
+
itemizedRefundDetail: PostOrderItemizedRefundDetailType[];
|
|
265
|
+
totalAmount: Amount;
|
|
266
|
+
};
|
|
267
|
+
export declare type PostOrderIssueRefundRequest = {
|
|
268
|
+
comments?: Comments;
|
|
269
|
+
refundDetail: RefundDetail;
|
|
270
|
+
relistItem?: boolean;
|
|
271
|
+
};
|
|
272
|
+
export declare type Interval = {
|
|
273
|
+
close: string;
|
|
274
|
+
open: string;
|
|
275
|
+
};
|
|
276
|
+
export declare type OperatingHours = {
|
|
277
|
+
dayOfWeekEnum: string;
|
|
278
|
+
intervals: Interval[];
|
|
279
|
+
};
|
|
280
|
+
export declare type SpecialHours = {
|
|
281
|
+
date: string;
|
|
282
|
+
intervals: Interval[];
|
|
283
|
+
};
|
|
284
|
+
export declare type InventoryLocation = {
|
|
285
|
+
locationAdditionalInformation?: string;
|
|
286
|
+
locationInstructions?: string;
|
|
287
|
+
locationWebUrl?: string;
|
|
288
|
+
name?: string;
|
|
289
|
+
operatingHours?: OperatingHours;
|
|
290
|
+
phone?: string;
|
|
291
|
+
specialHours?: SpecialHours;
|
|
292
|
+
};
|
|
293
|
+
export declare type GeoCoordinates = {
|
|
294
|
+
latitude: number;
|
|
295
|
+
longitude: number;
|
|
296
|
+
};
|
|
297
|
+
export declare type LocationDetails = {
|
|
298
|
+
address: Address;
|
|
299
|
+
geoCoordinates?: GeoCoordinates;
|
|
300
|
+
};
|
|
301
|
+
export declare type InventoryLocationFull = InventoryLocation & {
|
|
302
|
+
location: LocationDetails;
|
|
303
|
+
locationTypes?: StoreType[];
|
|
304
|
+
merchantLocationStatus?: string;
|
|
305
|
+
};
|
|
306
|
+
export declare type AvailabilityDistribution = {
|
|
307
|
+
fulfillmentTime?: TimeDuration;
|
|
308
|
+
merchantLocationKey: string;
|
|
309
|
+
quantity: number;
|
|
310
|
+
};
|
|
311
|
+
export declare type ShipToLocationAvailability = {
|
|
312
|
+
availabilityDistributions?: AvailabilityDistribution[];
|
|
313
|
+
quantity: number;
|
|
314
|
+
};
|
|
315
|
+
export declare type OfferPriceQuantity = {
|
|
316
|
+
offerId: string;
|
|
317
|
+
availableQuantity: number;
|
|
318
|
+
price: Amount;
|
|
319
|
+
};
|
|
320
|
+
export declare type PriceQuantity = {
|
|
321
|
+
sku: string;
|
|
322
|
+
shipToLocationAvailability: ShipToLocationAvailability;
|
|
323
|
+
offers: OfferPriceQuantity[];
|
|
324
|
+
};
|
|
325
|
+
export declare type BulkPriceQuantity = {
|
|
326
|
+
requests: PriceQuantity[];
|
|
327
|
+
};
|
|
328
|
+
export declare type PickupAtLocationAvailability = {
|
|
329
|
+
availabilityType: string;
|
|
330
|
+
fulfillmentTime: TimeDuration;
|
|
331
|
+
merchantLocationKey: string;
|
|
332
|
+
quantity: number;
|
|
333
|
+
};
|
|
334
|
+
export declare type Availability = {
|
|
335
|
+
pickupAtLocationAvailability?: PickupAtLocationAvailability;
|
|
336
|
+
shipToLocationAvailability: ShipToLocationAvailability;
|
|
337
|
+
};
|
|
338
|
+
export declare type Dimension = {
|
|
339
|
+
height: number;
|
|
340
|
+
length: number;
|
|
341
|
+
unit: LengthUnitOfMeasure;
|
|
342
|
+
width: number;
|
|
343
|
+
};
|
|
344
|
+
export declare type Weight = {
|
|
345
|
+
unit: WeightUnitOfMeasure;
|
|
346
|
+
value: number;
|
|
347
|
+
};
|
|
348
|
+
export declare type PackageWeightAndSize = {
|
|
349
|
+
dimensions?: Dimension;
|
|
350
|
+
packageType?: PackageType;
|
|
351
|
+
weight: Weight;
|
|
352
|
+
};
|
|
353
|
+
export declare type Product = {
|
|
354
|
+
aspects?: any;
|
|
355
|
+
brand?: string;
|
|
356
|
+
description?: string;
|
|
357
|
+
imageUrls: string[];
|
|
358
|
+
mpn?: string;
|
|
359
|
+
subtitle?: string;
|
|
360
|
+
title: string;
|
|
361
|
+
isbn?: string[];
|
|
362
|
+
upc?: string[];
|
|
363
|
+
ean?: string[];
|
|
364
|
+
epid?: string;
|
|
365
|
+
};
|
|
366
|
+
export declare type InventoryItemWithSkuLocale = SellInventoryItem & {
|
|
367
|
+
sku: string;
|
|
368
|
+
locale?: Locale;
|
|
369
|
+
};
|
|
370
|
+
export declare type BulkInventoryItem = {
|
|
371
|
+
requests: InventoryItemWithSkuLocale[];
|
|
372
|
+
};
|
|
373
|
+
export declare type PublishByInventoryItemGroupRequest = {
|
|
374
|
+
inventoryItemGroupKey: string;
|
|
375
|
+
marketplaceId: Marketplace;
|
|
376
|
+
};
|
|
377
|
+
export declare type WithdrawByInventoryItemGroupRequest = {
|
|
378
|
+
inventoryItemGroupKey: string;
|
|
379
|
+
marketplaceId: Marketplace;
|
|
380
|
+
};
|
|
381
|
+
export declare type OfferKeyWithId = {
|
|
382
|
+
offerId: string;
|
|
383
|
+
};
|
|
384
|
+
export declare type OfferKeysWithId = {
|
|
385
|
+
offers: OfferKeyWithId[];
|
|
386
|
+
};
|
|
387
|
+
export declare type ShippingCostOverride = {
|
|
388
|
+
surcharge?: Amount;
|
|
389
|
+
additionalShippingCost?: Amount;
|
|
390
|
+
priority: number;
|
|
391
|
+
shippingCost?: Amount;
|
|
392
|
+
shippingServiceType: string;
|
|
393
|
+
};
|
|
394
|
+
export declare type BestOffer = {
|
|
395
|
+
autoAcceptPrice?: Amount;
|
|
396
|
+
autoDeclinePrice?: Amount;
|
|
397
|
+
bestOfferEnabled?: boolean;
|
|
398
|
+
};
|
|
399
|
+
export declare type ListingPolicies = {
|
|
400
|
+
bestOfferTerms?: BestOffer;
|
|
401
|
+
paymentPolicyId: string;
|
|
402
|
+
returnPolicyId: string;
|
|
403
|
+
shippingCostOverrides?: ShippingCostOverride[];
|
|
404
|
+
fulfillmentPolicyId: string;
|
|
405
|
+
ebayPlusIfEligible?: boolean;
|
|
406
|
+
};
|
|
407
|
+
export declare type PricingSummary = {
|
|
408
|
+
minimumAdvertisedPrice?: Amount;
|
|
409
|
+
pricingVisibility?: string;
|
|
410
|
+
originallySoldForRetailPriceOn?: string;
|
|
411
|
+
originalRetailPrice?: Amount;
|
|
412
|
+
price: Amount;
|
|
413
|
+
};
|
|
414
|
+
export declare type Tax = {
|
|
415
|
+
applyTax: boolean;
|
|
416
|
+
thirdPartyTaxCategory?: string;
|
|
417
|
+
vatPercentage?: number;
|
|
418
|
+
};
|
|
419
|
+
export declare type Charity = {
|
|
420
|
+
charityId: string;
|
|
421
|
+
donationPercentage: string;
|
|
422
|
+
};
|
|
423
|
+
export declare type EbayOfferDetailsWithId = {
|
|
424
|
+
availableQuantity?: number;
|
|
425
|
+
categoryId?: string;
|
|
426
|
+
charity?: Charity;
|
|
427
|
+
includeCatalogProductDetails?: boolean;
|
|
428
|
+
listingDescription?: string;
|
|
429
|
+
listingDuration?: string;
|
|
430
|
+
listingPolicies: ListingPolicies;
|
|
431
|
+
merchantLocationKey: string;
|
|
432
|
+
pricingSummary: PricingSummary;
|
|
433
|
+
quantityLimitPerBuyer?: number;
|
|
434
|
+
secondaryCategoryId?: string;
|
|
435
|
+
tax?: Tax;
|
|
436
|
+
storeCategoryNames?: string[];
|
|
437
|
+
lotSize?: number;
|
|
438
|
+
};
|
|
439
|
+
export declare type EbayOfferDetailsWithKeys = EbayOfferDetailsWithId & {
|
|
440
|
+
sku: string;
|
|
441
|
+
marketplaceId: Marketplace;
|
|
442
|
+
format: FormatType;
|
|
443
|
+
};
|
|
444
|
+
export declare type BulkEbayOfferDetailsWithKeys = {
|
|
445
|
+
requests: EbayOfferDetailsWithKeys[];
|
|
446
|
+
};
|
|
447
|
+
export declare type BulkOffer = {
|
|
448
|
+
requests: OfferKeyWithId[];
|
|
449
|
+
};
|
|
450
|
+
export declare type MigrateListing = {
|
|
451
|
+
listingId: string;
|
|
452
|
+
};
|
|
453
|
+
export declare type BulkMigrateListing = {
|
|
454
|
+
requests: MigrateListing[];
|
|
455
|
+
};
|
|
456
|
+
export declare type FindListingRecommendationRequest = {
|
|
457
|
+
listingIds: string[];
|
|
458
|
+
};
|
|
459
|
+
export declare type TranslateRequest = {
|
|
460
|
+
from: string;
|
|
461
|
+
to: string;
|
|
462
|
+
translationContext: string;
|
|
463
|
+
text: string[];
|
|
464
|
+
};
|
|
465
|
+
export declare type CreateAdsByInventoryReferenceRequest = {
|
|
466
|
+
bidPercentage: string;
|
|
467
|
+
inventoryReferenceId: string;
|
|
468
|
+
inventoryReferenceType: string;
|
|
469
|
+
};
|
|
470
|
+
export declare type BulkCreateAdsByInventoryReferenceRequest = {
|
|
471
|
+
requests: CreateAdsByInventoryReferenceRequest[];
|
|
472
|
+
};
|
|
473
|
+
export declare type CreateAdRequest = {
|
|
474
|
+
bidPercentage: string;
|
|
475
|
+
listingId: string;
|
|
476
|
+
};
|
|
477
|
+
export declare type BulkCreateAdRequest = {
|
|
478
|
+
requests: CreateAdRequest[];
|
|
479
|
+
};
|
|
480
|
+
export declare type DeleteAdsByInventoryReferenceRequest = {
|
|
481
|
+
inventoryReferenceId: string;
|
|
482
|
+
inventoryReferenceType: string;
|
|
483
|
+
};
|
|
484
|
+
export declare type BulkDeleteAdsByInventoryReferenceRequest = {
|
|
485
|
+
requests: DeleteAdsByInventoryReferenceRequest[];
|
|
486
|
+
};
|
|
487
|
+
export declare type DeleteAdRequest = {
|
|
488
|
+
listingId: string;
|
|
489
|
+
};
|
|
490
|
+
export declare type BulkDeleteAdRequest = {
|
|
491
|
+
requests: DeleteAdRequest[];
|
|
492
|
+
};
|
|
493
|
+
export declare type UpdateBidPercentageRequest = {
|
|
494
|
+
bidPercentage: string;
|
|
495
|
+
};
|
|
496
|
+
export declare type FundingStrategy = {
|
|
497
|
+
bidPercentage: string;
|
|
498
|
+
fundingModel: string;
|
|
499
|
+
};
|
|
500
|
+
export declare type CloneCampaignRequest = {
|
|
501
|
+
campaignName: string;
|
|
502
|
+
endDate: string;
|
|
503
|
+
fundingStrategy: FundingStrategy;
|
|
504
|
+
startDate: string;
|
|
505
|
+
};
|
|
506
|
+
export declare type UpdateCampaignIdentificationRequest = {
|
|
507
|
+
campaignName: string;
|
|
508
|
+
endDate: string;
|
|
509
|
+
startDate: string;
|
|
510
|
+
};
|
|
511
|
+
export declare type DiscountBenefit = {
|
|
512
|
+
amountOffItem: Amount;
|
|
513
|
+
amountOffOrder: Amount;
|
|
514
|
+
percentageOffItem: string;
|
|
515
|
+
percentageOffOrder: string;
|
|
516
|
+
};
|
|
517
|
+
export declare type InventoryItem = {
|
|
518
|
+
inventoryReferenceId: string;
|
|
519
|
+
};
|
|
520
|
+
export declare type SelectionRule = {
|
|
521
|
+
brands: string[];
|
|
522
|
+
categoryIds: string[];
|
|
523
|
+
categoryScope: string;
|
|
524
|
+
listingConditionIds: string[];
|
|
525
|
+
maxPrice: Amount;
|
|
526
|
+
minPrice: Amount;
|
|
527
|
+
};
|
|
528
|
+
export declare type RuleCriteria = {
|
|
529
|
+
excludeInventoryItems: InventoryItem[];
|
|
530
|
+
excludeListingIds: string[];
|
|
531
|
+
markupInventoryItems: InventoryItem[];
|
|
532
|
+
markupListingIds: string[];
|
|
533
|
+
selectionRules: SelectionRule;
|
|
534
|
+
};
|
|
535
|
+
export declare type InventoryCriterion = {
|
|
536
|
+
inventoryCriterionType: string;
|
|
537
|
+
inventoryItems: InventoryItem;
|
|
538
|
+
listingIds: string[];
|
|
539
|
+
ruleCriteria: RuleCriteria;
|
|
540
|
+
};
|
|
541
|
+
export declare type SelectedInventoryDiscount = {
|
|
542
|
+
discountBenefit: DiscountBenefit;
|
|
543
|
+
discountId: string;
|
|
544
|
+
inventoryCriterion: InventoryCriterion;
|
|
545
|
+
ruleOrder: number;
|
|
546
|
+
};
|
|
547
|
+
export declare type ItemPriceMarkdown = {
|
|
548
|
+
applyFreeShipping: boolean;
|
|
549
|
+
autoSelectFutureInventory: boolean;
|
|
550
|
+
blockPriceIncreaseInItemRevision: boolean;
|
|
551
|
+
description: string;
|
|
552
|
+
endDate: string;
|
|
553
|
+
marketplaceId: MarketplaceId;
|
|
554
|
+
name: string;
|
|
555
|
+
priority: string;
|
|
556
|
+
promotionImageUrl: string;
|
|
557
|
+
promotionStatus: string;
|
|
558
|
+
selectedInventoryDiscounts: SelectedInventoryDiscount;
|
|
559
|
+
startDate: string;
|
|
560
|
+
};
|
|
561
|
+
export declare type DiscountSpecification = {
|
|
562
|
+
properties: Amount;
|
|
563
|
+
forEachQuantity: number;
|
|
564
|
+
minAmount: Amount;
|
|
565
|
+
minQuantity: number;
|
|
566
|
+
numberOfDiscountedItems: number;
|
|
567
|
+
};
|
|
568
|
+
export declare type DiscountRule = {
|
|
569
|
+
discountBenefit: DiscountBenefit;
|
|
570
|
+
discountSpecification: DiscountSpecification;
|
|
571
|
+
ruleOrder: number;
|
|
572
|
+
};
|
|
573
|
+
export declare type ItemPromotion = {
|
|
574
|
+
applyDiscountToSingleItemOnly: boolean;
|
|
575
|
+
description: string;
|
|
576
|
+
discountRules: DiscountRule[];
|
|
577
|
+
endDate: string;
|
|
578
|
+
inventoryCriterion: InventoryCriterion;
|
|
579
|
+
marketplaceId: MarketplaceId;
|
|
580
|
+
name: string;
|
|
581
|
+
priority: string;
|
|
582
|
+
promotionImageUrl: string;
|
|
583
|
+
promotionStatus: string;
|
|
584
|
+
promotionType: string;
|
|
585
|
+
startDate: string;
|
|
586
|
+
};
|
|
587
|
+
export declare type DateTime = {
|
|
588
|
+
formattedValue?: string;
|
|
589
|
+
value: string;
|
|
590
|
+
};
|
|
591
|
+
export declare type LineItem = {
|
|
592
|
+
itemId: number;
|
|
593
|
+
quantity: number;
|
|
594
|
+
transactionId: number;
|
|
595
|
+
};
|
|
596
|
+
export declare type CreateCancelRequest = {
|
|
597
|
+
buyerPaid?: boolean;
|
|
598
|
+
buyerPaidDate?: DateTime;
|
|
599
|
+
cancelReason?: CancelReason;
|
|
600
|
+
legacyOrderId: string;
|
|
601
|
+
relistLineItem?: LineItem[];
|
|
602
|
+
};
|
|
603
|
+
export declare type ConfirmRefundRequest = {
|
|
604
|
+
refundDate?: DateTime;
|
|
605
|
+
unpaidOrder?: boolean;
|
|
606
|
+
};
|
|
607
|
+
export declare type RejectCancelRequest = {
|
|
608
|
+
shipmentDate?: DateTime;
|
|
609
|
+
trackingNumber?: string;
|
|
610
|
+
};
|
|
611
|
+
export declare type CancelSortField = {
|
|
612
|
+
ascending: boolean;
|
|
613
|
+
enumValue: 'CANCEL_ID' | 'CANCEL_REQUEST_DATE';
|
|
614
|
+
field: '+' | '-';
|
|
615
|
+
};
|
|
616
|
+
export declare type CancellationSearchParams = {
|
|
617
|
+
cancel_id?: string;
|
|
618
|
+
creation_date_range_from?: string;
|
|
619
|
+
creation_date_range_to?: string;
|
|
620
|
+
item_id?: string;
|
|
621
|
+
legacy_order_id?: string;
|
|
622
|
+
limit?: string;
|
|
623
|
+
offset?: string;
|
|
624
|
+
role?: UserRoleFilter;
|
|
625
|
+
sort?: CancelSortField;
|
|
626
|
+
transaction_id?: string;
|
|
627
|
+
};
|
|
628
|
+
export declare type Text = {
|
|
629
|
+
content: string;
|
|
630
|
+
language?: string;
|
|
631
|
+
translatedFromContent?: string;
|
|
632
|
+
translatedFromLanguage?: string;
|
|
633
|
+
};
|
|
634
|
+
export declare type AppealRequest = {
|
|
635
|
+
comments: Text;
|
|
636
|
+
};
|
|
637
|
+
export declare type BuyerCloseCaseRequest = {
|
|
638
|
+
closeReason: boolean;
|
|
639
|
+
comments?: Text;
|
|
640
|
+
};
|
|
641
|
+
export declare type Address = {
|
|
642
|
+
addressLine1?: string;
|
|
643
|
+
addressLine2?: string;
|
|
644
|
+
addressType?: string;
|
|
645
|
+
city?: string;
|
|
646
|
+
country?: CountryCode;
|
|
647
|
+
county?: string;
|
|
648
|
+
isTransliterated?: boolean;
|
|
649
|
+
nationalRegion?: string;
|
|
650
|
+
postalCode?: string;
|
|
651
|
+
script?: string;
|
|
652
|
+
stateOrProvince?: string;
|
|
653
|
+
transliteratedFromScript?: string;
|
|
654
|
+
worldRegion?: string;
|
|
655
|
+
};
|
|
656
|
+
export declare type ReturnAddressRequest = {
|
|
657
|
+
firstName?: string;
|
|
658
|
+
lastName?: string;
|
|
659
|
+
returnAddress?: Address;
|
|
660
|
+
RMA?: string;
|
|
661
|
+
};
|
|
662
|
+
export declare type CaseSearchParams = {
|
|
663
|
+
case_creation_date_range_from: string;
|
|
664
|
+
case_creation_date_range_to: string;
|
|
665
|
+
case_status_filter: CaseStatusFilter;
|
|
666
|
+
fieldgroups: CaseSearchFieldGroup;
|
|
667
|
+
item_id: string;
|
|
668
|
+
limit: number;
|
|
669
|
+
offset: number;
|
|
670
|
+
order_id: string;
|
|
671
|
+
return_id: string;
|
|
672
|
+
sort: string;
|
|
673
|
+
transaction_id: string;
|
|
674
|
+
};
|
|
675
|
+
export declare type CheckInquiryEligibilityRequest = {
|
|
676
|
+
itemId: string;
|
|
677
|
+
transactionId: string;
|
|
678
|
+
};
|
|
679
|
+
export declare type Token = string;
|
|
680
|
+
export declare type BuyerCloseInquiryRequest = {
|
|
681
|
+
closeReason?: Token;
|
|
682
|
+
comments?: Text;
|
|
683
|
+
};
|
|
684
|
+
export declare type CreateInquiryRequest = {
|
|
685
|
+
claimQuantity?: number;
|
|
686
|
+
comments?: Text;
|
|
687
|
+
desiredOutcome?: Token;
|
|
688
|
+
itemId: string;
|
|
689
|
+
transactionId: string;
|
|
690
|
+
};
|
|
691
|
+
export declare type EscalateInquiryRequest = {
|
|
692
|
+
comments?: Text;
|
|
693
|
+
escalateInquiryReason: Token;
|
|
694
|
+
};
|
|
695
|
+
export declare type InquiryVoluntaryRefundRequest = {
|
|
696
|
+
comments?: Text;
|
|
697
|
+
};
|
|
698
|
+
export declare type SellerProvideRefundInfoRequest = {
|
|
699
|
+
message: Text;
|
|
700
|
+
};
|
|
701
|
+
export declare type ShipmentInfoRequest = {
|
|
702
|
+
proofOfShipmentUploaded?: boolean;
|
|
703
|
+
sellerComments?: Text;
|
|
704
|
+
shippedWithTracking?: boolean;
|
|
705
|
+
shippingCarrierName?: string;
|
|
706
|
+
shippingDate?: DateTime;
|
|
707
|
+
trackingNumber?: string;
|
|
708
|
+
};
|
|
709
|
+
export declare type InquirySearchParams = {
|
|
710
|
+
fieldgroups?: InquirySearchFieldGroup;
|
|
711
|
+
inquiry_creation_date_range_from?: string;
|
|
712
|
+
inquiry_creation_date_range_to?: string;
|
|
713
|
+
inquiry_status?: InquiryStatusFilter;
|
|
714
|
+
item_id?: string;
|
|
715
|
+
limit?: number;
|
|
716
|
+
offset?: number;
|
|
717
|
+
order_id?: string;
|
|
718
|
+
sort?: string;
|
|
719
|
+
transaction_id?: string;
|
|
720
|
+
};
|
|
721
|
+
export declare type SendMessageRequest = {
|
|
722
|
+
message: Text;
|
|
723
|
+
};
|
|
724
|
+
export declare type UpdateTrackingRequest = {
|
|
725
|
+
newCarrierEnum?: ShippingCarrier;
|
|
726
|
+
newCarrierName?: string;
|
|
727
|
+
newTrackingNumber?: string;
|
|
728
|
+
usedCarrierEnum?: ShippingCarrier;
|
|
729
|
+
usedCarrierName?: string;
|
|
730
|
+
usedTrackingNumber?: string;
|
|
731
|
+
};
|
|
732
|
+
export declare type ReturnRequestType = {
|
|
733
|
+
carrier?: ShippingCarrier;
|
|
734
|
+
comments?: Text;
|
|
735
|
+
itemId: string;
|
|
736
|
+
reason?: ReturnReason;
|
|
737
|
+
requestType: RequestType;
|
|
738
|
+
returnQuantity?: number;
|
|
739
|
+
transactionId: string;
|
|
740
|
+
type?: ReturnType;
|
|
741
|
+
};
|
|
742
|
+
export declare type SetReturnCreationSessionRequest = {
|
|
743
|
+
returnRequest: ReturnRequestType;
|
|
744
|
+
};
|
|
745
|
+
export declare type CreateReturnRequest = {
|
|
746
|
+
draftId?: string;
|
|
747
|
+
returnRequest: ReturnRequestType;
|
|
748
|
+
};
|
|
749
|
+
export declare type ProvideLabelRequest = {
|
|
750
|
+
carrierEnum?: ShippingCarrier;
|
|
751
|
+
carrierName?: string;
|
|
752
|
+
comments?: Text;
|
|
753
|
+
fileId?: string;
|
|
754
|
+
forwardShippingLabelProvided?: boolean;
|
|
755
|
+
labelAction: Token;
|
|
756
|
+
labelSentDate?: DateTime;
|
|
757
|
+
noLabelReason: Token;
|
|
758
|
+
returnLabelCost?: Amount;
|
|
759
|
+
trackingNumber?: string;
|
|
760
|
+
};
|
|
761
|
+
export declare type CloseReturnRequest = {
|
|
762
|
+
buyerCloseReason?: Token;
|
|
763
|
+
comments?: Text;
|
|
764
|
+
};
|
|
765
|
+
export declare type CheckEligibilityRequest = {
|
|
766
|
+
checkTypes: Token[];
|
|
767
|
+
itemId: string;
|
|
768
|
+
reason: Token;
|
|
769
|
+
returnQuantity?: number;
|
|
770
|
+
transactionId: string;
|
|
771
|
+
};
|
|
772
|
+
export declare type EscalateRequest = {
|
|
773
|
+
comments: Text;
|
|
774
|
+
reason: EscalateReason;
|
|
775
|
+
};
|
|
776
|
+
export declare type GetEstimateRequest = {
|
|
777
|
+
itemId: string;
|
|
778
|
+
reason?: ReturnReason;
|
|
779
|
+
returnQuantity?: number;
|
|
780
|
+
transactionId: string;
|
|
781
|
+
};
|
|
782
|
+
export declare type MarkAsReceivedRequest = {
|
|
783
|
+
comments?: Text;
|
|
784
|
+
};
|
|
785
|
+
export declare type ItemizedRefundDetailType = {
|
|
786
|
+
refundAmount: Amount;
|
|
787
|
+
refundFeeType: Token;
|
|
788
|
+
};
|
|
789
|
+
export declare type RefundDetailType = {
|
|
790
|
+
itemizedRefundDetail: ItemizedRefundDetailType;
|
|
791
|
+
totalAmount: Amount;
|
|
792
|
+
};
|
|
793
|
+
export declare type MarkRefundSentRequest = {
|
|
794
|
+
comments?: Text;
|
|
795
|
+
partialRefundAmount?: Amount;
|
|
796
|
+
refundDetail: RefundDetailType;
|
|
797
|
+
};
|
|
798
|
+
export declare type MarkAsShippedRequest = {
|
|
799
|
+
carrierEnum?: ShippingCarrier;
|
|
800
|
+
carrierName?: string;
|
|
801
|
+
carrierUsed?: string;
|
|
802
|
+
comments?: Text;
|
|
803
|
+
shippedDate?: DateTime;
|
|
804
|
+
trackingNumber: string;
|
|
805
|
+
};
|
|
806
|
+
export declare type UploadFileRequest = {
|
|
807
|
+
data: any;
|
|
808
|
+
fileName?: string;
|
|
809
|
+
filePurpose: FilePurpose;
|
|
810
|
+
};
|
|
811
|
+
export declare type VoidLabelRequest = {
|
|
812
|
+
comments?: Text;
|
|
813
|
+
labelId: string;
|
|
814
|
+
};
|
|
815
|
+
export declare type SearchReturnParams = {
|
|
816
|
+
creation_date_range_from?: string;
|
|
817
|
+
creation_date_range_to?: string;
|
|
818
|
+
item_id?: string;
|
|
819
|
+
limit?: number;
|
|
820
|
+
offset?: number;
|
|
821
|
+
order_id?: string;
|
|
822
|
+
return_id?: string;
|
|
823
|
+
return_state?: Token;
|
|
824
|
+
role?: Token;
|
|
825
|
+
sort?: ReturnCountFilter;
|
|
826
|
+
states?: ReturnState;
|
|
827
|
+
transaction_id?: string;
|
|
828
|
+
};
|
|
829
|
+
export declare type DecideReturnRequest = {
|
|
830
|
+
comments?: Text;
|
|
831
|
+
decision: Decision;
|
|
832
|
+
keepOriginalItem?: boolean;
|
|
833
|
+
partialRefundAmount?: Amount;
|
|
834
|
+
RMANumber?: string;
|
|
835
|
+
rMAProvided?: boolean;
|
|
836
|
+
};
|
|
837
|
+
export declare type CategoryType = {
|
|
838
|
+
default?: boolean;
|
|
839
|
+
name: CategoryTypeEnum;
|
|
840
|
+
};
|
|
841
|
+
export declare type TimeDuration = {
|
|
842
|
+
unit: TimeDurationUnit;
|
|
843
|
+
value: number;
|
|
844
|
+
};
|
|
845
|
+
export declare type Region = {
|
|
846
|
+
regionName: string;
|
|
847
|
+
regionType?: RegionType;
|
|
848
|
+
};
|
|
849
|
+
export declare type RegionSet = {
|
|
850
|
+
regionExcluded?: Region[];
|
|
851
|
+
regionIncluded?: Region[];
|
|
852
|
+
};
|
|
853
|
+
export declare type ShippingService = {
|
|
854
|
+
additionalShippingCost?: Amount;
|
|
855
|
+
buyerResponsibleForPickup?: boolean;
|
|
856
|
+
buyerResponsibleForShipping?: boolean;
|
|
857
|
+
cashOnDeliveryFee?: Amount;
|
|
858
|
+
freeShipping?: boolean;
|
|
859
|
+
shippingCarrierCode?: string;
|
|
860
|
+
shippingCost?: Amount;
|
|
861
|
+
shippingServiceCode?: string;
|
|
862
|
+
shipToLocations?: RegionSet;
|
|
863
|
+
sortOrder?: number;
|
|
864
|
+
surcharge?: Amount;
|
|
865
|
+
};
|
|
866
|
+
export declare type ShippingOption = {
|
|
867
|
+
costType: ShippingCostType;
|
|
868
|
+
insuranceFee?: Amount;
|
|
869
|
+
insuranceOffered?: boolean;
|
|
870
|
+
optionType: ShippingOptionType;
|
|
871
|
+
packageHandlingCost?: Amount;
|
|
872
|
+
rateTableId?: string;
|
|
873
|
+
shippingServices: ShippingService[];
|
|
874
|
+
};
|
|
875
|
+
export declare type FulfillmentPolicyRequest = {
|
|
876
|
+
categoryTypes: CategoryType[];
|
|
877
|
+
description?: string;
|
|
878
|
+
freightShipping?: boolean;
|
|
879
|
+
globalShipping?: boolean;
|
|
880
|
+
handlingTime: TimeDuration;
|
|
881
|
+
localPickup?: boolean;
|
|
882
|
+
marketplaceId: MarketplaceId;
|
|
883
|
+
name: string;
|
|
884
|
+
pickupDropOff?: boolean;
|
|
885
|
+
shippingOptions?: ShippingOption[];
|
|
886
|
+
shipToLocations?: RegionSet;
|
|
887
|
+
};
|
|
888
|
+
export declare type RecipientAccountReference = {
|
|
889
|
+
referenceId: string;
|
|
890
|
+
referenceType: RecipientAccountReferenceType;
|
|
891
|
+
};
|
|
892
|
+
export declare type PaymentMethod = {
|
|
893
|
+
brands?: string[];
|
|
894
|
+
paymentMethodType?: PaymentMethodType;
|
|
895
|
+
recipientAccountReference?: RecipientAccountReference;
|
|
896
|
+
};
|
|
897
|
+
export declare type Deposit = {
|
|
898
|
+
amount?: Amount;
|
|
899
|
+
dueIn?: TimeDuration;
|
|
900
|
+
paymentMethods: PaymentMethod[];
|
|
901
|
+
};
|
|
902
|
+
export declare type PaymentPolicyRequest = {
|
|
903
|
+
categoryTypes: CategoryType[];
|
|
904
|
+
deposit?: Deposit;
|
|
905
|
+
description?: string;
|
|
906
|
+
fullPaymentDueIn?: TimeDuration;
|
|
907
|
+
immediatePay?: boolean;
|
|
908
|
+
marketplaceId: MarketplaceId;
|
|
909
|
+
name: string;
|
|
910
|
+
paymentInstructions?: string;
|
|
911
|
+
paymentMethods?: PaymentMethod[];
|
|
912
|
+
};
|
|
913
|
+
export declare type InternationalReturnOverrideType = {
|
|
914
|
+
returnMethod?: ReturnMethod;
|
|
915
|
+
returnPeriod?: TimeDuration;
|
|
916
|
+
returnsAccepted?: boolean;
|
|
917
|
+
returnShippingCostPayer?: ReturnShippingCostPayer;
|
|
918
|
+
};
|
|
919
|
+
export declare type ReturnPolicyRequest = {
|
|
920
|
+
categoryTypes?: CategoryType[];
|
|
921
|
+
description?: string;
|
|
922
|
+
extendedHolidayReturnsOffered?: boolean;
|
|
923
|
+
internationalOverride?: InternationalReturnOverrideType;
|
|
924
|
+
marketplaceId: MarketplaceId;
|
|
925
|
+
name: string;
|
|
926
|
+
refundMethod?: ReturnMethod;
|
|
927
|
+
restockingFeePercentage?: string;
|
|
928
|
+
returnInstructions?: string;
|
|
929
|
+
returnMethod?: ReturnMethod;
|
|
930
|
+
returnPeriod?: TimeDuration;
|
|
931
|
+
returnsAccepted: boolean;
|
|
932
|
+
returnShippingCostPayer?: ReturnShippingCostPayer;
|
|
933
|
+
};
|
|
934
|
+
export declare type SalesTaxBase = {
|
|
935
|
+
salesTaxPercentage: string;
|
|
936
|
+
shippingAndHandlingTaxed: boolean;
|
|
937
|
+
};
|
|
938
|
+
export declare type LineItemReference = {
|
|
939
|
+
lineItemId: string;
|
|
940
|
+
quantity?: number;
|
|
941
|
+
};
|
|
942
|
+
export declare type ShippingFulfillmentDetails = {
|
|
943
|
+
lineItems: LineItemReference[];
|
|
944
|
+
shippedDate?: string;
|
|
945
|
+
shippingCarrierCode: string;
|
|
946
|
+
trackingNumber: string;
|
|
947
|
+
};
|
|
948
|
+
export declare type SellInventoryItem = {
|
|
949
|
+
availability: Availability;
|
|
950
|
+
condition: Condition;
|
|
951
|
+
conditionDescription?: string;
|
|
952
|
+
packageWeightAndSize?: PackageWeightAndSize;
|
|
953
|
+
product: Product;
|
|
954
|
+
};
|
|
955
|
+
export declare type ProductFamilyProperties = {
|
|
956
|
+
make: string;
|
|
957
|
+
model: string;
|
|
958
|
+
year: string;
|
|
959
|
+
trim?: string;
|
|
960
|
+
engine?: string;
|
|
961
|
+
};
|
|
962
|
+
export declare type ProductIdentifier = {
|
|
963
|
+
epid?: string;
|
|
964
|
+
gtin?: string;
|
|
965
|
+
ktype?: string;
|
|
966
|
+
};
|
|
967
|
+
export declare type NameValueList = {
|
|
968
|
+
name: string;
|
|
969
|
+
value: string;
|
|
970
|
+
};
|
|
971
|
+
export declare type CompatibleProduct = {
|
|
972
|
+
compatibilityProperties?: NameValueList[];
|
|
973
|
+
productFamilyProperties?: ProductFamilyProperties;
|
|
974
|
+
productIdentifier?: ProductIdentifier;
|
|
975
|
+
notes?: string;
|
|
976
|
+
};
|
|
977
|
+
export declare type Compatibility = {
|
|
978
|
+
compatibleProducts: CompatibleProduct[];
|
|
979
|
+
};
|
|
980
|
+
export declare type Specification = {
|
|
981
|
+
name: string;
|
|
982
|
+
values: string[];
|
|
983
|
+
};
|
|
984
|
+
export declare type VariesBy = {
|
|
985
|
+
aspectsImageVariesBy: string[];
|
|
986
|
+
specifications: Specification[];
|
|
987
|
+
};
|
|
988
|
+
export declare type InventoryItemGroup = {
|
|
989
|
+
aspects: any;
|
|
990
|
+
description: string;
|
|
991
|
+
inventoryItemGroupKey: string;
|
|
992
|
+
imageUrls: string[];
|
|
993
|
+
subtitle?: string;
|
|
994
|
+
title: string;
|
|
995
|
+
variantSKUs: string[];
|
|
996
|
+
variesBy: VariesBy;
|
|
997
|
+
};
|
|
998
|
+
export declare type CampaignCriterion = {
|
|
999
|
+
autoSelectFutureInventory: boolean;
|
|
1000
|
+
criterionType: string;
|
|
1001
|
+
selectionRules: SelectionRule[];
|
|
1002
|
+
};
|
|
1003
|
+
export declare type CreateCampaignRequest = {
|
|
1004
|
+
campaignCriterion: CampaignCriterion;
|
|
1005
|
+
campaignName: string;
|
|
1006
|
+
endDate: string;
|
|
1007
|
+
fundingStrategy: FundingStrategy;
|
|
1008
|
+
marketplaceId: MarketplaceId;
|
|
1009
|
+
startDate: string;
|
|
1010
|
+
};
|
|
1011
|
+
export declare type InventoryReference = {
|
|
1012
|
+
inventoryReferenceId?: string;
|
|
1013
|
+
inventoryReferenceType?: string;
|
|
1014
|
+
};
|
|
1015
|
+
export declare type CreateReportTask = {
|
|
1016
|
+
campaignIds: string[];
|
|
1017
|
+
dateFrom: string;
|
|
1018
|
+
dateTo: string;
|
|
1019
|
+
dimensions: Dimension[];
|
|
1020
|
+
inventoryReferences?: InventoryReference;
|
|
1021
|
+
listingIds: string[];
|
|
1022
|
+
marketplaceId: MarketplaceId;
|
|
1023
|
+
metricKeys: string[];
|
|
1024
|
+
reportFormat: string;
|
|
1025
|
+
reportType: string;
|
|
1026
|
+
};
|
|
1027
|
+
export declare type SellFeedParams = {
|
|
1028
|
+
dateRange?: string;
|
|
1029
|
+
feedType?: string;
|
|
1030
|
+
limit?: string;
|
|
1031
|
+
lookBackDays?: string;
|
|
1032
|
+
offset?: string;
|
|
1033
|
+
scheduleId?: string;
|
|
1034
|
+
};
|
|
1035
|
+
export declare type MarketingInsightsSearchParams = {
|
|
1036
|
+
aspectFilter?: string;
|
|
1037
|
+
categoryIds?: string;
|
|
1038
|
+
epid?: string;
|
|
1039
|
+
fieldgroups?: string;
|
|
1040
|
+
filter?: string;
|
|
1041
|
+
gtin?: string;
|
|
1042
|
+
limit?: string;
|
|
1043
|
+
offset?: string;
|
|
1044
|
+
q?: string;
|
|
1045
|
+
sort?: string;
|
|
1046
|
+
};
|
|
1047
|
+
export declare type NotificationParams = {
|
|
1048
|
+
limit?: string;
|
|
1049
|
+
continuationToken?: string;
|
|
1050
|
+
};
|
|
1051
|
+
export declare type SubscriptionPayloadDetail = {
|
|
1052
|
+
format: string;
|
|
1053
|
+
schemaVersion: string;
|
|
1054
|
+
deliveryProtocol: string;
|
|
1055
|
+
};
|
|
1056
|
+
export declare type CreateSubscriptionRequest = {
|
|
1057
|
+
topicId: string;
|
|
1058
|
+
status: string;
|
|
1059
|
+
payload: SubscriptionPayloadDetail;
|
|
1060
|
+
destinationId: string;
|
|
1061
|
+
};
|
|
1062
|
+
export declare type UpdateSubscriptionRequest = Omit<CreateSubscriptionRequest, 'topicId'>;
|
|
1063
|
+
export declare type DeliveryConfig = {
|
|
1064
|
+
endpoint: string;
|
|
1065
|
+
verificationToken: string;
|
|
1066
|
+
};
|
|
1067
|
+
export declare type DestinationRequest = {
|
|
1068
|
+
name: string;
|
|
1069
|
+
status: string;
|
|
1070
|
+
deliveryConfig: DeliveryConfig;
|
|
1071
|
+
};
|
|
1072
|
+
export declare type NotificationConfig = {
|
|
1073
|
+
alertEmail: string;
|
|
1074
|
+
};
|
|
1075
|
+
export declare type ItemsParams = {
|
|
1076
|
+
itemIds: string;
|
|
1077
|
+
itemGroupIds: string;
|
|
1078
|
+
};
|
|
1079
|
+
export declare type SuppressViolationRequest = {
|
|
1080
|
+
complianceType: string;
|
|
1081
|
+
listingId: string;
|
|
1082
|
+
};
|