ebay-api 8.4.1 → 8.5.1

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 (394) hide show
  1. package/README.md +3 -3
  2. package/dist/api/apiFactory.d.ts +27 -27
  3. package/dist/api/apiFactory.js +94 -94
  4. package/dist/api/base.d.ts +10 -10
  5. package/dist/api/base.js +10 -10
  6. package/dist/api/digitalSignature.d.ts +43 -43
  7. package/dist/api/digitalSignature.js +105 -105
  8. package/dist/api/index.d.ts +13 -13
  9. package/dist/api/index.js +29 -29
  10. package/dist/api/restful/buy/browse/index.d.ts +84 -84
  11. package/dist/api/restful/buy/browse/index.js +132 -135
  12. package/dist/api/restful/buy/deal/index.d.ts +56 -55
  13. package/dist/api/restful/buy/deal/index.js +74 -73
  14. package/dist/api/restful/buy/feed/index.d.ts +44 -43
  15. package/dist/api/restful/buy/feed/index.js +79 -78
  16. package/dist/api/restful/buy/index.d.ts +17 -17
  17. package/dist/api/restful/buy/index.js +8 -8
  18. package/dist/api/restful/buy/marketing/index.d.ts +28 -27
  19. package/dist/api/restful/buy/marketing/index.js +45 -44
  20. package/dist/api/restful/buy/marketplaceInsights/index.d.ts +29 -28
  21. package/dist/api/restful/buy/marketplaceInsights/index.js +45 -44
  22. package/dist/api/restful/buy/offer/index.d.ts +24 -23
  23. package/dist/api/restful/buy/offer/index.js +31 -30
  24. package/dist/api/restful/buy/order/index.d.ts +265 -264
  25. package/dist/api/restful/buy/order/index.js +363 -362
  26. package/dist/api/restful/commerce/catalog/index.d.ts +74 -73
  27. package/dist/api/restful/commerce/catalog/index.js +100 -101
  28. package/dist/api/restful/commerce/charity/index.d.ts +35 -34
  29. package/dist/api/restful/commerce/charity/index.js +50 -49
  30. package/dist/api/restful/commerce/identity/index.d.ts +15 -14
  31. package/dist/api/restful/commerce/identity/index.js +21 -20
  32. package/dist/api/restful/commerce/index.d.ts +15 -15
  33. package/dist/api/restful/commerce/index.js +7 -7
  34. package/dist/api/restful/commerce/notification/index.d.ts +118 -117
  35. package/dist/api/restful/commerce/notification/index.js +181 -180
  36. package/dist/api/restful/commerce/taxonomy/index.d.ts +79 -78
  37. package/dist/api/restful/commerce/taxonomy/index.js +129 -128
  38. package/dist/api/restful/commerce/translation/index.d.ts +16 -15
  39. package/dist/api/restful/commerce/translation/index.js +19 -18
  40. package/dist/api/restful/developer/analytics/index.d.ts +23 -22
  41. package/dist/api/restful/developer/analytics/index.js +39 -38
  42. package/dist/api/restful/developer/index.d.ts +7 -7
  43. package/dist/api/restful/developer/index.js +3 -3
  44. package/dist/api/restful/developer/keyManagement/index.d.ts +25 -24
  45. package/dist/api/restful/developer/keyManagement/index.js +37 -36
  46. package/dist/api/restful/index.d.ts +70 -67
  47. package/dist/api/restful/index.js +180 -180
  48. package/dist/api/restful/postOrder/cancellation/index.d.ts +57 -57
  49. package/dist/api/restful/postOrder/cancellation/index.js +89 -88
  50. package/dist/api/restful/postOrder/case/index.d.ts +63 -63
  51. package/dist/api/restful/postOrder/case/index.js +89 -88
  52. package/dist/api/restful/postOrder/index.d.ts +11 -11
  53. package/dist/api/restful/postOrder/index.js +5 -5
  54. package/dist/api/restful/postOrder/inquiry/index.d.ts +82 -82
  55. package/dist/api/restful/postOrder/inquiry/index.js +125 -124
  56. package/dist/api/restful/postOrder/return/index.d.ts +231 -231
  57. package/dist/api/restful/postOrder/return/index.js +355 -354
  58. package/dist/api/restful/sell/account/index.d.ts +299 -298
  59. package/dist/api/restful/sell/account/index.js +461 -460
  60. package/dist/api/restful/sell/analytics/index.d.ts +42 -41
  61. package/dist/api/restful/sell/analytics/index.js +55 -54
  62. package/dist/api/restful/sell/compliance/index.d.ts +38 -37
  63. package/dist/api/restful/sell/compliance/index.js +51 -50
  64. package/dist/api/restful/sell/feed/index.d.ts +172 -171
  65. package/dist/api/restful/sell/feed/index.js +278 -277
  66. package/dist/api/restful/sell/finances/index.d.ts +79 -78
  67. package/dist/api/restful/sell/finances/index.js +103 -102
  68. package/dist/api/restful/sell/fulfillment/index.d.ts +138 -137
  69. package/dist/api/restful/sell/fulfillment/index.js +193 -192
  70. package/dist/api/restful/sell/index.d.ts +29 -29
  71. package/dist/api/restful/sell/index.js +14 -14
  72. package/dist/api/restful/sell/inventory/index.d.ts +249 -248
  73. package/dist/api/restful/sell/inventory/index.js +340 -339
  74. package/dist/api/restful/sell/listing/index.d.ts +15 -14
  75. package/dist/api/restful/sell/listing/index.js +19 -18
  76. package/dist/api/restful/sell/logistics/index.d.ts +45 -44
  77. package/dist/api/restful/sell/logistics/index.js +60 -59
  78. package/dist/api/restful/sell/marketing/index.d.ts +627 -626
  79. package/dist/api/restful/sell/marketing/index.js +863 -862
  80. package/dist/api/restful/sell/metadata/index.d.ts +78 -77
  81. package/dist/api/restful/sell/metadata/index.js +125 -124
  82. package/dist/api/restful/sell/negotiation/index.d.ts +25 -24
  83. package/dist/api/restful/sell/negotiation/index.js +33 -32
  84. package/dist/api/restful/sell/recommendation/index.d.ts +27 -26
  85. package/dist/api/restful/sell/recommendation/index.js +33 -32
  86. package/dist/api/traditional/XMLRequest.d.ts +109 -109
  87. package/dist/api/traditional/XMLRequest.js +176 -175
  88. package/dist/api/traditional/clientAlerts/index.d.ts +9 -9
  89. package/dist/api/traditional/clientAlerts/index.js +11 -11
  90. package/dist/api/traditional/clientAlerts/types.d.ts +31 -31
  91. package/dist/api/traditional/clientAlerts/types.js +32 -32
  92. package/dist/api/traditional/fields.d.ts +1948 -1948
  93. package/dist/api/traditional/fields.js +1946 -1946
  94. package/dist/api/traditional/finding/index.d.ts +12 -12
  95. package/dist/api/traditional/finding/index.js +13 -13
  96. package/dist/api/traditional/index.d.ts +17 -17
  97. package/dist/api/traditional/index.js +191 -191
  98. package/dist/api/traditional/merchandising/index.d.ts +7 -7
  99. package/dist/api/traditional/merchandising/index.js +8 -8
  100. package/dist/api/traditional/shopping/index.d.ts +11 -11
  101. package/dist/api/traditional/shopping/index.js +13 -13
  102. package/dist/api/traditional/trading/index.d.ts +142 -142
  103. package/dist/api/traditional/trading/index.js +143 -143
  104. package/dist/auth/authNAuth.d.ts +49 -49
  105. package/dist/auth/authNAuth.js +117 -116
  106. package/dist/auth/index.d.ts +17 -17
  107. package/dist/auth/index.js +25 -25
  108. package/dist/auth/oAuth2.d.ts +95 -95
  109. package/dist/auth/oAuth2.js +260 -259
  110. package/dist/eBayApi.d.ts +59 -59
  111. package/dist/eBayApi.js +105 -104
  112. package/dist/ebay-api.min.mjs +1 -1
  113. package/dist/enums/apiEnums.d.ts +49 -49
  114. package/dist/enums/apiEnums.js +51 -51
  115. package/dist/enums/index.d.ts +2 -2
  116. package/dist/enums/index.js +2 -2
  117. package/dist/enums/restfulEnums.d.ts +976 -970
  118. package/dist/enums/restfulEnums.js +1019 -1013
  119. package/dist/errors/index.d.ts +66 -66
  120. package/dist/errors/index.js +190 -189
  121. package/dist/nanoevents.d.ts +6 -6
  122. package/dist/nanoevents.js +20 -20
  123. package/dist/request.d.ts +26 -26
  124. package/dist/request.js +43 -43
  125. package/dist/types/apiTypes.d.ts +40 -40
  126. package/dist/types/apiTypes.js +1 -1
  127. package/dist/types/index.d.ts +3 -3
  128. package/dist/types/index.js +3 -3
  129. package/dist/types/restful/specs/buy_browse_v1_oas3.d.ts +1531 -0
  130. package/dist/types/restful/specs/buy_browse_v1_oas3.js +5 -0
  131. package/dist/types/restful/specs/buy_deal_v1_oas3.d.ts +434 -0
  132. package/dist/types/restful/specs/buy_deal_v1_oas3.js +5 -0
  133. package/dist/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +561 -0
  134. package/dist/types/restful/specs/buy_feed_v1_beta_oas3.js +5 -0
  135. package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +288 -0
  136. package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.js +5 -0
  137. package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +304 -0
  138. package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +5 -0
  139. package/dist/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +173 -0
  140. package/dist/types/restful/specs/buy_offer_v1_beta_oas3.js +5 -0
  141. package/dist/types/restful/specs/buy_order_v1_beta_oas3.d.ts +1701 -0
  142. package/dist/types/restful/specs/buy_order_v1_beta_oas3.js +5 -0
  143. package/dist/types/restful/specs/cancellation_oas3.d.ts +112 -0
  144. package/dist/types/restful/specs/cancellation_oas3.js +5 -0
  145. package/dist/types/restful/specs/case_oas3.d.ts +124 -0
  146. package/dist/types/restful/specs/case_oas3.js +5 -0
  147. package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +758 -0
  148. package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.js +5 -0
  149. package/dist/types/restful/specs/commerce_charity_v1_oas3.d.ts +224 -0
  150. package/dist/types/restful/specs/commerce_charity_v1_oas3.js +5 -0
  151. package/dist/types/restful/specs/commerce_identity_v1_oas3.d.ts +152 -0
  152. package/dist/types/restful/specs/commerce_identity_v1_oas3.js +5 -0
  153. package/dist/types/restful/specs/commerce_notification_v1_oas3.d.ts +677 -0
  154. package/dist/types/restful/specs/commerce_notification_v1_oas3.js +5 -0
  155. package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +530 -0
  156. package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.js +5 -0
  157. package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +100 -0
  158. package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.js +5 -0
  159. package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +158 -0
  160. package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.js +5 -0
  161. package/dist/types/restful/specs/developer_key_management_v1_oas3.d.ts +162 -0
  162. package/dist/types/restful/specs/developer_key_management_v1_oas3.js +5 -0
  163. package/dist/types/restful/specs/inquiry_oas3.d.ts +180 -0
  164. package/dist/types/restful/specs/inquiry_oas3.js +5 -0
  165. package/dist/types/restful/specs/return_oas3.d.ts +528 -0
  166. package/dist/types/restful/specs/return_oas3.js +5 -0
  167. package/dist/types/restful/specs/sell_account_v1_oas3.d.ts +2061 -0
  168. package/dist/types/restful/specs/sell_account_v1_oas3.js +5 -0
  169. package/dist/types/restful/specs/sell_analytics_v1_oas3.d.ts +340 -0
  170. package/dist/types/restful/specs/sell_analytics_v1_oas3.js +5 -0
  171. package/dist/types/restful/specs/sell_compliance_v1_oas3.d.ts +253 -0
  172. package/dist/types/restful/specs/sell_compliance_v1_oas3.js +5 -0
  173. package/dist/types/restful/specs/sell_feed_v1_oas3.d.ts +1191 -0
  174. package/dist/types/restful/specs/sell_feed_v1_oas3.js +5 -0
  175. package/dist/types/restful/specs/sell_finances_v1_oas3.d.ts +572 -0
  176. package/dist/types/restful/specs/sell_finances_v1_oas3.js +5 -0
  177. package/dist/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +1386 -0
  178. package/dist/types/restful/specs/sell_fulfillment_v1_oas3.js +5 -0
  179. package/dist/types/restful/specs/sell_inventory_v1_oas3.d.ts +2175 -0
  180. package/dist/types/restful/specs/sell_inventory_v1_oas3.js +5 -0
  181. package/dist/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +150 -0
  182. package/dist/types/restful/specs/sell_listing_v1_beta_oas3.js +5 -0
  183. package/dist/types/restful/specs/sell_logistics_v1_oas3.d.ts +451 -0
  184. package/dist/types/restful/specs/sell_logistics_v1_oas3.js +5 -0
  185. package/dist/types/restful/specs/sell_marketing_v1_oas3.d.ts +3728 -0
  186. package/dist/types/restful/specs/sell_marketing_v1_oas3.js +5 -0
  187. package/dist/types/restful/specs/sell_metadata_v1_oas3.d.ts +429 -0
  188. package/dist/types/restful/specs/sell_metadata_v1_oas3.js +5 -0
  189. package/dist/types/restful/specs/sell_negotiation_v1_oas3.d.ts +225 -0
  190. package/dist/types/restful/specs/sell_negotiation_v1_oas3.js +5 -0
  191. package/dist/types/restful/specs/sell_recommendation_v1_oas3.d.ts +148 -0
  192. package/dist/types/restful/specs/sell_recommendation_v1_oas3.js +5 -0
  193. package/dist/types/restfulTypes.d.ts +439 -1179
  194. package/dist/types/restfulTypes.js +1 -1
  195. package/dist/types/traditonalTypes.d.ts +35 -35
  196. package/dist/types/traditonalTypes.js +1 -1
  197. package/lib/api/apiFactory.d.ts +27 -27
  198. package/lib/api/apiFactory.js +100 -100
  199. package/lib/api/base.d.ts +10 -10
  200. package/lib/api/base.js +13 -13
  201. package/lib/api/digitalSignature.d.ts +43 -43
  202. package/lib/api/digitalSignature.js +112 -112
  203. package/lib/api/index.d.ts +13 -13
  204. package/lib/api/index.js +35 -35
  205. package/lib/api/restful/buy/browse/index.d.ts +84 -84
  206. package/lib/api/restful/buy/browse/index.js +137 -141
  207. package/lib/api/restful/buy/deal/index.d.ts +56 -55
  208. package/lib/api/restful/buy/deal/index.js +79 -79
  209. package/lib/api/restful/buy/feed/index.d.ts +44 -43
  210. package/lib/api/restful/buy/feed/index.js +84 -84
  211. package/lib/api/restful/buy/index.d.ts +17 -17
  212. package/lib/api/restful/buy/index.js +20 -20
  213. package/lib/api/restful/buy/marketing/index.d.ts +28 -27
  214. package/lib/api/restful/buy/marketing/index.js +50 -50
  215. package/lib/api/restful/buy/marketplaceInsights/index.d.ts +29 -28
  216. package/lib/api/restful/buy/marketplaceInsights/index.js +50 -50
  217. package/lib/api/restful/buy/offer/index.d.ts +24 -23
  218. package/lib/api/restful/buy/offer/index.js +36 -36
  219. package/lib/api/restful/buy/order/index.d.ts +265 -264
  220. package/lib/api/restful/buy/order/index.js +368 -368
  221. package/lib/api/restful/commerce/catalog/index.d.ts +74 -73
  222. package/lib/api/restful/commerce/catalog/index.js +105 -107
  223. package/lib/api/restful/commerce/charity/index.d.ts +35 -34
  224. package/lib/api/restful/commerce/charity/index.js +55 -55
  225. package/lib/api/restful/commerce/identity/index.d.ts +15 -14
  226. package/lib/api/restful/commerce/identity/index.js +26 -26
  227. package/lib/api/restful/commerce/index.d.ts +15 -15
  228. package/lib/api/restful/commerce/index.js +18 -18
  229. package/lib/api/restful/commerce/notification/index.d.ts +118 -117
  230. package/lib/api/restful/commerce/notification/index.js +186 -186
  231. package/lib/api/restful/commerce/taxonomy/index.d.ts +79 -78
  232. package/lib/api/restful/commerce/taxonomy/index.js +134 -134
  233. package/lib/api/restful/commerce/translation/index.d.ts +16 -15
  234. package/lib/api/restful/commerce/translation/index.js +24 -24
  235. package/lib/api/restful/developer/analytics/index.d.ts +23 -22
  236. package/lib/api/restful/developer/analytics/index.js +44 -44
  237. package/lib/api/restful/developer/index.d.ts +7 -7
  238. package/lib/api/restful/developer/index.js +10 -10
  239. package/lib/api/restful/developer/keyManagement/index.d.ts +25 -24
  240. package/lib/api/restful/developer/keyManagement/index.js +42 -42
  241. package/lib/api/restful/index.d.ts +70 -67
  242. package/lib/api/restful/index.js +187 -187
  243. package/lib/api/restful/postOrder/cancellation/index.d.ts +57 -57
  244. package/lib/api/restful/postOrder/cancellation/index.js +94 -94
  245. package/lib/api/restful/postOrder/case/index.d.ts +63 -63
  246. package/lib/api/restful/postOrder/case/index.js +94 -94
  247. package/lib/api/restful/postOrder/index.d.ts +11 -11
  248. package/lib/api/restful/postOrder/index.js +14 -14
  249. package/lib/api/restful/postOrder/inquiry/index.d.ts +82 -82
  250. package/lib/api/restful/postOrder/inquiry/index.js +130 -130
  251. package/lib/api/restful/postOrder/return/index.d.ts +231 -231
  252. package/lib/api/restful/postOrder/return/index.js +360 -360
  253. package/lib/api/restful/sell/account/index.d.ts +299 -298
  254. package/lib/api/restful/sell/account/index.js +466 -466
  255. package/lib/api/restful/sell/analytics/index.d.ts +42 -41
  256. package/lib/api/restful/sell/analytics/index.js +60 -60
  257. package/lib/api/restful/sell/compliance/index.d.ts +38 -37
  258. package/lib/api/restful/sell/compliance/index.js +56 -56
  259. package/lib/api/restful/sell/feed/index.d.ts +172 -171
  260. package/lib/api/restful/sell/feed/index.js +283 -283
  261. package/lib/api/restful/sell/finances/index.d.ts +79 -78
  262. package/lib/api/restful/sell/finances/index.js +108 -108
  263. package/lib/api/restful/sell/fulfillment/index.d.ts +138 -137
  264. package/lib/api/restful/sell/fulfillment/index.js +198 -198
  265. package/lib/api/restful/sell/index.d.ts +29 -29
  266. package/lib/api/restful/sell/index.js +32 -32
  267. package/lib/api/restful/sell/inventory/index.d.ts +249 -248
  268. package/lib/api/restful/sell/inventory/index.js +345 -345
  269. package/lib/api/restful/sell/listing/index.d.ts +15 -14
  270. package/lib/api/restful/sell/listing/index.js +24 -24
  271. package/lib/api/restful/sell/logistics/index.d.ts +45 -44
  272. package/lib/api/restful/sell/logistics/index.js +65 -65
  273. package/lib/api/restful/sell/marketing/index.d.ts +627 -626
  274. package/lib/api/restful/sell/marketing/index.js +868 -868
  275. package/lib/api/restful/sell/metadata/index.d.ts +78 -77
  276. package/lib/api/restful/sell/metadata/index.js +130 -130
  277. package/lib/api/restful/sell/negotiation/index.d.ts +25 -24
  278. package/lib/api/restful/sell/negotiation/index.js +38 -38
  279. package/lib/api/restful/sell/recommendation/index.d.ts +27 -26
  280. package/lib/api/restful/sell/recommendation/index.js +38 -38
  281. package/lib/api/traditional/XMLRequest.d.ts +109 -109
  282. package/lib/api/traditional/XMLRequest.js +182 -182
  283. package/lib/api/traditional/clientAlerts/index.d.ts +9 -9
  284. package/lib/api/traditional/clientAlerts/index.js +14 -14
  285. package/lib/api/traditional/clientAlerts/types.d.ts +31 -31
  286. package/lib/api/traditional/clientAlerts/types.js +34 -35
  287. package/lib/api/traditional/fields.d.ts +1948 -1948
  288. package/lib/api/traditional/fields.js +1948 -1948
  289. package/lib/api/traditional/finding/index.d.ts +12 -12
  290. package/lib/api/traditional/finding/index.js +15 -15
  291. package/lib/api/traditional/index.d.ts +17 -17
  292. package/lib/api/traditional/index.js +220 -220
  293. package/lib/api/traditional/merchandising/index.d.ts +7 -7
  294. package/lib/api/traditional/merchandising/index.js +10 -10
  295. package/lib/api/traditional/shopping/index.d.ts +11 -11
  296. package/lib/api/traditional/shopping/index.js +15 -15
  297. package/lib/api/traditional/trading/index.d.ts +142 -142
  298. package/lib/api/traditional/trading/index.js +145 -145
  299. package/lib/auth/authNAuth.d.ts +49 -49
  300. package/lib/auth/authNAuth.js +122 -122
  301. package/lib/auth/index.d.ts +17 -17
  302. package/lib/auth/index.js +31 -31
  303. package/lib/auth/oAuth2.d.ts +95 -95
  304. package/lib/auth/oAuth2.js +265 -265
  305. package/lib/eBayApi.d.ts +59 -59
  306. package/lib/eBayApi.js +141 -141
  307. package/lib/ebay-api.min.js +1 -1
  308. package/lib/enums/apiEnums.d.ts +49 -49
  309. package/lib/enums/apiEnums.js +54 -54
  310. package/lib/enums/index.d.ts +2 -2
  311. package/lib/enums/index.js +18 -18
  312. package/lib/enums/restfulEnums.d.ts +976 -970
  313. package/lib/enums/restfulEnums.js +1021 -1016
  314. package/lib/errors/index.d.ts +66 -66
  315. package/lib/errors/index.js +213 -212
  316. package/lib/index.d.ts +2 -2
  317. package/lib/index.js +6 -6
  318. package/lib/nanoevents.d.ts +6 -6
  319. package/lib/nanoevents.js +24 -24
  320. package/lib/request.d.ts +26 -26
  321. package/lib/request.js +50 -50
  322. package/lib/types/apiTypes.d.ts +40 -40
  323. package/lib/types/apiTypes.js +2 -2
  324. package/lib/types/index.d.ts +3 -3
  325. package/lib/types/index.js +19 -19
  326. package/lib/types/restful/specs/buy_browse_v1_oas3.d.ts +1531 -0
  327. package/lib/types/restful/specs/buy_browse_v1_oas3.js +6 -0
  328. package/lib/types/restful/specs/buy_deal_v1_oas3.d.ts +434 -0
  329. package/lib/types/restful/specs/buy_deal_v1_oas3.js +6 -0
  330. package/lib/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +561 -0
  331. package/lib/types/restful/specs/buy_feed_v1_beta_oas3.js +6 -0
  332. package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +288 -0
  333. package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.js +6 -0
  334. package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +304 -0
  335. package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +6 -0
  336. package/lib/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +173 -0
  337. package/lib/types/restful/specs/buy_offer_v1_beta_oas3.js +6 -0
  338. package/lib/types/restful/specs/buy_order_v1_beta_oas3.d.ts +1701 -0
  339. package/lib/types/restful/specs/buy_order_v1_beta_oas3.js +6 -0
  340. package/lib/types/restful/specs/cancellation_oas3.d.ts +112 -0
  341. package/lib/types/restful/specs/cancellation_oas3.js +6 -0
  342. package/lib/types/restful/specs/case_oas3.d.ts +124 -0
  343. package/lib/types/restful/specs/case_oas3.js +6 -0
  344. package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +758 -0
  345. package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.js +6 -0
  346. package/lib/types/restful/specs/commerce_charity_v1_oas3.d.ts +224 -0
  347. package/lib/types/restful/specs/commerce_charity_v1_oas3.js +6 -0
  348. package/lib/types/restful/specs/commerce_identity_v1_oas3.d.ts +152 -0
  349. package/lib/types/restful/specs/commerce_identity_v1_oas3.js +6 -0
  350. package/lib/types/restful/specs/commerce_notification_v1_oas3.d.ts +677 -0
  351. package/lib/types/restful/specs/commerce_notification_v1_oas3.js +6 -0
  352. package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +530 -0
  353. package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.js +6 -0
  354. package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +100 -0
  355. package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.js +6 -0
  356. package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +158 -0
  357. package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.js +6 -0
  358. package/lib/types/restful/specs/developer_key_management_v1_oas3.d.ts +162 -0
  359. package/lib/types/restful/specs/developer_key_management_v1_oas3.js +6 -0
  360. package/lib/types/restful/specs/inquiry_oas3.d.ts +180 -0
  361. package/lib/types/restful/specs/inquiry_oas3.js +6 -0
  362. package/lib/types/restful/specs/return_oas3.d.ts +528 -0
  363. package/lib/types/restful/specs/return_oas3.js +6 -0
  364. package/lib/types/restful/specs/sell_account_v1_oas3.d.ts +2061 -0
  365. package/lib/types/restful/specs/sell_account_v1_oas3.js +6 -0
  366. package/lib/types/restful/specs/sell_analytics_v1_oas3.d.ts +340 -0
  367. package/lib/types/restful/specs/sell_analytics_v1_oas3.js +6 -0
  368. package/lib/types/restful/specs/sell_compliance_v1_oas3.d.ts +253 -0
  369. package/lib/types/restful/specs/sell_compliance_v1_oas3.js +6 -0
  370. package/lib/types/restful/specs/sell_feed_v1_oas3.d.ts +1191 -0
  371. package/lib/types/restful/specs/sell_feed_v1_oas3.js +6 -0
  372. package/lib/types/restful/specs/sell_finances_v1_oas3.d.ts +572 -0
  373. package/lib/types/restful/specs/sell_finances_v1_oas3.js +6 -0
  374. package/lib/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +1386 -0
  375. package/lib/types/restful/specs/sell_fulfillment_v1_oas3.js +6 -0
  376. package/lib/types/restful/specs/sell_inventory_v1_oas3.d.ts +2175 -0
  377. package/lib/types/restful/specs/sell_inventory_v1_oas3.js +6 -0
  378. package/lib/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +150 -0
  379. package/lib/types/restful/specs/sell_listing_v1_beta_oas3.js +6 -0
  380. package/lib/types/restful/specs/sell_logistics_v1_oas3.d.ts +451 -0
  381. package/lib/types/restful/specs/sell_logistics_v1_oas3.js +6 -0
  382. package/lib/types/restful/specs/sell_marketing_v1_oas3.d.ts +3728 -0
  383. package/lib/types/restful/specs/sell_marketing_v1_oas3.js +6 -0
  384. package/lib/types/restful/specs/sell_metadata_v1_oas3.d.ts +429 -0
  385. package/lib/types/restful/specs/sell_metadata_v1_oas3.js +6 -0
  386. package/lib/types/restful/specs/sell_negotiation_v1_oas3.d.ts +225 -0
  387. package/lib/types/restful/specs/sell_negotiation_v1_oas3.js +6 -0
  388. package/lib/types/restful/specs/sell_recommendation_v1_oas3.d.ts +148 -0
  389. package/lib/types/restful/specs/sell_recommendation_v1_oas3.js +6 -0
  390. package/lib/types/restfulTypes.d.ts +439 -1179
  391. package/lib/types/restfulTypes.js +2 -2
  392. package/lib/types/traditonalTypes.d.ts +35 -35
  393. package/lib/types/traditonalTypes.js +2 -2
  394. package/package.json +6 -4
