ebay-api 8.5.0 → 8.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (320) hide show
  1. package/README.md +4 -4
  2. package/dist/api/apiFactory.d.ts +0 -3
  3. package/dist/api/apiFactory.js +0 -4
  4. package/dist/api/base.d.ts +0 -3
  5. package/dist/api/base.js +0 -3
  6. package/dist/api/digitalSignature.d.ts +0 -33
  7. package/dist/api/digitalSignature.js +1 -41
  8. package/dist/api/index.d.ts +0 -3
  9. package/dist/api/index.js +0 -3
  10. package/dist/api/restful/buy/browse/index.d.ts +0 -66
  11. package/dist/api/restful/buy/browse/index.js +0 -73
  12. package/dist/api/restful/buy/deal/index.d.ts +0 -32
  13. package/dist/api/restful/buy/deal/index.js +0 -32
  14. package/dist/api/restful/buy/feed/index.d.ts +0 -33
  15. package/dist/api/restful/buy/feed/index.js +0 -33
  16. package/dist/api/restful/buy/marketing/index.d.ts +0 -18
  17. package/dist/api/restful/buy/marketing/index.js +0 -22
  18. package/dist/api/restful/buy/marketplaceInsights/index.d.ts +0 -21
  19. package/dist/api/restful/buy/marketplaceInsights/index.js +0 -21
  20. package/dist/api/restful/buy/offer/index.d.ts +0 -15
  21. package/dist/api/restful/buy/offer/index.js +0 -15
  22. package/dist/api/restful/buy/order/index.d.ts +0 -227
  23. package/dist/api/restful/buy/order/index.js +0 -227
  24. package/dist/api/restful/commerce/catalog/index.d.ts +0 -54
  25. package/dist/api/restful/commerce/catalog/index.js +0 -54
  26. package/dist/api/restful/commerce/charity/index.d.ts +0 -21
  27. package/dist/api/restful/commerce/charity/index.js +0 -21
  28. package/dist/api/restful/commerce/identity/index.d.ts +0 -7
  29. package/dist/api/restful/commerce/identity/index.js +0 -7
  30. package/dist/api/restful/commerce/notification/index.d.ts +0 -93
  31. package/dist/api/restful/commerce/notification/index.js +0 -93
  32. package/dist/api/restful/commerce/taxonomy/index.d.ts +0 -64
  33. package/dist/api/restful/commerce/taxonomy/index.js +0 -64
  34. package/dist/api/restful/commerce/translation/index.d.ts +0 -8
  35. package/dist/api/restful/commerce/translation/index.js +0 -8
  36. package/dist/api/restful/developer/analytics/index.d.ts +0 -15
  37. package/dist/api/restful/developer/analytics/index.js +0 -15
  38. package/dist/api/restful/developer/keyManagement/index.d.ts +0 -15
  39. package/dist/api/restful/developer/keyManagement/index.js +0 -15
  40. package/dist/api/restful/index.d.ts +0 -16
  41. package/dist/api/restful/index.js +1 -23
  42. package/dist/api/restful/postOrder/cancellation/index.d.ts +0 -43
  43. package/dist/api/restful/postOrder/cancellation/index.js +0 -43
  44. package/dist/api/restful/postOrder/case/index.d.ts +0 -46
  45. package/dist/api/restful/postOrder/case/index.js +0 -46
  46. package/dist/api/restful/postOrder/inquiry/index.d.ts +0 -64
  47. package/dist/api/restful/postOrder/inquiry/index.js +0 -64
  48. package/dist/api/restful/postOrder/return/index.d.ts +0 -190
  49. package/dist/api/restful/postOrder/return/index.js +0 -190
  50. package/dist/api/restful/sell/account/index.d.ts +0 -241
  51. package/dist/api/restful/sell/account/index.js +0 -241
  52. package/dist/api/restful/sell/analytics/index.d.ts +0 -26
  53. package/dist/api/restful/sell/analytics/index.js +0 -26
  54. package/dist/api/restful/sell/compliance/index.d.ts +0 -23
  55. package/dist/api/restful/sell/compliance/index.js +0 -23
  56. package/dist/api/restful/sell/feed/index.d.ts +0 -135
  57. package/dist/api/restful/sell/feed/index.js +0 -135
  58. package/dist/api/restful/sell/finances/index.d.ts +0 -51
  59. package/dist/api/restful/sell/finances/index.js +0 -51
  60. package/dist/api/restful/sell/fulfillment/index.d.ts +0 -108
  61. package/dist/api/restful/sell/fulfillment/index.js +0 -108
  62. package/dist/api/restful/sell/inventory/index.d.ts +0 -197
  63. package/dist/api/restful/sell/inventory/index.js +0 -197
  64. package/dist/api/restful/sell/listing/index.d.ts +0 -8
  65. package/dist/api/restful/sell/listing/index.js +0 -8
  66. package/dist/api/restful/sell/logistics/index.d.ts +0 -33
  67. package/dist/api/restful/sell/logistics/index.js +0 -33
  68. package/dist/api/restful/sell/marketing/index.d.ts +16 -495
  69. package/dist/api/restful/sell/marketing/index.js +48 -494
  70. package/dist/api/restful/sell/metadata/index.d.ts +0 -65
  71. package/dist/api/restful/sell/metadata/index.js +0 -65
  72. package/dist/api/restful/sell/negotiation/index.d.ts +0 -14
  73. package/dist/api/restful/sell/negotiation/index.js +0 -14
  74. package/dist/api/restful/sell/recommendation/index.d.ts +0 -15
  75. package/dist/api/restful/sell/recommendation/index.js +0 -15
  76. package/dist/api/traditional/XMLRequest.d.ts +0 -44
  77. package/dist/api/traditional/XMLRequest.js +0 -46
  78. package/dist/api/traditional/clientAlerts/index.js +0 -1
  79. package/dist/api/traditional/index.d.ts +0 -3
  80. package/dist/api/traditional/index.js +0 -5
  81. package/dist/api/traditional/shopping/index.js +0 -1
  82. package/dist/auth/authNAuth.d.ts +0 -5
  83. package/dist/auth/authNAuth.js +0 -5
  84. package/dist/auth/index.d.ts +0 -3
  85. package/dist/auth/index.js +0 -3
  86. package/dist/auth/oAuth2.d.ts +0 -52
  87. package/dist/auth/oAuth2.js +0 -53
  88. package/dist/eBayApi.d.ts +1 -12
  89. package/dist/eBayApi.js +0 -14
  90. package/dist/ebay-api.min.mjs +1 -1
  91. package/dist/enums/restfulEnums.d.ts +24 -23
  92. package/dist/enums/restfulEnums.js +52 -51
  93. package/dist/errors/index.d.ts +0 -19
  94. package/dist/errors/index.js +1 -20
  95. package/dist/types/apiTypes.d.ts +2 -2
  96. package/dist/types/restful/specs/buy_browse_v1_oas3.d.ts +0 -697
  97. package/dist/types/restful/specs/buy_browse_v1_oas3.js +0 -4
  98. package/dist/types/restful/specs/buy_deal_v1_oas3.d.ts +0 -189
  99. package/dist/types/restful/specs/buy_deal_v1_oas3.js +0 -4
  100. package/dist/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +0 -229
  101. package/dist/types/restful/specs/buy_feed_v1_beta_oas3.js +0 -4
  102. package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +0 -101
  103. package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.js +0 -4
  104. package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +0 -150
  105. package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +0 -4
  106. package/dist/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +0 -62
  107. package/dist/types/restful/specs/buy_offer_v1_beta_oas3.js +0 -4
  108. package/dist/types/restful/specs/buy_order_v1_beta_oas3.d.ts +0 -600
  109. package/dist/types/restful/specs/buy_order_v1_beta_oas3.js +0 -4
  110. package/dist/types/restful/specs/cancellation_oas3.d.ts +0 -29
  111. package/dist/types/restful/specs/cancellation_oas3.js +0 -4
  112. package/dist/types/restful/specs/case_oas3.d.ts +0 -31
  113. package/dist/types/restful/specs/case_oas3.js +0 -4
  114. package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +0 -331
  115. package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.js +0 -4
  116. package/dist/types/restful/specs/commerce_charity_v1_oas3.d.ts +0 -85
  117. package/dist/types/restful/specs/commerce_charity_v1_oas3.js +0 -4
  118. package/dist/types/restful/specs/commerce_identity_v1_oas3.d.ts +0 -63
  119. package/dist/types/restful/specs/commerce_identity_v1_oas3.js +0 -4
  120. package/dist/types/restful/specs/commerce_notification_v1_oas3.d.ts +0 -236
  121. package/dist/types/restful/specs/commerce_notification_v1_oas3.js +0 -4
  122. package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +0 -219
  123. package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.js +0 -4
  124. package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +0 -36
  125. package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.js +0 -4
  126. package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +0 -57
  127. package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.js +0 -4
  128. package/dist/types/restful/specs/developer_key_management_v1_oas3.d.ts +0 -60
  129. package/dist/types/restful/specs/developer_key_management_v1_oas3.js +0 -4
  130. package/dist/types/restful/specs/inquiry_oas3.d.ts +0 -45
  131. package/dist/types/restful/specs/inquiry_oas3.js +0 -4
  132. package/dist/types/restful/specs/return_oas3.d.ts +0 -130
  133. package/dist/types/restful/specs/return_oas3.js +0 -4
  134. package/dist/types/restful/specs/sell_account_v1_oas3.d.ts +0 -751
  135. package/dist/types/restful/specs/sell_account_v1_oas3.js +0 -4
  136. package/dist/types/restful/specs/sell_analytics_v1_oas3.d.ts +0 -130
  137. package/dist/types/restful/specs/sell_analytics_v1_oas3.js +0 -4
  138. package/dist/types/restful/specs/sell_compliance_v1_oas3.d.ts +0 -102
  139. package/dist/types/restful/specs/sell_compliance_v1_oas3.js +0 -4
  140. package/dist/types/restful/specs/sell_feed_v1_oas3.d.ts +0 -461
  141. package/dist/types/restful/specs/sell_feed_v1_oas3.js +0 -4
  142. package/dist/types/restful/specs/sell_finances_v1_oas3.d.ts +0 -255
  143. package/dist/types/restful/specs/sell_finances_v1_oas3.js +0 -4
  144. package/dist/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +0 -595
  145. package/dist/types/restful/specs/sell_fulfillment_v1_oas3.js +0 -4
  146. package/dist/types/restful/specs/sell_inventory_v1_oas3.d.ts +0 -844
  147. package/dist/types/restful/specs/sell_inventory_v1_oas3.js +0 -4
  148. package/dist/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +0 -57
  149. package/dist/types/restful/specs/sell_listing_v1_beta_oas3.js +0 -4
  150. package/dist/types/restful/specs/sell_logistics_v1_oas3.d.ts +0 -173
  151. package/dist/types/restful/specs/sell_logistics_v1_oas3.js +0 -4
  152. package/dist/types/restful/specs/sell_marketing_v1_oas3.d.ts +454 -1411
  153. package/dist/types/restful/specs/sell_marketing_v1_oas3.js +0 -4
  154. package/dist/types/restful/specs/sell_metadata_v1_oas3.d.ts +0 -147
  155. package/dist/types/restful/specs/sell_metadata_v1_oas3.js +0 -4
  156. package/dist/types/restful/specs/sell_negotiation_v1_oas3.d.ts +0 -94
  157. package/dist/types/restful/specs/sell_negotiation_v1_oas3.js +0 -4
  158. package/dist/types/restful/specs/sell_recommendation_v1_oas3.d.ts +0 -60
  159. package/dist/types/restful/specs/sell_recommendation_v1_oas3.js +0 -4
  160. package/dist/types/restfulTypes.d.ts +3 -0
  161. package/lib/api/apiFactory.d.ts +0 -3
  162. package/lib/api/apiFactory.js +0 -4
  163. package/lib/api/base.d.ts +0 -3
  164. package/lib/api/base.js +0 -3
  165. package/lib/api/digitalSignature.d.ts +0 -33
  166. package/lib/api/digitalSignature.js +1 -41
  167. package/lib/api/index.d.ts +0 -3
  168. package/lib/api/index.js +0 -3
  169. package/lib/api/restful/buy/browse/index.d.ts +0 -66
  170. package/lib/api/restful/buy/browse/index.js +0 -73
  171. package/lib/api/restful/buy/deal/index.d.ts +0 -32
  172. package/lib/api/restful/buy/deal/index.js +0 -32
  173. package/lib/api/restful/buy/feed/index.d.ts +0 -33
  174. package/lib/api/restful/buy/feed/index.js +0 -33
  175. package/lib/api/restful/buy/marketing/index.d.ts +0 -18
  176. package/lib/api/restful/buy/marketing/index.js +0 -22
  177. package/lib/api/restful/buy/marketplaceInsights/index.d.ts +0 -21
  178. package/lib/api/restful/buy/marketplaceInsights/index.js +0 -21
  179. package/lib/api/restful/buy/offer/index.d.ts +0 -15
  180. package/lib/api/restful/buy/offer/index.js +0 -15
  181. package/lib/api/restful/buy/order/index.d.ts +0 -227
  182. package/lib/api/restful/buy/order/index.js +0 -227
  183. package/lib/api/restful/commerce/catalog/index.d.ts +0 -54
  184. package/lib/api/restful/commerce/catalog/index.js +0 -54
  185. package/lib/api/restful/commerce/charity/index.d.ts +0 -21
  186. package/lib/api/restful/commerce/charity/index.js +0 -21
  187. package/lib/api/restful/commerce/identity/index.d.ts +0 -7
  188. package/lib/api/restful/commerce/identity/index.js +0 -7
  189. package/lib/api/restful/commerce/notification/index.d.ts +0 -93
  190. package/lib/api/restful/commerce/notification/index.js +0 -93
  191. package/lib/api/restful/commerce/taxonomy/index.d.ts +0 -64
  192. package/lib/api/restful/commerce/taxonomy/index.js +0 -64
  193. package/lib/api/restful/commerce/translation/index.d.ts +0 -8
  194. package/lib/api/restful/commerce/translation/index.js +0 -8
  195. package/lib/api/restful/developer/analytics/index.d.ts +0 -15
  196. package/lib/api/restful/developer/analytics/index.js +0 -15
  197. package/lib/api/restful/developer/keyManagement/index.d.ts +0 -15
  198. package/lib/api/restful/developer/keyManagement/index.js +0 -15
  199. package/lib/api/restful/index.d.ts +0 -16
  200. package/lib/api/restful/index.js +1 -23
  201. package/lib/api/restful/postOrder/cancellation/index.d.ts +0 -43
  202. package/lib/api/restful/postOrder/cancellation/index.js +0 -43
  203. package/lib/api/restful/postOrder/case/index.d.ts +0 -46
  204. package/lib/api/restful/postOrder/case/index.js +0 -46
  205. package/lib/api/restful/postOrder/inquiry/index.d.ts +0 -64
  206. package/lib/api/restful/postOrder/inquiry/index.js +0 -64
  207. package/lib/api/restful/postOrder/return/index.d.ts +0 -190
  208. package/lib/api/restful/postOrder/return/index.js +0 -190
  209. package/lib/api/restful/sell/account/index.d.ts +0 -241
  210. package/lib/api/restful/sell/account/index.js +0 -241
  211. package/lib/api/restful/sell/analytics/index.d.ts +0 -26
  212. package/lib/api/restful/sell/analytics/index.js +0 -26
  213. package/lib/api/restful/sell/compliance/index.d.ts +0 -23
  214. package/lib/api/restful/sell/compliance/index.js +0 -23
  215. package/lib/api/restful/sell/feed/index.d.ts +0 -135
  216. package/lib/api/restful/sell/feed/index.js +0 -135
  217. package/lib/api/restful/sell/finances/index.d.ts +0 -51
  218. package/lib/api/restful/sell/finances/index.js +0 -51
  219. package/lib/api/restful/sell/fulfillment/index.d.ts +0 -108
  220. package/lib/api/restful/sell/fulfillment/index.js +0 -108
  221. package/lib/api/restful/sell/inventory/index.d.ts +0 -197
  222. package/lib/api/restful/sell/inventory/index.js +0 -197
  223. package/lib/api/restful/sell/listing/index.d.ts +0 -8
  224. package/lib/api/restful/sell/listing/index.js +0 -8
  225. package/lib/api/restful/sell/logistics/index.d.ts +0 -33
  226. package/lib/api/restful/sell/logistics/index.js +0 -33
  227. package/lib/api/restful/sell/marketing/index.d.ts +16 -495
  228. package/lib/api/restful/sell/marketing/index.js +48 -494
  229. package/lib/api/restful/sell/metadata/index.d.ts +0 -65
  230. package/lib/api/restful/sell/metadata/index.js +0 -65
  231. package/lib/api/restful/sell/negotiation/index.d.ts +0 -14
  232. package/lib/api/restful/sell/negotiation/index.js +0 -14
  233. package/lib/api/restful/sell/recommendation/index.d.ts +0 -15
  234. package/lib/api/restful/sell/recommendation/index.js +0 -15
  235. package/lib/api/traditional/XMLRequest.d.ts +0 -44
  236. package/lib/api/traditional/XMLRequest.js +0 -46
  237. package/lib/api/traditional/clientAlerts/index.js +0 -1
  238. package/lib/api/traditional/index.d.ts +0 -3
  239. package/lib/api/traditional/index.js +0 -5
  240. package/lib/api/traditional/shopping/index.js +0 -1
  241. package/lib/auth/authNAuth.d.ts +0 -5
  242. package/lib/auth/authNAuth.js +0 -5
  243. package/lib/auth/index.d.ts +0 -3
  244. package/lib/auth/index.js +0 -3
  245. package/lib/auth/oAuth2.d.ts +0 -52
  246. package/lib/auth/oAuth2.js +0 -53
  247. package/lib/eBayApi.d.ts +1 -12
  248. package/lib/eBayApi.js +0 -14
  249. package/lib/ebay-api.min.js +1 -1
  250. package/lib/enums/restfulEnums.d.ts +24 -23
  251. package/lib/enums/restfulEnums.js +52 -52
  252. package/lib/errors/index.d.ts +0 -19
  253. package/lib/errors/index.js +1 -20
  254. package/lib/types/apiTypes.d.ts +2 -2
  255. package/lib/types/restful/specs/buy_browse_v1_oas3.d.ts +0 -697
  256. package/lib/types/restful/specs/buy_browse_v1_oas3.js +0 -4
  257. package/lib/types/restful/specs/buy_deal_v1_oas3.d.ts +0 -189
  258. package/lib/types/restful/specs/buy_deal_v1_oas3.js +0 -4
  259. package/lib/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +0 -229
  260. package/lib/types/restful/specs/buy_feed_v1_beta_oas3.js +0 -4
  261. package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +0 -101
  262. package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.js +0 -4
  263. package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +0 -150
  264. package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +0 -4
  265. package/lib/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +0 -62
  266. package/lib/types/restful/specs/buy_offer_v1_beta_oas3.js +0 -4
  267. package/lib/types/restful/specs/buy_order_v1_beta_oas3.d.ts +0 -600
  268. package/lib/types/restful/specs/buy_order_v1_beta_oas3.js +0 -4
  269. package/lib/types/restful/specs/cancellation_oas3.d.ts +0 -29
  270. package/lib/types/restful/specs/cancellation_oas3.js +0 -4
  271. package/lib/types/restful/specs/case_oas3.d.ts +0 -31
  272. package/lib/types/restful/specs/case_oas3.js +0 -4
  273. package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +0 -331
  274. package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.js +0 -4
  275. package/lib/types/restful/specs/commerce_charity_v1_oas3.d.ts +0 -85
  276. package/lib/types/restful/specs/commerce_charity_v1_oas3.js +0 -4
  277. package/lib/types/restful/specs/commerce_identity_v1_oas3.d.ts +0 -63
  278. package/lib/types/restful/specs/commerce_identity_v1_oas3.js +0 -4
  279. package/lib/types/restful/specs/commerce_notification_v1_oas3.d.ts +0 -236
  280. package/lib/types/restful/specs/commerce_notification_v1_oas3.js +0 -4
  281. package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +0 -219
  282. package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.js +0 -4
  283. package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +0 -36
  284. package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.js +0 -4
  285. package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +0 -57
  286. package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.js +0 -4
  287. package/lib/types/restful/specs/developer_key_management_v1_oas3.d.ts +0 -60
  288. package/lib/types/restful/specs/developer_key_management_v1_oas3.js +0 -4
  289. package/lib/types/restful/specs/inquiry_oas3.d.ts +0 -45
  290. package/lib/types/restful/specs/inquiry_oas3.js +0 -4
  291. package/lib/types/restful/specs/return_oas3.d.ts +0 -130
  292. package/lib/types/restful/specs/return_oas3.js +0 -4
  293. package/lib/types/restful/specs/sell_account_v1_oas3.d.ts +0 -751
  294. package/lib/types/restful/specs/sell_account_v1_oas3.js +0 -4
  295. package/lib/types/restful/specs/sell_analytics_v1_oas3.d.ts +0 -130
  296. package/lib/types/restful/specs/sell_analytics_v1_oas3.js +0 -4
  297. package/lib/types/restful/specs/sell_compliance_v1_oas3.d.ts +0 -102
  298. package/lib/types/restful/specs/sell_compliance_v1_oas3.js +0 -4
  299. package/lib/types/restful/specs/sell_feed_v1_oas3.d.ts +0 -461
  300. package/lib/types/restful/specs/sell_feed_v1_oas3.js +0 -4
  301. package/lib/types/restful/specs/sell_finances_v1_oas3.d.ts +0 -255
  302. package/lib/types/restful/specs/sell_finances_v1_oas3.js +0 -4
  303. package/lib/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +0 -595
  304. package/lib/types/restful/specs/sell_fulfillment_v1_oas3.js +0 -4
  305. package/lib/types/restful/specs/sell_inventory_v1_oas3.d.ts +0 -844
  306. package/lib/types/restful/specs/sell_inventory_v1_oas3.js +0 -4
  307. package/lib/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +0 -57
  308. package/lib/types/restful/specs/sell_listing_v1_beta_oas3.js +0 -4
  309. package/lib/types/restful/specs/sell_logistics_v1_oas3.d.ts +0 -173
  310. package/lib/types/restful/specs/sell_logistics_v1_oas3.js +0 -4
  311. package/lib/types/restful/specs/sell_marketing_v1_oas3.d.ts +454 -1411
  312. package/lib/types/restful/specs/sell_marketing_v1_oas3.js +0 -4
  313. package/lib/types/restful/specs/sell_metadata_v1_oas3.d.ts +0 -147
  314. package/lib/types/restful/specs/sell_metadata_v1_oas3.js +0 -4
  315. package/lib/types/restful/specs/sell_negotiation_v1_oas3.d.ts +0 -94
  316. package/lib/types/restful/specs/sell_negotiation_v1_oas3.js +0 -4
  317. package/lib/types/restful/specs/sell_recommendation_v1_oas3.d.ts +0 -60
  318. package/lib/types/restful/specs/sell_recommendation_v1_oas3.js +0 -4
  319. package/lib/types/restfulTypes.d.ts +3 -0
  320. package/package.json +2 -2
