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.
Files changed (205) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +586 -0
  3. package/build/api/account-management/account.d.ts +216 -0
  4. package/build/api/account-management/account.js +305 -0
  5. package/build/api/analytics-and-report/analytics.d.ts +33 -0
  6. package/build/api/analytics-and-report/analytics.js +102 -0
  7. package/build/api/client.d.ts +89 -0
  8. package/build/api/client.js +343 -0
  9. package/build/api/communication/feedback.d.ts +45 -0
  10. package/build/api/communication/feedback.js +119 -0
  11. package/build/api/communication/message.d.ts +55 -0
  12. package/build/api/communication/message.js +131 -0
  13. package/build/api/communication/negotiation.d.ts +39 -0
  14. package/build/api/communication/negotiation.js +97 -0
  15. package/build/api/communication/notification.d.ts +128 -0
  16. package/build/api/communication/notification.js +373 -0
  17. package/build/api/index.d.ts +96 -0
  18. package/build/api/index.js +121 -0
  19. package/build/api/listing-management/inventory.d.ts +216 -0
  20. package/build/api/listing-management/inventory.js +633 -0
  21. package/build/api/listing-metadata/metadata.d.ts +154 -0
  22. package/build/api/listing-metadata/metadata.js +485 -0
  23. package/build/api/listing-metadata/taxonomy.d.ts +38 -0
  24. package/build/api/listing-metadata/taxonomy.js +58 -0
  25. package/build/api/marketing-and-promotions/marketing.d.ts +395 -0
  26. package/build/api/marketing-and-promotions/marketing.js +565 -0
  27. package/build/api/marketing-and-promotions/recommendation.d.ts +20 -0
  28. package/build/api/marketing-and-promotions/recommendation.js +32 -0
  29. package/build/api/order-management/dispute.d.ts +65 -0
  30. package/build/api/order-management/dispute.js +69 -0
  31. package/build/api/order-management/fulfillment.d.ts +80 -0
  32. package/build/api/order-management/fulfillment.js +89 -0
  33. package/build/api/other/compliance.d.ts +26 -0
  34. package/build/api/other/compliance.js +47 -0
  35. package/build/api/other/edelivery.d.ts +153 -0
  36. package/build/api/other/edelivery.js +219 -0
  37. package/build/api/other/identity.d.ts +17 -0
  38. package/build/api/other/identity.js +24 -0
  39. package/build/api/other/translation.d.ts +14 -0
  40. package/build/api/other/translation.js +22 -0
  41. package/build/api/other/vero.d.ts +30 -0
  42. package/build/api/other/vero.js +48 -0
  43. package/build/auth/oauth-metadata.d.ts +46 -0
  44. package/build/auth/oauth-metadata.js +59 -0
  45. package/build/auth/oauth-middleware.d.ts +35 -0
  46. package/build/auth/oauth-middleware.js +99 -0
  47. package/build/auth/oauth-types.d.ts +66 -0
  48. package/build/auth/oauth-types.js +4 -0
  49. package/build/auth/oauth.d.ts +93 -0
  50. package/build/auth/oauth.js +383 -0
  51. package/build/auth/scope-utils.d.ts +70 -0
  52. package/build/auth/scope-utils.js +304 -0
  53. package/build/auth/token-verifier.d.ts +57 -0
  54. package/build/auth/token-verifier.js +172 -0
  55. package/build/config/environment.d.ts +61 -0
  56. package/build/config/environment.js +260 -0
  57. package/build/index.d.ts +1 -0
  58. package/build/index.js +98 -0
  59. package/build/schemas/account-management/account.d.ts +5324 -0
  60. package/build/schemas/account-management/account.js +366 -0
  61. package/build/schemas/analytics/analytics.d.ts +167 -0
  62. package/build/schemas/analytics/analytics.js +191 -0
  63. package/build/schemas/communication/messages.d.ts +1872 -0
  64. package/build/schemas/communication/messages.js +348 -0
  65. package/build/schemas/fulfillment/orders.d.ts +4655 -0
  66. package/build/schemas/fulfillment/orders.js +317 -0
  67. package/build/schemas/index.d.ts +2100 -0
  68. package/build/schemas/index.js +68 -0
  69. package/build/schemas/inventory-management/inventory.d.ts +6419 -0
  70. package/build/schemas/inventory-management/inventory.js +450 -0
  71. package/build/schemas/marketing/marketing.d.ts +14181 -0
  72. package/build/schemas/marketing/marketing.js +1088 -0
  73. package/build/schemas/metadata/metadata.d.ts +5259 -0
  74. package/build/schemas/metadata/metadata.js +614 -0
  75. package/build/schemas/other/other-apis.d.ts +257 -0
  76. package/build/schemas/other/other-apis.js +372 -0
  77. package/build/schemas/taxonomy/taxonomy.d.ts +215 -0
  78. package/build/schemas/taxonomy/taxonomy.js +571 -0
  79. package/build/scripts/auto-setup.d.ts +12 -0
  80. package/build/scripts/auto-setup.js +277 -0
  81. package/build/scripts/diagnostics.d.ts +8 -0
  82. package/build/scripts/diagnostics.js +299 -0
  83. package/build/scripts/download-specs.d.ts +1 -0
  84. package/build/scripts/download-specs.js +116 -0
  85. package/build/scripts/interactive-setup.d.ts +21 -0
  86. package/build/scripts/interactive-setup.js +723 -0
  87. package/build/server-http.d.ts +11 -0
  88. package/build/server-http.js +361 -0
  89. package/build/tools/definitions/account-with-schemas.d.ts +39 -0
  90. package/build/tools/definitions/account-with-schemas.js +170 -0
  91. package/build/tools/definitions/account.d.ts +12 -0
  92. package/build/tools/definitions/account.js +428 -0
  93. package/build/tools/definitions/analytics.d.ts +25 -0
  94. package/build/tools/definitions/analytics.js +66 -0
  95. package/build/tools/definitions/communication.d.ts +12 -0
  96. package/build/tools/definitions/communication.js +151 -0
  97. package/build/tools/definitions/fulfillment.d.ts +12 -0
  98. package/build/tools/definitions/fulfillment.js +326 -0
  99. package/build/tools/definitions/index.d.ts +25 -0
  100. package/build/tools/definitions/index.js +37 -0
  101. package/build/tools/definitions/inventory.d.ts +12 -0
  102. package/build/tools/definitions/inventory.js +429 -0
  103. package/build/tools/definitions/marketing.d.ts +12 -0
  104. package/build/tools/definitions/marketing.js +1095 -0
  105. package/build/tools/definitions/metadata.d.ts +12 -0
  106. package/build/tools/definitions/metadata.js +188 -0
  107. package/build/tools/definitions/other.d.ts +13 -0
  108. package/build/tools/definitions/other.js +309 -0
  109. package/build/tools/definitions/taxonomy.d.ts +25 -0
  110. package/build/tools/definitions/taxonomy.js +64 -0
  111. package/build/tools/definitions/token-management.d.ts +35 -0
  112. package/build/tools/definitions/token-management.js +103 -0
  113. package/build/tools/index.d.ts +11 -0
  114. package/build/tools/index.js +1003 -0
  115. package/build/tools/schemas.d.ts +14764 -0
  116. package/build/tools/schemas.js +667 -0
  117. package/build/tools/tool-definitions.d.ts +35 -0
  118. package/build/tools/tool-definitions.js +3534 -0
  119. package/build/types/application-settings/developerAnalyticsV1BetaOas3.d.ts +197 -0
  120. package/build/types/application-settings/developerAnalyticsV1BetaOas3.js +5 -0
  121. package/build/types/application-settings/developerClientRegistrationV1Oas3.d.ts +155 -0
  122. package/build/types/application-settings/developerClientRegistrationV1Oas3.js +5 -0
  123. package/build/types/application-settings/developerKeyManagementV1Oas3.d.ts +246 -0
  124. package/build/types/application-settings/developerKeyManagementV1Oas3.js +5 -0
  125. package/build/types/ebay-enums.d.ts +1204 -0
  126. package/build/types/ebay-enums.js +1330 -0
  127. package/build/types/ebay.d.ts +143 -0
  128. package/build/types/ebay.js +123 -0
  129. package/build/types/index.d.ts +6 -0
  130. package/build/types/index.js +10 -0
  131. package/build/types/sell-apps/account-management/sellAccountV1Oas3.d.ts +2579 -0
  132. package/build/types/sell-apps/account-management/sellAccountV1Oas3.js +5 -0
  133. package/build/types/sell-apps/analytics-and-report/sellAnalyticsV1Oas3.d.ts +446 -0
  134. package/build/types/sell-apps/analytics-and-report/sellAnalyticsV1Oas3.js +5 -0
  135. package/build/types/sell-apps/communication/commerceFeedbackV1BetaOas3.d.ts +705 -0
  136. package/build/types/sell-apps/communication/commerceFeedbackV1BetaOas3.js +5 -0
  137. package/build/types/sell-apps/communication/commerceMessageV1Oas3.d.ts +590 -0
  138. package/build/types/sell-apps/communication/commerceMessageV1Oas3.js +5 -0
  139. package/build/types/sell-apps/communication/commerceNotificationV1Oas3.d.ts +1276 -0
  140. package/build/types/sell-apps/communication/commerceNotificationV1Oas3.js +5 -0
  141. package/build/types/sell-apps/communication/sellNegotiationV1Oas3.d.ts +277 -0
  142. package/build/types/sell-apps/communication/sellNegotiationV1Oas3.js +5 -0
  143. package/build/types/sell-apps/listing-management/sellInventoryV1Oas3.d.ts +3133 -0
  144. package/build/types/sell-apps/listing-management/sellInventoryV1Oas3.js +5 -0
  145. package/build/types/sell-apps/listing-metadata/sellMetadataV1Oas3.d.ts +2289 -0
  146. package/build/types/sell-apps/listing-metadata/sellMetadataV1Oas3.js +5 -0
  147. package/build/types/sell-apps/markeitng-and-promotions/sellMarketingV1Oas3.d.ts +6650 -0
  148. package/build/types/sell-apps/markeitng-and-promotions/sellMarketingV1Oas3.js +5 -0
  149. package/build/types/sell-apps/markeitng-and-promotions/sellRecommendationV1Oas3.d.ts +172 -0
  150. package/build/types/sell-apps/markeitng-and-promotions/sellRecommendationV1Oas3.js +5 -0
  151. package/build/types/sell-apps/order-management/sellFulfillmentV1Oas3.d.ts +1869 -0
  152. package/build/types/sell-apps/order-management/sellFulfillmentV1Oas3.js +5 -0
  153. package/build/types/sell-apps/other-apis/commerceIdentityV1Oas3.d.ts +178 -0
  154. package/build/types/sell-apps/other-apis/commerceIdentityV1Oas3.js +5 -0
  155. package/build/types/sell-apps/other-apis/commerceTranslationV1BetaOas3.d.ts +128 -0
  156. package/build/types/sell-apps/other-apis/commerceTranslationV1BetaOas3.js +5 -0
  157. package/build/types/sell-apps/other-apis/commerceVeroV1Oas3.d.ts +417 -0
  158. package/build/types/sell-apps/other-apis/commerceVeroV1Oas3.js +5 -0
  159. package/build/types/sell-apps/other-apis/sellComplianceV1Oas3.d.ts +273 -0
  160. package/build/types/sell-apps/other-apis/sellComplianceV1Oas3.js +5 -0
  161. package/build/types/sell-apps/other-apis/sellEdeliveryInternationalShippingOas3.d.ts +2537 -0
  162. package/build/types/sell-apps/other-apis/sellEdeliveryInternationalShippingOas3.js +5 -0
  163. package/build/types/sell-apps/other-apis/sellMarketingV1Oas3.d.ts +6650 -0
  164. package/build/types/sell-apps/other-apis/sellMarketingV1Oas3.js +5 -0
  165. package/build/types/sell-apps/other-apis/sellRecommendationV1Oas3.d.ts +172 -0
  166. package/build/types/sell-apps/other-apis/sellRecommendationV1Oas3.js +5 -0
  167. package/build/utils/account-management/account.d.ts +1094 -0
  168. package/build/utils/account-management/account.js +831 -0
  169. package/build/utils/communication/feedback.d.ts +152 -0
  170. package/build/utils/communication/feedback.js +216 -0
  171. package/build/utils/communication/message.d.ts +174 -0
  172. package/build/utils/communication/message.js +242 -0
  173. package/build/utils/communication/negotiation.d.ts +123 -0
  174. package/build/utils/communication/negotiation.js +150 -0
  175. package/build/utils/communication/notification.d.ts +370 -0
  176. package/build/utils/communication/notification.js +369 -0
  177. package/build/utils/date-converter.d.ts +59 -0
  178. package/build/utils/date-converter.js +160 -0
  179. package/build/utils/llm-client-detector.d.ts +54 -0
  180. package/build/utils/llm-client-detector.js +318 -0
  181. package/build/utils/oauth-helper.d.ts +37 -0
  182. package/build/utils/oauth-helper.js +315 -0
  183. package/build/utils/order-management/dispute.d.ts +346 -0
  184. package/build/utils/order-management/dispute.js +369 -0
  185. package/build/utils/order-management/fulfillment.d.ts +200 -0
  186. package/build/utils/order-management/fulfillment.js +205 -0
  187. package/build/utils/other/compliance.d.ts +49 -0
  188. package/build/utils/other/compliance.js +76 -0
  189. package/build/utils/other/edelivery.d.ts +310 -0
  190. package/build/utils/other/edelivery.js +241 -0
  191. package/build/utils/other/identity.d.ts +13 -0
  192. package/build/utils/other/identity.js +13 -0
  193. package/build/utils/other/translation.d.ts +28 -0
  194. package/build/utils/other/translation.js +41 -0
  195. package/build/utils/other/vero.d.ts +61 -0
  196. package/build/utils/other/vero.js +90 -0
  197. package/build/utils/scope-helper.d.ts +49 -0
  198. package/build/utils/scope-helper.js +207 -0
  199. package/build/utils/security-checker.d.ts +46 -0
  200. package/build/utils/security-checker.js +248 -0
  201. package/build/utils/setup-validator.d.ts +25 -0
  202. package/build/utils/setup-validator.js +305 -0
  203. package/build/utils/token-utils.d.ts +40 -0
  204. package/build/utils/token-utils.js +40 -0
  205. package/package.json +115 -0
