ebay-mcp 1.4.3
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 +201 -0
- package/README.md +586 -0
- package/build/api/account-management/account.d.ts +216 -0
- package/build/api/account-management/account.js +305 -0
- package/build/api/analytics-and-report/analytics.d.ts +33 -0
- package/build/api/analytics-and-report/analytics.js +102 -0
- package/build/api/client.d.ts +89 -0
- package/build/api/client.js +343 -0
- package/build/api/communication/feedback.d.ts +45 -0
- package/build/api/communication/feedback.js +119 -0
- package/build/api/communication/message.d.ts +55 -0
- package/build/api/communication/message.js +131 -0
- package/build/api/communication/negotiation.d.ts +39 -0
- package/build/api/communication/negotiation.js +97 -0
- package/build/api/communication/notification.d.ts +128 -0
- package/build/api/communication/notification.js +373 -0
- package/build/api/index.d.ts +96 -0
- package/build/api/index.js +121 -0
- package/build/api/listing-management/inventory.d.ts +216 -0
- package/build/api/listing-management/inventory.js +633 -0
- package/build/api/listing-metadata/metadata.d.ts +154 -0
- package/build/api/listing-metadata/metadata.js +485 -0
- package/build/api/listing-metadata/taxonomy.d.ts +38 -0
- package/build/api/listing-metadata/taxonomy.js +58 -0
- package/build/api/marketing-and-promotions/marketing.d.ts +395 -0
- package/build/api/marketing-and-promotions/marketing.js +565 -0
- package/build/api/marketing-and-promotions/recommendation.d.ts +20 -0
- package/build/api/marketing-and-promotions/recommendation.js +32 -0
- package/build/api/order-management/dispute.d.ts +65 -0
- package/build/api/order-management/dispute.js +69 -0
- package/build/api/order-management/fulfillment.d.ts +80 -0
- package/build/api/order-management/fulfillment.js +89 -0
- package/build/api/other/compliance.d.ts +26 -0
- package/build/api/other/compliance.js +47 -0
- package/build/api/other/edelivery.d.ts +153 -0
- package/build/api/other/edelivery.js +219 -0
- package/build/api/other/identity.d.ts +17 -0
- package/build/api/other/identity.js +24 -0
- package/build/api/other/translation.d.ts +14 -0
- package/build/api/other/translation.js +22 -0
- package/build/api/other/vero.d.ts +30 -0
- package/build/api/other/vero.js +48 -0
- package/build/auth/oauth-metadata.d.ts +46 -0
- package/build/auth/oauth-metadata.js +59 -0
- package/build/auth/oauth-middleware.d.ts +35 -0
- package/build/auth/oauth-middleware.js +99 -0
- package/build/auth/oauth-types.d.ts +66 -0
- package/build/auth/oauth-types.js +4 -0
- package/build/auth/oauth.d.ts +93 -0
- package/build/auth/oauth.js +383 -0
- package/build/auth/scope-utils.d.ts +70 -0
- package/build/auth/scope-utils.js +304 -0
- package/build/auth/token-verifier.d.ts +57 -0
- package/build/auth/token-verifier.js +172 -0
- package/build/config/environment.d.ts +61 -0
- package/build/config/environment.js +260 -0
- package/build/index.d.ts +1 -0
- package/build/index.js +98 -0
- package/build/schemas/account-management/account.d.ts +5324 -0
- package/build/schemas/account-management/account.js +366 -0
- package/build/schemas/analytics/analytics.d.ts +167 -0
- package/build/schemas/analytics/analytics.js +191 -0
- package/build/schemas/communication/messages.d.ts +1872 -0
- package/build/schemas/communication/messages.js +348 -0
- package/build/schemas/fulfillment/orders.d.ts +4655 -0
- package/build/schemas/fulfillment/orders.js +317 -0
- package/build/schemas/index.d.ts +2100 -0
- package/build/schemas/index.js +68 -0
- package/build/schemas/inventory-management/inventory.d.ts +6419 -0
- package/build/schemas/inventory-management/inventory.js +450 -0
- package/build/schemas/marketing/marketing.d.ts +14181 -0
- package/build/schemas/marketing/marketing.js +1088 -0
- package/build/schemas/metadata/metadata.d.ts +5259 -0
- package/build/schemas/metadata/metadata.js +614 -0
- package/build/schemas/other/other-apis.d.ts +257 -0
- package/build/schemas/other/other-apis.js +372 -0
- package/build/schemas/taxonomy/taxonomy.d.ts +215 -0
- package/build/schemas/taxonomy/taxonomy.js +571 -0
- package/build/scripts/auto-setup.d.ts +12 -0
- package/build/scripts/auto-setup.js +277 -0
- package/build/scripts/diagnostics.d.ts +8 -0
- package/build/scripts/diagnostics.js +299 -0
- package/build/scripts/download-specs.d.ts +1 -0
- package/build/scripts/download-specs.js +116 -0
- package/build/scripts/interactive-setup.d.ts +21 -0
- package/build/scripts/interactive-setup.js +723 -0
- package/build/server-http.d.ts +11 -0
- package/build/server-http.js +361 -0
- package/build/tools/definitions/account-with-schemas.d.ts +39 -0
- package/build/tools/definitions/account-with-schemas.js +170 -0
- package/build/tools/definitions/account.d.ts +12 -0
- package/build/tools/definitions/account.js +428 -0
- package/build/tools/definitions/analytics.d.ts +25 -0
- package/build/tools/definitions/analytics.js +66 -0
- package/build/tools/definitions/communication.d.ts +12 -0
- package/build/tools/definitions/communication.js +151 -0
- package/build/tools/definitions/fulfillment.d.ts +12 -0
- package/build/tools/definitions/fulfillment.js +326 -0
- package/build/tools/definitions/index.d.ts +25 -0
- package/build/tools/definitions/index.js +37 -0
- package/build/tools/definitions/inventory.d.ts +12 -0
- package/build/tools/definitions/inventory.js +429 -0
- package/build/tools/definitions/marketing.d.ts +12 -0
- package/build/tools/definitions/marketing.js +1095 -0
- package/build/tools/definitions/metadata.d.ts +12 -0
- package/build/tools/definitions/metadata.js +188 -0
- package/build/tools/definitions/other.d.ts +13 -0
- package/build/tools/definitions/other.js +309 -0
- package/build/tools/definitions/taxonomy.d.ts +25 -0
- package/build/tools/definitions/taxonomy.js +64 -0
- package/build/tools/definitions/token-management.d.ts +35 -0
- package/build/tools/definitions/token-management.js +103 -0
- package/build/tools/index.d.ts +11 -0
- package/build/tools/index.js +1003 -0
- package/build/tools/schemas.d.ts +14764 -0
- package/build/tools/schemas.js +667 -0
- package/build/tools/tool-definitions.d.ts +35 -0
- package/build/tools/tool-definitions.js +3534 -0
- package/build/types/application-settings/developerAnalyticsV1BetaOas3.d.ts +197 -0
- package/build/types/application-settings/developerAnalyticsV1BetaOas3.js +5 -0
- package/build/types/application-settings/developerClientRegistrationV1Oas3.d.ts +155 -0
- package/build/types/application-settings/developerClientRegistrationV1Oas3.js +5 -0
- package/build/types/application-settings/developerKeyManagementV1Oas3.d.ts +246 -0
- package/build/types/application-settings/developerKeyManagementV1Oas3.js +5 -0
- package/build/types/ebay-enums.d.ts +1204 -0
- package/build/types/ebay-enums.js +1330 -0
- package/build/types/ebay.d.ts +143 -0
- package/build/types/ebay.js +123 -0
- package/build/types/index.d.ts +6 -0
- package/build/types/index.js +10 -0
- package/build/types/sell-apps/account-management/sellAccountV1Oas3.d.ts +2579 -0
- package/build/types/sell-apps/account-management/sellAccountV1Oas3.js +5 -0
- package/build/types/sell-apps/analytics-and-report/sellAnalyticsV1Oas3.d.ts +446 -0
- package/build/types/sell-apps/analytics-and-report/sellAnalyticsV1Oas3.js +5 -0
- package/build/types/sell-apps/communication/commerceFeedbackV1BetaOas3.d.ts +705 -0
- package/build/types/sell-apps/communication/commerceFeedbackV1BetaOas3.js +5 -0
- package/build/types/sell-apps/communication/commerceMessageV1Oas3.d.ts +590 -0
- package/build/types/sell-apps/communication/commerceMessageV1Oas3.js +5 -0
- package/build/types/sell-apps/communication/commerceNotificationV1Oas3.d.ts +1276 -0
- package/build/types/sell-apps/communication/commerceNotificationV1Oas3.js +5 -0
- package/build/types/sell-apps/communication/sellNegotiationV1Oas3.d.ts +277 -0
- package/build/types/sell-apps/communication/sellNegotiationV1Oas3.js +5 -0
- package/build/types/sell-apps/listing-management/sellInventoryV1Oas3.d.ts +3133 -0
- package/build/types/sell-apps/listing-management/sellInventoryV1Oas3.js +5 -0
- package/build/types/sell-apps/listing-metadata/sellMetadataV1Oas3.d.ts +2289 -0
- package/build/types/sell-apps/listing-metadata/sellMetadataV1Oas3.js +5 -0
- package/build/types/sell-apps/markeitng-and-promotions/sellMarketingV1Oas3.d.ts +6650 -0
- package/build/types/sell-apps/markeitng-and-promotions/sellMarketingV1Oas3.js +5 -0
- package/build/types/sell-apps/markeitng-and-promotions/sellRecommendationV1Oas3.d.ts +172 -0
- package/build/types/sell-apps/markeitng-and-promotions/sellRecommendationV1Oas3.js +5 -0
- package/build/types/sell-apps/order-management/sellFulfillmentV1Oas3.d.ts +1869 -0
- package/build/types/sell-apps/order-management/sellFulfillmentV1Oas3.js +5 -0
- package/build/types/sell-apps/other-apis/commerceIdentityV1Oas3.d.ts +178 -0
- package/build/types/sell-apps/other-apis/commerceIdentityV1Oas3.js +5 -0
- package/build/types/sell-apps/other-apis/commerceTranslationV1BetaOas3.d.ts +128 -0
- package/build/types/sell-apps/other-apis/commerceTranslationV1BetaOas3.js +5 -0
- package/build/types/sell-apps/other-apis/commerceVeroV1Oas3.d.ts +417 -0
- package/build/types/sell-apps/other-apis/commerceVeroV1Oas3.js +5 -0
- package/build/types/sell-apps/other-apis/sellComplianceV1Oas3.d.ts +273 -0
- package/build/types/sell-apps/other-apis/sellComplianceV1Oas3.js +5 -0
- package/build/types/sell-apps/other-apis/sellEdeliveryInternationalShippingOas3.d.ts +2537 -0
- package/build/types/sell-apps/other-apis/sellEdeliveryInternationalShippingOas3.js +5 -0
- package/build/types/sell-apps/other-apis/sellMarketingV1Oas3.d.ts +6650 -0
- package/build/types/sell-apps/other-apis/sellMarketingV1Oas3.js +5 -0
- package/build/types/sell-apps/other-apis/sellRecommendationV1Oas3.d.ts +172 -0
- package/build/types/sell-apps/other-apis/sellRecommendationV1Oas3.js +5 -0
- package/build/utils/account-management/account.d.ts +1094 -0
- package/build/utils/account-management/account.js +831 -0
- package/build/utils/communication/feedback.d.ts +152 -0
- package/build/utils/communication/feedback.js +216 -0
- package/build/utils/communication/message.d.ts +174 -0
- package/build/utils/communication/message.js +242 -0
- package/build/utils/communication/negotiation.d.ts +123 -0
- package/build/utils/communication/negotiation.js +150 -0
- package/build/utils/communication/notification.d.ts +370 -0
- package/build/utils/communication/notification.js +369 -0
- package/build/utils/date-converter.d.ts +59 -0
- package/build/utils/date-converter.js +160 -0
- package/build/utils/llm-client-detector.d.ts +54 -0
- package/build/utils/llm-client-detector.js +318 -0
- package/build/utils/oauth-helper.d.ts +37 -0
- package/build/utils/oauth-helper.js +315 -0
- package/build/utils/order-management/dispute.d.ts +346 -0
- package/build/utils/order-management/dispute.js +369 -0
- package/build/utils/order-management/fulfillment.d.ts +200 -0
- package/build/utils/order-management/fulfillment.js +205 -0
- package/build/utils/other/compliance.d.ts +49 -0
- package/build/utils/other/compliance.js +76 -0
- package/build/utils/other/edelivery.d.ts +310 -0
- package/build/utils/other/edelivery.js +241 -0
- package/build/utils/other/identity.d.ts +13 -0
- package/build/utils/other/identity.js +13 -0
- package/build/utils/other/translation.d.ts +28 -0
- package/build/utils/other/translation.js +41 -0
- package/build/utils/other/vero.d.ts +61 -0
- package/build/utils/other/vero.js +90 -0
- package/build/utils/scope-helper.d.ts +49 -0
- package/build/utils/scope-helper.js +207 -0
- package/build/utils/security-checker.d.ts +46 -0
- package/build/utils/security-checker.js +248 -0
- package/build/utils/setup-validator.d.ts +25 -0
- package/build/utils/setup-validator.js +305 -0
- package/build/utils/token-utils.d.ts +40 -0
- package/build/utils/token-utils.js +40 -0
- package/package.json +115 -0
|
@@ -0,0 +1,2289 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export interface paths {
|
|
6
|
+
'/marketplace/{marketplace_id}/get_automotive_parts_compatibility_policies': {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/** @description This method returns the eBay policies that define how to list automotive parts compatibility items in the categories of the specified marketplace. <br><br>By default, this method returns all categories that support parts compatibility. You can limit the size of the result set by using the <b>filter</b> query parameter to specify only the category IDs you want to review.<br><br><span class="tablenote"><b>Note: </b>To return policy information for the eBay US marketplace, specify <code>EBAY_MOTORS_US</code> as the path parameter for <b>marketplace_id</b>.</span><br><span class="tablenote"><span style="color:#478415"><strong>Tip:</strong></span> This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the <b>Accept-Encoding</b> request header and setting the value to <code>gzip</code>.</span><br>If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a <b>204 No content</b> status code is returned with an empty response body. */
|
|
14
|
+
get: operations['getAutomotivePartsCompatibilityPolicies'];
|
|
15
|
+
put?: never;
|
|
16
|
+
post?: never;
|
|
17
|
+
delete?: never;
|
|
18
|
+
options?: never;
|
|
19
|
+
head?: never;
|
|
20
|
+
patch?: never;
|
|
21
|
+
trace?: never;
|
|
22
|
+
};
|
|
23
|
+
'/marketplace/{marketplace_id}/get_category_policies': {
|
|
24
|
+
parameters: {
|
|
25
|
+
query?: never;
|
|
26
|
+
header?: never;
|
|
27
|
+
path?: never;
|
|
28
|
+
cookie?: never;
|
|
29
|
+
};
|
|
30
|
+
/** @description This method returns eBay category policy metadata for all leaf categories on the specified marketplace.<p>By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the <b>filter</b> query parameter to specify only the leaf category IDs you want to review.</p><p>If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a <b>204 No content</b> status code with an empty response body.</p> */
|
|
31
|
+
get: operations['getCategoryPolicies'];
|
|
32
|
+
put?: never;
|
|
33
|
+
post?: never;
|
|
34
|
+
delete?: never;
|
|
35
|
+
options?: never;
|
|
36
|
+
head?: never;
|
|
37
|
+
patch?: never;
|
|
38
|
+
trace?: never;
|
|
39
|
+
};
|
|
40
|
+
'/marketplace/{marketplace_id}/get_classified_ad_policies': {
|
|
41
|
+
parameters: {
|
|
42
|
+
query?: never;
|
|
43
|
+
header?: never;
|
|
44
|
+
path?: never;
|
|
45
|
+
cookie?: never;
|
|
46
|
+
};
|
|
47
|
+
/** @description This method returns eBay classified ad policy metadata for all leaf categories on the specified marketplace.<p>By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the <b>filter</b> query parameter to specify only the leaf category IDs you want to review.</p><p>If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a <b>204 No content</b> status code with an empty response body.</p><p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>This method does not support classified ads for eBay US Motors categories (EBAY_MOTORS_US). For eBay Motors Pro users, use <a href="/api-docs/sell/metadata/resources/marketplace/methods/getMotorsListingPolicies" target="_blank">getMotorsListingPolicies</a>.</span></p> */
|
|
48
|
+
get: operations['getClassifiedAdPolicies'];
|
|
49
|
+
put?: never;
|
|
50
|
+
post?: never;
|
|
51
|
+
delete?: never;
|
|
52
|
+
options?: never;
|
|
53
|
+
head?: never;
|
|
54
|
+
patch?: never;
|
|
55
|
+
trace?: never;
|
|
56
|
+
};
|
|
57
|
+
'/marketplace/{marketplace_id}/get_currencies': {
|
|
58
|
+
parameters: {
|
|
59
|
+
query?: never;
|
|
60
|
+
header?: never;
|
|
61
|
+
path?: never;
|
|
62
|
+
cookie?: never;
|
|
63
|
+
};
|
|
64
|
+
/** @description This method returns the default currency used by the eBay marketplace specified in the request. This is the currency that the seller should use when providing price data for this marketplace through listing APIs. */
|
|
65
|
+
get: operations['getCurrencies'];
|
|
66
|
+
put?: never;
|
|
67
|
+
post?: never;
|
|
68
|
+
delete?: never;
|
|
69
|
+
options?: never;
|
|
70
|
+
head?: never;
|
|
71
|
+
patch?: never;
|
|
72
|
+
trace?: never;
|
|
73
|
+
};
|
|
74
|
+
'/marketplace/{marketplace_id}/get_extended_producer_responsibility_policies': {
|
|
75
|
+
parameters: {
|
|
76
|
+
query?: never;
|
|
77
|
+
header?: never;
|
|
78
|
+
path?: never;
|
|
79
|
+
cookie?: never;
|
|
80
|
+
};
|
|
81
|
+
/** @description This method returns the Extended Producer Responsibility policies for one, multiple, or all eBay categories in an eBay marketplace.<br><br>The identifier of the eBay marketplace is passed in as a path parameter, and unless one or more eBay category IDs are passed in through the filter query parameter, this method will return metadata on every applicable category for the specified marketplace.<br><br><span class="tablenote"><span style="color:#004680"><strong>Note:</strong></span> Currently, the Extended Producer Responsibility policies are only applicable to a limited number of categories.</span><br><span class="tablenote"><span style="color:#004680"><strong>Note: </strong></span>Extended Producer Responsibility IDs are no longer set at the listing level so category-level metadata is no longer returned. Instead, sellers will provide/manage these IDs at the account level by going to <a href="https://accountsettings.ebay.fr/epr-fr " target="_blank">Account Settings</a>.</span><br><span class="tablenote"><span style="color:#478415"><strong>Tip:</strong></span> This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the <b>Accept-Encoding</b> request header and setting the value to <code>gzip</code>.</span> */
|
|
82
|
+
get: operations['getExtendedProducerResponsibilityPolicies'];
|
|
83
|
+
put?: never;
|
|
84
|
+
post?: never;
|
|
85
|
+
delete?: never;
|
|
86
|
+
options?: never;
|
|
87
|
+
head?: never;
|
|
88
|
+
patch?: never;
|
|
89
|
+
trace?: never;
|
|
90
|
+
};
|
|
91
|
+
'/marketplace/{marketplace_id}/get_hazardous_materials_labels': {
|
|
92
|
+
parameters: {
|
|
93
|
+
query?: never;
|
|
94
|
+
header?: never;
|
|
95
|
+
path?: never;
|
|
96
|
+
cookie?: never;
|
|
97
|
+
};
|
|
98
|
+
/** @description This method returns hazardous materials label information for the specified eBay marketplace. The information includes IDs, descriptions, and URLs (as applicable) for the available signal words, statements, and pictograms. The returned statements are localized for the default language of the marketplace. If a marketplace does not support hazardous materials label information, no response payload is returned, but only a <b>204 No content</b> status code.<p>This information is used by the seller to add hazardous materials label related information to their listings (see <a href='/api-docs/sell/static/metadata/feature-regulatorhazmatcontainer.html'>Specifying hazardous material related information</a>).</p> */
|
|
99
|
+
get: operations['getHazardousMaterialsLabels'];
|
|
100
|
+
put?: never;
|
|
101
|
+
post?: never;
|
|
102
|
+
delete?: never;
|
|
103
|
+
options?: never;
|
|
104
|
+
head?: never;
|
|
105
|
+
patch?: never;
|
|
106
|
+
trace?: never;
|
|
107
|
+
};
|
|
108
|
+
'/marketplace/{marketplace_id}/get_item_condition_policies': {
|
|
109
|
+
parameters: {
|
|
110
|
+
query?: never;
|
|
111
|
+
header?: never;
|
|
112
|
+
path?: never;
|
|
113
|
+
cookie?: never;
|
|
114
|
+
};
|
|
115
|
+
/** @description This method returns item condition metadata on one, multiple, or all eBay categories on an eBay marketplace. This metadata consists of the different item conditions (with IDs) that an eBay category supports, and a boolean to indicate if an eBay category requires an item condition. <br><br>If applicable, this metadata also shows the different condition descriptors (with IDs) that an eBay category supports.<br><br><span class="tablenote"><b>Note:</b> Currently, condition grading is only applicable to the following trading card categories: <ul><li>Non-Sport Trading Card Singles</li><li>CCG Individual Cards</li><li>Sports Trading Cards Singles</li></ul></span><br>The identifier of the eBay marketplace is passed in as a path parameter, and unless one or more eBay category IDs are passed in through the <b>filter</b> query parameter, this method will return metadata on every single category for the specified marketplace. If you only want to view item condition metadata for one eBay category or a select group of eBay categories, you can pass in up to 50 eBay category ID through the <b>filter</b> query parameter.<br><br><span class="tablenote"><span style="color:#FF0000"><strong>Important:</strong></span> <b>Certified - Refurbished</b>-eligible sellers, and sellers who are eligible to list with the new values (EXCELLENT_REFURBISHED, VERY_GOOD_REFURBISHED, and GOOD_REFURBISHED) must use an OAuth token created with the <a href="/api-docs/static/oauth-authorization-code-grant.html" target="_blank">authorization code grant flow</a> and <b>https://api.ebay.com/oauth/api_scope/sell.inventory</b> scope in order to retrieve the refurbished conditions for the relevant categories.<br/><br/>See the <a href="/api-docs/sell/static/metadata/condition-id-values.html#Category " target="_blank">eBay Refurbished Program - Category and marketplace support</a> topic for the categories and marketplaces that support these refurbished conditions<br/><br/>These restricted item conditions will not be returned if an OAuth token created with the <a href="/api-docs/static/oauth-client-credentials-grant.html" target="_blank">client credentials grant flow</a> and <b>https://api.ebay.com/oauth/api_scope</b> scope is used, or if any seller is not eligible to list with that item condition. <br/><br/> See the <a href="/api-docs/static/oauth-scopes.html" target="_blank">Specifying OAuth scopes</a> topic for more information about specifying scopes.</span><br><br><span class="tablenote"><span style="color:#478415"><strong>Tip:</strong></span> This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the <b>Accept-Encoding</b> request header and setting the value to <code>gzip</code>.</span> */
|
|
116
|
+
get: operations['getItemConditionPolicies'];
|
|
117
|
+
put?: never;
|
|
118
|
+
post?: never;
|
|
119
|
+
delete?: never;
|
|
120
|
+
options?: never;
|
|
121
|
+
head?: never;
|
|
122
|
+
patch?: never;
|
|
123
|
+
trace?: never;
|
|
124
|
+
};
|
|
125
|
+
'/marketplace/{marketplace_id}/get_listing_structure_policies': {
|
|
126
|
+
parameters: {
|
|
127
|
+
query?: never;
|
|
128
|
+
header?: never;
|
|
129
|
+
path?: never;
|
|
130
|
+
cookie?: never;
|
|
131
|
+
};
|
|
132
|
+
/** @description This method returns the eBay policies that define the allowed listing structures for the categories of a specific marketplace. The listing-structure policies currently pertain to whether or not you can list items with variations. <br><br>By default, this method returns the entire category tree for the specified marketplace. You can limit the size of the result set by using the <b>filter</b> query parameter to specify only the category IDs you want to review.<br><br><span class="tablenote"><span style="color:#478415"><strong>Tip:</strong></span> This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the <b>Accept-Encoding</b> request header and setting the value to <code>gzip</code>.</span> */
|
|
133
|
+
get: operations['getListingStructurePolicies'];
|
|
134
|
+
put?: never;
|
|
135
|
+
post?: never;
|
|
136
|
+
delete?: never;
|
|
137
|
+
options?: never;
|
|
138
|
+
head?: never;
|
|
139
|
+
patch?: never;
|
|
140
|
+
trace?: never;
|
|
141
|
+
};
|
|
142
|
+
'/marketplace/{marketplace_id}/get_listing_type_policies': {
|
|
143
|
+
parameters: {
|
|
144
|
+
query?: never;
|
|
145
|
+
header?: never;
|
|
146
|
+
path?: never;
|
|
147
|
+
cookie?: never;
|
|
148
|
+
};
|
|
149
|
+
/** @description This method returns eBay listing type policy metadata for all leaf categories on the specified marketplace. <p>By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the <b>filter</b> query parameter to specify only the leaf category IDs you want to review.</p><p>If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a <b>204 No content</b> status code with an empty response body.</p> */
|
|
150
|
+
get: operations['getListingTypePolicies'];
|
|
151
|
+
put?: never;
|
|
152
|
+
post?: never;
|
|
153
|
+
delete?: never;
|
|
154
|
+
options?: never;
|
|
155
|
+
head?: never;
|
|
156
|
+
patch?: never;
|
|
157
|
+
trace?: never;
|
|
158
|
+
};
|
|
159
|
+
'/marketplace/{marketplace_id}/get_motors_listing_policies': {
|
|
160
|
+
parameters: {
|
|
161
|
+
query?: never;
|
|
162
|
+
header?: never;
|
|
163
|
+
path?: never;
|
|
164
|
+
cookie?: never;
|
|
165
|
+
};
|
|
166
|
+
/** @description This method returns eBay Motors policy metadata for all leaf categories on the specified marketplace. <p>By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the <b>filter</b> query parameter to specify only the leaf category IDs you want to review.</p><p>If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a <b>204 No content</b> status code with an empty response body.</p><p><span class="tablenote"><span style="color:#004680"><strong>Note:</strong></span> To return policy information for eBay US Motors categories, specify <b>marketplace_id</b> as <code>EBAY_MOTORS_US</code>.</span></p> */
|
|
167
|
+
get: operations['getMotorsListingPolicies'];
|
|
168
|
+
put?: never;
|
|
169
|
+
post?: never;
|
|
170
|
+
delete?: never;
|
|
171
|
+
options?: never;
|
|
172
|
+
head?: never;
|
|
173
|
+
patch?: never;
|
|
174
|
+
trace?: never;
|
|
175
|
+
};
|
|
176
|
+
'/marketplace/{marketplace_id}/get_negotiated_price_policies': {
|
|
177
|
+
parameters: {
|
|
178
|
+
query?: never;
|
|
179
|
+
header?: never;
|
|
180
|
+
path?: never;
|
|
181
|
+
cookie?: never;
|
|
182
|
+
};
|
|
183
|
+
/** @description This method returns the eBay policies that define the supported negotiated price features (like "best offer") for the categories of a specific marketplace. <br><br>By default, this method returns the entire category tree for the specified marketplace. You can limit the size of the result set by using the <b>filter</b> query parameter to specify only the category IDs you want to review.<br><br><span class="tablenote"><span style="color:#478415"><strong>Tip:</strong></span> This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the <b>Accept-Encoding</b> request header and setting the value to <code>gzip</code>.</span> */
|
|
184
|
+
get: operations['getNegotiatedPricePolicies'];
|
|
185
|
+
put?: never;
|
|
186
|
+
post?: never;
|
|
187
|
+
delete?: never;
|
|
188
|
+
options?: never;
|
|
189
|
+
head?: never;
|
|
190
|
+
patch?: never;
|
|
191
|
+
trace?: never;
|
|
192
|
+
};
|
|
193
|
+
'/marketplace/{marketplace_id}/get_product_safety_labels': {
|
|
194
|
+
parameters: {
|
|
195
|
+
query?: never;
|
|
196
|
+
header?: never;
|
|
197
|
+
path?: never;
|
|
198
|
+
cookie?: never;
|
|
199
|
+
};
|
|
200
|
+
/** @description This method returns product safety label information for the specified eBay marketplace. The information includes IDs, descriptions, and URLs (as applicable) for the available statements and pictograms. The returned statements are localized for the default language of the marketplace. If a marketplace does not support product safety label information, no response payload is returned, but only a <b>204 No content</b> status code.<p>This information is used by the seller to add product safety label related information to their listings. The <a href="/api-docs/sell/metadata/resources/marketplace/methods/getRegulatoryPolicies" target="_blank">getRegulatoryPolicies</a> method can be used to see which categories recommend or require product safety labels.</p> */
|
|
201
|
+
get: operations['getProductSafetyLabels'];
|
|
202
|
+
put?: never;
|
|
203
|
+
post?: never;
|
|
204
|
+
delete?: never;
|
|
205
|
+
options?: never;
|
|
206
|
+
head?: never;
|
|
207
|
+
patch?: never;
|
|
208
|
+
trace?: never;
|
|
209
|
+
};
|
|
210
|
+
'/marketplace/{marketplace_id}/get_regulatory_policies': {
|
|
211
|
+
parameters: {
|
|
212
|
+
query?: never;
|
|
213
|
+
header?: never;
|
|
214
|
+
path?: never;
|
|
215
|
+
cookie?: never;
|
|
216
|
+
};
|
|
217
|
+
/** @description This method returns regulatory policies for one, multiple, or all eBay categories in an eBay marketplace. The identifier of the eBay marketplace is passed in as a path parameter, and unless one or more eBay category IDs are passed in through the filter query parameter, this method will return metadata for every listing category in the specified marketplace.</p><p><span class="tablenote"><span style="color:#478415"><strong>Tip:</strong></span> This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the <b>Accept-Encoding</b> request header and setting the value to <code>gzip</code>.</span></p> */
|
|
218
|
+
get: operations['getRegulatoryPolicies'];
|
|
219
|
+
put?: never;
|
|
220
|
+
post?: never;
|
|
221
|
+
delete?: never;
|
|
222
|
+
options?: never;
|
|
223
|
+
head?: never;
|
|
224
|
+
patch?: never;
|
|
225
|
+
trace?: never;
|
|
226
|
+
};
|
|
227
|
+
'/marketplace/{marketplace_id}/get_return_policies': {
|
|
228
|
+
parameters: {
|
|
229
|
+
query?: never;
|
|
230
|
+
header?: never;
|
|
231
|
+
path?: never;
|
|
232
|
+
cookie?: never;
|
|
233
|
+
};
|
|
234
|
+
/** @description This method returns the eBay policies that define whether or not you must include a return policy for the items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and international return policies in the different eBay categories. <br><br>By default, this method returns the entire category tree for the specified marketplace. You can limit the size of the result set by using the <b>filter</b> query parameter to specify only the category IDs you want to review.<br><br><span class="tablenote"><span style="color:#478415"><strong>Tip:</strong></span> This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the <b>Accept-Encoding</b> request header and setting the value to <code>gzip</code>.</span> */
|
|
235
|
+
get: operations['getReturnPolicies'];
|
|
236
|
+
put?: never;
|
|
237
|
+
post?: never;
|
|
238
|
+
delete?: never;
|
|
239
|
+
options?: never;
|
|
240
|
+
head?: never;
|
|
241
|
+
patch?: never;
|
|
242
|
+
trace?: never;
|
|
243
|
+
};
|
|
244
|
+
'/marketplace/{marketplace_id}/get_shipping_policies': {
|
|
245
|
+
parameters: {
|
|
246
|
+
query?: never;
|
|
247
|
+
header?: never;
|
|
248
|
+
path?: never;
|
|
249
|
+
cookie?: never;
|
|
250
|
+
};
|
|
251
|
+
/** @description This method returns eBay shipping policy metadata for all leaf categories on the specified marketplace.<p>By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the <b>filter</b> query parameter to specify only the leaf category IDs you want to review.</p><p>If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a <b>204 No content</b> status code with an empty response body. */
|
|
252
|
+
get: operations['getShippingPolicies'];
|
|
253
|
+
put?: never;
|
|
254
|
+
post?: never;
|
|
255
|
+
delete?: never;
|
|
256
|
+
options?: never;
|
|
257
|
+
head?: never;
|
|
258
|
+
patch?: never;
|
|
259
|
+
trace?: never;
|
|
260
|
+
};
|
|
261
|
+
'/marketplace/{marketplace_id}/get_site_visibility_policies': {
|
|
262
|
+
parameters: {
|
|
263
|
+
query?: never;
|
|
264
|
+
header?: never;
|
|
265
|
+
path?: never;
|
|
266
|
+
cookie?: never;
|
|
267
|
+
};
|
|
268
|
+
/** @description This method returns eBay international site visibility policy metadata for all leaf categories on the specified marketplace.<p>By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the <b>filter</b> query parameter to specify only the leaf category IDs you want to review.</p><p>If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a <b>204 No content</b> status code with an empty response body. */
|
|
269
|
+
get: operations['getSiteVisibilityPolicies'];
|
|
270
|
+
put?: never;
|
|
271
|
+
post?: never;
|
|
272
|
+
delete?: never;
|
|
273
|
+
options?: never;
|
|
274
|
+
head?: never;
|
|
275
|
+
patch?: never;
|
|
276
|
+
trace?: never;
|
|
277
|
+
};
|
|
278
|
+
'/compatibilities/get_compatibilities_by_specification': {
|
|
279
|
+
parameters: {
|
|
280
|
+
query?: never;
|
|
281
|
+
header?: never;
|
|
282
|
+
path?: never;
|
|
283
|
+
cookie?: never;
|
|
284
|
+
};
|
|
285
|
+
get?: never;
|
|
286
|
+
put?: never;
|
|
287
|
+
/** @description This method is used to retrieve all compatible application name-value pairs for a part based on the provided specification(s).<br><br>The part's relevant dimensions and/or characteristics can be provided through the <b>specifications</b> container. For example, when retrieving compatible application name-value pairs for a tire, the tire's dimensions (such as the section width or rim diameter) should be provided.<br><br>By default, all compatible application name-value pairs for the specifications are returned. You can limit the size of the result set by using the <b>compatibilityPropertyFilters</b> array to specify the properties (such as make, model, year, or trim) you wish to be included in the response.<br><br><span class="tablenote"><b>Note:</b> The <a href="/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyNames" target="_blank ">getCompatibilityPropertyNames</a> and <a href="/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues" target="_blank ">getCompatibilityPropertyValues</a> methods can be used to retrieve valid property names and values that can be used as the name-value pairs to define specifications.</span> */
|
|
288
|
+
post: operations['getCompatibilitiesBySpecification'];
|
|
289
|
+
delete?: never;
|
|
290
|
+
options?: never;
|
|
291
|
+
head?: never;
|
|
292
|
+
patch?: never;
|
|
293
|
+
trace?: never;
|
|
294
|
+
};
|
|
295
|
+
'/compatibilities/get_compatibility_property_names': {
|
|
296
|
+
parameters: {
|
|
297
|
+
query?: never;
|
|
298
|
+
header?: never;
|
|
299
|
+
path?: never;
|
|
300
|
+
cookie?: never;
|
|
301
|
+
};
|
|
302
|
+
get?: never;
|
|
303
|
+
put?: never;
|
|
304
|
+
/** @description This method is used to retrieve product compatibility property names for the specified compatibility-enabled category.<br><br>Compatibility property names can be used alongside the corresponding compatibility property value (retrieved using the <a href="/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues" target="_blank ">getCompatibilityPropertyValues</a> method) to describe the assembly for which an item is compatible.<br><br>The <b>categoryId</b> of the compatibility-enabled category for which to retrieve compatibility property names is required in the request body.<br><br>By default, all property names within the compatibility category of the specified compatibility-enable category are returned. You can limit the size of the result set by using the <b>dataset</b> array to specify the types of properties you want returned. */
|
|
305
|
+
post: operations['getCompatibilityPropertyNames'];
|
|
306
|
+
delete?: never;
|
|
307
|
+
options?: never;
|
|
308
|
+
head?: never;
|
|
309
|
+
patch?: never;
|
|
310
|
+
trace?: never;
|
|
311
|
+
};
|
|
312
|
+
'/compatibilities/get_compatibility_property_values': {
|
|
313
|
+
parameters: {
|
|
314
|
+
query?: never;
|
|
315
|
+
header?: never;
|
|
316
|
+
path?: never;
|
|
317
|
+
cookie?: never;
|
|
318
|
+
};
|
|
319
|
+
get?: never;
|
|
320
|
+
put?: never;
|
|
321
|
+
/** @description This method is used to retrieve product compatibility property values associated with a single property name, in the specified category.<br><br>Compatibility property values can be used alongside the corresponding compatibility property name (retrieved using the <a href="/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyNames" target="_blank ">getCompatibilityPropertyNames</a> method) to describe the assembly for which an item is compatible.<br><br>The <b>categoryId</b> of the compatibility-enabled category for which to retrieve compatibility property values is required in the request body, as well as the <b>propertyName</b> for which you wish to retrieve associated values.<br><br>By default, all property values associated with the specified <b>propertyName</b> are returned. You can limit the size of the result set by using the <b>propertyFilter</b> array. Only property values associated with the specified name-value pairs will be returned. */
|
|
322
|
+
post: operations['getCompatibilityPropertyValues'];
|
|
323
|
+
delete?: never;
|
|
324
|
+
options?: never;
|
|
325
|
+
head?: never;
|
|
326
|
+
patch?: never;
|
|
327
|
+
trace?: never;
|
|
328
|
+
};
|
|
329
|
+
'/compatibilities/get_multi_compatibility_property_values': {
|
|
330
|
+
parameters: {
|
|
331
|
+
query?: never;
|
|
332
|
+
header?: never;
|
|
333
|
+
path?: never;
|
|
334
|
+
cookie?: never;
|
|
335
|
+
};
|
|
336
|
+
get?: never;
|
|
337
|
+
put?: never;
|
|
338
|
+
/** @description This method is used to retrieve product compatibility property values associated with multiple property names, in the specified category.<br><br>Compatibility property values can be used alongside the corresponding compatibility property name (retrieved using the <a href="/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyNames" target="_blank ">getCompatibilityPropertyNames</a> method) to describe the assembly for which an item is compatible.<br><br>The <b>categoryId</b> of the compatibility-enabled category for which to retrieve compatibility property values is required in the request body, as well as the <b>propertyNames</b> for which you wish to retrieve associated property values. The <b>propertyFilter</b> array is also required to constrain the output. Only property values associated with the specified name-value pairs will be returned. */
|
|
339
|
+
post: operations['getMultiCompatibilityPropertyValues'];
|
|
340
|
+
delete?: never;
|
|
341
|
+
options?: never;
|
|
342
|
+
head?: never;
|
|
343
|
+
patch?: never;
|
|
344
|
+
trace?: never;
|
|
345
|
+
};
|
|
346
|
+
'/compatibilities/get_product_compatibilities': {
|
|
347
|
+
parameters: {
|
|
348
|
+
query?: never;
|
|
349
|
+
header?: never;
|
|
350
|
+
path?: never;
|
|
351
|
+
cookie?: never;
|
|
352
|
+
};
|
|
353
|
+
get?: never;
|
|
354
|
+
put?: never;
|
|
355
|
+
/** @description This method is used to retrieve all available item compatibility details for the specified product.<br><br>Item compatibility details can be used to see the properties for which an item is compatible. For example, if you are searching for a part for a specific vehicle, you can use this method to see the years, engine, and/or trim for which the part is compatible. Item compatibility details are returned as name-value pairs.<br><br>The product for which to retrieve item compatibility details must be provided through the <b>productIdentifier</b> field. This value can be either an eBay specific identifier (such as an ePID) or an external identifier (such as a UPC).<br><br>By default, all available item compatibility details for the specified product are returned. You can limit the size of the result set using the <b>dataset</b> or <b>datasetPropertyName</b> fields to specify the types of properties you want returned in the response. The <b>applicationPropertyFilter</b> array can also be used so that only parts compatible with the specified name-value pairs are returned. */
|
|
356
|
+
post: operations['getProductCompatibilities'];
|
|
357
|
+
delete?: never;
|
|
358
|
+
options?: never;
|
|
359
|
+
head?: never;
|
|
360
|
+
patch?: never;
|
|
361
|
+
trace?: never;
|
|
362
|
+
};
|
|
363
|
+
'/country/{countryCode}/sales_tax_jurisdiction': {
|
|
364
|
+
parameters: {
|
|
365
|
+
query?: never;
|
|
366
|
+
header?: never;
|
|
367
|
+
path?: never;
|
|
368
|
+
cookie?: never;
|
|
369
|
+
};
|
|
370
|
+
/** @description This method retrieves all sales-tax jurisdictions for the country specified in the <b>countryCode</b> path parameter. Countries with valid sales-tax jurisdictions are Canada and the US.<br><br>The response from this call tells you the jurisdictions for which a seller can configure tax tables. Although setting up tax tables is optional, you can use the <b>createOrReplaceSalesTax</b> method in the <b>Account API</b> call to configure the tax tables for the jurisdictions into which you sell.<br><br><span class="tablenote"><b>Note:</b> Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.</span><br><br><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="<b><span style="color: #dd1e31;" class="mcFormatColor">Important! </span></b>"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.<br><br>However, sellers may continue to use a sales-tax table to set rates for the following US territories:<ul><li>American Samoa (AS)</li><li>Guam (GU)</li><li>Northern Mariana Islands (MP)</li><li>Palau (PW)</li><li>US Virgin Islands (VI)</li></ul>For additional information, refer to <a href="https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121 " target="_blank">Taxes and import charges</a>.</p></div> */
|
|
371
|
+
get: operations['getSalesTaxJurisdictions'];
|
|
372
|
+
put?: never;
|
|
373
|
+
post?: never;
|
|
374
|
+
delete?: never;
|
|
375
|
+
options?: never;
|
|
376
|
+
head?: never;
|
|
377
|
+
patch?: never;
|
|
378
|
+
trace?: never;
|
|
379
|
+
};
|
|
380
|
+
}
|
|
381
|
+
export type webhooks = Record<string, never>;
|
|
382
|
+
export interface components {
|
|
383
|
+
schemas: {
|
|
384
|
+
/** @description The type that defines the fields for the currency and a monetary amount. */
|
|
385
|
+
Amount: {
|
|
386
|
+
/** @description The three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html " target="_blank">ISO 4217</a> code representing the currency of the amount in the <b> value</b> field. <br /><br /><b>Restriction: </b> Only the currency of the marketplace is supported. For example, on the US marketplace the only currency supported is USD. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/bas:CurrencyCodeEnum'>eBay API documentation</a> */
|
|
387
|
+
currency?: string;
|
|
388
|
+
/** @description The monetary amount, in the currency specified by the <b>currency</b> field. */
|
|
389
|
+
value?: string;
|
|
390
|
+
};
|
|
391
|
+
AutomotivePartsCompatibilityPolicy: {
|
|
392
|
+
/** @description The category ID to which the automotive parts compatibility policies apply. */
|
|
393
|
+
categoryId?: string;
|
|
394
|
+
/** @description A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. <br><br>A <i>category tree</i> is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique <b>categoryId</b> value. Within a category tree, the root node has no parent node and <i>leaf nodes</i> are nodes that have no child nodes. */
|
|
395
|
+
categoryTreeId?: string;
|
|
396
|
+
/** @description Indicates whether the category supports parts compatibility by either <code>ASSEMBLY</code> or by <code>SPECIFICATION</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:CompatibilityTypeEnum'>eBay API documentation</a> */
|
|
397
|
+
compatibilityBasedOn?: string;
|
|
398
|
+
/** @description Indicates the compatibility classification of the part based on high-level vehicle types. */
|
|
399
|
+
compatibleVehicleTypes?: string[];
|
|
400
|
+
/**
|
|
401
|
+
* Format: int32
|
|
402
|
+
* @description Specifies the maximum number of compatible vehicle-applications allowed per item.
|
|
403
|
+
*/
|
|
404
|
+
maxNumberOfCompatibleVehicles?: number;
|
|
405
|
+
};
|
|
406
|
+
AutomotivePartsCompatibilityPolicyResponse: {
|
|
407
|
+
/** @description A list of category IDs and the automotive parts compatibility policies for each of the listed categories. */
|
|
408
|
+
automotivePartsCompatibilityPolicies?: components['schemas']['AutomotivePartsCompatibilityPolicy'][];
|
|
409
|
+
/** @description A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
410
|
+
warnings?: components['schemas']['Error'][];
|
|
411
|
+
};
|
|
412
|
+
/** @description This type contains applicable policy metadata for the leaf categories returned for the marketplace. */
|
|
413
|
+
CategoryPolicy: {
|
|
414
|
+
/** @description If this field is returned as <code>true</code>, the corresponding category supports immediate payment for listings. The immediate payment feature is applicable to fixed-price listings, to auction listings with the 'Buy It Now' option enabled, and for a motor vehicle listing that requires an initial deposit. If the immediate payment feature is enabled for a listing, the buyer must pay immediately after clicking the 'Buy it Now' button. <p>This field is only returned when <code>true</code> (not returned when false).</p> */
|
|
415
|
+
autoPayEnabled?: boolean;
|
|
416
|
+
/** @description If this field is returned as <code>true</code>, the corresponding category supports business-to-business (B2B) VAT listings. If this field is not present, the category does not have B2B VAT listings. This feature is applicable to the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites only.<p>This field is only returned when <code>true</code> (not returned when false).</p> */
|
|
417
|
+
b2bVatEnabled?: boolean;
|
|
418
|
+
/** @description The unique identifier of the eBay leaf category for which metadata is being returned. */
|
|
419
|
+
categoryId?: string;
|
|
420
|
+
/** @description The unique identifier of the category tree. */
|
|
421
|
+
categoryTreeId?: string;
|
|
422
|
+
/** @description This enumerated value indicates whether or not European Article Numbers (EANs) are supported/required when listing products in the category. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ProductIdentiferEnabledEnum'>eBay API documentation</a> */
|
|
423
|
+
eanSupport?: string;
|
|
424
|
+
/** @description If this field is returned as <code>true</code>, the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category. You can use the <a href="/api-docs/sell/taxonomy/resources/category_tree/methods/getExpiredCategories" target="_blank">getExpiredCategories</a> method (of the <b>Taxonomy API</b>) to find the leaf category that replaced the expired category. <p>This field is only returned when <code>true</code> (not returned when false).</p> */
|
|
425
|
+
expired?: boolean;
|
|
426
|
+
/** @description If this field is returned as <code>true</code>, the category supports the listing of intangible goods or services. */
|
|
427
|
+
intangibleEnabled?: boolean;
|
|
428
|
+
/** @description This enumerated value indicates whether or not International Standard Book Numbers (ISBNs) are supported/required when listing products in the specified category. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ProductIdentiferEnabledEnum'>eBay API documentation</a> */
|
|
429
|
+
isbnSupport?: string;
|
|
430
|
+
/** @description If this field (Lot Size Disabled) is returned as <code>true</code>, the corresponding category does not support lot listings. A lot listing is a listing that features multiple related items that must be purchased by one buyer in one transaction. <p>This field is only returned when <code>true</code> (not returned when false).</p> */
|
|
431
|
+
lsd?: boolean;
|
|
432
|
+
/** @description Indicates the Minimum Reserve Price for an auction listing in this category. If there is no Minimum Reserve Price, a value of <code>0.0</code> is returned in this field. */
|
|
433
|
+
minimumReservePrice?: number;
|
|
434
|
+
/** @description If this field (Override Reserve Price Allowed) is returned as <code>true</code>, all leaf categories on the site allow the seller to completely remove the reserve price for an active auction listing. For information on removing or reducing reserve prices, see <a href="https://www.ebay.com/help/selling/listings/selling-auctions/reserve-prices?id=4143" target="_blank">Setting a reserve price</a>. */
|
|
435
|
+
orpa?: boolean;
|
|
436
|
+
/** @description If this field (Override Reduce Reserve Allowed) is returned as <code>true</code>, the seller can reduce or remove a reserve price that had already been reduced for an active auction listing. */
|
|
437
|
+
orra?: boolean;
|
|
438
|
+
/** @description An array that indicates the acceptable offline payment methods that can be used when listing an item for sale in the corresponding category. */
|
|
439
|
+
paymentMethods?: string[];
|
|
440
|
+
/** @description If this field (Reduce Reserve Allowed) is <code>true</code>, the corresponding leaf category allows the seller to reduce an item's reserve price. If false, this field is not returned in the response and the corresponding leaf category on the site do not normally allow sellers to reduce an item's reserve price.<p>This field is only returned when <code>true</code> (not returned when false).</p> */
|
|
441
|
+
reduceReserveAllowed?: boolean;
|
|
442
|
+
/** @description This enumerated value indicates whether or not the category on the specified eBay site supports the use of Universal Product Codes (UPCs) to help create a listing. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ProductIdentiferEnabledEnum'>eBay API documentation</a> */
|
|
443
|
+
upcSupport?: string;
|
|
444
|
+
/** @description When returned as <code>true</code>, this boolean indicates that the leaf category for the specified site is designated by eBay as a value category. Value categories can be used as a secondary category for a listing at no extra charge. */
|
|
445
|
+
valueCategory?: boolean;
|
|
446
|
+
/** @description If this field is returned as <code>true</code>, the corresponding category is an eBay virtual category, a category in which items may not be listed.<p>This field is only returned when <code>true</code> (not returned when false).</p> */
|
|
447
|
+
virtual?: boolean;
|
|
448
|
+
};
|
|
449
|
+
/** @description This type contains applicable policy metadata for the leaf categories returned for the marketplace. */
|
|
450
|
+
CategoryPolicyResponse: {
|
|
451
|
+
/** @description This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter <b>marketplace_id</b> and optionally limited by only those leaf category IDs specified in the query parameter <b>filter</b>. */
|
|
452
|
+
categoryPolicies?: components['schemas']['CategoryPolicy'][];
|
|
453
|
+
/** @description An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
454
|
+
warnings?: components['schemas']['Error'][];
|
|
455
|
+
};
|
|
456
|
+
/** @description This type provides fields that contains applicable Classified Ad policy metadata for the leaf categories returned for the marketplace. */
|
|
457
|
+
ClassifiedAdPolicy: {
|
|
458
|
+
/** @description This enumerated value indicates the type or status of available Classified Ad formats for this category. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:AdFormatEnabledEnum'>eBay API documentation</a> */
|
|
459
|
+
adFormatEnabled?: string;
|
|
460
|
+
/** @description The unique identifier of the eBay leaf category for which metadata is being returned. */
|
|
461
|
+
categoryId?: string;
|
|
462
|
+
/** @description The unique identifier of the category tree. */
|
|
463
|
+
categoryTreeId?: string;
|
|
464
|
+
/** @description Indicates whether the category supports the Best Offer Automatic Accept feature for Classified Ad listings. */
|
|
465
|
+
classifiedAdAutoAcceptEnabled?: boolean;
|
|
466
|
+
/** @description Indicates whether the category supports the Best Offer Automatic Reject feature for Classified Ad listings. */
|
|
467
|
+
classifiedAdAutoDeclineEnabled?: boolean;
|
|
468
|
+
/** @description This enumerated value indicates if Best Offer is enabled, disabled, or required for Classified Ad listings in this category. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ClassifiedAdBestOfferEnabledEnum'>eBay API documentation</a> */
|
|
469
|
+
classifiedAdBestOfferEnabled?: string;
|
|
470
|
+
/** @description Indicates whether this category supports including a company name in the seller's contact information. This element is for <b>For Sale By Owner</b> listings. */
|
|
471
|
+
classifiedAdCompanyNameEnabled?: boolean;
|
|
472
|
+
/** @description Indicates whether this category supports including an address in the seller's contact information. This element is for <b>For Sale By Owner</b> listings. */
|
|
473
|
+
classifiedAdContactByAddressEnabled?: boolean;
|
|
474
|
+
/** @description Indicates whether most categories support including an email address in the seller's contact information. */
|
|
475
|
+
classifiedAdContactByEmailEnabled?: boolean;
|
|
476
|
+
/** @description Indicates whether most categories support including a phone number in the seller's contact information. */
|
|
477
|
+
classifiedAdContactByPhoneEnabled?: boolean;
|
|
478
|
+
/** @description Indicates whether counter offers are allowed on Best offers for the category. */
|
|
479
|
+
classifiedAdCounterOfferEnabled?: boolean;
|
|
480
|
+
/** @description This enumerated value indicates support for the payment method being displayed to the user for the category. Even if enabled, checkout may or may not be enabled. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ClassifiedAdPaymentMethodEnabledEnum'>eBay API documentation</a> */
|
|
481
|
+
classifiedAdPaymentMethodEnabled?: string;
|
|
482
|
+
/**
|
|
483
|
+
* Format: int32
|
|
484
|
+
* @description Indicates how many contact phone numbers can be specified in contact information for the category. This element is for <b>For Sale By Owner</b> listings.
|
|
485
|
+
*/
|
|
486
|
+
classifiedAdPhoneCount?: number;
|
|
487
|
+
/** @description Indicates if shipping methods can be specified and displayed in the <b>View Item</b> page for the category. */
|
|
488
|
+
classifiedAdShippingMethodEnabled?: boolean;
|
|
489
|
+
/**
|
|
490
|
+
* Format: int32
|
|
491
|
+
* @description Indicates how many street addresses can be specified in contact information for the category. This element is for <b>For Sale By Owner</b> listings.
|
|
492
|
+
*/
|
|
493
|
+
classifiedAdStreetCount?: number;
|
|
494
|
+
/** @description Indicates whether this category supports seller-level contact information for Classified Ad listings. */
|
|
495
|
+
sellerContactDetailsEnabled?: boolean;
|
|
496
|
+
};
|
|
497
|
+
/** @description This type contains applicable policy metadata for the leaf categories returned for the marketplace. */
|
|
498
|
+
ClassifiedAdPolicyResponse: {
|
|
499
|
+
/** @description This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter <b>marketplace_id</b> and optionally limited by only those leaf category IDs specified in the query parameter <b>filter</b>. */
|
|
500
|
+
classifiedAdPolicies?: components['schemas']['ClassifiedAdPolicy'][];
|
|
501
|
+
/** @description An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
502
|
+
warnings?: components['schemas']['Error'][];
|
|
503
|
+
};
|
|
504
|
+
/** @description This type defines the property names and values that are compatible with the property name values specified in the request. */
|
|
505
|
+
Compatibility: {
|
|
506
|
+
/** @description This array returns a list of compatibility details associated with the specified property name(s). */
|
|
507
|
+
compatibilityDetails?: components['schemas']['CompatibilityDetails'][];
|
|
508
|
+
};
|
|
509
|
+
/** @description This type defines the compatible property names and values associated with the product. */
|
|
510
|
+
CompatibilityDetails: {
|
|
511
|
+
/** @description The name of the property being described. */
|
|
512
|
+
propertyName?: string;
|
|
513
|
+
/** @description The value for the property specified in the <b>propertyName</b> field. */
|
|
514
|
+
propertyValue?: string;
|
|
515
|
+
};
|
|
516
|
+
/** @description The type defining valid currencies for the marketplace. */
|
|
517
|
+
Currency: {
|
|
518
|
+
/** @description The three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html " target="_blank">ISO 4217</a> code returned. <br /><br /><b>Restriction: </b> Only the currency of the marketplace is supported. Examples: on the US marketplace, the only currency supported is the United States dollar, <code>USD</code>; on the Canadian marketplace, the only currency supported is the Canadian dollar, <code>CAD</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/bas:CurrencyCodeEnum'>eBay API documentation</a> */
|
|
519
|
+
code?: string;
|
|
520
|
+
/** @description The description of the returned three-letter code. For example, if the code is <code>USD</code>, the description returned would be <code>US Dollar</code>. */
|
|
521
|
+
description?: string;
|
|
522
|
+
};
|
|
523
|
+
/** @description This type defines the booleans used to determine if a product is excluded from eBay selling and/or review. */
|
|
524
|
+
DisabledProductFilter: {
|
|
525
|
+
/** @description Specifies whether to filter out products excluded for eBay reviews.<br><br>If set to <code>true</code>, items excluded from eBay reviews are not returned. */
|
|
526
|
+
excludeForEbayReviews?: boolean;
|
|
527
|
+
/** @description Specifies whether to filter out products excluded for eBay selling.<br><br>If set to <code>true</code>, items excluded from eBay selling are not returned. */
|
|
528
|
+
excludeForEbaySelling?: boolean;
|
|
529
|
+
};
|
|
530
|
+
/** @description A container that defines the elements of error and warning messages. */
|
|
531
|
+
Error: {
|
|
532
|
+
/** @description The category type for this error or warning. It takes an ErrorCategory object which can have one of three values:<ul><li><code>Application</code>: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.</li><li><code>Business</code>: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors.</li><li><code>Request</code>: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.</li></ul> */
|
|
533
|
+
category?: string;
|
|
534
|
+
/** @description Name of the domain containing the service or application. */
|
|
535
|
+
domain?: string;
|
|
536
|
+
/**
|
|
537
|
+
* Format: int32
|
|
538
|
+
* @description A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
|
|
539
|
+
*/
|
|
540
|
+
errorId?: number;
|
|
541
|
+
/** @description Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use <i>JSONPath</i> notation. */
|
|
542
|
+
inputRefIds?: string[];
|
|
543
|
+
/** @description An expanded version of message that should be around 100-200 characters long, but is not required to be such. */
|
|
544
|
+
longMessage?: string;
|
|
545
|
+
/** @description An end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale. */
|
|
546
|
+
message?: string;
|
|
547
|
+
/** @description Identifies specific response elements associated with the error, if any. Path format is the same as <code>inputRefId</code>. */
|
|
548
|
+
outputRefIds?: string[];
|
|
549
|
+
/** @description This optional complex field type contains a list of one or more context-specific <code>ErrorParameter</code> objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each <code>ErrorParameter</code> object consists of two fields, a <code>name</code> and a <code>value</code>. */
|
|
550
|
+
parameters?: components['schemas']['ErrorParameter'][];
|
|
551
|
+
/** @description Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain. */
|
|
552
|
+
subdomain?: string;
|
|
553
|
+
};
|
|
554
|
+
/** @description Container for a error parameter. */
|
|
555
|
+
ErrorParameter: {
|
|
556
|
+
/** @description Name of the entity that threw the error. */
|
|
557
|
+
name?: string;
|
|
558
|
+
/** @description A description of the error. */
|
|
559
|
+
value?: string;
|
|
560
|
+
};
|
|
561
|
+
/** @description A type that defines the attributes of an Extended Producer Responsibility policy. */
|
|
562
|
+
ExtendedProducerResponsibility: {
|
|
563
|
+
/** @description An indication of whether the attribute can be enabled for listing variations.<br><br>If the value is <code>true</code>, the attribute may be specified at the variation level. */
|
|
564
|
+
enabledForVariations?: boolean;
|
|
565
|
+
/** @description The name of the attribute included in the policy. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ExtendedProducerResponsibilityEnum'>eBay API documentation</a> */
|
|
566
|
+
name?: string;
|
|
567
|
+
/** @description The usage guidelines for the attribute, in the specified marketplace. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:GenericUsageEnum'>eBay API documentation</a> */
|
|
568
|
+
usage?: string;
|
|
569
|
+
};
|
|
570
|
+
/** @description A type that defines the Extended Producer Responsibility policy. */
|
|
571
|
+
ExtendedProducerResponsibilityPolicy: {
|
|
572
|
+
/** @description The unique identifier for the category under which the policy applies. */
|
|
573
|
+
categoryId?: string;
|
|
574
|
+
/** @description The unique identifier for the category tree under which the policy applies. */
|
|
575
|
+
categoryTreeId?: string;
|
|
576
|
+
/** @description The details regarding the attributes included in the policy, such as their usage guidelines and whether they can be specified at the listing variation level. */
|
|
577
|
+
supportedAttributes?: components['schemas']['ExtendedProducerResponsibility'][];
|
|
578
|
+
};
|
|
579
|
+
/** @description A type that defines the response fields for the <b>getExtendedProducerResponsibilityPolicies</b> method. */
|
|
580
|
+
ExtendedProducerResponsibilityPolicyResponse: {
|
|
581
|
+
/** @description An array of response fields detailing the Extended Producer Responsibility policies supported for the specified marketplace. */
|
|
582
|
+
extendedProducerResponsibilities?: components['schemas']['ExtendedProducerResponsibilityPolicy'][];
|
|
583
|
+
/** @description A collection of warnings generated for the request. */
|
|
584
|
+
warnings?: components['schemas']['Error'][];
|
|
585
|
+
};
|
|
586
|
+
/** @description This type defines the response fields specifying the default currency for the marketplace. */
|
|
587
|
+
GetCurrenciesResponse: {
|
|
588
|
+
/** @description This field specifies the default currency used by the marketplace. */
|
|
589
|
+
defaultCurrency?: components['schemas']['Currency'];
|
|
590
|
+
/** @description The ID of the eBay marketplace to which the default currency applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/bas:MarketplaceIdEnum'>eBay API documentation</a> */
|
|
591
|
+
marketplaceId?: string;
|
|
592
|
+
};
|
|
593
|
+
/** @description A type that describes hazard statements for hazardous materials labels */
|
|
594
|
+
HazardStatement: {
|
|
595
|
+
/** @description The identifier of the statement. For sample values, see <a href='/api-docs/sell/static/metadata/feature-regulatorhazmatcontainer.html#Hazard'>Hazard statement sample values</a>. */
|
|
596
|
+
statementId?: string;
|
|
597
|
+
/** @description The description of the statement localized to the default language of the marketplace. For sample values, see <a href='/api-docs/sell/static/metadata/feature-regulatorhazmatcontainer.html#Hazard'>Hazard statement sample values</a>. */
|
|
598
|
+
statementDescription?: string;
|
|
599
|
+
};
|
|
600
|
+
/** @description A type that defines the response fields for the <b>getHazardousMaterialsLabels</b> method. */
|
|
601
|
+
HazardousMaterialDetailsResponse: {
|
|
602
|
+
/** @description This array contains available hazardous materials signal words for the specified marketplace. */
|
|
603
|
+
signalWords?: components['schemas']['SignalWord'][];
|
|
604
|
+
/** @description This array contains available hazardous materials hazard statements for the specified marketplace. */
|
|
605
|
+
statements?: components['schemas']['HazardStatement'][];
|
|
606
|
+
/** @description This array contains available hazardous materials hazard pictograms for the specified marketplace. */
|
|
607
|
+
pictograms?: components['schemas']['Pictogram'][];
|
|
608
|
+
};
|
|
609
|
+
/** @description <span class="tablenote"><b>Note: </b>In all eBay marketplaces, Condition ID 2000 now maps to an item condition of 'Certified Refurbished', and not 'Manufacturer Refurbished'. To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition. Any active listings on any eBay marketplace that had 'Manufacturer Refurbished' as the item condition should have been automatically updated by eBay to the 'Seller Refurbished' item condition (Condition ID 2500). <br><br> Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the <a href="https://pages.ebay.com/seller-center/listing-and-marketing/certified-refurbished-program.html " target="_blank">Certified refurbished program</a> page in Seller Center. </span> */
|
|
610
|
+
ItemCondition: {
|
|
611
|
+
/** @description The human-readable label for the condition (e.g., "New"). This value is typically localized for each site. <br><br>Note that the display name can vary by category. For example, the description for condition ID <code>1000</code> could be called "New: with Tags" in one category and "Brand New" in another. For details on condition IDs and descriptions, see <a href='/api-docs/sell/static/metadata/condition-id-values.html'>Item condition ID and name values</a>. */
|
|
612
|
+
conditionDescription?: string;
|
|
613
|
+
/** @description This array contains the possible condition descriptors and condition descriptor values applicable for the specified category. It also returns usage requirements, maximum length, cardinality, and help text.<br><br><span class="tablenote"><b>Note:</b> This array is only returned for categories that support condition descriptors.</span> */
|
|
614
|
+
conditionDescriptors?: components['schemas']['ItemConditionDescriptor'][];
|
|
615
|
+
/** @description A detailed description of the condition denoted by the <b>conditionID</b> and <b>conditionDescription</b>. */
|
|
616
|
+
conditionHelpText?: string;
|
|
617
|
+
/** @description The ID value of the selected item condition. For information on the supported condition ID values, see <a href='/api-docs/sell/static/metadata/condition-id-values.html'>Item condition ID and name values</a>. */
|
|
618
|
+
conditionId?: string;
|
|
619
|
+
/** @description The value returned in this field indicates if there are any usage restrictions or requirements for the corresponding item condition in the corresponding category.<br><br><span class="tablenote"><b>Note:</b> Currently, the only supported value is 'RESTRICTED', and this field will only be returned for the following conditions: 2000, 2010, 2020, 2030. Sellers must be pre-approved to use any of these item conditions.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:UsageEnum'>eBay API documentation</a> */
|
|
620
|
+
usage?: string;
|
|
621
|
+
};
|
|
622
|
+
/** @description This type is used to display the possible condition descriptors and condition values applicable for a specified category. It also returns usage requirements, maximum length, cardinality, and help text. */
|
|
623
|
+
ItemConditionDescriptor: {
|
|
624
|
+
/** @description This container shows the constraints on a condition descriptor, such as the maximum length, default condition descriptor value ID, cardinality, mode, usage, and applicable descriptor IDs. */
|
|
625
|
+
conditionDescriptorConstraint?: components['schemas']['ItemConditionDescriptorConstraint'];
|
|
626
|
+
/** @description A description of the condition descriptor that directs a user to its condition descriptor values.<br><br> For example, the help text for <code>Card Condition</code> is <code>Select ungraded condition</code>. */
|
|
627
|
+
conditionDescriptorHelpText?: string;
|
|
628
|
+
/** @description The unique identification number of a condition descriptor associated with with a <b>conditionDescriptorName</b>. <br><br>For example, <code>40001</code> is the ID for <code>Card Condition</code>.<br><br>These IDs are used in the addItem family of calls of the <b>Trading API</b> to provide condition descriptor names for the item. These IDs are used by the inventoryItem family of calls of the <b>Inventory API</b> to provide condition descriptor names for the item. */
|
|
629
|
+
conditionDescriptorId?: string;
|
|
630
|
+
/** @description The human-readable label for the condition descriptor associated with the <b>conditionDescriptorID</b>. <br><br>For example, <code>Card Condition</code> is the condition descriptor name for ID <code>40001</code> */
|
|
631
|
+
conditionDescriptorName?: string;
|
|
632
|
+
/** @description This array shows the possible values that map to the corresponding <b>conditionDescriptorName</b> values. Constraint information and help text are also shown for each value. <br><br>For example, The ID <code>40001</code> is ID for the condition descriptor <code>card condition</code>. The ID <code>400012</code> is the ID for the <code>Very Good</code> card condition value. */
|
|
633
|
+
conditionDescriptorValues?: components['schemas']['ItemConditionDescriptorValue'][];
|
|
634
|
+
};
|
|
635
|
+
/** @description This type specifies the constraints on a condition descriptor, such as the maximum length, default condition descriptor value ID, cardinality, mode, usage, and applicable descriptor IDs. */
|
|
636
|
+
ItemConditionDescriptorConstraint: {
|
|
637
|
+
/** @description This array is returned if the corresponding condition descriptor requires that one or more other associated condition descriptors must also be specified in a listing. The condition descriptor IDs for the associated condition descriptors are returned here.<br><br>For example, the <code>Grade</code> and <code>Grader</code> condition descriptors must always be specified together in a listing for Graded cards. */
|
|
638
|
+
applicableToConditionDescriptorIds?: string[];
|
|
639
|
+
/** @description The value returned in this field indicates whether a condition descriptor can have a single value or multiple values. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:CardinalityEnum'>eBay API documentation</a> */
|
|
640
|
+
cardinality?: string;
|
|
641
|
+
/** @description The default condition descriptor value that will be set if there are multiple values. */
|
|
642
|
+
defaultConditionDescriptorValueId?: string;
|
|
643
|
+
/**
|
|
644
|
+
* Format: int32
|
|
645
|
+
* @description The maximum characters allowed for a condition descriptor. This field is only returned/applicable for condition descriptors that allow free text for condition descriptor values.
|
|
646
|
+
*/
|
|
647
|
+
maxLength?: number;
|
|
648
|
+
/** @description The value returned in this field indicates whether the supported values for a condition descriptor are predefined or if the seller manually specified the value.<br><br><span class="tablenote"><b>Note:</b> <code>FREE_TEXT</code> is currently only applicable to the Certification Number condition descriptor.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ModeEnum'>eBay API documentation</a> */
|
|
649
|
+
mode?: string;
|
|
650
|
+
/** @description This value indicates whether or not the condition descriptor is required for the item condition. Currently, this field is only returned if the condition descriptor is required for the item condition. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:DescriptorUsageEnum'>eBay API documentation</a> */
|
|
651
|
+
usage?: string;
|
|
652
|
+
};
|
|
653
|
+
/** @description This type displays the possible values for the corresponding condition descriptor, along with help text and constraint information. */
|
|
654
|
+
ItemConditionDescriptorValue: {
|
|
655
|
+
/** @description Additional information about the the condition of the item that is not included in the <b>conditionDescriptorValueHelpText</b> field. */
|
|
656
|
+
conditionDescriptorValueAdditionalHelpText?: string[];
|
|
657
|
+
/** @description The constraints on a condition descriptor value, such as which descriptor value IDs and Descriptor ID it is associated with. */
|
|
658
|
+
conditionDescriptorValueConstraints?: components['schemas']['ItemConditionDescriptorValueConstraint'][];
|
|
659
|
+
/** @description A detailed description of the condition descriptor value. */
|
|
660
|
+
conditionDescriptorValueHelpText?: string;
|
|
661
|
+
/** @description The unique identification number of a condition descriptor value associated with the <b>conditionDescriptorValueName</b>. */
|
|
662
|
+
conditionDescriptorValueId?: string;
|
|
663
|
+
/** @description The human-readable label for the condition descriptor value associated with the <b>conditionDescriptorValueID</b>. */
|
|
664
|
+
conditionDescriptorValueName?: string;
|
|
665
|
+
};
|
|
666
|
+
/** @description This type shows the constraints on a condition descriptor value, such as any associated condition descriptor ID and condition descriptor value IDs required for a listing. */
|
|
667
|
+
ItemConditionDescriptorValueConstraint: {
|
|
668
|
+
/** @description This string is returned if the corresponding condition descriptor value requires an associated condition descriptor that must also be specified in a listing. The condition descriptor ID for the associated condition descriptors is returned here. */
|
|
669
|
+
applicableToConditionDescriptorId?: string;
|
|
670
|
+
/** @description This array is returned if the corresponding condition descriptor value is required for one or more associated condition descriptor values that must also be specified in a listing. The condition descriptor values IDs for the associated condition descriptor values are returned here. */
|
|
671
|
+
applicableToConditionDescriptorValueIds?: string[];
|
|
672
|
+
};
|
|
673
|
+
ItemConditionPolicy: {
|
|
674
|
+
/** @description The category ID to which the item-condition policy applies. */
|
|
675
|
+
categoryId?: string;
|
|
676
|
+
/** @description A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. <br><br>A <i>category tree</i> is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique <b>categoryId</b> value. Within a category tree, the root node has no parent node and <i>leaf nodes</i> are nodes that have no child nodes. */
|
|
677
|
+
categoryTreeId?: string;
|
|
678
|
+
/** @description This flag denotes whether or not you must list the item condition in a listing for the specified category. If set to <code>true</code>, you must specify an item condition for the associated category. */
|
|
679
|
+
itemConditionRequired?: boolean;
|
|
680
|
+
/** @description The item-condition values allowed in the category.<br><br><span class="tablenote"><b>Note:</b> The ‘Seller Refurbished’ item condition (condition ID 2500) has been replaced by the 'Excellent - Refurbished', 'Very Good - Refurbished', and 'Good - Refurbished' item conditions in a select number of eBay marketplaces and categories. See the <a href="/api-docs/sell/static/metadata/condition-id-values.html#Category " target="_blank "> eBay Refurbished Program - Category and marketplace support</a> topic for more details.<br/><br/>Similar to the ‘Certified Refurbished’ item condition (condition ID 2000), a seller’s OAuth user token will have to be used instead of an OAuth application token, since each seller must go through an application and qualification process before using any of these new refurbished item conditions in supported categories. If a seller is not qualified to use the new refurbished item conditions, these item condition values will not be returned by <b>getItemConditionPolicies</b>.</span> */
|
|
681
|
+
itemConditions?: components['schemas']['ItemCondition'][];
|
|
682
|
+
};
|
|
683
|
+
ItemConditionPolicyResponse: {
|
|
684
|
+
/** @description A list of category IDs and the policies for how to indicate an item's condition in each of the listed categories. */
|
|
685
|
+
itemConditionPolicies?: components['schemas']['ItemConditionPolicy'][];
|
|
686
|
+
/** @description A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
687
|
+
warnings?: components['schemas']['Error'][];
|
|
688
|
+
};
|
|
689
|
+
/** @description This type identifies the kind of listing and its duration periods. */
|
|
690
|
+
ListingDuration: {
|
|
691
|
+
/** @description This array defines the supported time duration options available for the listing type. */
|
|
692
|
+
durationValues?: string[];
|
|
693
|
+
/** @description The enumerated value returned in this field indicates the listing type for the duration value(s). For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ListingTypeEnum'>eBay API documentation</a> */
|
|
694
|
+
listingType?: string;
|
|
695
|
+
};
|
|
696
|
+
ListingStructurePolicy: {
|
|
697
|
+
/** @description The category ID to which the listing-structure policy applies. */
|
|
698
|
+
categoryId?: string;
|
|
699
|
+
/** @description A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. <br><br>A <i>category tree</i> is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique <b>categoryId</b> value. Within a category tree, the root node has no parent node and <i>leaf nodes</i> are nodes that have no child nodes. */
|
|
700
|
+
categoryTreeId?: string;
|
|
701
|
+
/** @description This flag denotes whether or not the associated category supports listings with item variations. If set to <code>true</code>, the category does support item variations. */
|
|
702
|
+
variationsSupported?: boolean;
|
|
703
|
+
};
|
|
704
|
+
ListingStructurePolicyResponse: {
|
|
705
|
+
/** @description Returns a list of category IDs plus a flag indicating whether or not each listed category supports item variations. */
|
|
706
|
+
listingStructurePolicies?: components['schemas']['ListingStructurePolicy'][];
|
|
707
|
+
/** @description A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
708
|
+
warnings?: components['schemas']['Error'][];
|
|
709
|
+
};
|
|
710
|
+
/** @description This type contains the selling formats for eBay listings. */
|
|
711
|
+
ListingTypePoliciesResponse: {
|
|
712
|
+
/** @description This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter <b>marketplace_id</b> and optionally limited by only those leaf category IDs specified in the query parameter <b>filter</b>. */
|
|
713
|
+
listingTypePolicies?: components['schemas']['ListingTypePolicy'][];
|
|
714
|
+
/** @description An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
715
|
+
warnings?: components['schemas']['Error'][];
|
|
716
|
+
};
|
|
717
|
+
/** @description This type contains the policies governing the listing type by category. */
|
|
718
|
+
ListingTypePolicy: {
|
|
719
|
+
/** @description The unique identifier of the eBay leaf category for which metadata is being returned. */
|
|
720
|
+
categoryId?: string;
|
|
721
|
+
/** @description The unique identifier of the category tree. */
|
|
722
|
+
categoryTreeId?: string;
|
|
723
|
+
/** @description A <code>true</code> value in this field indicates that the leaf category supports the listing of items (such as gift cards) that can be delivered electronically via a download link or sent to a buyer's email address. */
|
|
724
|
+
digitalGoodDeliveryEnabled?: boolean;
|
|
725
|
+
/** @description An array of eBay listing types and the supported durations for the corresponding leaf category. If a specific eBay listing type does not appear for a leaf category, it indicates that the category does not support that listing type. */
|
|
726
|
+
listingDurations?: components['schemas']['ListingDuration'][];
|
|
727
|
+
/** @description A true value in this field indicates that items listed in the category (specified in the <b>listingTypePolicies.categoryId</b> field) may be enabled with the 'Click and Collect' feature. With the 'Click and Collect' feature, a buyer can purchase certain items on an eBay site and collect them at a local store. Buyers are notified by eBay once their items are available. A false value in this field indicates that items listed in the category are not eligible for the 'Click and Collect' feature. */
|
|
728
|
+
pickupDropOffEnabled?: boolean;
|
|
729
|
+
};
|
|
730
|
+
/** @description This type contains the kind of distance and radius of the selling area for Local Market Vehicle listings. */
|
|
731
|
+
LocalListingDistance: {
|
|
732
|
+
/** @description This array indicates the radius (in miles) of the selling area for Local Market Vehicle listings. */
|
|
733
|
+
distances?: number[];
|
|
734
|
+
/** @description This enumerated value indicates the type of local listing distances, such as non-subscription or regular, for items listed by sellers. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:DistanceType'>eBay API documentation</a> */
|
|
735
|
+
distanceType?: string;
|
|
736
|
+
};
|
|
737
|
+
MotorsListingPoliciesResponse: {
|
|
738
|
+
/** @description This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter <b>marketplace_id</b> and optionally limited by only those leaf category IDs specified in the query parameter <b>filter</b>. */
|
|
739
|
+
motorsListingPolicies?: components['schemas']['MotorsListingPolicy'][];
|
|
740
|
+
/** @description An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
741
|
+
warnings?: components['schemas']['Error'][];
|
|
742
|
+
};
|
|
743
|
+
MotorsListingPolicy: {
|
|
744
|
+
/** @description The unique identifier of the eBay leaf category for which metadata is being returned. */
|
|
745
|
+
categoryId?: string;
|
|
746
|
+
/** @description The unique identifier of the category tree. */
|
|
747
|
+
categoryTreeId?: string;
|
|
748
|
+
/** @description This field is returned as <code>true</code> if the corresponding category supports the use of a deposit/down payment on a motor vehicle listing. In an AddItem call, the seller can configure a down payment for a motor vehicle listing using the PaymentDetails container. */
|
|
749
|
+
depositSupported?: boolean;
|
|
750
|
+
/** @description Indicates whether or not eBay Motors Pro sellers can use classified ads in this category to sell their vehicles. This element is applicable for eBay Motors Pro users. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:AdFormatEnabledEnum'>eBay API documentation</a> */
|
|
751
|
+
ebayMotorsProAdFormatEnabled?: string;
|
|
752
|
+
/** @description Indicates whether or not the category supports the Best Offer Auto Accept feature for eBay Motors Pro listings. This element is for eBay Motors Pro users. */
|
|
753
|
+
ebayMotorsProAutoAcceptEnabled?: boolean;
|
|
754
|
+
/** @description Indicates whether or not the category allows auto-decline for Best Offers for eBay Motors Classified Ad listings. This element is for eBay Motors Pro users. */
|
|
755
|
+
ebayMotorsProAutoDeclineEnabled?: boolean;
|
|
756
|
+
/** @description This enumerated value indicates whether or not Best Offer features are supported for eBay Motors Classified Ad listings in this category. This element is for eBay Motors Pro users. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ClassifiedAdBestOfferEnabledEnum'>eBay API documentation</a> */
|
|
757
|
+
ebayMotorsProBestOfferEnabled?: string;
|
|
758
|
+
/** @description Indicates whether this category supports including the company name in the seller's contact information. This element is for eBay Motors Pro users. */
|
|
759
|
+
ebayMotorsProCompanyNameEnabled?: boolean;
|
|
760
|
+
/** @description Indicates whether this category supports including the address in the seller's contact information. This element is for eBay Motors Pro users. */
|
|
761
|
+
ebayMotorsProContactByAddressEnabled?: boolean;
|
|
762
|
+
/** @description Indicates whether this category supports including an email address in the seller's contact information. This element is for eBay Motors Pro users. */
|
|
763
|
+
ebayMotorsProContactByEmailEnabled?: boolean;
|
|
764
|
+
/** @description Indicates whether this category supports including the telephone in the seller's contact information. This element is for eBay Motors Pro users. */
|
|
765
|
+
ebayMotorsProContactByPhoneEnabled?: boolean;
|
|
766
|
+
/** @description Indicates whether counter offers are allowed on Best Offers for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users. */
|
|
767
|
+
ebayMotorsProCounterOfferEnabled?: boolean;
|
|
768
|
+
/** @description This enumerated value indicates whether this category supports that the payment method should be displayed to the user for this category in an eBay Motors Classified Ad listing. Even if enabled, checkout may or may not be enabled. This element is for eBay Motors Pro users. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ClassifiedAdPaymentMethodEnabledEnum'>eBay API documentation</a> */
|
|
769
|
+
ebayMotorsProPaymentMethodCheckOutEnabled?: string;
|
|
770
|
+
/**
|
|
771
|
+
* Format: int32
|
|
772
|
+
* @description Indicates the number of phone numbers that can be included through contact information for this category. This element is for eBay Motors Pro users.
|
|
773
|
+
*/
|
|
774
|
+
ebayMotorsProPhoneCount?: number;
|
|
775
|
+
/** @description Indicates whether this category allows seller-level contact information for eBay Motors Classified Ad listings. A value of true means seller-level contact information is available for Classified Ad listings. This element is for eBay Motors Pro users. */
|
|
776
|
+
ebayMotorsProSellerContactDetailsEnabled?: boolean;
|
|
777
|
+
/** @description Indicates if shipping options should be displayed to the user for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users. */
|
|
778
|
+
ebayMotorsProShippingMethodEnabled?: boolean;
|
|
779
|
+
/**
|
|
780
|
+
* Format: int32
|
|
781
|
+
* @description This field indicates the number of street addresses allowed in contact information for this category. This element is for eBay Motors Pro users.
|
|
782
|
+
*/
|
|
783
|
+
ebayMotorsProStreetCount?: number;
|
|
784
|
+
/** @description If returned as <code>true</code>, this indicates the category supports the use of an eBay Product ID (e.g. ePID) to identify which motorcycles and/or scooters are compatible with a motor vehicle part or accessory. ePIDs can only be used to identify motorcycles and scooters on the Germany and UK sites. */
|
|
785
|
+
epidSupported?: boolean;
|
|
786
|
+
/** @description This field indicates whether or not the category supports the use of a K type to identify the cars and trucks compatible with a motor vehicle part or accessory. Only the AU, DE, ES, FR, IT, and UK marketplaces support the use of K types. See <a href="/api-docs/user-guides/static/trading-user-guide/manually-specify-compatibility.html#ktype" target="_blank">Compatibility by K type</a> for more information */
|
|
787
|
+
kTypeSupported?: boolean;
|
|
788
|
+
/** @description This array shows the supported distances (in miles) for different types of Local Market subscription types in this category. Motor vehicle listings will be shown to buyers located within these proximities of the vehicle's location. */
|
|
789
|
+
localListingDistances?: components['schemas']['LocalListingDistance'][];
|
|
790
|
+
/** @description Specifies whether this category supports Motor Local Market Classified Ad listings. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:AdFormatEnabledEnum'>eBay API documentation</a> */
|
|
791
|
+
localMarketAdFormatEnabled?: string;
|
|
792
|
+
/** @description Specifies whether this category supports auto-accept for Best Offers for Motors Local Market Classified Ads. */
|
|
793
|
+
localMarketAutoAcceptEnabled?: boolean;
|
|
794
|
+
/** @description Specifies whether this category supports auto-decline for Best Offers for Motors Local Market Classified Ads. */
|
|
795
|
+
localMarketAutoDeclineEnabled?: boolean;
|
|
796
|
+
/** @description Indicates if Best Offer is enabled/required for Motors Local Market Classified Ad listings in this category. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ClassifiedAdBestOfferEnabledEnum'>eBay API documentation</a> */
|
|
797
|
+
localMarketBestOfferEnabled?: string;
|
|
798
|
+
/** @description Indicates whether the category supports the seller's company name being specified when using Motors Local Market classified ads. */
|
|
799
|
+
localMarketCompanyNameEnabled?: boolean;
|
|
800
|
+
/** @description Indicates whether this category supports including the address in the seller's contact information. */
|
|
801
|
+
localMarketContactByAddressEnabled?: boolean;
|
|
802
|
+
/** @description Indicates whether the category supports including an email address in the seller's contact information. */
|
|
803
|
+
localMarketContactByEmailEnabled?: boolean;
|
|
804
|
+
/** @description Indicates whether this category supports including the telephone in the seller's contact information. */
|
|
805
|
+
localMarketContactByPhoneEnabled?: boolean;
|
|
806
|
+
/** @description Indicates whether counter offers are allowed on Best Offers for this category for Motors Local Market Classified Ad listings. */
|
|
807
|
+
localMarketCounterOfferEnabled?: boolean;
|
|
808
|
+
/** @description Indicates whether the category supports a seller creating a Motors Local Market listing without a subscription. This feature is only available to licensed vehicle dealers. */
|
|
809
|
+
localMarketNonSubscription?: boolean;
|
|
810
|
+
/** @description Indicates if the payment method should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ClassifiedAdPaymentMethodEnabledEnum'>eBay API documentation</a> */
|
|
811
|
+
localMarketPaymentMethodCheckOutEnabled?: string;
|
|
812
|
+
/**
|
|
813
|
+
* Format: int32
|
|
814
|
+
* @description Indicates the number of phone numbers that can be included through contact information for this category.
|
|
815
|
+
*/
|
|
816
|
+
localMarketPhoneCount?: number;
|
|
817
|
+
/** @description Indicates whether the category supports the Premium level subscription Motors Local Market listings. This feature is only available to licensed vehicle dealers. */
|
|
818
|
+
localMarketPremiumSubscription?: boolean;
|
|
819
|
+
/** @description Indicates whether the category supports the Regular level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers. */
|
|
820
|
+
localMarketRegularSubscription?: boolean;
|
|
821
|
+
/** @description Specifies the whether this category allows seller-level contact information for Motors Local Market Classified Ad listings. */
|
|
822
|
+
localMarketSellerContactDetailsEnabled?: boolean;
|
|
823
|
+
/** @description Indicates if shipping methods should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled. */
|
|
824
|
+
localMarketShippingMethodEnabled?: boolean;
|
|
825
|
+
/** @description Indicates whether the category supports the Speciality level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers. */
|
|
826
|
+
localMarketSpecialitySubscription?: boolean;
|
|
827
|
+
/**
|
|
828
|
+
* Format: int32
|
|
829
|
+
* @description Indicates which address option is enabled for the seller's contact information.
|
|
830
|
+
*/
|
|
831
|
+
localMarketStreetCount?: number;
|
|
832
|
+
/**
|
|
833
|
+
* Format: int32
|
|
834
|
+
* @description Indicates the maximum number of compatible applications allowed per item when adding or revising items with compatibilities provided at the most detailed granularity. For example, in Car and Truck Parts on the US site, the most granular application would include Year, Make, Model, Trim, and Engine.
|
|
835
|
+
*/
|
|
836
|
+
maxGranularFitmentCount?: number;
|
|
837
|
+
/**
|
|
838
|
+
* Format: int32
|
|
839
|
+
* @description Indicates the maximum number of compatible applications allowed per item when adding or revising items. This is relevant for specifying parts compatibility by application manually only. See <a href="/api-docs/user-guides/static/trading-user-guide/manually-specify-compatibility.html" target="_blank">Specify parts compatibility manually</a> and <a href="/api-docs/sell/static/inventory/managing-product-compatibility.html" target="_blank">Managing product compatibility</a> for more information.
|
|
840
|
+
*/
|
|
841
|
+
maxItemCompatibility?: number;
|
|
842
|
+
/**
|
|
843
|
+
* Format: int32
|
|
844
|
+
* @description Indicates the minimum number of required compatible applications for listing items. A value of <code>0</code> indicates it is not mandatory to specify parts compatibilities when listing.
|
|
845
|
+
*/
|
|
846
|
+
minItemCompatibility?: number;
|
|
847
|
+
/** @description The value in this field indicates whether the category supports Motors Local Market listings if the seller does not have a vehicle subscription. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:GeographicExposureEnum'>eBay API documentation</a> */
|
|
848
|
+
nonSubscription?: string;
|
|
849
|
+
/** @description The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Premium vehicle subscription. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:GeographicExposureEnum'>eBay API documentation</a> */
|
|
850
|
+
premiumSubscription?: string;
|
|
851
|
+
/** @description The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Regular vehicle subscription. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:GeographicExposureEnum'>eBay API documentation</a> */
|
|
852
|
+
regularSubscription?: string;
|
|
853
|
+
/** @description This field is returned as <code>true</code> if the corresponding category supports the use of a seller-provided title for a motor vehicle listing on the US or Canada Motors marketplaces. A seller-provided title is a descriptive title, given by the seller, that appears below eBay's pre-filled listing title for the motor vehicle. Visually, the seller-provided title is similar to a subtitle on other types of eBay listings (non-vehicle). A seller-provided title can assist in helping buyers discover the vehicle. */
|
|
854
|
+
sellerProvidedTitleSupported?: boolean;
|
|
855
|
+
/** @description The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:GeographicExposureEnum'>eBay API documentation</a> */
|
|
856
|
+
specialitySubscription?: string;
|
|
857
|
+
/** @description Indicates if Vehicle Identification Number is supported. */
|
|
858
|
+
vinSupported?: boolean;
|
|
859
|
+
/** @description Indicates if Vehicle Registration Mark is supported. */
|
|
860
|
+
vrmSupported?: boolean;
|
|
861
|
+
};
|
|
862
|
+
/** @description This type defines the request fields used in the <b>getMultiCompatibilityPropertyValues</b> method. */
|
|
863
|
+
MultiCompatibilityPropertyValuesRequest: {
|
|
864
|
+
/** @description The unique identifier of the eBay leaf category for which to retrieve property values.<br><br>Use the <a href="/api-docs/sell/metadata/resources/marketplace/methods/getAutomotivePartsCompatibilityPolicies" target="_blank ">getAutomotivePartsCompatibilityPolicies</a> method to retrieve a list of categories that support parts compatibility. */
|
|
865
|
+
categoryId?: string;
|
|
866
|
+
/** @description This array can be used to specify the compatibility properties used to limit the result set. Only values associated with the specified name-value pairs will be returned in the response.<br><br>For example, if the <b>propertyName</b> is set to <code>Year</code> and the <b>propertyValue</b> is set to <code>2022</code>, only compatible vehicles from 2022 will be returned.<br><br>At least one property name-value pair must be used. */
|
|
867
|
+
propertyFilters?: components['schemas']['PropertyFilterInner'][];
|
|
868
|
+
/** @description This comma-delimited array specifies the names of the properties for which to retrieve associated property values.<br><br>For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. */
|
|
869
|
+
propertyNames?: string[];
|
|
870
|
+
};
|
|
871
|
+
/** @description This type defines the response fields for the <b>getMultiCompatibilityPropertyValues</b> method. */
|
|
872
|
+
MultiCompatibilityPropertyValuesResponse: {
|
|
873
|
+
/** @description This container defines the compatibility details associated with the specified property name value(s). */
|
|
874
|
+
compatibilities?: components['schemas']['Compatibility'][];
|
|
875
|
+
/** @description The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace. */
|
|
876
|
+
metadataVersion?: string;
|
|
877
|
+
};
|
|
878
|
+
NegotiatedPricePolicy: {
|
|
879
|
+
/** @description This flag denotes whether or not the category supports the setting of a price at which best offers are automatically accepted. If set to <code>true</code>, the category does support the setting of an automatic price for best-offers. */
|
|
880
|
+
bestOfferAutoAcceptEnabled?: boolean;
|
|
881
|
+
/** @description This flag denotes whether or not the category supports the setting of an auto-decline price for best offers. If set to <code>true</code>, the category does support the setting of an automatic-decline price for best-offers. */
|
|
882
|
+
bestOfferAutoDeclineEnabled?: boolean;
|
|
883
|
+
/** @description This flag denotes whether or not the category supports the setting for an automatic counter-offer on best offers. If set to <code>true</code>, the category does support the setting of an automatic counter-offer price for best-offers. */
|
|
884
|
+
bestOfferCounterEnabled?: boolean;
|
|
885
|
+
/** @description The category ID to which the negotiated-price policies apply. */
|
|
886
|
+
categoryId?: string;
|
|
887
|
+
/** @description A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. <br><br>A <i>category tree</i> is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique <b>categoryId</b> value. Within a category tree, the root node has no parent node and <i>leaf nodes</i> are nodes that have no child nodes. */
|
|
888
|
+
categoryTreeId?: string;
|
|
889
|
+
};
|
|
890
|
+
NegotiatedPricePolicyResponse: {
|
|
891
|
+
/** @description A list of category IDs and the policies related to negotiated-price items for each of the listed categories. */
|
|
892
|
+
negotiatedPricePolicies?: components['schemas']['NegotiatedPricePolicy'][];
|
|
893
|
+
/** @description A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
894
|
+
warnings?: components['schemas']['Error'][];
|
|
895
|
+
};
|
|
896
|
+
/** @description This type defines the pagination settings for a result set. */
|
|
897
|
+
Pagination: {
|
|
898
|
+
/**
|
|
899
|
+
* Format: int32
|
|
900
|
+
* @description The number of results showing on the current page of results.
|
|
901
|
+
*/
|
|
902
|
+
count?: number;
|
|
903
|
+
/**
|
|
904
|
+
* Format: int32
|
|
905
|
+
* @description The max number of entries that can be returned on a single page.
|
|
906
|
+
*/
|
|
907
|
+
limit?: number;
|
|
908
|
+
/**
|
|
909
|
+
* Format: int32
|
|
910
|
+
* @description The number of items that will be skipped in the result set before returning the first item in the paginated response.
|
|
911
|
+
*/
|
|
912
|
+
offset?: number;
|
|
913
|
+
/**
|
|
914
|
+
* Format: int32
|
|
915
|
+
* @description The total number of results in a result set.
|
|
916
|
+
*/
|
|
917
|
+
total?: number;
|
|
918
|
+
};
|
|
919
|
+
/** @description This type defines the fields used to control the pagination of the result set. */
|
|
920
|
+
PaginationInput: {
|
|
921
|
+
/**
|
|
922
|
+
* Format: int32
|
|
923
|
+
* @description The max number of items, from the current result set, returned on a single page.<br><br><span class="tablenote"><b>Note:</b> For <b>getProductCompatibilities</b>, the max value is 100. If no <b>limit</b> is specified, this field defaults to the max value.</span>
|
|
924
|
+
*/
|
|
925
|
+
limit?: number;
|
|
926
|
+
/**
|
|
927
|
+
* Format: int32
|
|
928
|
+
* @description The number of items that will be skipped in the result set before returning the first item in the paginated response.<br><br>Combine <b>offset</b> with <b>limit</b> to control the items returned in the response. For example, if you supply an offset of 10 and a limit of 20, the first page of the response contains items 11-30 from the complete result set.<br><br><b>Default:</b> 0
|
|
929
|
+
*/
|
|
930
|
+
offset?: number;
|
|
931
|
+
};
|
|
932
|
+
/** @description A type that describes pictograms for hazardous materials labels. */
|
|
933
|
+
Pictogram: {
|
|
934
|
+
/** @description The identifier of the pictogram. For sample values, see <a href='/api-docs/sell/static/metadata/feature-regulatorhazmatcontainer.html#Pictogra'>Pictogram sample values</a>. */
|
|
935
|
+
pictogramId?: string;
|
|
936
|
+
/** @description The description of the pictogram localized to the default language of the marketplace. For sample values, see <a href='/api-docs/sell/static/metadata/feature-regulatorhazmatcontainer.html#Pictogra'>Pictogram sample values</a>. */
|
|
937
|
+
pictogramDescription?: string;
|
|
938
|
+
/** @description The URL of the pictogram. */
|
|
939
|
+
pictogramUrl?: string;
|
|
940
|
+
};
|
|
941
|
+
/** @description This type defines the supported product identifiers. */
|
|
942
|
+
ProductIdentifier: {
|
|
943
|
+
/** @description The EAN of the item, if applicable. EAN is the European Article Number, a barcode standard for retail product labeling primarily used outside of North America. */
|
|
944
|
+
ean?: string;
|
|
945
|
+
/** @description The ePID (eBay Product Identifier) of the item, if applicable. ePID is a unique identifier used by eBay to track products in its catalog.<br><br>Use the <a href="/api-docs/commerce/catalog/resources/product/methods/getProduct" target="_blank ">getProduct</a> method of the Catalog API to retrieve the ePID of an item. */
|
|
946
|
+
epid?: string;
|
|
947
|
+
/** @description The ISBN of the item, if applicable. ISBN is the International Standard Book Number, a unique identifier for books. */
|
|
948
|
+
isbn?: string;
|
|
949
|
+
/** @description The product ID of the item, if applicable. The product ID is a general term for a unique identifier assigned to a product. */
|
|
950
|
+
productId?: string;
|
|
951
|
+
/** @description The UPC of the item, if applicable. UPC stands for Universal Product Code, a unique identifier for products, primarily in North America. */
|
|
952
|
+
upc?: string;
|
|
953
|
+
};
|
|
954
|
+
/** @description This type defines the request fields for the <b>getProductCompatibilities</b> method. */
|
|
955
|
+
ProductRequest: {
|
|
956
|
+
/** @description This array is used to filter the properties of an application, such as a vehicle's make or model, that will be returned in the response.<br><br>Application property filters are specified as name-value pairs. Only products compatible with these name-value pairs will be returned. */
|
|
957
|
+
applicationPropertyFilters?: components['schemas']['PropertyFilterInner'][];
|
|
958
|
+
/** @description This array defines the type of properties that are returned for the catalog-enabled category.<br><br>For example, if you specify <code>Searchable</code>, the compatibility details will contain properties that can be used to search for products, such as make or model.<br><br><span class="tablenote"><b>Note:</b> This field cannot be used alongside <b>dataPropertyName</b>. If both are used, an error will occur.</span><br><b>Valid values:</b><ul><li><code>DisplayableProductDetails</code>: Properties for use in a user interface to describe products.</li><li><code>DisplayableSearchResults</code>: Properties for use in results for product searches.</li><li><code>Searchable</code>: Properties for use in searches.</li><li><code>Sortable</code>: Properties that are suitable for sorting.</li></ul><br><b>Default:</b> <code>DisplayableSearchResults</code> */
|
|
959
|
+
dataset?: string[];
|
|
960
|
+
/** @description This comma-delimted array can be used to define the specific property name(s) that will be returned in the response.<br><br>For example, if you specify <code>Engine</code>, the result set will only contain engines that are compatible with the input criteria.<br><br><span class="tablenote"><b>Note:</b> This array cannot be used alongside <b>dataset</b>. If both are used, an error will occur.</span> */
|
|
961
|
+
datasetPropertyName?: string[];
|
|
962
|
+
/** @description This container can be used to specify whether or not to filter out products which are disabled for selling on eBay and/or disabled for product review. */
|
|
963
|
+
disabledProductFilter?: components['schemas']['DisabledProductFilter'];
|
|
964
|
+
/** @description This container controls the pagination of the result set. */
|
|
965
|
+
paginationInput?: components['schemas']['PaginationInput'];
|
|
966
|
+
/** @description This container is used to provide unique identifier for the product. The product identifier consists of an identifier type and value, and are unique across all sites. */
|
|
967
|
+
productIdentifier?: components['schemas']['ProductIdentifier'];
|
|
968
|
+
/** @description This array controls the sort order of compatibility properties. */
|
|
969
|
+
sortOrders?: components['schemas']['SortOrderInner'][];
|
|
970
|
+
};
|
|
971
|
+
/** @description This type defines the response fields for the <b>getProductCompatibilities</b> method. */
|
|
972
|
+
ProductResponse: {
|
|
973
|
+
/** @description This container provides compatibility details for the specified product. */
|
|
974
|
+
compatibilityDetails?: components['schemas']['ProductResponseCompatibilityDetails'][];
|
|
975
|
+
/** @description This container returns the pagination settings for the result set. */
|
|
976
|
+
pagination?: components['schemas']['Pagination'];
|
|
977
|
+
};
|
|
978
|
+
/** @description This type defines the compatibility details for a product. */
|
|
979
|
+
ProductResponseCompatibilityDetails: {
|
|
980
|
+
/** @description This array returns additional comments about the corresponding product in the form of name-value pairs. */
|
|
981
|
+
noteDetails?: components['schemas']['PropertyFilterInner'][];
|
|
982
|
+
/** @description This array returns details about the product in the form of name-value pairs. */
|
|
983
|
+
productDetails?: components['schemas']['PropertyValues'][];
|
|
984
|
+
};
|
|
985
|
+
/** @description A type that describes pictograms for product safety labels. */
|
|
986
|
+
ProductSafetyLabelPictogram: {
|
|
987
|
+
/** @description The description of the pictogram localized to the default language of the marketplace. */
|
|
988
|
+
pictogramDescription?: string;
|
|
989
|
+
/** @description The identifier of the pictogram. */
|
|
990
|
+
pictogramId?: string;
|
|
991
|
+
/** @description The URL of the pictogram. */
|
|
992
|
+
pictogramUrl?: string;
|
|
993
|
+
};
|
|
994
|
+
/** @description A type that describes statements for product safety labels. */
|
|
995
|
+
ProductSafetyLabelStatement: {
|
|
996
|
+
/** @description The description of the statement localized to the default language of the marketplace. */
|
|
997
|
+
statementDescription?: string;
|
|
998
|
+
/** @description The identifier of the statement. */
|
|
999
|
+
statementId?: string;
|
|
1000
|
+
};
|
|
1001
|
+
/** @description A type that defines the response fields for the <b>getProductSafetyLabels</b> method. */
|
|
1002
|
+
ProductSafetyLabelsResponse: {
|
|
1003
|
+
/** @description This array contains a list of pictograms of product safety labels for the specified marketplace. */
|
|
1004
|
+
pictograms?: components['schemas']['ProductSafetyLabelPictogram'][];
|
|
1005
|
+
/** @description This array contains available product safety labels statements for the specified marketplace. */
|
|
1006
|
+
statements?: components['schemas']['ProductSafetyLabelStatement'][];
|
|
1007
|
+
};
|
|
1008
|
+
/** @description This type is used to define the available compatibility property filters. */
|
|
1009
|
+
PropertyFilterInner: {
|
|
1010
|
+
/** @description The name of the property being described.<br><br>For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the <a href="/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyNames" target="_blank ">getCompatibilityPropertyNames</a> method to retrieve valid property names for a specified category. */
|
|
1011
|
+
propertyName?: string;
|
|
1012
|
+
/** @description The value for the property specified in the <b>properyName</b> field.<br><br>For example, if the <b>propertyName</b> is <code>Make</code>, then the <b>propertyValue</b> will be the specific make of the vehicle, such as <code>Toyota</code>. Use the <a href="/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues" target="_blank ">getCompatibilityPropertyValues</a> to retreive valid property values associated with a specified property name. */
|
|
1013
|
+
propertyValue?: string;
|
|
1014
|
+
/** @description The unit of measurement of the property being described, if applicable. */
|
|
1015
|
+
unitOfMeasurement?: string;
|
|
1016
|
+
/** @description The URL associated with the property being described, if applicable. */
|
|
1017
|
+
url?: string;
|
|
1018
|
+
};
|
|
1019
|
+
/** @description This type defines the request fields for the <b>getCompatibilityPropertyNames</b> method. */
|
|
1020
|
+
PropertyNamesRequest: {
|
|
1021
|
+
/** @description The unique identifier of the eBay leaf category for which to retrieve compatibility property names. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility.<br><br>Use the <a href="/api-docs/sell/metadata/resources/marketplace/methods/getAutomotivePartsCompatibilityPolicies" target="_blank ">getAutomotivePartsCompatibilityPolicies</a> method to retrieve a list of categories that support parts compatibility. */
|
|
1022
|
+
categoryId?: string;
|
|
1023
|
+
/** @description This array defines the properties that will be returned for the compatibility-enabled category.<br><br> For example, if you specify <code>Searchable</code>, the compatibility details will contain properties that can be used to search for products, such as make or model.<br><br><b>Valid values:</b><ul><li><code>DisplayableProductDetails</code>: Properties for use in a user interface to describe products.</li><li><code>DisplayableSearchResults</code>: Properties for use in results for product searches.</li><li><code>Searchable</code>: Properties for use in searches.</li><li><code>Sortable</code>: Properties that are suitable for sorting.</li></ul><b>Default:</b> <code>DisplayableSearchResults</code> */
|
|
1024
|
+
dataset?: string[];
|
|
1025
|
+
};
|
|
1026
|
+
/** @description This type defines the fields returned in the <b>getCompatibilityPropertyNames</b> method. */
|
|
1027
|
+
PropertyNamesResponse: {
|
|
1028
|
+
/** @description The unique identifier of the eBay category specified in the request. */
|
|
1029
|
+
categoryId?: string;
|
|
1030
|
+
/** @description This array contains all of the properties for the specified category. */
|
|
1031
|
+
properties?: components['schemas']['PropertyNamesResponseProperties'][];
|
|
1032
|
+
};
|
|
1033
|
+
/** @description This type defines the properties and dataset for a specified category. */
|
|
1034
|
+
PropertyNamesResponseProperties: {
|
|
1035
|
+
/** @description This field defines the types of properties are returned for the specified catalog-enabled category.<br><br><b>Valid values:</b><ul><li><code>DisplayableProductDetails</code>: Properties for use in a user interface to describe products.</li><li><code>DisplayableSearchResults</code>: Properties for use in results for product searches.</li><li><code>Searchable</code>: Properties for use in searches.</li><li><code>Sortable</code>: Properties that are suitable for sorting.</li></ul> */
|
|
1036
|
+
dataset?: string;
|
|
1037
|
+
/** @description This array specifies the names of the properties associated with the specified category in the specified marketplace.<br><br>For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. */
|
|
1038
|
+
propertyNames?: components['schemas']['PropertyNamesResponsePropertyNames'][];
|
|
1039
|
+
};
|
|
1040
|
+
/** @description This type defines the property name metadata. */
|
|
1041
|
+
PropertyNamesResponsePropertyNameMetadata: {
|
|
1042
|
+
/**
|
|
1043
|
+
* Format: int32
|
|
1044
|
+
* @description The numeric value indicating the ordering position of the property.
|
|
1045
|
+
*/
|
|
1046
|
+
displaySequence?: number;
|
|
1047
|
+
};
|
|
1048
|
+
/** @description This type defines the fields associated with a property name. */
|
|
1049
|
+
PropertyNamesResponsePropertyNames: {
|
|
1050
|
+
/** @description The display name of a property. This is the localized name of the compatible property. */
|
|
1051
|
+
propertyDisplayName?: string;
|
|
1052
|
+
/** @description The canonical name of a property. This value is used as part of the name-value pairs used to specify compatibility. */
|
|
1053
|
+
propertyName?: string;
|
|
1054
|
+
/** @description The metadata for a property. */
|
|
1055
|
+
propertyNameMetadata?: components['schemas']['PropertyNamesResponsePropertyNameMetadata'];
|
|
1056
|
+
};
|
|
1057
|
+
/** @description This type defines the name-value pair associated with a property value. */
|
|
1058
|
+
PropertyValues: {
|
|
1059
|
+
/** @description The name of the property.<br><br>For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. */
|
|
1060
|
+
propertyName?: string;
|
|
1061
|
+
/** @description The value for the property specified in the <b>properyName</b> field.<br><br>For example, if the <b>propertyName</b> is <code>make</code>, then the <b>propertyValue</b> will be the specific make of the vehicle, such as <code>Toyota</code>. */
|
|
1062
|
+
propertyValue?: string;
|
|
1063
|
+
};
|
|
1064
|
+
/** @description This type defines the request fields used in the <b>getCompatibilityPropertyValues</b> method. */
|
|
1065
|
+
PropertyValuesRequest: {
|
|
1066
|
+
/** @description The unique identifier of the eBay leaf category for which to retrieve compatibility property values. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility.<br><br>Use the <a href="/api-docs/sell/metadata/resources/marketplace/methods/getAutomotivePartsCompatibilityPolicies" target="_blank ">getAutomotivePartsCompatibilityPolicies</a> method to retrieve a list of categories that support parts compatibility. */
|
|
1067
|
+
categoryId?: string;
|
|
1068
|
+
/** @description This array can be used to specify the compatibility properties used limit the result set. Only values associated with the specified name-value pairs will be returned in the response.<br><br>For example, if the <b>propertyName</b> is set to <code>Make</code> and the <b>propertyValue</b> is set to <code>Honda</code>, only compatible Honda vehicles will be returned. */
|
|
1069
|
+
propertyFilters?: components['schemas']['PropertyFilterInner'][];
|
|
1070
|
+
/** @description This field specifies the name of the property for which to retrieve associated property values.<br><br>For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the <a href="/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyNames" target="_blank ">getCompatibilityPropertyNames</a> method to retrieve valid property names for a specified category. */
|
|
1071
|
+
propertyName?: string;
|
|
1072
|
+
/** @description This field specifies the sort order for the property values in the result set.<br><br><b>Valid values:</b><ul><li><code>Ascending</code></li><li>Descending</li></ul><span class="tablenote"><b>Note:</b> If no search order is specified, values are sorted in ascending order.</span> */
|
|
1073
|
+
sortOrder?: string;
|
|
1074
|
+
};
|
|
1075
|
+
/** @description This type defines the response fields used in the <b>getCompatibilityPropertyValues</b> method. */
|
|
1076
|
+
PropertyValuesResponse: {
|
|
1077
|
+
/** @description The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace. */
|
|
1078
|
+
metadataVersion?: string;
|
|
1079
|
+
/** @description The name of the property specified in the request. */
|
|
1080
|
+
propertyName?: string;
|
|
1081
|
+
/** @description This array specifies the property values associated with the specified <b>propertyName</b>, in the specified category. */
|
|
1082
|
+
propertyValues?: string[];
|
|
1083
|
+
};
|
|
1084
|
+
/** @description A type that defines the attributes of a regulatory policy. */
|
|
1085
|
+
RegulatoryAttribute: {
|
|
1086
|
+
/** @description A unique value identifying a specific regulatory attribute. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:RegulatoryAttributeEnum'>eBay API documentation</a> */
|
|
1087
|
+
name?: string;
|
|
1088
|
+
/** @description The enumeration value in this field indicates whether the corresponding attribute is recommended or required for the corresponding leaf category. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:GenericUsageEnum'>eBay API documentation</a> */
|
|
1089
|
+
usage?: string;
|
|
1090
|
+
};
|
|
1091
|
+
/** @description A type that defines the regulatory policy. */
|
|
1092
|
+
RegulatoryPolicy: {
|
|
1093
|
+
/** @description The unique identifier of the leaf category to which the corresponding policies pertain. */
|
|
1094
|
+
categoryId?: string;
|
|
1095
|
+
/** @description The unique identifier of the category tree, which reflects the specified marketplace. */
|
|
1096
|
+
categoryTreeId?: string;
|
|
1097
|
+
/** @description A list of supported regulatory attributes for this marketplace. */
|
|
1098
|
+
supportedAttributes?: components['schemas']['RegulatoryAttribute'][];
|
|
1099
|
+
};
|
|
1100
|
+
/** @description A type that defines the response fields for the <b>getRegulatoryPolicies</b> method. */
|
|
1101
|
+
RegulatoryPolicyResponse: {
|
|
1102
|
+
/** @description A list of eBay policies that define whether or not you must include required regulatory information for leaf categories on the given marketplace. */
|
|
1103
|
+
regulatoryPolicies?: components['schemas']['RegulatoryPolicy'][];
|
|
1104
|
+
/** @description A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
1105
|
+
warnings?: components['schemas']['Error'][];
|
|
1106
|
+
};
|
|
1107
|
+
ReturnPolicy: {
|
|
1108
|
+
/** @description The category ID to which the return policies apply. */
|
|
1109
|
+
categoryId?: string;
|
|
1110
|
+
/** @description A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. <br><br>A <i>category tree</i> is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique <b>categoryId</b> value. Within a category tree, the root node has no parent node and <i>leaf nodes</i> are nodes that have no child nodes. */
|
|
1111
|
+
categoryTreeId?: string;
|
|
1112
|
+
/** @description This complex type defines the category policies related to domestic item returns. */
|
|
1113
|
+
domestic?: components['schemas']['ReturnPolicyDetails'];
|
|
1114
|
+
/** @description This complex type defines the category policies related to international item returns. */
|
|
1115
|
+
international?: components['schemas']['ReturnPolicyDetails'];
|
|
1116
|
+
/** @description If set to <code>true</code>, this flag indicates that you must specify a return policy for items listed in the associated category. <br><br>Note that not accepting returns (setting <b>returnsAcceptedEnabled</b> to <code>false</code>) is a valid return policy. */
|
|
1117
|
+
required?: boolean;
|
|
1118
|
+
};
|
|
1119
|
+
/** @description This container defines the category policies that relate to domestic and international return policies (the return shipping is made via a domestic or an international shipping service, respectively). */
|
|
1120
|
+
ReturnPolicyDetails: {
|
|
1121
|
+
/** @description If set to <code>true</code>, this flag indicates you can supply a detailed return policy description within your return policy (for example, by populating the <b>returnInstructions</b> field in the Account API's <b>createReturnPolicy</b>). User-supplied return policy details are allowed only in the DE, ES, FR, and IT marketplaces. */
|
|
1122
|
+
policyDescriptionEnabled?: boolean;
|
|
1123
|
+
/** @description A list of refund methods allowed for the associated category. */
|
|
1124
|
+
refundMethods?: string[];
|
|
1125
|
+
/** @description A list of return methods allowed for the associated category. */
|
|
1126
|
+
returnMethods?: string[];
|
|
1127
|
+
/** @description A list of return periods allowed for the associated category. <br><br>Note that different APIs require you to enter the return period in different ways. For example, the Account API uses the complex <b>TimeDuration</b> type, which takes two values (a <b>unit</b> and a <b>value</b>), whereas the Trading API takes a single value (such as <code>Days_30</code>). */
|
|
1128
|
+
returnPeriods?: components['schemas']['TimeDuration'][];
|
|
1129
|
+
/** @description If set to <code>true</code>, this flag indicates the seller can configure how they handle domestic returns. */
|
|
1130
|
+
returnsAcceptanceEnabled?: boolean;
|
|
1131
|
+
/** @description A list of allowed values for who pays for the return shipping cost. <br><br>Note that for SNAD returns, the seller is always responsible for the return shipping cost. */
|
|
1132
|
+
returnShippingCostPayers?: string[];
|
|
1133
|
+
};
|
|
1134
|
+
ReturnPolicyResponse: {
|
|
1135
|
+
/** @description A list of elements, where each contains a category ID and a flag that indicates whether or not listings in that category require a return policy. */
|
|
1136
|
+
returnPolicies?: components['schemas']['ReturnPolicy'][];
|
|
1137
|
+
/** @description A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
1138
|
+
warnings?: components['schemas']['Error'][];
|
|
1139
|
+
};
|
|
1140
|
+
/** @description A unique ID for a sales tax jurisdiction. */
|
|
1141
|
+
SalesTaxJurisdiction: {
|
|
1142
|
+
/** @description The unique ID for a sales-tax jurisdiction.<br><br><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="<b><span style="color: #dd1e31;" class="mcFormatColor">Important! </span></b>"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> When <code>countryCode</code> is set to <code>US</code>, IDs for all 50 states, Washington, DC, and all US territories will be returned. However, the only <code>salesTaxJurisdictionId</code> values currently supported are:<ul><li><code>AS</code> (American Samoa)</li><li><code>GU</code> (Guam</li><li><code>MP</code> Northern Mariana Islands</li><li><code>PW (Palau)</li><li><code>VI</code> (US Virgin Islands)</li></ul></p></div> */
|
|
1143
|
+
salesTaxJurisdictionId?: string;
|
|
1144
|
+
};
|
|
1145
|
+
/** @description This complex type contains a list of sales-tax jurisdictions. */
|
|
1146
|
+
SalesTaxJurisdictions: {
|
|
1147
|
+
/** @description A list of sales-tax jurisdictions. */
|
|
1148
|
+
salesTaxJurisdictions?: components['schemas']['SalesTaxJurisdiction'][];
|
|
1149
|
+
};
|
|
1150
|
+
/** @description This type provides fields applicable for shipping policy metadata for the leaf categories returned for the marketplace. */
|
|
1151
|
+
ShippingPoliciesResponse: {
|
|
1152
|
+
/** @description This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter <b>marketplace_id</b> and optionally limited by only those leaf category IDs specified in the query parameter <b>filter</b>. */
|
|
1153
|
+
shippingPolicies?: components['schemas']['ShippingPolicy'][];
|
|
1154
|
+
/** @description An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
1155
|
+
warnings?: components['schemas']['Error'][];
|
|
1156
|
+
};
|
|
1157
|
+
ShippingPolicy: {
|
|
1158
|
+
/** @description The unique identifier of the eBay leaf category for which metadata is being returned. */
|
|
1159
|
+
categoryId?: string;
|
|
1160
|
+
/** @description The unique identifier of the category tree. */
|
|
1161
|
+
categoryTreeId?: string;
|
|
1162
|
+
/** @description Indicates if the Global Shipping Program (GSP) is supported for the category. <p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>GSP is only supported by the eBay UK marketplace (<code>EBAY_GB</code>).</span></p> */
|
|
1163
|
+
globalShippingEnabled?: boolean;
|
|
1164
|
+
/** @description Returns the applicable max cap per shipping cost for shipping service group1. */
|
|
1165
|
+
group1MaxFlatShippingCost?: components['schemas']['Amount'];
|
|
1166
|
+
/** @description Returns the applicable max cap per shipping cost for shipping service group2. */
|
|
1167
|
+
group2MaxFlatShippingCost?: components['schemas']['Amount'];
|
|
1168
|
+
/** @description Returns the applicable max cap per shipping cost for shipping service group3. */
|
|
1169
|
+
group3MaxFlatShippingCost?: components['schemas']['Amount'];
|
|
1170
|
+
/** @description Indicates if a seller's stated handling time is enabled for a category. A handling time is generally needed for items that are shipped to the buyer, but not necessarily applicable to freight shipping or local pickup. */
|
|
1171
|
+
handlingTimeEnabled?: boolean;
|
|
1172
|
+
/** @description The maximum cost the seller can charge for the first domestic flat-rate shipping service. Mutually exclusive with the GroupNMaxFlatShippingCost elements. */
|
|
1173
|
+
maxFlatShippingCost?: components['schemas']['Amount'];
|
|
1174
|
+
/** @description Indicates whether the category requires sellers to specify shipping details at listing time. */
|
|
1175
|
+
shippingTermsRequired?: boolean;
|
|
1176
|
+
};
|
|
1177
|
+
/** @description A type that describes signal words for hazardous materials labels. */
|
|
1178
|
+
SignalWord: {
|
|
1179
|
+
/** @description The identifier of the signal word. For more information, see <a href='/api-docs/sell/static/metadata/feature-regulatorhazmatcontainer.html#Signal'>Signal word information</a>. */
|
|
1180
|
+
signalWordId?: string;
|
|
1181
|
+
/** @description The description of the signal word localized to the default language of the marketplace. For more information, see <a href='/api-docs/sell/static/metadata/feature-regulatorhazmatcontainer.html#Signal'>Signal word information</a>. */
|
|
1182
|
+
signalWordDescription?: string;
|
|
1183
|
+
};
|
|
1184
|
+
/** @description A type that contains eBay international site visibility policy metadata fields. */
|
|
1185
|
+
SiteVisibilityPoliciesResponse: {
|
|
1186
|
+
/** @description This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter <b>marketplace_id</b> and optionally limited by only those leaf category IDs specified in the query parameter <b>filter</b>. */
|
|
1187
|
+
siteVisibilityPolicies?: components['schemas']['SiteVisibilityPolicy'][];
|
|
1188
|
+
/** @description An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. */
|
|
1189
|
+
warnings?: components['schemas']['Error'][];
|
|
1190
|
+
};
|
|
1191
|
+
/** @description A type that contains eBay international cross border trade policy metadata fields. */
|
|
1192
|
+
SiteVisibilityPolicy: {
|
|
1193
|
+
/** @description The unique identifier of the eBay leaf category for which metadata is being returned. */
|
|
1194
|
+
categoryId?: string;
|
|
1195
|
+
/** @description The unique identifier of the category tree. */
|
|
1196
|
+
categoryTreeId?: string;
|
|
1197
|
+
/** @description If <code>true</code>, the category supports specifying that listings of a seller on the UK marketplace can pass in Australia as a value in a <CrossBorderTrade> field to expose that item on the eBay Australia site (ebay.com.au). For more information, see <a href="/api-docs/user-guides/static/trading-user-guide/cross-border-trading.html" target="_blank">Cross-border trading</a>. */
|
|
1198
|
+
crossBorderTradeAustraliaEnabled?: boolean;
|
|
1199
|
+
/** @description If <code>true</code>, the category supports specifying that listings of a seller on the US or Canada merketplaces can pass in UK as a value in a <CrossBorderTrade> field to expose that item on the eBay UK (ebay.co.uk) and eBay IE (ebay.ie) sites. For more information, see <a href="/api-docs/user-guides/static/trading-user-guide/cross-border-trading.html" target="_blank">Cross-border trading</a>. */
|
|
1200
|
+
crossBorderTradeGBEnabled?: boolean;
|
|
1201
|
+
/** @description If <code>true</code>, the category supports specifying that listings of a seller on the US or Canada merketplaces can pass in North America as a value in a <CrossBorderTrade> field to expose that item on the eBay US (ebay.com) and eBay Canada (ebay.ca) sites (English). For more information, see <a href="/api-docs/user-guides/static/trading-user-guide/cross-border-trading.html" target="_blank">Cross-border trading</a>. */
|
|
1202
|
+
crossBorderTradeNorthAmericaEnabled?: boolean;
|
|
1203
|
+
};
|
|
1204
|
+
/** @description This type is used to provide the sort order of compatibility properties returned in the response. */
|
|
1205
|
+
SortOrderInner: {
|
|
1206
|
+
/** @description This container is used to define the property to be used in the sorting. */
|
|
1207
|
+
sortOrder?: components['schemas']['SortOrderProperties'];
|
|
1208
|
+
/** @description The priority of the specified sort order provided.<br><br>For example, when a property is assigned <code>Sort1</code>, its values are sorted first. Values for the property assigned <code>Sort2</code> are sorted second, and so on.<br><br><b>Valid values</b>:<ul><li><code>Sort1</code></li><li><code>Sort2</code></li><li><code>Sort3</code></li><li><code>Sort4</code></li><li><code>Sort5</code></li></ul> */
|
|
1209
|
+
sortPriority?: string;
|
|
1210
|
+
};
|
|
1211
|
+
/** @description This type is used to define the property to be used in sorting. */
|
|
1212
|
+
SortOrderProperties: {
|
|
1213
|
+
/** @description Defines the order of the sort.<br><br><b>Valid values</b>:<ul><li><code>Ascending</code></li><li><code>Descending</code></li></ul> */
|
|
1214
|
+
order?: string;
|
|
1215
|
+
/** @description The name of the searchable property to be used for sorting.<br><br>For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. */
|
|
1216
|
+
propertyName?: string;
|
|
1217
|
+
};
|
|
1218
|
+
/** @description This type provides the properties and specifications to use to search for compatibilities. */
|
|
1219
|
+
SpecificationRequest: {
|
|
1220
|
+
/** @description The unique identifier of the eBay leaf category for which compatibility details are being retrieved. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcycles.<br><br>Use the <a href="/api-docs/sell/metadata/resources/marketplace/methods/getAutomotivePartsCompatibilityPolicies" target="_blank ">getAutomotivePartsCompatibilityPolicies</a> method to retrieve a list of categories that support parts compatibility by specification. For the categories in the response that support compatibility by specification, you’ll see <code>SPECIFICATIONS</code> as the value for the <b>compatibilityBasedOn</b> field */
|
|
1221
|
+
categoryId?: string;
|
|
1222
|
+
/** @description This comma-delimited array can be used to restrict the number of compatible application name-value pairs returned in the response by specifying the properties that the seller wishes to be included in the response.<br><br>Only compatible applications with the specified properties will be returned. Properties that can be specified here include make, model, year, and trim. */
|
|
1223
|
+
compatibilityPropertyFilters?: components['schemas']['PropertyFilterInner'][];
|
|
1224
|
+
/** @description This field can be used to define the type of properties that will be returned in the response.<br><br> For example, if you specify <code>Searchable</code>, the compatibility details will contain properties that can be used to search for products, such as make or model.<br><br><span class="tablenote"><b>Note:</b> This field cannot be used alongside <b>dataPropertyName</b>. If both are used, an error will occur.</span><br><b>Valid values:</b><ul><li><code>DisplayableProductDetails</code>: Properties for use in a user interface to describe products.</li><li><code>DisplayableSearchResults</code>: Properties for use in results for product searches.</li><li><code>Searchable</code>: Properties for use in searches.</li><li><code>Sortable</code>: Properties that are suitable for sorting.</li></ul><b>Default value:</b> <code>DisplayableSearchResults</code> */
|
|
1225
|
+
dataset?: string;
|
|
1226
|
+
/** @description This comma-delimited array can be used to define the specific property name(s) that will be returned in the response.<br><br>For example, if you specify <code>Engine</code>, the result set will only contain engines that are compatible with the input criteria.<br><br><span class="tablenote"><b>Note:</b> This array cannot be used alongside <b>dataset</b>. If both are used, an error will occur.</span> */
|
|
1227
|
+
datasetPropertyName?: string[];
|
|
1228
|
+
/** @description This boolean can be used to specify that the compatibilities returned in the response are to be defined by an exact match on the input value of specification properties.<br><br>By default, an expanded compatibility match is done when it applies, such as for Load Index, where a compatible vehicle is one that has a load index requirement that is less than or equal to the input. By specifying this field as <code>true</code>, only exact matches are returned. */
|
|
1229
|
+
exactMatch?: boolean;
|
|
1230
|
+
/** @description <div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="<b><span style="color: #dd1e31;" class="mcFormatColor">Important! </span></b>"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> Pagination is not yet supported by this method. If this container is included in the request, it will be ignored.</p></div> */
|
|
1231
|
+
paginationInput?: components['schemas']['PaginationInput'];
|
|
1232
|
+
/** @description This array specifies the sorting order of the compatibility properties. Any of the searchable properties can be used to specify search order. Up to 5 levels of sort order may be specified.<br><br><span class="tablenote"><b>Note:</b> If no sort order is specified through this field, the default sort order of <b>popularity descending</b> is applied.</span> */
|
|
1233
|
+
sortOrders?: components['schemas']['SortOrderInner'][];
|
|
1234
|
+
/** @description This array defines the specifications of the part, in the form of name-value pairs, for which compatible applications will be retrieved. */
|
|
1235
|
+
specifications?: components['schemas']['PropertyFilterInner'][];
|
|
1236
|
+
};
|
|
1237
|
+
/** @description This type defines the fields used in the <b>getCompatibilitiesBySpecification</b> response. */
|
|
1238
|
+
SpecificationResponse: {
|
|
1239
|
+
/** @description This container returns the list of all compatible application name-value pairs for the given filter criteria. */
|
|
1240
|
+
compatibilityDetails?: components['schemas']['Compatibility'][];
|
|
1241
|
+
/** @description <div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="<b><span style="color: #dd1e31;" class="mcFormatColor">Important! </span></b>"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> Not currently returned. For future use. </p></div> <!-- This container returns the pagination settings for the result set.--> */
|
|
1242
|
+
pagination?: components['schemas']['Pagination'];
|
|
1243
|
+
};
|
|
1244
|
+
/** @description A complex type that specifies a period of time using a specified time-measurement unit. */
|
|
1245
|
+
TimeDuration: {
|
|
1246
|
+
/** @description A time-measurement unit that specifies a singular period of time. <br><br>A span of time is defined when you apply the value specified in the <b>value</b> field to the value specified for <b>unit</b>. <br><br>Time-measurement units can be YEAR, MONTH, DAY, and so on. See <b>TimeDurationUnitEnum</b> for a complete list of possible time-measurement units. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/ba:TimeDurationUnitEnum'>eBay API documentation</a> */
|
|
1247
|
+
unit?: string;
|
|
1248
|
+
/**
|
|
1249
|
+
* Format: int32
|
|
1250
|
+
* @description An integer that represents an amount of time, as measured by the time-measurement unit specified in the <b>unit</b> field.
|
|
1251
|
+
*/
|
|
1252
|
+
value?: number;
|
|
1253
|
+
};
|
|
1254
|
+
};
|
|
1255
|
+
responses: never;
|
|
1256
|
+
parameters: never;
|
|
1257
|
+
requestBodies: never;
|
|
1258
|
+
headers: never;
|
|
1259
|
+
pathItems: never;
|
|
1260
|
+
}
|
|
1261
|
+
export type $defs = Record<string, never>;
|
|
1262
|
+
export interface operations {
|
|
1263
|
+
getAutomotivePartsCompatibilityPolicies: {
|
|
1264
|
+
parameters: {
|
|
1265
|
+
query?: {
|
|
1266
|
+
/** @description This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply <b>categoryId</b> values for the sections of the tree you want returned. Use the <a href="/api-docs/commerce/taxonomy/overview.html" target="_blank ">Taxonomy API</a> to retrieve category ID values.<br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. <br><br><b>Example:</b> <code>filter=categoryIds:{183521|183523|183524}</code> <br><br><span class="tablenote"><b>Note: </b>URL-encoding of the parameter list is no longer required.</span> */
|
|
1267
|
+
filter?: string;
|
|
1268
|
+
};
|
|
1269
|
+
header?: {
|
|
1270
|
+
/** @description This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to <code>gzip</code>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
|
|
1271
|
+
'Accept-Encoding'?: string;
|
|
1272
|
+
};
|
|
1273
|
+
path: {
|
|
1274
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved. <br><br><span class="tablenote"><b>Note: </b>Only the following eBay marketplaces support automotive parts compatibility: <ul> <li>EBAY_MOTORS_US</li> <li>EBAY_AU</li> <li>EBAY_CA</li> <li>EBAY_DE</li> <li>EBAY_ES</li> <li>EBAY_FR</li> <li>EBAY_GB</li> <li>EBAY_IT</li></ul></span> */
|
|
1275
|
+
marketplace_id: string;
|
|
1276
|
+
};
|
|
1277
|
+
cookie?: never;
|
|
1278
|
+
};
|
|
1279
|
+
requestBody?: never;
|
|
1280
|
+
responses: {
|
|
1281
|
+
/** @description Success */
|
|
1282
|
+
200: {
|
|
1283
|
+
headers: Record<string, unknown>;
|
|
1284
|
+
content: {
|
|
1285
|
+
'application/json': components['schemas']['AutomotivePartsCompatibilityPolicyResponse'];
|
|
1286
|
+
};
|
|
1287
|
+
};
|
|
1288
|
+
/** @description No content */
|
|
1289
|
+
204: {
|
|
1290
|
+
headers: Record<string, unknown>;
|
|
1291
|
+
content?: never;
|
|
1292
|
+
};
|
|
1293
|
+
/** @description Bad Request */
|
|
1294
|
+
400: {
|
|
1295
|
+
headers: Record<string, unknown>;
|
|
1296
|
+
content?: never;
|
|
1297
|
+
};
|
|
1298
|
+
/** @description Not found */
|
|
1299
|
+
404: {
|
|
1300
|
+
headers: Record<string, unknown>;
|
|
1301
|
+
content?: never;
|
|
1302
|
+
};
|
|
1303
|
+
/** @description Internal Server Error */
|
|
1304
|
+
500: {
|
|
1305
|
+
headers: Record<string, unknown>;
|
|
1306
|
+
content?: never;
|
|
1307
|
+
};
|
|
1308
|
+
};
|
|
1309
|
+
};
|
|
1310
|
+
getCategoryPolicies: {
|
|
1311
|
+
parameters: {
|
|
1312
|
+
query?: {
|
|
1313
|
+
/** @description This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the <b>categoryId</b> for one or more leaf categories. You can verify if a category is a leaf category by using the <a href="/api-docs/commerce/taxonomy/overview.html" target="_blank ">Taxonomy API</a> and looking for a <code>"leafCategory": true</code> tag. <br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.<br><br><b>Example:</b> <code>filter=categoryIds:{3767|171784}</code> */
|
|
1314
|
+
filter?: string;
|
|
1315
|
+
};
|
|
1316
|
+
header?: {
|
|
1317
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1318
|
+
'Accept-Language'?: string;
|
|
1319
|
+
};
|
|
1320
|
+
path: {
|
|
1321
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1322
|
+
marketplace_id: string;
|
|
1323
|
+
};
|
|
1324
|
+
cookie?: never;
|
|
1325
|
+
};
|
|
1326
|
+
requestBody?: never;
|
|
1327
|
+
responses: {
|
|
1328
|
+
/** @description Success */
|
|
1329
|
+
200: {
|
|
1330
|
+
headers: Record<string, unknown>;
|
|
1331
|
+
content: {
|
|
1332
|
+
'application/json': components['schemas']['CategoryPolicyResponse'];
|
|
1333
|
+
};
|
|
1334
|
+
};
|
|
1335
|
+
/** @description No content */
|
|
1336
|
+
204: {
|
|
1337
|
+
headers: Record<string, unknown>;
|
|
1338
|
+
content?: never;
|
|
1339
|
+
};
|
|
1340
|
+
/** @description Bad Request */
|
|
1341
|
+
400: {
|
|
1342
|
+
headers: Record<string, unknown>;
|
|
1343
|
+
content?: never;
|
|
1344
|
+
};
|
|
1345
|
+
/** @description Not found */
|
|
1346
|
+
404: {
|
|
1347
|
+
headers: Record<string, unknown>;
|
|
1348
|
+
content?: never;
|
|
1349
|
+
};
|
|
1350
|
+
/** @description Internal Server Error */
|
|
1351
|
+
500: {
|
|
1352
|
+
headers: Record<string, unknown>;
|
|
1353
|
+
content?: never;
|
|
1354
|
+
};
|
|
1355
|
+
};
|
|
1356
|
+
};
|
|
1357
|
+
getClassifiedAdPolicies: {
|
|
1358
|
+
parameters: {
|
|
1359
|
+
query?: {
|
|
1360
|
+
/** @description This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the <b>categoryId</b> for one or more leaf categories. You can verify if a category is a leaf category by using the <a href="/api-docs/commerce/taxonomy/overview.html" target="_blank ">Taxonomy API</a> and looking for a <code>"leafCategory": true</code> tag. <br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.<br><br><b>Example:</b><code>filter=categoryIds:{3767|171784}</code> */
|
|
1361
|
+
filter?: string;
|
|
1362
|
+
};
|
|
1363
|
+
header?: {
|
|
1364
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1365
|
+
'Accept-Language'?: string;
|
|
1366
|
+
};
|
|
1367
|
+
path: {
|
|
1368
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved.<br><br>See <a href="/api-docs/sell/metadata/types/bas:MarketplaceIdEnum" target="_blank">MarketplaceIdEnum</a> for a list of supported eBay marketplace ID values. */
|
|
1369
|
+
marketplace_id: string;
|
|
1370
|
+
};
|
|
1371
|
+
cookie?: never;
|
|
1372
|
+
};
|
|
1373
|
+
requestBody?: never;
|
|
1374
|
+
responses: {
|
|
1375
|
+
/** @description Success */
|
|
1376
|
+
200: {
|
|
1377
|
+
headers: Record<string, unknown>;
|
|
1378
|
+
content: {
|
|
1379
|
+
'application/json': components['schemas']['ClassifiedAdPolicyResponse'];
|
|
1380
|
+
};
|
|
1381
|
+
};
|
|
1382
|
+
/** @description No content */
|
|
1383
|
+
204: {
|
|
1384
|
+
headers: Record<string, unknown>;
|
|
1385
|
+
content?: never;
|
|
1386
|
+
};
|
|
1387
|
+
/** @description Bad Request */
|
|
1388
|
+
400: {
|
|
1389
|
+
headers: Record<string, unknown>;
|
|
1390
|
+
content?: never;
|
|
1391
|
+
};
|
|
1392
|
+
/** @description Not found */
|
|
1393
|
+
404: {
|
|
1394
|
+
headers: Record<string, unknown>;
|
|
1395
|
+
content?: never;
|
|
1396
|
+
};
|
|
1397
|
+
/** @description Internal Server Error */
|
|
1398
|
+
500: {
|
|
1399
|
+
headers: Record<string, unknown>;
|
|
1400
|
+
content?: never;
|
|
1401
|
+
};
|
|
1402
|
+
};
|
|
1403
|
+
};
|
|
1404
|
+
getCurrencies: {
|
|
1405
|
+
parameters: {
|
|
1406
|
+
query?: never;
|
|
1407
|
+
header?: {
|
|
1408
|
+
/** @description This header is required to retrieve metadata for the French Canada and French Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.<br><br><span class="tablenote"><b>Note:</b> If <code>EBAY_BE</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the Dutch Belgium marketplace.</span></li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code> and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span></ul> */
|
|
1409
|
+
'Accept-Language'?: string;
|
|
1410
|
+
};
|
|
1411
|
+
path: {
|
|
1412
|
+
/** @description This path parameter specifies the eBay marketplace for which currency information is retrieved.<br><br>See the <a href="/api-docs/sell/metadata/types/bas:MarketplaceIdEnum" target="_blank">MarketplaceIdEnum</a> type for a list of supported eBay marketplace ID values. */
|
|
1413
|
+
marketplace_id: string;
|
|
1414
|
+
};
|
|
1415
|
+
cookie?: never;
|
|
1416
|
+
};
|
|
1417
|
+
requestBody?: never;
|
|
1418
|
+
responses: {
|
|
1419
|
+
/** @description Success */
|
|
1420
|
+
200: {
|
|
1421
|
+
headers: Record<string, unknown>;
|
|
1422
|
+
content: {
|
|
1423
|
+
'application/json': components['schemas']['GetCurrenciesResponse'];
|
|
1424
|
+
};
|
|
1425
|
+
};
|
|
1426
|
+
/** @description No Content */
|
|
1427
|
+
204: {
|
|
1428
|
+
headers: Record<string, unknown>;
|
|
1429
|
+
content?: never;
|
|
1430
|
+
};
|
|
1431
|
+
/** @description Bad Request */
|
|
1432
|
+
400: {
|
|
1433
|
+
headers: Record<string, unknown>;
|
|
1434
|
+
content?: never;
|
|
1435
|
+
};
|
|
1436
|
+
/** @description Not Found */
|
|
1437
|
+
404: {
|
|
1438
|
+
headers: Record<string, unknown>;
|
|
1439
|
+
content?: never;
|
|
1440
|
+
};
|
|
1441
|
+
/** @description Internal Server Error */
|
|
1442
|
+
500: {
|
|
1443
|
+
headers: Record<string, unknown>;
|
|
1444
|
+
content?: never;
|
|
1445
|
+
};
|
|
1446
|
+
};
|
|
1447
|
+
};
|
|
1448
|
+
getExtendedProducerResponsibilityPolicies: {
|
|
1449
|
+
parameters: {
|
|
1450
|
+
query?: {
|
|
1451
|
+
/** @description A query parameter that can be used to limit the response by returning policy information for only the selected sections of the category tree. Supply <b>categoryId</b> values for the sections of the tree that should be returned.<br><br>When a <b>categoryId</b> value is specified, the returned category tree includes the policies for that parent node, as well as the policies for any child nodes below that parent node.<br><br>Pass in the <b>categoryId</b> values using a URL-encoded, pipe-separated ('|') list. For example:<br><br><code>filter=categoryIds%3A%7B100%7C101%7C102%7D</code><br><br><b>Maximum:</b> 50 */
|
|
1452
|
+
filter?: string;
|
|
1453
|
+
};
|
|
1454
|
+
header?: {
|
|
1455
|
+
/** @description This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to <code>gzip</code>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
|
|
1456
|
+
'Accept-Encoding'?: string;
|
|
1457
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1458
|
+
'Accept-Language'?: string;
|
|
1459
|
+
};
|
|
1460
|
+
path: {
|
|
1461
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information shall be retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1462
|
+
marketplace_id: string;
|
|
1463
|
+
};
|
|
1464
|
+
cookie?: never;
|
|
1465
|
+
};
|
|
1466
|
+
requestBody?: never;
|
|
1467
|
+
responses: {
|
|
1468
|
+
/** @description Success */
|
|
1469
|
+
200: {
|
|
1470
|
+
headers: Record<string, unknown>;
|
|
1471
|
+
content: {
|
|
1472
|
+
'application/json': components['schemas']['ExtendedProducerResponsibilityPolicyResponse'];
|
|
1473
|
+
};
|
|
1474
|
+
};
|
|
1475
|
+
/** @description No content */
|
|
1476
|
+
204: {
|
|
1477
|
+
headers: Record<string, unknown>;
|
|
1478
|
+
content?: never;
|
|
1479
|
+
};
|
|
1480
|
+
/** @description Bad Request */
|
|
1481
|
+
400: {
|
|
1482
|
+
headers: Record<string, unknown>;
|
|
1483
|
+
content?: never;
|
|
1484
|
+
};
|
|
1485
|
+
/** @description Not found */
|
|
1486
|
+
404: {
|
|
1487
|
+
headers: Record<string, unknown>;
|
|
1488
|
+
content?: never;
|
|
1489
|
+
};
|
|
1490
|
+
/** @description Internal Server Error */
|
|
1491
|
+
500: {
|
|
1492
|
+
headers: Record<string, unknown>;
|
|
1493
|
+
content?: never;
|
|
1494
|
+
};
|
|
1495
|
+
};
|
|
1496
|
+
};
|
|
1497
|
+
getHazardousMaterialsLabels: {
|
|
1498
|
+
parameters: {
|
|
1499
|
+
query?: never;
|
|
1500
|
+
header?: {
|
|
1501
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1502
|
+
'Accept-Language'?: string;
|
|
1503
|
+
};
|
|
1504
|
+
path: {
|
|
1505
|
+
/** @description This path parameter specifies the eBay marketplace for which hazardous materials label information shall be retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1506
|
+
marketplace_id: string;
|
|
1507
|
+
};
|
|
1508
|
+
cookie?: never;
|
|
1509
|
+
};
|
|
1510
|
+
requestBody?: never;
|
|
1511
|
+
responses: {
|
|
1512
|
+
/** @description Success */
|
|
1513
|
+
200: {
|
|
1514
|
+
headers: Record<string, unknown>;
|
|
1515
|
+
content: {
|
|
1516
|
+
'application/json': components['schemas']['HazardousMaterialDetailsResponse'];
|
|
1517
|
+
};
|
|
1518
|
+
};
|
|
1519
|
+
/** @description No content */
|
|
1520
|
+
204: {
|
|
1521
|
+
headers: Record<string, unknown>;
|
|
1522
|
+
content?: never;
|
|
1523
|
+
};
|
|
1524
|
+
/** @description Bad Request */
|
|
1525
|
+
400: {
|
|
1526
|
+
headers: Record<string, unknown>;
|
|
1527
|
+
content?: never;
|
|
1528
|
+
};
|
|
1529
|
+
/** @description Not found */
|
|
1530
|
+
404: {
|
|
1531
|
+
headers: Record<string, unknown>;
|
|
1532
|
+
content?: never;
|
|
1533
|
+
};
|
|
1534
|
+
/** @description Internal Server Error */
|
|
1535
|
+
500: {
|
|
1536
|
+
headers: Record<string, unknown>;
|
|
1537
|
+
content?: never;
|
|
1538
|
+
};
|
|
1539
|
+
};
|
|
1540
|
+
};
|
|
1541
|
+
getItemConditionPolicies: {
|
|
1542
|
+
parameters: {
|
|
1543
|
+
query?: {
|
|
1544
|
+
/** @description This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply <b>categoryId</b> values for the sections of the tree you want returned. <br><br>When you specify a <b>categoryId</b> value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node. <br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. <br><br><b>Example:</b> <code>filter=categoryIds:{100|101|102}</code> <br><br>Note that you must URL-encode the parameter list, which results in the following filter for the above example: <br><br> <code>filter=categoryIds%3A%7B100%7C101%7C102%7D</code> */
|
|
1545
|
+
filter?: string;
|
|
1546
|
+
};
|
|
1547
|
+
header?: {
|
|
1548
|
+
/** @description This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to <code>gzip</code>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
|
|
1549
|
+
'Accept-Encoding'?: string;
|
|
1550
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1551
|
+
'Accept-Language'?: string;
|
|
1552
|
+
};
|
|
1553
|
+
path: {
|
|
1554
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1555
|
+
marketplace_id: string;
|
|
1556
|
+
};
|
|
1557
|
+
cookie?: never;
|
|
1558
|
+
};
|
|
1559
|
+
requestBody?: never;
|
|
1560
|
+
responses: {
|
|
1561
|
+
/** @description Success */
|
|
1562
|
+
200: {
|
|
1563
|
+
headers: Record<string, unknown>;
|
|
1564
|
+
content: {
|
|
1565
|
+
'application/json': components['schemas']['ItemConditionPolicyResponse'];
|
|
1566
|
+
};
|
|
1567
|
+
};
|
|
1568
|
+
/** @description No content */
|
|
1569
|
+
204: {
|
|
1570
|
+
headers: Record<string, unknown>;
|
|
1571
|
+
content?: never;
|
|
1572
|
+
};
|
|
1573
|
+
/** @description Bad Request */
|
|
1574
|
+
400: {
|
|
1575
|
+
headers: Record<string, unknown>;
|
|
1576
|
+
content?: never;
|
|
1577
|
+
};
|
|
1578
|
+
/** @description Not found */
|
|
1579
|
+
404: {
|
|
1580
|
+
headers: Record<string, unknown>;
|
|
1581
|
+
content?: never;
|
|
1582
|
+
};
|
|
1583
|
+
/** @description Internal Server Error */
|
|
1584
|
+
500: {
|
|
1585
|
+
headers: Record<string, unknown>;
|
|
1586
|
+
content?: never;
|
|
1587
|
+
};
|
|
1588
|
+
};
|
|
1589
|
+
};
|
|
1590
|
+
getListingStructurePolicies: {
|
|
1591
|
+
parameters: {
|
|
1592
|
+
query?: {
|
|
1593
|
+
/** @description This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply <b>categoryId</b> values for the sections of the tree you want returned. <br><br>When you specify a <b>categoryId</b> value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node. <br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. <br><br><b>Example:</b> <code>filter=categoryIds:{100|101|102}</code> <br><br>Note that you must URL-encode the parameter list, which results in the following filter for the above example: <br><br> <code>filter=categoryIds%3A%7B100%7C101%7C102%7D</code> */
|
|
1594
|
+
filter?: string;
|
|
1595
|
+
};
|
|
1596
|
+
header?: {
|
|
1597
|
+
/** @description This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to <code>gzip</code>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
|
|
1598
|
+
'Accept-Encoding'?: string;
|
|
1599
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1600
|
+
'Accept-Language'?: string;
|
|
1601
|
+
};
|
|
1602
|
+
path: {
|
|
1603
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved. <br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1604
|
+
marketplace_id: string;
|
|
1605
|
+
};
|
|
1606
|
+
cookie?: never;
|
|
1607
|
+
};
|
|
1608
|
+
requestBody?: never;
|
|
1609
|
+
responses: {
|
|
1610
|
+
/** @description Success */
|
|
1611
|
+
200: {
|
|
1612
|
+
headers: Record<string, unknown>;
|
|
1613
|
+
content: {
|
|
1614
|
+
'application/json': components['schemas']['ListingStructurePolicyResponse'];
|
|
1615
|
+
};
|
|
1616
|
+
};
|
|
1617
|
+
/** @description No content */
|
|
1618
|
+
204: {
|
|
1619
|
+
headers: Record<string, unknown>;
|
|
1620
|
+
content?: never;
|
|
1621
|
+
};
|
|
1622
|
+
/** @description Bad Request */
|
|
1623
|
+
400: {
|
|
1624
|
+
headers: Record<string, unknown>;
|
|
1625
|
+
content?: never;
|
|
1626
|
+
};
|
|
1627
|
+
/** @description Not found */
|
|
1628
|
+
404: {
|
|
1629
|
+
headers: Record<string, unknown>;
|
|
1630
|
+
content?: never;
|
|
1631
|
+
};
|
|
1632
|
+
/** @description Internal Server Error */
|
|
1633
|
+
500: {
|
|
1634
|
+
headers: Record<string, unknown>;
|
|
1635
|
+
content?: never;
|
|
1636
|
+
};
|
|
1637
|
+
};
|
|
1638
|
+
};
|
|
1639
|
+
getListingTypePolicies: {
|
|
1640
|
+
parameters: {
|
|
1641
|
+
query?: {
|
|
1642
|
+
/** @description This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the <b>categoryId</b> for one or more leaf categories. You can verify if a category is a leaf category by using the <a href="/api-docs/commerce/taxonomy/overview.html" target="_blank ">Taxonomy API</a> and looking for a <code>"leafCategory": true</code> tag.<br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.<br><br><b>Example:</b> <code>filter=categoryIds:{3767|171784}</code> */
|
|
1643
|
+
filter?: string;
|
|
1644
|
+
};
|
|
1645
|
+
header?: {
|
|
1646
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1647
|
+
'Accept-Language'?: string;
|
|
1648
|
+
};
|
|
1649
|
+
path: {
|
|
1650
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1651
|
+
marketplace_id: string;
|
|
1652
|
+
};
|
|
1653
|
+
cookie?: never;
|
|
1654
|
+
};
|
|
1655
|
+
requestBody?: never;
|
|
1656
|
+
responses: {
|
|
1657
|
+
/** @description Success */
|
|
1658
|
+
200: {
|
|
1659
|
+
headers: Record<string, unknown>;
|
|
1660
|
+
content: {
|
|
1661
|
+
'application/json': components['schemas']['ListingTypePoliciesResponse'];
|
|
1662
|
+
};
|
|
1663
|
+
};
|
|
1664
|
+
/** @description No content */
|
|
1665
|
+
204: {
|
|
1666
|
+
headers: Record<string, unknown>;
|
|
1667
|
+
content?: never;
|
|
1668
|
+
};
|
|
1669
|
+
/** @description Bad Request */
|
|
1670
|
+
400: {
|
|
1671
|
+
headers: Record<string, unknown>;
|
|
1672
|
+
content?: never;
|
|
1673
|
+
};
|
|
1674
|
+
/** @description Not found */
|
|
1675
|
+
404: {
|
|
1676
|
+
headers: Record<string, unknown>;
|
|
1677
|
+
content?: never;
|
|
1678
|
+
};
|
|
1679
|
+
/** @description Internal Server Error */
|
|
1680
|
+
500: {
|
|
1681
|
+
headers: Record<string, unknown>;
|
|
1682
|
+
content?: never;
|
|
1683
|
+
};
|
|
1684
|
+
};
|
|
1685
|
+
};
|
|
1686
|
+
getMotorsListingPolicies: {
|
|
1687
|
+
parameters: {
|
|
1688
|
+
query?: {
|
|
1689
|
+
/** @description This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the <b>categoryId</b> for one or more leaf categories. You can verify if a category is a leaf category by using the <a href="/api-docs/commerce/taxonomy/overview.html" target="_blank ">Taxonomy API</a> and looking for a <code>"leafCategory": true</code> tag. <br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.<br><br><b>Example:</b> <code>filter=categoryIds:{3767|171784}</code> */
|
|
1690
|
+
filter?: string;
|
|
1691
|
+
};
|
|
1692
|
+
header?: {
|
|
1693
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1694
|
+
'Accept-Language'?: string;
|
|
1695
|
+
};
|
|
1696
|
+
path: {
|
|
1697
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1698
|
+
marketplace_id: string;
|
|
1699
|
+
};
|
|
1700
|
+
cookie?: never;
|
|
1701
|
+
};
|
|
1702
|
+
requestBody?: never;
|
|
1703
|
+
responses: {
|
|
1704
|
+
/** @description Success */
|
|
1705
|
+
200: {
|
|
1706
|
+
headers: Record<string, unknown>;
|
|
1707
|
+
content: {
|
|
1708
|
+
'application/json': components['schemas']['MotorsListingPoliciesResponse'];
|
|
1709
|
+
};
|
|
1710
|
+
};
|
|
1711
|
+
/** @description No content */
|
|
1712
|
+
204: {
|
|
1713
|
+
headers: Record<string, unknown>;
|
|
1714
|
+
content?: never;
|
|
1715
|
+
};
|
|
1716
|
+
/** @description Bad Request */
|
|
1717
|
+
400: {
|
|
1718
|
+
headers: Record<string, unknown>;
|
|
1719
|
+
content?: never;
|
|
1720
|
+
};
|
|
1721
|
+
/** @description Not found */
|
|
1722
|
+
404: {
|
|
1723
|
+
headers: Record<string, unknown>;
|
|
1724
|
+
content?: never;
|
|
1725
|
+
};
|
|
1726
|
+
/** @description Internal Server Error */
|
|
1727
|
+
500: {
|
|
1728
|
+
headers: Record<string, unknown>;
|
|
1729
|
+
content?: never;
|
|
1730
|
+
};
|
|
1731
|
+
};
|
|
1732
|
+
};
|
|
1733
|
+
getNegotiatedPricePolicies: {
|
|
1734
|
+
parameters: {
|
|
1735
|
+
query?: {
|
|
1736
|
+
/** @description This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply <b>categoryId</b> values for the sections of the tree you want returned. <br><br>When you specify a <b>categoryId</b> value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node. <br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. <br><br><b>Example:</b> <code>filter=categoryIds:{100|101|102}</code> <br><br>Note that you must URL-encode the parameter list, which results in the following filter for the above example: <br><br> <code>filter=categoryIds%3A%7B100%7C101%7C102%7D</code> */
|
|
1737
|
+
filter?: string;
|
|
1738
|
+
};
|
|
1739
|
+
header?: {
|
|
1740
|
+
/** @description This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to <code>gzip</code>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
|
|
1741
|
+
'Accept-Encoding'?: string;
|
|
1742
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1743
|
+
'Accept-Language'?: string;
|
|
1744
|
+
};
|
|
1745
|
+
path: {
|
|
1746
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1747
|
+
marketplace_id: string;
|
|
1748
|
+
};
|
|
1749
|
+
cookie?: never;
|
|
1750
|
+
};
|
|
1751
|
+
requestBody?: never;
|
|
1752
|
+
responses: {
|
|
1753
|
+
/** @description Success */
|
|
1754
|
+
200: {
|
|
1755
|
+
headers: Record<string, unknown>;
|
|
1756
|
+
content: {
|
|
1757
|
+
'application/json': components['schemas']['NegotiatedPricePolicyResponse'];
|
|
1758
|
+
};
|
|
1759
|
+
};
|
|
1760
|
+
/** @description No content */
|
|
1761
|
+
204: {
|
|
1762
|
+
headers: Record<string, unknown>;
|
|
1763
|
+
content?: never;
|
|
1764
|
+
};
|
|
1765
|
+
/** @description Bad Request */
|
|
1766
|
+
400: {
|
|
1767
|
+
headers: Record<string, unknown>;
|
|
1768
|
+
content?: never;
|
|
1769
|
+
};
|
|
1770
|
+
/** @description Not found */
|
|
1771
|
+
404: {
|
|
1772
|
+
headers: Record<string, unknown>;
|
|
1773
|
+
content?: never;
|
|
1774
|
+
};
|
|
1775
|
+
/** @description Internal Server Error */
|
|
1776
|
+
500: {
|
|
1777
|
+
headers: Record<string, unknown>;
|
|
1778
|
+
content?: never;
|
|
1779
|
+
};
|
|
1780
|
+
};
|
|
1781
|
+
};
|
|
1782
|
+
getProductSafetyLabels: {
|
|
1783
|
+
parameters: {
|
|
1784
|
+
query?: never;
|
|
1785
|
+
header?: never;
|
|
1786
|
+
path: {
|
|
1787
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. See the following note for exceptions.<span class="tablenote"><span style="color:#478415"><strong>Note: </strong></span>This method is not supported in the <code>EBAY_HK</code>, <code>EBAY_MY</code>, <code>EBAY_TW</code>, or <code>EBAY_PH</code> marketplaces.</span> */
|
|
1788
|
+
marketplace_id: string;
|
|
1789
|
+
};
|
|
1790
|
+
cookie?: never;
|
|
1791
|
+
};
|
|
1792
|
+
requestBody?: never;
|
|
1793
|
+
responses: {
|
|
1794
|
+
/** @description Success */
|
|
1795
|
+
200: {
|
|
1796
|
+
headers: Record<string, unknown>;
|
|
1797
|
+
content: {
|
|
1798
|
+
'application/json': components['schemas']['ProductSafetyLabelsResponse'];
|
|
1799
|
+
};
|
|
1800
|
+
};
|
|
1801
|
+
/** @description No content */
|
|
1802
|
+
204: {
|
|
1803
|
+
headers: Record<string, unknown>;
|
|
1804
|
+
content?: never;
|
|
1805
|
+
};
|
|
1806
|
+
/** @description Bad Request */
|
|
1807
|
+
400: {
|
|
1808
|
+
headers: Record<string, unknown>;
|
|
1809
|
+
content?: never;
|
|
1810
|
+
};
|
|
1811
|
+
/** @description Not found */
|
|
1812
|
+
404: {
|
|
1813
|
+
headers: Record<string, unknown>;
|
|
1814
|
+
content?: never;
|
|
1815
|
+
};
|
|
1816
|
+
/** @description Internal Server Error */
|
|
1817
|
+
500: {
|
|
1818
|
+
headers: Record<string, unknown>;
|
|
1819
|
+
content?: never;
|
|
1820
|
+
};
|
|
1821
|
+
};
|
|
1822
|
+
};
|
|
1823
|
+
getRegulatoryPolicies: {
|
|
1824
|
+
parameters: {
|
|
1825
|
+
query?: {
|
|
1826
|
+
/** @description A query parameter that can be used to limit the response by returning policy information for only the selected sections of the category tree. Supply <b>categoryId</b> values for the sections of the tree that should be returned.<br><br>Pass in the <b>categoryId</b> values using a URL-encoded, pipe-separated ('|') list. For example: <br><br><code>filter=categoryIds%3A%7B100%7C101%7C102%7D</code><br><br><b>Maximum:</b> 50 */
|
|
1827
|
+
filter?: string;
|
|
1828
|
+
};
|
|
1829
|
+
header?: {
|
|
1830
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1831
|
+
'Accept-Language'?: string;
|
|
1832
|
+
};
|
|
1833
|
+
path: {
|
|
1834
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information shall be retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values.<span class="tablenote"><span style="color:#478415"><strong>Note: </strong></span>This method is not supported in the <code>EBAY_HK</code>, <code>EBAY_MY</code>, <code>EBAY_TW</code>, or <code>EBAY_PH</code> marketplaces.</span> */
|
|
1835
|
+
marketplace_id: string;
|
|
1836
|
+
};
|
|
1837
|
+
cookie?: never;
|
|
1838
|
+
};
|
|
1839
|
+
requestBody?: never;
|
|
1840
|
+
responses: {
|
|
1841
|
+
/** @description Success */
|
|
1842
|
+
200: {
|
|
1843
|
+
headers: Record<string, unknown>;
|
|
1844
|
+
content: {
|
|
1845
|
+
'application/json': components['schemas']['RegulatoryPolicyResponse'];
|
|
1846
|
+
};
|
|
1847
|
+
};
|
|
1848
|
+
/** @description No content */
|
|
1849
|
+
204: {
|
|
1850
|
+
headers: Record<string, unknown>;
|
|
1851
|
+
content?: never;
|
|
1852
|
+
};
|
|
1853
|
+
/** @description Bad Request */
|
|
1854
|
+
400: {
|
|
1855
|
+
headers: Record<string, unknown>;
|
|
1856
|
+
content?: never;
|
|
1857
|
+
};
|
|
1858
|
+
/** @description Not found */
|
|
1859
|
+
404: {
|
|
1860
|
+
headers: Record<string, unknown>;
|
|
1861
|
+
content?: never;
|
|
1862
|
+
};
|
|
1863
|
+
/** @description Internal Server Error */
|
|
1864
|
+
500: {
|
|
1865
|
+
headers: Record<string, unknown>;
|
|
1866
|
+
content?: never;
|
|
1867
|
+
};
|
|
1868
|
+
};
|
|
1869
|
+
};
|
|
1870
|
+
getReturnPolicies: {
|
|
1871
|
+
parameters: {
|
|
1872
|
+
query?: {
|
|
1873
|
+
/** @description This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply <b>categoryId</b> values for the sections of the tree you want returned. <br><br>When you specify a <b>categoryId</b> value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node. <br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. <br><br><b>Example:</b> <code>filter=categoryIds:{100|101|102}</code> <br><br>Note that you must URL-encode the parameter list, which results in the following filter for the above example: <br><br> <code>filter=categoryIds%3A%7B100%7C101%7C102%7D</code> */
|
|
1874
|
+
filter?: string;
|
|
1875
|
+
};
|
|
1876
|
+
header?: {
|
|
1877
|
+
/** @description This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to <code>gzip</code>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
|
|
1878
|
+
'Accept-Encoding'?: string;
|
|
1879
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1880
|
+
'Accept-Language'?: string;
|
|
1881
|
+
};
|
|
1882
|
+
path: {
|
|
1883
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1884
|
+
marketplace_id: string;
|
|
1885
|
+
};
|
|
1886
|
+
cookie?: never;
|
|
1887
|
+
};
|
|
1888
|
+
requestBody?: never;
|
|
1889
|
+
responses: {
|
|
1890
|
+
/** @description Success */
|
|
1891
|
+
200: {
|
|
1892
|
+
headers: Record<string, unknown>;
|
|
1893
|
+
content: {
|
|
1894
|
+
'application/json': components['schemas']['ReturnPolicyResponse'];
|
|
1895
|
+
};
|
|
1896
|
+
};
|
|
1897
|
+
/** @description No content */
|
|
1898
|
+
204: {
|
|
1899
|
+
headers: Record<string, unknown>;
|
|
1900
|
+
content?: never;
|
|
1901
|
+
};
|
|
1902
|
+
/** @description Bad Request */
|
|
1903
|
+
400: {
|
|
1904
|
+
headers: Record<string, unknown>;
|
|
1905
|
+
content?: never;
|
|
1906
|
+
};
|
|
1907
|
+
/** @description Not found */
|
|
1908
|
+
404: {
|
|
1909
|
+
headers: Record<string, unknown>;
|
|
1910
|
+
content?: never;
|
|
1911
|
+
};
|
|
1912
|
+
/** @description Internal Server Error */
|
|
1913
|
+
500: {
|
|
1914
|
+
headers: Record<string, unknown>;
|
|
1915
|
+
content?: never;
|
|
1916
|
+
};
|
|
1917
|
+
};
|
|
1918
|
+
};
|
|
1919
|
+
getShippingPolicies: {
|
|
1920
|
+
parameters: {
|
|
1921
|
+
query?: {
|
|
1922
|
+
/** @description This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the <b>categoryId</b> for one or more leaf categories. You can verify if a category is a leaf category by using the <a href="/api-docs/commerce/taxonomy/overview.html" target="_blank ">Taxonomy API</a> and looking for a <code>"leafCategory": true</code> tag. <br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.<br><br><b>Example:</b> <code>filter=categoryIds:{3767|171784}</code> */
|
|
1923
|
+
filter?: string;
|
|
1924
|
+
};
|
|
1925
|
+
header?: {
|
|
1926
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1927
|
+
'Accept-Language'?: string;
|
|
1928
|
+
};
|
|
1929
|
+
path: {
|
|
1930
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1931
|
+
marketplace_id: string;
|
|
1932
|
+
};
|
|
1933
|
+
cookie?: never;
|
|
1934
|
+
};
|
|
1935
|
+
requestBody?: never;
|
|
1936
|
+
responses: {
|
|
1937
|
+
/** @description Success */
|
|
1938
|
+
200: {
|
|
1939
|
+
headers: Record<string, unknown>;
|
|
1940
|
+
content: {
|
|
1941
|
+
'application/json': components['schemas']['ShippingPoliciesResponse'];
|
|
1942
|
+
};
|
|
1943
|
+
};
|
|
1944
|
+
/** @description No content */
|
|
1945
|
+
204: {
|
|
1946
|
+
headers: Record<string, unknown>;
|
|
1947
|
+
content?: never;
|
|
1948
|
+
};
|
|
1949
|
+
/** @description Bad Request */
|
|
1950
|
+
400: {
|
|
1951
|
+
headers: Record<string, unknown>;
|
|
1952
|
+
content?: never;
|
|
1953
|
+
};
|
|
1954
|
+
/** @description Not found */
|
|
1955
|
+
404: {
|
|
1956
|
+
headers: Record<string, unknown>;
|
|
1957
|
+
content?: never;
|
|
1958
|
+
};
|
|
1959
|
+
/** @description Internal Server Error */
|
|
1960
|
+
500: {
|
|
1961
|
+
headers: Record<string, unknown>;
|
|
1962
|
+
content?: never;
|
|
1963
|
+
};
|
|
1964
|
+
};
|
|
1965
|
+
};
|
|
1966
|
+
getSiteVisibilityPolicies: {
|
|
1967
|
+
parameters: {
|
|
1968
|
+
query?: {
|
|
1969
|
+
/** @description This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the <b>categoryId</b> for one or more leaf categories. You can verify if a category is a leaf category by using the <a href="/api-docs/commerce/taxonomy/overview.html" target="_blank ">Taxonomy API</a> and looking for a <code>"leafCategory": true</code> tag. <br><br>The parameter takes a list of <b>categoryId</b> values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 <code>categoryId</code> values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.<br><br><b>Example:</b><code>filter=categoryIds:{3767|171784}</code> */
|
|
1970
|
+
filter?: string;
|
|
1971
|
+
};
|
|
1972
|
+
header?: {
|
|
1973
|
+
/** @description This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.<br><br>Follow the instructions below to retrieve metadata for these three marketplaces:<ul><li><b>French Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li><li><b>Dutch Belgium</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_BE</code>, and include the <b>Accept-Language</b> header with a value of <code>nl-BE</code>.</li><li><b>French Canada</b>: Set the <b>marketplace_id</b> path parameter value to <code>EBAY_CA</code>, and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li></ul><span class="tablenote"><b>Note:</b> If <code>EBAY_CA</code> is set as the <b>marketplace_id</b> path parameter and the <b>Accept-Language</b> header is not used, the marketplace will default to the English Canada marketplace.</span> */
|
|
1974
|
+
'Accept-Language'?: string;
|
|
1975
|
+
};
|
|
1976
|
+
path: {
|
|
1977
|
+
/** @description This path parameter specifies the eBay marketplace for which policy information is retrieved.<br><br>See <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">HTTP Request Headers</a> for a list of supported eBay marketplace ID values. */
|
|
1978
|
+
marketplace_id: string;
|
|
1979
|
+
};
|
|
1980
|
+
cookie?: never;
|
|
1981
|
+
};
|
|
1982
|
+
requestBody?: never;
|
|
1983
|
+
responses: {
|
|
1984
|
+
/** @description Success */
|
|
1985
|
+
200: {
|
|
1986
|
+
headers: Record<string, unknown>;
|
|
1987
|
+
content: {
|
|
1988
|
+
'application/json': components['schemas']['SiteVisibilityPoliciesResponse'];
|
|
1989
|
+
};
|
|
1990
|
+
};
|
|
1991
|
+
/** @description No content */
|
|
1992
|
+
204: {
|
|
1993
|
+
headers: Record<string, unknown>;
|
|
1994
|
+
content?: never;
|
|
1995
|
+
};
|
|
1996
|
+
/** @description Bad Request */
|
|
1997
|
+
400: {
|
|
1998
|
+
headers: Record<string, unknown>;
|
|
1999
|
+
content?: never;
|
|
2000
|
+
};
|
|
2001
|
+
/** @description Not found */
|
|
2002
|
+
404: {
|
|
2003
|
+
headers: Record<string, unknown>;
|
|
2004
|
+
content?: never;
|
|
2005
|
+
};
|
|
2006
|
+
/** @description Internal Server Error */
|
|
2007
|
+
500: {
|
|
2008
|
+
headers: Record<string, unknown>;
|
|
2009
|
+
content?: never;
|
|
2010
|
+
};
|
|
2011
|
+
};
|
|
2012
|
+
};
|
|
2013
|
+
getCompatibilitiesBySpecification: {
|
|
2014
|
+
parameters: {
|
|
2015
|
+
query?: never;
|
|
2016
|
+
header: {
|
|
2017
|
+
/** @description This header identifies the seller's eBay marketplace.<br><br>See <a href="/api-docs/sell/metadata/overview.html#requirements" target="_blank ">Metadata API requirements and restrictions</a> for supported values. */
|
|
2018
|
+
'X-EBAY-C-MARKETPLACE-ID': string;
|
|
2019
|
+
/** @description This header indicates the format of the request body provided by the client.<br><br>Its value should be set to <code>application/json</code>.<br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a> in the <a href="/api-docs/static/ebay-rest-landing.html" target="_blank">Using eBay RESTful APIs</a> guide. */
|
|
2020
|
+
'Content-Type': string;
|
|
2021
|
+
};
|
|
2022
|
+
path?: never;
|
|
2023
|
+
cookie?: never;
|
|
2024
|
+
};
|
|
2025
|
+
/** @description This type defines the properties and specifications to use to search for compatibilities. */
|
|
2026
|
+
requestBody?: {
|
|
2027
|
+
content: {
|
|
2028
|
+
'application/json': components['schemas']['SpecificationRequest'];
|
|
2029
|
+
};
|
|
2030
|
+
};
|
|
2031
|
+
responses: {
|
|
2032
|
+
/** @description Success */
|
|
2033
|
+
200: {
|
|
2034
|
+
headers: Record<string, unknown>;
|
|
2035
|
+
content: {
|
|
2036
|
+
'application/json': components['schemas']['SpecificationResponse'];
|
|
2037
|
+
};
|
|
2038
|
+
};
|
|
2039
|
+
/** @description No Content */
|
|
2040
|
+
204: {
|
|
2041
|
+
headers: Record<string, unknown>;
|
|
2042
|
+
content?: never;
|
|
2043
|
+
};
|
|
2044
|
+
/** @description Bad Request */
|
|
2045
|
+
400: {
|
|
2046
|
+
headers: Record<string, unknown>;
|
|
2047
|
+
content?: never;
|
|
2048
|
+
};
|
|
2049
|
+
/** @description Unauthorized */
|
|
2050
|
+
401: {
|
|
2051
|
+
headers: Record<string, unknown>;
|
|
2052
|
+
content?: never;
|
|
2053
|
+
};
|
|
2054
|
+
/** @description Internal Server Error */
|
|
2055
|
+
500: {
|
|
2056
|
+
headers: Record<string, unknown>;
|
|
2057
|
+
content?: never;
|
|
2058
|
+
};
|
|
2059
|
+
};
|
|
2060
|
+
};
|
|
2061
|
+
getCompatibilityPropertyNames: {
|
|
2062
|
+
parameters: {
|
|
2063
|
+
query?: never;
|
|
2064
|
+
header: {
|
|
2065
|
+
/** @description This header identifies the seller's eBay marketplace.<br><br>See <a href="/api-docs/sell/metadata/overview.html#requirements" target="_blank ">Metadata API requirements and restrictions</a> for supported values. */
|
|
2066
|
+
'X-EBAY-C-MARKETPLACE-ID': string;
|
|
2067
|
+
/** @description This header indicates the format of the request body provided by the client.<br><br>Its value should be set to <code>application/json</code>.<br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a> in the <a href="/api-docs/static/ebay-rest-landing.html" target="_blank">Using eBay RESTful APIs</a> guide. */
|
|
2068
|
+
'Content-Type': string;
|
|
2069
|
+
};
|
|
2070
|
+
path?: never;
|
|
2071
|
+
cookie?: never;
|
|
2072
|
+
};
|
|
2073
|
+
/** @description This type defines the properties used to retrieve compatibility property names. */
|
|
2074
|
+
requestBody?: {
|
|
2075
|
+
content: {
|
|
2076
|
+
'application/json': components['schemas']['PropertyNamesRequest'];
|
|
2077
|
+
};
|
|
2078
|
+
};
|
|
2079
|
+
responses: {
|
|
2080
|
+
/** @description Success */
|
|
2081
|
+
200: {
|
|
2082
|
+
headers: Record<string, unknown>;
|
|
2083
|
+
content: {
|
|
2084
|
+
'application/json': components['schemas']['PropertyNamesResponse'];
|
|
2085
|
+
};
|
|
2086
|
+
};
|
|
2087
|
+
/** @description No Content */
|
|
2088
|
+
204: {
|
|
2089
|
+
headers: Record<string, unknown>;
|
|
2090
|
+
content?: never;
|
|
2091
|
+
};
|
|
2092
|
+
/** @description Bad Request */
|
|
2093
|
+
400: {
|
|
2094
|
+
headers: Record<string, unknown>;
|
|
2095
|
+
content?: never;
|
|
2096
|
+
};
|
|
2097
|
+
/** @description Unauthorized */
|
|
2098
|
+
401: {
|
|
2099
|
+
headers: Record<string, unknown>;
|
|
2100
|
+
content?: never;
|
|
2101
|
+
};
|
|
2102
|
+
/** @description Internal Server Error */
|
|
2103
|
+
500: {
|
|
2104
|
+
headers: Record<string, unknown>;
|
|
2105
|
+
content?: never;
|
|
2106
|
+
};
|
|
2107
|
+
};
|
|
2108
|
+
};
|
|
2109
|
+
getCompatibilityPropertyValues: {
|
|
2110
|
+
parameters: {
|
|
2111
|
+
query?: never;
|
|
2112
|
+
header: {
|
|
2113
|
+
/** @description This header identifies the seller's eBay marketplace.<br><br>See <a href="/api-docs/sell/metadata/overview.html#requirements" target="_blank ">Metadata API requirements and restrictions</a> for supported values. */
|
|
2114
|
+
'X-EBAY-C-MARKETPLACE-ID': string;
|
|
2115
|
+
/** @description This header indicates the format of the request body provided by the client.<br><br>Its value should be set to <code>application/json</code>.<br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a> in the <a href="/api-docs/static/ebay-rest-landing.html" target="_blank">Using eBay RESTful APIs</a> guide. */
|
|
2116
|
+
'Content-Type': string;
|
|
2117
|
+
};
|
|
2118
|
+
path?: never;
|
|
2119
|
+
cookie?: never;
|
|
2120
|
+
};
|
|
2121
|
+
/** @description This type defines the category ID and property name for which to retrieve values. */
|
|
2122
|
+
requestBody?: {
|
|
2123
|
+
content: {
|
|
2124
|
+
'application/json': components['schemas']['PropertyValuesRequest'];
|
|
2125
|
+
};
|
|
2126
|
+
};
|
|
2127
|
+
responses: {
|
|
2128
|
+
/** @description Success */
|
|
2129
|
+
200: {
|
|
2130
|
+
headers: Record<string, unknown>;
|
|
2131
|
+
content: {
|
|
2132
|
+
'application/json': components['schemas']['PropertyValuesResponse'];
|
|
2133
|
+
};
|
|
2134
|
+
};
|
|
2135
|
+
/** @description No Content */
|
|
2136
|
+
204: {
|
|
2137
|
+
headers: Record<string, unknown>;
|
|
2138
|
+
content?: never;
|
|
2139
|
+
};
|
|
2140
|
+
/** @description Bad Request */
|
|
2141
|
+
400: {
|
|
2142
|
+
headers: Record<string, unknown>;
|
|
2143
|
+
content?: never;
|
|
2144
|
+
};
|
|
2145
|
+
/** @description Unauthorized */
|
|
2146
|
+
401: {
|
|
2147
|
+
headers: Record<string, unknown>;
|
|
2148
|
+
content?: never;
|
|
2149
|
+
};
|
|
2150
|
+
/** @description Internal Server Error */
|
|
2151
|
+
500: {
|
|
2152
|
+
headers: Record<string, unknown>;
|
|
2153
|
+
content?: never;
|
|
2154
|
+
};
|
|
2155
|
+
};
|
|
2156
|
+
};
|
|
2157
|
+
getMultiCompatibilityPropertyValues: {
|
|
2158
|
+
parameters: {
|
|
2159
|
+
query?: never;
|
|
2160
|
+
header: {
|
|
2161
|
+
/** @description This header identifies the seller's eBay marketplace.<br><br>See <a href="/api-docs/sell/metadata/overview.html#requirements" target="_blank ">Metadata API requirements and restrictions</a> for supported values. */
|
|
2162
|
+
'X-EBAY-C-MARKETPLACE-ID': string;
|
|
2163
|
+
/** @description This header indicates the format of the request body provided by the client.<br><br>Its value should be set to <code>application/json</code>.<br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a> in the <a href="/api-docs/static/ebay-rest-landing.html" target="_blank">Using eBay RESTful APIs</a> guide. */
|
|
2164
|
+
'Content-Type': string;
|
|
2165
|
+
};
|
|
2166
|
+
path?: never;
|
|
2167
|
+
cookie?: never;
|
|
2168
|
+
};
|
|
2169
|
+
/** @description This type defines the category ID and property names for which to retrieve values. */
|
|
2170
|
+
requestBody?: {
|
|
2171
|
+
content: {
|
|
2172
|
+
'application/json': components['schemas']['MultiCompatibilityPropertyValuesRequest'];
|
|
2173
|
+
};
|
|
2174
|
+
};
|
|
2175
|
+
responses: {
|
|
2176
|
+
/** @description Success */
|
|
2177
|
+
200: {
|
|
2178
|
+
headers: Record<string, unknown>;
|
|
2179
|
+
content: {
|
|
2180
|
+
'application/json': components['schemas']['MultiCompatibilityPropertyValuesResponse'];
|
|
2181
|
+
};
|
|
2182
|
+
};
|
|
2183
|
+
/** @description No Content */
|
|
2184
|
+
204: {
|
|
2185
|
+
headers: Record<string, unknown>;
|
|
2186
|
+
content?: never;
|
|
2187
|
+
};
|
|
2188
|
+
/** @description Bad Request */
|
|
2189
|
+
400: {
|
|
2190
|
+
headers: Record<string, unknown>;
|
|
2191
|
+
content?: never;
|
|
2192
|
+
};
|
|
2193
|
+
/** @description Unauthorized */
|
|
2194
|
+
401: {
|
|
2195
|
+
headers: Record<string, unknown>;
|
|
2196
|
+
content?: never;
|
|
2197
|
+
};
|
|
2198
|
+
/** @description Internal Server Error */
|
|
2199
|
+
500: {
|
|
2200
|
+
headers: Record<string, unknown>;
|
|
2201
|
+
content?: never;
|
|
2202
|
+
};
|
|
2203
|
+
};
|
|
2204
|
+
};
|
|
2205
|
+
getProductCompatibilities: {
|
|
2206
|
+
parameters: {
|
|
2207
|
+
query?: never;
|
|
2208
|
+
header: {
|
|
2209
|
+
/** @description This header identifies the seller's eBay marketplace.<br><br>See <a href="/api-docs/sell/metadata/overview.html#requirements" target="_blank ">Metadata API requirements and restrictions</a> for supported values. */
|
|
2210
|
+
'X-EBAY-C-MARKETPLACE-ID': string;
|
|
2211
|
+
/** @description This header indicates the format of the request body provided by the client.<br><br>Its value should be set to <code>application/json</code>.<br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a> in the <a href="/api-docs/static/ebay-rest-landing.html" target="_blank">Using eBay RESTful APIs</a> guide. */
|
|
2212
|
+
'Content-Type': string;
|
|
2213
|
+
};
|
|
2214
|
+
path?: never;
|
|
2215
|
+
cookie?: never;
|
|
2216
|
+
};
|
|
2217
|
+
/** @description This type defines properties for which to find compatibilities. */
|
|
2218
|
+
requestBody?: {
|
|
2219
|
+
content: {
|
|
2220
|
+
'application/json': components['schemas']['ProductRequest'];
|
|
2221
|
+
};
|
|
2222
|
+
};
|
|
2223
|
+
responses: {
|
|
2224
|
+
/** @description Success */
|
|
2225
|
+
200: {
|
|
2226
|
+
headers: Record<string, unknown>;
|
|
2227
|
+
content: {
|
|
2228
|
+
'application/json': components['schemas']['ProductResponse'];
|
|
2229
|
+
};
|
|
2230
|
+
};
|
|
2231
|
+
/** @description No Content */
|
|
2232
|
+
204: {
|
|
2233
|
+
headers: Record<string, unknown>;
|
|
2234
|
+
content?: never;
|
|
2235
|
+
};
|
|
2236
|
+
/** @description Bad Request */
|
|
2237
|
+
400: {
|
|
2238
|
+
headers: Record<string, unknown>;
|
|
2239
|
+
content?: never;
|
|
2240
|
+
};
|
|
2241
|
+
/** @description Unauthorized */
|
|
2242
|
+
401: {
|
|
2243
|
+
headers: Record<string, unknown>;
|
|
2244
|
+
content?: never;
|
|
2245
|
+
};
|
|
2246
|
+
/** @description Internal Server Error */
|
|
2247
|
+
500: {
|
|
2248
|
+
headers: Record<string, unknown>;
|
|
2249
|
+
content?: never;
|
|
2250
|
+
};
|
|
2251
|
+
};
|
|
2252
|
+
};
|
|
2253
|
+
getSalesTaxJurisdictions: {
|
|
2254
|
+
parameters: {
|
|
2255
|
+
query?: never;
|
|
2256
|
+
header?: never;
|
|
2257
|
+
path: {
|
|
2258
|
+
/** @description This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> country code for the country whose jurisdictions you want to retrieve.<br><br><span class="tablenote"><b>Note:</b> Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span> */
|
|
2259
|
+
countryCode: string;
|
|
2260
|
+
};
|
|
2261
|
+
cookie?: never;
|
|
2262
|
+
};
|
|
2263
|
+
requestBody?: never;
|
|
2264
|
+
responses: {
|
|
2265
|
+
/** @description Success */
|
|
2266
|
+
200: {
|
|
2267
|
+
headers: Record<string, unknown>;
|
|
2268
|
+
content: {
|
|
2269
|
+
'application/json': components['schemas']['SalesTaxJurisdictions'];
|
|
2270
|
+
};
|
|
2271
|
+
};
|
|
2272
|
+
/** @description Bad Request */
|
|
2273
|
+
400: {
|
|
2274
|
+
headers: Record<string, unknown>;
|
|
2275
|
+
content?: never;
|
|
2276
|
+
};
|
|
2277
|
+
/** @description Not Found */
|
|
2278
|
+
404: {
|
|
2279
|
+
headers: Record<string, unknown>;
|
|
2280
|
+
content?: never;
|
|
2281
|
+
};
|
|
2282
|
+
/** @description Internal Server Error */
|
|
2283
|
+
500: {
|
|
2284
|
+
headers: Record<string, unknown>;
|
|
2285
|
+
content?: never;
|
|
2286
|
+
};
|
|
2287
|
+
};
|
|
2288
|
+
};
|
|
2289
|
+
}
|