@@ -1,758 +1,417 @@
1
- /**
2
- * This file was auto-generated by openapi-typescript.
3
- * Do not make direct changes to the file.
4
- */
5
1
  export interface paths {
6
2
  "/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
3
  post: operations["applyCoupon"];
9
4
  };
10
5
  "/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
6
  get: operations["getCheckoutSession"];
13
7
  };
14
8
  "/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
9
  post: operations["initiateCheckoutSession"];
17
10
  };
18
11
  "/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
12
  post: operations["placeOrder"];
21
13
  };
22
14
  "/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
15
  post: operations["removeCoupon"];
25
16
  };
26
17
  "/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
18
  post: operations["updatePaymentInfo"];
29
19
  };
30
20
  "/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
21
  post: operations["updateQuantity"];
33
22
  };
34
23
  "/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
24
  post: operations["updateShippingAddress"];
37
25
  };
38
26
  "/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
27
  post: operations["updateShippingOption"];
41
28
  };
42
29
  "/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
30
  post: operations["applyGuestCoupon"];
45
31
  };
46
32
  "/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
33
  get: operations["getGuestCheckoutSession"];
49
34
  };
50
35
  "/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
36
  post: operations["initiateGuestCheckoutSession"];
53
37
  };
54
38
  "/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
39
  post: operations["initiateGuestPayment"];