@@ -0,0 +1,1701 @@
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
+ "/checkout_session/{checkoutSessionId}/apply_coupon": {
7
+ /** @description (Limited Release) You must be whitelisted to use this method. This method adds a coupon to an eBay proxy guest checkout session and applies it to all the eligible items in the order. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions Maximum: One coupon per order For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
8
+ post: operations["applyCoupon"];
9
+ };
10
+ "/checkout_session/{checkoutSessionId}": {
11
+ /** @description This method returns the details of the specified eBay member checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
12
+ get: operations["getCheckoutSession"];
13
+ };
14
+ "/checkout_session/initiate": {
15
+ /** @description This method creates a eBay member checkout session, which is the first step in performing a checkout. You use this method to create a checkout session before you can process a checkout. This method assumes (and checks for) payment using PayPal, which is linked to the buyer's eBay account. You can use the updatePaymentInfo method to pay by a credit card. If the address submitted cannot be validated, a warning message will be returned. The method returns a checkoutSessionId that you use as a URI parameter in subsequent checkout methods. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. Tip: To test the entire checkout flow, you might need a "test" credit card. You can generate a credit card number from http://www.getcreditcardnumbers.com. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
16
+ post: operations["initiateCheckoutSession"];
17
+ };
18
+ "/checkout_session/{checkoutSessionId}/place_order": {
19
+ /** @description This method creates the purchase order, pays for the items, and terminates the specified eBay member checkout session. The checkoutSessionId is passed in as a URI parameter and is required. Although there is not a request payload, for this method you must pass in { } in the request body. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. Note: If the credit card is declined, the checkout session is unusable. You will need to create a new checkout session for the order using the initiateCheckoutSession method. */
20
+ post: operations["placeOrder"];
21
+ };
22
+ "/checkout_session/{checkoutSessionId}/remove_coupon": {
23
+ /** @description (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay member checkout session. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is specified in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
24
+ post: operations["removeCoupon"];
25
+ };
26
+ "/checkout_session/{checkoutSessionId}/update_payment_info": {
27
+ /** @description This method changes the payment method information of the specified eBay member checkout session. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
28
+ post: operations["updatePaymentInfo"];
29
+ };
30
+ "/checkout_session/{checkoutSessionId}/update_quantity": {
31
+ /** @description This method changes the quantity of the specified line item in an eBay member checkout session. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
32
+ post: operations["updateQuantity"];
33
+ };
34
+ "/checkout_session/{checkoutSessionId}/update_shipping_address": {
35
+ /** @description This method changes the shipping address for in an eBay member checkout session. All the line items in an order must be shipped to the same address, but the shipping method can be specific to the line item. Note: If the address submitted cannot be validated, a warning message will be returned. This does not prevent the method from executing, but you may want to verify the address. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
36
+ post: operations["updateShippingAddress"];
37
+ };
38
+ "/checkout_session/{checkoutSessionId}/update_shipping_option": {
39
+ /** @description This method changes the shipping method for the specified line item in an eBay member checkout session. The shipping option can be set for each line item. This gives the shopper the ability choose the cost of shipping for each line item. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
40
+ post: operations["updateShippingOption"];
41
+ };
42
+ "/guest_checkout_session/{checkoutSessionId}/apply_coupon": {
43
+ /** @description (Limited Release) You must be whitelisted to use this method. This method adds a coupon to an eBay guest checkout session and applies it to all the eligible items in the order. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions The PayPal Smart Button eBay guest payment flow does not support using coupons. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
44
+ post: operations["applyGuestCoupon"];
45
+ };
46
+ "/guest_checkout_session/{checkoutSessionId}": {
47
+ /** @description This method returns the details of the specified guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
48
+ get: operations["getGuestCheckoutSession"];
49
+ };
50
+ "/guest_checkout_session/initiate": {
51
+ /** @description This method creates an eBay guest checkout session, which is the first step in performing a checkout. The method returns a checkoutSessionId that you use as a URI parameter in subsequent checkout methods. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. TIP: To test the entire checkout flow, you might need a "test" credit card. You can generate a credit card number from http://www.getcreditcardnumbers.com. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
52
+ post: operations["initiateGuestCheckoutSession"];
53
+ };
54
+ "/guest_checkout_session/{checkoutSessionId}/initiate_payment": {
55
+ /** @description This method is used only in the PayPal Smart Button eBay guest payment flow. It sets the payment to the PayPal Checkout, which enables eBay guests to pay for their items with or without having a PayPal account without leaving your App or site. You can use this payment flow whether you are PCI compliant or not. To pay for items, buyers can either: Sign into their PayPal account and use any payment method associated with that account. Without a PayPal account, they can pay using a credit card or a direct debit from their bank account. For details about this flow, see PayPal Smart Button eBay guest payment flow. Requirement: To use this method you must integrate with PayPal's checkout.js on the client side. API URLs To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions If you want to apply or remove a coupon, you must do that before using this method. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
56
+ post: operations["initiateGuestPayment"];
57
+ };
58
+ "/guest_checkout_session/{checkoutSessionId}/place_order": {
59
+ /** @description This method creates the purchase order, pays for the items, and terminates the specified guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. Request headers This method requires specific request headers. For details see, HTTP request headers section. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. Note: If the credit card is declined, the checkout session is unusable. You will need to create a new checkout session for the order using the initiateGuestCheckoutSession method. */
60
+ post: operations["placeGuestOrder"];
61
+ };
62
+ "/guest_checkout_session/{checkoutSessionId}/remove_coupon": {
63
+ /** @description (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is specified in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions The PayPal Smart Button eBay guest payment flow does not support using coupons. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
64
+ post: operations["removeGuestCoupon"];
65
+ };
66
+ "/guest_checkout_session/{checkoutSessionId}/update_payment_info": {
67
+ /** @description This method changes the payment method information of the specified guest checkout session. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
68
+ post: operations["updateGuestPaymentInfo"];
69
+ };
70
+ "/guest_checkout_session/{checkoutSessionId}/update_quantity": {
71
+ /** @description This method changes the quantity of the specified line item in an eBay guest checkout session. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
72
+ post: operations["updateGuestQuantity"];
73
+ };
74
+ "/guest_checkout_session/{checkoutSessionId}/update_shipping_address": {
75
+ /** @description This method changes the shipping address for the order in an eBay guest checkout session. All the line items in an order must be shipped to the same address, but the shipping method can be specific to the line item. Note: If the address submitted cannot be validated, a warning message will be returned. This does not prevent the method from executing, but you may want to verify the address. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
76
+ post: operations["updateGuestShippingAddress"];
77
+ };
78
+ "/guest_checkout_session/{checkoutSessionId}/update_shipping_option": {
79
+ /** @description This method changes the shipping method for the specified line item in an eBay guest checkout session. The shipping option can be set for each line item. This gives the shopper the ability choose the cost of shipping for each line item. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
80
+ post: operations["updateGuestShippingOption"];
81
+ };
82
+ "/proxy_guest_checkout_session/{checkoutSessionId}/apply_coupon": {
83
+ /** @description (Limited Release) You must be whitelisted to use this method. This method adds a coupon to an eBay proxy guest checkout session and applies it to all the eligible items in the order. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions Maximum: One coupon per order For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
84
+ post: operations["applyProxyGuestCoupon"];
85
+ };
86
+ "/proxy_guest_checkout_session/{checkoutSessionId}": {
87
+ /** @description This method returns the details of the specified eBay proxy guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
88
+ get: operations["getProxyGuestCheckoutSession"];
89
+ };
90
+ "/proxy_guest_checkout_session/initiate": {
91
+ /** @description This method creates an eBay proxy guest checkout session, which is a payment flow that requires integration with a VSP (vault service provider), such as Braintree. The VSP handles only the methods within this flow that contain payment information. This method returns the details of the order and a marketplace specific checkoutSessionId that you use as a URI parameter in subsequent proxy_guest_checkout_session resource checkout methods. For details about the VSP payment flow, see Vault service eBay guest payment flow. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. TIP: To test the entire checkout flow, you might need a "test" credit card. You can generate a credit card number from http://www.getcreditcardnumbers.com. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
92
+ post: operations["initiateProxyGuestCheckoutSession"];
93
+ };
94
+ "/proxy_guest_checkout_session/{checkoutSessionId}/place_order": {
95
+ /** @description This method creates the proxy guest purchase order, pays for the items, and terminates the specified guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
96
+ post: operations["placeProxyGuestOrder"];
97
+ };
98
+ "/proxy_guest_checkout_session/{checkoutSessionId}/remove_coupon": {
99
+ /** @description (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay proxy guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is specified in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
100
+ post: operations["removeProxyGuestCoupon"];
101
+ };
102
+ "/proxy_guest_checkout_session/{checkoutSessionId}/update_payment_info": {
103
+ /** @description This method adds or changes the payment information of the specified proxy guest checkout session. This endpoint is invoked by the VSP (vault service provider) on behalf of the eBay partner. For details about the VSP payment flow, see Vault service eBay guest payment flow. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
104
+ post: operations["updateProxyGuestPaymentInfo"];
105
+ };
106
+ "/proxy_guest_checkout_session/{checkoutSessionId}/update_quantity": {
107
+ /** @description This method changes the quantity of the specified line item in an eBay proxy guest checkout session. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
108
+ post: operations["updateProxyGuestQuantity"];
109
+ };
110
+ "/proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_address": {
111
+ /** @description This method changes the shipping address for the order in an eBay proxy guest checkout session. All the line items in an order must be shipped to the same address, but the shipping method can be specific to the line item. Note: If the address submitted cannot be validated, a warning message will be returned. This does not prevent the method from executing, but you may want to verify the address. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
112
+ post: operations["updateProxyGuestShippingAddress"];
113
+ };
114
+ "/proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_option": {
115
+ /** @description This method changes the shipping method for the specified line item in an eBay proxy guest checkout session. The shipping option can be set for each line item. This gives the shopper the ability choose the cost of shipping for each line item. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
116
+ post: operations["updateProxyGuestShippingOption"];
117
+ };
118
+ "/guest_purchase_order/{purchaseOrderId}": {
119
+ /** @description This method retrieves the details about a specific guest purchase order. It returns the line items, including purchase order status; dates created and modified; item quantity and listing data; payment and shipping information; and prices, taxes, and discounts and credits. The purchaseOrderId is passed in as a URI parameter and is required. This method has no request payload. The placeGuestOrder or method initiates the payment process, which can sometimes take a few minutes. You can use this method to not only get the details of a purchase order but to check the value of the purchaseOrderPaymentStatus field to determine if the order has been paid for. If the order has been paid for, this field will return PAID. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
120
+ get: operations["getGuestPurchaseOrder"];
121
+ };
122
+ "/purchase_order/{purchaseOrderId}": {
123
+ /** @description This method retrieves the details about a specific eBay member purchase order. It returns the line items, including purchase order status; dates created and modified; item quantity and listing data; payment and shipping information; and prices, taxes, and discounts and credits. The purchaseOrderId is passed in as a URI parameter and is required. This method has no request payload. The placeOrder method initiates the payment process, which can sometimes take a few minutes. You can use this method to not only get the details of a purchase order but to check the value of the purchaseOrderPaymentStatus field to determine if the order has been paid for. If the order has been paid for, this field will return PAID. This method also returns the legacyItemId, legacyTransactionId, and legacyOrderId fields. The values in these fields enable eBay partners to use the Post Order API for eBay member checkouts, to process a return or cancellation. For more information, see Post order tasks in the Buy Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
124
+ get: operations["getPurchaseOrder"];
125
+ };
126
+ }
127
+ export type webhooks = Record<string, never>;
128
+ export interface components {
129
+ schemas: {
130
+ /** @description The type that defines the fields for seller adjustments. An adjustment can be a credit or debit. */
131
+ Adjustment: {
132
+ /** @description The container for the amount and currency of the adjustment. */
133
+ amount?: components["schemas"]["Amount"];
134
+ /** @description Text that describes the adjustment. */
135
+ label?: string;
136
+ };
137
+ /** @description The type the defines the fields for the details of a monetary amount, in the currency used by the method and in the original currency, if the amount was converted between currencies. */
138
+ Amount: {
139
+ /** @description A three letter ISO 4217 code specifying the currency of the monetary amount. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/CurrencyCodeEnum.html'>eBay API documentation</a> */
140
+ currency?: string;
141
+ /** @description The monetary amount. */
142
+ value?: string;
143
+ };
144
+ /** @description The type that defines the fields for an address. Maximum characters AU, CA, &amp; US - 40 DE &amp; GB - 35 All other marketplaces - 50 */
145
+ BillingAddress: {
146
+ /** @description The first line of the street address. Maximum characters AU, CA, &amp; US - 40 DE &amp; GB - 35 All other marketplaces - 50 */
147
+ addressLine1?: string;
148
+ /** @description The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'. */
149
+ addressLine2?: string;
150
+ /** @description The city of the address. */
151
+ city?: string;
152
+ /** @description The two letter code representing the country of the address. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/CountryCodeEnum.html'>eBay API documentation</a> */
153
+ country?: string;
154
+ /** @description The county of the address. */
155
+ county?: string;
156
+ /** @description The buyer's first name. */
157
+ firstName?: string;
158
+ /** @description The buyer's last name. */
159
+ lastName?: string;
160
+ /** @description The postal code of the address. */
161
+ postalCode?: string;
162
+ /** @description The state or province of the address. Note: For the US marketplace, this is a 2 character value. For a list of these, see US State and Canada Province Codes. */
163
+ stateOrProvince?: string;
164
+ };
165
+ /** @description The type that defines the fields for initiateProxyGuestCheckoutSession request. */
166
+ CheckoutSessionRequestWithoutPayment: {
167
+ /** @description The buyer's email address. */
168
+ contactEmail?: string;
169
+ /** @description The buyer's first name. */
170
+ contactFirstName?: string;
171
+ /** @description The buyer's last name. */
172
+ contactLastName?: string;
173
+ /** @description The type that defines the fields for a line item in an eBay guest checkout session. Maximum number of line items: 10 */
174
+ lineItemInputs?: (components["schemas"]["LineItemInput"])[];
175
+ /** @description The container that returns the shipping address for an eBay guest checkout session. sThe Order API supports only domestic shipping. For example, an item purchased on the EBAY_DE marketplace can be shipped only to an address in Germany. Note: If the address cannot be validated, a warning message is be returned along with the response. */
176
+ shippingAddress?: components["schemas"]["ShippingAddress"];
177
+ };
178
+ /** @description Type that defines the fields for a checkout session. */
179
+ CheckoutSessionResponse: {
180
+ /** @description The container that returns the payment method that can be used to purchase the items. */
181
+ acceptedPaymentMethods?: (components["schemas"]["PaymentMethod"])[];
182
+ /** @description The container that returns the information for the coupons that were applied in the checkout session. */
183
+ appliedCoupons?: (components["schemas"]["Coupon"])[];
184
+ /** @description The checkoutSessionId submitted in the request. */
185
+ checkoutSessionId?: string;
186
+ /** @description The time the checkout session will end. To purchase the items the order must be placed before this time. */
187
+ expirationDate?: string;
188
+ /** @description An array of line items associated with the checkout session. */
189
+ lineItems?: (components["schemas"]["LineItem"])[];
190
+ /** @description The container that returns the grand total, costs, discounts, seller fees, and adjustments of all the line items. */
191
+ pricingSummary?: components["schemas"]["PricingSummary"];
192
+ /** @description The container that returns the payment methods that can be used for the checkout. This is returned only if you have used the updatePaymentInfo method to change the payment method. */
193
+ providedPaymentInstrument?: components["schemas"]["ProvidedPaymentInstrument"];
194
+ /** @description The container that returns the address to which the purchase order will be shipped. */
195
+ shippingAddress?: components["schemas"]["ShippingAddress"];
196
+ /** @description An array of any process errors or warnings that were generated during the method processing. */
197
+ warnings?: (components["schemas"]["Error"])[];
198
+ };
199
+ /** @description The type the defines the fields for the coupon information. */
200
+ Coupon: {
201
+ /** @description The redemption code of the coupon. Note: There can be only one redemption code per order. */
202
+ redemptionCode?: string;
203
+ };
204
+ /** @description The type that defines the fields for the coupon information used in the request. */
205
+ CouponRequest: {
206
+ /** @description The redemption code of the coupon. Maximum: one redemption code per order */
207
+ redemptionCode?: string;
208
+ };
209
+ /** @description The type that defines the fields used to create an eBay guest checkout session. */
210
+ CreateGuestCheckoutSessionRequest: {
211
+ /** @description The buyer's email address. */
212
+ contactEmail?: string;
213
+ /** @description The buyer's first name. */
214
+ contactFirstName?: string;
215
+ /** @description The buyer's last name. */
216
+ contactLastName?: string;
217
+ /** @description The container that returns the credit card being used to pay for the items. */
218
+ creditCard?: components["schemas"]["CreditCard"];
219
+ /** @description The type that defines the fields for a line item in an eBay guest checkout session. Maximum number of line items: 10 */
220
+ lineItemInputs?: (components["schemas"]["LineItemInput"])[];
221
+ /** @description The container that returns the shipping address for an eBay guest checkout session. The Order API supports only domestic shipping. For example, an item purchased on the EBAY_DE marketplace can be shipped only to an address in Germany. Note: If the address cannot be validated, a warning message is be returned along with the response. */
222
+ shippingAddress?: components["schemas"]["ShippingAddress"];
223
+ };
224
+ /** @description The type that defines the fields for creating a eBay member checkout session. */
225
+ CreateSignInCheckoutSessionRequest: {
226
+ /** @description The container that returns the buyer's credit card information. */
227
+ creditCard?: components["schemas"]["CreditCard"];
228
+ /** @description The container for the line item information fields in an eBay member checkout session. Maximum number of line items: 10 */
229
+ lineItemInputs?: (components["schemas"]["LineItemInput"])[];
230
+ /** @description The container for the shipping address information in an eBay member checkout session. The Order API supports only domestic shipping. For example, an item purchased on the EBAY_DE marketplace can be shipped only to an address in Germany. Note: If the address cannot be validated, a warning message is be returned along with the response. */
231
+ shippingAddress?: components["schemas"]["ShippingAddress"];
232
+ };
233
+ /** @description The type that defines the fields for the credit card that's used to pay for the items. */
234
+ CreditCard: {
235
+ /** @description The name of the card holder under which the credit card was issued. */
236
+ accountHolderName?: string;
237
+ /** @description The container that returns the billing address of the card holder. Note: If the address cannot be validated, a warning message will be returned. */
238
+ billingAddress?: components["schemas"]["BillingAddress"];
239
+ /** @description The type of the credit car, such as Visa or MasterCard. */
240
+ brand?: string;
241
+ /** @description The credit card number on the card. */
242
+ cardNumber?: string;
243
+ /** @description The Card Verification Value of the credit card. This value is also known as the card verification code (CVC) or card security code (CSC). This is a three-digit number on VISA, MasterCard, and Discover branded credit and debit cards. On American Express branded cards, this is a four-digit numeric code. Note: This number is not the PIN associated with the card. */
244
+ cvvNumber?: string;
245
+ /**
246
+ * Format: int32
247
+ * @description The month the credit card expires.
248
+ */
249
+ expireMonth?: number;
250
+ /**
251
+ * Format: int32
252
+ * @description The year the credit card expires.
253
+ */
254
+ expireYear?: number;
255
+ };
256
+ /** @description The type that defines the fields for the error messages. */
257
+ Error: {
258
+ /** @description Identifies the type of error. */
259
+ category?: string;
260
+ /** @description Name for the primary system where the error occurred. This is relevant for application errors. */
261
+ domain?: string;
262
+ /**
263
+ * Format: int32
264
+ * @description A unique number to identify the error.
265
+ */
266
+ errorId?: number;
267
+ /** @description An array of request elements most closely associated to the error. */
268
+ inputRefIds?: (string)[];
269
+ /** @description A more detailed explanation of the error. */
270
+ longMessage?: string;
271
+ /** @description Information on how to correct the problem, in the end user's terms and language where applicable. */
272
+ message?: string;
273
+ /** @description An array of request elements most closely associated to the error. */
274
+ outputRefIds?: (string)[];
275
+ /** @description An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. */
276
+ parameters?: (components["schemas"]["ErrorParameter"])[];
277
+ /** @description Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc. */
278
+ subdomain?: string;
279
+ };
280
+ /** @description An array of name/value pairs that provide more details regarding error condition. */
281
+ ErrorParameter: {
282
+ /** @description The object of the error. */
283
+ name?: string;
284
+ /** @description The value of the object. */
285
+ value?: string;
286
+ };
287
+ /** @description The type that defines the fields for the location of a tracking event. */
288
+ EventLocation: {
289
+ /** @description The city where the tracking event occurred. */
290
+ city?: string;
291
+ /** @description The two letter code representing the country of the address where the tracking event occurred. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/CountryCodeEnum.html'>eBay API documentation</a> */
292
+ country?: string;
293
+ /** @description The county where the tracking event occurred. */
294
+ county?: string;
295
+ /** @description The postal code where the tracking event occurred. */
296
+ postalCode?: string;
297
+ /** @description The state where the tracking event occurred. */
298
+ stateOrProvince?: string;
299
+ };
300
+ GuestCheckoutSessionResponse: {
301
+ /** @description The container that returns the payment method that can be used to purchase the items. */
302
+ acceptedPaymentMethods?: (components["schemas"]["PaymentMethod"])[];
303
+ /** @description The container that returns the information for the coupons that were applied in the checkout session. */
304
+ appliedCoupons?: (components["schemas"]["Coupon"])[];
305
+ /** @description The checkoutSessionId submitted in the request. */
306
+ checkoutSessionId?: string;
307
+ /** @description The time the checkout session will end. To purchase the items the order must be placed before this time. */
308
+ expirationDate?: string;
309
+ /** @description An array of line items associated with the checkout session. */
310
+ lineItems?: (components["schemas"]["LineItem"])[];
311
+ /** @description The container that returns the marketing consent fields. These fields show the legal marketing consent message to be shown to the buyer when they place the order, and the marketing channels, for example email, and marketing types, for example promotions, the buyer can choose to receive. */
312
+ marketingMessages?: (components["schemas"]["MarketingMessage"])[];
313
+ /** @description The container that returns the grand total, costs, discounts, seller fees, and adjustments of all the line items. */
314
+ pricingSummary?: components["schemas"]["PricingSummary"];
315
+ /** @description The container that returns the payment methods that can be used for the checkout. This is returned only if you have used the updatePaymentInfo method to change the payment method. */
316
+ providedPaymentInstrument?: components["schemas"]["ProvidedPaymentInstrument"];
317
+ /** @description The container that returns the address to which the purchase order will be shipped. */
318
+ shippingAddress?: components["schemas"]["ShippingAddress"];
319
+ /** @description An array of any process errors or warnings that were generated during the method processing. */
320
+ warnings?: (components["schemas"]["Error"])[];
321
+ };
322
+ /** @description The type that defines the fields that enables the buyer to give or withhold their permission to receive marketing messages. */
323
+ GuestPlaceOrderRequest: {
324
+ /** @description The container for the marketing channels, the types of messages the buyer can choose to receive, and the field to indicate whether the buyer wants to receive marketing materials from eBay. These fields are required for all marketplaces. See Marketing Consent Notice for details. */
325
+ marketingTerms?: (components["schemas"]["MarketingTerms"])[];
326
+ };
327
+ /** @description The type that defines the fields for a guest purchase order. */
328
+ GuestPurchaseOrder: {
329
+ /** @description The container that returns the information for the coupons that were applied in the order. */
330
+ appliedCoupons?: (components["schemas"]["Coupon"])[];
331
+ /** @description An array of the line items in the order. */
332
+ lineItems?: (components["schemas"]["OrderLineItem"])[];
333
+ /** @description The container that returns the monetary details of the order. */
334
+ pricingSummary?: components["schemas"]["PricingSummary"];
335
+ /** @description The creation date of the purchase order. */
336
+ purchaseOrderCreationDate?: string;
337
+ /** @description The unique identifier of the purchase order. This value was returned in the purchaseOrderId field by the placeGuestOrder method. */
338
+ purchaseOrderId?: string;
339
+ /** @description The container for the status of the payment for the purchase order. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PurchaseOrderPaymentStatusEnum.html'>eBay API documentation</a> */
340
+ purchaseOrderPaymentStatus?: string;
341
+ /** @description An enumeration value that indicates the current status of the buyer's payment and any refund that applies to the purchase order. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PurchaseOrderStatusEnum.html'>eBay API documentation</a> */
342
+ purchaseOrderStatus?: string;
343
+ /** @description The total amount of any refunds for the purchase order. */
344
+ refundedAmount?: components["schemas"]["Amount"];
345
+ /** @description The container for any warning messages. */
346
+ warnings?: (components["schemas"]["Error"])[];
347
+ };
348
+ /** @description The type the defines the fields for the details of an image, such as size and URL. Currently only imageUrl is getting populated. The height and width were added for future use. */
349
+ Image: {
350
+ /**
351
+ * Format: int32
352
+ * @description Reserved for future use.
353
+ */
354
+ height?: number;
355
+ /** @description The URL of the image. */
356
+ imageUrl?: string;
357
+ /**
358
+ * Format: int32
359
+ * @description Reserved for future use.
360
+ */
361
+ width?: number;
362
+ };
363
+ /** @description Type that defines the fields for the initiateGuestPayment method. */
364
+ InitiatePaymentRequest: {
365
+ /** @description The enumeration value that specifies the payment method company. Note: The only value supported for the initiateGuestPayment method is PAYPAL_CHECKOUT. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PaymentMethodBrandEnum.html'>eBay API documentation</a> */
366
+ paymentMethodBrandType?: string;
367
+ /** @description The enumeration value that specifies the payment method type. Note: The only value supported for the initiateGuestPayment method is WALLET. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PaymentMethodTypeEnum.html'>eBay API documentation</a> */
368
+ paymentMethodType?: string;
369
+ };
370
+ /** @description The type that defines the fields to support using the Post Order API for returns and cancellations. Restriction: The Post Order API can be used only with eBay member checkouts. */
371
+ LegacyReference: {
372
+ /** @description The legacy ID used to identify an item. This is used by the Post Order API Create Return Request method. This call initiates the item return process. For more information on how to use this field in the Post Order API, see Create a return request in the Buy Integration Guide. Restriction: The Post Order API can be used only with eBay member checkouts. */
373
+ legacyItemId?: string;
374
+ /** @description The legacy ID of the order. This is used by the Post Order API Submit Cancellation Request method. This method initiates the item cancellation process. For more information on how to use this field in the Post Order API, see Using the Post Order API. Restriction: The Post Order API can be used only with eBay member checkouts. */
375
+ legacyOrderId?: string;
376
+ /** @description The legacy ID of the transaction. This is used by the Post Order API Create Return Request call. This call initiates the item return process. For more information on how to use this field in the Post Order API, see Using the Post Order API in the Buy Integration Guide. Restriction: The Post Order API can be used only with eBay member checkouts. */
377
+ legacyTransactionId?: string;
378
+ };
379
+ /** @description The container that returns an individual line item in a checkout transaction. */
380
+ LineItem: {
381
+ /** @description The cost of a single item in this line item. This is the starting point for computing the price during checkout session. */
382
+ baseUnitPrice?: components["schemas"]["Amount"];
383
+ /** @description An eBay-assigned URL that points to an image of the item. eBay assigns the URL when the seller uploads the image. */
384
+ image?: components["schemas"]["Image"];
385
+ /** @description A unique eBay-assigned ID value that identifies the item. */
386
+ itemId?: string;
387
+ /** @description A unique eBay-assigned ID value that identifies the line item in a checkout session. */
388
+ lineItemId?: string;
389
+ /** @description The total cost for the items in this line item taking into account the quantity and applying any seller item discounts, such as Buy 1 Get 1, and any coupon that applies to this item. Note: This also does not include any shipping discounts, shipping costs, fees, or seller adjustments. */
390
+ netPrice?: components["schemas"]["Amount"];
391
+ /** @description An array of promotions applied with the item of this line item. */
392
+ promotions?: (components["schemas"]["Promotion"])[];
393
+ /**
394
+ * Format: int32
395
+ * @description The number of individual items ordered for this line item, as specified by the buyer.
396
+ */
397
+ quantity?: number;
398
+ /** @description The container that returns the information about the seller, such as their eBay user name. */
399
+ seller?: components["schemas"]["Seller"];
400
+ /** @description An array of the shipping methods that are available for the line item. By default, the first one will be selected. */
401
+ shippingOptions?: (components["schemas"]["ShippingOption"])[];
402
+ /** @description This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.). */
403
+ shortDescription?: string;
404
+ /** @description The seller created title of the item. */
405
+ title?: string;
406
+ };
407
+ /** @description The type that defines the fields for a line item. */
408
+ LineItemInput: {
409
+ /** @description The eBay identifier of an item. This ID is returned by the Browse and Feed API methods. The ID must be in RESTful item ID format. For example: v1|262446562346|561248611424 or v1|112330214619|0. For more information about item ID for RESTful APIs, see the Legacy API compatibility. Each itemId will become a single line item. You can have a maximum of 10 itemId(s) per checkout. Maximum: 10 */
410
+ itemId?: string;
411
+ /**
412
+ * Format: int32
413
+ * @description The number of items ordered in this line item.
414
+ */
415
+ quantity?: number;
416
+ };
417
+ /** @description Type the defines the fields for the line item ID and the quantity. */
418
+ LineItemReference: {
419
+ /** @description A unique eBay-assigned ID value to identify the line item in a purchase order. */
420
+ lineItemId?: string;
421
+ /**
422
+ * Format: int32
423
+ * @description The number of individual items ordered for this line item, as specified by the buyer.
424
+ */
425
+ quantity?: number;
426
+ };
427
+ /** @description The type that defines the marketing consent fields. These fields show the legal message to be shown to the buyer, and the marketing channels and marketing type the buyer can choose to receive. */
428
+ MarketingMessage: {
429
+ /** @description This field returns the following marketing consent legal message. This message is to be shown to the buyer when they place the order. I agree to receive marketing offers, promotions, and surveys from eBay through emails. */
430
+ legalMessage?: string;
431
+ /** @description A list of enumeration values representing the marketing channels, such as email, that the buyer can choose to receive. These are to be shown to the buyer when they place the order. */
432
+ marketingChannels?: (string)[];
433
+ /** @description A list of enumeration values representing the marketing types, such as OFFER, that the buyer can choose to receive. These are to be shown to the buyer when they place the order. */
434
+ marketingTypes?: (string)[];
435
+ };
436
+ /** @description The type that defines the fields used to let the buyer opt-in or opt-out-of receiving marketing messages. And the list of marketing channels and types. */
437
+ MarketingTerms: {
438
+ /** @description An enumeration value representing the available marketing channels, such as EMAIL. Valid Values: EMAIL */
439
+ marketingChannels?: (string)[];
440
+ /** @description A boolean that indicates whether the buyer wants to receive marketing messages. */
441
+ marketingTermsAccepted?: boolean;
442
+ /** @description An enumeration value representing the available types of marketing messages. Valid Values: OFFER PROMOTION SURVEY Required: You must always pass in all these values, even if marketingTermsAccepted is set to false. See the Samples for an example. */
443
+ marketingTypes?: (string)[];
444
+ };
445
+ /** @description The type that defines the fields for line item information in a purchase order. */
446
+ OrderLineItem: {
447
+ /** @description The cost of a single item in this line item. */
448
+ baseUnitPrice?: components["schemas"]["Amount"];
449
+ /** @description The URL of the item's image. */
450
+ image?: components["schemas"]["Image"];
451
+ /** @description The identifier of the item. */
452
+ itemId?: string;
453
+ /** @description The container that returns fields to support using the Post Order API for returns and cancellations. For information about what is returned in these fields and how to use the Post Order API, see Using the Post Order API. Note: The Post Order API can be used only with eBay member checkouts. */
454
+ legacyReference?: components["schemas"]["LegacyReference"];
455
+ /** @description The identifier of this line item. This is created by the initiateCheckoutSession for a member and initiateGuestCheckoutSession for a guest calls. */
456
+ lineItemId?: string;
457
+ /** @description An enumeration value that indicates the payment status of this line item. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/LineItemPaymentStatusEnum.html'>eBay API documentation</a> */
458
+ lineItemPaymentStatus?: string;
459
+ /** @description An enumeration value that indicates the fulfillment state of this line item. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/LineItemStatusEnum.html'>eBay API documentation</a> */
460
+ lineItemStatus?: string;
461
+ /** @description The total cost for the items in this line item taking into account the quantity and applying any seller item discounts, such as Buy 1 Get 1, and any coupon that applies to this item. Note : This does not include any shipping discounts, shipping costs, or seller adjustments. */
462
+ netPrice?: components["schemas"]["Amount"];
463
+ /** @description For future use. The unique order ID for this line item. This value is the new eBay unique order ID, which is being rolled out starting in Summer 2019. In the future, this will replace the lineItems.legacyReference fields you use in the Post Order API. For details see, Easier order management with updated order numbers. */
464
+ orderId?: string;
465
+ /** @description An array of promotions applied to the items in this line item. */
466
+ promotions?: (components["schemas"]["Promotion"])[];
467
+ /**
468
+ * Format: int32
469
+ * @description The number of individual items in this line item.
470
+ */
471
+ quantity?: number;
472
+ /** @description The container for information about the seller offering this item, such as the seller's user name. */
473
+ seller?: components["schemas"]["Seller"];
474
+ /** @description Information about the shipping provider used for this line item. */
475
+ shippingDetail?: components["schemas"]["ShippingDetail"];
476
+ /** @description The seller created title of the item. */
477
+ title?: string;
478
+ };
479
+ /** @description The type that defines the fields for the reference information about the payment method. */
480
+ PaymentInstrument: {
481
+ /** @description The name of the credit card company (brand). */
482
+ brand?: components["schemas"]["PaymentMethodBrand"];
483
+ /** @description An enumeration value that indicates the method of payment, such as credit card. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PaymentMethodTypeEnum.html'>eBay API documentation</a> */
484
+ paymentMethodType?: string;
485
+ };
486
+ /** @description The type that defines the fields for the payment reference, such as last four digits of a credit card. */
487
+ PaymentInstrumentReference: {
488
+ /** @description The identifier of the buyer's PayPal cart, which is returned by the initiateGuestPayment method. This ID is generated by PayPal and required for the PayPal Smart Button eBay guest payment flow. */
489
+ externalReferenceId?: string;
490
+ /** @description The last four digits of the credit card number being used to pay for the items. */
491
+ lastFourDigitForCreditCard?: string;
492
+ };
493
+ /** @description The type that defines the fields for the payment method. */
494
+ PaymentMethod: {
495
+ /** @description Text indicating the payment type. For example, when paying by credit card, this label will be CC . When paying using PayPal Smart Button eBay guest payment flow the label will be WALLET. */
496
+ label?: string;
497
+ /** @description The URL of the image of the payment method logo. */
498
+ logoImage?: components["schemas"]["Image"];
499
+ /** @description An array of credit card brands that can be used as the payment method. */
500
+ paymentMethodBrands?: (components["schemas"]["PaymentMethodBrand"])[];
501
+ /** @description The type that defines the fields for legal messages and buyer consent verification. */
502
+ paymentMethodMessages?: (components["schemas"]["PaymentMethodMessage"])[];
503
+ /** @description An enumeration value that indicates the method of payment, such as credit card. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PaymentMethodTypeEnum.html'>eBay API documentation</a> */
504
+ paymentMethodType?: string;
505
+ };
506
+ /** @description The type that defines the fields for the credit card company (brand), which can be used as the payment method. */
507
+ PaymentMethodBrand: {
508
+ /** @description The URL of the image of the credit card company (brand). */
509
+ logoImage?: components["schemas"]["Image"];
510
+ /** @description An enumeration value that indicates the credit card company (brand). For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PaymentMethodBrandEnum.html'>eBay API documentation</a> */
511
+ paymentMethodBrandType?: string;
512
+ };
513
+ /** @description The type that defines the fields for legal messages and buyer consent verification. */
514
+ PaymentMethodMessage: {
515
+ /** @description Information that eBay is legally obligated to show to the buyer. This field can be null, in which case do nothing. But if this field is not null, the value of this field must appear on the checkout page. Note: This field is not used for US purchases. */
516
+ legalMessage?: string;
517
+ /** @description Reserved for future use. */
518
+ privacyPolicyWebUrl?: string;
519
+ /** @description Reserved for future use. */
520
+ requiredForUserConfirmation?: boolean;
521
+ /** @description Reserved for future use. */
522
+ userAgreementWebUrl?: string;
523
+ };
524
+ /** @description The type that defines the fields for the costs, discounts, and seller fees and adjustments of all the line items. */
525
+ PricingSummary: {
526
+ /** @description The total amount of the coupon discounts in the purchase order. */
527
+ additionalSavings?: components["schemas"]["Amount"];
528
+ /** @description The total amount of any seller adjustments. An adjustment can be a credit or debit. This is used to catch any monetary changes to the purchase order that are not already captured in one of the other fields. */
529
+ adjustment?: components["schemas"]["Adjustment"];
530
+ /** @description The shipping cost for all the line items before any shipping discounts are applied. Let's say there were 4 line items and the shipping cost for each line item is $5. One of the line items qualifies for free shipping. The deliveryCost value would be $20, which is the total cost for shipping all the line items before any discounts were appiled. */
531
+ deliveryCost?: components["schemas"]["Amount"];
532
+ /** @description The total amount of the order shipping discounts for the all line items, such as free shipping. Let's say there were 4 line items and the shipping cost for each line items is $5. One of the line items qualifies for free shipping. The deliveryDiscounts value would be 5, which is the value of the free shipping discount. Note: This will always be a negative number. */
533
+ deliveryDiscount?: components["schemas"]["Amount"];
534
+ /** @description The total amount of any fees for all the line items, such as a recycling fee. */
535
+ fee?: components["schemas"]["Amount"];
536
+ /** @description The sum of the Global Shipping Program import charges for all line items. */
537
+ importCharges?: components["schemas"]["Amount"];
538
+ /** @description The total amount of all the item discounts for all line items, such as Buy 1 Get 1 free. Let's say there were 4 line items. One of the line items qualifies for free shipping, which is $5 and two items qualify for a Buy 1 Get 1 offer, which is a $6 and a $15 discount. The priceDiscount value would be 21, which is the total of the two Buy 1 Get 1 discounts. The shipping discount is not included. It is returned in the deliveryDiscount field. Note: This will always be a negative number. */
539
+ priceDiscount?: components["schemas"]["Amount"];
540
+ /** @description The total amount for all the line items taking into account the item quantity but before adding in taxes and shipping costs, or applying discounts, fees, and adjustments. */
541
+ priceSubtotal?: components["schemas"]["Amount"];
542
+ /** @description The total amount of the taxes for all the line items. */
543
+ tax?: components["schemas"]["Amount"];
544
+ /** @description The total of the purchase order. total = priceSubtotal + baseDeliveryCost + tax + importCharges + deliveryDiscounts + priceDiscount + adjustment. Note: deliveryDiscounts and priceDiscount are negative numbers. */
545
+ total?: components["schemas"]["Amount"];
546
+ };
547
+ /** @description The type that defines the fields for the details of an item promotion. */
548
+ Promotion: {
549
+ /** @description The discount amount on the applied promotional offer. */
550
+ discount?: components["schemas"]["Amount"];
551
+ /** @description Note: This field is not return in the purchase order methods response. */
552
+ discountPercentage?: string;
553
+ /** @description The text for the promotion title, which describes the promotion. For example, Buy 1 Get 1. */
554
+ message?: string;
555
+ /** @description An identifier of the promotion that was generated by the system when the promotion was created. */
556
+ promotionCode?: string;
557
+ /** @description Indicates the kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON. */
558
+ promotionType?: string;
559
+ };
560
+ /** @description The type that defines the fields for reference information about the payment method. This is returned only if you have used the updatePaymentInfo method to change the payment method. */
561
+ ProvidedPaymentInstrument: {
562
+ /** @description The container that returns the payment reference, such as last four digits of a credit card. */
563
+ paymentInstrumentReference?: components["schemas"]["PaymentInstrumentReference"];
564
+ /** @description The container that returns the name and logo of the payment company (brand), such as Visa. */
565
+ paymentMethodBrand?: components["schemas"]["PaymentMethodBrand"];
566
+ /** @description An enumeration value that indicates the method of payment, such as CREDIT_CARD. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PaymentMethodTypeEnum.html'>eBay API documentation</a> */
567
+ paymentMethodType?: string;
568
+ };
569
+ /** @description The type that defines the fields for a purchase order, including line items, costs and charges, payment method, and the purchase order status. */
570
+ PurchaseOrder: {
571
+ /** @description The container that returns the information for the coupons that were applied in the order. */
572
+ appliedCoupons?: (components["schemas"]["Coupon"])[];
573
+ /** @description An array of line items in the purchase order. */
574
+ lineItems?: (components["schemas"]["OrderLineItem"])[];
575
+ /** @description The payment method used for the purchase order. */
576
+ paymentInstrument?: components["schemas"]["PaymentInstrument"];
577
+ /** @description The container that returns the monetary details of the order. */
578
+ pricingSummary?: components["schemas"]["PricingSummary"];
579
+ /** @description The timestamp of when the purchase order was created. */
580
+ purchaseOrderCreationDate?: string;
581
+ /** @description The unique identifier of the purchase order. This value was returned in the purchaseOrderId field by the place order guest methods. */
582
+ purchaseOrderId?: string;
583
+ /** @description An enumeration value that indicates the status of the payment for the purchase order. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PurchaseOrderPaymentStatusEnum.html'>eBay API documentation</a> */
584
+ purchaseOrderPaymentStatus?: string;
585
+ /** @description The container for the current status of the buyer's payment and any refund that applies to the purchase order. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PurchaseOrderStatusEnum.html'>eBay API documentation</a> */
586
+ purchaseOrderStatus?: string;
587
+ /** @description The total amount of any refunds for purchase order. */
588
+ refundedAmount?: components["schemas"]["Amount"];
589
+ /** @description The shipping address for the purchase order. */
590
+ shippingAddress?: components["schemas"]["ShippingAddress"];
591
+ /** @description An array of the shipping providers and the purchase order delivery details. */
592
+ shippingFulfillments?: (components["schemas"]["ShippingFulfillment"])[];
593
+ /** @description An array of warning messages. These type of errors do not prevent the call from executing but should be checked. */
594
+ warnings?: (components["schemas"]["Error"])[];
595
+ };
596
+ /** @description The type that defines the fields for the summary of a purchase order. */
597
+ PurchaseOrderSummary: {
598
+ /** @description The URI of the purchase order. */
599
+ purchaseOrderHref?: string;
600
+ /** @description A unique identifier of the purchase order. When a checkout session completes, a purchase order ID is generated but this does not indicate that the item has been purchased. Note: If there is a problem with the payment information, the purchase order ID will be returned and the PurchaseOrderPaymentStatusEnum field will return FAILED. */
601
+ purchaseOrderId?: string;
602
+ /** @description An enumeration value that indicates the payment status for the purchase order. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/PurchaseOrderPaymentStatusEnum.html'>eBay API documentation</a> */
603
+ purchaseOrderPaymentStatus?: string;
604
+ /** @description An array of warning messages. */
605
+ warnings?: (components["schemas"]["Error"])[];
606
+ };
607
+ /** @description The type that defines the fields for the basic seller information. */
608
+ Seller: {
609
+ /** @description The percentage of the total positive feedback. */
610
+ feedbackPercentage?: string;
611
+ /**
612
+ * Format: int32
613
+ * @description The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.
614
+ */
615
+ feedbackScore?: number;
616
+ /** @description Indicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in some countries. This field is returned only on the following sites. EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL Valid values: BUSINESS INDIVIDUALCode so that your app gracefully handles any future changes to this list. */
617
+ sellerAccountType?: string;
618
+ /** @description The user name created by the seller for use on eBay. */
619
+ username?: string;
620
+ };
621
+ /** @description The type that defines the fields for the details of a shipping event, such as DELIVERED. */
622
+ ShipmentTrackingEvents: {
623
+ /** @description A string describing the tracking event. For example: On FedEx vehicle for delivery */
624
+ description?: string;
625
+ /** @description The date of the shipment tracking event. UTC Format: yyyy-MM-ddThh:00:00.000Z For example: 2019-03-01T12:12:00.000Z */
626
+ eventDate?: string;
627
+ /** @description A normalized string for shipment tracking event. For example: OUT_FOR_DELIVERY */
628
+ eventType?: string;
629
+ /** @description Where the shipment tracking event occurred. For example: The city, state, postal code, and country of where the package was delivered. */
630
+ location?: components["schemas"]["EventLocation"];
631
+ };
632
+ /** @description The type that defines the fields for a shipping address. For restrictions, see Shipping restrictions. */
633
+ ShippingAddress: {
634
+ /** @description The first line of the street address where the item is being shipped. */
635
+ addressLine1?: string;
636
+ /** @description The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'. */
637
+ addressLine2?: string;
638
+ /** @description The city of the address where the item is being shipped. */
639
+ city?: string;
640
+ /** @description The two letter code representing the country of the address. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/CountryCodeEnum.html'>eBay API documentation</a> */
641
+ country?: string;
642
+ /** @description The county of the address where the item is being shipped. */
643
+ county?: string;
644
+ /** @description The phone number of the person receiving the package. */
645
+ phoneNumber?: string;
646
+ /** @description The postal code of the address where the item is being shipped. */
647
+ postalCode?: string;
648
+ /** @description Name of the person receiving the package. */
649
+ recipient?: string;
650
+ /** @description The state or province of the address where the item is being shipped. */
651
+ stateOrProvince?: string;
652
+ };
653
+ /** @description The type that defines the shipping address fields. Note: If the address cannot be validated, a warning message is be returned along with the response. */
654
+ ShippingAddressImpl: {
655
+ /** @description The first line of the street address. */
656
+ addressLine1?: string;
657
+ /** @description The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'. */
658
+ addressLine2?: string;
659
+ /** @description The city of the address. */
660
+ city?: string;
661
+ /** @description The two letter code representing the country of the address. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/order/types/CountryCodeEnum.html'>eBay API documentation</a> */
662
+ country?: string;
663
+ /** @description The county of the address. */
664
+ county?: string;
665
+ /** @description The phone number of the person receiving the package. Note: It is highly recommended that when entering the phone number you include the country code. For example, if a US phone number is 4081231234 you would enter +14081231234. If you do not include this code, the service will use the country specified in the country field. You can find the country code at https://countrycode.org. */
666
+ phoneNumber?: string;
667
+ /** @description The postal code of the address. */
668
+ postalCode?: string;
669
+ /** @description Full name of the person receiving the purchase order. */
670
+ recipient?: string;
671
+ /** @description The state or province of the address. Note: For the US marketplace, this is a 2 character value. For a list of these, see US State and Canada Province Codes. */
672
+ stateOrProvince?: string;
673
+ };
674
+ /** @description The type that defines the fields for the shipping information, such as delivery date estimates and shipping provider. */
675
+ ShippingDetail: {
676
+ /** @description The end of the date range in which the purchase order is expected to be delivered to the shipping address (final destination). */
677
+ maxEstimatedDeliveryDate?: string;
678
+ /** @description The beginning of the date range in which the purchase order is expected to be delivered to the shipping address (final destination). */
679
+ minEstimatedDeliveryDate?: string;
680
+ /** @description The shipping provider, such as FedEx, or USPS for the line item. */
681
+ shippingCarrierCode?: string;
682
+ /** @description A name of a shipping type. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). */
683
+ shippingServiceCode?: string;
684
+ };
685
+ /** @description The type that defines the fields for the shipping details. */
686
+ ShippingFulfillment: {
687
+ /** @description The date the purchase order was delivered. */
688
+ actualDeliveryDate?: string;
689
+ /** @description The container the returns the fields for the line item ID and the quantity. */
690
+ lineItemReferences?: (components["schemas"]["LineItemReference"])[];
691
+ /** @description The end of the date range in which the purchase order is expected to be delivered to the shipping address. */
692
+ maxEstimatedDeliveryDate?: string;
693
+ /** @description The beginning of the date range in which the purchase order is expected to be delivered to the shipping address. */
694
+ minEstimatedDeliveryDate?: string;
695
+ /** @description The container that returns all the shipment tracking events. */
696
+ shipmentTrackingEvents?: (components["schemas"]["ShipmentTrackingEvents"])[];
697
+ /** @description The shipping provider number associated with the purchase order that can be used to track the package. */
698
+ shipmentTrackingNumber?: string;
699
+ /** @description The URL of the shipping provider's shipment tracking page. */
700
+ shipmentTrackingUrl?: string;
701
+ /** @description The date the seller gave the purchase order to the shipping provider. */
702
+ shippedDate?: string;
703
+ /** @description A name of the shipping provider, such as FedEx, or USPS. */
704
+ shippingCarrierCode?: string;
705
+ /** @description A name of a shipping type. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). */
706
+ shippingServiceCode?: string;
707
+ };
708
+ /** @description The type that defines the fields for the shipping options. */
709
+ ShippingOption: {
710
+ /** @description The shipping cost using this shipping option for this line item before any shipping discounts. */
711
+ baseDeliveryCost?: components["schemas"]["Amount"];
712
+ /** @description The monetary value of any delivery discount. */
713
+ deliveryDiscount?: components["schemas"]["Amount"];
714
+ /** @description The Global Shipping Program import charges for this line item. */
715
+ importCharges?: components["schemas"]["Amount"];
716
+ /** @description The end of the date range in which the purchase order is expected to be delivered to the shipping address. */
717
+ maxEstimatedDeliveryDate?: string;
718
+ /** @description The beginning of the date range in which the purchase order is expected to be delivered to the shipping address. */
719
+ minEstimatedDeliveryDate?: string;
720
+ /** @description Indicates if the shipping method is selected. */
721
+ selected?: boolean;
722
+ /** @description The shipping provider, such as FedEx, or USPS for the line item. */
723
+ shippingCarrierCode?: string;
724
+ /** @description A unique ID for the selected shipping option/method. */
725
+ shippingOptionId?: string;
726
+ /** @description A name of a shipping type. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). */
727
+ shippingServiceCode?: string;
728
+ };
729
+ /** @description The type that defines the fields for payment information. */
730
+ UpdatePaymentInformation: {
731
+ /** @description Container for the buyer's credit card information. */
732
+ creditCard?: components["schemas"]["CreditCard"];
733
+ /** @description The container that returns the wallet payment token. Note: Currently, this is supported only for eBay Guest checkouts. Support for eBay Member checkouts will be available in 2019. */
734
+ wallet?: components["schemas"]["Wallet"];
735
+ };
736
+ /** @description The type that defines the fields used to update the quantity of a line item. */
737
+ UpdateQuantity: {
738
+ /** @description A unique eBay-assigned ID value that identifys a line item in a purchase order. */
739
+ lineItemId?: string;
740
+ /**
741
+ * Format: int32
742
+ * @description The number of individual items ordered in this line item, as specified by the buyer.
743
+ */
744
+ quantity?: number;
745
+ };
746
+ /** @description The type that defines the fields used to update the shipping option of a line item. */
747
+ UpdateShippingOption: {
748
+ /** @description A unique eBay-assigned ID value that identifies the line item in a checkout session. */
749
+ lineItemId?: string;
750
+ /** @description A unique ID for the selected shipping option/method. */
751
+ shippingOptionId?: string;
752
+ };
753
+ /** @description The type that defines the fields for payment tokens. Note: Currently, this is supported only for eBay Guest checkouts. Support for eBay Member checkouts will be available in 2019. */
754
+ Wallet: {
755
+ /** @description This token is a payment nonce. A payment method nonce is a secure, one-time-use reference to payment information. It's the key element that allows your server to communicate sensitive payment information to the payment processor server without ever touching the raw data. The nonce is generated by the payment processor. Note: Currently, this is supported only for eBay Guest checkouts. Support for eBay Member checkouts will be available in 2019. */
756
+ paymentToken?: string;
757
+ };
758
+ };
759
+ responses: never;
760
+ parameters: never;
761
+ requestBodies: never;
762
+ headers: never;
763
+ pathItems: never;
764
+ }
765
+ export type external = Record<string, never>;
766
+ export interface operations {
767
+ /** @description (Limited Release) You must be whitelisted to use this method. This method adds a coupon to an eBay proxy guest checkout session and applies it to all the eligible items in the order. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions Maximum: One coupon per order For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
768
+ applyCoupon: {
769
+ parameters: {
770
+ path: {
771
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
772
+ checkoutSessionId: string;
773
+ };
774
+ };
775
+ /** @description The container for the fields used to apply a coupon to a checkout session. */
776
+ requestBody?: {
777
+ content: {
778
+ "application/json": components["schemas"]["CouponRequest"];
779
+ };
780
+ };
781
+ responses: {
782
+ /** @description OK */
783
+ 200: {
784
+ content: {
785
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
786
+ };
787
+ };
788
+ /** @description Bad Request */
789
+ 400: never;
790
+ /** @description Access Forbidden */
791
+ 403: never;
792
+ /** @description Resource Not Found */
793
+ 404: never;
794
+ /** @description Conflict */
795
+ 409: never;
796
+ /** @description Internal Server Error */
797
+ 500: never;
798
+ };
799
+ };
800
+ /** @description This method returns the details of the specified eBay member checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
801
+ getCheckoutSession: {
802
+ parameters: {
803
+ path: {
804
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
805
+ checkoutSessionId: string;
806
+ };
807
+ };
808
+ responses: {
809
+ /** @description OK */
810
+ 200: {
811
+ content: {
812
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
813
+ };
814
+ };
815
+ /** @description Bad Request */
816
+ 400: never;
817
+ /** @description Access Forbidden */
818
+ 403: never;
819
+ /** @description Resource Not Found */
820
+ 404: never;
821
+ /** @description Conflict */
822
+ 409: never;
823
+ /** @description Internal Error */
824
+ 500: never;
825
+ };
826
+ };
827
+ /** @description This method creates a eBay member checkout session, which is the first step in performing a checkout. You use this method to create a checkout session before you can process a checkout. This method assumes (and checks for) payment using PayPal, which is linked to the buyer's eBay account. You can use the updatePaymentInfo method to pay by a credit card. If the address submitted cannot be validated, a warning message will be returned. The method returns a checkoutSessionId that you use as a URI parameter in subsequent checkout methods. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. Tip: To test the entire checkout flow, you might need a &quot;test&quot; credit card. You can generate a credit card number from http://www.getcreditcardnumbers.com. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
828
+ initiateCheckoutSession: {
829
+ /** @description The container for the fields used by the initiateCheckoutSession method. */
830
+ requestBody?: {
831
+ content: {
832
+ "application/json": components["schemas"]["CreateSignInCheckoutSessionRequest"];
833
+ };
834
+ };
835
+ responses: {
836
+ /** @description OK */
837
+ 200: {
838
+ content: {
839
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
840
+ };
841
+ };
842
+ /** @description Bad Request */
843
+ 400: never;
844
+ /** @description Conflict */
845
+ 409: never;
846
+ /** @description Internal Server Error */
847
+ 500: never;
848
+ };
849
+ };
850
+ /** @description This method creates the purchase order, pays for the items, and terminates the specified eBay member checkout session. The checkoutSessionId is passed in as a URI parameter and is required. Although there is not a request payload, for this method you must pass in { } in the request body. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. Note: If the credit card is declined, the checkout session is unusable. You will need to create a new checkout session for the order using the initiateCheckoutSession method. */
851
+ placeOrder: {
852
+ parameters: {
853
+ path: {
854
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. */
855
+ checkoutSessionId: string;
856
+ };
857
+ };
858
+ responses: {
859
+ /** @description OK */
860
+ 200: {
861
+ content: {
862
+ "application/json": components["schemas"]["PurchaseOrderSummary"];
863
+ };
864
+ };
865
+ /** @description Bad Request */
866
+ 400: never;
867
+ /** @description Access Forbidden */
868
+ 403: never;
869
+ /** @description Resource Not Found */
870
+ 404: never;
871
+ /** @description Conflict */
872
+ 409: never;
873
+ /** @description Internal Server Error */
874
+ 500: never;
875
+ };
876
+ };
877
+ /** @description (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay member checkout session. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is specified in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
878
+ removeCoupon: {
879
+ parameters: {
880
+ path: {
881
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
882
+ checkoutSessionId: string;
883
+ };
884
+ };
885
+ /** @description The container for the fields used to remove a coupon from a checkout session. */
886
+ requestBody?: {
887
+ content: {
888
+ "application/json": components["schemas"]["CouponRequest"];
889
+ };
890
+ };
891
+ responses: {
892
+ /** @description OK */
893
+ 200: {
894
+ content: {
895
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
896
+ };
897
+ };
898
+ /** @description Bad Request */
899
+ 400: never;
900
+ /** @description Access Forbidden */
901
+ 403: never;
902
+ /** @description Resource Not Found */
903
+ 404: never;
904
+ /** @description Conflict */
905
+ 409: never;
906
+ /** @description Internal Error */
907
+ 500: never;
908
+ };
909
+ };
910
+ /** @description This method changes the payment method information of the specified eBay member checkout session. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
911
+ updatePaymentInfo: {
912
+ parameters: {
913
+ path: {
914
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
915
+ checkoutSessionId: string;
916
+ };
917
+ };
918
+ /** @description The container for the fields used by the updatePaymentInfo method. */
919
+ requestBody?: {
920
+ content: {
921
+ "application/json": components["schemas"]["UpdatePaymentInformation"];
922
+ };
923
+ };
924
+ responses: {
925
+ /** @description OK */
926
+ 200: {
927
+ content: {
928
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
929
+ };
930
+ };
931
+ /** @description Bad Request */
932
+ 400: never;
933
+ /** @description Access Forbidden */
934
+ 403: never;
935
+ /** @description Resource Not Found */
936
+ 404: never;
937
+ /** @description Conflict */
938
+ 409: never;
939
+ /** @description Internal Server Error */
940
+ 500: never;
941
+ };
942
+ };
943
+ /** @description This method changes the quantity of the specified line item in an eBay member checkout session. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
944
+ updateQuantity: {
945
+ parameters: {
946
+ path: {
947
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
948
+ checkoutSessionId: string;
949
+ };
950
+ };
951
+ /** @description The container for the fields used by the updateQuantity method. */
952
+ requestBody?: {
953
+ content: {
954
+ "application/json": components["schemas"]["UpdateQuantity"];
955
+ };
956
+ };
957
+ responses: {
958
+ /** @description OK */
959
+ 200: {
960
+ content: {
961
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
962
+ };
963
+ };
964
+ /** @description Bad Request */
965
+ 400: never;
966
+ /** @description Access Forbidden */
967
+ 403: never;
968
+ /** @description Resource Not Found */
969
+ 404: never;
970
+ /** @description Conflict */
971
+ 409: never;
972
+ /** @description Internal Error */
973
+ 500: never;
974
+ };
975
+ };
976
+ /** @description This method changes the shipping address for in an eBay member checkout session. All the line items in an order must be shipped to the same address, but the shipping method can be specific to the line item. Note: If the address submitted cannot be validated, a warning message will be returned. This does not prevent the method from executing, but you may want to verify the address. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
977
+ updateShippingAddress: {
978
+ parameters: {
979
+ path: {
980
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
981
+ checkoutSessionId: string;
982
+ };
983
+ };
984
+ /** @description The container for the fields used by the updateShippingAddress method. */
985
+ requestBody?: {
986
+ content: {
987
+ "application/json": components["schemas"]["ShippingAddressImpl"];
988
+ };
989
+ };
990
+ responses: {
991
+ /** @description OK */
992
+ 200: {
993
+ content: {
994
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
995
+ };
996
+ };
997
+ /** @description Bad Request */
998
+ 400: never;
999
+ /** @description Access Forbidden */
1000
+ 403: never;
1001
+ /** @description Resource Not Found */
1002
+ 404: never;
1003
+ /** @description Conflict */
1004
+ 409: never;
1005
+ /** @description Internal Server Error */
1006
+ 500: never;
1007
+ };
1008
+ };
1009
+ /** @description This method changes the shipping method for the specified line item in an eBay member checkout session. The shipping option can be set for each line item. This gives the shopper the ability choose the cost of shipping for each line item. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1010
+ updateShippingOption: {
1011
+ parameters: {
1012
+ path: {
1013
+ /** @description The eBay-assigned checkout session ID, for a specific eBay marketplace, that is returned by initiateCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1014
+ checkoutSessionId: string;
1015
+ };
1016
+ };
1017
+ /** @description The container for the fields used by the updateShippingOption method. */
1018
+ requestBody?: {
1019
+ content: {
1020
+ "application/json": components["schemas"]["UpdateShippingOption"];
1021
+ };
1022
+ };
1023
+ responses: {
1024
+ /** @description OK */
1025
+ 200: {
1026
+ content: {
1027
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
1028
+ };
1029
+ };
1030
+ /** @description Bad Request */
1031
+ 400: never;
1032
+ /** @description Access Forbidden */
1033
+ 403: never;
1034
+ /** @description Resource Not Found */
1035
+ 404: never;
1036
+ /** @description Conflict */
1037
+ 409: never;
1038
+ /** @description Internal Error */
1039
+ 500: never;
1040
+ };
1041
+ };
1042
+ /** @description (Limited Release) You must be whitelisted to use this method. This method adds a coupon to an eBay guest checkout session and applies it to all the eligible items in the order. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions The PayPal Smart Button eBay guest payment flow does not support using coupons. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1043
+ applyGuestCoupon: {
1044
+ parameters: {
1045
+ path: {
1046
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1047
+ checkoutSessionId: string;
1048
+ };
1049
+ };
1050
+ /** @description The container for the fields used to apply a coupon to a checkout session. */
1051
+ requestBody?: {
1052
+ content: {
1053
+ "application/json": components["schemas"]["CouponRequest"];
1054
+ };
1055
+ };
1056
+ responses: {
1057
+ /** @description OK */
1058
+ 200: {
1059
+ content: {
1060
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
1061
+ };
1062
+ };
1063
+ /** @description Bad Request */
1064
+ 400: never;
1065
+ /** @description Access Forbidden */
1066
+ 403: never;
1067
+ /** @description Resource Not Found */
1068
+ 404: never;
1069
+ /** @description Conflict */
1070
+ 409: never;
1071
+ /** @description Internal Server Error */
1072
+ 500: never;
1073
+ };
1074
+ };
1075
+ /** @description This method returns the details of the specified guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1076
+ getGuestCheckoutSession: {
1077
+ parameters: {
1078
+ path: {
1079
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1080
+ checkoutSessionId: string;
1081
+ };
1082
+ };
1083
+ responses: {
1084
+ /** @description OK */
1085
+ 200: {
1086
+ content: {
1087
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1088
+ };
1089
+ };
1090
+ /** @description Bad Request */
1091
+ 400: never;
1092
+ /** @description Access Forbidden */
1093
+ 403: never;
1094
+ /** @description Resource Not Found */
1095
+ 404: never;
1096
+ /** @description Conflict */
1097
+ 409: never;
1098
+ /** @description Internal Error */
1099
+ 500: never;
1100
+ };
1101
+ };
1102
+ /** @description This method creates an eBay guest checkout session, which is the first step in performing a checkout. The method returns a checkoutSessionId that you use as a URI parameter in subsequent checkout methods. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. TIP: To test the entire checkout flow, you might need a &quot;test&quot; credit card. You can generate a credit card number from http://www.getcreditcardnumbers.com. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1103
+ initiateGuestCheckoutSession: {
1104
+ /** @description The container for the fields used by the initiateGuestCheckoutSession method. */
1105
+ requestBody?: {
1106
+ content: {
1107
+ "application/json": components["schemas"]["CreateGuestCheckoutSessionRequest"];
1108
+ };
1109
+ };
1110
+ responses: {
1111
+ /** @description OK */
1112
+ 200: {
1113
+ content: {
1114
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1115
+ };
1116
+ };
1117
+ /** @description Bad Request */
1118
+ 400: never;
1119
+ /** @description Conflict */
1120
+ 409: never;
1121
+ /** @description Internal Error */
1122
+ 500: never;
1123
+ };
1124
+ };
1125
+ /** @description This method is used only in the PayPal Smart Button eBay guest payment flow. It sets the payment to the PayPal Checkout, which enables eBay guests to pay for their items with or without having a PayPal account without leaving your App or site. You can use this payment flow whether you are PCI compliant or not. To pay for items, buyers can either: Sign into their PayPal account and use any payment method associated with that account. Without a PayPal account, they can pay using a credit card or a direct debit from their bank account. For details about this flow, see PayPal Smart Button eBay guest payment flow. Requirement: To use this method you must integrate with PayPal's checkout.js on the client side. API URLs To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions If you want to apply or remove a coupon, you must do that before using this method. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1126
+ initiateGuestPayment: {
1127
+ parameters: {
1128
+ path: {
1129
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1130
+ checkoutSessionId: string;
1131
+ };
1132
+ };
1133
+ /** @description The container for the fields used by the initiateGuestPayment method. */
1134
+ requestBody?: {
1135
+ content: {
1136
+ "application/json": components["schemas"]["InitiatePaymentRequest"];
1137
+ };
1138
+ };
1139
+ responses: {
1140
+ /** @description OK */
1141
+ 200: {
1142
+ content: {
1143
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1144
+ };
1145
+ };
1146
+ /** @description Bad Request */
1147
+ 400: never;
1148
+ /** @description Access Forbidden */
1149
+ 403: never;
1150
+ /** @description Resource Not Found */
1151
+ 404: never;
1152
+ /** @description Conflict */
1153
+ 409: never;
1154
+ /** @description Internal Server Error */
1155
+ 500: never;
1156
+ };
1157
+ };
1158
+ /** @description This method creates the purchase order, pays for the items, and terminates the specified guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. Request headers This method requires specific request headers. For details see, HTTP request headers section. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. Note: If the credit card is declined, the checkout session is unusable. You will need to create a new checkout session for the order using the initiateGuestCheckoutSession method. */
1159
+ placeGuestOrder: {
1160
+ parameters: {
1161
+ path: {
1162
+ /** @description The eBay-assigned session ID, for a specific, eBay marketplace that is returned by the initiateGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1163
+ checkoutSessionId: string;
1164
+ };
1165
+ };
1166
+ /** @description The container for the fields used by the placeGuestOrder method. */
1167
+ requestBody?: {
1168
+ content: {
1169
+ "application/json": components["schemas"]["GuestPlaceOrderRequest"];
1170
+ };
1171
+ };
1172
+ responses: {
1173
+ /** @description OK */
1174
+ 200: {
1175
+ content: {
1176
+ "application/json": components["schemas"]["PurchaseOrderSummary"];
1177
+ };
1178
+ };
1179
+ /** @description Bad Request */
1180
+ 400: never;
1181
+ /** @description Access Forbidden */
1182
+ 403: never;
1183
+ /** @description Resource Not Found */
1184
+ 404: never;
1185
+ /** @description Conflict */
1186
+ 409: never;
1187
+ /** @description Internal Error */
1188
+ 500: never;
1189
+ };
1190
+ };
1191
+ /** @description (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is specified in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions The PayPal Smart Button eBay guest payment flow does not support using coupons. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1192
+ removeGuestCoupon: {
1193
+ parameters: {
1194
+ path: {
1195
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1196
+ checkoutSessionId: string;
1197
+ };
1198
+ };
1199
+ /** @description The container for the fields used to remove a coupon from a checkout session. */
1200
+ requestBody?: {
1201
+ content: {
1202
+ "application/json": components["schemas"]["CouponRequest"];
1203
+ };
1204
+ };
1205
+ responses: {
1206
+ /** @description OK */
1207
+ 200: {
1208
+ content: {
1209
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
1210
+ };
1211
+ };
1212
+ /** @description Bad Request */
1213
+ 400: never;
1214
+ /** @description Access Forbidden */
1215
+ 403: never;
1216
+ /** @description Resource Not Found */
1217
+ 404: never;
1218
+ /** @description Conflict */
1219
+ 409: never;
1220
+ /** @description Internal Error */
1221
+ 500: never;
1222
+ };
1223
+ };
1224
+ /** @description This method changes the payment method information of the specified guest checkout session. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1225
+ updateGuestPaymentInfo: {
1226
+ parameters: {
1227
+ path: {
1228
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1229
+ checkoutSessionId: string;
1230
+ };
1231
+ };
1232
+ /** @description The container for the fields used by the updateGuestPaymentInfo method. */
1233
+ requestBody?: {
1234
+ content: {
1235
+ "application/json": components["schemas"]["UpdatePaymentInformation"];
1236
+ };
1237
+ };
1238
+ responses: {
1239
+ /** @description OK */
1240
+ 200: {
1241
+ content: {
1242
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1243
+ };
1244
+ };
1245
+ /** @description Bad Request */
1246
+ 400: never;
1247
+ /** @description Access Forbidden */
1248
+ 403: never;
1249
+ /** @description Resource Not Found */
1250
+ 404: never;
1251
+ /** @description Conflict */
1252
+ 409: never;
1253
+ /** @description Internal Error */
1254
+ 500: never;
1255
+ };
1256
+ };
1257
+ /** @description This method changes the quantity of the specified line item in an eBay guest checkout session. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1258
+ updateGuestQuantity: {
1259
+ parameters: {
1260
+ path: {
1261
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1262
+ checkoutSessionId: string;
1263
+ };
1264
+ };
1265
+ /** @description The container for the fields used by the updateGuestQuantity method. */
1266
+ requestBody?: {
1267
+ content: {
1268
+ "application/json": components["schemas"]["UpdateQuantity"];
1269
+ };
1270
+ };
1271
+ responses: {
1272
+ /** @description OK */
1273
+ 200: {
1274
+ content: {
1275
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1276
+ };
1277
+ };
1278
+ /** @description Bad Request */
1279
+ 400: never;
1280
+ /** @description Access Forbidden */
1281
+ 403: never;
1282
+ /** @description Resource Not Found */
1283
+ 404: never;
1284
+ /** @description Conflict */
1285
+ 409: never;
1286
+ /** @description Internal Server Error */
1287
+ 500: never;
1288
+ };
1289
+ };
1290
+ /** @description This method changes the shipping address for the order in an eBay guest checkout session. All the line items in an order must be shipped to the same address, but the shipping method can be specific to the line item. Note: If the address submitted cannot be validated, a warning message will be returned. This does not prevent the method from executing, but you may want to verify the address. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1291
+ updateGuestShippingAddress: {
1292
+ parameters: {
1293
+ path: {
1294
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1295
+ checkoutSessionId: string;
1296
+ };
1297
+ };
1298
+ /** @description The container for the fields used by the updateGuestShippingAddress method. */
1299
+ requestBody?: {
1300
+ content: {
1301
+ "application/json": components["schemas"]["ShippingAddressImpl"];
1302
+ };
1303
+ };
1304
+ responses: {
1305
+ /** @description OK */
1306
+ 200: {
1307
+ content: {
1308
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1309
+ };
1310
+ };
1311
+ /** @description Bad Request */
1312
+ 400: never;
1313
+ /** @description Access Forbidden */
1314
+ 403: never;
1315
+ /** @description Resource Not Found */
1316
+ 404: never;
1317
+ /** @description Conflict */
1318
+ 409: never;
1319
+ /** @description Internal Error */
1320
+ 500: never;
1321
+ };
1322
+ };
1323
+ /** @description This method changes the shipping method for the specified line item in an eBay guest checkout session. The shipping option can be set for each line item. This gives the shopper the ability choose the cost of shipping for each line item. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1324
+ updateGuestShippingOption: {
1325
+ parameters: {
1326
+ path: {
1327
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1328
+ checkoutSessionId: string;
1329
+ };
1330
+ };
1331
+ /** @description The container for the fields used by the updateGuestShippingOption method. */
1332
+ requestBody?: {
1333
+ content: {
1334
+ "application/json": components["schemas"]["UpdateShippingOption"];
1335
+ };
1336
+ };
1337
+ responses: {
1338
+ /** @description OK */
1339
+ 200: {
1340
+ content: {
1341
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1342
+ };
1343
+ };
1344
+ /** @description Bad Request */
1345
+ 400: never;
1346
+ /** @description Access Forbidden */
1347
+ 403: never;
1348
+ /** @description Resource Not Found */
1349
+ 404: never;
1350
+ /** @description Conflict */
1351
+ 409: never;
1352
+ /** @description Internal Error */
1353
+ 500: never;
1354
+ };
1355
+ };
1356
+ /** @description (Limited Release) You must be whitelisted to use this method. This method adds a coupon to an eBay proxy guest checkout session and applies it to all the eligible items in the order. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions Maximum: One coupon per order For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1357
+ applyProxyGuestCoupon: {
1358
+ parameters: {
1359
+ path: {
1360
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateProxyGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1361
+ checkoutSessionId: string;
1362
+ };
1363
+ };
1364
+ /** @description The container for the fields used to apply a coupon to a checkout session. */
1365
+ requestBody?: {
1366
+ content: {
1367
+ "application/json": components["schemas"]["CouponRequest"];
1368
+ };
1369
+ };
1370
+ responses: {
1371
+ /** @description OK */
1372
+ 200: {
1373
+ content: {
1374
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
1375
+ };
1376
+ };
1377
+ /** @description Bad Request */
1378
+ 400: never;
1379
+ /** @description Access Forbidden */
1380
+ 403: never;
1381
+ /** @description Resource Not Found */
1382
+ 404: never;
1383
+ /** @description Conflict */
1384
+ 409: never;
1385
+ /** @description Internal Error */
1386
+ 500: never;
1387
+ };
1388
+ };
1389
+ /** @description This method returns the details of the specified eBay proxy guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1390
+ getProxyGuestCheckoutSession: {
1391
+ parameters: {
1392
+ path: {
1393
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateProxyGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1394
+ checkoutSessionId: string;
1395
+ };
1396
+ };
1397
+ responses: {
1398
+ /** @description OK */
1399
+ 200: {
1400
+ content: {
1401
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1402
+ };
1403
+ };
1404
+ /** @description Bad Request */
1405
+ 400: never;
1406
+ /** @description Access Forbidden */
1407
+ 403: never;
1408
+ /** @description Resource Not Found */
1409
+ 404: never;
1410
+ /** @description Conflict */
1411
+ 409: never;
1412
+ /** @description Internal Error */
1413
+ 500: never;
1414
+ };
1415
+ };
1416
+ /** @description This method creates an eBay proxy guest checkout session, which is a payment flow that requires integration with a VSP (vault service provider), such as Braintree. The VSP handles only the methods within this flow that contain payment information. This method returns the details of the order and a marketplace specific checkoutSessionId that you use as a URI parameter in subsequent proxy_guest_checkout_session resource checkout methods. For details about the VSP payment flow, see Vault service eBay guest payment flow. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. TIP: To test the entire checkout flow, you might need a &quot;test&quot; credit card. You can generate a credit card number from http://www.getcreditcardnumbers.com. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1417
+ initiateProxyGuestCheckoutSession: {
1418
+ /** @description The container for the fields used by the initiateProxyGuestCheckoutSession method. */
1419
+ requestBody?: {
1420
+ content: {
1421
+ "application/json": components["schemas"]["CheckoutSessionRequestWithoutPayment"];
1422
+ };
1423
+ };
1424
+ responses: {
1425
+ /** @description OK */
1426
+ 200: {
1427
+ content: {
1428
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1429
+ };
1430
+ };
1431
+ /** @description Bad Request */
1432
+ 400: never;
1433
+ /** @description Access Forbidden */
1434
+ 403: never;
1435
+ /** @description Conflict */
1436
+ 409: never;
1437
+ /** @description Internal Error */
1438
+ 500: never;
1439
+ };
1440
+ };
1441
+ /** @description This method creates the proxy guest purchase order, pays for the items, and terminates the specified guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1442
+ placeProxyGuestOrder: {
1443
+ parameters: {
1444
+ path: {
1445
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateProxyGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1446
+ checkoutSessionId: string;
1447
+ };
1448
+ };
1449
+ /** @description The container for the fields used by the placeProxyGuestOrder method. */
1450
+ requestBody?: {
1451
+ content: {
1452
+ "application/json": components["schemas"]["GuestPlaceOrderRequest"];
1453
+ };
1454
+ };
1455
+ responses: {
1456
+ /** @description OK */
1457
+ 200: {
1458
+ content: {
1459
+ "application/json": components["schemas"]["PurchaseOrderSummary"];
1460
+ };
1461
+ };
1462
+ /** @description Bad Request */
1463
+ 400: never;
1464
+ /** @description Access Forbidden */
1465
+ 403: never;
1466
+ /** @description Resource Not Found */
1467
+ 404: never;
1468
+ /** @description Conflict */
1469
+ 409: never;
1470
+ /** @description Internal Server Error */
1471
+ 500: never;
1472
+ };
1473
+ };
1474
+ /** @description (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay proxy guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is specified in the payload and is also required. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1475
+ removeProxyGuestCoupon: {
1476
+ parameters: {
1477
+ path: {
1478
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateProxyGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1479
+ checkoutSessionId: string;
1480
+ };
1481
+ };
1482
+ /** @description The container for the fields used to remove a coupon from a checkout session. */
1483
+ requestBody?: {
1484
+ content: {
1485
+ "application/json": components["schemas"]["CouponRequest"];
1486
+ };
1487
+ };
1488
+ responses: {
1489
+ /** @description OK */
1490
+ 200: {
1491
+ content: {
1492
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
1493
+ };
1494
+ };
1495
+ /** @description Bad Request */
1496
+ 400: never;
1497
+ /** @description Access Forbidden */
1498
+ 403: never;
1499
+ /** @description Resource Not Found */
1500
+ 404: never;
1501
+ /** @description Conflict */
1502
+ 409: never;
1503
+ /** @description Internal Server Error */
1504
+ 500: never;
1505
+ };
1506
+ };
1507
+ /** @description This method adds or changes the payment information of the specified proxy guest checkout session. This endpoint is invoked by the VSP (vault service provider) on behalf of the eBay partner. For details about the VSP payment flow, see Vault service eBay guest payment flow. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1508
+ updateProxyGuestPaymentInfo: {
1509
+ parameters: {
1510
+ header: {
1511
+ /** @description The oAuth token. Note: The eBay partner must include this header in the request. */
1512
+ Authorization: string;
1513
+ /** @description The UTC timestamp of the request, which is generated and added to the request by the VSP. */
1514
+ "X-EBAY-C-DATE": string;
1515
+ /** @description The eBay marketplace ID. For a list of supported sites, see API Restrictions in the Order API overview. Note: The eBay partner must include this header in the request. */
1516
+ "X-EBAY-C-MARKETPLACE-ID": string;
1517
+ /** @description A UUID (a 128-bit universal unique ID), which is generated and added to the request by the VSP. */
1518
+ "X-EBAY-C-REQUEST-NONCE": string;
1519
+ /** @description The HMAC signature, which is generated and added to the request by the VSP. */
1520
+ "X-EBAY-C-SIGNATURE": string;
1521
+ };
1522
+ path: {
1523
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateProxyGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1524
+ checkoutSessionId: string;
1525
+ };
1526
+ };
1527
+ /** @description The container for the fields used by the updateProxyGuestPaymentInfo method. */
1528
+ requestBody?: {
1529
+ content: {
1530
+ "application/json": components["schemas"]["UpdatePaymentInformation"];
1531
+ };
1532
+ };
1533
+ responses: {
1534
+ /** @description OK */
1535
+ 200: {
1536
+ content: {
1537
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1538
+ };
1539
+ };
1540
+ /** @description Bad Request */
1541
+ 400: never;
1542
+ /** @description Access Forbidden */
1543
+ 403: never;
1544
+ /** @description Resource Not Found */
1545
+ 404: never;
1546
+ /** @description Conflict */
1547
+ 409: never;
1548
+ /** @description Internal Server Error */
1549
+ 500: never;
1550
+ };
1551
+ };
1552
+ /** @description This method changes the quantity of the specified line item in an eBay proxy guest checkout session. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1553
+ updateProxyGuestQuantity: {
1554
+ parameters: {
1555
+ path: {
1556
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateProxyGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1557
+ checkoutSessionId: string;
1558
+ };
1559
+ };
1560
+ /** @description The container for the fields used by the updateProxyGuestQuantity method. */
1561
+ requestBody?: {
1562
+ content: {
1563
+ "application/json": components["schemas"]["UpdateQuantity"];
1564
+ };
1565
+ };
1566
+ responses: {
1567
+ /** @description OK */
1568
+ 200: {
1569
+ content: {
1570
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1571
+ };
1572
+ };
1573
+ /** @description Bad Request */
1574
+ 400: never;
1575
+ /** @description Access Forbidden */
1576
+ 403: never;
1577
+ /** @description Resource Not Found */
1578
+ 404: never;
1579
+ /** @description Conflict */
1580
+ 409: never;
1581
+ /** @description Internal Server Error */
1582
+ 500: never;
1583
+ };
1584
+ };
1585
+ /** @description This method changes the shipping address for the order in an eBay proxy guest checkout session. All the line items in an order must be shipped to the same address, but the shipping method can be specific to the line item. Note: If the address submitted cannot be validated, a warning message will be returned. This does not prevent the method from executing, but you may want to verify the address. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1586
+ updateProxyGuestShippingAddress: {
1587
+ parameters: {
1588
+ path: {
1589
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateProxyGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1590
+ checkoutSessionId: string;
1591
+ };
1592
+ };
1593
+ /** @description The container for the fields used by the updateProxyGuestShippingAddress method. */
1594
+ requestBody?: {
1595
+ content: {
1596
+ "application/json": components["schemas"]["ShippingAddressImpl"];
1597
+ };
1598
+ };
1599
+ responses: {
1600
+ /** @description OK */
1601
+ 200: {
1602
+ content: {
1603
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1604
+ };
1605
+ };
1606
+ /** @description Bad Request */
1607
+ 400: never;
1608
+ /** @description Access Forbidden */
1609
+ 403: never;
1610
+ /** @description Resource Not Found */
1611
+ 404: never;
1612
+ /** @description Conflict */
1613
+ 409: never;
1614
+ /** @description Internal Error */
1615
+ 500: never;
1616
+ };
1617
+ };
1618
+ /** @description This method changes the shipping method for the specified line item in an eBay proxy guest checkout session. The shipping option can be set for each line item. This gives the shopper the ability choose the cost of shipping for each line item. To meet security requirements for payments, the URLs for this method are: Production URL: https://apix.ebay.com/buy/order/v1 Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v1 Note: This method is not available in the eBay API Explorer. Restrictions This method is used only when the eBay partner is using a payment vault service, such as Braintree, to process payments. The Vault service eBay guest payment flow is supported only for the EBAY_US marketplace. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1619
+ updateProxyGuestShippingOption: {
1620
+ parameters: {
1621
+ path: {
1622
+ /** @description The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateProxyGuestCheckoutSession method. Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as what was used when this checkout session was created. See Checkout session restrictions in the Buy Integration Guide. */
1623
+ checkoutSessionId: string;
1624
+ };
1625
+ };
1626
+ /** @description The container for the fields used by the updateProxyGuestShippingOption method. */
1627
+ requestBody?: {
1628
+ content: {
1629
+ "application/json": components["schemas"]["UpdateShippingOption"];
1630
+ };
1631
+ };
1632
+ responses: {
1633
+ /** @description OK */
1634
+ 200: {
1635
+ content: {
1636
+ "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1637
+ };
1638
+ };
1639
+ /** @description Bad Request */
1640
+ 400: never;
1641
+ /** @description Access Forbidden */
1642
+ 403: never;
1643
+ /** @description Resource Not Found */
1644
+ 404: never;
1645
+ /** @description Conflict */
1646
+ 409: never;
1647
+ /** @description Internal Server Error */
1648
+ 500: never;
1649
+ };
1650
+ };
1651
+ /** @description This method retrieves the details about a specific guest purchase order. It returns the line items, including purchase order status; dates created and modified; item quantity and listing data; payment and shipping information; and prices, taxes, and discounts and credits. The purchaseOrderId is passed in as a URI parameter and is required. This method has no request payload. The placeGuestOrder or method initiates the payment process, which can sometimes take a few minutes. You can use this method to not only get the details of a purchase order but to check the value of the purchaseOrderPaymentStatus field to determine if the order has been paid for. If the order has been paid for, this field will return PAID. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1652
+ getGuestPurchaseOrder: {
1653
+ parameters: {
1654
+ path: {
1655
+ /** @description The unique identifier of a purchase order made by a guest buyer, for which details are to be retrieved. This value is returned by the placeGuestOrder method in the purchaseOrderId field. The purchaseOrderId is passed in as a URI parameter and is required. */
1656
+ purchaseOrderId: string;
1657
+ };
1658
+ };
1659
+ responses: {
1660
+ /** @description OK */
1661
+ 200: {
1662
+ content: {
1663
+ "application/json": components["schemas"]["GuestPurchaseOrder"];
1664
+ };
1665
+ };
1666
+ /** @description Bad Request */
1667
+ 400: never;
1668
+ /** @description Access Forbidden */
1669
+ 403: never;
1670
+ /** @description Not Found */
1671
+ 404: never;
1672
+ /** @description Internal Server Error */
1673
+ 500: never;
1674
+ };
1675
+ };
1676
+ /** @description This method retrieves the details about a specific eBay member purchase order. It returns the line items, including purchase order status; dates created and modified; item quantity and listing data; payment and shipping information; and prices, taxes, and discounts and credits. The purchaseOrderId is passed in as a URI parameter and is required. This method has no request payload. The placeOrder method initiates the payment process, which can sometimes take a few minutes. You can use this method to not only get the details of a purchase order but to check the value of the purchaseOrderPaymentStatus field to determine if the order has been paid for. If the order has been paid for, this field will return PAID. This method also returns the legacyItemId, legacyTransactionId, and legacyOrderId fields. The values in these fields enable eBay partners to use the Post Order API for eBay member checkouts, to process a return or cancellation. For more information, see Post order tasks in the Buy Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. */
1677
+ getPurchaseOrder: {
1678
+ parameters: {
1679
+ path: {
1680
+ /** @description The unique identifier of a purchase order made by an eBay member, for which details are to be retrieved. This value is returned by the placeOrder method in the purchaseOrderId field. The purchaseOrderId is passed in as a URI parameter and is required. */
1681
+ purchaseOrderId: string;
1682
+ };
1683
+ };
1684
+ responses: {
1685
+ /** @description OK */
1686
+ 200: {
1687
+ content: {
1688
+ "application/json": components["schemas"]["PurchaseOrder"];
1689
+ };
1690
+ };
1691
+ /** @description Bad Request */
1692
+ 400: never;
1693
+ /** @description Access Forbidden */
1694
+ 403: never;
1695
+ /** @description Not Found */
1696
+ 404: never;
1697
+ /** @description Internal Server Error */
1698
+ 500: never;
1699
+ };
1700
+ };
1701
+ }