@@ -0,0 +1,2579 @@
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
+ '/custom_policy/': {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ /** @description This method retrieves the list of custom policies defined for a seller's account. To limit the returned custom policies, specify the <b>policy_types</b> query parameter. */
14
+ get: operations['getCustomPolicies'];
15
+ put?: never;
16
+ /** @description This method creates a new custom policy that specifies the seller's terms for complying with local governmental regulations. Each Custom Policy targets a <b>policyType</b>. Multiple policies may be created as using the following custom policy types:<ul><li>PRODUCT_COMPLIANCE: Product Compliance policies disclose product information as required for regulatory compliance. <br/><br/><span class="tablenote"><strong>Note:</strong> A maximum of 60 Product Compliance policies per seller may be created.</span></li><li>TAKE_BACK: Takeback policies describe the seller's legal obligation to take back a previously purchased item when the buyer purchases a new one. <br/><br/><span class="tablenote"><strong>Note:</strong> A maximum of 18 Takeback policies per seller may be created.</span></li></ul>A successful create policy call returns an HTTP status code of <b>201 Created</b> with the system-generated policy ID included in the Location response header. */
17
+ post: operations['createCustomPolicy'];
18
+ delete?: never;
19
+ options?: never;
20
+ head?: never;
21
+ patch?: never;
22
+ trace?: never;
23
+ };
24
+ '/custom_policy/{custom_policy_id}': {
25
+ parameters: {
26
+ query?: never;
27
+ header?: never;
28
+ path?: never;
29
+ cookie?: never;
30
+ };
31
+ /** @description This method retrieves the custom policy specified by the <b>custom_policy_id</b> path parameter. */
32
+ get: operations['getCustomPolicy'];
33
+ /** @description This method updates an existing custom policy specified by the <b>custom_policy_id</b> path parameter. Since this method overwrites the policy's <b>name</b>, <b>label</b>, and <b>description</b> fields, always include the complete and current text of all three policy fields in the request payload, even if they are not being updated.<br/> <br/>For example, the value for the <b>label</b> field is to be updated, but the <b>name</b> and <b>description</b> values will remain unchanged. The existing <b>name</b> and <b>description</b> values, as they are defined in the current policy, must also be passed in. <br/><br/>A successful policy update call returns an HTTP status code of <b>204 No Content</b>. */
34
+ put: operations['updateCustomPolicy'];
35
+ post?: never;
36
+ delete?: never;
37
+ options?: never;
38
+ head?: never;
39
+ patch?: never;
40
+ trace?: never;
41
+ };
42
+ '/fulfillment_policy/': {
43
+ parameters: {
44
+ query?: never;
45
+ header?: never;
46
+ path?: never;
47
+ cookie?: never;
48
+ };
49
+ get?: never;
50
+ put?: never;
51
+ /** @description This method creates a new fulfillment policy for an eBay marketplace where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers. <br><br>A successful request returns the <b>getFulfillmentPolicy</b> URI to the new policy in the <b>Location</b> response header and the ID for the new policy is returned in the response payload. <p class="tablenote"><b>Tip:</b> For details on creating and using the business policies supported by the Account API, see <a href="/api-docs/sell/static/seller-accounts/business-policies.html">eBay business policies</a>.</p> */
52
+ post: operations['createFulfillmentPolicy'];
53
+ delete?: never;
54
+ options?: never;
55
+ head?: never;
56
+ patch?: never;
57
+ trace?: never;
58
+ };
59
+ '/fulfillment_policy/{fulfillmentPolicyId}': {
60
+ parameters: {
61
+ query?: never;
62
+ header?: never;
63
+ path?: never;
64
+ cookie?: never;
65
+ };
66
+ /** @description This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the <b>fulfillmentPolicyId</b> path parameter. */
67
+ get: operations['getFulfillmentPolicy'];
68
+ /** @description This method updates an existing fulfillment policy. Specify the policy you want to update using the <b>fulfillment_policy_id</b> path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload. */
69
+ put: operations['updateFulfillmentPolicy'];
70
+ post?: never;
71
+ /** @description This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the <b>fulfillmentPolicyId</b> path parameter. */
72
+ delete: operations['deleteFulfillmentPolicy'];
73
+ options?: never;
74
+ head?: never;
75
+ patch?: never;
76
+ trace?: never;
77
+ };
78
+ '/fulfillment_policy': {
79
+ parameters: {
80
+ query?: never;
81
+ header?: never;
82
+ path?: never;
83
+ cookie?: never;
84
+ };
85
+ /** @description This method retrieves all the fulfillment policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter. */
86
+ get: operations['getFulfillmentPolicies'];
87
+ put?: never;
88
+ post?: never;
89
+ delete?: never;
90
+ options?: never;
91
+ head?: never;
92
+ patch?: never;
93
+ trace?: never;
94
+ };
95
+ '/fulfillment_policy/get_by_policy_name': {
96
+ parameters: {
97
+ query?: never;
98
+ header?: never;
99
+ path?: never;
100
+ cookie?: never;
101
+ };
102
+ /** @description This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy <code>name</code> and its associated <code>marketplace_id</code> as query parameters. */
103
+ get: operations['getFulfillmentPolicyByName'];
104
+ put?: never;
105
+ post?: never;
106
+ delete?: never;
107
+ options?: never;
108
+ head?: never;
109
+ patch?: never;
110
+ trace?: never;
111
+ };
112
+ '/payment_policy': {
113
+ parameters: {
114
+ query?: never;
115
+ header?: never;
116
+ path?: never;
117
+ cookie?: never;
118
+ };
119
+ /** @description This method retrieves all the payment business policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter. */
120
+ get: operations['getPaymentPolicies'];
121
+ put?: never;
122
+ /** @description This method creates a new payment policy where the policy encapsulates seller's terms for order payments. <br><br>A successful request returns the <b>getPaymentPolicy</b> URI to the new policy in the <b>Location</b> response header and the ID for the new policy is returned in the response payload. <p class="tablenote"><b>Tip:</b> For details on creating and using the business policies supported by the Account API, see <a href="/api-docs/sell/static/seller-accounts/business-policies.html">eBay business policies</a>.</p> */
123
+ post: operations['createPaymentPolicy'];
124
+ delete?: never;
125
+ options?: never;
126
+ head?: never;
127
+ patch?: never;
128
+ trace?: never;
129
+ };
130
+ '/payment_policy/{payment_policy_id}': {
131
+ parameters: {
132
+ query?: never;
133
+ header?: never;
134
+ path?: never;
135
+ cookie?: never;
136
+ };
137
+ /** @description This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the <b>paymentPolicyId</b> path parameter. */
138
+ get: operations['getPaymentPolicy'];
139
+ /** @description This method updates an existing payment policy. Specify the policy you want to update using the <b>payment_policy_id</b> path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload. */
140
+ put: operations['updatePaymentPolicy'];
141
+ post?: never;
142
+ /** @description This method deletes a payment policy. Supply the ID of the policy you want to delete in the <b>paymentPolicyId</b> path parameter. */
143
+ delete: operations['deletePaymentPolicy'];
144
+ options?: never;
145
+ head?: never;
146
+ patch?: never;
147
+ trace?: never;
148
+ };
149
+ '/payment_policy/get_by_policy_name': {
150
+ parameters: {
151
+ query?: never;
152
+ header?: never;
153
+ path?: never;
154
+ cookie?: never;
155
+ };
156
+ /** @description This method retrieves the details of a specific payment policy. Supply both the policy <code>name</code> and its associated <code>marketplace_id</code> in the request query parameters. */
157
+ get: operations['getPaymentPolicyByName'];
158
+ put?: never;
159
+ post?: never;
160
+ delete?: never;
161
+ options?: never;
162
+ head?: never;
163
+ patch?: never;
164
+ trace?: never;
165
+ };
166
+ '/payments_program/{marketplace_id}/{payments_program_type}': {
167
+ parameters: {
168
+ query?: never;
169
+ header?: never;
170
+ path?: never;
171
+ cookie?: never;
172
+ };
173
+ /** @description <span class="tablenote"><b>Note:</b> This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.</span><br>This method returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the <b>marketplace_id</b> path parameter to specify the marketplace of the status flag you want returned. */
174
+ get: operations['getPaymentsProgram'];
175
+ put?: never;
176
+ post?: never;
177
+ delete?: never;
178
+ options?: never;
179
+ head?: never;
180
+ patch?: never;
181
+ trace?: never;
182
+ };
183
+ '/payments_program/{marketplace_id}/{payments_program_type}/onboarding': {
184
+ parameters: {
185
+ query?: never;
186
+ header?: never;
187
+ path?: never;
188
+ cookie?: never;
189
+ };
190
+ /** @description <span class="tablenote"><b>Note:</b> This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.</span><br>This method retrieves a seller's onboarding status for a payments program for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned. */
191
+ get: operations['getPaymentsProgramOnboarding'];
192
+ put?: never;
193
+ post?: never;
194
+ delete?: never;
195
+ options?: never;
196
+ head?: never;
197
+ patch?: never;
198
+ trace?: never;
199
+ };
200
+ '/privilege': {
201
+ parameters: {
202
+ query?: never;
203
+ header?: never;
204
+ path?: never;
205
+ cookie?: never;
206
+ };
207
+ /** @description This method retrieves the seller's current set of privileges, including whether or not the seller's eBay registration has been completed, as well as the details of their site-wide <b>sellingLimit</b> (the amount and quantity they can sell on a given day). */
208
+ get: operations['getPrivileges'];
209
+ put?: never;
210
+ post?: never;
211
+ delete?: never;
212
+ options?: never;
213
+ head?: never;
214
+ patch?: never;
215
+ trace?: never;
216
+ };
217
+ '/program/get_opted_in_programs': {
218
+ parameters: {
219
+ query?: never;
220
+ header?: never;
221
+ path?: never;
222
+ cookie?: never;
223
+ };
224
+ /** @description This method gets a list of the seller programs that the seller has opted-in to. */
225
+ get: operations['getOptedInPrograms'];
226
+ put?: never;
227
+ post?: never;
228
+ delete?: never;
229
+ options?: never;
230
+ head?: never;
231
+ patch?: never;
232
+ trace?: never;
233
+ };
234
+ '/program/opt_in': {
235
+ parameters: {
236
+ query?: never;
237
+ header?: never;
238
+ path?: never;
239
+ cookie?: never;
240
+ };
241
+ get?: never;
242
+ put?: never;
243
+ /** @description This method opts the seller in to an eBay seller program. Refer to the <a href="/api-docs/sell/account/overview.html#opt-in" target="_blank">Account API overview</a> for information about available eBay seller programs.<br><br><span class="tablenote"><b>Note:</b> It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the <a href="/api-docs/sell/account/resources/program/methods/getOptedInPrograms" target="_blank">getOptedInPrograms</a> call to check the status of your request after the processing period has passed.</span> */
244
+ post: operations['optInToProgram'];
245
+ delete?: never;
246
+ options?: never;
247
+ head?: never;
248
+ patch?: never;
249
+ trace?: never;
250
+ };
251
+ '/program/opt_out': {
252
+ parameters: {
253
+ query?: never;
254
+ header?: never;
255
+ path?: never;
256
+ cookie?: never;
257
+ };
258
+ get?: never;
259
+ put?: never;
260
+ /** @description This method opts the seller out of a seller program in which they are currently opted in to. A seller can retrieve a list of the seller programs they are opted-in to using the <b>getOptedInPrograms</b> method. */
261
+ post: operations['optOutOfProgram'];
262
+ delete?: never;
263
+ options?: never;
264
+ head?: never;
265
+ patch?: never;
266
+ trace?: never;
267
+ };
268
+ '/rate_table': {
269
+ parameters: {
270
+ query?: never;
271
+ header?: never;
272
+ path?: never;
273
+ cookie?: never;
274
+ };
275
+ /** @description This method retrieves a seller's <i>shipping rate tables</i> for the country specified in the <b>country_code</b> query parameter. If you call this method without specifying a country code, the call returns all of the seller's shipping rate tables. <br><br>The method's response includes a <b>rateTableId</b> for each table defined by the seller. This <b>rateTableId</b> value is used in add/revise item call or in create/update fulfillment business policy call to specify the shipping rate table to use for that policy's domestic or international shipping options. <br><br>This call currently supports getting rate tables related to the following marketplaces: United States, Canada, United Kingdom, Germany, Australia, France, Italy, and Spain. <span class="tablenote"><b>Note:</b> Rate tables created with the Trading API might not have been assigned a <b>rateTableId</b> at the time of their creation. This method can assign and return <b>rateTableId</b> values for rate tables with missing IDs if you make a request using the <b>country_code</b> where the seller has defined rate tables.</span> <br><br>Sellers can define up to 40 shipping rate tables for their account, which lets them set up different rate tables for each of the marketplaces they sell into. Go to <a href="https://www.ebay.com/ship/rt ">Shipping rate tables</a> in <b>My eBay</b> to create and update rate tables. */
276
+ get: operations['getRateTables'];
277
+ put?: never;
278
+ post?: never;
279
+ delete?: never;
280
+ options?: never;
281
+ head?: never;
282
+ patch?: never;
283
+ trace?: never;
284
+ };
285
+ '/return_policy': {
286
+ parameters: {
287
+ query?: never;
288
+ header?: never;
289
+ path?: never;
290
+ cookie?: never;
291
+ };
292
+ /** @description This method retrieves all the return policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter. */
293
+ get: operations['getReturnPolicies'];
294
+ put?: never;
295
+ /** @description This method creates a new return policy where the policy encapsulates seller's terms for returning items. <br><br>Each policy targets a specific marketplace, and you can create multiple policies for each marketplace. Return policies are not applicable to motor-vehicle listings.<br><br>A successful request returns the <b>getReturnPolicy</b> URI to the new policy in the <b>Location</b> response header and the ID for the new policy is returned in the response payload. <p class="tablenote"><b>Tip:</b> For details on creating and using the business policies supported by the Account API, see <a href="/api-docs/sell/static/seller-accounts/business-policies.html">eBay business policies</a>.</p> */
296
+ post: operations['createReturnPolicy'];
297
+ delete?: never;
298
+ options?: never;
299
+ head?: never;
300
+ patch?: never;
301
+ trace?: never;
302
+ };
303
+ '/return_policy/{return_policy_id}': {
304
+ parameters: {
305
+ query?: never;
306
+ header?: never;
307
+ path?: never;
308
+ cookie?: never;
309
+ };
310
+ /** @description This method retrieves the complete details of the return policy specified by the <b>returnPolicyId</b> path parameter. */
311
+ get: operations['getReturnPolicy'];
312
+ /** @description This method updates an existing return policy. Specify the policy you want to update using the <b>return_policy_id</b> path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload. */
313
+ put: operations['updateReturnPolicy'];
314
+ post?: never;
315
+ /** @description This method deletes a return policy. Supply the ID of the policy you want to delete in the <b>returnPolicyId</b> path parameter. */
316
+ delete: operations['deleteReturnPolicy'];
317
+ options?: never;
318
+ head?: never;
319
+ patch?: never;
320
+ trace?: never;
321
+ };
322
+ '/return_policy/get_by_policy_name': {
323
+ parameters: {
324
+ query?: never;
325
+ header?: never;
326
+ path?: never;
327
+ cookie?: never;
328
+ };
329
+ /** @description This method retrieves the details of a specific return policy. Supply both the policy <code>name</code> and its associated <code>marketplace_id</code> in the request query parameters. */
330
+ get: operations['getReturnPolicyByName'];
331
+ put?: never;
332
+ post?: never;
333
+ delete?: never;
334
+ options?: never;
335
+ head?: never;
336
+ patch?: never;
337
+ trace?: never;
338
+ };
339
+ '/bulk_create_or_replace_sales_tax': {
340
+ parameters: {
341
+ query?: never;
342
+ header?: never;
343
+ path?: never;
344
+ cookie?: never;
345
+ };
346
+ get?: never;
347
+ put?: never;
348
+ /** @description This method creates or updates multiple sales-tax table entries.<br><br><i>Sales-tax tables</i> can be set up for countries that support different <i>tax jurisdictions</i>.<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>Each sales-tax table entry comprises the following parameters:<ul><li><code>countryCode</code></li><li><code>jurisdictionId</code></li><li><code>salesTaxPercentage</code></li><li><code>shippingAndHandlingTaxed</code></li></ul><br>Valid jurisdiction IDs are retrieved using <b><a href="/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions" target="_blank">getSalesTaxJurisdictions</a></b> in the Metadata API.<br><br>For details about using this call, refer to <a href="/api-docs/sell/static/seller-accounts/tax-tables.html">Establishing sales-tax tables</a>.<br><br><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><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> */
349
+ post: operations['bulkCreateOrReplaceSalesTax'];
350
+ delete?: never;
351
+ options?: never;
352
+ head?: never;
353
+ patch?: never;
354
+ trace?: never;
355
+ };
356
+ '/sales_tax/{countryCode}/{jurisdictionId}': {
357
+ parameters: {
358
+ query?: never;
359
+ header?: never;
360
+ path?: never;
361
+ cookie?: never;
362
+ };
363
+ /** @description This call retrieves the current sales-tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the <b>countryCode</b> and <b>jurisdictionId</b> path parameters. All four response fields will be returned if a sales-tax entry exists for the tax jurisdiction. Otherwise, the response will be returned as empty.<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><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><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> */
364
+ get: operations['getSalesTax'];
365
+ /** @description This method creates or updates a sales-tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: <b>countryCode</b> and <b>jurisdictionId</b>. <br><br>A tax table entry for a jurisdiction is comprised of two fields: one for the jurisdiction's sales-tax rate and another that's a boolean value indicating whether or not shipping and handling are taxed in the jurisdiction.<br><br>You can set up <i>sales-tax tables</i> for countries that support different <i>tax jurisdictions</i>.<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>Retrieve valid jurisdiction IDs using <b><a href="/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions" target="_blank">getSalesTaxJurisdictions</a></b> in the Metadata API.<br><br>For details about using this call, refer to <a href="/api-docs/sell/static/seller-accounts/tax-tables.html">Establishing sales-tax tables</a>.<br><br><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><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> */
366
+ put: operations['createOrReplaceSalesTax'];
367
+ post?: never;
368
+ /** @description This call deletes a sales-tax table entry for a jurisdiction. Specify the jurisdiction to delete using the <b>countryCode</b> and <b>jurisdictionId</b> path parameters.<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> */
369
+ delete: operations['deleteSalesTax'];
370
+ options?: never;
371
+ head?: never;
372
+ patch?: never;
373
+ trace?: never;
374
+ };
375
+ '/sales_tax': {
376
+ parameters: {
377
+ query?: never;
378
+ header?: never;
379
+ path?: never;
380
+ cookie?: never;
381
+ };
382
+ /** @description Use this call to retrieve all sales tax table entries that the seller has defined for a specific country. All four response fields will be returned for each tax jurisdiction that matches the search criteria. If no sales tax rates are defined for the specified, a <code>204 No Content</code> status code is returned with no response payload.<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><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><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> */
383
+ get: operations['getSalesTaxes'];
384
+ put?: never;
385
+ post?: never;
386
+ delete?: never;
387
+ options?: never;
388
+ head?: never;
389
+ patch?: never;
390
+ trace?: never;
391
+ };
392
+ '/subscription': {
393
+ parameters: {
394
+ query?: never;
395
+ header?: never;
396
+ path?: never;
397
+ cookie?: never;
398
+ };
399
+ /** @description This method retrieves a list of subscriptions associated with the seller account. */
400
+ get: operations['getSubscription'];
401
+ put?: never;
402
+ post?: never;
403
+ delete?: never;
404
+ options?: never;
405
+ head?: never;
406
+ patch?: never;
407
+ trace?: never;
408
+ };
409
+ '/kyc': {
410
+ parameters: {
411
+ query?: never;
412
+ header?: never;
413
+ path?: never;
414
+ cookie?: never;
415
+ };
416
+ /** @description <span class="tablenote"><b>Note:</b> This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts are onboarded globally, this method should now just return an empty payload with a <code>204 No Content</code> HTTP status code. </span> */
417
+ get: operations['getKYC'];
418
+ put?: never;
419
+ post?: never;
420
+ delete?: never;
421
+ options?: never;
422
+ head?: never;
423
+ patch?: never;
424
+ trace?: never;
425
+ };
426
+ '/advertising_eligibility': {
427
+ parameters: {
428
+ query?: never;
429
+ header?: never;
430
+ path?: never;
431
+ cookie?: never;
432
+ };
433
+ /** @description This method allows developers to check the seller eligibility status for eBay advertising programs. */
434
+ get: operations['getAdvertisingEligibility'];
435
+ put?: never;
436
+ post?: never;
437
+ delete?: never;
438
+ options?: never;
439
+ head?: never;
440
+ patch?: never;
441
+ trace?: never;
442
+ };
443
+ }
444
+ export type webhooks = Record<string, never>;
445
+ export interface components {
446
+ schemas: {
447
+ /** @description A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both <b>currency</b> and <b>value</b> fields are required, and both fields are also always returned for an amount in a response field. */
448
+ Amount: {
449
+ /** @description The base currency applied to the <b>value</b> field to establish a monetary amount. <br><br>The currency is represented as a 3-letter <a href="https://www.iso.org/iso-4217-currency-codes.html " title="https://www.iso.org " target="_blank">ISO 4217</a> currency code. For example, the code for the Canadian Dollar is <code>CAD</code>.<br><br><b>Default:</b> The default currency of the eBay marketplace that hosts the listing. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CurrencyCodeEnum'>eBay API documentation</a> */
450
+ currency?: string;
451
+ /** @description The monetary amount in the specified <b>currency</b>. */
452
+ value?: string;
453
+ };
454
+ BulkSalesTaxInput: {
455
+ /** @description The array of sales-tax table entries to be created or updated. */
456
+ salesTaxInputList?: components['schemas']['SalesTaxInput'][];
457
+ };
458
+ /** @description The category type discerns whether the policy applies to motor vehicle listings, or to any other items except motor vehicle listings. <br><br>Each business policy can be associated with either or both categories ('MOTORS_VEHICLES' and 'ALL_EXCLUDING_MOTORS_VEHICLES'); however, return business policies are not applicable for motor vehicle listings. */
459
+ CategoryType: {
460
+ /** @description <span class="tablenote"><strong>Note:</strong> This field has been deprecated and is no longer used.<ul><li>Do not include this field in any <b>create</b> or <b>update</b> method.</li><li>This field may be returned within the payload of a <b>get</b> method, but it can be ignored.</li></ul></span> */
461
+ default?: boolean;
462
+ /** @description The category type to which the policy applies (motor vehicles or non-motor vehicles). <br><br><span class="tablenote"><strong>Note:</strong> The <code>MOTORS_VEHICLES</code> category type is not valid for return policies. eBay flows do not support the return of motor vehicles.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CategoryTypeEnum'>eBay API documentation</a> */
463
+ name?: string;
464
+ };
465
+ /** @description The response payload for requests that return a list of custom policies. */
466
+ CompactCustomPolicyResponse: {
467
+ /** @description The unique custom policy identifier for the policy being returned.<br><br><span class="tablenote"><strong>Note:</strong> This value is automatically assigned by the system when the policy is created.</span> */
468
+ customPolicyId?: string;
469
+ /** @description Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information.<br><br><b>Max length:</b> 65 */
470
+ label?: string;
471
+ /** @description The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.<br><br><span class="tablenote"><strong>Note:</strong> This field is visible only to the seller. </span><br><b>Max length:</b> 65 */
472
+ name?: string;
473
+ /** @description Specifies the type of Custom Policy being returned. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CustomPolicyTypeEnum'>eBay API documentation</a> */
474
+ policyType?: string;
475
+ };
476
+ /** @description This container defines a seller's custom policy identified by policy ID for the selected eBay marketplace. A successful call returns the requested policy information. */
477
+ CustomPolicy: {
478
+ /** @description The unique custom policy identifier for a policy. */
479
+ customPolicyId?: string;
480
+ /** @description Contains the seller's policy and policy terms. Buyers access this information from the View Item page for items to which the policy has been applied.<br><br><b>Max length:</b> 15,000 */
481
+ description?: string;
482
+ /** @description Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information.<br><br><b>Max length:</b> 65 */
483
+ label?: string;
484
+ /** @description The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.<br><br><span class="tablenote"><strong>Note:</strong> This field is visible only to the seller. </span><br><b>Max length:</b> 65 */
485
+ name?: string;
486
+ /** @description Specifies the type of Custom Policy being returned. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CustomPolicyTypeEnum'>eBay API documentation</a> */
487
+ policyType?: string;
488
+ };
489
+ /** @description This type is used by the request payload of the createCustomPolicy method to define a new custom policy for a specific marketplace. */
490
+ CustomPolicyCreateRequest: {
491
+ /** @description Contains the seller's policy and policy terms.<br><br><b>Max length:</b> 15,000 */
492
+ description?: string;
493
+ /** @description Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information.<br><br><b>Max length:</b> 65 */
494
+ label?: string;
495
+ /** @description The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.<br><br><span class="tablenote"><strong>Note:</strong> This field is visible only to the seller. </span><br><b>Max length:</b> 65 */
496
+ name?: string;
497
+ /** @description Specifies the type of custom policy being created. <br><br>Two Custom Policy types are supported: <ul><li>Product Compliance (PRODUCT_COMPLIANCE)</li> <li>Takeback (TAKE_BACK)</li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CustomPolicyTypeEnum'>eBay API documentation</a> */
498
+ policyType?: string;
499
+ };
500
+ CustomPolicyRequest: {
501
+ /** @description Contains the seller specified policy and policy terms.<br><br><span class="tablenote"><strong>Note:</strong> Always supply this field. If this field is not specified, any previous value is removed. Call the <a href="/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicy">getCustomPolicy</a> method to return the present field value for this policy.</span><br><b>Max length:</b> 15,000 */
502
+ description?: string;
503
+ /** @description Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to seller specified policy information.<br><br><span class="tablenote"><strong>Note:</strong> Always supply this field. If this field is not specified, any previous value is removed. Call the <a href="/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicy">getCustomPolicy</a> method to return the present field value for this policy.</span><br><b>Max length:</b> 65 */
504
+ label?: string;
505
+ /** @description The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.<br><br><span class="tablenote"><strong>Note:</strong> This field is visible only to the seller. </span><br><br><span class="tablenote"><strong>Note:</strong> Always supply this field. If this field is not specified, any previous value is removed. Call the <a href="/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicy">getCustomPolicy</a> method to return the present field value for this policy.</span><br><b>Max length:</b> 65 */
506
+ name?: string;
507
+ };
508
+ CustomPolicyResponse: {
509
+ /** @description This array contains the custom policies that match the input criteria. */
510
+ customPolicies?: components['schemas']['CompactCustomPolicyResponse'][];
511
+ /** @description <i>This field is for future use.</i> */
512
+ href?: string;
513
+ /**
514
+ * Format: int32
515
+ * @description <i>This field is for future use.</i>
516
+ */
517
+ limit?: number;
518
+ /** @description <i>This field is for future use.</i> */
519
+ next?: string;
520
+ /**
521
+ * Format: int32
522
+ * @description <i>This field is for future use.</i>
523
+ */
524
+ offset?: number;
525
+ /** @description <i>This field is for future use.</i> */
526
+ prev?: string;
527
+ /**
528
+ * Format: int32
529
+ * @description <i>This field is for future use.</i>
530
+ */
531
+ total?: number;
532
+ };
533
+ /** @description This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing. */
534
+ Deposit: {
535
+ /** @description This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required.<br><br><b>Max</b>: <code>2000.0</code> */
536
+ amount?: components['schemas']['Amount'];
537
+ /** @description This value indicates the number of hours that the buyer has (after they commit to buy) to pay the initial deposit on a motor vehicle. Valid <b>dueIn</b> times are 24, 48, and 72 hours. <code>HOUR</code> is set as the <b>unit</b> value, and <code>24</code>, <code>48</code> or <code>72</code> are set in the <b>value</b> field.<br><br><span class="tablenote"><b>Note</b>: The <b>dueIn</b> value is overridden if the seller has set the motor vehicle listing to require immediate payment. If the listing requires immediate payment, the buyer must pay the deposit immediately in order to be eligible to purchase the motor vehicle.</span><br><br><b>Min</b>=24 (hours)<b>Max</b>=72 (hours), <b>Default</b>=48 (hours) */
538
+ dueIn?: components['schemas']['TimeDuration'];
539
+ /** @description This array is no longer applicable and should not be used since eBay now manages the electronic payment options available to buyers to pay the deposit. */
540
+ paymentMethods?: components['schemas']['PaymentMethod'][];
541
+ };
542
+ /** @description A container that defines the elements of error and warning messages. */
543
+ Error: {
544
+ /** @description The category type for this error or warning. It is a string that 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> */
545
+ category?: string;
546
+ /** @description Name of the domain ,or primary system, of the service or application where the error occurred. */
547
+ domain?: string;
548
+ /**
549
+ * Format: int32
550
+ * @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.
551
+ */
552
+ errorId?: number;
553
+ /** @description Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use <i>JSONPath</i> notation. */
554
+ inputRefIds?: string[];
555
+ /** @description A more detailed explanation of the error than given in the <code>message</code> error field. */
556
+ longMessage?: string;
557
+ /** @description Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale. */
558
+ message?: string;
559
+ /** @description Identifies specific response elements associated with the error, if any. Path format is the same as <code>inputRefId</code>. */
560
+ outputRefIds?: string[];
561
+ /** @description This optional list of name/value pairs that contain context-specific <code>ErrorParameter</code> objects, with each item in the list 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>. */
562
+ parameters?: components['schemas']['ErrorParameter'][];
563
+ /** @description If present, indicates the subsystem in which the error occurred. */
564
+ subdomain?: string;
565
+ };
566
+ /** @description A complex type that indicates a parameter that caused an error and the value of the parameter which caused the error. */
567
+ ErrorParameter: {
568
+ /** @description Name of the parameter that caused the error. */
569
+ name?: string;
570
+ /** @description The value of the parameter that caused the error. */
571
+ value?: string;
572
+ };
573
+ /** @description This type is used by the <b>fulfillmentPolicy</b> response container, a container which defines a seller's fulfillment policy for a specific marketplace. */
574
+ FulfillmentPolicy: {
575
+ /** @description This container indicates whether the fulfillment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. */
576
+ categoryTypes?: components['schemas']['CategoryType'][];
577
+ /** @description A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. <br><br><b>Max length</b>: 250 */
578
+ description?: string;
579
+ /** @description If returned as <code>true</code>, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs. */
580
+ freightShipping?: boolean;
581
+ /** @description A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created. */
582
+ fulfillmentPolicyId?: string;
583
+ /** @description <span class="tablenote"><b>Note</b>: This field is only applicable for the eBay United Kingdom marketplace (<code>EBAY_GB</code>).</span><br>If returned as <code>true</code>, eBay's Global Shipping Program will be used by the seller to ship items to international locations.<br><br>eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy. */
584
+ globalShipping?: boolean;
585
+ /** @description Specifies the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order. <p>If only local pickup or freight shipping is available for the item, this container may not get returned.</p> */
586
+ handlingTime?: components['schemas']['TimeDuration'];
587
+ /** @description If returned as <code>true</code>, local pickup is available for this policy. */
588
+ localPickup?: boolean;
589
+ /** @description The ID of the eBay marketplace to which this fulfillment policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
590
+ marketplaceId?: string;
591
+ /** @description A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. <br><br><b>Max length</b>: 64 */
592
+ name?: string;
593
+ /** @description If returned as <code>true</code>, the seller offers the "Click and Collect" option. <br><br>Currently, "Click and Collect" is available only to large retail merchants the eBay AU, UK, DE, FR, and IT marketplaces. */
594
+ pickupDropOff?: boolean;
595
+ /** @description This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate <b>ShippingOption</b> object covers domestic shipping service options and international shipping service options (if the seller ships to international locations). <br><br>The <b>optionType</b> field indicates whether the <b>ShippingOption</b> object applies to domestic or international shipping, and the <b>costType</b> field indicates whether flat-rate shipping or calculated shipping will be used. <p>A separate <b>ShippingServices</b> object is used to specify cost and other details for every available domestic and international shipping service option. </p> */
596
+ shippingOptions?: components['schemas']['ShippingOption'][];
597
+ /** @description This container consists of the <b>regionIncluded</b> and <b>regionExcluded</b> containers, which define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy. */
598
+ shipToLocations?: components['schemas']['RegionSet'];
599
+ };
600
+ /** @description This root container defines a seller's fulfillment policy for a specific marketplace and category group. This type is used when creating or updating a fulfillment business policy. */
601
+ FulfillmentPolicyRequest: {
602
+ /** @description This container is used to specify whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. */
603
+ categoryTypes?: components['schemas']['CategoryType'][];
604
+ /** @description A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. <br><br><b>Max length</b>: 250 */
605
+ description?: string;
606
+ /** @description This field is included and set to <code>true</code> if freight shipping is available for the item. Freight shipping can be used for large items over 150 lbs.<br><br><b>Default</b>: false */
607
+ freightShipping?: boolean;
608
+ /** @description <span class="tablenote"><b>Note</b>: This field is only applicable for the eBay United Kingdom marketplace (<code>EBAY_GB</code>).</span><br>This field is included and set to <code>true</code> if the seller wants to use the Global Shipping Program for international shipments. See the <a href="https://pages.ebay.com/help/sell/shipping-globally.html ">Global Shipping Program</a> help topic for more details and requirements on the Global Shipping Program.<br><br>A seller can use a combination of the Global Shipping Program and other international shipping services. <br><br>If set to <code>false</code> or if the field is omitted, the seller has to manually specifying individual international shipping services (if the seller ships internationally), as described in <a href="https://developer.ebay.com/api-docs/sell/static/seller-accounts/ht_shipping-worldwide.html ">Setting up worldwide shipping</a>. <br><br>Sellers opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.<br><br>eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy.<p><b>Default</b>: false</p> */
609
+ globalShipping?: boolean;
610
+ /** @description This container is used to specify the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order.<br><br>Valid values can vary by site and by category. To obtain the supported values for a site, call <a href="/devzone/xml/docs/reference/ebay/GeteBayDetails.html">GeteBayDetails</a> in the Trading API with <b>DetailName</b> set to <code>DispatchTimeMaxDetails</code>, then inspect the <b>DispatchTimeMaxDetails</b> container in the response for the time values supported by the site (typical handling times are <code>0</code>, <code>1</code>, <code>2</code>, <code>3</code>, <code>4</code>, <code>5</code>, <code>10</code>, <code>15</code>, and <code>20</code>, but these can vary by site and may change over time.) <p>This field is conditionally required when the seller is offering one or more domestic or international shipping options, but it is not applicable when the item is only available through local pickup (<code>"localPickup": "true"</code>), or if it will be shipped through a freight shipping service (<code>"freightShipping": "true"</code>). </p> <span class="tablenote"><b>Note: </b> Top-Rated sellers must offer same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results pages. To offer zero-day or one-day handling, set field to '0' or '1', respectively.</span> */
611
+ handlingTime?: components['schemas']['TimeDuration'];
612
+ /** @description This field should be included and set to <code>true</code> if local pickup is one of the fulfillment options available to the buyer. It is possible for the seller to make local pickup and some shipping service options available to the buyer.<br><br>With local pickup, the buyer and seller make arrangements for pickup time and location.<br><br><b>Default</b>: <code>false</code> */
613
+ localPickup?: boolean;
614
+ /** @description The ID of the eBay marketplace to which this fulfillment policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
615
+ marketplaceId?: string;
616
+ /** @description A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. <br><br><b>Max length</b>: 64 */
617
+ name?: string;
618
+ /** @description This field should be included and set to <code>true</code> if the seller offers the "Click and Collect" feature for an item. <p>To enable "Click and Collect" on a listing, a seller must be eligible for Click and Collect. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU, UK, DE, FR, and IT marketplaces.</p> <p>In addition to setting this field to <code>true</code>, the merchant must also do the following to enable the "Click and Collect" option on a listing: <ul><li>Have inventory for the product at one or more physical stores tied to the merchant's account. <p>Sellers can use the <b>createInventoryLocation</b> method in the Inventory API to associate physical stores to their account and they can then add inventory to specific store locations.</p></li><li>Set an immediate payment requirement on the item. The immediate payment feature requires the seller to: <ul><li>Set the <b>immediatePay</b> flag in the payment policy to 'true'.</li><li>Have a valid store location with a complete street address.</li></ul></li></ul><p>When a merchant successfully lists an item with Click and Collect, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.</p><b>Default</b>: false */
619
+ pickupDropOff?: boolean;
620
+ /** @description This array is used to provide detailed information on the domestic and international shipping options available for the policy. <br><br>A separate <b>ShippingOption</b> object is required for domestic shipping service options and for international shipping service options (if the seller ships to international locations). <ul><li>The <b>optionType</b> field is used to indicate whether the <b>ShippingOption</b> object applies to domestic or international shipping, and the <b>costType</b> field is used to indicate whether flat-rate shipping or calculated shipping will be used.</li> <li>The <b>rateTableId</b> field can be used to associate a defined shipping rate table to the policy, and the <b>packageHandlingCost</b> container can be used to set a handling charge for the policy.</li></ul> <p>A separate <b>ShippingServices</b> object will be used to specify cost and other details for every available domestic and international shipping service option. </p> */
621
+ shippingOptions?: components['schemas']['ShippingOption'][];
622
+ /** @description This container consists of the <b>regionIncluded</b> and <b>regionExcluded</b> arrays, which are used to define the geographical regions/countries/states or provinces/domestic regions that a seller does and does not ship to for the associated fulfillment policy. Note that this container can be considered the master list of where the seller ships and does not ship, but there is also a <b>shipToLocations</b> container that can be set at the shipping service option level.<br><br><span class="tablenote"><b>Note:</b> Any shipping exclusions specified through this container can be overridden by the eBay International Shipping exclusions toggle located under <b>Shipping Preferences</b> in <b>My eBay</b>. For more information on eBay International Shipping, see <a href="https://www.ebay.com/help/selling/shipping-items/setting-shipping-options/ebay-international-shipping-program?id=5348" target="_blank">eBay International Shipping program</a>.</span><br>To retrieve the valid geographical shipping region values, two-digit country values, or special domestic regions for an eBay marketplace, call <a href="/devzone/xml/docs/reference/ebay/GeteBayDetails.html">GeteBayDetails</a> with <b>DetailName</b> value set to <code>ExcludeShippingLocationDetails</code>, then review the <b>ExcludeShippingLocationDetails</b> containers in the response for the strings you use in both the <b>regionIncluded.regionName</b> and in the <b>regionExcluded.regionName</b> fields. <br><br>For valid geographical region names, look for the <code>ExcludeShippingLocationDetails</code> containers in the <b>GeteBayDetails</b> response where the <b>Region</b> value is <code>Worldwide</code>, and the valid values will be shown in the corresponding <b>Location</b> fields. <br><br>For valid two-digit country codes, look for <code>ExcludeShippingLocationDetails</code> in the <b>GeteBayDetails</b> response where the <b>Region</b> value is one of the defined geographical regions, and the valid values will be shown in the corresponding <b>Location</b> fields. Alternatively, you can find the two-digit country code values in the <a href="/api-docs/sell/account/types/ba:CountryCodeEnum">CountryCodeEnum</a> type definition. For valid domestic region values, look for <code>ExcludeShippingLocationDetails</code> in the <b>GeteBayDetails</b> response where the <b>Region</b> value is either <code>Domestic Location</code> or <code>Additional Locations</code>, and the valid values will be shown in the corresponding <b>Location</b> fields. <br><br>The <code>STATE_OR_PROVINCE</code> region type is only applicable to the US and Canada, and valid values for US states are the same <a href="https://about.usps.com/who-we-are/postal-history/state-abbreviations.htm ">two-digit abbreviations</a> used by the United States Postal Service, and valid values for Canadian provinces and territories are the same <a href="https://www.canadapost-postescanada.ca/cpc/en/support/articles/addressing-guidelines/symbols-and-abbreviations.page ">two-digit abbreviations</a> used by the Canada Post. */
623
+ shipToLocations?: components['schemas']['RegionSet'];
624
+ };
625
+ /** @description The response payload for the <b>getFulfillmentPolicies</b> method.<br><br><span class="tablenote"><b>Note</b>: Pagination has not yet been enabled for <b>getFulfillmentPolicies</b>, so all of the pagination-related fields are for future use.</span> */
626
+ FulfillmentPolicyResponse: {
627
+ /** @description A list of all of the seller's fulfillment policies defined for the specified marketplace. This array will be returned as empty if no fulfillment policies are defined for the specified marketplace. */
628
+ fulfillmentPolicies?: components['schemas']['FulfillmentPolicy'][];
629
+ /** @description This field is for future use. */
630
+ href?: string;
631
+ /**
632
+ * Format: int32
633
+ * @description This field is for future use.
634
+ */
635
+ limit?: number;
636
+ /** @description This field is for future use. */
637
+ next?: string;
638
+ /**
639
+ * Format: int32
640
+ * @description This field is for future use.
641
+ */
642
+ offset?: number;
643
+ /** @description This field is for future use. */
644
+ prev?: string;
645
+ /**
646
+ * Format: int32
647
+ * @description The total number of fulfillment policies retrieved in the result set. <br><br>If no fulfillment policies are defined for the specified marketplace, this field is returned with a value of <code>0</code>.
648
+ */
649
+ total?: number;
650
+ };
651
+ /** @description This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers. */
652
+ InternationalReturnOverrideType: {
653
+ /** @description This field sets/indicates if the seller offers replacement items to the buyer in the case of an international return. The buyer must be willing to accept a replacement item; otherwise, the seller will need to issue a refund for a return. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay API documentation</a> */
654
+ returnMethod?: string;
655
+ /** @description This container indicates the number of calendar days that the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. <br><br>You must set the value to one that's accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods. For a definitive list of return periods for one or more categories, call <a href="/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies">getReturnPolicies</a> method of the <b>Metadata API</b>. <br><br>The <b>TimeDuration</b> type is used to set/indicate the return period, and you set the <b>unit</b> value to <code>DAY</code> and the <b>value</b> field to either <code>30</code> or <code>60</code> (or other value, as appropriate). <br><br>Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours. <br><br>This field is conditionally required if the <b>internationalOverride.returnsAccepted</b> field is set to <code>true</code>. */
656
+ returnPeriod?: components['schemas']['TimeDuration'];
657
+ /** @description If set to <code>true</code>, the seller accepts international returns. If set to <code>false</code>, the seller does not accept international returns. <br><br>This field is conditionally required if the seller chooses to have a separate international return policy. */
658
+ returnsAccepted?: boolean;
659
+ /** @description This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either <code>BUYER</code> or <code>SELLER</code>. <br><br>Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for 'significantly not as described' (SNAD) issues. <br><br>This field is conditionally required if the <b>internationalOverride.returnsAccepted</b> field is set to <code>true</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay API documentation</a> */
660
+ returnShippingCostPayer?: string;
661
+ };
662
+ /** @description This type is used to provide details about any KYC check that is applicable to the managed payments seller. */
663
+ KycCheck: {
664
+ /** @description The enumeration value returned in this field categorizes the type of details needed for the KYC check. More information about the check is shown in the <b>detailMessage</b> and other applicable, corresponding fields. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/kyc:DetailsType'>eBay API documentation</a> */
665
+ dataRequired?: string;
666
+ /** @description The timestamp in this field indicates the date by which the seller should resolve the KYC requirement.<br><br>The timestamp in this field uses the UTC date and time format described in the <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601 Standard</a>. See below for this format and an example: <br><br><i>MM-DD-YYYY HH:MM:SS</i><br/><code>06-05-2020 10:34:18</code> */
667
+ dueDate?: string;
668
+ /** @description If applicable and available, a URL will be returned in this field, and the link will take the seller to an eBay page where they can provide the requested information. */
669
+ remedyUrl?: string;
670
+ /** @description This field gives a short summary of what is required from the seller. An example might be, '<code>Upload bank document now.</code>'. The <b>detailMessage</b> field will often provide more details on what is required of the seller. */
671
+ alert?: string;
672
+ /** @description This field gives a detailed message about what is required from the seller. An example might be, '<code>Please upload a bank document by 2020-08-01 to get your account back in good standing.</code>'. */
673
+ detailMessage?: string;
674
+ };
675
+ /** @description This is the base response type of the <b>getKYC</b> method. */
676
+ KycResponse: {
677
+ /** @description This array contains one or more KYC checks required from a managed payments seller. The seller may need to provide more documentation and/or information about themselves, their company, or the bank account they are using for seller payouts.<br/><br/>If no KYC checks are currently required from the seller, this array is not returned, and the seller only receives a <code>204 No Content</code> HTTP status code. */
678
+ kycChecks?: components['schemas']['KycCheck'][];
679
+ };
680
+ /** @description This type is used by the <b>paymentMethods</b> container, which is used by the seller to specify one or more offline payment methods. <br><br> <span class="tablenote"><b>Note</b>: eBay now controls all electronic payment methods available for a marketplace, so a seller will no longer use this type to specify any electronic payment methods.</span> */
681
+ PaymentMethod: {
682
+ /** @description <span class="tablenote"><b>Note</b>: This array is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including any credit card brands accepted. </span> */
683
+ brands?: string[];
684
+ /** @description This array is only applicable for listings supporting offline payment methods. See the <b>PaymentMethodTypeEnum</b> type for supported offline payment method enum values. If offline payments are enabled for the policy, provide at least one offline payment method.</p> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentMethodTypeEnum'>eBay API documentation</a> */
685
+ paymentMethodType?: string;
686
+ /** @description <span class="tablenote"><b>Note</b>: This container is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including PayPal. </span> */
687
+ recipientAccountReference?: components['schemas']['RecipientAccountReference'];
688
+ };
689
+ /** @description This type is used by the <b>paymentPolicy</b> response container, a container which defines a seller's payment business policy for a specific marketplace. */
690
+ PaymentPolicy: {
691
+ /** @description This container indicates whether the payment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. */
692
+ categoryTypes?: components['schemas']['CategoryType'][];
693
+ /** @description This container is applicable only if the <b>categoryTypes.name</b> field is set to <code>MOTORS_VEHICLES</code>, and is only returned if the seller requires an initial deposit on motor vehicles.<br><br>The container shows the amount due for the deposit and when it is due (within 1-3 days after commitment to purchase, unless the listing requires immediate payment). <p class="tablenote"><b>Note:</b> The due date that is specified in the <b>deposit</b> container will be overridden if the payment business policy requires immediate payment (in this case, for the deposit), and the buyer commits to purchasing the motor vehicle through a fixed-price listing or through the 'Buy it Now' option of an auction listing. </p> */
694
+ deposit?: components['schemas']['Deposit'];
695
+ /** @description A seller-defined description of the payment policy. This description is only for the seller's use, and is not exposed on any eBay pages. <br><br><b>Max length</b>: 250 */
696
+ description?: string;
697
+ /** @description This container applies to motor vehicles listings only and indicates when a final payment for the vehicle is due. This value is always returned if <b>categoryTypes</b> is set to <code>MOTORS_VEHICLES</code>. <br><br>This container indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. The period starts when the buyer commits to buy. The valid values, as specified with <b>TimeDuration</b>, are:<ul><li>3 DAYS</li><li>7 DAYS (the default)</li><li>10 DAYS</li><li>14 DAYS</li></ul>A <code>MOTORS_VEHICLES</code>) payment business policy must specify at least one of the following <b>paymentMethods</b> values for the final payment: <ul> <li>CASH_ON_PICKUP<br><br><span class="tablenote"><b>Note:</b> This payment method is only available to sellers outside the US.</span></li> <li>CASHIER_CHECK</li> <li>MONEY_ORDER</li><li>PERSONAL_CHECK</li></ul> */
698
+ fullPaymentDueIn?: components['schemas']['TimeDuration'];
699
+ /** @description If this field is returned as <code>true</code>, immediate payment is required from the buyer for: <ul><li>A fixed-price item</li><li>An auction item where the buyer uses the 'Buy it Now' option</li><li>A deposit for a motor vehicle listing</li></ul><br>It is possible for the seller to set this field as <code>true</code> in the payment business policy, but it will not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyer purchases that involve the Best Offer feature, or for transactions that happen offline between the buyer and seller. */
700
+ immediatePay?: boolean;
701
+ /** @description The ID of the eBay marketplace to which the payment business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
702
+ marketplaceId?: string;
703
+ /** @description A seller-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. <br><br><b>Max length</b>: 64 */
704
+ name?: string;
705
+ /** @description Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy. <br><br><b>Max length</b>: 1000 */
706
+ paymentInstructions?: string;
707
+ /** @description This container is returned to show the payment methods that are accepted for the payment business policy. <br><br>Sellers do not have to specify any electronic payment methods for listings, so this array will often be returned empty unless the payment business policy is intended for motor vehicle listings or other items in categories where offline payments are required or supported. */
708
+ paymentMethods?: components['schemas']['PaymentMethod'][];
709
+ /** @description A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created. */
710
+ paymentPolicyId?: string;
711
+ };
712
+ /** @description This root container defines a seller's payment business policy for a specific marketplace and category group. This type is used when creating or updating a payment business policy. */
713
+ PaymentPolicyRequest: {
714
+ /** @description This container is used to specify whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. */
715
+ categoryTypes?: components['schemas']['CategoryType'][];
716
+ /** @description This container is used if the seller wants to require an initial deposit on a motor vehicle listing. In this container, the seller sets the deposit amount and the due date for the deposit.<br><br>Because eBay controls all electronic payment methods, sellers do not need to specify a payment method and the <b>deposit.paymentMethods</b> array is not needed.<p class="tablenote"><b>Note: </b>The 'due date' specified in the <b>deposit</b> container will be overridden if the payment business policy requires immediate payment (in this case, for the deposit), and the buyer commits to purchase the motor vehicle through a fixed-price listing or through the 'Buy it Now' option of an auction listing. See <a href="/api-docs/sell/account/resources/payment_policy/methods/createPaymentPolicy#request.immediatePay">immediatePay</a>.</p> */
717
+ deposit?: components['schemas']['Deposit'];
718
+ /** @description A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages. <br><br><b>Max length</b>: 250 */
719
+ description?: string;
720
+ /** @description This container is used to specify the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. <br><br>The period starts when the buyer commits to buy. The valid values, as specified with <b>TimeDuration</b>, are:<ul><li><code>3 DAYS</code></li><li><code>7 DAYS</code> (the default)</li><li><code>10 DAYS</code></li><li><code>14 DAYS</code></li></ul>In order for a buyer to make a full payment on a motor vehicle, at least one of the following <b>paymentMethods</b> values must be specified for the corresponding payment business policy: <ul> <li><code>CASH_ON_PICKUP</code></li> <li><code>CASHIER_CHECK</code></li> <li><code>MONEY_ORDER</code></li> <li><code>PERSONAL_CHECK</code></li></ul><b>Default:</b> <code>7 DAYS</code> */
721
+ fullPaymentDueIn?: components['schemas']['TimeDuration'];
722
+ /** @description This field should be included and set to <code>true</code> if the seller wants to require immediate payment from the buyer for: <ul><li>A fixed-price item</li><li>An auction item where the buyer is using the 'Buy it Now' option</li><li>A deposit for a motor vehicle listing</li></ul><br><b>Default:</b> False */
723
+ immediatePay?: boolean;
724
+ /** @description The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
725
+ marketplaceId?: string;
726
+ /** @description A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.<br><br><b>Max length:</b> 64 */
727
+ name?: string;
728
+ /** @description <p class="tablenote"><b>Note:</b> DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.</p>A free-form string field that allows sellers to add detailed payment instructions to their listings. */
729
+ paymentInstructions?: string;
730
+ /** @description <p class="tablenote"><b>Note:</b> This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item.</p>This array is used to specify one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform. */
731
+ paymentMethods?: components['schemas']['PaymentMethod'][];
732
+ };
733
+ /** @description The response payload for the <b>getPaymentPolicies</b> method. <br><br><span class="tablenote"><b>Note</b>: Pagination has not yet been enabled for <b>getPaymentPolicies</b>, so all of the pagination-related fields are for future use.</span> */
734
+ PaymentPolicyResponse: {
735
+ /** @description This field is for future use. */
736
+ href?: string;
737
+ /**
738
+ * Format: int32
739
+ * @description This field is for future use.
740
+ */
741
+ limit?: number;
742
+ /** @description This field is for future use. */
743
+ next?: string;
744
+ /**
745
+ * Format: int32
746
+ * @description This field is for future use.
747
+ */
748
+ offset?: number;
749
+ /** @description A list of all of the seller's payment business policies defined for the specified marketplace. This array will be returned as empty if no payment business policies are defined for the specified marketplace. */
750
+ paymentPolicies?: components['schemas']['PaymentPolicy'][];
751
+ /** @description This field is for future use. */
752
+ prev?: string;
753
+ /**
754
+ * Format: int32
755
+ * @description The total number of payment business policies retrieved in the result set. <br><br>If no payment business policies are defined for the specified marketplace, this field is returned with a value of <code>0</code>.
756
+ */
757
+ total?: number;
758
+ };
759
+ /** @description Type used by the payments program onboarding response */
760
+ PaymentsProgramOnboardingResponse: {
761
+ /** @description This enumeration value indicates the eligibility of payment onboarding for the registered site. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramOnboardingStatus'>eBay API documentation</a> */
762
+ onboardingStatus?: string;
763
+ /** @description An array of the active process steps for payment onboarding and the status of each step. This array includes the step <strong>name</strong>, step <strong>status</strong>, and a <strong>webUrl</strong> to the <code>IN_PROGRESS</code> step. The step names are returned in sequential order. */
764
+ steps?: components['schemas']['PaymentsProgramOnboardingSteps'][];
765
+ };
766
+ /** @description The payments program onboarding steps, status, and link. */
767
+ PaymentsProgramOnboardingSteps: {
768
+ /** @description The name of the step in the steps array. Over time, these names are subject to change as processes change. The output sample contains example step names. Review an actual call response for updated step names. */
769
+ name?: string;
770
+ /** @description This enumeration value indicates the status of the associated step. <p> <span class="tablenote"><strong>Note:</strong> Only one step can be <code>IN_PROGRESS</code> at a time.</span></p> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramOnboardingStepStatus'>eBay API documentation</a> */
771
+ status?: string;
772
+ /** @description This URL provides access to the <code>IN_PROGRESS</code> step. */
773
+ webUrl?: string;
774
+ };
775
+ /** @description The response object containing the sellers status with regards to the specified payment program. */
776
+ PaymentsProgramResponse: {
777
+ /** @description The ID of the eBay marketplace to which the payment program applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
778
+ marketplaceId?: string;
779
+ /** @description This parameter specifies the payment program whose status is returned by the call. <br><br>Currently the only supported payments program is <code>EBAY_PAYMENTS</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramType'>eBay API documentation</a> */
780
+ paymentsProgramType?: string;
781
+ /** @description The enumeration value returned in this field indicates whether or not the seller's account is enabled for the payments program. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramStatus'>eBay API documentation</a> */
782
+ status?: string;
783
+ /** @description If returned as <code>true</code>, the seller was at one point opted-in to the associated payment program, but they later opted out of the program. A value of <code>false</code> indicates the seller never opted-in to the program or if they did opt-in to the program, they never opted-out of it. <br><br>It's important to note that the setting of this field does not indicate the seller's current status regarding the payment program. It is possible for this field to return <code>true</code> while the <b>status</b> field returns <code>OPTED_IN</code>. */
784
+ wasPreviouslyOptedIn?: boolean;
785
+ };
786
+ /** @description The seller program to opt in to when part of an <b>optInToProgram</b> request, or out of when part of an <b>optOutOfProgram</b> request. */
787
+ Program: {
788
+ /** @description The seller program to opt in to when part of an <b>optInToProgram</b> request, or out of when part of an <b>optOutOfProgram</b> request. When returned in an <b>getOptedInPrograms</b> response, a separate <b>programType</b> field is returned for each seller program that the seller is opted in to. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ProgramTypeEnum'>eBay API documentation</a> */
789
+ programType?: string;
790
+ };
791
+ /** @description The base response type of the <b>getOptedInPrograms</b> method. */
792
+ Programs: {
793
+ /** @description An array of seller programs that the seller's account is opted in to. An empty array is returned if the seller is not opted in to any of the seller programs. */
794
+ programs?: components['schemas']['Program'][];
795
+ };
796
+ /** @description This type is used to provide details about each shipping rate table that is returned in the <b>getRateTables</b> response. */
797
+ RateTable: {
798
+ /** @description A 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 representing the eBay marketplace where the shipping rate table is defined. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'>eBay API documentation</a> */
799
+ countryCode?: string;
800
+ /** @description This enumeration value returned here indicates whether the shipping rate table is a domestic or international shipping rate table. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingOptionTypeEnum'>eBay API documentation</a> */
801
+ locality?: string;
802
+ /** @description The seller-defined name for the shipping rate table. */
803
+ name?: string;
804
+ /** @description A unique eBay-assigned ID for a seller's shipping rate table. These <b>rateTableId</b> values are used to associate shipping rate tables to fulfillment business policies or directly to listings through an add/revise/relist call in the Trading API. */
805
+ rateTableId?: string;
806
+ };
807
+ /** @description This type is the base response of the <b>getRateTables</b> method. */
808
+ RateTableResponse: {
809
+ /** @description An array of all shipping rate tables defined for a marketplace (or all marketplaces if no <b>country_code</b> query parameter is used). This array will be returned as empty if the seller has no defined shipping rate tables for the specified marketplace. */
810
+ rateTables?: components['schemas']['RateTable'][];
811
+ };
812
+ /** @description <span class="tablenote"><b>Note</b>: This type is no longer applicable. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.</span> */
813
+ RecipientAccountReference: {
814
+ /** @description <span class="tablenote"><b>Note</b>: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.</span> */
815
+ referenceId?: string;
816
+ /** @description <span class="tablenote"><b>Note</b>: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RecipientAccountReferenceTypeEnum'>eBay API documentation</a> */
817
+ referenceType?: string;
818
+ };
819
+ /** @description This type is used to define specific shipping regions. There are four 'levels' of shipping regions, including large geographical regions (like 'Asia', 'Europe', or 'Middle East'), individual countries, US states or Canadian provinces, and special locations/domestic regions within a country (like 'Alaska/Hawaii' or 'PO Box'). */
820
+ Region: {
821
+ /** @description A string that indicates the name of a region, as defined by eBay. A "region" can be either a 'world region' (e.g., the "Middle East" or "Southeast Asia"), a country (represented with a two-letter country code), a state or province (represented with a two-letter code), or a special domestic region within a country. <br><br>The <a href="/devzone/xml/docs/reference/ebay/GeteBayDetails.html">GeteBayDetails</a> call in the Trading API can be used to retrieve the world regions and special domestic regions within a specific country. To get these enumeration values, call <b>GeteBayDetails</b> with the <b>DetailName</b> value set to <b>ExcludeShippingLocationDetails</b>. */
822
+ regionName?: string;
823
+ /** @description Reserved for future use. <!--The region's type, which can be one of the following: 'COUNTRY', 'COUNTRY_REGION', 'STATE_OR_PROVINCE', 'WORLD_REGION', or 'WORLDWIDE'.--> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:RegionTypeEnum'>eBay API documentation</a> */
824
+ regionType?: string;
825
+ };
826
+ /** @description This type consists of the <b>regionIncluded</b> and <b>regionExcluded</b> arrays, which indicate the areas to where the seller does and doesn't ship. */
827
+ RegionSet: {
828
+ /** @description An array of one or more <b>regionName</b> values that specify the areas to where a seller does not ship. A <b>regionExcluded</b> list should only be set in the top-level <b>shipToLocations</b> container and not within the <b>shippingServices.shipToLocations</b> container used to specify which shipping regions are serviced by each available shipping service option. <p>Many sellers are willing to ship to many international locations, but they may want to exclude some world regions or some countries as places they are willing to ship to.<br><br>This array will be returned as empty if no shipping regions are excluded with the fulfillment business policy.<br> <br><span class="tablenote"><b>Note: </b> The <b>regionExcluded</b> array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a <b>createFulfillmentPolicy</b> or <b>updateFulfillmentPolicy</b> request, it will be ignored.</span> */
829
+ regionExcluded?: components['schemas']['Region'][];
830
+ /** @description An array of one or more <b>regionName</b> fields that specify the areas to where a seller ships. <br>Each eBay marketplace supports its own set of allowable shipping locations.<br> <br><span class="tablenote"><b>Note: </b> The <b>regionIncluded</b> array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a <b>createFulfillmentPolicy</b> or <b>updateFulfillmentPolicy</b> request, it will be ignored.</span> */
831
+ regionIncluded?: components['schemas']['Region'][];
832
+ };
833
+ /** @description This type is used by the <b>returnPolicy</b> response container, a container which defines a seller's return business policy for a specific marketplace. */
834
+ ReturnPolicy: {
835
+ /** @description This container indicates which category group that the return policy applies to.<br><br><span class="tablenote"><b>Note</b>: Return business policies are not applicable to motor vehicle listings, so the <b>categoryTypes.name</b> value will always be <code>ALL_EXCLUDING_MOTORS_VEHICLES</code> for return business policies.</span> */
836
+ categoryTypes?: components['schemas']['CategoryType'][];
837
+ /** @description A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. <br><br><b>Max length</b>: 250 */
838
+ description?: string;
839
+ /** @description <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.</p> */
840
+ extendedHolidayReturnsOffered?: boolean;
841
+ /** @description This container shows the seller's international return policy settings. This container is only returned if the seller has set a separate international return policy for the business policy. International return policies are optional, even if the seller ships to international locations. If a separate international return policy is not set, all of the domestic return policy settings also apply to international orders. */
842
+ internationalOverride?: components['schemas']['InternationalReturnOverrideType'];
843
+ /** @description The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
844
+ marketplaceId?: string;
845
+ /** @description A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.<br><br><b>Max length:</b> 64 */
846
+ name?: string;
847
+ /** @description This field indicates the refund method offered by the seller. Its value will be <code>MONEY_BACK</code> unless the seller is enabled for <b>Buy online, Pickup in Store</b> or <b>Click and Collect</b>, and then it might be <code>MERCHANDISE_CREDIT</code>. Getting their money back for returned items is always an option for buyers, regardless of what the seller sets in this field. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum'>eBay API documentation</a> */
848
+ refundMethod?: string;
849
+ /** @description <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored and it is no longer returned.</p> */
850
+ restockingFeePercentage?: string;
851
+ /** @description This text-based field provides more details on seller-specified return instructions. This field is only returned if set for the return business policy.<br><p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call <a href="/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies">getReturnPolicies</a> method of the <b>Metadata API</b>. Then you will look for the <b>policyDescriptionEnabled</b> field with a value of <code>true</code> for the eBay category.</span></p><br><b>Max length</b>: 5000 (8000 for DE) */
852
+ returnInstructions?: string;
853
+ /** @description This field is only returned if the seller is willing to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay API documentation</a> */
854
+ returnMethod?: string;
855
+ /** @description This container indicates the number of calendar days that the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. <br><br>Most categories support 30-day and 60-day return periods.<br><br><span class="tablenote"><b>Note</b>: Unless the seller has set a separate international return policy through the <b>internationalOverride</b> container, this return period will be valid for domestic and international returns (if the seller ships internationally).</span> */
856
+ returnPeriod?: components['schemas']['TimeDuration'];
857
+ /** @description A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created. */
858
+ returnPolicyId?: string;
859
+ /** @description If this field is returned as <code>true</code>, the seller accepts returns. If set to <code>false</code>, the seller does not accept returns.<br><br><span class="tablenote"><strong>Note:</strong> Top-Rated sellers must accept item returns and the <b>handlingTime</b> should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see <a href="https://pages.ebay.com/help/sell/top-rated.html ">Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits</a>.</span> */
860
+ returnsAccepted?: boolean;
861
+ /** @description This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either <code>BUYER</code> or <code>SELLER</code>. <br><br>Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay API documentation</a> */
862
+ returnShippingCostPayer?: string;
863
+ };
864
+ /** @description This root container defines a seller's return business policy for a specific marketplace and category group. This type is used when creating or updating a return business policy. */
865
+ ReturnPolicyRequest: {
866
+ /** @description This container indicates which category group that the return policy applies to.<br><br><span class="tablenote"><b>Note</b>: Return business policies are not applicable to motor vehicle listings, so the <b>categoryTypes.name</b> value must be set to <code>ALL_EXCLUDING_MOTORS_VEHICLES</code> for return business policies.</span> */
867
+ categoryTypes?: components['schemas']['CategoryType'][];
868
+ /** @description A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. <br><br><b>Max length</b>: 250 */
869
+ description?: string;
870
+ /** @description <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.</p> */
871
+ extendedHolidayReturnsOffered?: boolean;
872
+ /** @description This container is used by the seller to specify a separate international return policy. If a separate international return policy is not defined by a seller, all of the domestic return policy settings will also apply to international orders. */
873
+ internationalOverride?: components['schemas']['InternationalReturnOverrideType'];
874
+ /** @description The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
875
+ marketplaceId?: string;
876
+ /** @description A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace. <br><br><b>Max length</b>: 64 */
877
+ name?: string;
878
+ /** @description This field sets the refund method to use for returned items. Its value defaults to <code>MONEY_BACK</code> if omitted, so this field is only needed for <b>Buy online, Pickup in Store</b> or <b>Click and Collect</b> items where the seller is willing to offer merchandise credit as an additional refund method to buyers. Getting their money back for returned items is always an option for buyers, regardless of what the seller sets in this field.<p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> If this field is not included in a return business policy, it will default to <code>MONEY_BACK</code>.</p> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum'>eBay API documentation</a> */
879
+ refundMethod?: string;
880
+ /** @description <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored.</p> */
881
+ restockingFeePercentage?: string;
882
+ /** @description This text-based field provides more details on seller-specified return instructions. <br><p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call <a href="/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies">getReturnPolicies</a> method of the <b>Metadata API</b>. Then you will look for the <b>policyDescriptionEnabled</b> field with a value of <code>true</code> for the eBay category.</span></p><br><b>Max length</b>: 5000 (8000 for DE) */
883
+ returnInstructions?: string;
884
+ /** @description This field can be used if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay API documentation</a> */
885
+ returnMethod?: string;
886
+ /** @description This container is used to specify the number of days that the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. <br><br>You must set the value to one that's accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods. <p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See <a href="/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html" target="_blank">Support for easy returns in Parts and Accessories</a> for details.</span></p> <br>For a definitive list of return periods for one or more categories, call <a href="/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies">getReturnPolicies</a> method of the <b>Metadata API</b>.<br><br>The return period is set using the <b>TimeDuration</b> type, where you set <b>unit</b> to <code>DAY</code> and <b>value</b> to either <code>30</code> or <code>60</code> (or other value, as appropriate). <br><br>Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours. <br><br><i>Required if </i> <b>returnsAccepted</b> is set to <code>true</code>. */
887
+ returnPeriod?: components['schemas']['TimeDuration'];
888
+ /** @description If set to <code>true</code>, the seller accepts returns. If set to <code>false</code>, the seller does not accept returns.<br><p><span class="tablenote"><strong>Note:</strong>Top-Rated sellers must accept item returns and the <b>handlingTime</b> should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see <a href="http://pages.ebay.com/help/sell/top-rated.html ">Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits</a>.</span></p> */
889
+ returnsAccepted?: boolean;
890
+ /** @description This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either <code>BUYER</code> or <code>SELLER</code>. <p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See <a href="/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html" target="_blank">Support for easy returns in Parts and Accessories</a> for details.</span></p> <br>Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. <br><br>This field is conditionally required if <b>returnsAccepted</b> is set to <code>true</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay API documentation</a> */
891
+ returnShippingCostPayer?: string;
892
+ };
893
+ /** @description The response payload for the <b>getReturnPolicies</b> method. <br><br><span class="tablenote"><b>Note</b>: Pagination has not yet been enabled for <b>getReturnPolicies</b>, so all of the pagination-related fields are for future use.</span> */
894
+ ReturnPolicyResponse: {
895
+ /** @description This field is for future use. */
896
+ href?: string;
897
+ /**
898
+ * Format: int32
899
+ * @description This field is for future use.
900
+ */
901
+ limit?: number;
902
+ /** @description This field is for future use. */
903
+ next?: string;
904
+ /**
905
+ * Format: int32
906
+ * @description This field is for future use.
907
+ */
908
+ offset?: number;
909
+ /** @description This field is for future use. */
910
+ prev?: string;
911
+ /** @description A list of all of the seller's return business policies defined for the specified marketplace. This array will be returned as empty if no return business policies are defined for the specified marketplace. */
912
+ returnPolicies?: components['schemas']['ReturnPolicy'][];
913
+ /**
914
+ * Format: int32
915
+ * @description The total number of return business policies retrieved in the result set. <br><br>If no return business policies are defined for the specified marketplace, this field is returned with a value of <code>0</code>.
916
+ */
917
+ total?: number;
918
+ };
919
+ /** @description This type is used to provide sales tax settings for a specific tax jurisdiction. */
920
+ SalesTax: {
921
+ /** @description The country code enumeration value identifies the country to which this sales tax rate applies.<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> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'>eBay API documentation</a> */
922
+ countryCode?: string;
923
+ /** @description A unique ID that identifies the sales tax jurisdiction to which the sales tax rate applies.<br><br><span class="tablenote"><b>Note:</b> When the returned <code>countryCode</code> is <code>US</code>, the only supported return values for <code>salesTaxJurisdictionId</code> 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></span> */
924
+ salesTaxJurisdictionId?: string;
925
+ /** @description The sales tax rate that will be applied to sales price. The <b>shippingAndHandlingTaxed</b> value will indicate whether or not sales tax is also applied to shipping and handling charges<br><br>Although it is a string, a percentage value is returned here, such as <code>7.75</code> */
926
+ salesTaxPercentage?: string;
927
+ /** @description If returned as <code>true</code>, sales tax is also applied to shipping and handling charges, and not just the total sales price of the order. */
928
+ shippingAndHandlingTaxed?: boolean;
929
+ };
930
+ /** @description This type is used by the base request of the <b>createOrReplaceSalesTax</b>. */
931
+ SalesTaxBase: {
932
+ /** @description This field is used to set the sales tax rate for the tax jurisdiction set in the call URI. When applicable to an order, this sales tax rate will be applied to sales price. The <b>shippingAndHandlingTaxed</b> value will indicate whether or not sales tax is also applied to shipping and handling charges<br><br>Although it is a string, a percentage value is set here, such as <code>7.75</code>. */
933
+ salesTaxPercentage?: string;
934
+ /** @description This field is set to <code>true</code> if the seller wishes to apply sales tax to shipping and handling charges, and not just the total sales price of the order. Otherwise, this field's value should be set to <code>false</code>. */
935
+ shippingAndHandlingTaxed?: boolean;
936
+ };
937
+ SalesTaxInput: {
938
+ /** @description This 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> code of the country for which a sales-tax table entry is to be created or updated.<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> */
939
+ countryCode?: string;
940
+ /** @description This parameter specifies the ID of the tax jurisdiction for which a sales-tax table entry is to be created or updated.<br><br>Valid jurisdiction IDs can be retrieved using the <a href="/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions" target="_blank ">getSalesTaxJurisdiction</a> method of the Metadata API.<br><br><span class="tablenote"><b>Note:</b> When <code>countryCode</code> is set to <code>US</code>, the only supported values for <code>jurisdictionId</code> 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</code> (Palau)</li><li><code>VI</code> (US Virgin Islands)</li></ul></span> */
941
+ salesTaxJurisdictionId?: string;
942
+ /** @description This parameter specifies the sales tax rate for the specified <b>salesTaxJurisdictionId</b>. When applicable to an order, this sales tax rate will be applied to the sales price. The <b>shippingAndHandlingTaxed</b> value indicates whether or not sales tax is also applied to shipping and handling charges<br><br>Although it is a string, a percentage value is set here, such as <code>7.75</code>. */
943
+ salesTaxPercentage?: string;
944
+ /** @description This parameter is set to <code>true</code> if the seller wishes to apply sales tax to shipping and handling charges and not just the total sales price of an order. Otherwise, this parameter's value should be set to <code>false</code>. */
945
+ shippingAndHandlingTaxed?: boolean;
946
+ };
947
+ /** @description This type is used by the root response of the <b>getSalesTaxes</b> method. */
948
+ SalesTaxes: {
949
+ /** @description An array of one or more sales-tax rate entries for a specified country.<br><br>If no sales-tax rate entries are set up, no response payload is returned, but an HTTP status code of <code>204 No Content</code> is returned. */
950
+ salesTaxes?: components['schemas']['SalesTax'][];
951
+ };
952
+ /** @description The base response of the <b>getAdvertisingEligibility</b> method that contains the seller eligibility information for one or more advertising programs. */
953
+ SellerEligibilityMultiProgramResponse: {
954
+ /** @description An array of response fields that define the seller eligibility for eBay advertising programs. */
955
+ advertisingEligibility?: components['schemas']['SellerEligibilityResponse'][];
956
+ };
957
+ /** @description A type that is used to provide the seller's eligibility status for an eBay advertising program. */
958
+ SellerEligibilityResponse: {
959
+ /** @description The eBay advertising program for which a seller may be eligible. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/plser:AdvertisingProgramEnum'>eBay API documentation</a> */
960
+ programType?: string;
961
+ /** @description The reason why a seller is ineligible for the specified eBay advertising program.<br /><br />This field is only returned if the seller is ineligible for the eBay advertising program. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/plser:SellerIneligibleReasonEnum'>eBay API documentation</a> */
962
+ reason?: string;
963
+ /** @description The seller eligibility status for the specified eBay advertising program. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/cmlib:SellerEligibilityEnum'>eBay API documentation</a> */
964
+ status?: string;
965
+ };
966
+ /** @description Type used by the <b>sellingLimit</b> container, a container that lists the monthly cap for the quantity of items sold and total sales amount allowed for the seller's account. */
967
+ SellingLimit: {
968
+ /** @description This container shows the monthly cap for total sales amount allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total sales amount. */
969
+ amount?: components['schemas']['Amount'];
970
+ /**
971
+ * Format: int32
972
+ * @description This field shows the monthly cap for total quantity sold allowed for the seller's account. This field may not be returned if a seller does not have a monthly cap for total quantity sold.
973
+ */
974
+ quantity?: number;
975
+ };
976
+ /** @description This type is used by the base response of the <b>getPrivileges</b> method. */
977
+ SellingPrivileges: {
978
+ /** @description If this field is returned as <code>true</code>, the seller's registration is completed. If this field is returned as <code>false</code>, the registration process is not complete. */
979
+ sellerRegistrationCompleted?: boolean;
980
+ /** @description This container lists the monthly cap for the quantity of items sold and total sales amount allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total quantity sold and total sales amount. <p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>The selling limit value returned in <b>getPrivileges</b> may vary slightly from the value displayed in Seller Hub. The value in Seller Hub is an abbreviated figure, where rounding is applied.</span></p> */
981
+ sellingLimit?: components['schemas']['SellingLimit'];
982
+ };
983
+ /** @description Complex type that that gets populated with a response containing a fulfillment policy. */
984
+ SetFulfillmentPolicyResponse: {
985
+ /** @description This container indicates whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. */
986
+ categoryTypes?: components['schemas']['CategoryType'][];
987
+ /** @description A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. <br><br><b>Max length</b>: 250 */
988
+ description?: string;
989
+ /** @description If returned as <code>true</code>, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs. */
990
+ freightShipping?: boolean;
991
+ /** @description A unique eBay-assigned ID for a fulfillment business policy. This ID is generated when the policy is created. */
992
+ fulfillmentPolicyId?: string;
993
+ /** @description <span class="tablenote"><b>Note</b>: This field is only applicable for the eBay United Kingdom marketplace (<code>EBAY_GB</code>).</span><br>This field is included and set to <code>true</code> if the seller wants to use the Global Shipping Program for international shipments. See the <a href="https://pages.ebay.com/help/sell/shipping-globally.html ">Global Shipping Program</a> help topic for more details and requirements on the Global Shipping Program.<br><br>A seller can use a combination of the Global Shipping Program and other international shipping services. <br><br>If set to <code>false</code> or if the field is omitted, the seller has to manually specifying individual international shipping services (if the seller ships internationally), as described in <a href="https://developer.ebay.com/api-docs/sell/static/seller-accounts/ht_shipping-worldwide.html ">Setting up worldwide shipping</a>. <br><br>Sellers opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.<br><br>eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy.</span> */
994
+ globalShipping?: boolean;
995
+ /** @description Specifies the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order. <p>If only local pickup or freight shipping is available for the item, this container may not get returned.</p> */
996
+ handlingTime?: components['schemas']['TimeDuration'];
997
+ /** @description If returned as <code>true</code>, local pickup is available for items using this policy. */
998
+ localPickup?: boolean;
999
+ /** @description The ID of the eBay marketplace to which this fulfillment business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
1000
+ marketplaceId?: string;
1001
+ /** @description A seller-defined name for this fulfillment business policy. <br><br><b>Max length</b>: 64 */
1002
+ name?: string;
1003
+ /** @description If returned as <code>true</code>, the seller offers the "Click and Collect" option. <br><br>Currently, "Click and Collect" is available only to large retail merchants the eBay AU, UK, DE, FR, and IT marketplaces. */
1004
+ pickupDropOff?: boolean;
1005
+ /** @description This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate <b>ShippingOption</b> object covers domestic shipping service options and international shipping service options (if the seller ships to international locations). <br><br>The <b>optionType</b> field indicates whether the <b>ShippingOption</b> object applies to domestic or international shipping, and the <b>costType</b> field indicates whether flat-rate shipping or calculated shipping will be used. <p>A separate <b>ShippingServices</b> object is used to specify cost and other details for every available domestic and international shipping service option. </p> */
1006
+ shippingOptions?: components['schemas']['ShippingOption'][];
1007
+ /** @description This container consists of the <b>regionIncluded</b> and <b>regionExcluded</b> containers, which define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy. */
1008
+ shipToLocations?: components['schemas']['RegionSet'];
1009
+ /** @description An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty. */
1010
+ warnings?: components['schemas']['Error'][];
1011
+ };
1012
+ /** @description Complex type that that gets populated with a response containing a payment policy. */
1013
+ SetPaymentPolicyResponse: {
1014
+ /** @description This container indicates whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. */
1015
+ categoryTypes?: components['schemas']['CategoryType'][];
1016
+ /** @description This container is only returned if the seller just created or updated a motor vehicles payment business policy and requires buyers to pay an initial deposit after they commit to buying a motor vehicle. */
1017
+ deposit?: components['schemas']['Deposit'];
1018
+ /** @description A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. <br><br><b>Max length</b>: 250 */
1019
+ description?: string;
1020
+ /** @description The number of days (after the buyer commits to buy) that a buyer has to pay the remaining balance of a motor vehicle transaction. Sellers can set this value to 3, 7, 10, or 14 days.<p class="tablenote"><b>Note:</b> This value is always returned if <b>categoryTypes</b> is set to <code>MOTORS_VEHICLES</code>.</p> */
1021
+ fullPaymentDueIn?: components['schemas']['TimeDuration'];
1022
+ /** @description The value returned in this field will reflect the value set by the seller in the <b>immediatePay</b> request field. A value of <code>true</code> indicates that immediate payment is required from the buyer for: <ul><li>A fixed-price item</li><li>An auction item where the buyer is using the 'Buy it Now' option</li><li>A deposit for a motor vehicle listing</li></ul><br>It is possible for the seller to set this field as <code>true</code> in the payment business policy, but it will not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyer purchases that involve the Best Offer feature, or for transactions that happen offline between the buyer and seller. */
1023
+ immediatePay?: boolean;
1024
+ /** @description The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
1025
+ marketplaceId?: string;
1026
+ /** @description A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.<br><br><b>Max length:</b> 64 */
1027
+ name?: string;
1028
+ /** @description <p class="tablenote"><b>Note:</b> NO LONGER SUPPORTED. Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy.</p>A free-form string field that allows sellers to add detailed payment instructions to their listings. */
1029
+ paymentInstructions?: string;
1030
+ /** @description This array shows the available payment methods that the seller has set for the payment business policy.<br><br>Sellers do not have to specify any electronic payment methods for listings, so this array will often be returned empty unless the payment business policy is intended for motor vehicle listings or other items in categories where offline payments are required or supported. */
1031
+ paymentMethods?: components['schemas']['PaymentMethod'][];
1032
+ /** @description A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created. */
1033
+ paymentPolicyId?: string;
1034
+ /** @description An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty. */
1035
+ warnings?: components['schemas']['Error'][];
1036
+ };
1037
+ /** @description A complex type that is populated with a response containing a return policies. */
1038
+ SetReturnPolicyResponse: {
1039
+ /** @description This field always returns <code>ALL_EXCLUDING_MOTORS_VEHICLES</code> for return business policies, since return business policies are not applicable to motor vehicle listings. */
1040
+ categoryTypes?: components['schemas']['CategoryType'][];
1041
+ /** @description A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. <br><br><b>Max length</b>: 250 */
1042
+ description?: string;
1043
+ /** @description <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer supports extended holiday returns. This field should no longer be returned.</p> */
1044
+ extendedHolidayReturnsOffered?: boolean;
1045
+ /** @description This container is used by the seller to specify a separate international return policy, and will only be returned if the seller has set a separate return policy for international orders. If a separate international return policy is not defined by a seller, all of the domestic return policy settings will also apply to international orders. */
1046
+ internationalOverride?: components['schemas']['InternationalReturnOverrideType'];
1047
+ /** @description The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
1048
+ marketplaceId?: string;
1049
+ /** @description A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.<br><br><b>Max length:</b> 64 */
1050
+ name?: string;
1051
+ /** @description If a seller indicates that they will accept buyer returns, this value will be <code>MONEY_BACK</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum'>eBay API documentation</a> */
1052
+ refundMethod?: string;
1053
+ /** @description <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns.</p> */
1054
+ restockingFeePercentage?: string;
1055
+ /** @description This text-based field provides more details on seller-specified return instructions. <br><p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call <a href="/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies">getReturnPolicies</a> method of the <b>Metadata API</b>. Then you will look for the <b>policyDescriptionEnabled</b> field with a value of <code>true</code> for the eBay category.</span></p><br><b>Max length</b>: 5000 (8000 for DE) */
1056
+ returnInstructions?: string;
1057
+ /** @description This field will be returned if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay API documentation</a> */
1058
+ returnMethod?: string;
1059
+ /** @description This container specifies the amount of days that the buyer has to return the item after receiving it. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. This container will be returned unless the business policy states that the seller does not accept returns. <br><p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See <a href="/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html" target="_blank">Support for easy returns in Parts and Accessories</a> for details.</span></p> */
1060
+ returnPeriod?: components['schemas']['TimeDuration'];
1061
+ /** @description A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created. */
1062
+ returnPolicyId?: string;
1063
+ /** @description If set to <code>true</code>, the seller accepts returns. If set to <code>false</code>, this field indicates that the seller does not accept returns. */
1064
+ returnsAccepted?: boolean;
1065
+ /** @description This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either <code>BUYER</code> or <code>SELLER</code>. <p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See <a href="/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html" target="_blank">Support for easy returns in Parts and Accessories</a> for details.</span></p> <br>Note that the seller is always responsible for return shipping costs for SNAD-related issues. <br><br>This container will be returned unless the business policy states that the seller does not accept returns. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay API documentation</a> */
1066
+ returnShippingCostPayer?: string;
1067
+ /** @description An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty. */
1068
+ warnings?: components['schemas']['Error'][];
1069
+ };
1070
+ /** @description This type is used by the <b>shippingOptions</b> array, which is used to provide detailed information on the domestic and international shipping options available for the policy. A separate <b>ShippingOption</b> object covers domestic shipping service options and international shipping service options (if the seller ships to international locations). */
1071
+ ShippingOption: {
1072
+ /** @description This field defines whether the shipping cost model is <code>FLAT_RATE</code> (the same rate for all buyers, or buyers within a region if shipping rate tables are used) or <code>CALCULATED</code> (the shipping rate varies by the ship-to location and size and weight of the package). <br><br>This field is conditionally required if any shipping service options are specified (domestic and/or international). For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingCostTypeEnum'>eBay API documentation</a> */
1073
+ costType?: string;
1074
+ /** @description This field has been deprecated. <br><br>Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies. */
1075
+ insuranceFee?: components['schemas']['Amount'];
1076
+ /** @description This field has been deprecated. <br><br>Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies. */
1077
+ insuranceOffered?: boolean;
1078
+ /** @description This field is used to indicate if the corresponding shipping service options (under <b>shippingServices</b> array) are domestic or international shipping service options. This field is conditionally required if any shipping service options are specified (domestic and/or international). For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingOptionTypeEnum'>eBay API documentation</a> */
1079
+ optionType?: string;
1080
+ /** @description This container is used if the seller adds handling charges to domestic and/or international shipments. <br><br>Sellers can not specify any domestic handling charges if they offered 'free shipping' in the policy.<br><br>This container will only be returned if set for the policy. */
1081
+ packageHandlingCost?: components['schemas']['Amount'];
1082
+ /** @description This field is used if the seller wants to associate a domestic or international shipping rate table to the fulfillment business policy. The <a href="/api-docs/sell/account/resources/rate_table/methods/getRateTables">getRateTables</a> method can be used to retrieve shipping rate table IDs.<br><br>With domestic and international shipping rate tables, the seller can set different shipping costs based on shipping regions and shipping speed/level of service (one-day, expedited, standard, economy). There are also options to add additional per-weight and handling charges.<br><br>Sellers need to be careful that shipping rate tables match the corresponding shipping service options. In other words, a domestic shipping rate table must not be specified in the same container where international shipping service options are being specified, and vice versa, and the shipping speed/level of service of the provided shipping service options should match the shipping speed/level of service options that are defined in the shipping rate tables. <br><br>For example, if the corresponding shipping rate table defines costs for one-day shipping services, there should be at least one one-day shipping service option specified under the <b>shippingServices</b> array.<br><br>This field is returned if set. */
1083
+ rateTableId?: string;
1084
+ /** @description This field is the unique identifier of a seller's domestic or international shipping discount profile. If a buyer satisfies the requirements of the discount rule, this buyer will receive a shipping discount for the order. <br><br>The seller can create and manage shipping discount profiles using (Get/Set) <b>ShippingDiscountProfiles</b> calls in the <b>Trading API</b> or through the <b>Shipping Preferences</b> in <b>My eBay</b>. */
1085
+ shippingDiscountProfileId?: string;
1086
+ /** @description This boolean indicates whether or not the seller has set up a promotional shipping discount that will be available to buyers who satisfy the requirements of the shipping discount rule. <br><br>The seller can create and manage shipping promotional discounts using (Get/Set) <b>ShippingDiscountProfiles</b> calls in the <b>Trading API</b> or through the <b>Shipping Preferences</b> in <b>My eBay</b>. */
1087
+ shippingPromotionOffered?: boolean;
1088
+ /** @description This array consists of the domestic or international shipping services options that are defined for the policy. The shipping service options defined under this array should match what is set in the corresponding <b>shippingOptions.optionType</b> field (which controls whether domestic or international shipping service options are being defined). If a shipping rate table is being used, the specified shipping service options should also match the shipping rate table settings (domestic or international, shipping speed/level of service, etc.) <br><br>Sellers can specify up to four domestic shipping services and up to five international shipping service options by using separate <b>shippingService</b> containers for each. If the seller is using the Global Shipping Program as an international option, only a total of four international shipping service options (including GSP) can be offered. <br><br> See <a href="/api-docs/sell/static/seller-accounts/ht_shipping-setting-shipping-carrier-and-service-values.html" target="_blank">How to set up shipping carrier and shipping service values</a>. <br><br>To use the eBay standard envelope service (eSE), see <a href="/api-docs/sell/static/seller-accounts/using-the-ebay-standard-envelope-service.html" target="_blank">Using eBay standard envelope (eSE) service</a>.<br><br>This array is conditionally required if the seller is offering one or more domestic and/or international shipping service options. */
1089
+ shippingServices?: components['schemas']['ShippingService'][];
1090
+ };
1091
+ /** @description This type is used by the <b>shippingServices</b> array, an array that provides details about every domestic and international shipping service option that is defined for the policy. */
1092
+ ShippingService: {
1093
+ /** @description This container is used by the seller to cover the use case when a single buyer purchases multiple quantities of the same line item. This cost cannot exceed the corresponding <b>shippingCost</b> value. A seller will generally set this field when he/she wants to pass on a shipping discount to the buyer if that buyer purchases multiple quantities of a line item. <br><br>The seller can ship multiple quantities of the line item in the same package and pass on the shipping savings to the buyer.<br><br>If this field is not set, and a buyer purchases multiple quantities of an item, the seller can technically charge the same cost set in the <b>shippingCost</b> container for each individual item, but in general, it behooves both the seller and the buyer (and saves both parties money) if they discuss combined shipping.<br><br>This field is not applicable to auction listings or single-quantity, fixed-price listings.<br><br>This container is returned if set. */
1094
+ additionalShippingCost?: components['schemas']['Amount'];
1095
+ /** @description This field should be included and set to <code>true</code> for a motor vehicle listing if it will be the buyer's responsibility to pick up the purchased motor vehicle after full payment is made. <br><br>This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle. <br><br>This field is returned if set.<br><br><b>Default</b>: false */
1096
+ buyerResponsibleForPickup?: boolean;
1097
+ /** @description This field should be included and set to <code>true</code> for a motor vehicle listing if it will be the buyer's responsibility to arrange for shipment of a motor vehicle. <br><br>This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle. <br><br>This field is returned if set.<br><br><b>Default</b>: false */
1098
+ buyerResponsibleForShipping?: boolean;
1099
+ /** @description This field is included and set to <code>true</code> if the seller offers a free domestic shipping option to the buyer. <br><br>This field can only be included and set to <code>true</code> for the first domestic shipping service option specified in the <b>shippingServices</b> array (it is ignored if set for subsequent shipping services or for any international shipping service option). <br><br>The first specified shipping service option has a <b>sortOrder</b> value of <code>1</code> or if the <b>sortOrderId</b> field is not used, it is the shipping service option that's specified first in the <b>shippingServices</b> array.<br><br>This container is returned if set. */
1100
+ freeShipping?: boolean;
1101
+ /** @description This field sets/indicates the shipping carrier, such as <code>USPS</code>, <code>FedEx</code>, or <code>UPS</code>. Although this field uses the <b>string</b> type, the seller must pass in a pre-defined enumeration value here. <br><br>For a full list of shipping carrier enum values for a specified eBay marketplace, the <a href="/devzone/xml/docs/reference/ebay/GeteBayDetails.html">GeteBayDetails</a> call of the <b>Trading API</b> can be used, and the <b>DetailName</b> field's value should be set to <code>ShippingCarrierDetails</code>. The enum values for each shipping carriers can be found in each <b>ShippingCarrierDetails.ShippingCarrier</b> field in the response payload.<br><br> This field is actually optional, as the shipping carrier is also tied into the <b>shippingServiceCode</b> enum value, and that field is required for every specified shipping service option.<br><br>This field is returned if set. */
1102
+ shippingCarrierCode?: string;
1103
+ /** @description This container is used to set the shipping cost to ship one item using the corresponding shipping service option. This container is conditionally required if the seller is using flat-rate shipping and is not using a domestic or international shipping rate table. <br><br>This container is not necessary for calculated shipping, since eBay will calculate the shipping cost and display it in the View Item page based off of the potential buyer's ship-to location.<br><br>This value is automatically set to <code>0.0</code> for the first specified domestic shipping service option and if the corresponding <b>freeShipping</b> field is set to <code>true</code>. <br><br>This container is returned if set for the policy. */
1104
+ shippingCost?: components['schemas']['Amount'];
1105
+ /** @description This field sets/indicates the domestic or international shipping service option, such as <code>USPSPriority</code>, <code>FedEx2Day</code>, or <code>UPS3rdDay</code>. Although this field uses the <b>string</b> type, the seller must pass in a pre-defined enumeration value here. <br><br>For a full list of shipping service option enum values for a specified eBay marketplace, the <a href="/devzone/xml/docs/reference/ebay/GeteBayDetails.html">GeteBayDetails</a> call of the <b>Trading API</b> can be used, and the <b>DetailName</b> field's value should be set to <code>ShippingServiceDetails</code>. <br><br>The enum values for each shipping service option can be found in each <b>ShippingServiceDetails.ShippingService</b> field in the response payload. The seller must make sure that the shipping service option is still valid, which is indicated by a <code>true</code> value in the corresponding <b>ValidForSellingFlow</b> boolean field. International shipping service options are typically returned at the top of the response payload, and are indicated by an <b>InternationalService</b> boolean field that reads <code>true</code>. <br><br>The <b>InternationalService</b> boolean field is not returned at all for domestic shipping service options. <br><br> This field is required for every specified shipping service option. */
1106
+ shippingServiceCode?: string;
1107
+ /** @description This container is used to set the ship-to locations applicable to the corresponding shipping service option. Although the <b>regionExcluded</b> container is defined for <b>RegionSet</b> type and could technically be used here, it is recommened that only the <b>regionIncluded</b> container be used at the shipping service level. The excluded shipping regions (if any) can instead be set up in the top-level <b>regionExcluded</b> container. <br><br>The <b>regionIncluded</b> and <b>regionExcluded</b> containers define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy.<br><br>To retrieve the valid geographical shipping region values, two-digit country values, or special domestic regions for an eBay marketplace, call <a href="/devzone/xml/docs/reference/ebay/GeteBayDetails.html">GeteBayDetails</a> with <b>DetailName</b> value set to <code>ExcludeShippingLocationDetails</code>, then review the <b>ExcludeShippingLocationDetails</b> containers in the response for the strings you use in the <b>regionIncluded.regionName</b> field. <ul><li>For valid geographical region names, look for the <code>ExcludeShippingLocationDetails</code> containers in the <b>GeteBayDetails</b> response where the <b>Region</b> value is <code>Worldwide</code>, and the valid values will be shown in the corresponding <b>Location</b> fields.</li> <li>For valid two-digit country codes, look for <code>ExcludeShippingLocationDetails</code> in the <b>GeteBayDetails</b> response where the <b>Region</b> value is one of the defined geographical regions, and the valid values will be shown in the corresponding <b>Location</b> fields. Alternatively, you can find the two-digit country code values in the <a href="/api-docs/sell/account/types/ba:CountryCodeEnum">CountryCodeEnum</a> type definition.</li> <li>For valid domestic region values, look for <code>ExcludeShippingLocationDetails</code> in the <b>GeteBayDetails</b> response where the <b>Region</b> value is either <code>Domestic Location</code> or <code>Additional Locations</code>, and the valid values will be shown in the corresponding <b>Location</b> fields.</li></ul> The <code>STATE_OR_PROVINCE</code> region type is only applicable to the US and Canada, and valid values for US states are the same <a href="https://about.usps.com/who-we-are/postal-history/state-abbreviations.htm ">two-digit abbreviations</a> used by the United States Postal Service, and valid values for Canadian provinces and territories are the same <a href="https://www.canadapost-postescanada.ca/cpc/en/support/articles/addressing-guidelines/symbols-and-abbreviations.page ">two-digit abbreviations</a> used by the Canada Post. */
1108
+ shipToLocations?: components['schemas']['RegionSet'];
1109
+ /**
1110
+ * Format: int32
1111
+ * @description The integer value set in this field controls the order of the corresponding domestic or international shipping service option in the View Item and Checkout pages. <br><br>If the <b>sortOrder</b> field is not supplied, the order of domestic and international shipping service options is determined by the order in which they are listed in the API call. <br><br><b>Min</b>: 1. <b>Max</b>: 4 (for domestic shipping service) or 5 (for international shipping service).
1112
+ */
1113
+ sortOrder?: number;
1114
+ /** @description <span class="tablenote"> <strong>Note:</strong> DO NOT USE THIS FIELD. Shipping surcharges for domestic shipping service options can no longer be set with fulfillment business policies, except through shipping rate tables. <br><br>To do this, a seller would set up a surcharge-based shipping rate table and specify the surcharge in that table. Then, the seller would need to associate this shipping rate table to the fulfillment business policy by specifying the unique ID of the shipping rate table through the <b>shippingOptions.rateTableId</b> field. </span>Shipping surcharges cannot be applied at all to international shipping service options. */
1115
+ surcharge?: components['schemas']['Amount'];
1116
+ };
1117
+ /** @description This type is used by the <strong>getSubscription</strong> response container, which defines the subscription types and levels for the seller account. */
1118
+ Subscription: {
1119
+ /** @description The marketplace with which the subscription is associated. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a> */
1120
+ marketplaceId?: string;
1121
+ /** @description The subscription ID. */
1122
+ subscriptionId?: string;
1123
+ /** @description The subscription level. For example, subscription levels for an eBay store include Starter, Basic, Featured, Anchor, and Enterprise levels. */
1124
+ subscriptionLevel?: string;
1125
+ /** @description The kind of entity with which the subscription is associated, such as an eBay store. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:SubscriptionTypeEnum'>eBay API documentation</a> */
1126
+ subscriptionType?: string;
1127
+ /** @description The term of the subscription plan (typically in months). */
1128
+ term?: components['schemas']['TimeDuration'];
1129
+ };
1130
+ /** @description This type is used by the response payload for the <b>getSubscription</b> method.<br><br><span class="tablenote"><b>Note</b>: Pagination has not yet been enabled for <b>getSubscription</b>, so all of the pagination-related fields are for future use.</span> */
1131
+ SubscriptionResponse: {
1132
+ /** @description This field is for future use. */
1133
+ href?: string;
1134
+ /**
1135
+ * Format: int32
1136
+ * @description This field is for future use.
1137
+ */
1138
+ limit?: number;
1139
+ /** @description This field is for future use. */
1140
+ next?: string;
1141
+ /** @description An array of subscriptions associated with the seller account. */
1142
+ subscriptions?: components['schemas']['Subscription'][];
1143
+ /**
1144
+ * Format: int32
1145
+ * @description The total number of subscriptions displayed on the current page of results.
1146
+ */
1147
+ total?: number;
1148
+ };
1149
+ /** @description A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned. */
1150
+ TimeDuration: {
1151
+ /** @description These enum values represent the time measurement unit, such as <code>DAY</code>. 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>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/account/types/ba:TimeDurationUnitEnum'>eBay API documentation</a> */
1152
+ unit?: string;
1153
+ /**
1154
+ * Format: int32
1155
+ * @description An integer that represents an amount of time, as measured by the time-measurement unit specified in the <b>unit</b> field.
1156
+ */
1157
+ value?: number;
1158
+ };
1159
+ /** @description This container stores the array of sales-tax table entries that have been created or updated. */
1160
+ UpdatedSalesTaxEntry: {
1161
+ /** @description The two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> code of the country associated with the sales-tax table entry. */
1162
+ countryCode?: string;
1163
+ /** @description The ID of the tax jurisdiction associated with the sales-tax table entry. */
1164
+ jurisdictionId?: string;
1165
+ /**
1166
+ * Format: int32
1167
+ * @description The HTTP status code for the call.<br><br><span class="tablenote"><b>Note:</b> The system returns one HTTP status code regardless of the number of sales-tax table entries provided. Therefore, the same HTTP <code>statusCode</code> will be listed for all sales-tax table entries returned in the payload.</span>
1168
+ */
1169
+ statusCode?: number;
1170
+ };
1171
+ /** @description This type is used to return the list of new and updated sales-tax table entries. */
1172
+ UpdatedSalesTaxResponse: {
1173
+ /** @description The array of new and updated sales-tax table entries. */
1174
+ updatedSalesTaxEntries?: components['schemas']['UpdatedSalesTaxEntry'][];
1175
+ };
1176
+ };
1177
+ responses: never;
1178
+ parameters: never;
1179
+ requestBodies: never;
1180
+ headers: never;
1181
+ pathItems: never;
1182
+ }
1183
+ export type $defs = Record<string, never>;
1184
+ export interface operations {
1185
+ getCustomPolicies: {
1186
+ parameters: {
1187
+ query?: {
1188
+ /** @description This query parameter specifies the type of custom policies to be returned.<br><br>Multiple policy types may be requested in a single call by providing a comma-delimited set of all policy types to be returned.<br><br><span class="tablenote"><strong>Note:</strong> Omitting this query parameter from a request will also return policies of all policy types.</span><br> See the <a href="/api-docs/sell/account/types/api:CustomPolicyTypeEnum" target="_blank ">CustomPolicyTypeEnum</a> type for a list of supported values. */
1189
+ policy_types?: string;
1190
+ };
1191
+ header?: never;
1192
+ path?: never;
1193
+ cookie?: never;
1194
+ };
1195
+ requestBody?: never;
1196
+ responses: {
1197
+ /** @description Success */
1198
+ 200: {
1199
+ headers: Record<string, unknown>;
1200
+ content: {
1201
+ 'application/json': components['schemas']['CustomPolicyResponse'];
1202
+ };
1203
+ };
1204
+ /** @description Bad Request */
1205
+ 400: {
1206
+ headers: Record<string, unknown>;
1207
+ content?: never;
1208
+ };
1209
+ /** @description Internal Server Error */
1210
+ 500: {
1211
+ headers: Record<string, unknown>;
1212
+ content?: never;
1213
+ };
1214
+ };
1215
+ };
1216
+ createCustomPolicy: {
1217
+ parameters: {
1218
+ query?: never;
1219
+ header: {
1220
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
1221
+ 'Content-Type': string;
1222
+ };
1223
+ path?: never;
1224
+ cookie?: never;
1225
+ };
1226
+ /** @description Request to create a new Custom Policy. */
1227
+ requestBody: {
1228
+ content: {
1229
+ 'application/json': components['schemas']['CustomPolicyCreateRequest'];
1230
+ };
1231
+ };
1232
+ responses: {
1233
+ /** @description Created */
1234
+ 201: {
1235
+ headers: {
1236
+ Location?: string;
1237
+ [name: string]: unknown;
1238
+ };
1239
+ content: {
1240
+ 'application/json': Record<string, never>;
1241
+ };
1242
+ };
1243
+ /** @description Bad Request */
1244
+ 400: {
1245
+ headers: Record<string, unknown>;
1246
+ content?: never;
1247
+ };
1248
+ /** @description Policy Name already used/ Maximum no of policies per site reached */
1249
+ 409: {
1250
+ headers: Record<string, unknown>;
1251
+ content?: never;
1252
+ };
1253
+ /** @description Internal Server Error */
1254
+ 500: {
1255
+ headers: Record<string, unknown>;
1256
+ content?: never;
1257
+ };
1258
+ };
1259
+ };
1260
+ getCustomPolicy: {
1261
+ parameters: {
1262
+ query?: never;
1263
+ header?: never;
1264
+ path: {
1265
+ /** @description This path parameter is the unique identifier of the custom policy to retrieve.<br><br> This ID can be retrieved for a custom policy by using the <a href="/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicies" target="_blank ">getCustomPolicies</a> method. */
1266
+ custom_policy_id: string;
1267
+ };
1268
+ cookie?: never;
1269
+ };
1270
+ requestBody?: never;
1271
+ responses: {
1272
+ /** @description Success */
1273
+ 200: {
1274
+ headers: Record<string, unknown>;
1275
+ content: {
1276
+ 'application/json': components['schemas']['CustomPolicy'];
1277
+ };
1278
+ };
1279
+ /** @description Bad Request */
1280
+ 400: {
1281
+ headers: Record<string, unknown>;
1282
+ content?: never;
1283
+ };
1284
+ /** @description Not Found */
1285
+ 404: {
1286
+ headers: Record<string, unknown>;
1287
+ content?: never;
1288
+ };
1289
+ /** @description Internal Server Error */
1290
+ 500: {
1291
+ headers: Record<string, unknown>;
1292
+ content?: never;
1293
+ };
1294
+ };
1295
+ };
1296
+ updateCustomPolicy: {
1297
+ parameters: {
1298
+ query?: never;
1299
+ header: {
1300
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
1301
+ 'Content-Type': string;
1302
+ };
1303
+ path: {
1304
+ /** @description This path parameter is the unique identifier of the custom policy to update.<br><br><span class="tablenote"><b>Note:</b> A list of custom policies defined for a seller's account that includes this ID can be retrieved by calling the <a href="/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicies" target="_blank ">getCustomPolicies</a> method.</span> */
1305
+ custom_policy_id: string;
1306
+ };
1307
+ cookie?: never;
1308
+ };
1309
+ /** @description Request to update a current custom policy. */
1310
+ requestBody: {
1311
+ content: {
1312
+ 'application/json': components['schemas']['CustomPolicyRequest'];
1313
+ };
1314
+ };
1315
+ responses: {
1316
+ /** @description No Content */
1317
+ 204: {
1318
+ headers: Record<string, unknown>;
1319
+ content?: never;
1320
+ };
1321
+ /** @description Bad Request */
1322
+ 400: {
1323
+ headers: Record<string, unknown>;
1324
+ content?: never;
1325
+ };
1326
+ /** @description Not Found */
1327
+ 404: {
1328
+ headers: Record<string, unknown>;
1329
+ content?: never;
1330
+ };
1331
+ /** @description Policy Name already used/ Maximum no of policies per site reached */
1332
+ 409: {
1333
+ headers: Record<string, unknown>;
1334
+ content?: never;
1335
+ };
1336
+ /** @description Internal Server Error */
1337
+ 500: {
1338
+ headers: Record<string, unknown>;
1339
+ content?: never;
1340
+ };
1341
+ };
1342
+ };
1343
+ createFulfillmentPolicy: {
1344
+ parameters: {
1345
+ query?: never;
1346
+ header: {
1347
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
1348
+ 'Content-Type': string;
1349
+ };
1350
+ path?: never;
1351
+ cookie?: never;
1352
+ };
1353
+ /** @description Request to create a seller account fulfillment policy. */
1354
+ requestBody: {
1355
+ content: {
1356
+ 'application/json': components['schemas']['FulfillmentPolicyRequest'];
1357
+ };
1358
+ };
1359
+ responses: {
1360
+ /** @description Created */
1361
+ 201: {
1362
+ headers: {
1363
+ Location?: string;
1364
+ [name: string]: unknown;
1365
+ };
1366
+ content: {
1367
+ 'application/json': components['schemas']['SetFulfillmentPolicyResponse'];
1368
+ };
1369
+ };
1370
+ /** @description Bad Request */
1371
+ 400: {
1372
+ headers: Record<string, unknown>;
1373
+ content?: never;
1374
+ };
1375
+ /** @description Internal Server Error */
1376
+ 500: {
1377
+ headers: Record<string, unknown>;
1378
+ content?: never;
1379
+ };
1380
+ };
1381
+ };
1382
+ getFulfillmentPolicy: {
1383
+ parameters: {
1384
+ query?: never;
1385
+ header?: never;
1386
+ path: {
1387
+ /** @description This path parameter specifies the ID of the fulfillment policy you want to retrieve.<br><br> This ID can be retrieved for a fulfillment policy by using the <a href="/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies" target="_blank ">getFulfillmentPolicies</a> method. */
1388
+ fulfillmentPolicyId: string;
1389
+ };
1390
+ cookie?: never;
1391
+ };
1392
+ requestBody?: never;
1393
+ responses: {
1394
+ /** @description Success */
1395
+ 200: {
1396
+ headers: Record<string, unknown>;
1397
+ content: {
1398
+ 'application/json': components['schemas']['FulfillmentPolicy'];
1399
+ };
1400
+ };
1401
+ /** @description Bad Request */
1402
+ 400: {
1403
+ headers: Record<string, unknown>;
1404
+ content?: never;
1405
+ };
1406
+ /** @description Not Found */
1407
+ 404: {
1408
+ headers: Record<string, unknown>;
1409
+ content?: never;
1410
+ };
1411
+ /** @description Internal Server Error */
1412
+ 500: {
1413
+ headers: Record<string, unknown>;
1414
+ content?: never;
1415
+ };
1416
+ };
1417
+ };
1418
+ updateFulfillmentPolicy: {
1419
+ parameters: {
1420
+ query?: never;
1421
+ header: {
1422
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
1423
+ 'Content-Type': string;
1424
+ };
1425
+ path: {
1426
+ /** @description This path parameter specifies the ID of the fulfillment policy you want to update.<br><br>This ID can be retrieved for a specific fulfillment policy by using the <a href="/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies" target="_blank ">getFulfillmentPolicies</a> method. */
1427
+ fulfillmentPolicyId: string;
1428
+ };
1429
+ cookie?: never;
1430
+ };
1431
+ /** @description Fulfillment policy request */
1432
+ requestBody: {
1433
+ content: {
1434
+ 'application/json': components['schemas']['FulfillmentPolicyRequest'];
1435
+ };
1436
+ };
1437
+ responses: {
1438
+ /** @description OK */
1439
+ 200: {
1440
+ headers: Record<string, unknown>;
1441
+ content: {
1442
+ 'application/json': components['schemas']['SetFulfillmentPolicyResponse'];
1443
+ };
1444
+ };
1445
+ /** @description Bad Request */
1446
+ 400: {
1447
+ headers: Record<string, unknown>;
1448
+ content?: never;
1449
+ };
1450
+ /** @description Not Found */
1451
+ 404: {
1452
+ headers: Record<string, unknown>;
1453
+ content?: never;
1454
+ };
1455
+ /** @description Internal Server Error */
1456
+ 500: {
1457
+ headers: Record<string, unknown>;
1458
+ content?: never;
1459
+ };
1460
+ };
1461
+ };
1462
+ deleteFulfillmentPolicy: {
1463
+ parameters: {
1464
+ query?: never;
1465
+ header?: never;
1466
+ path: {
1467
+ /** @description This path parameter specifies the ID of the fulfillment policy to delete.<br><br> This ID can be retrieved for a fulfillment policy by using the <a href="/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies" target="_blank ">getFulfillmentPolicies</a> method. */
1468
+ fulfillmentPolicyId: string;
1469
+ };
1470
+ cookie?: never;
1471
+ };
1472
+ requestBody?: never;
1473
+ responses: {
1474
+ /** @description No Content */
1475
+ 204: {
1476
+ headers: Record<string, unknown>;
1477
+ content?: never;
1478
+ };
1479
+ /** @description Bad Request */
1480
+ 400: {
1481
+ headers: Record<string, unknown>;
1482
+ content?: never;
1483
+ };
1484
+ /** @description Not Found */
1485
+ 404: {
1486
+ headers: Record<string, unknown>;
1487
+ content?: never;
1488
+ };
1489
+ /** @description Conflict */
1490
+ 409: {
1491
+ headers: Record<string, unknown>;
1492
+ content?: never;
1493
+ };
1494
+ /** @description Internal Server Error */
1495
+ 500: {
1496
+ headers: Record<string, unknown>;
1497
+ content?: never;
1498
+ };
1499
+ };
1500
+ };
1501
+ getFulfillmentPolicies: {
1502
+ parameters: {
1503
+ query: {
1504
+ /** @description This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum */
1505
+ marketplace_id: string;
1506
+ };
1507
+ header?: {
1508
+ /** @description Get the correct policies for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get the policies for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank">HTTP request headers</a>. */
1509
+ 'Content-Language'?: string;
1510
+ };
1511
+ path?: never;
1512
+ cookie?: never;
1513
+ };
1514
+ requestBody?: never;
1515
+ responses: {
1516
+ /** @description Success */
1517
+ 200: {
1518
+ headers: Record<string, unknown>;
1519
+ content: {
1520
+ 'application/json': components['schemas']['FulfillmentPolicyResponse'];
1521
+ };
1522
+ };
1523
+ /** @description Bad Request */
1524
+ 400: {
1525
+ headers: Record<string, unknown>;
1526
+ content?: never;
1527
+ };
1528
+ /** @description Internal Server Error */
1529
+ 500: {
1530
+ headers: Record<string, unknown>;
1531
+ content?: never;
1532
+ };
1533
+ };
1534
+ };
1535
+ getFulfillmentPolicyByName: {
1536
+ parameters: {
1537
+ query: {
1538
+ /** @description This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum */
1539
+ marketplace_id: string;
1540
+ /** @description This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve.<br><br>This value can be retrieved for a fulfillment policy by using the <a href="/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies" target="_blank ">getFulfillmentPolicies</a> method. */
1541
+ name: string;
1542
+ };
1543
+ header?: {
1544
+ /** @description Get the correct policies for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get the policies for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank">HTTP request headers</a>. */
1545
+ 'Content-Language'?: string;
1546
+ };
1547
+ path?: never;
1548
+ cookie?: never;
1549
+ };
1550
+ requestBody?: never;
1551
+ responses: {
1552
+ /** @description Success */
1553
+ 200: {
1554
+ headers: Record<string, unknown>;
1555
+ content: {
1556
+ 'application/json': components['schemas']['FulfillmentPolicy'];
1557
+ };
1558
+ };
1559
+ /** @description Bad Request */
1560
+ 400: {
1561
+ headers: Record<string, unknown>;
1562
+ content?: never;
1563
+ };
1564
+ /** @description Internal Server Error */
1565
+ 500: {
1566
+ headers: Record<string, unknown>;
1567
+ content?: never;
1568
+ };
1569
+ };
1570
+ };
1571
+ getPaymentPolicies: {
1572
+ parameters: {
1573
+ query: {
1574
+ /** @description This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum */
1575
+ marketplace_id: string;
1576
+ };
1577
+ header?: {
1578
+ /** @description Get the correct policies for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get the policies for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank">HTTP request headers</a>. */
1579
+ 'Content-Language'?: string;
1580
+ };
1581
+ path?: never;
1582
+ cookie?: never;
1583
+ };
1584
+ requestBody?: never;
1585
+ responses: {
1586
+ /** @description Success */
1587
+ 200: {
1588
+ headers: Record<string, unknown>;
1589
+ content: {
1590
+ 'application/json': components['schemas']['PaymentPolicyResponse'];
1591
+ };
1592
+ };
1593
+ /** @description Bad Request */
1594
+ 400: {
1595
+ headers: Record<string, unknown>;
1596
+ content?: never;
1597
+ };
1598
+ /** @description Internal Server Error */
1599
+ 500: {
1600
+ headers: Record<string, unknown>;
1601
+ content?: never;
1602
+ };
1603
+ };
1604
+ };
1605
+ createPaymentPolicy: {
1606
+ parameters: {
1607
+ query?: never;
1608
+ header: {
1609
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
1610
+ 'Content-Type': string;
1611
+ };
1612
+ path?: never;
1613
+ cookie?: never;
1614
+ };
1615
+ /** @description Payment policy request */
1616
+ requestBody: {
1617
+ content: {
1618
+ 'application/json': components['schemas']['PaymentPolicyRequest'];
1619
+ };
1620
+ };
1621
+ responses: {
1622
+ /** @description Created */
1623
+ 201: {
1624
+ headers: {
1625
+ Location?: string;
1626
+ [name: string]: unknown;
1627
+ };
1628
+ content: {
1629
+ 'application/json': components['schemas']['SetPaymentPolicyResponse'];
1630
+ };
1631
+ };
1632
+ /** @description Bad Request */
1633
+ 400: {
1634
+ headers: Record<string, unknown>;
1635
+ content?: never;
1636
+ };
1637
+ /** @description Internal Server Error */
1638
+ 500: {
1639
+ headers: Record<string, unknown>;
1640
+ content?: never;
1641
+ };
1642
+ };
1643
+ };
1644
+ getPaymentPolicy: {
1645
+ parameters: {
1646
+ query?: never;
1647
+ header?: never;
1648
+ path: {
1649
+ /** @description This path parameter specifies the ID of the payment policy you want to retrieve. <br><br> This ID can be retrieved for a payment policy by using the <a href="/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies" target="_blank ">getPaymentPolices</a> method. */
1650
+ payment_policy_id: string;
1651
+ };
1652
+ cookie?: never;
1653
+ };
1654
+ requestBody?: never;
1655
+ responses: {
1656
+ /** @description Success */
1657
+ 200: {
1658
+ headers: Record<string, unknown>;
1659
+ content: {
1660
+ 'application/json': components['schemas']['PaymentPolicy'];
1661
+ };
1662
+ };
1663
+ /** @description Bad Request */
1664
+ 400: {
1665
+ headers: Record<string, unknown>;
1666
+ content?: never;
1667
+ };
1668
+ /** @description Not Found */
1669
+ 404: {
1670
+ headers: Record<string, unknown>;
1671
+ content?: never;
1672
+ };
1673
+ /** @description Internal Server Error */
1674
+ 500: {
1675
+ headers: Record<string, unknown>;
1676
+ content?: never;
1677
+ };
1678
+ };
1679
+ };
1680
+ updatePaymentPolicy: {
1681
+ parameters: {
1682
+ query?: never;
1683
+ header: {
1684
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
1685
+ 'Content-Type': string;
1686
+ };
1687
+ path: {
1688
+ /** @description This path parameter specifies the ID of the payment policy you want to update. <br><br> This ID can be retrieved for a payment policy by using the <a href="/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies" target="_blank ">getPaymentPolices</a> method. */
1689
+ payment_policy_id: string;
1690
+ };
1691
+ cookie?: never;
1692
+ };
1693
+ /** @description Payment policy request */
1694
+ requestBody: {
1695
+ content: {
1696
+ 'application/json': components['schemas']['PaymentPolicyRequest'];
1697
+ };
1698
+ };
1699
+ responses: {
1700
+ /** @description OK */
1701
+ 200: {
1702
+ headers: Record<string, unknown>;
1703
+ content: {
1704
+ 'application/json': components['schemas']['SetPaymentPolicyResponse'];
1705
+ };
1706
+ };
1707
+ /** @description Bad Request */
1708
+ 400: {
1709
+ headers: Record<string, unknown>;
1710
+ content?: never;
1711
+ };
1712
+ /** @description Not Found */
1713
+ 404: {
1714
+ headers: Record<string, unknown>;
1715
+ content?: never;
1716
+ };
1717
+ /** @description Internal Server Error */
1718
+ 500: {
1719
+ headers: Record<string, unknown>;
1720
+ content?: never;
1721
+ };
1722
+ };
1723
+ };
1724
+ deletePaymentPolicy: {
1725
+ parameters: {
1726
+ query?: never;
1727
+ header?: never;
1728
+ path: {
1729
+ /** @description This path parameter specifies the unique identifier of the payment policy you want to delete.<br><br> This ID can be retrieved for a payment policy by using the <a href="/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies" target="_blank ">getPaymentPolices</a> method. */
1730
+ payment_policy_id: string;
1731
+ };
1732
+ cookie?: never;
1733
+ };
1734
+ requestBody?: never;
1735
+ responses: {
1736
+ /** @description No Content */
1737
+ 204: {
1738
+ headers: Record<string, unknown>;
1739
+ content?: never;
1740
+ };
1741
+ /** @description Bad Request */
1742
+ 400: {
1743
+ headers: Record<string, unknown>;
1744
+ content?: never;
1745
+ };
1746
+ /** @description Not Found */
1747
+ 404: {
1748
+ headers: Record<string, unknown>;
1749
+ content?: never;
1750
+ };
1751
+ /** @description Conflict */
1752
+ 409: {
1753
+ headers: Record<string, unknown>;
1754
+ content?: never;
1755
+ };
1756
+ /** @description Internal Server Error */
1757
+ 500: {
1758
+ headers: Record<string, unknown>;
1759
+ content?: never;
1760
+ };
1761
+ };
1762
+ };
1763
+ getPaymentPolicyByName: {
1764
+ parameters: {
1765
+ query: {
1766
+ /** @description This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum */
1767
+ marketplace_id: string;
1768
+ /** @description This query parameter specifies the seller-defined name of the payment policy you want to retrieve.<br><br> This value can be retrieved for a payment policy by using the <a href="/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies" target="_blank ">getPaymentPolicies</a> method. */
1769
+ name: string;
1770
+ };
1771
+ header?: {
1772
+ /** @description Get the correct policy for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get a policy for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a>. */
1773
+ 'Content-Language'?: string;
1774
+ };
1775
+ path?: never;
1776
+ cookie?: never;
1777
+ };
1778
+ requestBody?: never;
1779
+ responses: {
1780
+ /** @description Success */
1781
+ 200: {
1782
+ headers: Record<string, unknown>;
1783
+ content: {
1784
+ 'application/json': components['schemas']['PaymentPolicy'];
1785
+ };
1786
+ };
1787
+ /** @description Bad Request */
1788
+ 400: {
1789
+ headers: Record<string, unknown>;
1790
+ content?: never;
1791
+ };
1792
+ /** @description Internal Server Error */
1793
+ 500: {
1794
+ headers: Record<string, unknown>;
1795
+ content?: never;
1796
+ };
1797
+ };
1798
+ };
1799
+ getPaymentsProgram: {
1800
+ parameters: {
1801
+ query?: never;
1802
+ header?: never;
1803
+ path: {
1804
+ /** @description This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status. */
1805
+ marketplace_id: string;
1806
+ /** @description This path parameter specifies the payments program whose status is returned by the call. */
1807
+ payments_program_type: string;
1808
+ };
1809
+ cookie?: never;
1810
+ };
1811
+ requestBody?: never;
1812
+ responses: {
1813
+ /** @description Success */
1814
+ 200: {
1815
+ headers: Record<string, unknown>;
1816
+ content: {
1817
+ 'application/json': components['schemas']['PaymentsProgramResponse'];
1818
+ };
1819
+ };
1820
+ /** @description Bad Request */
1821
+ 400: {
1822
+ headers: Record<string, unknown>;
1823
+ content?: never;
1824
+ };
1825
+ /** @description Not Found */
1826
+ 404: {
1827
+ headers: Record<string, unknown>;
1828
+ content?: never;
1829
+ };
1830
+ /** @description Internal Server Error */
1831
+ 500: {
1832
+ headers: Record<string, unknown>;
1833
+ content?: never;
1834
+ };
1835
+ };
1836
+ };
1837
+ getPaymentsProgramOnboarding: {
1838
+ parameters: {
1839
+ query?: never;
1840
+ header?: never;
1841
+ path: {
1842
+ /** @description The eBay marketplace ID associated with the onboarding status to retrieve. */
1843
+ marketplace_id: string;
1844
+ /** @description The type of payments program whose status is returned by the method. */
1845
+ payments_program_type: string;
1846
+ };
1847
+ cookie?: never;
1848
+ };
1849
+ requestBody?: never;
1850
+ responses: {
1851
+ /** @description Success */
1852
+ 200: {
1853
+ headers: Record<string, unknown>;
1854
+ content: {
1855
+ 'application/json': components['schemas']['PaymentsProgramOnboardingResponse'];
1856
+ };
1857
+ };
1858
+ /** @description Bad Request */
1859
+ 400: {
1860
+ headers: Record<string, unknown>;
1861
+ content?: never;
1862
+ };
1863
+ /** @description Not Found */
1864
+ 404: {
1865
+ headers: Record<string, unknown>;
1866
+ content?: never;
1867
+ };
1868
+ /** @description Internal Server Error */
1869
+ 500: {
1870
+ headers: Record<string, unknown>;
1871
+ content?: never;
1872
+ };
1873
+ };
1874
+ };
1875
+ getPrivileges: {
1876
+ parameters: {
1877
+ query?: never;
1878
+ header?: never;
1879
+ path?: never;
1880
+ cookie?: never;
1881
+ };
1882
+ requestBody?: never;
1883
+ responses: {
1884
+ /** @description Success */
1885
+ 200: {
1886
+ headers: Record<string, unknown>;
1887
+ content: {
1888
+ 'application/json': components['schemas']['SellingPrivileges'];
1889
+ };
1890
+ };
1891
+ /** @description Bad Request */
1892
+ 400: {
1893
+ headers: Record<string, unknown>;
1894
+ content?: never;
1895
+ };
1896
+ /** @description Internal Server Error */
1897
+ 500: {
1898
+ headers: Record<string, unknown>;
1899
+ content?: never;
1900
+ };
1901
+ };
1902
+ };
1903
+ getOptedInPrograms: {
1904
+ parameters: {
1905
+ query?: never;
1906
+ header?: never;
1907
+ path?: never;
1908
+ cookie?: never;
1909
+ };
1910
+ requestBody?: never;
1911
+ responses: {
1912
+ /** @description Success */
1913
+ 200: {
1914
+ headers: Record<string, unknown>;
1915
+ content: {
1916
+ 'application/json': components['schemas']['Programs'];
1917
+ };
1918
+ };
1919
+ /** @description Bad Request */
1920
+ 400: {
1921
+ headers: Record<string, unknown>;
1922
+ content?: never;
1923
+ };
1924
+ /** @description Not Found */
1925
+ 404: {
1926
+ headers: Record<string, unknown>;
1927
+ content?: never;
1928
+ };
1929
+ /** @description Internal Server Error */
1930
+ 500: {
1931
+ headers: Record<string, unknown>;
1932
+ content?: never;
1933
+ };
1934
+ };
1935
+ };
1936
+ optInToProgram: {
1937
+ parameters: {
1938
+ query?: never;
1939
+ header: {
1940
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
1941
+ 'Content-Type': string;
1942
+ };
1943
+ path?: never;
1944
+ cookie?: never;
1945
+ };
1946
+ /** @description Program being opted-in to. */
1947
+ requestBody: {
1948
+ content: {
1949
+ 'application/json': components['schemas']['Program'];
1950
+ };
1951
+ };
1952
+ responses: {
1953
+ /** @description Success */
1954
+ 200: {
1955
+ headers: Record<string, unknown>;
1956
+ content: {
1957
+ 'application/json': Record<string, never>;
1958
+ };
1959
+ };
1960
+ /** @description Bad Request */
1961
+ 400: {
1962
+ headers: Record<string, unknown>;
1963
+ content?: never;
1964
+ };
1965
+ /** @description Not Found */
1966
+ 404: {
1967
+ headers: Record<string, unknown>;
1968
+ content?: never;
1969
+ };
1970
+ /** @description Conflict */
1971
+ 409: {
1972
+ headers: Record<string, unknown>;
1973
+ content?: never;
1974
+ };
1975
+ /** @description Internal Server Error */
1976
+ 500: {
1977
+ headers: Record<string, unknown>;
1978
+ content?: never;
1979
+ };
1980
+ };
1981
+ };
1982
+ optOutOfProgram: {
1983
+ parameters: {
1984
+ query?: never;
1985
+ header: {
1986
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
1987
+ 'Content-Type': string;
1988
+ };
1989
+ path?: never;
1990
+ cookie?: never;
1991
+ };
1992
+ /** @description Program being opted-out of. */
1993
+ requestBody: {
1994
+ content: {
1995
+ 'application/json': components['schemas']['Program'];
1996
+ };
1997
+ };
1998
+ responses: {
1999
+ /** @description Success */
2000
+ 200: {
2001
+ headers: Record<string, unknown>;
2002
+ content: {
2003
+ 'application/json': Record<string, never>;
2004
+ };
2005
+ };
2006
+ /** @description Bad Request */
2007
+ 400: {
2008
+ headers: Record<string, unknown>;
2009
+ content?: never;
2010
+ };
2011
+ /** @description Not Found */
2012
+ 404: {
2013
+ headers: Record<string, unknown>;
2014
+ content?: never;
2015
+ };
2016
+ /** @description Conflict */
2017
+ 409: {
2018
+ headers: Record<string, unknown>;
2019
+ content?: never;
2020
+ };
2021
+ /** @description Internal Server Error */
2022
+ 500: {
2023
+ headers: Record<string, unknown>;
2024
+ content?: never;
2025
+ };
2026
+ };
2027
+ };
2028
+ getRateTables: {
2029
+ parameters: {
2030
+ query?: {
2031
+ /** @description This query 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> code of country for which you want shipping rate table information. If you do not specify a country code, the request returns all of the seller's defined shipping rate tables for all eBay marketplaces. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum */
2032
+ country_code?: string;
2033
+ };
2034
+ header?: never;
2035
+ path?: never;
2036
+ cookie?: never;
2037
+ };
2038
+ requestBody?: never;
2039
+ responses: {
2040
+ /** @description Success */
2041
+ 200: {
2042
+ headers: Record<string, unknown>;
2043
+ content: {
2044
+ 'application/json': components['schemas']['RateTableResponse'];
2045
+ };
2046
+ };
2047
+ /** @description Bad Request */
2048
+ 400: {
2049
+ headers: Record<string, unknown>;
2050
+ content?: never;
2051
+ };
2052
+ /** @description Internal Server Error */
2053
+ 500: {
2054
+ headers: Record<string, unknown>;
2055
+ content?: never;
2056
+ };
2057
+ };
2058
+ };
2059
+ getReturnPolicies: {
2060
+ parameters: {
2061
+ query: {
2062
+ /** @description This query parameter specifies the ID of the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum */
2063
+ marketplace_id: string;
2064
+ };
2065
+ header?: {
2066
+ /** @description Get the correct policies for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get the policies for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank">HTTP request headers</a>. */
2067
+ 'Content-Language'?: string;
2068
+ };
2069
+ path?: never;
2070
+ cookie?: never;
2071
+ };
2072
+ requestBody?: never;
2073
+ responses: {
2074
+ /** @description Success */
2075
+ 200: {
2076
+ headers: Record<string, unknown>;
2077
+ content: {
2078
+ 'application/json': components['schemas']['ReturnPolicyResponse'];
2079
+ };
2080
+ };
2081
+ /** @description Bad Request */
2082
+ 400: {
2083
+ headers: Record<string, unknown>;
2084
+ content?: never;
2085
+ };
2086
+ /** @description Internal Server Error */
2087
+ 500: {
2088
+ headers: Record<string, unknown>;
2089
+ content?: never;
2090
+ };
2091
+ };
2092
+ };
2093
+ createReturnPolicy: {
2094
+ parameters: {
2095
+ query?: never;
2096
+ header: {
2097
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
2098
+ 'Content-Type': string;
2099
+ };
2100
+ path?: never;
2101
+ cookie?: never;
2102
+ };
2103
+ /** @description Return policy request */
2104
+ requestBody: {
2105
+ content: {
2106
+ 'application/json': components['schemas']['ReturnPolicyRequest'];
2107
+ };
2108
+ };
2109
+ responses: {
2110
+ /** @description Created */
2111
+ 201: {
2112
+ headers: {
2113
+ Location?: string;
2114
+ [name: string]: unknown;
2115
+ };
2116
+ content: {
2117
+ 'application/json': components['schemas']['SetReturnPolicyResponse'];
2118
+ };
2119
+ };
2120
+ /** @description Bad Request */
2121
+ 400: {
2122
+ headers: Record<string, unknown>;
2123
+ content?: never;
2124
+ };
2125
+ /** @description Internal Server Error */
2126
+ 500: {
2127
+ headers: Record<string, unknown>;
2128
+ content?: never;
2129
+ };
2130
+ };
2131
+ };
2132
+ getReturnPolicy: {
2133
+ parameters: {
2134
+ query?: never;
2135
+ header?: never;
2136
+ path: {
2137
+ /** @description This path parameter specifies the unique identifier of the return policy you want to retrieve. <br><br> This ID can be retrieved for a return policy by using the <a href="/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies" target="_blank ">getReturnPolicies</a> method. */
2138
+ return_policy_id: string;
2139
+ };
2140
+ cookie?: never;
2141
+ };
2142
+ requestBody?: never;
2143
+ responses: {
2144
+ /** @description Success */
2145
+ 200: {
2146
+ headers: Record<string, unknown>;
2147
+ content: {
2148
+ 'application/json': components['schemas']['ReturnPolicy'];
2149
+ };
2150
+ };
2151
+ /** @description Bad Request */
2152
+ 400: {
2153
+ headers: Record<string, unknown>;
2154
+ content?: never;
2155
+ };
2156
+ /** @description Not Found */
2157
+ 404: {
2158
+ headers: Record<string, unknown>;
2159
+ content?: never;
2160
+ };
2161
+ /** @description Internal Server Error */
2162
+ 500: {
2163
+ headers: Record<string, unknown>;
2164
+ content?: never;
2165
+ };
2166
+ };
2167
+ };
2168
+ updateReturnPolicy: {
2169
+ parameters: {
2170
+ query?: never;
2171
+ header: {
2172
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
2173
+ 'Content-Type': string;
2174
+ };
2175
+ path: {
2176
+ /** @description This path parameter specifies the ID of the return policy you want to update. <br><br> This ID can be retrieved for a return policy by using the <a href="/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies" target="_blank ">getReturnPolicies</a> method. */
2177
+ return_policy_id: string;
2178
+ };
2179
+ cookie?: never;
2180
+ };
2181
+ /** @description Container for a return policy request. */
2182
+ requestBody: {
2183
+ content: {
2184
+ 'application/json': components['schemas']['ReturnPolicyRequest'];
2185
+ };
2186
+ };
2187
+ responses: {
2188
+ /** @description OK */
2189
+ 200: {
2190
+ headers: Record<string, unknown>;
2191
+ content: {
2192
+ 'application/json': components['schemas']['SetReturnPolicyResponse'];
2193
+ };
2194
+ };
2195
+ /** @description Bad Request */
2196
+ 400: {
2197
+ headers: Record<string, unknown>;
2198
+ content?: never;
2199
+ };
2200
+ /** @description Not Found */
2201
+ 404: {
2202
+ headers: Record<string, unknown>;
2203
+ content?: never;
2204
+ };
2205
+ /** @description Internal Server Error */
2206
+ 500: {
2207
+ headers: Record<string, unknown>;
2208
+ content?: never;
2209
+ };
2210
+ };
2211
+ };
2212
+ deleteReturnPolicy: {
2213
+ parameters: {
2214
+ query?: never;
2215
+ header?: never;
2216
+ path: {
2217
+ /** @description This path parameter specifies the unique identifier of the return policy you want to delete.<br><br> This ID can be retrieved for a return policy by using the <a href="/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies" target="_blank ">getReturnPolicies</a> method. */
2218
+ return_policy_id: string;
2219
+ };
2220
+ cookie?: never;
2221
+ };
2222
+ requestBody?: never;
2223
+ responses: {
2224
+ /** @description No Content */
2225
+ 204: {
2226
+ headers: Record<string, unknown>;
2227
+ content?: never;
2228
+ };
2229
+ /** @description Bad Request */
2230
+ 400: {
2231
+ headers: Record<string, unknown>;
2232
+ content?: never;
2233
+ };
2234
+ /** @description Not Found */
2235
+ 404: {
2236
+ headers: Record<string, unknown>;
2237
+ content?: never;
2238
+ };
2239
+ /** @description Conflict */
2240
+ 409: {
2241
+ headers: Record<string, unknown>;
2242
+ content?: never;
2243
+ };
2244
+ /** @description Internal Server Error */
2245
+ 500: {
2246
+ headers: Record<string, unknown>;
2247
+ content?: never;
2248
+ };
2249
+ };
2250
+ };
2251
+ getReturnPolicyByName: {
2252
+ parameters: {
2253
+ query: {
2254
+ /** @description This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum */
2255
+ marketplace_id: string;
2256
+ /** @description This query parameter specifies the seller-defined name of the return policy you want to retrieve.<br><br> This value can be retrieved for a return policy by using the <a href="/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies" target="_blank ">getReturnPolicies</a> method. */
2257
+ name: string;
2258
+ };
2259
+ header?: {
2260
+ /** @description Get the correct policy for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get a policy for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a>. */
2261
+ 'Content-Language'?: string;
2262
+ };
2263
+ path?: never;
2264
+ cookie?: never;
2265
+ };
2266
+ requestBody?: never;
2267
+ responses: {
2268
+ /** @description Success */
2269
+ 200: {
2270
+ headers: Record<string, unknown>;
2271
+ content: {
2272
+ 'application/json': components['schemas']['ReturnPolicy'];
2273
+ };
2274
+ };
2275
+ /** @description Bad Request */
2276
+ 400: {
2277
+ headers: Record<string, unknown>;
2278
+ content?: never;
2279
+ };
2280
+ /** @description Internal Server Error */
2281
+ 500: {
2282
+ headers: Record<string, unknown>;
2283
+ content?: never;
2284
+ };
2285
+ };
2286
+ };
2287
+ bulkCreateOrReplaceSalesTax: {
2288
+ parameters: {
2289
+ query?: never;
2290
+ header?: never;
2291
+ path?: never;
2292
+ cookie?: never;
2293
+ };
2294
+ /** @description List of sales taxes to be updated */
2295
+ requestBody: {
2296
+ content: {
2297
+ 'application/json': components['schemas']['BulkSalesTaxInput'];
2298
+ };
2299
+ };
2300
+ responses: {
2301
+ /** @description Success */
2302
+ 200: {
2303
+ headers: Record<string, unknown>;
2304
+ content: {
2305
+ 'application/json': components['schemas']['UpdatedSalesTaxResponse'];
2306
+ };
2307
+ };
2308
+ /** @description partial success */
2309
+ 207: {
2310
+ headers: Record<string, unknown>;
2311
+ content?: never;
2312
+ };
2313
+ /** @description Bad Request */
2314
+ 400: {
2315
+ headers: Record<string, unknown>;
2316
+ content?: never;
2317
+ };
2318
+ /** @description Internal Server Error */
2319
+ 500: {
2320
+ headers: Record<string, unknown>;
2321
+ content?: never;
2322
+ };
2323
+ };
2324
+ };
2325
+ getSalesTax: {
2326
+ parameters: {
2327
+ query?: never;
2328
+ header?: never;
2329
+ path: {
2330
+ /** @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> code for the country whose sales tax table 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> */
2331
+ countryCode: string;
2332
+ /** @description This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry to be retrieved.<br><br>Valid jurisdiction IDs can be retrieved using the <a href="/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions" target="_blank ">getSalesTaxJurisdiction</a> method of the Metadata API.<br><br><span class="tablenote"><b>Note:</b> When <code>countryCode</code> is set to <code>US</code>, the only supported values for <code>jurisdictionId</code> 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></span> */
2333
+ jurisdictionId: string;
2334
+ };
2335
+ cookie?: never;
2336
+ };
2337
+ requestBody?: never;
2338
+ responses: {
2339
+ /** @description Success */
2340
+ 200: {
2341
+ headers: Record<string, unknown>;
2342
+ content: {
2343
+ 'application/json': components['schemas']['SalesTax'];
2344
+ };
2345
+ };
2346
+ /** @description No content */
2347
+ 204: {
2348
+ headers: Record<string, unknown>;
2349
+ content?: never;
2350
+ };
2351
+ /** @description Bad Request */
2352
+ 400: {
2353
+ headers: Record<string, unknown>;
2354
+ content?: never;
2355
+ };
2356
+ /** @description Not Found */
2357
+ 404: {
2358
+ headers: Record<string, unknown>;
2359
+ content?: never;
2360
+ };
2361
+ /** @description Internal Server Error */
2362
+ 500: {
2363
+ headers: Record<string, unknown>;
2364
+ content?: never;
2365
+ };
2366
+ };
2367
+ };
2368
+ createOrReplaceSalesTax: {
2369
+ parameters: {
2370
+ query?: never;
2371
+ header: {
2372
+ /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>.<br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
2373
+ 'Content-Type': string;
2374
+ };
2375
+ path: {
2376
+ /** @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> code for the country for which you want to create a sales tax table entry.<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> */
2377
+ countryCode: string;
2378
+ /** @description This path parameter specifies the ID of the tax jurisdiction for the table entry to be created.<br><br>Valid jurisdiction IDs can be retrieved using the <a href="/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions" target="_blank ">getSalesTaxJurisdiction</a> method of the Metadata API.<br><br><span class="tablenote"><b>Note:</b> When <code>countryCode</code> is set to <code>US</code>, the only supported values for <code>jurisdictionId</code> 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</code> (Palau)</li><li><code>VI</code> (US Virgin Islands)</li></ul></span> */
2379
+ jurisdictionId: string;
2380
+ };
2381
+ cookie?: never;
2382
+ };
2383
+ /** @description A container that describes the how the sales tax is calculated. */
2384
+ requestBody: {
2385
+ content: {
2386
+ 'application/json': components['schemas']['SalesTaxBase'];
2387
+ };
2388
+ };
2389
+ responses: {
2390
+ /** @description No Content */
2391
+ 204: {
2392
+ headers: Record<string, unknown>;
2393
+ content?: never;
2394
+ };
2395
+ /** @description Bad Request */
2396
+ 400: {
2397
+ headers: Record<string, unknown>;
2398
+ content?: never;
2399
+ };
2400
+ /** @description Not Found */
2401
+ 404: {
2402
+ headers: Record<string, unknown>;
2403
+ content?: never;
2404
+ };
2405
+ /** @description Internal Server Error */
2406
+ 500: {
2407
+ headers: Record<string, unknown>;
2408
+ content?: never;
2409
+ };
2410
+ };
2411
+ };
2412
+ deleteSalesTax: {
2413
+ parameters: {
2414
+ query?: never;
2415
+ header?: never;
2416
+ path: {
2417
+ /** @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> code for the country whose sales tax table entry you want to delete.<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> */
2418
+ countryCode: string;
2419
+ /** @description This path parameter specifies the ID of the sales tax jurisdiction whose table entry you want to delete.<br><br>Valid jurisdiction IDs can be retrieved using the <a href="/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions" target="_blank ">getSalesTaxJurisdiction</a> method of the Metadata API.<br><br><span class="tablenote"><b>Note:</b> When <code>countryCode</code> is set to <code>US</code>, the only supported values for <code>jurisdictionId</code> 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</code> (Palau)</li><li><code>VI</code> (US Virgin Islands)</li></ul></span> */
2420
+ jurisdictionId: string;
2421
+ };
2422
+ cookie?: never;
2423
+ };
2424
+ requestBody?: never;
2425
+ responses: {
2426
+ /** @description Success */
2427
+ 204: {
2428
+ headers: Record<string, unknown>;
2429
+ content?: never;
2430
+ };
2431
+ /** @description Bad Request */
2432
+ 400: {
2433
+ headers: Record<string, unknown>;
2434
+ content?: never;
2435
+ };
2436
+ /** @description Not Found */
2437
+ 404: {
2438
+ headers: Record<string, unknown>;
2439
+ content?: never;
2440
+ };
2441
+ /** @description Internal Server Error */
2442
+ 500: {
2443
+ headers: Record<string, unknown>;
2444
+ content?: never;
2445
+ };
2446
+ };
2447
+ };
2448
+ getSalesTaxes: {
2449
+ parameters: {
2450
+ query: {
2451
+ /** @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> code for the country whose tax table 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> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum */
2452
+ country_code: string;
2453
+ };
2454
+ header?: never;
2455
+ path?: never;
2456
+ cookie?: never;
2457
+ };
2458
+ requestBody?: never;
2459
+ responses: {
2460
+ /** @description Success */
2461
+ 200: {
2462
+ headers: Record<string, unknown>;
2463
+ content: {
2464
+ 'application/json': components['schemas']['SalesTaxes'];
2465
+ };
2466
+ };
2467
+ /** @description Bad Request */
2468
+ 400: {
2469
+ headers: Record<string, unknown>;
2470
+ content?: never;
2471
+ };
2472
+ /** @description Internal Server Error */
2473
+ 500: {
2474
+ headers: Record<string, unknown>;
2475
+ content?: never;
2476
+ };
2477
+ };
2478
+ };
2479
+ getSubscription: {
2480
+ parameters: {
2481
+ query?: {
2482
+ /** @description This field is for future use. */
2483
+ limit?: string;
2484
+ /** @description This field is for future use. */
2485
+ continuation_token?: string;
2486
+ };
2487
+ header?: never;
2488
+ path?: never;
2489
+ cookie?: never;
2490
+ };
2491
+ requestBody?: never;
2492
+ responses: {
2493
+ /** @description Success */
2494
+ 200: {
2495
+ headers: Record<string, unknown>;
2496
+ content: {
2497
+ 'application/json': components['schemas']['SubscriptionResponse'];
2498
+ };
2499
+ };
2500
+ /** @description Bad Request */
2501
+ 400: {
2502
+ headers: Record<string, unknown>;
2503
+ content?: never;
2504
+ };
2505
+ /** @description Internal Server Error */
2506
+ 500: {
2507
+ headers: Record<string, unknown>;
2508
+ content?: never;
2509
+ };
2510
+ };
2511
+ };
2512
+ getKYC: {
2513
+ parameters: {
2514
+ query?: never;
2515
+ header?: never;
2516
+ path?: never;
2517
+ cookie?: never;
2518
+ };
2519
+ requestBody?: never;
2520
+ responses: {
2521
+ /** @description OK */
2522
+ 200: {
2523
+ headers: Record<string, unknown>;
2524
+ content: {
2525
+ 'application/json': components['schemas']['KycResponse'];
2526
+ };
2527
+ };
2528
+ /** @description No Content */
2529
+ 204: {
2530
+ headers: Record<string, unknown>;
2531
+ content?: never;
2532
+ };
2533
+ /** @description Bad Request */
2534
+ 400: {
2535
+ headers: Record<string, unknown>;
2536
+ content?: never;
2537
+ };
2538
+ /** @description Internal Server Error */
2539
+ 500: {
2540
+ headers: Record<string, unknown>;
2541
+ content?: never;
2542
+ };
2543
+ };
2544
+ };
2545
+ getAdvertisingEligibility: {
2546
+ parameters: {
2547
+ query?: {
2548
+ /** @description A comma-separated list of eBay advertising programs for which eligibility status will be returned.<br><br> See the <a href="/api-docs/sell/account/types/plser:AdvertisingProgramEnum" target="_blank"> AdvertisingProgramEnum</a> type for a list of supported values.<br><br>If no programs are specified, the results will be returned for all programs. */
2549
+ program_types?: string;
2550
+ };
2551
+ header: {
2552
+ /** @description The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked. This header is required or the call will fail.<br><br>See the <a href="/api-docs/sell/account/types/ba:MarketplaceIdEnum " target="_blank ">MarketplaceIdEnum</a> type for the supported marketplace ID values. */
2553
+ 'X-EBAY-C-MARKETPLACE-ID': string;
2554
+ };
2555
+ path?: never;
2556
+ cookie?: never;
2557
+ };
2558
+ requestBody?: never;
2559
+ responses: {
2560
+ /** @description Success */
2561
+ 200: {
2562
+ headers: Record<string, unknown>;
2563
+ content: {
2564
+ 'application/json': components['schemas']['SellerEligibilityMultiProgramResponse'];
2565
+ };
2566
+ };
2567
+ /** @description Bad Request */
2568
+ 400: {
2569
+ headers: Record<string, unknown>;
2570
+ content?: never;
2571
+ };
2572
+ /** @description Internal Server Error */
2573
+ 500: {
2574
+ headers: Record<string, unknown>;
2575
+ content?: never;
2576
+ };
2577
+ };
2578
+ };
2579
+ }