57
40
  };
58
41
  "/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
42
  post: operations["placeGuestOrder"];
61
43
  };
62
44
  "/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
45
  post: operations["removeGuestCoupon"];
65
46
  };
66
47
  "/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
48
  post: operations["updateGuestPaymentInfo"];
69
49
  };
70
50
  "/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
51
  post: operations["updateGuestQuantity"];
73
52
  };
74
53
  "/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
54
  post: operations["updateGuestShippingAddress"];
77
55
  };
78
56
  "/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
57
  post: operations["updateGuestShippingOption"];
81
58
  };
82
59
  "/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
60
  post: operations["applyProxyGuestCoupon"];
85
61
  };
86
62
  "/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
63
  get: operations["getProxyGuestCheckoutSession"];
89
64
  };
90
65
  "/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
66
  post: operations["initiateProxyGuestCheckoutSession"];
93
67
  };
94
68
  "/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
69
  post: operations["placeProxyGuestOrder"];
97
70
  };
98
71
  "/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
72
  post: operations["removeProxyGuestCoupon"];
101
73
  };
102
74
  "/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
75
  post: operations["updateProxyGuestPaymentInfo"];
105
76
  };
106
77
  "/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
78
  post: operations["updateProxyGuestQuantity"];
109
79
  };
110
80
  "/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
81
  post: operations["updateProxyGuestShippingAddress"];
113
82
  };
114
83
  "/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
84
  post: operations["updateProxyGuestShippingOption"];
117
85
  };
118
86
  "/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
87
  get: operations["getGuestPurchaseOrder"];
121
88
  };
122
89
  "/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
90
  get: operations["getPurchaseOrder"];
125
91
  };
126
92
  }
127
93
  export type webhooks = Record<string, never>;
128
94
  export interface components {
129
95
  schemas: {
130
- /** @description The type that defines the fields for seller adjustments. An adjustment can be a credit or debit. */
131
96
  Adjustment: {
132
- /** @description The container for the amount and currency of the adjustment. */
133
97
  amount?: components["schemas"]["Amount"];
134
- /** @description Text that describes the adjustment. */
135
98
  label?: string;
136
99
  };
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
100
  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
101
  currency?: string;
141
- /** @description The monetary amount. */
142
102
  value?: string;
143
103
  };
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
104
  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
105
  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
106
  addressLine2?: string;
150
- /** @description The city of the address. */
151
107
  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
108
  country?: string;
154
- /** @description The county of the address. */
155
109
  county?: string;
156
- /** @description The buyer's first name. */
157
110
  firstName?: string;
158
- /** @description The buyer's last name. */
159
111
  lastName?: string;
160
- /** @description The postal code of the address. */
161
112
  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
113
  stateOrProvince?: string;
164
114
  };
165
- /** @description The type that defines the fields for initiateProxyGuestCheckoutSession request. */
166
115
  CheckoutSessionRequestWithoutPayment: {
167
- /** @description The buyer's email address. */
168
116
  contactEmail?: string;
169
- /** @description The buyer's first name. */
170
117
  contactFirstName?: string;
171
- /** @description The buyer's last name. */
172
118
  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
119
  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
120
  shippingAddress?: components["schemas"]["ShippingAddress"];
177
121
  };
178
- /** @description Type that defines the fields for a checkout session. */
179
122
  CheckoutSessionResponse: {
180
- /** @description The container that returns the payment method that can be used to purchase the items. */
181
123
  acceptedPaymentMethods?: (components["schemas"]["PaymentMethod"])[];
182
- /** @description The container that returns the information for the coupons that were applied in the checkout session. */
183
124
  appliedCoupons?: (components["schemas"]["Coupon"])[];
184
- /** @description The checkoutSessionId submitted in the request. */
185
125
  checkoutSessionId?: string;
186
- /** @description The time the checkout session will end. To purchase the items the order must be placed before this time. */
187
126
  expirationDate?: string;
188
- /** @description An array of line items associated with the checkout session. */
189
127
  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
128
  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
129
  providedPaymentInstrument?: components["schemas"]["ProvidedPaymentInstrument"];
194
- /** @description The container that returns the address to which the purchase order will be shipped. */
195
130
  shippingAddress?: components["schemas"]["ShippingAddress"];
196
- /** @description An array of any process errors or warnings that were generated during the method processing. */
197
131
  warnings?: (components["schemas"]["Error"])[];
198
132
  };
