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,2537 @@
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
+ '/actual_costs': {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method is used to retrieve the actual weight and cost for one or more packages based on the provided input criteria.<br><br>Responses can be filtered by the <b>tracking_numbers</b> query parameter. If this parameter is used, actual costs for each package associated with the provided tracking numbers are returned.<br><br>Alternatively, responses can be filtered by the <b>trans_begin_time</b> and <b>trans_end_time</b> query parameters. If these parameters are used, the actual costs of all packages created within this date range are returned.<br><br>Only one filtering method can be used per call. */
14
+ get: operations['getActualCosts'];
15
+ put?: never;
16
+ post?: never;
17
+ delete?: never;
18
+ options?: never;
19
+ head?: never;
20
+ patch?: never;
21
+ trace?: never;
22
+ };
23
+ '/address_preference': {
24
+ parameters: {
25
+ query?: never;
26
+ header?: never;
27
+ path?: never;
28
+ cookie?: never;
29
+ };
30
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve information about all the ship-from and/or return addresses associated with a seller's eDIS account. */
31
+ get: operations['getAddressPreferences'];
32
+ put?: never;
33
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to create an address on your eDIS account.<br><br>The following types of addresses can be created through this method:<ul><li><code>SHIP_FROM_ADDRESS</code></li><li><code>RETURN_ADDRESS</code></li></ul>The address information for the address, including location details, contact information, and address type, must be provided in the <b>shipFromAddress</b> container. If the call is successful, the <b>addressId</b> for the newly created address will be returned. This identifier can then be used when creating a package to specify the address to use for the shipment. */
34
+ post: operations['createAddressPreference'];
35
+ delete?: never;
36
+ options?: never;
37
+ head?: never;
38
+ patch?: never;
39
+ trace?: never;
40
+ };
41
+ '/agents': {
42
+ parameters: {
43
+ query?: never;
44
+ header?: never;
45
+ path?: never;
46
+ cookie?: never;
47
+ };
48
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve information about the EU Authorized Representative (AR) agent(s) associated with a seller's eDIS account.<br><br>An EU AR agent acts as a liaison between non-EU manufacturers and European regulatory authorities to ensure compliance with EU regulations. This method returns contact information about each agent, as well as their eBay ID and the countries that they support. */
49
+ get: operations['getAgents'];
50
+ put?: never;
51
+ post?: never;
52
+ delete?: never;
53
+ options?: never;
54
+ head?: never;
55
+ patch?: never;
56
+ trace?: never;
57
+ };
58
+ '/battery_qualifications': {
59
+ parameters: {
60
+ query?: never;
61
+ header?: never;
62
+ path?: never;
63
+ cookie?: never;
64
+ };
65
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method is used to retrieve all battery qualifications associated with your eDIS account. This includes the type, electronic qualification ID and name, and expiration date for each battery. */
66
+ get: operations['getBatteryQualifications'];
67
+ put?: never;
68
+ post?: never;
69
+ delete?: never;
70
+ options?: never;
71
+ head?: never;
72
+ patch?: never;
73
+ trace?: never;
74
+ };
75
+ '/bundle/{bundle_id}/cancel': {
76
+ parameters: {
77
+ query?: never;
78
+ header?: never;
79
+ path?: never;
80
+ cookie?: never;
81
+ };
82
+ get?: never;
83
+ put?: never;
84
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method is used to cancel a bundle.<br><br>The <b>bundleId</b> value of the bundle to be canceled must be input as a path parameter in the request. <br><br><span class="tablenote"><b>Note:</b> Bundles cannot be canceled if they are currently being processed.</span> */
85
+ post: operations['cancelBundle'];
86
+ delete?: never;
87
+ options?: never;
88
+ head?: never;
89
+ patch?: never;
90
+ trace?: never;
91
+ };
92
+ '/bundle': {
93
+ parameters: {
94
+ query?: never;
95
+ header?: never;
96
+ path?: never;
97
+ cookie?: never;
98
+ };
99
+ get?: never;
100
+ put?: never;
101
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method is used to create a bundle for multiple packages in an order.<br><br>To create a bundle, the consign address to be associated with the bundle and the tracking numbers of the packages to be used in the bundle must be specified in the request. <br><br>If the call is successful, the <b>bundleId</b> for the newly created bundle will be returned.<br><br><span class="tablenote"><b>Note:</b> Sellers should keep track of the returned <b>bundleId</b>, as there is no programmatic way to retrieve this value at this time.</span> */
102
+ post: operations['createBundle'];
103
+ delete?: never;
104
+ options?: never;
105
+ head?: never;
106
+ patch?: never;
107
+ trace?: never;
108
+ };
109
+ '/bundle/{bundle_id}': {
110
+ parameters: {
111
+ query?: never;
112
+ header?: never;
113
+ path?: never;
114
+ cookie?: never;
115
+ };
116
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method is used to retrieved information about a specific bundle based on the provided bundle ID value.<br><br>The <b>bundle_id</b> value of the bundle to be retrieved must be input as a path parameter in the request. If the call is successful, information about the bundle is returned, such as its associated consign preference ID and the tracking numbers of each package in the bundle. */
117
+ get: operations['getBundle'];
118
+ put?: never;
119
+ post?: never;
120
+ delete?: never;
121
+ options?: never;
122
+ head?: never;
123
+ patch?: never;
124
+ trace?: never;
125
+ };
126
+ '/bundle/{bundle_id}/label': {
127
+ parameters: {
128
+ query?: never;
129
+ header?: never;
130
+ path?: never;
131
+ cookie?: never;
132
+ };
133
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve the bundle label for a bundle of packages.<br><br>The bundle for which to retrieve a bundle label is specified through the <b>bundleId</b> path parameter.<br><br>Bundle labels will be returned as base64 string values which can be converted to PDF files. */
134
+ get: operations['getBundleLabel'];
135
+ put?: never;
136
+ post?: never;
137
+ delete?: never;
138
+ options?: never;
139
+ head?: never;
140
+ patch?: never;
141
+ trace?: never;
142
+ };
143
+ '/complaint': {
144
+ parameters: {
145
+ query?: never;
146
+ header?: never;
147
+ path?: never;
148
+ cookie?: never;
149
+ };
150
+ get?: never;
151
+ put?: never;
152
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to create a complaint about a shipment order. Complaints can be filed if there is a pickup delay on an order or if an item has been lost in transit.<br><br>The complaint reason, complaint type, and the date the issue occurred must be specified in the request. If the complaint is being filed for a missing package, the affected <b>packageId</b> values must also be specified in the <b>affectedPackages</b> array.<br><br>If the call was successful, HTTP status code <b>201 Created</b> will be returned, and the complaint will be created. */
153
+ post: operations['createComplaint'];
154
+ delete?: never;
155
+ options?: never;
156
+ head?: never;
157
+ patch?: never;
158
+ trace?: never;
159
+ };
160
+ '/consign_preference': {
161
+ parameters: {
162
+ query?: never;
163
+ header?: never;
164
+ path?: never;
165
+ cookie?: never;
166
+ };
167
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve information about all the pickup, drop-off, and/or forward deployment consign addresses associated with a seller's eDIS account. */
168
+ get: operations['getConsignPreferences'];
169
+ put?: never;
170
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to create a consign address.<br><br>The following types of address preferences can be created via this method:<ul><li><code>PICK_UP</code></li><li><code>DROP_OFF</code></li><li><code>FORWARD_DEPLOYMENT</code></li><li><code>RDC</code></li><li><code>CN_POST_DROP_OFF</code></li><li><code>CN_POST_PICK_UP</code></li><li><code>HK_POST_DROP_OFF</code></ul>The address information for the consign address must be provided in the <b>consignAddress</b> container. If the call is successful, the <b>addressId</b> for the newly created address will be returned. This ID can then be used when creating a package to specify the consign address to use for the shipment. */
171
+ post: operations['createConsignPreference'];
172
+ delete?: never;
173
+ options?: never;
174
+ head?: never;
175
+ patch?: never;
176
+ trace?: never;
177
+ };
178
+ '/dropoff_sites': {
179
+ parameters: {
180
+ query?: never;
181
+ header?: never;
182
+ path?: never;
183
+ cookie?: never;
184
+ };
185
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve metadata for one or more drop-off sites associated with a seller's eDIS account.<br><br>Pagination query parameters are provided that allow users to control how many drop-off site locations are returned in the response. */
186
+ get: operations['getDropoffSites'];
187
+ put?: never;
188
+ post?: never;
189
+ delete?: never;
190
+ options?: never;
191
+ head?: never;
192
+ patch?: never;
193
+ trace?: never;
194
+ };
195
+ '/handover_sheet': {
196
+ parameters: {
197
+ query?: never;
198
+ header?: never;
199
+ path?: never;
200
+ cookie?: never;
201
+ };
202
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve the handover sheet for one or more packages in a pickup request.<br><br>The tracking numbers for the packages for which to retrieve handover sheets are specified through the <b>tracking_numbers</b> query parameter.<br><br>The retrieved handover sheet will be returned as a base64 string value, and can be used for confirmation with a pickup contact. Only one handover sheet will be returned for the specified packages. */
203
+ get: operations['getHandoverSheet'];
204
+ put?: never;
205
+ post?: never;
206
+ delete?: never;
207
+ options?: never;
208
+ head?: never;
209
+ patch?: never;
210
+ trace?: never;
211
+ };
212
+ '/labels': {
213
+ parameters: {
214
+ query?: never;
215
+ header?: never;
216
+ path?: never;
217
+ cookie?: never;
218
+ };
219
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve shipping labels for the one or more specified packages.<br><br>The packages for which to retrieve shipping labels can be specified through the <b>tracking_numbers</b> query parameter. The page size and print preference settings for the shipping label(s) can also be specified through the query parameters.<br><br>Shipping labels are returned as base64 string values which can be converted to PDF files. A separate file will be returned for each tracking number specified in the request. */
220
+ get: operations['getLabels'];
221
+ put?: never;
222
+ post?: never;
223
+ delete?: never;
224
+ options?: never;
225
+ head?: never;
226
+ patch?: never;
227
+ trace?: never;
228
+ };
229
+ '/package/bulk_cancel_packages': {
230
+ parameters: {
231
+ query?: never;
232
+ header?: never;
233
+ path?: never;
234
+ cookie?: never;
235
+ };
236
+ get?: never;
237
+ put?: never;
238
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to cancel multiple packages and their associated tracking numbers.<br><br>The package ID values for the packages to be canceled must be input in the <b>packageIds</b> array of the request.<br><br><span class="tablenote"><b>Note:</b> Packages cannot be cancelled if they are currently being processed.</span> */
239
+ post: operations['bulkCancelPackages'];
240
+ delete?: never;
241
+ options?: never;
242
+ head?: never;
243
+ patch?: never;
244
+ trace?: never;
245
+ };
246
+ '/package/bulk_confirm_packages': {
247
+ parameters: {
248
+ query?: never;
249
+ header?: never;
250
+ path?: never;
251
+ cookie?: never;
252
+ };
253
+ get?: never;
254
+ put?: never;
255
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to confirm the shipping order for multiple packages.<br><br>The package ID values for the packages to be confirmed must be input in the <b>packageIds</b> array of the request.<br><br>After a package is confirmed, the estimated cost will be frozen in your wallet and the pickup request will be submitted. */
256
+ post: operations['bulkConfirmPackages'];
257
+ delete?: never;
258
+ options?: never;
259
+ head?: never;
260
+ patch?: never;
261
+ trace?: never;
262
+ };
263
+ '/package/bulk_delete_packages': {
264
+ parameters: {
265
+ query?: never;
266
+ header?: never;
267
+ path?: never;
268
+ cookie?: never;
269
+ };
270
+ get?: never;
271
+ put?: never;
272
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to delete multiple packages.<br><br>The package ID values for the packages to be deleted must be input in the <b>packageIds</b> array of the request.<br><br><span class="tablenote"><b>Note:</b> Packages can only be deleted once they have been cancelled through the <b>cancelPackage</b> or <b>bulkCancelPackages</b> methods and no longer have a tracking number associated with them.</span> */
273
+ post: operations['bulkDeletePackages'];
274
+ delete?: never;
275
+ options?: never;
276
+ head?: never;
277
+ patch?: never;
278
+ trace?: never;
279
+ };
280
+ '/package/{package_id}/cancel': {
281
+ parameters: {
282
+ query?: never;
283
+ header?: never;
284
+ path?: never;
285
+ cookie?: never;
286
+ };
287
+ get?: never;
288
+ put?: never;
289
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to cancel a package and its associated tracking number.<br><br>The <b>packageId</b> value of the package to be canceled must be input as a path parameter in the request.<br><br><span class="tablenote"><b>Note:</b> Packages cannot be canceled if they are currently being processed.</span> */
290
+ post: operations['cancelPackage'];
291
+ delete?: never;
292
+ options?: never;
293
+ head?: never;
294
+ patch?: never;
295
+ trace?: never;
296
+ };
297
+ '/package/{package_id}/clone': {
298
+ parameters: {
299
+ query?: never;
300
+ header?: never;
301
+ path?: never;
302
+ cookie?: never;
303
+ };
304
+ get?: never;
305
+ put?: never;
306
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to clone a package for redelivery, resending the package with the same information input during the <b>createPackage</b> call.<br><br>The <b>packageId</b> value of the package to be cloned must be input as a path parameter in the request. */
307
+ post: operations['clonePackage'];
308
+ delete?: never;
309
+ options?: never;
310
+ head?: never;
311
+ patch?: never;
312
+ trace?: never;
313
+ };
314
+ '/package/{package_id}/confirm': {
315
+ parameters: {
316
+ query?: never;
317
+ header?: never;
318
+ path?: never;
319
+ cookie?: never;
320
+ };
321
+ get?: never;
322
+ put?: never;
323
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to confirm the shipping order for a package.<br><br>The <b>packageId</b> value of the package to be confirmed must be input as a path parameter in the request.<br><br>After confirmation the estimated cost will be frozen in your wallet and the pickup request will be submitted. */
324
+ post: operations['confirmPackage'];
325
+ delete?: never;
326
+ options?: never;
327
+ head?: never;
328
+ patch?: never;
329
+ trace?: never;
330
+ };
331
+ '/package': {
332
+ parameters: {
333
+ query?: never;
334
+ header?: never;
335
+ path?: never;
336
+ cookie?: never;
337
+ };
338
+ get?: never;
339
+ put?: never;
340
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to create a package for an order.<br><br>To create a package, the package's shipping information, such as the dimensions, weight, ship from, and ship to address, as well as information about the item(s) it contains must be specified in the request.<br><br>If the call is successful, the <b>packageId</b> and tracking number for the newly created package will be returned.<br><br><span class="tablenote"><b>Note:</b> Sellers should keep track of the returned <b>packageId</b>, as there is no programmatic way to retrieve this value at this time.</span> */
341
+ post: operations['createPackage'];
342
+ delete?: never;
343
+ options?: never;
344
+ head?: never;
345
+ patch?: never;
346
+ trace?: never;
347
+ };
348
+ '/package/{package_id}': {
349
+ parameters: {
350
+ query?: never;
351
+ header?: never;
352
+ path?: never;
353
+ cookie?: never;
354
+ };
355
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve a package based on the provided package ID value.<br><br>The <b>packageId</b> value of the package to be retrieved must be input as a path parameter in the request. If the call is successful, information about the package is returned, such as the package's shipping information (its dimensions, weight, ship from, and ship to address) and information about the item(s) it contains. */
356
+ get: operations['getPackage'];
357
+ put?: never;
358
+ post?: never;
359
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to delete a package.<br><br>The <b>packageId</b> value of the package to be deleted must be input as a path parameter in the request. If the call is successful, HTTP status code <b>204 No Content</b> will be returned, and the package will be deleted.<br><br><span class="tablenote"><b>Note:</b> Packages can only be deleted once they have been cancelled through the <b>cancelPackage</b> or <b>bulkCancelPackages</b> methods and no longer have a tracking number associated with them.</span> */
360
+ delete: operations['deletePackage'];
361
+ options?: never;
362
+ head?: never;
363
+ patch?: never;
364
+ trace?: never;
365
+ };
366
+ '/package/{order_line_item_id}/item': {
367
+ parameters: {
368
+ query?: never;
369
+ header?: never;
370
+ path?: never;
371
+ cookie?: never;
372
+ };
373
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve one or more packages based on the provided order line item ID.<br><br>This method can be followed up with <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/getPackage" target="_blank">getPackage</a> call to retrieve more detailed information about a specific package. */
374
+ get: operations['getPackagesByLineItemID'];
375
+ put?: never;
376
+ post?: never;
377
+ delete?: never;
378
+ options?: never;
379
+ head?: never;
380
+ patch?: never;
381
+ trace?: never;
382
+ };
383
+ '/services': {
384
+ parameters: {
385
+ query?: never;
386
+ header?: never;
387
+ path?: never;
388
+ cookie?: never;
389
+ };
390
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve metadata on available shipping services, such as the name, description, and directions. */
391
+ get: operations['getServices'];
392
+ put?: never;
393
+ post?: never;
394
+ delete?: never;
395
+ options?: never;
396
+ head?: never;
397
+ patch?: never;
398
+ trace?: never;
399
+ };
400
+ '/tracking': {
401
+ parameters: {
402
+ query?: never;
403
+ header?: never;
404
+ path?: never;
405
+ cookie?: never;
406
+ };
407
+ /** @description <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> This method is only available for Greater-China based sellers with an active eDIS account.</p></div><br>This method can be used to retrieve tracking event details for a package associated with the provided tracking number.<br><br>Each tracking event is returned in the <b>trackingDetails</b> array and includes the description, location, time, and status of the event. */
408
+ get: operations['getTracking'];
409
+ put?: never;
410
+ post?: never;
411
+ delete?: never;
412
+ options?: never;
413
+ head?: never;
414
+ patch?: never;
415
+ trace?: never;
416
+ };
417
+ }
418
+ export type webhooks = Record<string, never>;
419
+ export interface components {
420
+ schemas: {
421
+ /** @description This type is used to define the request container of the <b>createComplaint</b> method. */
422
+ AddComplaintRequest: {
423
+ /** @description This container is used to specify the information included in a complaint request, such as the complaint reason, date, and type. */
424
+ complaintRequest?: components['schemas']['AddComplaintRequestData'];
425
+ };
426
+ /** @description This type specifies the information included in a complaint request. */
427
+ AddComplaintRequestData: {
428
+ /** @description This array specifies a list of packages, specified by their <b>packageId</b>, affected by the issue causing the complaint.<br><br>Package ID values are returned when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method<br><br>This array is required if the complaint being filed is for a missing package. */
429
+ affectedPackages?: string[];
430
+ /** @description The date in which the issue associated with the complaint occurred.<br><br><b>Format:</b> <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code> */
431
+ complaintDate?: string;
432
+ /** @description This string specifies the reason the complaint was filed.<br><br><b>Max length</b>: 200 characters */
433
+ complaintReason?: string;
434
+ /** @description The type of complaint being filed.<br><br><b>Valid values</b>:<ul><li><code>ABNORMAL_COLLECTION_COMPLAINT</code></li><li><code>LOST_PACKAGE_COMPLAINT</code></li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:ComplaintTypeEnum'>eBay API documentation</a> */
435
+ complaintType?: string;
436
+ /**
437
+ * Format: int32
438
+ * @description The unique identifier of the address associated with the complaint.<br><br>This field is required if the complain being filed is associated with a specific address.
439
+ */
440
+ preferenceId?: number;
441
+ /** @description A remark to the seller themselves. */
442
+ remark?: string;
443
+ };
444
+ /** @description This type defines the request container used in the <b>createPackage</b> method. */
445
+ AddPackageRequest: {
446
+ /** @description This container is used to specify the information needed to create a package. */
447
+ packageInfo?: components['schemas']['PackageInfoRequest'];
448
+ };
449
+ /** @description This type defines the response container used in the <b>createPackage</b> method. */
450
+ AddPackageResponses: {
451
+ /** @description This container returns information about the newly created package, including its tracking number and <b>packageId</b> value. */
452
+ createPackageResult?: components['schemas']['AddPackageResponsesData'];
453
+ };
454
+ /** @description This type specifies information about the newly created package, such as its estimated costs, tracking number, and package ID value. */
455
+ AddPackageResponsesData: {
456
+ /** @description The estimated shipping cost of the package. */
457
+ estimateCost?: components['schemas']['Amount'];
458
+ /** @description The last-mile tracking number of the package.<br><br>This field is only returned if the last-mile tracking number is provided by the carrier. */
459
+ lastMileTrackingNumber?: string;
460
+ /** @description The unique identifier of the created package.<br><br><span class="tablenote"><b>Note:</b> Sellers should keep track of the returned <b>packageId</b>, as there is no programmatic way to retrieve this value at this time.</span> */
461
+ packageId?: string;
462
+ /** @description The actual payment cost of the package. */
463
+ paymentCost?: components['schemas']['Amount'];
464
+ /** @description The tracking number of the created package. */
465
+ trackingNumber?: string;
466
+ };
467
+ /** @description This type defines information about an EU AR agent, such as their address, name, and phone number. */
468
+ AgentInfoData: {
469
+ /** @description The address of the EU AR agent. */
470
+ agentAddress?: string;
471
+ /** @description The name of the EU AR agent. */
472
+ agentName?: string;
473
+ /** @description The phone number of the EU AR agent. */
474
+ agentPhone?: string;
475
+ };
476
+ /** @description This type defines the fields that describe an EU AR agent. */
477
+ AgentModelResponses: {
478
+ /** @description The address of the EU AR agent. */
479
+ agentAddress?: string;
480
+ /** @description The name of the EU AR agent. */
481
+ agentName?: string;
482
+ /** @description The phone number of the EU AR agent. */
483
+ agentPhone?: string;
484
+ /** @description This array returns the supported shipping countries and eBay user IDs associated with the EU AR agent. */
485
+ agentPreferences?: components['schemas']['AgentPreferenceListResponse'][];
486
+ /** @description The seller-defined setting name of the AR agent. */
487
+ arName?: string;
488
+ };
489
+ /** @description This type defines the fields that describe a EU AR agents preferences. */
490
+ AgentPreferenceListResponse: {
491
+ /** @description The eBay ID of the EU AR agent. */
492
+ ebayId?: string;
493
+ /** @description The two-letter ISO 3166 code of the shipping country that an EU AR agent supports. */
494
+ shippingCountry?: string;
495
+ };
496
+ /** @description This type defines the monetary value of an amount. */
497
+ Amount: {
498
+ /** @description This enum value represents the type of currency being used. Both the <b>value</b> and <b>currency fields</b> are required/always returned when expressing cost.<br><br> See the <a href="/api-docs/sell/edelivery_international_shipping/types/bas:CurrencyCodeEnum" target="_blank">CurrencyCodeEnum</a> type for the full list of supported values.<br><br>Both the <b>value</b> and <b>currency</b> fields are required/always returned when expressing cost. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/bas:CurrencyCodeEnum'>eBay API documentation</a> */
499
+ currency?: string;
500
+ /** @description The monetary amount, in the currency specified by the <b>currency</b> field.<br><br>Both the <b>value</b> and <b>currency</b> fields are required/always returned when expressing cost. */
501
+ value?: string;
502
+ };
503
+ /** @description This type defines the fields to describe a battery's qualifications. */
504
+ BatteryQualResponses: {
505
+ /** @description The type of the battery. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:LiBatteryTypeEnum'>eBay API documentation</a> */
506
+ batteryType?: string;
507
+ /** @description The unique identifier of the battery's electric qualification, which indicates that the battery has a certificate of approval for global shipping. */
508
+ elecQualificationId?: string;
509
+ /** @description The name of the battery's electric qualification. */
510
+ elecQualificationName?: string;
511
+ /** @description The expiration date of the battery qualification. */
512
+ expireDate?: string;
513
+ /** @description A remark to the seller themselves.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
514
+ remark?: string;
515
+ };
516
+ /** @description This type defines the response payload of the <b>getBundle</b> method. */
517
+ BundleDetailResponse: {
518
+ /** @description This container returns information about the retrieved bundle, such as its tracking numbers and consign preference ID. */
519
+ bundleDetail?: components['schemas']['BundleDetailResponseData'];
520
+ };
521
+ /** @description This type is used to specify information, such as the tracking numbers and consign preference ID, of a bundle. */
522
+ BundleDetailResponseData: {
523
+ /** @description The unique identifier of the consign address associated with the retrieved bundle. */
524
+ consignPreferenceId?: string;
525
+ /** @description This array specifies the tracking numbers of the packages included in the bundle. */
526
+ trackingNumbers?: string[];
527
+ };
528
+ /** @description This type defines the response container of the <b>getBundleLabel</b> method. */
529
+ BundleLabelResponse: {
530
+ /** @description This container returns the bundle label information, such as the base64 string value, for the specified bundle. */
531
+ label?: components['schemas']['BundleLabelResponseData'];
532
+ };
533
+ /** @description This type defines the base64 string value used to download a bundle label PDF file. */
534
+ BundleLabelResponseData: {
535
+ /** @description The base 64 string value for the bundle label.<br><br>This string value can be converted into a PDF file. */
536
+ base64Str?: string;
537
+ };
538
+ /** @description This type defines the request container for the <b>bulkCancelPackages</b> method. */
539
+ CancelPackagesRequest: {
540
+ /** @description This container is used to specify the package ID values for the packages being canceled. */
541
+ requests?: components['schemas']['CancelPackagesRequestData'];
542
+ };
543
+ /** @description This type indicates the IDs of the packages being canceled. */
544
+ CancelPackagesRequestData: {
545
+ /** @description This comma-delimited array lists the unique identifiers of the packages being canceled.<br><br>Up to 200 package IDs can be specified. */
546
+ packageIds?: string[];
547
+ };
548
+ /** @description This type defines the response container of the <b>bulkCancelPackages</b> method. */
549
+ CancelPackagesResponses: {
550
+ /** @description This array returns the result code and message for each cancelled package. Each package is denoted by its package ID value. */
551
+ responses?: components['schemas']['CancelPackagesResponsesData'][];
552
+ };
553
+ /** @description This type indicates the response data returned after canceling multiple packages. */
554
+ CancelPackagesResponsesData: {
555
+ /** @description This string returns any additional information about the cancelation of the package. */
556
+ message?: string;
557
+ /** @description The unique identifier of the canceled package. */
558
+ packageId?: string;
559
+ /** @description The result code detailing the results cancelation process.<br><br>For example, a result code of <code>200</code> indicates that the call was a success and the package and tracking number were canceled. */
560
+ resultCode?: string;
561
+ };
562
+ /** @description This type defines the response container used in the <b>clonePackage</b> method. */
563
+ ClonePackageResponses: {
564
+ /** @description This container returns the package ID, payment cost, and tracking number for the cloned package. */
565
+ clonePackageResult?: components['schemas']['ClonePackageResponsesData'];
566
+ };
567
+ /** @description This type specifies the package ID, payment cost, tracking number, and last-mile tracking number (if applicable) for the cloned package. */
568
+ ClonePackageResponsesData: {
569
+ /** @description The last-mile tracking number of the package.<br><br>This field is only returned if the last-mile tracking number is provided by the carrier. */
570
+ lastMileTrackingNumber?: string;
571
+ /** @description The unique identifier of the package. A new <b>packageId</b> value is generated when a package is cloned. */
572
+ packageId?: string;
573
+ /** @description The payment cost for the package. */
574
+ paymentCost?: components['schemas']['Amount'];
575
+ /** @description The tracking number for the cloned package. */
576
+ trackingNumber?: string;
577
+ };
578
+ /** @description This type defines the request container of the <b>bulkConfirmPackages</b> method. */
579
+ ConfirmPackagesRequest: {
580
+ /** @description This container is used to specify the package ID values of the packages being confirmed. */
581
+ requests?: components['schemas']['ConfirmPackagesRequestData'];
582
+ };
583
+ /** @description This type specifies the IDs of the packages being confirmed. */
584
+ ConfirmPackagesRequestData: {
585
+ /** @description This comma-delimited array lists the unique identifiers of the packages being confirmed.<br><br>Up to 200 packages can be specified. */
586
+ packageIds?: string[];
587
+ };
588
+ /** @description This type defines the response container of the <b>bulkConfirmPackages</b> method. */
589
+ ConfirmPackagesResponses: {
590
+ /** @description This array returns the result code and message for each confirmed package. Each package is denoted by its package ID value. */
591
+ responses?: components['schemas']['ConfirmPackagesResponsesData'][];
592
+ };
593
+ /** @description This type indicates the response data after confirming multiple packages. */
594
+ ConfirmPackagesResponsesData: {
595
+ /** @description This string returns any additional information about the confirmation of the package. */
596
+ message?: string;
597
+ /** @description The unique identifier of the confirmed package. */
598
+ packageId?: string;
599
+ /** @description The result code relating to the confirmation of the package.<br><br>For example, a result code of <code>200</code> indicates that the call was a success and the package was confirmed. */
600
+ resultCode?: string;
601
+ };
602
+ /** @description This type specifies the fields used to create a consign address. */
603
+ ConsignPreferenceInfoResponses: {
604
+ /** @description The unique identifier of the consign address. */
605
+ consignPreferenceId?: string;
606
+ /** @description The name of the consign address. */
607
+ consignPreferenceName?: string;
608
+ /** @description The unique identifier of the drop-off site.<br><br>This field is only returned if the consign address is a drop-off location. */
609
+ dropoffSiteId?: string;
610
+ /** @description This container returns the address and contact information for a pickup address.<br><br><span class="tablenote"><b>Note:</b> This container is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
611
+ pickupAddress?: components['schemas']['PickupAddressResponsesData'];
612
+ /** @description The supported pickup window that the pickup location supports.<br><br>This field is only returned if the consign address is a pickup-from location For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:PickUpTimeTypeEnum'>eBay API documentation</a> */
613
+ pickupTime?: string;
614
+ /** @description The address type of the consign address.<br><br><b>Valid values</b>:<ul><li><code>PICK_UP</code></li><li><code>DROP_OFF</code></li><li><code>FORWARD_DEPLOYMENT</code></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:ConsignTypeEnum'>eBay API documentation</a> */
615
+ type?: string;
616
+ };
617
+ /** @description This type is used to define the request container used in the <b>createAddressPreference</b> method. */
618
+ CreateAddressPreferenceRequest: {
619
+ /** @description This container is used to specify the address details used to create an address. */
620
+ shipFromAddress?: components['schemas']['CreateAddressPreferenceRequestData'];
621
+ };
622
+ /** @description This type is used to specify the address details used to create an address. */
623
+ CreateAddressPreferenceRequestData: {
624
+ /** @description The city code of the address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid city codes. */
625
+ city?: string;
626
+ /** @description The company name associated with the address.<br><br><b>Max length</b>: 50 characters */
627
+ company?: string;
628
+ /** @description The name of the contact person associated with the address.<br><br><b>Max length</b>: 50 characters */
629
+ contact?: string;
630
+ /** @description The two-letter country code of the address.<br><br><b>Valid values</b>:<ul><li>CN</li><li>HK</li></ul> */
631
+ countryCode?: string;
632
+ /** @description The district code of the address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid district codes. */
633
+ district?: string;
634
+ /** @description The name of the address.<br><br><b>Max length</b>: 50 characters */
635
+ name?: string;
636
+ /** @description The phone number associated with the address. */
637
+ phone?: string;
638
+ /** @description The postal code of the address. */
639
+ postcode?: string;
640
+ /** @description The province code of the address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid province codes. */
641
+ province?: string;
642
+ /** @description The first line of the street address of the address.<br><br><b>Max length</b>: 50 characters */
643
+ street1?: string;
644
+ /** @description The second line, if applicable, of the street address of the address.<br><br><b>Max length</b>: 50 characters */
645
+ street2?: string;
646
+ /** @description The third line, if applicable, of the street address of the address.<br><br><b>Max length</b>: 50 characters */
647
+ street3?: string;
648
+ /** @description The address type of the address being created.<br><br><b>Valid values</b>:<ul><li><code>SHIP_FROM_ADDRESS</code></li><li><code>RETURN_ADRESS</code></li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:AddressTypeEnum'>eBay API documentation</a> */
649
+ type?: string;
650
+ };
651
+ /** @description This type is used to define the response container of the <b>createAddressPreference</b> method. */
652
+ CreateAddressPreferenceResponses: {
653
+ /** @description This container specifies the unique identifier of the newly created address. */
654
+ shipFromAddressId?: components['schemas']['CreateAddressPreferenceResponsesData'];
655
+ };
656
+ /** @description This type defines the unique identifier of a newly created address. */
657
+ CreateAddressPreferenceResponsesData: {
658
+ /** @description The unique identifier of the newly-created address.<br><br>This ID value can be used when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method to specify the ship-from or return address associated with the package. */
659
+ addressId?: string;
660
+ };
661
+ /** @description This type defines the request container of the <b>createBundle</b> method. */
662
+ CreateBundleRequest: {
663
+ /** @description This container is used to specify the information needed to create a bundle, such as the consign address associated with the bundle and the tracking numbers of the packages to be included in the bundle. */
664
+ bundle?: components['schemas']['CreateBundleRequestData'];
665
+ };
666
+ /** @description This type defines the information used to create a bundle. */
667
+ CreateBundleRequestData: {
668
+ /** @description The unique identifier of the consign address to be associated with the bundle.<br><br>This ID can be retrieved using the <a href="/api-docs/sell/edelivery_international_shipping/resources/consign_preference/methods/getConsignPreferences" target="_blank">getConsignPreferences</a> method. */
669
+ consignPreferenceId?: string;
670
+ /** @description This array specifies the tracking numbers of the packages to be included in the bundle.<br><br>Tracking numbers are returned when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method. */
671
+ trackingNumbers?: string[];
672
+ };
673
+ /** @description This type defines the response container of the <b>createBundle</b> method */
674
+ CreateBundleResponse: {
675
+ /** @description This container returns information about the newly created bundle, such as its <b>bundleId</b> value. */
676
+ bundle?: components['schemas']['CreateBundleResponseData'];
677
+ };
678
+ /** @description This type defines the unique identifier of the newly-created bundle. */
679
+ CreateBundleResponseData: {
680
+ /** @description The unique identifier of the newly created bundle. */
681
+ bundleId?: string;
682
+ };
683
+ /** @description This type is used to define the request container of the <b>createConsignPreference</b> method. */
684
+ CreateConsignPreferenceRequest: {
685
+ /** @description This container is used to specify the address details used to create a consign address. */
686
+ consignAddress?: components['schemas']['CreateConsignPreferenceRequestData'];
687
+ };
688
+ /** @description This type is used to specify the address details used to create a consign address. */
689
+ CreateConsignPreferenceRequestData: {
690
+ /** @description The name of the consign address. */
691
+ consignPreferenceName?: string;
692
+ /** @description The unique identifier of a drop-off site location. This value can be retrieved using the <a href="/api-docs/sell/edelivery_international_shipping/resources/dropoff_sites/methods/getDropoffSites" target="_blank">getDropoffSites</a> method.<br><br>This field is required if the <code>DROPOFF</code> address type is specified. */
693
+ dropoffSiteId?: string;
694
+ /** @description This container is used to specify the address details used to create a pickup-from address.<br><br>This container is required if the <code>PICK_UP</code> address type is specified. */
695
+ pickupAddress?: components['schemas']['PickupAddressRequestData'];
696
+ /** @description The pickup time that the pickup location supports.<br><br>This field is required if the <code>PICK_UP</code> address type is specified. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:PickUpTimeTypeEnum'>eBay API documentation</a> */
697
+ pickupTime?: string;
698
+ /** @description The address type of the consign address.<br><br><b>Valid values</b>:<ul><li><code>PICK_UP</code></li><li><code>DROP_OFF</code></li><li><code>FORWARD_DEPLOYMENT</code></li><li><code>RDC</code></li><li><code>CN_POST_DROP_OFF</code></li><li><code>CN_POST_PICK_UP</code></li><li><code>HK_POST_DROP_OFF</code></li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:ConsignTypeEnum'>eBay API documentation</a> */
699
+ type?: string;
700
+ };
701
+ /** @description This type defines the response container for the <b>createConsignPreference</b> method. */
702
+ CreateConsignPreferenceResponses: {
703
+ /** @description This container specifies the unique identifier of the newly created consign address. */
704
+ consignAddressId?: components['schemas']['CreateConsignPreferenceResponsesData'];
705
+ };
706
+ /** @description This type defines the unique identifier of the newly created consign address. */
707
+ CreateConsignPreferenceResponsesData: {
708
+ /** @description The unique identifier of the newly-created consign address.<br><br>This ID can be used when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method to specify the pickup, drop-off, or forward deployment address associated with the package. */
709
+ consignPreferenceId?: string;
710
+ };
711
+ /** @description This type defines the request container for the <b>bulkDeletePackages</b> method. */
712
+ DeletePackagesRequest: {
713
+ /** @description This container is used to specify the package ID values for the packages being deleted. */
714
+ requests?: components['schemas']['DeletePackagesRequestData'];
715
+ };
716
+ /** @description DeletePackagesRequestData */
717
+ DeletePackagesRequestData: {
718
+ /** @description This comma-delimited array lists the unique identifiers of the packages being deleted. These values must be for packages that have been cancelled and do not have tracking numbers associated with them.<br><br>Package ID values are returned when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method. */
719
+ packageIds?: string[];
720
+ };
721
+ /** @description This type defines the response container of the <b>bulkDeletePackages</b> method. */
722
+ DeletePackagesResponses: {
723
+ /** @description This array returns the result code and message for each deleted package. Each package is denoted by its package ID value. */
724
+ responses?: components['schemas']['DeletePackagesResponsesData'][];
725
+ };
726
+ /** @description This type defines the response data after deleting multiple packages. */
727
+ DeletePackagesResponsesData: {
728
+ /** @description This string returns any additional information about the deletion of the package. */
729
+ message?: string;
730
+ /** @description The unique identifier of the deleted package. */
731
+ packageId?: string;
732
+ /** @description The result code detailing the result of the deletion process.<br><br>For example, a result code of <code>200</code> indicates that the call was a success and the package was deleted. */
733
+ resultCode?: string;
734
+ };
735
+ /** @description This container specifies direction information for a shipping service. */
736
+ DirectionsResponses: {
737
+ /** @description The supported battery type for the shipping service. */
738
+ batteryType?: string;
739
+ /** @description The two-letter ISO 3166 ship-from country code. */
740
+ from?: string;
741
+ /** @description The two-letter ISO 3166 destination country code. */
742
+ to?: string;
743
+ };
744
+ /** @description This type defines the fields that can be returned in an error. */
745
+ Error: {
746
+ /** @description Identifies the type of erro. */
747
+ category?: string;
748
+ /** @description Name for the primary system where the error occurred. This is relevant for application errors. */
749
+ domain?: string;
750
+ /**
751
+ * Format: int32
752
+ * @description A unique number to identify the error.
753
+ */
754
+ errorId?: number;
755
+ /** @description An array of request elements most closely associated to the error. */
756
+ inputRefIds?: string[];
757
+ /** @description A more detailed explanation of the error. */
758
+ longMessage?: string;
759
+ /** @description Information on how to correct the problem, in the end user's terms and language where applicable. */
760
+ message?: string;
761
+ /** @description An array of request elements most closely associated to the error. */
762
+ outputRefIds?: string[];
763
+ /** @description An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. */
764
+ parameters?: components['schemas']['ErrorParameter'][];
765
+ /** @description Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc. */
766
+ subdomain?: string;
767
+ };
768
+ ErrorParameter: {
769
+ /** @description The object of the error. */
770
+ name?: string;
771
+ /** @description The value of the object. */
772
+ value?: string;
773
+ };
774
+ /** @description This type specifies FDC SKU information. */
775
+ FDCSkuRequest: {
776
+ /**
777
+ * Format: int32
778
+ * @description The quantity of the FDC SKU.
779
+ */
780
+ quantity?: number;
781
+ /** @description The unique identifier of the FDC SKU. */
782
+ skuId?: string;
783
+ };
784
+ /** @description This type defines the response containers of the <b>getActualCost</b> method. */
785
+ GetActualCostResponses: {
786
+ /** @description This array returns a list of actual costs associated with the packages matching the input criteria. */
787
+ actualCosts?: components['schemas']['GetActualCostResponsesData'][];
788
+ };
789
+ /** @description This type defines the actual weight, cost, and additional information of a specified package or packages. */
790
+ GetActualCostResponsesData: {
791
+ /** @description The actual weight of the package in grams. */
792
+ actualWeight?: number;
793
+ /** @description This container specifies the total monetary amount of the actual cost of the package. */
794
+ amount?: components['schemas']['Amount'];
795
+ /** @description The time the seller was charged for the actual cost of the package in UTC format. */
796
+ billingTime?: string;
797
+ /** @description The two-digit charge mode for the package.<br><br><b>Valid values</b>:<ul><li><code>01</code>: Actual weight</li><li><code>02</code>: Additional dimension weight</li><li><code>03</code>: Charged by lite mode</li></ul> */
798
+ chargeMode?: string;
799
+ /** @description The weight, in grams, charged for when shipping the package. */
800
+ chargeWeight?: number;
801
+ /** @description The two-digit cost type of the package. This field indicates any fees associated with the package.<br><br>The following values are the typical cost types returned through this field. If an undocumented cost type is returned, check the logistic provider's website for the latest values:<br><ul><li><code>01</code>: Shipping fee</li><li><code>02</code>: Domestic</li><li><code>03</code>: Return fee</li><li><code>04</code>: Domestic burning fee</li><li><code>05</code>: Custom collected fee</li><li><code>06</code>: Weight gap fee</li><li><code>07</code>: Duplication compensation</li></ul> */
802
+ costType?: string;
803
+ /** @description A seller-defined message to the buyer regarding the transaction.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
804
+ message?: string;
805
+ /** @description A remark to the seller themselves.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
806
+ remark?: string;
807
+ /** @description The result code associated with the call.<br><br>For example, a result code of <code>200</code> indicates that the call was a success. */
808
+ resultCode?: string;
809
+ /** @description The size of the package in centimeters. This value is returned in Length*Width*Height format. */
810
+ size?: string;
811
+ /** @description The tracking number associated with the package. */
812
+ trackingNumber?: string;
813
+ };
814
+ /** @description This type defines the response container associated with the <b>getAddressPreferences</b> method. */
815
+ GetAddressPreferenceListResponses: {
816
+ /** @description This container returns all ship-from and/or return addresses associated with a seller's eDIS account. */
817
+ addressPreferenceList?: components['schemas']['GetAddressPreferenceListResponsesData'];
818
+ };
819
+ /** @description This type defines the list of addresses associated with a eDIS account. */
820
+ GetAddressPreferenceListResponsesData: {
821
+ /** @description This array returns a list of address, contact, and identifier information for each of a seller's ship-from and/or return addresses associated with their eDIS account. */
822
+ addresses?: components['schemas']['GetAddressPreferencesResponses'][];
823
+ };
824
+ /** @description This type defines the fields associated with a seller's ship-from address, including the location and contact details of the addresses, as well as its unique identifier. */
825
+ GetAddressPreferencesResponses: {
826
+ /** @description The unique identifier of the address. */
827
+ addressId?: string;
828
+ /** @description The city code of the address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid city codes. */
829
+ city?: string;
830
+ /** @description The city name of the address. */
831
+ cityName?: string;
832
+ /** @description The company name associated with the address. */
833
+ company?: string;
834
+ /** @description The name of the contact person associated with the address. */
835
+ contact?: string;
836
+ /** @description The two-letter country code of the address. */
837
+ countryCode?: string;
838
+ /** @description The country name of the address. */
839
+ countryName?: string;
840
+ /** @description The district code of the address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid district codes. */
841
+ district?: string;
842
+ /** @description The district name of the address. */
843
+ districtName?: string;
844
+ /** @description The name of the address. */
845
+ name?: string;
846
+ /** @description The phone number associated with the address. */
847
+ phone?: string;
848
+ /** @description The postal code of the address. */
849
+ postcode?: string;
850
+ /** @description The province code of the address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid province codes. */
851
+ province?: string;
852
+ /** @description The province name of the address. */
853
+ provinceName?: string;
854
+ /** @description The first line of the street address of the address. */
855
+ street1?: string;
856
+ /** @description The second line of the street address of the address.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
857
+ street2?: string;
858
+ /** @description The third line of the street address of address.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
859
+ street3?: string;
860
+ /** @description The address type of the address. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:AddressTypeEnum'>eBay API documentation</a> */
861
+ type?: string;
862
+ };
863
+ /** @description This type defines the response container of the <b>getAgents</b> method. */
864
+ GetAgentListResponses: {
865
+ /** @description This container returns a list of all EU AR agents associated with your eDIS account and their information. */
866
+ agentList?: components['schemas']['GetAgentListResponsesData'];
867
+ };
868
+ /** @description This type defines the fields in a paginated result set of agents associated with a seller's eDIS account. The response consists of 0 or more sequenced pages that are returned from the complete result set, where each page consists of 0 or more items. */
869
+ GetAgentListResponsesData: {
870
+ /** @description This array returns information about each EU AR agent associated with a seller's eDIS account, including their contact information, eBay ID, and supported shipping countries. */
871
+ agents?: components['schemas']['AgentModelResponses'][];
872
+ /** @description The URL to the current page of the result set. */
873
+ href?: string;
874
+ /**
875
+ * Format: int32
876
+ * @description The value of the <b>limit</b> parameter submitted in the request.
877
+ */
878
+ limit?: number;
879
+ /** @description The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. */
880
+ next?: string;
881
+ /**
882
+ * Format: int32
883
+ * @description The value of the <b>offset</b> parameter submitted in the request.
884
+ */
885
+ offset?: number;
886
+ /** @description The URI for the previous page of results. This is returned if there is a previous page of results from the result set. */
887
+ prev?: string;
888
+ /**
889
+ * Format: int32
890
+ * @description The total number of results that match the input criteria.
891
+ */
892
+ total?: number;
893
+ };
894
+ /** @description This type defines the response container of the <b>getbatteryQualifications</b> method. */
895
+ GetBatteryQualListResponses: {
896
+ /** @description This container returns a list of all battery qualifications associated with an eDIS account. */
897
+ batteryQualificationList?: components['schemas']['GetBatteryQualListResponsesData'];
898
+ };
899
+ /** @description This type defines the fields in a paginated result set of battery qualifications associated with a seller's eDIS account. The response consists of 0 or more sequenced pages that are returned from the complete result set, where each page consists of 0 or more items. */
900
+ GetBatteryQualListResponsesData: {
901
+ /** @description The URL to the current page of the result set. */
902
+ href?: string;
903
+ /**
904
+ * Format: int32
905
+ * @description The value of the <b>limit</b> parameter submitted in the request.
906
+ */
907
+ limit?: number;
908
+ /** @description The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. */
909
+ next?: string;
910
+ /**
911
+ * Format: int32
912
+ * @description The value of the <b>offset</b> parameter submitted in the request.
913
+ */
914
+ offset?: number;
915
+ /** @description The URI for the previous page of results. This is returned if there is a previous page of results from the result set. */
916
+ prev?: string;
917
+ /** @description This array returns information about each battery qualification associated with an eDIS account, such as the battery type, qualification name, and expiration date. */
918
+ qualifications?: components['schemas']['BatteryQualResponses'][];
919
+ /**
920
+ * Format: int32
921
+ * @description The total number of results that match the input criteria.
922
+ */
923
+ total?: number;
924
+ };
925
+ /** @description This type defines the response container of the <b>getConsignPreferences</b> method. */
926
+ GetConsignPreferenceListResponses: {
927
+ /** @description This container returns a list of all consign addresses associated with a seller's eDIS account. */
928
+ consignPreferenceList?: components['schemas']['GetConsignPreferenceListResponsesData'];
929
+ };
930
+ /** @description This type defines the fields associated with a seller's consign addresses, including the location and contact details of the address, as well as its unique identifiers. */
931
+ GetConsignPreferenceListResponsesData: {
932
+ /** @description This array returns information about each of a seller's consign addresses associated with their eDIS account. */
933
+ consignPreferences?: components['schemas']['ConsignPreferenceInfoResponses'][];
934
+ };
935
+ /** @description This type defines the response container associated with the <b>getDropoffSites</b> method. */
936
+ GetDropoffSiteListResponses: {
937
+ /** @description This container returns a list of all of the drop-off site locations associated with an eDIS account. */
938
+ dropoffSiteList?: components['schemas']['GetDropoffSitesResponsesData'];
939
+ };
940
+ /** @description This type defines the fields associated with one or more drop-off sites associated with a seller's eDIS account. */
941
+ GetDropoffSitesResponses: {
942
+ /** @description The city code of the drop-off site location.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid city codes. */
943
+ city?: string;
944
+ /** @description The name of the contact person associated with the drop-off site location. */
945
+ contact?: string;
946
+ /** @description The two-letter country code associated with the drop-off site location. */
947
+ country?: string;
948
+ /** @description The district code of the drop-off site location.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid district codes. */
949
+ district?: string;
950
+ /** @description The unique identifier of the drop-off site location. */
951
+ dropoffSiteId?: string;
952
+ /** @description The name of the drop-off site location. */
953
+ name?: string;
954
+ /** @description The phone number associated with the drop-off site location. */
955
+ phone?: string;
956
+ /** @description The province code of the drop-off site location.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid province codes. */
957
+ province?: string;
958
+ /** @description The first line of the street address of the drop-off site location. */
959
+ street1?: string;
960
+ /** @description The second line, if applicable, of the street address of the drop-off site location.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
961
+ street2?: string;
962
+ /** @description The third line, if applicable, of the street address of the drop-off site location.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
963
+ street3?: string;
964
+ /** @description The type of the drop-off site location.<br><br>Currently, the only valid response is <code>DROP_OFF</code>. */
965
+ type?: string;
966
+ };
967
+ /** @description This type defines the list of drop-off site locations associated with an eDIS account. */
968
+ GetDropoffSitesResponsesData: {
969
+ /** @description This array returns address, contact, and identifier information for each of a seller's drop-off locations associated with their eDIS account. */
970
+ dropoffSites?: components['schemas']['GetDropoffSitesResponses'][];
971
+ /** @description The URL to the current page of the result set. */
972
+ href?: string;
973
+ /**
974
+ * Format: int32
975
+ * @description The value of the <b>limit</b> parameter submitted in the request.
976
+ */
977
+ limit?: number;
978
+ /** @description The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. */
979
+ next?: string;
980
+ /**
981
+ * Format: int32
982
+ * @description The value of the <b>offset</b> parameter submitted in the request.
983
+ */
984
+ offset?: number;
985
+ /** @description The URI for the previous page of results. This is returned if there is a previous page of results from the result set. */
986
+ prev?: string;
987
+ /**
988
+ * Format: int32
989
+ * @description The total number of results that match the input criteria.
990
+ */
991
+ total?: number;
992
+ };
993
+ /** @description This type is used to define the response container for the <b>getHandoverSheet</b> method. */
994
+ GetHandoverSheetResponses: {
995
+ /** @description This container returns the base64 string value for a handover sheet. */
996
+ handoverSheet?: components['schemas']['GetHandoverSheetResponsesData'];
997
+ };
998
+ /** @description This type specifies the base64 string value for a handover sheet. */
999
+ GetHandoverSheetResponsesData: {
1000
+ /** @description The base 64 string value for a handover sheet. This string can be converted to a PDF file once it has been retrieved. */
1001
+ base64Str?: string;
1002
+ };
1003
+ /** @description This type defines the response container of the <b>getPackageByLineItemID</b> method. */
1004
+ GetItemPackageIdResponses: {
1005
+ /** @description This array returns a list of packages associated with the specified line item ID. */
1006
+ itemPackages?: components['schemas']['GetItemPackageIdResponsesData'][];
1007
+ };
1008
+ /** @description This type returns information on the packages being retrieved based on the specified line item ID. */
1009
+ GetItemPackageIdResponsesData: {
1010
+ /** @description The unique identifier of the package. */
1011
+ packageId?: string;
1012
+ /** @description The current status of the package. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:PackageStatusEnum'>eBay API documentation</a> */
1013
+ packageStatus?: string;
1014
+ /** @description The tracking number of the package. */
1015
+ trackingNumber?: string;
1016
+ };
1017
+ /** @description This type defines the response container of the <b>getLabels</b> method. */
1018
+ GetLabelListResponses: {
1019
+ /** @description This array returns the shipping label information, such as the base64 string value and result code for each specified tracking number. */
1020
+ labels?: components['schemas']['GetLabelListResponsesData'][];
1021
+ };
1022
+ /** @description GetLabelListResponsesData */
1023
+ GetLabelListResponsesData: {
1024
+ /** @description The base 64 string value for a shipping label.<br><br>This string value can be converted to a PDF file. */
1025
+ base64Str?: string;
1026
+ /** @description A message relating to the status of the shipping label retrieval process. */
1027
+ message?: string;
1028
+ /** @description The result code detailing the results of the shipping label retrieval process.<br><br>For example, a result code of <code>200</code> indicates that at least one shipping label was successfully retrieved. */
1029
+ resultCode?: string;
1030
+ /** @description The tracking number for which the shipping label is being retrieved. */
1031
+ trackingNumber?: string;
1032
+ };
1033
+ /** @description This type defines the response container of the <b>getPackage</b> method. */
1034
+ GetPackageDetailResponses: {
1035
+ /** @description This container returns the details for the specified package. */
1036
+ packageDetail?: components['schemas']['GetPackageDetailResponsesData'];
1037
+ };
1038
+ /** @description This type specifies the details returned for the specified package. */
1039
+ GetPackageDetailResponsesData: {
1040
+ /** @description This container returns EU AR agent information associated with the package. */
1041
+ agentInfoResponse?: components['schemas']['AgentInfoData'];
1042
+ /** @description The unique identifier of the consign address associated with the package. */
1043
+ consignPreferenceId?: string;
1044
+ /** @description The incoterm information associated with the package.<br><br><b>Supported values</b>:<ul><li><code>DDP</code></li><li><code>DDU</code></li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:IncotermEnum'>eBay API documentation</a> */
1045
+ incoterm?: string;
1046
+ /** @description This array returns information about the eBay line item(s) that are included in the package. */
1047
+ items?: components['schemas']['ItemResponses'][];
1048
+ /** @description The last-mile tracking number of the package.<br><br>This field is only returned if the last-mile tracking number is provided by the carrier. */
1049
+ lastMileTrackingNumber?: string;
1050
+ /** @description The seller-defined remark to the buyer associated with the package. */
1051
+ packageComment?: string;
1052
+ /** @description The height of the package in centimeters. */
1053
+ packageHeight?: number;
1054
+ /** @description The unique identifier of the package. */
1055
+ packageId?: string;
1056
+ /** @description The length of the package in centimeters. */
1057
+ packageLength?: number;
1058
+ /** @description The current status of the package. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:PackageStatusEnum'>eBay API documentation</a> */
1059
+ packageStatus?: string;
1060
+ /** @description The weight of the package in grams. */
1061
+ packageWeight?: number;
1062
+ /** @description The width of the package in centimeters. */
1063
+ packageWidth?: number;
1064
+ /** @description The actual payment cost of the package. */
1065
+ paymentCost?: components['schemas']['Amount'];
1066
+ /** @description The unique identifier of the ship-from address associated with the package. */
1067
+ shipFromAddressId?: string;
1068
+ /** @description The unique identifier of the shipping service used for the package. */
1069
+ shippingServiceId?: string;
1070
+ /** @description This container returns information about the address the package is being shipped to. */
1071
+ shipToAddress?: components['schemas']['ShipToAddressResponsesData'];
1072
+ /** @description This container returns any special services associated with this package.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
1073
+ specialServiceDetail?: components['schemas']['SpecialServiceDetail'];
1074
+ /** @description The declared value of the package. */
1075
+ valueForCarriage?: string;
1076
+ };
1077
+ /** @description This type defines the response container of the </b>getService</b> method. */
1078
+ GetServiceListResponses: {
1079
+ /** @description This container returns shipping service metadata associated with a seller's eDIS account. */
1080
+ serviceList?: components['schemas']['GetServiceListResponsesData'];
1081
+ };
1082
+ /** @description This type defines the details returned for the retrieved shipping service(s). */
1083
+ GetServiceListResponsesData: {
1084
+ /** @description The URL to the current page of the result set. */
1085
+ href?: string;
1086
+ /**
1087
+ * Format: int32
1088
+ * @description The value of the <b>limit</b> parameter submitted in the request.
1089
+ */
1090
+ limit?: number;
1091
+ /** @description The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. */
1092
+ next?: string;
1093
+ /**
1094
+ * Format: int32
1095
+ * @description The value of the <b>offset</b> parameter submitted in the request.
1096
+ */
1097
+ offset?: number;
1098
+ /** @description The URI for the previous page of results. This is returned if there is a previous page of results from the result set. */
1099
+ prev?: string;
1100
+ /** @description This array returns a list of available shipping services, as well as the descriptions, directions, and identifiers of each service. */
1101
+ services?: components['schemas']['ServiceInfoResponses'][];
1102
+ /**
1103
+ * Format: int32
1104
+ * @description The total number of shipping services being displayed on the current results page.
1105
+ */
1106
+ total?: number;
1107
+ };
1108
+ /** @description This container defines the response container for the <b>getTracking</b> method. */
1109
+ GetTrackingDetailResponses: {
1110
+ /** @description This array returns a list of tracking event details for the specified tracking number. */
1111
+ trackingDetails?: components['schemas']['GetTrackingDetailResponsesData'][];
1112
+ };
1113
+ /** @description This type specifies the tracking event details for the specified tracking number. */
1114
+ GetTrackingDetailResponsesData: {
1115
+ /** @description The city code in which the tracking event occurred.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid city codes.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
1116
+ city?: string;
1117
+ /** @description The two-letter ISO 3166 country code where the tracking event occurred. */
1118
+ country?: string;
1119
+ /** @description The English description of the tracking event. */
1120
+ descriptionEn?: string;
1121
+ /** @description The Chinese description of the tracking event. */
1122
+ descriptionZh?: string;
1123
+ /** @description The district code where the tracking event occurred.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid district codes.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
1124
+ district?: string;
1125
+ /** @description The postal code of where the tracking event occurred.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
1126
+ eventPostalCode?: string;
1127
+ /** @description This timestamp the time and date the tracking event occurred. */
1128
+ eventTime?: string;
1129
+ /** @description The province code where the tracking event occurred.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for province district codes.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
1130
+ province?: string;
1131
+ /** @description The status of the shipment. */
1132
+ status?: string;
1133
+ /** @description The tracking number specified in the request. */
1134
+ trackingNumber?: string;
1135
+ };
1136
+ /** @description This container specifies information about the items being included in a package. */
1137
+ ItemRequest: {
1138
+ /** @description The buyer's eBay user ID. */
1139
+ buyerId?: string;
1140
+ /** @description The tax ID for the buyer. The type of Tax ID is specified in the <b>buyerTaxIdType</b> field. */
1141
+ buyerTaxId?: string;
1142
+ /** @description The type of tax ID that was supplied by the buyer during the checkout process. */
1143
+ buyerTaxType?: string;
1144
+ /** @description This boolean indicates if the corresponding line item is subject to a 'Collect and Remit' tax that eBay will collect and remit to the proper taxing authority on the buyer's behalf. */
1145
+ ebayCollectAndRemitTax?: boolean;
1146
+ /** @description The value of the 'Collect and Remit' tax for the order that the line item belongs to. */
1147
+ ebayCollectAndRemitTaxesValue?: string;
1148
+ /** @description The buyer's email address. */
1149
+ email?: string;
1150
+ /** @description The title of the listing. */
1151
+ itemTitle?: string;
1152
+ /** @description The unique identifier of the eBay listing.<br><br><span class="tablenote"><b>Note:</b> Either a <b>listingId</b> and <b>transactionId</b> pair, or an <b>orderLineItem</b> field is required to identify an order line item.</span> */
1153
+ listingId?: string;
1154
+ /** @description A message from the seller to the buyer. */
1155
+ message?: string;
1156
+ /** @description The unique identifier of the eBay order that the line item belongs to. */
1157
+ orderId?: string;
1158
+ /** @description The unique identifier of the line item.<br><br><span class="tablenote"><b>Note:</b> Either a <b>listingId</b> and <b>transactionId</b> pair, or an <b>orderLineItem</b> field is required to identify an order line item.<span> */
1159
+ orderLineItem?: string;
1160
+ /** @description The date and time the buyer pays for the order.<br><br><b>Format:</b> <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code> */
1161
+ paymentDate?: string;
1162
+ /** @description The buyer's PayPal email address. */
1163
+ payPalEmail?: string;
1164
+ /** @description The buyer's PayPal message. */
1165
+ payPalMessage?: string;
1166
+ /**
1167
+ * Format: int32
1168
+ * @description The quantity of the line item that will be shipped with the package. This value can differ from the order quantity in the case of a combined or split shipment.<br><br><b>Min</b>: 1<br><br><b>Max</b>: 999
1169
+ */
1170
+ postedQuantity?: number;
1171
+ /**
1172
+ * Format: int32
1173
+ * @description The unique identifier of the eBay site in which the order occurred.
1174
+ */
1175
+ siteId?: number;
1176
+ /** @description This container specifies information relating to the item being shipped in the package. */
1177
+ sku?: components['schemas']['SkuRequest'];
1178
+ /** @description The date the item was sold.<br><br><b>Format</b>: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code> */
1179
+ soldDate?: string;
1180
+ /** @description The price for which the item was sold. */
1181
+ soldPrice?: components['schemas']['Amount'];
1182
+ /**
1183
+ * Format: int32
1184
+ * @description The quantity of the line item that was sold.
1185
+ */
1186
+ soldQuantity?: number;
1187
+ /** @description The unique identifier of the monetary transaction.<br><br><span class="tablenote"><b>Note:</b> Either a <b>listingId</b> and <b>transactionId</b> pair, or an <b>orderLineItem</b> field is required to identify an order line item.</span> */
1188
+ transactionId?: string;
1189
+ };
1190
+ /** @description This type defines item information for items in a package. */
1191
+ ItemResponses: {
1192
+ /** @description The buyer's eBay ID. */
1193
+ buyerId?: string;
1194
+ /** @description The buyer's tax ID. */
1195
+ buyerTaxId?: string;
1196
+ /** @description The buyer's tax type. */
1197
+ buyerTaxType?: string;
1198
+ /** @description If returned as <code>true</code>, this boolean indicates that eBay will collect tax for the corresponding line item, and remit the tax to the taxing authority of the buyer's residence. */
1199
+ ebayCollectAndRemitTax?: boolean;
1200
+ /** @description The value of the collect and remit tax for the corresponding line item. This field is only returned if collect and remit tax is applied to the line item. */
1201
+ ebayCollectAndRemitTaxesValue?: string;
1202
+ /** @description The buyer's eBay email address. */
1203
+ email?: string;
1204
+ /** @description The seller created title of the item. */
1205
+ itemTitle?: string;
1206
+ /** @description The unique identifier of the eBay listing associated with the item. */
1207
+ listingId?: string;
1208
+ /** @description The buyer's eBay message. */
1209
+ message?: string;
1210
+ /** @description The unique identifier of the eBay order that the line item belongs to. */
1211
+ orderId?: string;
1212
+ /** @description The unique identifier of an eBay order line item. */
1213
+ orderLineItem?: string;
1214
+ /** @description The date and time that the payment was received by the seller. This timestamp is returned in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. */
1215
+ paymentDate?: string;
1216
+ /** @description The buyer's PayPal email address. */
1217
+ payPalEmail?: string;
1218
+ /** @description The buyer's PayPal message */
1219
+ payPalMessage?: string;
1220
+ /**
1221
+ * Format: int32
1222
+ * @description The quantity of the line item shipped with the package.
1223
+ */
1224
+ postedQuantity?: number;
1225
+ /**
1226
+ * Format: int32
1227
+ * @description The unique identifier of the eBay site in which the order occurred.
1228
+ */
1229
+ siteId?: number;
1230
+ /** @description This container returns SKU-related information relating to the item being shipped in the package. */
1231
+ sku?: components['schemas']['SkuRequest'];
1232
+ /** @description The date the item was sold. */
1233
+ soldDate?: string;
1234
+ /** @description The price for which the item was sold. */
1235
+ soldPrice?: components['schemas']['Amount'];
1236
+ /**
1237
+ * Format: int32
1238
+ * @description The quantity of the line item that was sold.
1239
+ */
1240
+ soldQuantity?: number;
1241
+ /** @description The unique identifier of the eBay transaction. */
1242
+ transactionId?: string;
1243
+ };
1244
+ /** @description This type is used to specify the package information needed to create a package. */
1245
+ PackageInfoRequest: {
1246
+ /** @description This container specifies the EU AR agent information associated with the package.<br><br>This information can be retrieved using the <a href="/api-docs/sell/edelivery_international_shipping/resources/agents/methods/getAgents" target="_blank">getAgents</a> method. */
1247
+ agentInfoRequest?: components['schemas']['AgentInfoData'];
1248
+ /** @description The unique identifier of the consign address to be associated with the package.<br><br>This ID can be retrieved using the <a href="/api-docs/sell/edelivery_international_shipping/resources/consign_preference/methods/getConsignPreferences" target="_blank">getConsignPreferences</a> method. */
1249
+ consignPreferenceId?: string;
1250
+ /** @description The incoterm information associated with the package.<br><br><b>Supported values</b>:<ul><li><code>DDP</code></li><li><code>DDU</code></li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:IncotermEnum'>eBay API documentation</a> */
1251
+ incoterm?: string;
1252
+ /** @description This array is used to specify applicable information about the eBay line item(s) that will be included in the package. */
1253
+ items?: components['schemas']['ItemRequest'][];
1254
+ /**
1255
+ * Format: int32
1256
+ * @description This field is used to limit the maximum number of parcels used in a single order. If the order has more than one parcel, revise this value to increase the limit.
1257
+ */
1258
+ maxQuantityLimit?: number;
1259
+ /** @description A seller-defined comment about the package. */
1260
+ packageComment?: string;
1261
+ /** @description The height of the package in centimeters. */
1262
+ packageHeight?: number;
1263
+ /** @description The length of the package in centimeters. */
1264
+ packageLength?: number;
1265
+ /** @description The weight of the package in grams. */
1266
+ packageWeight?: number;
1267
+ /** @description The width of the package in centimeters. */
1268
+ packageWidth?: number;
1269
+ /** @description The unique identifier of the ship-from address used for the package.<br><br>Use the <a href="/api-docs/sell/edelivery_international_shipping/resources/address_preference/methods/getAddressPreferences" target="_blank">getAddressPreferences</a> method to retrieve valid ship-from <b>addressId</b> values associated with your account. */
1270
+ shipFromAddressId?: string;
1271
+ /** @description The unique identifier of the shipping service being used for the package.<br><br>This value can be retrieved using the <a href="/api-docs/sell/edelivery_international_shipping/resources/services/methods/getServices" target="_blank">getServices</a> method. */
1272
+ shippingServiceId?: string;
1273
+ /** @description This container specifies the address details of the address ship-to address. */
1274
+ shipToAddress?: components['schemas']['ShipToAddressRequestData'];
1275
+ /** @description This container specifies any special service details about the package, such as any insurance fee, required signatures, or delivery exceptions. */
1276
+ specialServiceDetail?: components['schemas']['SpecialServiceDetail'];
1277
+ /** @description The declared value of a large carriage (a combination of several orders together). */
1278
+ valueForCarriage?: string;
1279
+ };
1280
+ /** @description This type defines the field used to create a pickup address. */
1281
+ PickupAddressRequestData: {
1282
+ /** @description The city code of the pickup address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid city codes. */
1283
+ city?: string;
1284
+ /** @description The company name associated with the pickup address.<br><br><b>Max length</b>: 50 characters */
1285
+ company?: string;
1286
+ /** @description The name of the contact person associated with the pickup address.<br><br><b>Max length</b>: 50 characters */
1287
+ contact?: string;
1288
+ /** @description The two-letter country code of the pickup address.<br><br><b>Valid values</b>:<ul><li>CN</li><li>HK</li></ul> */
1289
+ countryCode?: string;
1290
+ /** @description The district code of the pickup address. <br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid district codes. */
1291
+ district?: string;
1292
+ /** @description The name of the pickup address.<br><br><b>Max length</b>: 50 characters */
1293
+ name?: string;
1294
+ /** @description The phone number associated with the pickup address. */
1295
+ phone?: string;
1296
+ /** @description The postal code of the pickup address. */
1297
+ postcode?: string;
1298
+ /** @description The province code of the the pickup address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid province codes. */
1299
+ province?: string;
1300
+ /** @description The first line of the street address of the pickup address.<br><br><b>Max length</b>: 50 characters */
1301
+ street1?: string;
1302
+ /** @description The second line, if applicable, of the street address of the pickup address.<br><br><b>Max length</b>: 50 characters */
1303
+ street2?: string;
1304
+ /** @description The third line, if applicable, of the street address of the pickup address.<br><br><b>Max length</b>: 50 characters */
1305
+ street3?: string;
1306
+ };
1307
+ /** @description This type defines the fields used to specify location and contact information for a pickup-from consign address associated with a seller's eDIS account. */
1308
+ PickupAddressResponsesData: {
1309
+ /** @description The city code of the pickup address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid city codes. */
1310
+ city?: string;
1311
+ /** @description The city name of the pickup address. */
1312
+ cityName?: string;
1313
+ /** @description The name of the company associated with the pickup address. */
1314
+ company?: string;
1315
+ /** @description The name of the contact person associated with the pickup address. */
1316
+ contact?: string;
1317
+ /** @description The two-letter country code of the pickup address. */
1318
+ countryCode?: string;
1319
+ /** @description The name of the country of the pickup address. */
1320
+ countryName?: string;
1321
+ /** @description The district code of the pickup address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid district codes. */
1322
+ district?: string;
1323
+ /** @description The district name of the pickup address. */
1324
+ districtName?: string;
1325
+ /** @description The name of the pickup address. */
1326
+ name?: string;
1327
+ /** @description The phone number associated with the pickup address. */
1328
+ phone?: string;
1329
+ /** @description The postal code of the pickup address. */
1330
+ postcode?: string;
1331
+ /** @description The province code of the pickup address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid province codes. */
1332
+ province?: string;
1333
+ /** @description The name of the province of the pickup address. */
1334
+ provinceName?: string;
1335
+ /** @description The first line of the street address of the pickup address. */
1336
+ street1?: string;
1337
+ /** @description The second line, if applicable, of the street address of the pickup address. */
1338
+ street2?: string;
1339
+ /** @description The third line, if applicable, of the street address of the pickup address. */
1340
+ street3?: string;
1341
+ };
1342
+ /** @description This type specifies the shipping service information. */
1343
+ ServiceInfoResponses: {
1344
+ /** @description Basic shipping service information in English. */
1345
+ descriptionEn?: string;
1346
+ /** @description Basic shipping service information in traditional Chinese. */
1347
+ descriptionHk?: string;
1348
+ /** @description Basic shipping service information in Japanese. */
1349
+ descriptionJp?: string;
1350
+ /** @description Basic shipping service information in simplified Chinese. */
1351
+ descriptionZh?: string;
1352
+ /** @description This array lists includes all Ship From/Ship To combinations that the service supports. It also includes the type of batteries that may be shipping using the shipping service. */
1353
+ directions?: components['schemas']['DirectionsResponses'][];
1354
+ /** @description The incoterm information associated with the the shipping service.<br><br><b>Supported values</b>:<ul><li><code>DDP</code></li><li><code>DDU</code></li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:IncotermEnum'>eBay API documentation</a> */
1355
+ incoterm?: string;
1356
+ /** @description This value indicates the maximum length (in centimeters) of the shipping package that the shipping service allows.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
1357
+ maxLength?: number;
1358
+ /** @description This value indicates the total maximum value of the length, width, and height of the package.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
1359
+ maxTotalLength?: number;
1360
+ /** @description This value indicates the maximum weight (in grams) of the shipping package that the shipping service allows.<br><br><span class="tablenote"><b>Note:</b> This field is always returned, but will show as null or have an empty value if not defined/applicable.</span> */
1361
+ maxWeight?: number;
1362
+ /** @description The shipping service name in English */
1363
+ nameEn?: string;
1364
+ /** @description The shipping service name in traditional Chinese */
1365
+ nameHk?: string;
1366
+ /** @description The shipping service name in Japanese. */
1367
+ nameJp?: string;
1368
+ /** @description The shipping service name in simplified Chinese */
1369
+ nameZh?: string;
1370
+ /** @description The unique identifier of the shipping service being retrieved.<br><br>This value can be input in the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage#request.packageInfo.shippingServiceId" target="_blank">shippingServiceId</a> field when creating a package through the the <b>createPackage</b> method. */
1371
+ shippingServiceId?: string;
1372
+ };
1373
+ /** @description This type is used to specify the address fields of the ship-to address location. */
1374
+ ShipToAddressRequestData: {
1375
+ /** @description The city code of the ship-to address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid city codes. */
1376
+ city?: string;
1377
+ /** @description The name of the company associated with the ship-to address. */
1378
+ company?: string;
1379
+ /** @description The name of the contact person associated with the the ship-to address. */
1380
+ contact?: string;
1381
+ /** @description The two-letter country code of the ship-to address. */
1382
+ countryCode?: string;
1383
+ /** @description The country name of the ship-to address. */
1384
+ countryName?: string;
1385
+ /** @description The district code of the ship-to address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid district codes. */
1386
+ district?: string;
1387
+ /** @description The phone number associated with the ship-to address. */
1388
+ phone?: string;
1389
+ /** @description The postal code of the ship-to address. */
1390
+ postcode?: string;
1391
+ /** @description The province code of the ship-to address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid province codes. */
1392
+ province?: string;
1393
+ /** @description The first line of the street address of the ship-to address.<br><br><b>Max length</b>: 50 characters */
1394
+ street1?: string;
1395
+ /** @description The second line, if applicable, of the street address of the ship-to address.<br><br><b>Max length</b>: 50 characters */
1396
+ street2?: string;
1397
+ /** @description The third line, if applicable, of the street address of the ship-to address.<br><br><b>Max length</b>: 50 characters */
1398
+ street3?: string;
1399
+ };
1400
+ /** @description This type specifies the ship-to address information for a retrieved package. */
1401
+ ShipToAddressResponsesData: {
1402
+ /** @description The city code of the ship-to address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid city codes. */
1403
+ city?: string;
1404
+ /** @description The name of the company associated with the ship-to address. */
1405
+ company?: string;
1406
+ /** @description The name of the contact person associated with the ship-to address. */
1407
+ contact?: string;
1408
+ /** @description The two-letter country code of the ship-to address. */
1409
+ countryCode?: string;
1410
+ /** @description The country name of the ship-to address. */
1411
+ countryName?: string;
1412
+ /** @description The district code of the ship-to address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid district codes. */
1413
+ district?: string;
1414
+ /** @description The phone number associated with the ship-to address. */
1415
+ phone?: string;
1416
+ /** @description The postal code of the ship-to address. */
1417
+ postcode?: string;
1418
+ /** @description The province code of the ship-to address.<br><br>See <a href="https://www.edisebay.com/open/development-guide-detail?id=36" target="_blank">商户API地址编码主数据</a> for valid province codes. */
1419
+ province?: string;
1420
+ /** @description The first line of the street address of the ship-to address. */
1421
+ street1?: string;
1422
+ /** @description The second line of the street address of the ship-to address. */
1423
+ street2?: string;
1424
+ /** @description The third line of the street address of the ship-to address. */
1425
+ street3?: string;
1426
+ };
1427
+ /** @description This type specifies information relating to the SKU item in a package. */
1428
+ SkuRequest: {
1429
+ /** @description The unique identifier of the battery's electric qualification, which indicates that the battery has a certificate of approval for global shipping.<br><br>This value is returned in the <a href="/api-docs/sell/edelivery_international_shipping/resources/battery_qualifications/methods/getBatteryQualifications" target="_blank">getBatteryQualifications</a> method. */
1430
+ elecQualificationId?: string;
1431
+ /** @description This array lists the FDC SKUs associated with the item. An FDC SKU is the SKU label in a forward deployment center.<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> Please contact customer service before using these fields.</p></div> */
1432
+ fdcSkus?: components['schemas']['FDCSkuRequest'][];
1433
+ /** @description The height of the item in centimeters. */
1434
+ height?: number;
1435
+ /** @description This boolean indicates if the item contains a battery. */
1436
+ isLiBattery?: boolean;
1437
+ /** @description The length of the item in centimeters. */
1438
+ length?: number;
1439
+ /** @description If the item contains a battery, this field indicates the type of battery the item contains. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:LiBatteryTypeEnum'>eBay API documentation</a> */
1440
+ liBatteryType?: string;
1441
+ /** @description The English name of the item. */
1442
+ nameEn?: string;
1443
+ /** @description The Chinese name of the item. */
1444
+ nameZh?: string;
1445
+ /** @description The country of origin of the item. */
1446
+ origin?: string;
1447
+ /** @description The declared price of the item. */
1448
+ price?: components['schemas']['Amount'];
1449
+ /** @description A remark to the seller themselves. */
1450
+ remark?: string;
1451
+ /** @description The stock keeping unit (SKU) identifier of the item. */
1452
+ skuNumber?: string;
1453
+ /** @description The Harmonized System code for custom declaration. This value declares the category of the item.. */
1454
+ tariffCode?: string;
1455
+ /** @description The weight of the item in grams. */
1456
+ weight?: number;
1457
+ /** @description The width of the item in centimeters. */
1458
+ width?: number;
1459
+ };
1460
+ /** @description This type defines the special service details available for a package. */
1461
+ SpecialServiceDetail: {
1462
+ /** @description The insurance fee, if applicable, on the package.<br><br>The insurance amount and currency are consistent with the currency of the destination country */
1463
+ insuranceFee?: string;
1464
+ /** @description The package type.<br><br><b>Valid values</b>:<ul><li><code>PAK</code> (limited weight ≤ 2.5KG)</li><li><code>PACKAGE</code> (limited weight 68KG)</li></ul> */
1465
+ packagingType?: string;
1466
+ /** @description The signature type, if applicable, for the package.<br><br><b>Valid values</b>:<ul><li><code>ISR</code> (Indirect Signature Required)</li><li><code>DSR</code> (Direct Signature Required)</li><li><code>ASR</code> (Adult Signature Required)</li></ul> */
1467
+ signatureType?: string;
1468
+ /** @description Any special service types supported for the package.<br><br> For example, <code>SATURDAY_DELIVERY</code> indicates that the item is eligible for Saturday delivery. */
1469
+ specialServiceTypes?: string[];
1470
+ };
1471
+ };
1472
+ responses: never;
1473
+ parameters: never;
1474
+ requestBodies: never;
1475
+ headers: never;
1476
+ pathItems: never;
1477
+ }
1478
+ export type $defs = Record<string, never>;
1479
+ export interface operations {
1480
+ getActualCosts: {
1481
+ parameters: {
1482
+ query?: {
1483
+ /** @description This query parameter specifies the tracking number(s) of the package(s) for which to retrieve the actual weight and cost. Tracking numbers are returned when creating packages through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method.<br><br>Up to 200 tracking numbers can be provided.<br><br><span class="tablenote"><b>Note:</b> This query parameter is required if <b>trans_begin_time</b> and <b>trans_end_time</b> is not provided.</span> */
1484
+ tracking_numbers?: string;
1485
+ /** @description This query parameter specifies the start time of a transaction in UTC format.<br><br>If the the </b>trans_begin_time</b> and <b>trans_end_time</b> query parameters are used, the actual costs of all packages created within this date range are returned.<br><br><span class="tablenote"><b>Note:</b> This query parameter and <b>trans_end_time</b> are required if <b>tracking_numbers</b> is not provided.</span><br><b>Format</b>: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code> */
1486
+ trans_begin_time?: string;
1487
+ /** @description This query parameter specifies ending time of a transaction in UTC format.<br><br>If the the </b>trans_begin_time</b> and <b>trans_end_time</b> query parameters are used, the actual costs of all packages created within this date range are returned.<br><br><span class="tablenote"><b>Note:</b> This query parameter and <b>trans_start_time</b> are required if <b>tracking_numbers</b> is not provided.</span><br><b>Format</b>: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code> */
1488
+ trans_end_time?: string;
1489
+ };
1490
+ header?: never;
1491
+ path?: never;
1492
+ cookie?: never;
1493
+ };
1494
+ requestBody?: never;
1495
+ responses: {
1496
+ /** @description OK */
1497
+ 200: {
1498
+ headers: Record<string, unknown>;
1499
+ content: {
1500
+ 'application/json': components['schemas']['GetActualCostResponses'];
1501
+ };
1502
+ };
1503
+ /** @description Bad Request */
1504
+ 400: {
1505
+ headers: Record<string, unknown>;
1506
+ content?: never;
1507
+ };
1508
+ /** @description Unauthorized */
1509
+ 401: {
1510
+ headers: Record<string, unknown>;
1511
+ content?: never;
1512
+ };
1513
+ /** @description Not found */
1514
+ 404: {
1515
+ headers: Record<string, unknown>;
1516
+ content?: never;
1517
+ };
1518
+ /** @description Internal Server Error */
1519
+ 500: {
1520
+ headers: Record<string, unknown>;
1521
+ content?: never;
1522
+ };
1523
+ };
1524
+ };
1525
+ getAddressPreferences: {
1526
+ parameters: {
1527
+ query?: never;
1528
+ header?: never;
1529
+ path?: never;
1530
+ cookie?: never;
1531
+ };
1532
+ requestBody?: never;
1533
+ responses: {
1534
+ /** @description OK */
1535
+ 200: {
1536
+ headers: Record<string, unknown>;
1537
+ content: {
1538
+ 'application/json': components['schemas']['GetAddressPreferenceListResponses'];
1539
+ };
1540
+ };
1541
+ /** @description Bad Request */
1542
+ 400: {
1543
+ headers: Record<string, unknown>;
1544
+ content?: never;
1545
+ };
1546
+ /** @description Unauthorized */
1547
+ 401: {
1548
+ headers: Record<string, unknown>;
1549
+ content?: never;
1550
+ };
1551
+ /** @description Internal Server Error */
1552
+ 500: {
1553
+ headers: Record<string, unknown>;
1554
+ content?: never;
1555
+ };
1556
+ };
1557
+ };
1558
+ createAddressPreference: {
1559
+ parameters: {
1560
+ query?: never;
1561
+ header?: never;
1562
+ path?: never;
1563
+ cookie?: never;
1564
+ };
1565
+ requestBody?: {
1566
+ content: {
1567
+ 'application/json': components['schemas']['CreateAddressPreferenceRequest'];
1568
+ };
1569
+ };
1570
+ responses: {
1571
+ /** @description Created */
1572
+ 201: {
1573
+ headers: Record<string, unknown>;
1574
+ content: {
1575
+ 'application/json': components['schemas']['CreateAddressPreferenceResponses'];
1576
+ };
1577
+ };
1578
+ /** @description Bad Request */
1579
+ 400: {
1580
+ headers: Record<string, unknown>;
1581
+ content?: never;
1582
+ };
1583
+ /** @description Unauthorized */
1584
+ 401: {
1585
+ headers: Record<string, unknown>;
1586
+ content?: never;
1587
+ };
1588
+ /** @description Not found */
1589
+ 404: {
1590
+ headers: Record<string, unknown>;
1591
+ content?: never;
1592
+ };
1593
+ /** @description Internal Server Error */
1594
+ 500: {
1595
+ headers: Record<string, unknown>;
1596
+ content?: never;
1597
+ };
1598
+ };
1599
+ };
1600
+ getAgents: {
1601
+ parameters: {
1602
+ query?: {
1603
+ /** @description This query parameter sets the maximum number of agents to return on each page of the paginated response.<br><br>Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the call retrieves orders 11 through 20 from the result set.<br><br><b>Max</b>: <code>200</code><br><br><b>Default</b>: <code>50</code> */
1604
+ limit?: string;
1605
+ /** @description This query parameter specifies the number of agents to skip in the result set before returning the first agent in the paginated response.<br><br>Combine <b>offset</b> with the <b>limit</b> query parameter to control the items returned in the response. For example, if you supply an <b>offset</b> of <code>0</code> and a <b>limit</b> of <code>10</code>, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.<br><br><b>Default</b>: <code>0</code> */
1606
+ offset?: string;
1607
+ };
1608
+ header?: never;
1609
+ path?: never;
1610
+ cookie?: never;
1611
+ };
1612
+ requestBody?: never;
1613
+ responses: {
1614
+ /** @description OK */
1615
+ 200: {
1616
+ headers: Record<string, unknown>;
1617
+ content: {
1618
+ 'application/json': components['schemas']['GetAgentListResponses'];
1619
+ };
1620
+ };
1621
+ /** @description Bad Request */
1622
+ 400: {
1623
+ headers: Record<string, unknown>;
1624
+ content?: never;
1625
+ };
1626
+ /** @description Unauthorized */
1627
+ 401: {
1628
+ headers: Record<string, unknown>;
1629
+ content?: never;
1630
+ };
1631
+ /** @description Internal Server Error */
1632
+ 500: {
1633
+ headers: Record<string, unknown>;
1634
+ content?: never;
1635
+ };
1636
+ };
1637
+ };
1638
+ getBatteryQualifications: {
1639
+ parameters: {
1640
+ query?: {
1641
+ /** @description This query parameter sets the maximum number of qualifications to return on each page of the paginated response.<br><br>Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the call retrieves orders 11 through 20 from the result set.<br><br><b>Max</b>: <code>200</code><br><br><b>Default</b>: <code>50</code> */
1642
+ limit?: string;
1643
+ /** @description This query parameter specifies the number of qualifications to skip in the result set before returning the first qualification in the paginated response.<br><br>Combine <b>offset</b> with the <b>limit</b> query parameter to control the items returned in the response. For example, if you supply an <b>offset</b> of <code>0</code> and a <b>limit</b> of <code>10</code>, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.<br><br><b>Default</b>: <code>0</code> */
1644
+ offset?: string;
1645
+ };
1646
+ header?: never;
1647
+ path?: never;
1648
+ cookie?: never;
1649
+ };
1650
+ requestBody?: never;
1651
+ responses: {
1652
+ /** @description OK */
1653
+ 200: {
1654
+ headers: Record<string, unknown>;
1655
+ content: {
1656
+ 'application/json': components['schemas']['GetBatteryQualListResponses'];
1657
+ };
1658
+ };
1659
+ /** @description Bad Request */
1660
+ 400: {
1661
+ headers: Record<string, unknown>;
1662
+ content?: never;
1663
+ };
1664
+ /** @description Unauthorized */
1665
+ 401: {
1666
+ headers: Record<string, unknown>;
1667
+ content?: never;
1668
+ };
1669
+ /** @description Internal Server Error */
1670
+ 500: {
1671
+ headers: Record<string, unknown>;
1672
+ content?: never;
1673
+ };
1674
+ };
1675
+ };
1676
+ cancelBundle: {
1677
+ parameters: {
1678
+ query?: never;
1679
+ header?: never;
1680
+ path: {
1681
+ /** @description This path parameter specifies the unique identifier of the bundle being canceled.<br><br>This ID value is returned when creating a bundle through the <a href="/api-docs/sell/edelivery_international_shipping/resources/bundle/methods/createBundle" target="_blank">createBundle</a> method. */
1682
+ bundle_id: string;
1683
+ };
1684
+ cookie?: never;
1685
+ };
1686
+ requestBody?: never;
1687
+ responses: {
1688
+ /** @description No Content */
1689
+ 204: {
1690
+ headers: Record<string, unknown>;
1691
+ content?: never;
1692
+ };
1693
+ /** @description Bad Request */
1694
+ 400: {
1695
+ headers: Record<string, unknown>;
1696
+ content?: never;
1697
+ };
1698
+ /** @description Unauthorized */
1699
+ 401: {
1700
+ headers: Record<string, unknown>;
1701
+ content?: never;
1702
+ };
1703
+ /** @description Internal Server Error */
1704
+ 500: {
1705
+ headers: Record<string, unknown>;
1706
+ content?: never;
1707
+ };
1708
+ };
1709
+ };
1710
+ createBundle: {
1711
+ parameters: {
1712
+ query?: never;
1713
+ header?: never;
1714
+ path?: never;
1715
+ cookie?: never;
1716
+ };
1717
+ requestBody?: {
1718
+ content: {
1719
+ 'application/json': components['schemas']['CreateBundleRequest'];
1720
+ };
1721
+ };
1722
+ responses: {
1723
+ /** @description Created */
1724
+ 201: {
1725
+ headers: Record<string, unknown>;
1726
+ content: {
1727
+ 'application/json': components['schemas']['CreateBundleResponse'];
1728
+ };
1729
+ };
1730
+ /** @description Bad Request */
1731
+ 400: {
1732
+ headers: Record<string, unknown>;
1733
+ content?: never;
1734
+ };
1735
+ /** @description Unauthorized */
1736
+ 401: {
1737
+ headers: Record<string, unknown>;
1738
+ content?: never;
1739
+ };
1740
+ /** @description Internal Server Error */
1741
+ 500: {
1742
+ headers: Record<string, unknown>;
1743
+ content?: never;
1744
+ };
1745
+ };
1746
+ };
1747
+ getBundle: {
1748
+ parameters: {
1749
+ query?: never;
1750
+ header?: never;
1751
+ path: {
1752
+ /** @description This path parameter specifies the unique identifier of the bundle being retrieved.<br><br>This ID value is returned when creating a bundle through the <a href="/api-docs/sell/edelivery_international_shipping/resources/bundle/methods/createBundle" target="_blank">createBundle</a> method. */
1753
+ bundle_id: string;
1754
+ };
1755
+ cookie?: never;
1756
+ };
1757
+ requestBody?: never;
1758
+ responses: {
1759
+ /** @description OK */
1760
+ 200: {
1761
+ headers: Record<string, unknown>;
1762
+ content: {
1763
+ 'application/json': components['schemas']['BundleDetailResponse'];
1764
+ };
1765
+ };
1766
+ /** @description Bad Request */
1767
+ 400: {
1768
+ headers: Record<string, unknown>;
1769
+ content?: never;
1770
+ };
1771
+ /** @description Unauthorized */
1772
+ 401: {
1773
+ headers: Record<string, unknown>;
1774
+ content?: never;
1775
+ };
1776
+ /** @description Internal Server Error */
1777
+ 500: {
1778
+ headers: Record<string, unknown>;
1779
+ content?: never;
1780
+ };
1781
+ };
1782
+ };
1783
+ getBundleLabel: {
1784
+ parameters: {
1785
+ query?: never;
1786
+ header?: never;
1787
+ path: {
1788
+ /** @description This path parameter specifies the unique identifier of the bundle for which to retrieve a label.<br><br>This ID value is returned when creating a bundle through the <a href="/api-docs/sell/edelivery_international_shipping/resources/bundle/methods/createBundle" target="_blank">createBundle</a> method. */
1789
+ bundle_id: string;
1790
+ };
1791
+ cookie?: never;
1792
+ };
1793
+ requestBody?: never;
1794
+ responses: {
1795
+ /** @description OK */
1796
+ 200: {
1797
+ headers: Record<string, unknown>;
1798
+ content: {
1799
+ 'application/json': components['schemas']['BundleLabelResponse'];
1800
+ };
1801
+ };
1802
+ /** @description Bad Request */
1803
+ 400: {
1804
+ headers: Record<string, unknown>;
1805
+ content?: never;
1806
+ };
1807
+ /** @description Unauthorized */
1808
+ 401: {
1809
+ headers: Record<string, unknown>;
1810
+ content?: never;
1811
+ };
1812
+ /** @description Internal Server Error */
1813
+ 500: {
1814
+ headers: Record<string, unknown>;
1815
+ content?: never;
1816
+ };
1817
+ };
1818
+ };
1819
+ createComplaint: {
1820
+ parameters: {
1821
+ query?: never;
1822
+ header?: never;
1823
+ path?: never;
1824
+ cookie?: never;
1825
+ };
1826
+ requestBody?: {
1827
+ content: {
1828
+ 'application/json': components['schemas']['AddComplaintRequest'];
1829
+ };
1830
+ };
1831
+ responses: {
1832
+ /** @description Created */
1833
+ 201: {
1834
+ headers: Record<string, unknown>;
1835
+ content: {
1836
+ 'application/json': Record<string, never>;
1837
+ };
1838
+ };
1839
+ /** @description Bad Request */
1840
+ 400: {
1841
+ headers: Record<string, unknown>;
1842
+ content?: never;
1843
+ };
1844
+ /** @description Unauthorized */
1845
+ 401: {
1846
+ headers: Record<string, unknown>;
1847
+ content?: never;
1848
+ };
1849
+ /** @description Internal Server Error */
1850
+ 500: {
1851
+ headers: Record<string, unknown>;
1852
+ content?: never;
1853
+ };
1854
+ };
1855
+ };
1856
+ getConsignPreferences: {
1857
+ parameters: {
1858
+ query?: never;
1859
+ header?: never;
1860
+ path?: never;
1861
+ cookie?: never;
1862
+ };
1863
+ requestBody?: never;
1864
+ responses: {
1865
+ /** @description OK */
1866
+ 200: {
1867
+ headers: Record<string, unknown>;
1868
+ content: {
1869
+ 'application/json': components['schemas']['GetConsignPreferenceListResponses'];
1870
+ };
1871
+ };
1872
+ /** @description Bad Request */
1873
+ 400: {
1874
+ headers: Record<string, unknown>;
1875
+ content?: never;
1876
+ };
1877
+ /** @description Unauthorized */
1878
+ 401: {
1879
+ headers: Record<string, unknown>;
1880
+ content?: never;
1881
+ };
1882
+ /** @description Internal Server Error */
1883
+ 500: {
1884
+ headers: Record<string, unknown>;
1885
+ content?: never;
1886
+ };
1887
+ };
1888
+ };
1889
+ createConsignPreference: {
1890
+ parameters: {
1891
+ query?: never;
1892
+ header?: never;
1893
+ path?: never;
1894
+ cookie?: never;
1895
+ };
1896
+ requestBody?: {
1897
+ content: {
1898
+ 'application/json': components['schemas']['CreateConsignPreferenceRequest'];
1899
+ };
1900
+ };
1901
+ responses: {
1902
+ /** @description Created */
1903
+ 201: {
1904
+ headers: Record<string, unknown>;
1905
+ content: {
1906
+ 'application/json': components['schemas']['CreateConsignPreferenceResponses'];
1907
+ };
1908
+ };
1909
+ /** @description Bad Request */
1910
+ 400: {
1911
+ headers: Record<string, unknown>;
1912
+ content?: never;
1913
+ };
1914
+ /** @description Unauthorized */
1915
+ 401: {
1916
+ headers: Record<string, unknown>;
1917
+ content?: never;
1918
+ };
1919
+ /** @description Internal Server Error */
1920
+ 500: {
1921
+ headers: Record<string, unknown>;
1922
+ content?: never;
1923
+ };
1924
+ };
1925
+ };
1926
+ getDropoffSites: {
1927
+ parameters: {
1928
+ query?: {
1929
+ /** @description This query parameter sets the maximum number of drop-off site locations to return on each page of the paginated response.<br><br>Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the call retrieves orders 11 through 20 from the result set.<br><br><b>Max</b>: <code>200</code><br><br><b>Default</b>: <code>50</code> */
1930
+ limit?: string;
1931
+ /** @description This query parameter specifies the number of drop-off site locations to skip in the result set before returning the first location in the paginated response.<br><br>Combine <b>offset</b> with the <b>limit</b> query parameter to control the items returned in the response. For example, if you supply an <b>offset</b> of <code>0</code> and a <b>limit</b> of <code>10</code>, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.<br><br><b>Default</b>: <code>0</code> */
1932
+ offset?: string;
1933
+ };
1934
+ header?: never;
1935
+ path?: never;
1936
+ cookie?: never;
1937
+ };
1938
+ requestBody?: never;
1939
+ responses: {
1940
+ /** @description OK */
1941
+ 200: {
1942
+ headers: Record<string, unknown>;
1943
+ content: {
1944
+ 'application/json': components['schemas']['GetDropoffSiteListResponses'];
1945
+ };
1946
+ };
1947
+ /** @description Bad Request */
1948
+ 400: {
1949
+ headers: Record<string, unknown>;
1950
+ content?: never;
1951
+ };
1952
+ /** @description Unauthorized */
1953
+ 401: {
1954
+ headers: Record<string, unknown>;
1955
+ content?: never;
1956
+ };
1957
+ /** @description Internal Server Error */
1958
+ 500: {
1959
+ headers: Record<string, unknown>;
1960
+ content?: never;
1961
+ };
1962
+ };
1963
+ };
1964
+ getHandoverSheet: {
1965
+ parameters: {
1966
+ query: {
1967
+ /** @description This query parameter specifies an array of tracking numbers for the packages for which to retrieve a handover sheet.<br><br>Tracking numbers are returned when creating packages through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method.<br><br>Up to 200 tracking numbers can be provided. Multiple tracking numbers can be input as individual query parameters. For example,<br><br><code>tracking_numbers=E***********************N&tracking_numbers=E***********************Q</code> */
1968
+ tracking_numbers: string;
1969
+ };
1970
+ header?: never;
1971
+ path?: never;
1972
+ cookie?: never;
1973
+ };
1974
+ requestBody?: never;
1975
+ responses: {
1976
+ /** @description OK */
1977
+ 200: {
1978
+ headers: Record<string, unknown>;
1979
+ content: {
1980
+ 'application/json': components['schemas']['GetHandoverSheetResponses'];
1981
+ };
1982
+ };
1983
+ /** @description Bad Request */
1984
+ 400: {
1985
+ headers: Record<string, unknown>;
1986
+ content?: never;
1987
+ };
1988
+ /** @description Unauthorized */
1989
+ 401: {
1990
+ headers: Record<string, unknown>;
1991
+ content?: never;
1992
+ };
1993
+ /** @description Not found */
1994
+ 404: {
1995
+ headers: Record<string, unknown>;
1996
+ content?: never;
1997
+ };
1998
+ /** @description Internal Server Error */
1999
+ 500: {
2000
+ headers: Record<string, unknown>;
2001
+ content?: never;
2002
+ };
2003
+ };
2004
+ };
2005
+ getLabels: {
2006
+ parameters: {
2007
+ query: {
2008
+ /** @description This query parameter specifies the page size of the retrieved shipping labels.<br><br><b>Valid values</b>:<ul><li><code>A4</code></li><li><code>THERMAL_PAPER</code></li></ul> */
2009
+ page_size?: string;
2010
+ /** @description This query parameter specifies one or more printing preferences to be set when retrieving shipping labels. Multiple values can be delimited by a comma.<br><br><b>Valid values</b>:<ul><li><code>nameZh</code></li><li><code>nameEn</code></li><li><code>remark</code></li><li><code>skuPrice</code></li><li><code>skuNo</code></li><li><code>quantity</code></li><li><code>listingId</code></li><li><code>sellerId</code></li><li><code>buyerId</code></li></ul> */
2011
+ print_preference?: string;
2012
+ /** @description This query parameter specifies an array of tracking numbers of the packages for which to retrieve shipping labels.<br><br>Tracking numbers are returned when creating packages through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method.<br><br>Up to 200 tracking numbers can be provided. Multiple tracking numbers can be input as individual query parameters.For example,<br><br><code>tracking_numbers=E***********************N&tracking_numbers=E***********************Q</code> */
2013
+ tracking_numbers: string;
2014
+ };
2015
+ header?: never;
2016
+ path?: never;
2017
+ cookie?: never;
2018
+ };
2019
+ requestBody?: never;
2020
+ responses: {
2021
+ /** @description OK */
2022
+ 200: {
2023
+ headers: Record<string, unknown>;
2024
+ content: {
2025
+ 'application/json': components['schemas']['GetLabelListResponses'];
2026
+ };
2027
+ };
2028
+ /** @description Bad Request */
2029
+ 400: {
2030
+ headers: Record<string, unknown>;
2031
+ content?: never;
2032
+ };
2033
+ /** @description Unauthorized */
2034
+ 401: {
2035
+ headers: Record<string, unknown>;
2036
+ content?: never;
2037
+ };
2038
+ /** @description Not found */
2039
+ 404: {
2040
+ headers: Record<string, unknown>;
2041
+ content?: never;
2042
+ };
2043
+ /** @description Internal Server Error */
2044
+ 500: {
2045
+ headers: Record<string, unknown>;
2046
+ content?: never;
2047
+ };
2048
+ };
2049
+ };
2050
+ bulkCancelPackages: {
2051
+ parameters: {
2052
+ query?: never;
2053
+ header?: never;
2054
+ path?: never;
2055
+ cookie?: never;
2056
+ };
2057
+ requestBody?: {
2058
+ content: {
2059
+ 'application/json': components['schemas']['CancelPackagesRequest'];
2060
+ };
2061
+ };
2062
+ responses: {
2063
+ /** @description OK */
2064
+ 200: {
2065
+ headers: Record<string, unknown>;
2066
+ content: {
2067
+ 'application/json': components['schemas']['CancelPackagesResponses'];
2068
+ };
2069
+ };
2070
+ /** @description Bad Request */
2071
+ 400: {
2072
+ headers: Record<string, unknown>;
2073
+ content?: never;
2074
+ };
2075
+ /** @description Unauthorized */
2076
+ 401: {
2077
+ headers: Record<string, unknown>;
2078
+ content?: never;
2079
+ };
2080
+ /** @description Not found */
2081
+ 404: {
2082
+ headers: Record<string, unknown>;
2083
+ content?: never;
2084
+ };
2085
+ /** @description Internal Server Error */
2086
+ 500: {
2087
+ headers: Record<string, unknown>;
2088
+ content?: never;
2089
+ };
2090
+ };
2091
+ };
2092
+ bulkConfirmPackages: {
2093
+ parameters: {
2094
+ query?: never;
2095
+ header?: never;
2096
+ path?: never;
2097
+ cookie?: never;
2098
+ };
2099
+ requestBody?: {
2100
+ content: {
2101
+ 'application/json': components['schemas']['ConfirmPackagesRequest'];
2102
+ };
2103
+ };
2104
+ responses: {
2105
+ /** @description OK */
2106
+ 200: {
2107
+ headers: Record<string, unknown>;
2108
+ content: {
2109
+ 'application/json': components['schemas']['ConfirmPackagesResponses'];
2110
+ };
2111
+ };
2112
+ /** @description Bad Request */
2113
+ 400: {
2114
+ headers: Record<string, unknown>;
2115
+ content?: never;
2116
+ };
2117
+ /** @description Unauthorized */
2118
+ 401: {
2119
+ headers: Record<string, unknown>;
2120
+ content?: never;
2121
+ };
2122
+ /** @description Not found */
2123
+ 404: {
2124
+ headers: Record<string, unknown>;
2125
+ content?: never;
2126
+ };
2127
+ /** @description Internal Server Error */
2128
+ 500: {
2129
+ headers: Record<string, unknown>;
2130
+ content?: never;
2131
+ };
2132
+ };
2133
+ };
2134
+ bulkDeletePackages: {
2135
+ parameters: {
2136
+ query?: never;
2137
+ header?: never;
2138
+ path?: never;
2139
+ cookie?: never;
2140
+ };
2141
+ requestBody?: {
2142
+ content: {
2143
+ 'application/json': components['schemas']['DeletePackagesRequest'];
2144
+ };
2145
+ };
2146
+ responses: {
2147
+ /** @description OK */
2148
+ 200: {
2149
+ headers: Record<string, unknown>;
2150
+ content: {
2151
+ 'application/json': components['schemas']['DeletePackagesResponses'];
2152
+ };
2153
+ };
2154
+ /** @description Bad Request */
2155
+ 400: {
2156
+ headers: Record<string, unknown>;
2157
+ content?: never;
2158
+ };
2159
+ /** @description Unauthorized */
2160
+ 401: {
2161
+ headers: Record<string, unknown>;
2162
+ content?: never;
2163
+ };
2164
+ /** @description Not found */
2165
+ 404: {
2166
+ headers: Record<string, unknown>;
2167
+ content?: never;
2168
+ };
2169
+ /** @description Internal Server Error */
2170
+ 500: {
2171
+ headers: Record<string, unknown>;
2172
+ content?: never;
2173
+ };
2174
+ };
2175
+ };
2176
+ cancelPackage: {
2177
+ parameters: {
2178
+ query?: never;
2179
+ header?: never;
2180
+ path: {
2181
+ /** @description This path parameter specifies the unique identifier of the package being canceled.<br><br>This ID value is returned when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method. */
2182
+ package_id: string;
2183
+ };
2184
+ cookie?: never;
2185
+ };
2186
+ requestBody?: never;
2187
+ responses: {
2188
+ /** @description No Content */
2189
+ 204: {
2190
+ headers: Record<string, unknown>;
2191
+ content?: never;
2192
+ };
2193
+ /** @description Bad Request */
2194
+ 400: {
2195
+ headers: Record<string, unknown>;
2196
+ content?: never;
2197
+ };
2198
+ /** @description Unauthorized */
2199
+ 401: {
2200
+ headers: Record<string, unknown>;
2201
+ content?: never;
2202
+ };
2203
+ /** @description Not found */
2204
+ 404: {
2205
+ headers: Record<string, unknown>;
2206
+ content?: never;
2207
+ };
2208
+ /** @description Internal Server Error */
2209
+ 500: {
2210
+ headers: Record<string, unknown>;
2211
+ content?: never;
2212
+ };
2213
+ };
2214
+ };
2215
+ clonePackage: {
2216
+ parameters: {
2217
+ query?: never;
2218
+ header?: never;
2219
+ path: {
2220
+ /** @description This path parameter specifies the <b>packageId</b> value of the package to be cloned.<br><br>This ID value is returned when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method. */
2221
+ package_id: string;
2222
+ };
2223
+ cookie?: never;
2224
+ };
2225
+ requestBody?: never;
2226
+ responses: {
2227
+ /** @description Created */
2228
+ 201: {
2229
+ headers: Record<string, unknown>;
2230
+ content: {
2231
+ 'application/json': components['schemas']['ClonePackageResponses'];
2232
+ };
2233
+ };
2234
+ /** @description Bad Request */
2235
+ 400: {
2236
+ headers: Record<string, unknown>;
2237
+ content?: never;
2238
+ };
2239
+ /** @description Unauthorized */
2240
+ 401: {
2241
+ headers: Record<string, unknown>;
2242
+ content?: never;
2243
+ };
2244
+ /** @description Not found */
2245
+ 404: {
2246
+ headers: Record<string, unknown>;
2247
+ content?: never;
2248
+ };
2249
+ /** @description Internal Server Error */
2250
+ 500: {
2251
+ headers: Record<string, unknown>;
2252
+ content?: never;
2253
+ };
2254
+ };
2255
+ };
2256
+ confirmPackage: {
2257
+ parameters: {
2258
+ query?: never;
2259
+ header?: never;
2260
+ path: {
2261
+ /** @description This path parameter specifies the unique identifier of the package you wish to be confirmed.<br><br>This ID value is returned when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method. */
2262
+ package_id: string;
2263
+ };
2264
+ cookie?: never;
2265
+ };
2266
+ requestBody?: never;
2267
+ responses: {
2268
+ /** @description No Content */
2269
+ 204: {
2270
+ headers: Record<string, unknown>;
2271
+ content?: never;
2272
+ };
2273
+ /** @description Bad Request */
2274
+ 400: {
2275
+ headers: Record<string, unknown>;
2276
+ content?: never;
2277
+ };
2278
+ /** @description Unauthorized */
2279
+ 401: {
2280
+ headers: Record<string, unknown>;
2281
+ content?: never;
2282
+ };
2283
+ /** @description Not found */
2284
+ 404: {
2285
+ headers: Record<string, unknown>;
2286
+ content?: never;
2287
+ };
2288
+ /** @description Internal Server Error */
2289
+ 500: {
2290
+ headers: Record<string, unknown>;
2291
+ content?: never;
2292
+ };
2293
+ };
2294
+ };
2295
+ createPackage: {
2296
+ parameters: {
2297
+ query?: never;
2298
+ header?: never;
2299
+ path?: never;
2300
+ cookie?: never;
2301
+ };
2302
+ requestBody?: {
2303
+ content: {
2304
+ 'application/json': components['schemas']['AddPackageRequest'];
2305
+ };
2306
+ };
2307
+ responses: {
2308
+ /** @description Created */
2309
+ 201: {
2310
+ headers: Record<string, unknown>;
2311
+ content: {
2312
+ 'application/json': components['schemas']['AddPackageResponses'];
2313
+ };
2314
+ };
2315
+ /** @description Bad Request */
2316
+ 400: {
2317
+ headers: Record<string, unknown>;
2318
+ content?: never;
2319
+ };
2320
+ /** @description Unauthorized */
2321
+ 401: {
2322
+ headers: Record<string, unknown>;
2323
+ content?: never;
2324
+ };
2325
+ /** @description Internal Server Error */
2326
+ 500: {
2327
+ headers: Record<string, unknown>;
2328
+ content?: never;
2329
+ };
2330
+ };
2331
+ };
2332
+ getPackage: {
2333
+ parameters: {
2334
+ query?: never;
2335
+ header?: never;
2336
+ path: {
2337
+ /** @description This path parameter specifies the unique identifier of the package being retrieved.<br><br>This ID value is returned when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method. */
2338
+ package_id: string;
2339
+ };
2340
+ cookie?: never;
2341
+ };
2342
+ requestBody?: never;
2343
+ responses: {
2344
+ /** @description OK */
2345
+ 200: {
2346
+ headers: Record<string, unknown>;
2347
+ content: {
2348
+ 'application/json': components['schemas']['GetPackageDetailResponses'];
2349
+ };
2350
+ };
2351
+ /** @description Bad Request */
2352
+ 400: {
2353
+ headers: Record<string, unknown>;
2354
+ content?: never;
2355
+ };
2356
+ /** @description Unauthorized */
2357
+ 401: {
2358
+ headers: Record<string, unknown>;
2359
+ content?: never;
2360
+ };
2361
+ /** @description Not found */
2362
+ 404: {
2363
+ headers: Record<string, unknown>;
2364
+ content?: never;
2365
+ };
2366
+ /** @description Internal Server Error */
2367
+ 500: {
2368
+ headers: Record<string, unknown>;
2369
+ content?: never;
2370
+ };
2371
+ };
2372
+ };
2373
+ deletePackage: {
2374
+ parameters: {
2375
+ query?: never;
2376
+ header?: never;
2377
+ path: {
2378
+ /** @description This path parameter specifies the unique identifier of the package being deleted. This package must already be cancelled and have no tracking number associated with it.<br><br>This ID value is returned when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method. */
2379
+ package_id: string;
2380
+ };
2381
+ cookie?: never;
2382
+ };
2383
+ requestBody?: never;
2384
+ responses: {
2385
+ /** @description No Content */
2386
+ 204: {
2387
+ headers: Record<string, unknown>;
2388
+ content?: never;
2389
+ };
2390
+ /** @description Bad Request */
2391
+ 400: {
2392
+ headers: Record<string, unknown>;
2393
+ content?: never;
2394
+ };
2395
+ /** @description Unauthorized */
2396
+ 401: {
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
+ getPackagesByLineItemID: {
2413
+ parameters: {
2414
+ query?: never;
2415
+ header?: never;
2416
+ path: {
2417
+ /** @description This path parameter can be used to specify the unique identifier of the line item that is part of the package being retrieved.<br><br>This value is returned in the <b>lineItemId</b> field of the <a href="/api-docs/sell/fulfillment/resources/order/methods/getOrders" target="_blank">getOrders</a> method of the <b>Fulfillment API</b> or the <a href="/devzone/xml/docs/reference/ebay/GetOrders.html" target="_blank">GetOrders</a> method of the <b>Trading API</b>. */
2418
+ order_line_item_id: string;
2419
+ };
2420
+ cookie?: never;
2421
+ };
2422
+ requestBody?: never;
2423
+ responses: {
2424
+ /** @description OK */
2425
+ 200: {
2426
+ headers: Record<string, unknown>;
2427
+ content: {
2428
+ 'application/json': components['schemas']['GetItemPackageIdResponses'];
2429
+ };
2430
+ };
2431
+ /** @description Bad Request */
2432
+ 400: {
2433
+ headers: Record<string, unknown>;
2434
+ content?: never;
2435
+ };
2436
+ /** @description Unauthorized */
2437
+ 401: {
2438
+ headers: Record<string, unknown>;
2439
+ content?: never;
2440
+ };
2441
+ /** @description Not found */
2442
+ 404: {
2443
+ headers: Record<string, unknown>;
2444
+ content?: never;
2445
+ };
2446
+ /** @description Internal Server Error */
2447
+ 500: {
2448
+ headers: Record<string, unknown>;
2449
+ content?: never;
2450
+ };
2451
+ };
2452
+ };
2453
+ getServices: {
2454
+ parameters: {
2455
+ query?: {
2456
+ /** @description This query parameter sets the maximum number of shipping services to return on each page of the paginated response.<br><br>Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the call retrieves orders 11 through 20 from the result set.<br><br><b>Max</b>: <code>200</code><br><br><b>Default</b>: <code>50</code> */
2457
+ limit?: string;
2458
+ /** @description This query parameter specifies the number of shipping services to skip in the result set before returning the first shipping service in the paginated response.<br><br>Combine <b>offset</b> with the <b>limit</b> query parameter to control the items returned in the response. For example, if you supply an <b>offset</b> of <code>0</code> and a <b>limit</b> of <code>10</code>, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.<br><br><b>Default</b>: <code>0</code> */
2459
+ offset?: string;
2460
+ };
2461
+ header?: never;
2462
+ path?: never;
2463
+ cookie?: never;
2464
+ };
2465
+ requestBody?: never;
2466
+ responses: {
2467
+ /** @description OK */
2468
+ 200: {
2469
+ headers: Record<string, unknown>;
2470
+ content: {
2471
+ 'application/json': components['schemas']['GetServiceListResponses'];
2472
+ };
2473
+ };
2474
+ /** @description Bad Request */
2475
+ 400: {
2476
+ headers: Record<string, unknown>;
2477
+ content?: never;
2478
+ };
2479
+ /** @description Unauthorized */
2480
+ 401: {
2481
+ headers: Record<string, unknown>;
2482
+ content?: never;
2483
+ };
2484
+ /** @description Not found */
2485
+ 404: {
2486
+ headers: Record<string, unknown>;
2487
+ content?: never;
2488
+ };
2489
+ /** @description Internal Server Error */
2490
+ 500: {
2491
+ headers: Record<string, unknown>;
2492
+ content?: never;
2493
+ };
2494
+ };
2495
+ };
2496
+ getTracking: {
2497
+ parameters: {
2498
+ query: {
2499
+ /** @description This query parameter specifies the tracking number for which to retrieve current tracking event details.<br><br>This value is returned when creating a package through the <a href="/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage" target="_blank">createPackage</a> method. */
2500
+ tracking_number: string;
2501
+ };
2502
+ header?: never;
2503
+ path?: never;
2504
+ cookie?: never;
2505
+ };
2506
+ requestBody?: never;
2507
+ responses: {
2508
+ /** @description OK */
2509
+ 200: {
2510
+ headers: Record<string, unknown>;
2511
+ content: {
2512
+ 'application/json': components['schemas']['GetTrackingDetailResponses'];
2513
+ };
2514
+ };
2515
+ /** @description Bad Request */
2516
+ 400: {
2517
+ headers: Record<string, unknown>;
2518
+ content?: never;
2519
+ };
2520
+ /** @description Unauthorized */
2521
+ 401: {
2522
+ headers: Record<string, unknown>;
2523
+ content?: never;
2524
+ };
2525
+ /** @description Not found */
2526
+ 404: {
2527
+ headers: Record<string, unknown>;
2528
+ content?: never;
2529
+ };
2530
+ /** @description Internal Server Error */
2531
+ 500: {
2532
+ headers: Record<string, unknown>;
2533
+ content?: never;
2534
+ };
2535
+ };
2536
+ };
2537
+ }