199
- /** @description The type the defines the fields for the coupon information. */
200
133
  Coupon: {
201
- /** @description The redemption code of the coupon. Note: There can be only one redemption code per order. */
202
134
  redemptionCode?: string;
203
135
  };
204
- /** @description The type that defines the fields for the coupon information used in the request. */
205
136
  CouponRequest: {
206
- /** @description The redemption code of the coupon. Maximum: one redemption code per order */
207
137
  redemptionCode?: string;
208
138
  };
209
- /** @description The type that defines the fields used to create an eBay guest checkout session. */
210
139
  CreateGuestCheckoutSessionRequest: {
211
- /** @description The buyer's email address. */
212
140
  contactEmail?: string;
213
- /** @description The buyer's first name. */
214
141
  contactFirstName?: string;
215
- /** @description The buyer's last name. */
216
142
  contactLastName?: string;
217
- /** @description The container that returns the credit card being used to pay for the items. */
218
143
  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
144
  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
145
  shippingAddress?: components["schemas"]["ShippingAddress"];
223
146
  };
224
- /** @description The type that defines the fields for creating a eBay member checkout session. */
225
147
  CreateSignInCheckoutSessionRequest: {
226
- /** @description The container that returns the buyer's credit card information. */
227
148
  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
149
  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
150
  shippingAddress?: components["schemas"]["ShippingAddress"];
232
151
  };
233
- /** @description The type that defines the fields for the credit card that's used to pay for the items. */
234
152
  CreditCard: {
235
- /** @description The name of the card holder under which the credit card was issued. */
236
153
  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
154
  billingAddress?: components["schemas"]["BillingAddress"];
239
- /** @description The type of the credit car, such as Visa or MasterCard. */
240
155
  brand?: string;
241
- /** @description The credit card number on the card. */
242
156
  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
157
  cvvNumber?: string;
245
- /**
246
- * Format: int32
247
- * @description The month the credit card expires.
248
- */
249
158
  expireMonth?: number;
250
- /**
251
- * Format: int32
252
- * @description The year the credit card expires.
253
- */
254
159
  expireYear?: number;
255
160
  };
256
- /** @description The type that defines the fields for the error messages. */
257
161
  Error: {
258
- /** @description Identifies the type of error. */
259
162
  category?: string;
260
- /** @description Name for the primary system where the error occurred. This is relevant for application errors. */
261
163
  domain?: string;
262
- /**
263
- * Format: int32
264
- * @description A unique number to identify the error.
265
- */
266
164
  errorId?: number;
267
- /** @description An array of request elements most closely associated to the error. */
268
165
  inputRefIds?: (string)[];
269
- /** @description A more detailed explanation of the error. */
270
166
  longMessage?: string;
271
- /** @description Information on how to correct the problem, in the end user's terms and language where applicable. */
272
167
  message?: string;
273
- /** @description An array of request elements most closely associated to the error. */
274
168
  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
169
  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
170
  subdomain?: string;
279
171
  };
280
- /** @description An array of name/value pairs that provide more details regarding error condition. */
281
172
  ErrorParameter: {
282
- /** @description The object of the error. */
283
173
  name?: string;
284
- /** @description The value of the object. */
285
174
  value?: string;
286
175
  };
287
- /** @description The type that defines the fields for the location of a tracking event. */
288
176
  EventLocation: {
289
- /** @description The city where the tracking event occurred. */
290
177
  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
178
  country?: string;
293
- /** @description The county where the tracking event occurred. */
294
179
  county?: string;
295
- /** @description The postal code where the tracking event occurred. */
296
180
  postalCode?: string;
297
- /** @description The state where the tracking event occurred. */
298
181
  stateOrProvince?: string;
299
182
  };
300
183
  GuestCheckoutSessionResponse: {
301
- /** @description The container that returns the payment method that can be used to purchase the items. */
302
184
  acceptedPaymentMethods?: (components["schemas"]["PaymentMethod"])[];
303
- /** @description The container that returns the information for the coupons that were applied in the checkout session. */
304
185
  appliedCoupons?: (components["schemas"]["Coupon"])[];
305
- /** @description The checkoutSessionId submitted in the request. */
306
186
  checkoutSessionId?: string;
307
- /** @description The time the checkout session will end. To purchase the items the order must be placed before this time. */
308
187
  expirationDate?: string;
309
- /** @description An array of line items associated with the checkout session. */
310
188
  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
189
  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
190
  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
191
  providedPaymentInstrument?: components["schemas"]["ProvidedPaymentInstrument"];
317
- /** @description The container that returns the address to which the purchase order will be shipped. */
318
192
  shippingAddress?: components["schemas"]["ShippingAddress"];
319
- /** @description An array of any process errors or warnings that were generated during the method processing. */
320
193
  warnings?: (components["schemas"]["Error"])[];
321
194
  };
322
- /** @description The type that defines the fields that enables the buyer to give or withhold their permission to receive marketing messages. */
323
195
  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
196
  marketingTerms?: (components["schemas"]["MarketingTerms"])[];
326
197
  };
327
- /** @description The type that defines the fields for a guest purchase order. */
328
198
  GuestPurchaseOrder: {
329
- /** @description The container that returns the information for the coupons that were applied in the order. */
330
199
  appliedCoupons?: (components["schemas"]["Coupon"])[];
331
- /** @description An array of the line items in the order. */
332
200
  lineItems?: (components["schemas"]["OrderLineItem"])[];
333
- /** @description The container that returns the monetary details of the order. */
334
201
  pricingSummary?: components["schemas"]["PricingSummary"];
335
- /** @description The creation date of the purchase order. */
336
202
  purchaseOrderCreationDate?: string;
337
- /** @description The unique identifier of the purchase order. This value was returned in the purchaseOrderId field by the placeGuestOrder method. */
338
203
  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
204
  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
205
  purchaseOrderStatus?: string;
343
- /** @description The total amount of any refunds for the purchase order. */
344
206
  refundedAmount?: components["schemas"]["Amount"];
345
- /** @description The container for any warning messages. */
346
207
  warnings?: (components["schemas"]["Error"])[];
347
208
  };
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
209
  Image: {
350
- /**
351
- * Format: int32
352
- * @description Reserved for future use.
353
- */
354
210
  height?: number;
355
- /** @description The URL of the image. */
356
211
  imageUrl?: string;
357
- /**
358
- * Format: int32
359
- * @description Reserved for future use.
360
- */
361
212
  width?: number;
362
213
  };
363
- /** @description Type that defines the fields for the initiateGuestPayment method. */
364
214
  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
215
  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
216
  paymentMethodType?: string;
369
217
  };
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
218
  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
219
  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
220
  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
221
  legacyTransactionId?: string;
378
222
  };
379
- /** @description The container that returns an individual line item in a checkout transaction. */
380
223
  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
224
  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
225
  image?: components["schemas"]["Image"];
385
- /** @description A unique eBay-assigned ID value that identifies the item. */
386
226
  itemId?: string;
387
- /** @description A unique eBay-assigned ID value that identifies the line item in a checkout session. */
388
227
  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
228
  netPrice?: components["schemas"]["Amount"];
391
- /** @description An array of promotions applied with the item of this line item. */
392
229
  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
230
  quantity?: number;
398
- /** @description The container that returns the information about the seller, such as their eBay user name. */
399
231
  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
232
  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
233
  shortDescription?: string;
404
- /** @description The seller created title of the item. */
405
234
  title?: string;
406
235
  };
407
- /** @description The type that defines the fields for a line item. */
408
236
  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
237
  itemId?: string;
411
- /**
412
- * Format: int32
413
- * @description The number of items ordered in this line item.
414
- */
415
238
  quantity?: number;
416
239
  };
417
- /** @description Type the defines the fields for the line item ID and the quantity. */
418
240
  LineItemReference: {
419
- /** @description A unique eBay-assigned ID value to identify the line item in a purchase order. */
420
241
  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
242
  quantity?: number;
426
243
  };
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
244
  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
245
  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
246
  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
247
  marketingTypes?: (string)[];
435
248
  };
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
249
  MarketingTerms: {
438
- /** @description An enumeration value representing the available marketing channels, such as EMAIL. Valid Values: EMAIL */
439
250
  marketingChannels?: (string)[];
440
- /** @description A boolean that indicates whether the buyer wants to receive marketing messages. */
441
251
  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
252
  marketingTypes?: (string)[];
444
253
  };
445
- /** @description The type that defines the fields for line item information in a purchase order. */
446
254
  OrderLineItem: {
447
- /** @description The cost of a single item in this line item. */
448
255
  baseUnitPrice?: components["schemas"]["Amount"];
449
- /** @description The URL of the item's image. */
450
256
  image?: components["schemas"]["Image"];
451
- /** @description The identifier of the item. */
452
257
  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
258
  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
259
  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
260
  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
261
  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
262
  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
263
  orderId?: string;
465
- /** @description An array of promotions applied to the items in this line item. */
466
264
  promotions?: (components["schemas"]["Promotion"])[];
467
- /**
468
- * Format: int32
469
- * @description The number of individual items in this line item.
470
- */
471
265
  quantity?: number;
472
- /** @description The container for information about the seller offering this item, such as the seller's user name. */
473
266
  seller?: components["schemas"]["Seller"];
474
- /** @description Information about the shipping provider used for this line item. */
475
267
  shippingDetail?: components["schemas"]["ShippingDetail"];
476
- /** @description The seller created title of the item. */
477
268
  title?: string;
478
269
  };
479
- /** @description The type that defines the fields for the reference information about the payment method. */
480
270
  PaymentInstrument: {
481
- /** @description The name of the credit card company (brand). */
482
271
  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
272
  paymentMethodType?: string;
485
273
  };
486
- /** @description The type that defines the fields for the payment reference, such as last four digits of a credit card. */
487
274
  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
275
  externalReferenceId?: string;
490
- /** @description The last four digits of the credit card number being used to pay for the items. */
491
276
  lastFourDigitForCreditCard?: string;
492
277
  };
493
- /** @description The type that defines the fields for the payment method. */
494
278
  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
279
  label?: string;
497
- /** @description The URL of the image of the payment method logo. */
498
280
  logoImage?: components["schemas"]["Image"];
499
- /** @description An array of credit card brands that can be used as the payment method. */
500
281
  paymentMethodBrands?: (components["schemas"]["PaymentMethodBrand"])[];
501
- /** @description The type that defines the fields for legal messages and buyer consent verification. */
502
282
  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
283
  paymentMethodType?: string;
505
284
  };
506
- /** @description The type that defines the fields for the credit card company (brand), which can be used as the payment method. */
507
285
  PaymentMethodBrand: {
508
- /** @description The URL of the image of the credit card company (brand). */
509
286
  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
287
  paymentMethodBrandType?: string;
512
288
  };
513
- /** @description The type that defines the fields for legal messages and buyer consent verification. */
514
289
  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
290
  legalMessage?: string;
517
- /** @description Reserved for future use. */
518
291
  privacyPolicyWebUrl?: string;
519
- /** @description Reserved for future use. */
520
292
  requiredForUserConfirmation?: boolean;
521
- /** @description Reserved for future use. */
522
293
  userAgreementWebUrl?: string;
523
294
  };
524
- /** @description The type that defines the fields for the costs, discounts, and seller fees and adjustments of all the line items. */
525
295
  PricingSummary: {
526
- /** @description The total amount of the coupon discounts in the purchase order. */
527
296
  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
297
  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
298
  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
299
  deliveryDiscount?: components["schemas"]["Amount"];
534
- /** @description The total amount of any fees for all the line items, such as a recycling fee. */
535
300
  fee?: components["schemas"]["Amount"];
536
- /** @description The sum of the Global Shipping Program import charges for all line items. */
537
301
  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
302
  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
303
  priceSubtotal?: components["schemas"]["Amount"];
542
- /** @description The total amount of the taxes for all the line items. */
543
304
  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
305
  total?: components["schemas"]["Amount"];
546
306
  };
547
- /** @description The type that defines the fields for the details of an item promotion. */
548
307
  Promotion: {
549
- /** @description The discount amount on the applied promotional offer. */
550
308
  discount?: components["schemas"]["Amount"];
551
- /** @description Note: This field is not return in the purchase order methods response. */
552
309
  discountPercentage?: string;
553
- /** @description The text for the promotion title, which describes the promotion. For example, Buy 1 Get 1. */
554
310
  message?: string;
555
- /** @description An identifier of the promotion that was generated by the system when the promotion was created. */
556
311
  promotionCode?: string;
557
- /** @description Indicates the kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON. */
558
312
  promotionType?: string;
559
313
  };
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
314
  ProvidedPaymentInstrument: {
562
- /** @description The container that returns the payment reference, such as last four digits of a credit card. */
563
315
  paymentInstrumentReference?: components["schemas"]["PaymentInstrumentReference"];
564
- /** @description The container that returns the name and logo of the payment company (brand), such as Visa. */
565
316
  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
317
  paymentMethodType?: string;
568
318
  };
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
319
  PurchaseOrder: {
571
- /** @description The container that returns the information for the coupons that were applied in the order. */
572
320
  appliedCoupons?: (components["schemas"]["Coupon"])[];
573
- /** @description An array of line items in the purchase order. */
574
321
  lineItems?: (components["schemas"]["OrderLineItem"])[];
575
- /** @description The payment method used for the purchase order. */
576
322
  paymentInstrument?: components["schemas"]["PaymentInstrument"];
577
- /** @description The container that returns the monetary details of the order. */
578
323
  pricingSummary?: components["schemas"]["PricingSummary"];
579
- /** @description The timestamp of when the purchase order was created. */
580
324
  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
325
  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
326
  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
327
  purchaseOrderStatus?: string;
587
- /** @description The total amount of any refunds for purchase order. */
588
328
  refundedAmount?: components["schemas"]["Amount"];
589
- /** @description The shipping address for the purchase order. */
590
329
  shippingAddress?: components["schemas"]["ShippingAddress"];
591
- /** @description An array of the shipping providers and the purchase order delivery details. */
592
330
  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
331
  warnings?: (components["schemas"]["Error"])[];
595
332
  };
596
- /** @description The type that defines the fields for the summary of a purchase order. */
597
333
  PurchaseOrderSummary: {
598
- /** @description The URI of the purchase order. */
599
334
  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
335
  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
336
  purchaseOrderPaymentStatus?: string;
604
- /** @description An array of warning messages. */
605
337
  warnings?: (components["schemas"]["Error"])[];
606
338
  };
607
- /** @description The type that defines the fields for the basic seller information. */
608
339
  Seller: {
609
- /** @description The percentage of the total positive feedback. */
610
340
  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
341
  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
342
  sellerAccountType?: string;
618
- /** @description The user name created by the seller for use on eBay. */
619
343
  username?: string;
620
344
  };
621
- /** @description The type that defines the fields for the details of a shipping event, such as DELIVERED. */
622
345
  ShipmentTrackingEvents: {
623
- /** @description A string describing the tracking event. For example: On FedEx vehicle for delivery */
624
346
  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
347
  eventDate?: string;
627
- /** @description A normalized string for shipment tracking event. For example: OUT_FOR_DELIVERY */
628
348
  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
349
  location?: components["schemas"]["EventLocation"];
631
350
  };
632
- /** @description The type that defines the fields for a shipping address. For restrictions, see Shipping restrictions. */
633
351
  ShippingAddress: {
634
- /** @description The first line of the street address where the item is being shipped. */
635
352
  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
353
  addressLine2?: string;
638
- /** @description The city of the address where the item is being shipped. */
639
354
  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
355
  country?: string;
642
- /** @description The county of the address where the item is being shipped. */
643
356
  county?: string;
644
- /** @description The phone number of the person receiving the package. */
645
357
  phoneNumber?: string;
646
- /** @description The postal code of the address where the item is being shipped. */
647
358
  postalCode?: string;
648
- /** @description Name of the person receiving the package. */
649
359
  recipient?: string;
650
- /** @description The state or province of the address where the item is being shipped. */
651
360
  stateOrProvince?: string;
652
361
  };
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
362
  ShippingAddressImpl: {
655
- /** @description The first line of the street address. */
656
363
  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
364
  addressLine2?: string;
659
- /** @description The city of the address. */
660
365
  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
366
  country?: string;
663
- /** @description The county of the address. */
664
367
  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
368
  phoneNumber?: string;
667
- /** @description The postal code of the address. */
668
369
  postalCode?: string;
669
- /** @description Full name of the person receiving the purchase order. */
670
370
  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
371
  stateOrProvince?: string;
673
372
  };
674
- /** @description The type that defines the fields for the shipping information, such as delivery date estimates and shipping provider. */
675
373
  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
374
  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
375
  minEstimatedDeliveryDate?: string;
680
- /** @description The shipping provider, such as FedEx, or USPS for the line item. */
681
376
  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
377
  shippingServiceCode?: string;
684
378
  };
685
- /** @description The type that defines the fields for the shipping details. */
686
379
  ShippingFulfillment: {
687
- /** @description The date the purchase order was delivered. */
688
380
  actualDeliveryDate?: string;
689
- /** @description The container the returns the fields for the line item ID and the quantity. */
690
381
  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
382
  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
383
  minEstimatedDeliveryDate?: string;
695
- /** @description The container that returns all the shipment tracking events. */
696
384
  shipmentTrackingEvents?: (components["schemas"]["ShipmentTrackingEvents"])[];
697
- /** @description The shipping provider number associated with the purchase order that can be used to track the package. */
698
385
  shipmentTrackingNumber?: string;
699
- /** @description The URL of the shipping provider's shipment tracking page. */
700
386
  shipmentTrackingUrl?: string;
701
- /** @description The date the seller gave the purchase order to the shipping provider. */
702
387
  shippedDate?: string;
703
- /** @description A name of the shipping provider, such as FedEx, or USPS. */
704
388
  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
389
  shippingServiceCode?: string;
707
390
  };
708
- /** @description The type that defines the fields for the shipping options. */
709
391
  ShippingOption: {
710
- /** @description The shipping cost using this shipping option for this line item before any shipping discounts. */
711
392
  baseDeliveryCost?: components["schemas"]["Amount"];
712
- /** @description The monetary value of any delivery discount. */
713
393
  deliveryDiscount?: components["schemas"]["Amount"];
714
- /** @description The Global Shipping Program import charges for this line item. */
715
394
  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
395
  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
396
  minEstimatedDeliveryDate?: string;
720
- /** @description Indicates if the shipping method is selected. */
721
397
  selected?: boolean;
722
- /** @description The shipping provider, such as FedEx, or USPS for the line item. */
723
398
  shippingCarrierCode?: string;
724
- /** @description A unique ID for the selected shipping option/method. */
725
399
  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
400
  shippingServiceCode?: string;
728
401
  };
729
- /** @description The type that defines the fields for payment information. */
730
402
  UpdatePaymentInformation: {
731
- /** @description Container for the buyer's credit card information. */
732
403
  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
404
  wallet?: components["schemas"]["Wallet"];
735
405
  };
736
- /** @description The type that defines the fields used to update the quantity of a line item. */
737
406
  UpdateQuantity: {
738
- /** @description A unique eBay-assigned ID value that identifys a line item in a purchase order. */
739
407
  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
408
  quantity?: number;
745
409
  };
746
- /** @description The type that defines the fields used to update the shipping option of a line item. */
747
410
  UpdateShippingOption: {
748
- /** @description A unique eBay-assigned ID value that identifies the line item in a checkout session. */
749
411
  lineItemId?: string;
750
- /** @description A unique ID for the selected shipping option/method. */
751
412
  shippingOptionId?: string;
752
413
  };
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
414
  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
415
  paymentToken?: string;
757
416
  };
758
417
  };
@@ -764,937 +423,678 @@ export interface components {
764
423
  }
765
424
  export type external = Record<string, never>;
766
425
  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
426
  applyCoupon: {
769
427
  parameters: {
770
428
  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
429
  checkoutSessionId: string;
773
430
  };
774
431
  };
775
- /** @description The container for the fields used to apply a coupon to a checkout session. */
776
432
  requestBody?: {
777
433
  content: {
778
434
  "application/json": components["schemas"]["CouponRequest"];
779
435
  };
780
436
  };
781
437
  responses: {
782
- /** @description OK */
783
438
  200: {
784
439
  content: {
785
440
  "application/json": components["schemas"]["CheckoutSessionResponse"];
786
441
  };
787
442
  };
788
- /** @description Bad Request */
789
443
  400: never;
790
- /** @description Access Forbidden */
791
444
  403: never;
792
- /** @description Resource Not Found */
793
445
  404: never;
794
- /** @description Conflict */
795
446
  409: never;
796
- /** @description Internal Server Error */
797
447
  500: never;
798
448
  };
799
449
  };
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
450
  getCheckoutSession: {
802
451
  parameters: {
803
452
  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
453
  checkoutSessionId: string;
806
454
  };
807
455
  };
808
456
  responses: {
809
- /** @description OK */
810
457
  200: {
811
458
  content: {
812
459
  "application/json": components["schemas"]["CheckoutSessionResponse"];
813
460
  };
814
461
  };
815
- /** @description Bad Request */
816
462
  400: never;
817
- /** @description Access Forbidden */
818
463
  403: never;
819
- /** @description Resource Not Found */
820
464
  404: never;
821
- /** @description Conflict */
822
465
  409: never;
823
- /** @description Internal Error */
824
466
  500: never;
825
467
  };
826
468
  };
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
469
  initiateCheckoutSession: {
829
- /** @description The container for the fields used by the initiateCheckoutSession method. */
830
470
  requestBody?: {
831
471
  content: {
832
472
  "application/json": components["schemas"]["CreateSignInCheckoutSessionRequest"];
833
473
  };
834
474
  };
835
475
  responses: {
836
- /** @description OK */
837
476
  200: {
838
477
  content: {
839
478
  "application/json": components["schemas"]["CheckoutSessionResponse"];
840
479
  };
841
480
  };
842
- /** @description Bad Request */
843
481
  400: never;
844
- /** @description Conflict */
845
482
  409: never;
846
- /** @description Internal Server Error */
847
483
  500: never;
848
484
  };
849
485
  };
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
486
  placeOrder: {
852
487
  parameters: {
853
488
  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
489
  checkoutSessionId: string;
856
490
  };
857
491
  };
858
492
  responses: {
859
- /** @description OK */
860
493
  200: {
861
494
  content: {
862
495
  "application/json": components["schemas"]["PurchaseOrderSummary"];
863
496
  };
864
497
  };
865
- /** @description Bad Request */
866
498
  400: never;
867
- /** @description Access Forbidden */
868
499
  403: never;
869
- /** @description Resource Not Found */
870
500
  404: never;
871
- /** @description Conflict */
872
501
  409: never;
873
- /** @description Internal Server Error */
874
502
  500: never;
875
503
  };
876
504
  };
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
505
  removeCoupon: {
879
506
  parameters: {
880
507
  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
508
  checkoutSessionId: string;
883
509
  };
884
510
  };
885
- /** @description The container for the fields used to remove a coupon from a checkout session. */
886
511
  requestBody?: {
887
512
  content: {
888
513
  "application/json": components["schemas"]["CouponRequest"];
889
514
  };
890
515
  };
891
516
  responses: {
892
- /** @description OK */
893
517
  200: {
894
518
  content: {
895
519
  "application/json": components["schemas"]["CheckoutSessionResponse"];
896
520
  };
897
521
  };
898
- /** @description Bad Request */
899
522
  400: never;
900
- /** @description Access Forbidden */
901
523
  403: never;
902
- /** @description Resource Not Found */
903
524
  404: never;
904
- /** @description Conflict */
905
525
  409: never;
906
- /** @description Internal Error */
907
526
  500: never;
908
527
  };
909
528
  };
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
529
  updatePaymentInfo: {
912
530
  parameters: {
913
531
  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
532
  checkoutSessionId: string;
916
533
  };
917
534
  };
918
- /** @description The container for the fields used by the updatePaymentInfo method. */
919
535
  requestBody?: {
920
536
  content: {
921
537
  "application/json": components["schemas"]["UpdatePaymentInformation"];
922
538
  };
923
539
  };
924
540
  responses: {
925
- /** @description OK */
926
541
  200: {
927
542
  content: {
928
543
  "application/json": components["schemas"]["CheckoutSessionResponse"];
929
544
  };
930
545
  };
931
- /** @description Bad Request */
932
546
  400: never;
933
- /** @description Access Forbidden */
934
547
  403: never;
935
- /** @description Resource Not Found */
936
548
  404: never;
937
- /** @description Conflict */
938
549
  409: never;
939
- /** @description Internal Server Error */
940
550
  500: never;
941
551
  };
942
552
  };
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
553
  updateQuantity: {
945
554
  parameters: {
946
555
  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
556
  checkoutSessionId: string;
949
557
  };
950
558
  };
951
- /** @description The container for the fields used by the updateQuantity method. */
952
559
  requestBody?: {
953
560
  content: {
954
561
  "application/json": components["schemas"]["UpdateQuantity"];
955
562
  };
956
563
  };
957
564
  responses: {
958
- /** @description OK */
959
565
  200: {
960
566
  content: {
961
567
  "application/json": components["schemas"]["CheckoutSessionResponse"];
962
568
  };
963
569
  };
964
- /** @description Bad Request */
965
570
  400: never;
966
- /** @description Access Forbidden */
967
571
  403: never;
968
- /** @description Resource Not Found */
969
572
  404: never;
970
- /** @description Conflict */
971
573
  409: never;
972
- /** @description Internal Error */
973
574
  500: never;
974
575
  };
975
576
  };
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
577
  updateShippingAddress: {
978
578
  parameters: {
979
579
  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
580
  checkoutSessionId: string;
982
581
  };
983
582
  };
984
- /** @description The container for the fields used by the updateShippingAddress method. */
985
583
  requestBody?: {
986
584
  content: {
987
585
  "application/json": components["schemas"]["ShippingAddressImpl"];
988
586
  };
989
587
  };
990
588
  responses: {
991
- /** @description OK */
992
589
  200: {
993
590
  content: {
994
591
  "application/json": components["schemas"]["CheckoutSessionResponse"];
995
592
  };
996
593
  };
997
- /** @description Bad Request */
998
594
  400: never;
999
- /** @description Access Forbidden */
1000
595
  403: never;
1001
- /** @description Resource Not Found */
1002
596
  404: never;
1003
- /** @description Conflict */
1004
597
  409: never;
1005
- /** @description Internal Server Error */
1006
598
  500: never;
1007
599
  };
1008
600
  };
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
601
  updateShippingOption: {
1011
602
  parameters: {
1012
603
  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
604
  checkoutSessionId: string;
1015
605
  };
1016
606
  };
1017
- /** @description The container for the fields used by the updateShippingOption method. */
1018
607
  requestBody?: {
1019
608
  content: {
1020
609
  "application/json": components["schemas"]["UpdateShippingOption"];
1021
610
  };
1022
611
  };
1023
612
  responses: {
1024
- /** @description OK */
1025
613
  200: {
1026
614
  content: {
1027
615
  "application/json": components["schemas"]["CheckoutSessionResponse"];
1028
616
  };
1029
617
  };
1030
- /** @description Bad Request */
1031
618
  400: never;
1032
- /** @description Access Forbidden */
1033
619
  403: never;
1034
- /** @description Resource Not Found */
1035
620
  404: never;
1036
- /** @description Conflict */
1037
621
  409: never;
1038
- /** @description Internal Error */
1039
622
  500: never;
1040
623
  };
1041
624
  };
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
625
  applyGuestCoupon: {
1044
626
  parameters: {
1045
627
  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
628
  checkoutSessionId: string;
1048
629
  };
1049
630
  };
1050
- /** @description The container for the fields used to apply a coupon to a checkout session. */
1051
631
  requestBody?: {
1052
632
  content: {
1053
633
  "application/json": components["schemas"]["CouponRequest"];
1054
634
  };
1055
635
  };
1056
636
  responses: {
1057
- /** @description OK */
1058
637
  200: {
1059
638
  content: {
1060
639
  "application/json": components["schemas"]["CheckoutSessionResponse"];
1061
640
  };
1062
641
  };
1063
- /** @description Bad Request */
1064
642
  400: never;
1065
- /** @description Access Forbidden */
1066
643
  403: never;
1067
- /** @description Resource Not Found */
1068
644
  404: never;
1069
- /** @description Conflict */
1070
645
  409: never;
1071
- /** @description Internal Server Error */
1072
646
  500: never;
1073
647
  };
1074
648
  };
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
649
  getGuestCheckoutSession: {
1077
650
  parameters: {
1078
651
  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
652
  checkoutSessionId: string;
1081
653
  };
1082
654
  };
1083
655
  responses: {
1084
- /** @description OK */
1085
656
  200: {
1086
657
  content: {
1087
658
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1088
659
  };
1089
660
  };
1090
- /** @description Bad Request */
1091
661
  400: never;
1092
- /** @description Access Forbidden */
1093
662
  403: never;
1094
- /** @description Resource Not Found */
1095
663
  404: never;
1096
- /** @description Conflict */
1097
664
  409: never;
1098
- /** @description Internal Error */
1099
665
  500: never;
1100
666
  };
1101
667
  };
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
668
  initiateGuestCheckoutSession: {
1104
- /** @description The container for the fields used by the initiateGuestCheckoutSession method. */
1105
669
  requestBody?: {
1106
670
  content: {
1107
671
  "application/json": components["schemas"]["CreateGuestCheckoutSessionRequest"];
1108
672
  };
1109
673
  };
1110
674
  responses: {
1111
- /** @description OK */
1112
675
  200: {
1113
676
  content: {
1114
677
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1115
678
  };
1116
679
  };
1117
- /** @description Bad Request */
1118
680
  400: never;
1119
- /** @description Conflict */
1120
681
  409: never;
1121
- /** @description Internal Error */
1122
682
  500: never;
1123
683
  };
1124
684
  };
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
685
  initiateGuestPayment: {
1127
686
  parameters: {
1128
687
  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
688
  checkoutSessionId: string;
1131
689
  };
1132
690
  };
1133
- /** @description The container for the fields used by the initiateGuestPayment method. */
1134
691
  requestBody?: {
1135
692
  content: {
1136
693
  "application/json": components["schemas"]["InitiatePaymentRequest"];
1137
694
  };
1138
695
  };
1139
696
  responses: {
1140
- /** @description OK */
1141
697
  200: {
1142
698
  content: {
1143
699
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1144
700
  };
1145
701
  };
1146
- /** @description Bad Request */
1147
702
  400: never;
1148
- /** @description Access Forbidden */
1149
703
  403: never;
1150
- /** @description Resource Not Found */
1151
704
  404: never;
1152
- /** @description Conflict */
1153
705
  409: never;
1154
- /** @description Internal Server Error */
1155
706
  500: never;
1156
707
  };
1157
708
  };
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
709
  placeGuestOrder: {
1160
710
  parameters: {
1161
711
  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
712
  checkoutSessionId: string;
1164
713
  };
1165
714
  };
1166
- /** @description The container for the fields used by the placeGuestOrder method. */
1167
715
  requestBody?: {
1168
716
  content: {
1169
717
  "application/json": components["schemas"]["GuestPlaceOrderRequest"];
1170
718
  };
1171
719
  };
1172
720
  responses: {
1173
- /** @description OK */
1174
721
  200: {
1175
722
  content: {
1176
723
  "application/json": components["schemas"]["PurchaseOrderSummary"];
1177
724
  };
1178
725
  };
1179
- /** @description Bad Request */
1180
726
  400: never;
1181
- /** @description Access Forbidden */
1182
727
  403: never;
1183
- /** @description Resource Not Found */
1184
728
  404: never;
1185
- /** @description Conflict */
1186
729
  409: never;
1187
- /** @description Internal Error */
1188
730
  500: never;
1189
731
  };
1190
732
  };
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
733
  removeGuestCoupon: {
1193
734
  parameters: {
1194
735
  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
736
  checkoutSessionId: string;
1197
737
  };
1198
738
  };
1199
- /** @description The container for the fields used to remove a coupon from a checkout session. */
1200
739
  requestBody?: {
1201
740
  content: {
1202
741
  "application/json": components["schemas"]["CouponRequest"];
1203
742
  };
1204
743
  };
1205
744
  responses: {
1206
- /** @description OK */
1207
745
  200: {
1208
746
  content: {
1209
747
  "application/json": components["schemas"]["CheckoutSessionResponse"];
1210
748
  };
1211
749
  };
1212
- /** @description Bad Request */
1213
750
  400: never;
1214
- /** @description Access Forbidden */
1215
751
  403: never;
1216
- /** @description Resource Not Found */
1217
752
  404: never;
1218
- /** @description Conflict */
1219
753
  409: never;
1220
- /** @description Internal Error */
1221
754
  500: never;
1222
755
  };
1223
756
  };
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
757
  updateGuestPaymentInfo: {
1226
758
  parameters: {
1227
759
  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
760
  checkoutSessionId: string;
1230
761
  };
1231
762
  };
1232
- /** @description The container for the fields used by the updateGuestPaymentInfo method. */
1233
763
  requestBody?: {
1234
764
  content: {
1235
765
  "application/json": components["schemas"]["UpdatePaymentInformation"];
1236
766
  };
1237
767
  };
1238
768
  responses: {
1239
- /** @description OK */
1240
769
  200: {
1241
770
  content: {
1242
771
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1243
772
  };
1244
773
  };
1245
- /** @description Bad Request */
1246
774
  400: never;
1247
- /** @description Access Forbidden */
1248
775
  403: never;
1249
- /** @description Resource Not Found */
1250
776
  404: never;
1251
- /** @description Conflict */
1252
777
  409: never;
1253
- /** @description Internal Error */
1254
778
  500: never;
1255
779
  };
1256
780
  };
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
781
  updateGuestQuantity: {
1259
782
  parameters: {
1260
783
  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
784
  checkoutSessionId: string;
1263
785
  };
1264
786
  };
1265
- /** @description The container for the fields used by the updateGuestQuantity method. */
1266
787
  requestBody?: {
1267
788
  content: {
1268
789
  "application/json": components["schemas"]["UpdateQuantity"];
1269
790
  };
1270
791
  };
1271
792
  responses: {
1272
- /** @description OK */
1273
793
  200: {
1274
794
  content: {
1275
795
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1276
796
  };
1277
797
  };
1278
- /** @description Bad Request */
1279
798
  400: never;
1280
- /** @description Access Forbidden */
1281
799
  403: never;
1282
- /** @description Resource Not Found */
1283
800
  404: never;
1284
- /** @description Conflict */
1285
801
  409: never;
1286
- /** @description Internal Server Error */
1287
802
  500: never;
1288
803
  };
1289
804
  };
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
805
  updateGuestShippingAddress: {
1292
806
  parameters: {
1293
807
  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
808
  checkoutSessionId: string;
1296
809
  };
1297
810
  };
1298
- /** @description The container for the fields used by the updateGuestShippingAddress method. */
1299
811
  requestBody?: {
1300
812
  content: {
1301
813
  "application/json": components["schemas"]["ShippingAddressImpl"];
1302
814
  };
1303
815
  };
1304
816
  responses: {
1305
- /** @description OK */
1306
817
  200: {
1307
818
  content: {
1308
819
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1309
820
  };
1310
821
  };
1311
- /** @description Bad Request */
1312
822
  400: never;
1313
- /** @description Access Forbidden */
1314
823
  403: never;
1315
- /** @description Resource Not Found */
1316
824
  404: never;
1317
- /** @description Conflict */
1318
825
  409: never;
1319
- /** @description Internal Error */
1320
826
  500: never;
1321
827
  };
1322
828
  };
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
829
  updateGuestShippingOption: {
1325
830
  parameters: {
1326
831
  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
832
  checkoutSessionId: string;
1329
833
  };
1330
834
  };
1331
- /** @description The container for the fields used by the updateGuestShippingOption method. */
1332
835
  requestBody?: {
1333
836
  content: {
1334
837
  "application/json": components["schemas"]["UpdateShippingOption"];
1335
838
  };
1336
839
  };
1337
840
  responses: {
1338
- /** @description OK */
1339
841
  200: {
1340
842
  content: {
1341
843
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1342
844
  };
1343
845
  };
1344
- /** @description Bad Request */
1345
846
  400: never;
1346
- /** @description Access Forbidden */
1347
847
  403: never;
1348
- /** @description Resource Not Found */
1349
848
  404: never;
1350
- /** @description Conflict */
1351
849
  409: never;
1352
- /** @description Internal Error */
1353
850
  500: never;
1354
851
  };
1355
852
  };
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
853
  applyProxyGuestCoupon: {
1358
854
  parameters: {
1359
855
  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
856
  checkoutSessionId: string;
1362
857
  };
1363
858
  };
1364
- /** @description The container for the fields used to apply a coupon to a checkout session. */
1365
859
  requestBody?: {
1366
860
  content: {
1367
861
  "application/json": components["schemas"]["CouponRequest"];
1368
862
  };
1369
863
  };
1370
864
  responses: {
1371
- /** @description OK */
1372
865
  200: {
1373
866
  content: {
1374
867
  "application/json": components["schemas"]["CheckoutSessionResponse"];
1375
868
  };
1376
869
  };
1377
- /** @description Bad Request */
1378
870
  400: never;
1379
- /** @description Access Forbidden */
1380
871
  403: never;
1381
- /** @description Resource Not Found */
1382
872
  404: never;
1383
- /** @description Conflict */
1384
873
  409: never;
1385
- /** @description Internal Error */
1386
874
  500: never;
1387
875
  };
1388
876
  };
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
877
  getProxyGuestCheckoutSession: {
1391
878
  parameters: {
1392
879
  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
880
  checkoutSessionId: string;
1395
881
  };
1396
882
  };
1397
883
  responses: {
1398
- /** @description OK */
1399
884
  200: {
1400
885
  content: {
1401
886
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1402
887
  };
1403
888
  };
1404
- /** @description Bad Request */
1405
889
  400: never;
1406
- /** @description Access Forbidden */
1407
890
  403: never;
1408
- /** @description Resource Not Found */
1409
891
  404: never;
1410
- /** @description Conflict */
1411
892
  409: never;
1412
- /** @description Internal Error */
1413
893
  500: never;
1414
894
  };
1415
895
  };
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
896
  initiateProxyGuestCheckoutSession: {
1418
- /** @description The container for the fields used by the initiateProxyGuestCheckoutSession method. */
1419
897
  requestBody?: {
1420
898
  content: {
1421
899
  "application/json": components["schemas"]["CheckoutSessionRequestWithoutPayment"];
1422
900
  };
1423
901
  };
1424
902
  responses: {
1425
- /** @description OK */
1426
903
  200: {
1427
904
  content: {
1428
905
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1429
906
  };
1430
907
  };
1431
- /** @description Bad Request */
1432
908
  400: never;
1433
- /** @description Access Forbidden */
1434
909
  403: never;
1435
- /** @description Conflict */
1436
910
  409: never;
1437
- /** @description Internal Error */
1438
911
  500: never;
1439
912
  };
1440
913
  };
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
914
  placeProxyGuestOrder: {
1443
915
  parameters: {
1444
916
  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
917
  checkoutSessionId: string;
1447
918
  };
1448
919
  };
1449
- /** @description The container for the fields used by the placeProxyGuestOrder method. */
1450
920
  requestBody?: {
1451
921
  content: {
1452
922
  "application/json": components["schemas"]["GuestPlaceOrderRequest"];
1453
923
  };
1454
924
  };
1455
925
  responses: {
1456
- /** @description OK */
1457
926
  200: {
1458
927
  content: {
1459
928
  "application/json": components["schemas"]["PurchaseOrderSummary"];
1460
929
  };
1461
930
  };
1462
- /** @description Bad Request */
1463
931
  400: never;
1464
- /** @description Access Forbidden */
1465
932
  403: never;
1466
- /** @description Resource Not Found */
1467
933
  404: never;
1468
- /** @description Conflict */
1469
934
  409: never;
1470
- /** @description Internal Server Error */
1471
935
  500: never;
1472
936
  };
1473
937
  };
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
938
  removeProxyGuestCoupon: {
1476
939
  parameters: {
1477
940
  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
941
  checkoutSessionId: string;
1480
942
  };
1481
943
  };
1482
- /** @description The container for the fields used to remove a coupon from a checkout session. */
1483
944
  requestBody?: {
1484
945
  content: {
1485
946
  "application/json": components["schemas"]["CouponRequest"];
1486
947
  };
1487
948
  };
1488
949
  responses: {
1489
- /** @description OK */
1490
950
  200: {
1491
951
  content: {
1492
952
  "application/json": components["schemas"]["CheckoutSessionResponse"];
1493
953
  };
1494
954
  };
1495
- /** @description Bad Request */
1496
955
  400: never;
1497
- /** @description Access Forbidden */
1498
956
  403: never;
1499
- /** @description Resource Not Found */
1500
957
  404: never;
1501
- /** @description Conflict */
1502
958
  409: never;
1503
- /** @description Internal Server Error */
1504
959
  500: never;
1505
960
  };
1506
961
  };
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
962
  updateProxyGuestPaymentInfo: {
1509
963
  parameters: {
1510
964
  header: {
1511
- /** @description The oAuth token. Note: The eBay partner must include this header in the request. */
1512
965
  Authorization: string;
1513
- /** @description The UTC timestamp of the request, which is generated and added to the request by the VSP. */
1514
966
  "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
967
  "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
968
  "X-EBAY-C-REQUEST-NONCE": string;
1519
- /** @description The HMAC signature, which is generated and added to the request by the VSP. */
1520
969
  "X-EBAY-C-SIGNATURE": string;
1521
970
  };
1522
971
  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
972
  checkoutSessionId: string;
1525
973
  };
1526
974
  };
1527
- /** @description The container for the fields used by the updateProxyGuestPaymentInfo method. */
1528
975
  requestBody?: {
1529
976
  content: {
1530
977
  "application/json": components["schemas"]["UpdatePaymentInformation"];
1531
978
  };
1532
979
  };
1533
980
  responses: {
1534
- /** @description OK */
1535
981
  200: {
1536
982
  content: {
1537
983
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1538
984
  };
1539
985
  };
1540
- /** @description Bad Request */
1541
986
  400: never;
1542
- /** @description Access Forbidden */
1543
987
  403: never;
1544
- /** @description Resource Not Found */
1545
988
  404: never;
1546
- /** @description Conflict */
1547
989
  409: never;
1548
- /** @description Internal Server Error */
1549
990
  500: never;
1550
991
  };
1551
992
  };
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
993
  updateProxyGuestQuantity: {
1554
994
  parameters: {
1555
995
  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
996
  checkoutSessionId: string;
1558
997
  };
1559
998
  };
1560
- /** @description The container for the fields used by the updateProxyGuestQuantity method. */
1561
999
  requestBody?: {
1562
1000
  content: {
1563
1001
  "application/json": components["schemas"]["UpdateQuantity"];
1564
1002
  };
1565
1003
  };
1566
1004
  responses: {
1567
- /** @description OK */
1568
1005
  200: {
1569
1006
  content: {
1570
1007
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1571
1008
  };
1572
1009
  };
1573
- /** @description Bad Request */
1574
1010
  400: never;
1575
- /** @description Access Forbidden */
1576
1011
  403: never;
1577
- /** @description Resource Not Found */
1578
1012
  404: never;
1579
- /** @description Conflict */
1580
1013
  409: never;
1581
- /** @description Internal Server Error */
1582
1014
  500: never;
1583
1015
  };
1584
1016
  };
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
1017
  updateProxyGuestShippingAddress: {
1587
1018
  parameters: {
1588
1019
  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
1020
  checkoutSessionId: string;
1591
1021
  };
1592
1022
  };
1593
- /** @description The container for the fields used by the updateProxyGuestShippingAddress method. */
1594
1023
  requestBody?: {
1595
1024
  content: {
1596
1025
  "application/json": components["schemas"]["ShippingAddressImpl"];
1597
1026
  };
1598
1027
  };
1599
1028
  responses: {
1600
- /** @description OK */
1601
1029
  200: {
1602
1030
  content: {
1603
1031
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1604
1032
  };
1605
1033
  };
1606
- /** @description Bad Request */
1607
1034
  400: never;
1608
- /** @description Access Forbidden */
1609
1035
  403: never;
1610
- /** @description Resource Not Found */
1611
1036
  404: never;
1612
- /** @description Conflict */
1613
1037
  409: never;
1614
- /** @description Internal Error */
1615
1038
  500: never;
1616
1039
  };
1617
1040
  };
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
1041
  updateProxyGuestShippingOption: {
1620
1042
  parameters: {
1621
1043
  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
1044
  checkoutSessionId: string;
1624
1045
  };
1625
1046
  };
1626
- /** @description The container for the fields used by the updateProxyGuestShippingOption method. */
1627
1047
  requestBody?: {
1628
1048
  content: {
1629
1049
  "application/json": components["schemas"]["UpdateShippingOption"];
1630
1050
  };
1631
1051
  };
1632
1052
  responses: {
1633
- /** @description OK */
1634
1053
  200: {
1635
1054
  content: {
1636
1055
  "application/json": components["schemas"]["GuestCheckoutSessionResponse"];
1637
1056
  };
1638
1057
  };
1639
- /** @description Bad Request */
1640
1058
  400: never;
1641
- /** @description Access Forbidden */
1642
1059
  403: never;
1643
- /** @description Resource Not Found */
1644
1060
  404: never;
1645
- /** @description Conflict */
1646
1061
  409: never;
1647
- /** @description Internal Server Error */
1648
1062
  500: never;
1649
1063
  };
1650
1064
  };
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
1065
  getGuestPurchaseOrder: {
1653
1066
  parameters: {
1654
1067
  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
1068
  purchaseOrderId: string;
1657
1069
  };
1658
1070
  };
1659
1071
  responses: {
1660
- /** @description OK */
1661
1072
  200: {
1662
1073
  content: {
1663
1074
  "application/json": components["schemas"]["GuestPurchaseOrder"];
1664
1075
  };
1665
1076
  };
1666
- /** @description Bad Request */
1667
1077
  400: never;
1668
- /** @description Access Forbidden */
1669
1078
  403: never;
1670
- /** @description Not Found */
1671
1079
  404: never;
1672
- /** @description Internal Server Error */
1673
1080
  500: never;
1674
1081
  };
1675
1082
  };
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
1083
  getPurchaseOrder: {
1678
1084
  parameters: {
1679
1085
  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
1086
  purchaseOrderId: string;
1682
1087
  };
1683
1088
  };
1684
1089
  responses: {
1685
- /** @description OK */
1686
1090
  200: {
1687
1091
  content: {
1688
1092
  "application/json": components["schemas"]["PurchaseOrder"];
1689
1093
  };
1690
1094
  };
1691
- /** @description Bad Request */
1692
1095
  400: never;
1693
- /** @description Access Forbidden */
1694
1096
  403: never;
1695
- /** @description Not Found */
1696
1097
  404: never;
1697
- /** @description Internal Server Error */
1698
1098
  500: never;
1699
1099
  };
1700
1100
  };