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,1189 +1,592 @@
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
  "/item_summary/search": {
7
- /** @description <p>This method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combination of these. </p><p><span class="tablenote"><b> Note: </b>Only FIXED_PRICE (Buy It Now) items are returned by default. However, this method does return items where both FIXED_PRICE and AUCTION are available as a buying option. After a bid has been placed, items become active auction items and are no longer returned by default, but they remain accessible by filtering for the AUCTION buying option.</span></p><p>This method also supports the following: <ul> <li>Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the <a href="#uri.filter">filter</a> parameter.</li> <li>Retrieving the refinements (metadata) of an item , such as item aspects (color, brand), condition, category, etc. using the <a href="#uri.fieldgroups">fieldgroups</a> parameter. </li> <li>Filtering by item aspects and other refinements using the <a href="#uri.aspect_filter">aspect_filter</a> parameter. </li> <li>Filtering for items that are compatible with a specific product, using the <a href="#uri.compatibility_filter">compatibility_filter</a> parameter. </li><li>Creating aspects histograms, which enables shoppers to drill down in each refinement narrowing the search results. </li> </ul></p> <p>For details and examples of these capabilities, see <a href="/api-docs/buy/static/api-browse.html">Browse API</a> in the Buying Integration Guide.</p> <h3><b> Pagination and sort controls</b></h3> <p>There are pagination controls (<b>limit</b> and <b>offset</b> fields) and <b> sort</b> query parameters that control/sort the data that is returned. By default, the results are sorted by &quot;Best Match&quot;. For more information about Best Match, see the eBay help page <a href="https://pages.ebay.com/help/sell/searchstanding.html" target="_blank">Best Match</a>. </p> <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item_summary/search?</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/item_summary/search?</code></li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b>Restrictions </b></h3> <p>This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network: </b> In order to receive a commission for your sales, you must use the URL returned in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the ebay.com site. </span> */
8
3
  get: operations["search"];
9
4
  };
10
5
  "/item_summary/search_by_image": {
11
- /** @description <img src="/cms/img/docs/experimental-icon.svg" class="legend-icon experimental-icon" alt="Experimental Release" title="Experimental Release"> This is an <a href="https://developer.ebay.com/api-docs/static/versioning.html#experimental">Experimental</a> method. <p>This method searches for eBay items based on a image and retrieves summaries of the items. You pass in a Base64 image in the request payload and can refine the search by category, or eBay product ID (ePID), or a combination of these using URI parameters. <br /><br />To get the Base64 image string, you can use sites such as <a href="https://codebeautify.org/image-to-base64-converter" target="_blank">https://codebeautify.org/image-to-base64-converter</a>. </p> <p>This method also supports the following: <ul> <li>Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the <a href="#uri.filter">filter</a> parameter.</li> <li>Filtering by item aspects using the <a href="#uri.aspect_filter">aspect_filter</a> parameter. </li> </ul></p> <p>For details and examples of these capabilities, see <a href="/api-docs/buy/static/api-browse.html">Browse API</a> in the Buying Integration Guide.</p> <h3><b>Pagination and sort controls</b></h3> <p>There are pagination controls (<b>limit</b> and <b>offset</b> fields) and <b> sort</b> query parameters that control/sort the data that is returned. By default, the results are sorted by &quot;Best Match&quot;. For more information about Best Match, see the eBay help page <a href="https://pages.ebay.com/help/sell/searchstanding.html" target="_blank">Best Match</a>. </p> <h3><b> URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item_summary/search_by_image?</code></li> <li><b> Sandbox URL: </b>Due to the data available, this method is not supported in the eBay Sandbox. To test your integration, use the Production URL.</li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b>URL Encoding for Parameters</b></h3> <p>Query parameter values need to be URL encoded. For details, see <a href="/api-docs/static/rest-request-components.html#parameters">URL encoding query parameter values</a>. For readability, code examples in this document have not been URL encoded.</p> <h3><b>Restrictions </b></h3> <p>This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network: </b> In order to receive a commission for your sales, you must use the URL returned in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the ebay.com site. </span> */
12
6
  post: operations["searchByImage"];
13
7
  };
14
8
  "/item/{item_id}": {
15
- /** @description <p>This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery, and other information the buyer needs to make a purchasing decision.</p><p>The Buy APIs are designed to let you create an eBay shopping experience in your app or website. This means you will need to know when something, such as the availability, quantity, etc., has changed in any eBay item you are offering. You can do this easily by setting the <b> fieldgroups</b> URI parameter. This parameter lets you control what is returned in the response.</p> <p>Setting <b> fieldgroups</b> to <code>COMPACT</code> reduces the response to only the five fields that you need in order to check if any item detail has changed. Setting <b> fieldgroups</b> to <code>PRODUCT</code>, adds additional fields to the default response that return information about the product of the item. You can use either <code>COMPACT</code> or <code>PRODUCT</code> but not both. For more information, see <a href="/api-docs/buy/browse/resources/item/methods/getItem#uri.fieldgroups">fieldgroups</a>.</p> <h3>URLs for this method</h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item/{item_id}</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/item/{item_id}</code></li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b> Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network: </b> In order to be commissioned for your sales, you must use the URL returned in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the ebay.com site. </span> */
16
9
  get: operations["getItem"];
17
10
  };
18
11
  "/item/get_item_by_legacy_id": {
19
- /** @description <p>This method is a bridge between the eBay legacy APIs, such as <b> Shopping</b>, and <b> Finding</b> and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an "item" and what the item ID represents. This method lets you use the legacy item ids retrieve the details of a specific item, such as description, price, and other information the buyer needs to make a purchasing decision. It also returns the RESTful item ID, which you can use with all the Buy API methods.</p> <p>For more information about how to use legacy ids with the Buy APIs, see <a href="/api-docs/buy/static/api-browse.html#Legacy">Legacy API compatibility</a> in the Buying Integration guide.</p> <p>This method returns the item details and requires you to pass in either the item ID of a non-variation item or the item ids of both the parent and child of an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.</p> <p>When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.</p> <p>The <b> fieldgroups</b> URI parameter lets you control what is returned in the response. Setting <b> fieldgroups</b> to <code>PRODUCT</code>, adds additional fields to the default response that return information about the product of the item. For more information, see <a href="/api-docs/buy/browse/resources/item/methods/getItemByLegacyItem#uri.fieldgroups">fieldgroups</a>.</p> <h3>URLs for this method</h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item/get_item_by_legacy_id?</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/item/get_item_by_legacy_id?</code></li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b> Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network: </b> In order to be commissioned for your sales, you must use the URL returned in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the ebay.com site. </span> */
20
12
  get: operations["getItemByLegacyId"];
21
13
  };
22
14
  "/item/": {
23
- /** @description This method retrieves the details of specific items that the buyer needs to make a purchasing decision. <br><br><span class="tablenote"> <b>Note:</b> This is a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> available only to select Partners. <br><br>For this method, only the following fields are returned: <code>eligibleForInlineCheckout</code>, <code>estimatedAvailabilities</code>, <code>itemAffiliateWebUrl</code>, <code>itemId</code>, <code>itemWebUrl</code>, <code>legacyItemId</code>, <code>price</code>, <code>sellerItemRevision</code>, <code>taxes</code>, and <code>topRatedBuyingExperience</code>.</span> <h3>URLs for this method</h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item?</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/item?</code></li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b> Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network:</b> In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. */
24
15
  get: operations["getItems"];
25
16
  };
26
17
  "/item/get_items_by_item_group": {
27
- /** @description <p>This method retrieves the details of the individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. </p> <p>You pass in the item group ID as a URI parameter. You use this method to show the item details of items with multiple aspects, such as color, size, storage capacity, etc. </p> <p>This method returns two main containers; <b> items</b> and <b> commonDescriptions</b>. The <b> items</b> container has an array of containers with the details of each item in the group. The <b> commonDescriptions</b> container has an array of containers for a description and the item ids of all the items that have this exact description. Because items within an item group often have the same description, this decreases the size of the response. </p> <h3>URLs for this method</h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/item/get_items_by_item_group?</code></li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b> Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network: </b> In order to be commissioned for your sales, you must use the URL returned in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the ebay.com site. </span> */
28
18
  get: operations["getItemsByItemGroup"];
29
19
  };
30
20
  "/item/{item_id}/check_compatibility": {
31
- /** @description This method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay. <br /><br />For example, to check the compatibility of a part, you pass in the item ID of the part as a URI parameter and specify all the attributes used to define a specific car in the <b> compatibilityProperties</b> container. If the call is successful, the response will be <b> COMPATIBLE</b>, <b> NOT_COMPATIBLE</b>, or <b> UNDETERMINED</b>. See <a href="/api-docs/buy/browse/resources/item/methods/checkCompatibility#response.compatibilityStatus">compatibilityStatus</a> for details. <br /><br /> <span class="tablenote"><b> Note: </b> The only products supported are cars, trucks, and motorcycles. </span><p> To find the attributes and values for a specific marketplace, you can use the compatibility methods in the <a href="/api-docs/commerce/taxonomy/resources/methods">Taxonomy API</a>. You can use this data to create menus to help buyers specify the product, such as their car.</p> <p> For more details and a list of the required attributes for the US marketplace that describe motor vehicles, see <a href="/api-docs/buy/static/api-browse.html#Check">Check compatibility</a> in the Buy Integration Guide</a>.</p> <p>For an example, see the <a href="/api-docs/buy/browse/resources/item/methods/checkCompatibility#h2-samples">Samples</a> section. </p> <h3>URLs for this method</h3> <p><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item/{item_id}/check_compatibility</code> </p> <p><span class="tablenote"><b> Note: </b> This method is supported only on Production. </span></p> <h3><b> Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> */
32
21
  post: operations["checkCompatibility"];
33
22
  };
34
23
  "/shopping_cart/add_item": {
35
- /** @description <span class="tablenote"><b>Note: </b><img src="/cms/img/docs/experimental-icon.svg" class="legend-icon experimental-icon" alt="Experimental Release" title="Experimental Release" alt="Experimental Release" title="Experimental Release" /> This is an <a href="https://developer.ebay.com/api-docs/static/versioning.html#experimental">Experimental</a> method that is available as a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> to select developers approved by business units.</span> <p>This method creates an eBay cart for the eBay member, if one does not exist, and adds items to that cart. Because a cart never expires, any item added to the cart will remain in the cart until it is removed. <br /><br />To use this method, you must submit a RESTful item ID and the quantity of the item. If the <b> quantity</b> value is greater than the number of available, the <b> quantity</b> value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the <b> quantity</b> value to 50, the service automatically changes the value of <b>quantity</b> to 15. <br /><br />The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, whether it has just been added to the cart or has been in the cart for some time, the item will be returned in the <b> unavailableCartItems</b> container.</p> <p span class="tablenote"><b>Note: </b>There are differences between how legacy APIs, such as Finding, and RESTful APIs, such as Browse, return the identifier of an "item" and what the item ID represents. If you have an item ID from one of the legacy APIs, you can use the legacy item ID with the <a href="/api-docs/buy/browse/resources/item/methods/getItemByLegacyId"> getItemByLegacyId</a> method to retrieve the RESTful ID for that item. For more information about how to use legacy IDs with the Buy APIs, see <a href="/api-docs/buy/static/api-browse.html#Legacy">Legacy API compatibility</a> in the Buying Integration guide.</p> <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/shopping_cart/add_item</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/add_item</code> <br /><br /><b>Note: </b>This method is not available in the eBay API Explorer.</li> </ul> </p> <h3><b>Restrictions </b></h3> <ul> <li>This method can be used only for eBay members.</li> <li>You can add only items with a FIXED_PRICE that accept PayPal as a payment. </li> </ul> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> */
36
24
  post: operations["addItem"];
37
25
  };
38
26
  "/shopping_cart/": {
39
- /** @description <span class="tablenote"><b>Note: </b><img src="/cms/img/docs/experimental-icon.svg" class="legend-icon experimental-icon" alt="Experimental Release" title="Experimental Release" /> This is an <a href="https://developer.ebay.com/api-docs/static/versioning.html#experimental">experimental</a> method that is available as a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> to select developers approved by business units.</span> <p>This method retrieves all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. There are no URI parameters or request payload. <br /><br />The response returns the summary details of all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If the cart is empty, the response is HTTP 204. </p> <br /><br /> The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, the item will be returned in the <b> unavailableCartItems</b> container. <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/shopping_cart/</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/</code> <br /><br /><b>Note: </b>This method is not available in the eBay API Explorer.</li> </ul> </p> <h3><b>Restrictions </b></h3> <p>This method can be used only for eBay members. For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> */
40
27
  get: operations["getShoppingCart"];
41
28
  };
42
29
  "/shopping_cart/remove_item": {
43
- /** @description <span class="tablenote"><b>Note: </b><img src="/cms/img/docs/experimental-icon.svg" class="legend-icon experimental-icon" alt="Experimental Release" title="Experimental Release" /> This is an <a href="https://developer.ebay.com/api-docs/static/versioning.html#experimental">experimental</a> method that is available as a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> to select developers approved by business units.</span> <p>This method removes a specific item from the eBay member's cart. You specify the ID of the item in the cart (<b>cartItemId</b>) that you want to remove. <br /><br />The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If you remove the last item in the cart, the response is HTTP 204.<br /><br /> The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, the item will be returned in the <b> unavailableCartItems</b> container.</p> <p span class="tablenote"><b>Note: </b> The <b> cartItemId</b> is not the same as the item ID. The <b> cartItemId</b> is the identifier of a specific item <i>in</i> the cart and is generated when the item was added to the cart.</span></p> <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/shopping_cart/remove_item</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/remove_item</code> <br /><br /><b>Note: </b>This method is not available in the eBay API Explorer.</li> </ul> </p> <h3><b>Restrictions </b></h3> <p>This method can be used only for eBay members. For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> */
44
30
  post: operations["removeItem"];
45
31
  };
46
32
  "/shopping_cart/update_quantity": {
47
- /** @description <span class="tablenote"><b>Note: </b><img src="/cms/img/docs/experimental-icon.svg" class="legend-icon experimental-icon" alt="Experimental Release" title="Experimental Release" /> This is an <a href="https://developer.ebay.com/api-docs/static/versioning.html#experimental">experimental</a> method that is available as a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> to select developers approved by business units.</span> <p>This method updates the quantity value of a specific item in the eBay member's cart. You specify the ID of the item in the cart (<b>cartItemId</b>) and the new value for the quantity. If the <b> quantity</b> value is greater than the number of available, the <b> quantity</b> value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the <b> quantity</b> value to 50, the service automatically changes the value of <b>quantity</b> to 15. <br /><br />The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes "unavailable" such as, the listing has ended or the item is out of stock, the item will be returned in the <b> unavailableCartItems</b> container.</p> <p span class="tablenote"><b>Note: </b> The <b> cartItemId</b> is not the same as the item ID. The <b> cartItemId</b> is the identifier of a specific item <i>in</i> the cart and is generated when the item was added to the cart.</span></p> <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/shopping_cart/update_quantity</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/update_quantity</code> <br /><br /><b>Note: </b>This method is not available in the eBay API Explorer.</li> </ul> </p> <h3><b>Restrictions </b></h3> <p>This method can be used only for eBay members. For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> */
48
33
  post: operations["updateQuantity"];
49
34
  };
50
35
  }
51
36
  export type webhooks = Record<string, never>;
52
37
  export interface components {
53
38
  schemas: {
54
- /** @description The type that defines the fields for the <b>addItems</b> request. */
55
39
  AddCartItemInput: {
56
- /** @description The eBay RESTful identifier of the item you want added to the cart. <br /><br /> <b>RESTful Item ID Format: </b><code>v1</code>|<code><i>#</i></code>|<code><i>#</i></code> <br /><b> For example: </b> <br /><code>v1|2**********2|0</code> <br /><code>v1|1**********2|4**********2</code> <br /><br />For more information about item ID for RESTful APIs, see the <a href="/api-docs/buy/static/api-browse.html#Legacy">Legacy API compatibility</a> section of the <i>Buy APIs Overview</i>.<br /><br /><b> Maximum number of items in a cart: </b> 100 */
57
40
  itemId?: string;
58
- /**
59
- * Format: int32
60
- * @description The number of this item the buyer wants to purchase. If this value is greater than the number available, the service will change this value to the number available. If this happens, a warning is returned.<br /><br /><b> Maximum: </b> <i>number available</i>
61
- */
62
41
  quantity?: number;
63
42
  };
64
- /** @description The type that defines the array of product identifiers associated with the item. This container is returned if the seller has associated the eBay Product Identifier (ePID) with the item and in the request <b> fieldgroups</b> is set to <code>PRODUCT</code>. */
65
43
  AdditionalProductIdentity: {
66
- /** @description An array of the product identifier/value pairs for the product associated with the item. This is returned if the seller has associated the eBay Product Identifier (ePID) with the item and the request has <b> fieldgroups</b> set to <code>PRODUCT</code>. <br /><br />The following table shows what is returned, based on the item information provided by the seller, when the <b> fieldgroups</b> set to <code>PRODUCT</code>. <br /><br /><div style="overflow-x:auto;"> <table border=1> <tr> <th> ePID Provided </th> <th> Product&nbsp;ID(s) Provided</th> <th> Response</th> </tr> <tr> <td> No </td> <td> No </td> <td> The <b> AdditionalProductIdentity</b> container is <i> not</i> returned.</td></tr> <tr> <td> No </td> <td> Yes </td> <td> The <b> AdditionalProductIdentity</b> container is <i> not</i> returned but the product identifiers specified by the seller are returned in the <b> localizedAspects</b> container. </td> </tr> <tr> <td> Yes </td> <td> No </td> <td> The <b> AdditionalProductIdentity</b> container is returned listing the product identifiers of the product.</td></tr> <tr> <td> Yes </td> <td> Yes </td> <td> The <b> AdditionalProductIdentity</b> container is returned listing all the product identifiers of the product and the product identifiers specified by the seller are returned in the <b> localizedAspects</b> container.</td> </tr> </table> </div> */
67
44
  productIdentity?: (components["schemas"]["ProductIdentity"])[];
68
45
  };
69
- /** @description The type that defines the fields for an address. */
70
46
  Address: {
71
- /** @description The first line of the street address. <b> Note: </b> This is conditionally returned in the <b> itemLocation</b> field. */
72
47
  addressLine1?: string;
73
- /** @description The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'. */
74
48
  addressLine2?: string;
75
- /** @description The city of the address. */
76
49
  city?: string;
77
- /** @description The two-letter <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166</a> standard of the country of the address. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay API documentation</a> */
78
50
  country?: string;
79
- /** @description The county of the address. */
80
51
  county?: string;
81
- /** @description The postal code (or zip code in US) code of the address. Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in <b>itemLocation.postalCode</b> via the API. */
82
52
  postalCode?: string;
83
- /** @description The state or province of the address. <b> Note: </b> This is conditionally returned in the <b> itemLocation</b> field. */
84
53
  stateOrProvince?: string;
85
54
  };
86
55
  Amount: {
87
- /** @description The list of valid currencies. Each <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> currency code includes the currency name followed by the numeric value.<br /><br />For example, the Canadian Dollar code (CAD) would take the following form: <i>Canadian Dollar, 124</i>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CurrencyCodeEnum'>eBay API documentation</a> */
88
56
  currency?: string;
89
- /** @description The value of the discounted amount. */
90
57
  value?: string;
91
58
  };
92
- /** @description The type that defines the fields for the name/value pairs for the aspects of the product. For example: BRAND/Apple */
93
59
  Aspect: {
94
- /** @description The text representing the name of the aspect for the name/value pair, such as Brand. */
95
60
  localizedName?: string;
96
- /** @description The text representing the value of the aspect for the name/value pair, such as Apple. */
97
61
  localizedValues?: (string)[];
98
62
  };
99
- /** @description The type that define the fields for the aspect information. Aspects are the variations of an item, such as color, size, etc. */
100
63
  AspectDistribution: {
101
- /** @description An array of containers for the various values of the aspect and the match count and a HATEOAS reference (<b> refinementHref</b>) for this aspect. */
102
64
  aspectValueDistributions?: (components["schemas"]["AspectValueDistribution"])[];
103
- /** @description The name of an aspect, such as Brand, Color, etc. */
104
65
  localizedAspectName?: string;
105
66
  };
106
67
  AspectGroup: {
107
- /** @description An array of the name/value pairs for the aspects of the product. For example: BRAND/Apple */
108
68
  aspects?: (components["schemas"]["Aspect"])[];
109
- /** @description The name of a group of aspects. <br /><br />In the following example, <b> Product Identifiers</b> and <b> Process</b> are product aspect group names. Under the group name are the product aspect name/value pairs. <p><b> Product Identifiers</b> <br />&nbsp;&nbsp;&nbsp;Brand/Apple <br />&nbsp;&nbsp;&nbsp;Product Family/iMac</p> <p><b> Processor</b><br />&nbsp;&nbsp;&nbsp;Processor Type/Intel <br />&nbsp;&nbsp;&nbsp;Processor Speed/3.10</p> */
110
69
  localizedGroupName?: string;
111
70
  };
112
- /** @description The container that defines the fields for the conditions refinements. This container is returned when <b> fieldgroups</b> is set to <code>ASPECT_REFINEMENTS</code> or <code>FULL</code> in the request. */
113
71
  AspectValueDistribution: {
114
- /** @description The value of an aspect. For example, Red is a value for the aspect Color. */
115
72
  localizedAspectValue?: string;
116
- /**
117
- * Format: int32
118
- * @description The number of items with this aspect.
119
- */
120
73
  matchCount?: number;
121
- /** @description A HATEOAS reference for this aspect. */
122
74
  refinementHref?: string;
123
75
  };
124
- /** @description The type the defines attribute name/value pair fields that specify a product. The type of data depends on the context. For example, if you were using this to specify a specific vehicle, the attribute names would be Make, Model, Year, etc. */
125
76
  AttributeNameValue: {
126
- /** @description The name of the product attribute, such as Make, Model, Year, etc. */
127
77
  name?: string;
128
- /** @description The value for the <b> name</b> attribute, such as BMW, R1200GS, 2011, etc. */
129
78
  value?: string;
130
79
  };
131
- /** @description A type that identifies whether the item is qualified for the Authenticity Guarantee program. */
132
80
  AuthenticityGuaranteeProgram: {
133
- /** @description An indication that the item is qualified for the Authenticity Guarantee program. */
134
81
  description?: string;
135
- /** @description The URL to the Authenticity Guarantee program terms of use. */
136
82
  termsWebUrl?: string;
137
83
  };
138
- /** @description A type that identifies whether the item is from a verified seller. */
139
84
  AuthenticityVerificationProgram: {
140
- /** @description An indication that the item is from a verified seller. */
141
85
  description?: string;
142
- /** @description The URL to the Authenticity Verification program terms of use. */
143
86
  termsWebUrl?: string;
144
87
  };
145
88
  AutoCorrections: {
146
- /** @description The automatically spell-corrected keyword from the request. */
147
89
  q?: string;
148
90
  };
149
91
  AvailableCoupon: {
150
- /** @description The limitations or restrictions of the coupon. */
151
92
  constraint?: components["schemas"]["CouponConstraint"];
152
- /** @description The discount amount after the coupon is applied. */
153
93
  discountAmount?: components["schemas"]["Amount"];
154
- /** @description The type of discount that the coupon applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:CouponDiscountType'>eBay API documentation</a> */
155
94
  discountType?: string;
156
- /** @description A description of the coupon.<br /><br /><span class="tablenote"><b> Note: </b> The value returned in the <b>termsWebUrl</b> field should appear for all experiences when displaying coupons. The value in the <b>availableCoupons.message</b> field must also be included, if returned in the API response.</span> */
157
95
  message?: string;
158
- /** @description The coupon code. */
159
96
  redemptionCode?: string;
160
- /** @description The URL to the coupon terms of use.<br /><br /><span class="tablenote"><b> Note: </b> The value returned in the <b>termsWebUrl</b> field should appear for all experiences when displaying coupons. The value in the <b>availableCoupons.message</b> field must also be included, if returned in the API response.</span> */
161
97
  termsWebUrl?: string;
162
98
  };
163
- /** @description The container that defines the fields for the buying options refinements. This container is returned when <b> fieldgroups</b> is set to <code>BUYING_OPTION_REFINEMENTS</code> or <code>FULL</code> in the request. */
164
99
  BuyingOptionDistribution: {
165
- /** @description The container that returns the buying option type. This will be AUCTION or FIXED_PRICE or both. For details, see <a href="/api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.buyingOptions">buyingOptions</a>. */
166
100
  buyingOption?: string;
167
- /**
168
- * Format: int32
169
- * @description The number of items having this buying option.
170
- */
171
101
  matchCount?: number;
172
- /** @description The HATEOAS reference for this buying option. */
173
102
  refinementHref?: string;
174
103
  };
175
- /** @description The type that defines the fields for the individual items in a cart. */
176
104
  CartItem: {
177
- /** @description The identifier for the item being added to the cart. This is generated when the item is added to the cart. */
178
105
  cartItemId?: string;
179
- /** @description This is the subtotal of cost of a specific item in the cart. This does not include taxes, shipping costs, discounts, etc. It is <b> price</b> * <b> quantity</b>. */
180
106
  cartItemSubtotal?: components["schemas"]["Amount"];
181
- /** @description The primary image of the item. This is the image that appears on the eBay view item page for this item. */
182
107
  image?: components["schemas"]["Image"];
183
- /** @description The RESTful identifier of the item. This identifier is generated when the item was listed. <br /><br /> <b>RESTful Item ID Format: </b><code>v1</code>|<code><i>#</i></code>|<code><i>#</i></code> <br /><b> For example: </b><br /> <code>v1|2**********2|0</code> <br /><code>v1|1**********2|4**********2</code> */
184
108
  itemId?: string;
185
- /** @description The URL of the eBay view item page for the item. */
186
109
  itemWebUrl?: string;
187
- /** @description The cost of the item. */
188
110
  price?: components["schemas"]["Price"];
189
- /**
190
- * Format: int32
191
- * @description The number of this item the buyer wants to purchase.
192
- */
193
111
  quantity?: number;
194
- /** @description The title of the item. This can be written by the seller or come from the eBay product catalog. */
195
112
  title?: string;
196
113
  };
197
- /** @description This type is used by the <b> categories</b> container in the response of the <b> search</b> method, and contains the primary item category ID of the item, as well as the secondary item category if the item was listed in two categories. */
198
114
  Category: {
199
- /** @description The unique identifier of the primary item category of the item, as well as the secondary item category if item was listed in two categories. */
200
115
  categoryId?: string;
201
116
  };
202
- /** @description The container that defines the fields for the category refinements. This container is returned when <b> fieldgroups</b> is set to <code>CATEGORY_REFINEMENTS</code> or <code>FULL</code> in the request. */
203
117
  CategoryDistribution: {
204
- /** @description The identifier of the category. */
205
118
  categoryId?: string;
206
- /** @description The name of the category, such as Baby & Toddler Clothing. */
207
119
  categoryName?: string;
208
- /**
209
- * Format: int32
210
- * @description The number of items in this category.
211
- */
212
120
  matchCount?: number;
213
- /** @description The HATEOAS reference of this category. */
214
121
  refinementHref?: string;
215
122
  };
216
- /** @description The type that defines the fields for the item ids that all use a common description. Often the item variations within an item group all have the same description. Instead of repeating this description in the item details of each item, a description that is shared by at least one other item is returned in this container. If the description is unique, it is returned in the <b> items.description</b> field. */
217
123
  CommonDescriptions: {
218
- /** @description The item description that is used by more than one of the item variations. */
219
124
  description?: string;
220
- /** @description A list of item ids that have this description. */
221
125
  itemIds?: (string)[];
222
126
  };
223
- /** @description An array of attribute name/value pairs used to define a specific product. For example: If you wanted to specify a specific car, one of the name/value pairs would be <br /><code>"name" : "Year", <br />"value" : "2019"</code> <p> For a list of the attributes required for cars and trucks and motorcycles see <a href="/api-docs/buy/static/api-browse.html#Check">Check compatibility</a> in the Buy Integration Guide.</p> */
224
127
  CompatibilityPayload: {
225
- /** @description An array of attribute name/value pairs used to define a specific product. For example: If you wanted to specify a specific car, one of the name/value pairs would be <br /><code>"name" : "Year", <br />"value" : "2019"</code> <p> For a list of the attributes required for cars and trucks and motorcycles see <a href="/api-docs/buy/static/api-browse.html#Check">Check compatibility</a> in the Buy Integration Guide.</p> */
226
128
  compatibilityProperties?: (components["schemas"]["AttributeNameValue"])[];
227
129
  };
228
- /** @description This container returns the product attribute name/value pairs that are compatible with the keyword. These attributes are submitted in the <b>compatibility_filter</b> request field. */
229
130
  CompatibilityProperty: {
230
- /** @description The name of the product attribute that as been translated to the language of the site. */
231
131
  localizedName?: string;
232
- /** @description The name of the product attribute, such as Make, Model, Year, etc. */
233
132
  name?: string;
234
- /** @description The value for the <b> name</b> attribute, such as BMW, R1200GS, 2011, etc. */
235
133
  value?: string;
236
134
  };
237
- /** @description The type that defines the response fields for <b> checkCompatibility</b>. */
238
135
  CompatibilityResponse: {
239
- /** @description An enumeration value that tells you if the item is compatible with the product. <br /><br />The values are: <ul> <li> <b> COMPATIBLE</b> - Indicates the item is compatible with the product specified in the request.</li> <li> <b> NOT_COMPATIBLE</b> - Indicates the item is not compatible with the product specified in the request. Be sure to check all the <b> value</b> fields to ensure they are correct as errors in the value can also cause this response.</li> <li> <b> UNDETERMINED</b> - Indicates one or more attributes for the specified product are missing so compatibility cannot be determined. The response returns the attributes that are missing.</li> </ul> Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:CompatibilityStatus'>eBay API documentation</a> */
240
136
  compatibilityStatus?: string;
241
- /** @description An array of warning messages. These types of errors do not prevent the method from executing but should be checked. */
242
137
  warnings?: (components["schemas"]["Error"])[];
243
138
  };
244
- /** @description The container that defines the fields for the conditions refinements. This container is returned when <b> fieldgroups</b> is set to <code>CONDITION_REFINEMENTS</code> or <code>FULL</code> in the request. */
245
139
  ConditionDistribution: {
246
- /** @description The text describing the condition of the item, such as New or Used. For a list of condition names, see <a href="https://developer.ebay.com/devzone/finding/callref/enums/conditionIdList.html" target="_blank">Item Condition IDs and Names</a>. <br /><br />Code so that your app gracefully handles any future changes to this list.<br /><br /><span class="tablenote"><b> Note: </b>As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the <b>Cell Phones & Smartphones</b> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).</span> */
247
140
  condition?: string;
248
- /** @description The identifier of the condition. For example, 1000 is the identifier for NEW.<br /><br /><span class="tablenote"><b> Note: </b>As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the <b>Cell Phones & Smartphones</b> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).</span> */
249
141
  conditionId?: string;
250
- /**
251
- * Format: int32
252
- * @description The number of items having the condition.
253
- */
254
142
  matchCount?: number;
255
- /** @description The HATEOAS reference of this condition. */
256
143
  refinementHref?: string;
257
144
  };
258
- /** @description This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the conversion of that value into another currency, if applicable. */
259
145
  ConvertedAmount: {
260
- /** @description The three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> code representing the currency of the amount in the <b> convertedFromValue</b> field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CurrencyCodeEnum'>eBay API documentation</a> */
261
146
  convertedFromCurrency?: string;
262
- /** @description The monetary amount before any conversion is performed, in the currency specified by the <b> convertedFromCurrency</b> field. This value is required or returned only if currency conversion/localization is required. The <b> value</b> field contains the converted amount of this value, in the currency specified by the <b> currency</b> field. */
263
147
  convertedFromValue?: string;
264
- /** @description The three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> code representing the currency of the amount in the <b> value</b> field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the <b> value</b> field. <br /><br /><b> Default:</b> The currency of the authenticated user's country. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CurrencyCodeEnum'>eBay API documentation</a> */
265
148
  currency?: string;
266
- /** @description The monetary amount, in the currency specified by the <b> currency</b> field. If currency conversion/localization is required, this value is the converted amount, and the <b> convertedFromValue</b> field contains the amount in the original currency. */
267
149
  value?: string;
268
150
  };
269
- /** @description An array of containers with the details for all of the items returned. */
270
151
  CoreItem: {
271
- /** @description An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the <b> image.imageUrl</b> field. */
272
152
  additionalImages?: (components["schemas"]["Image"])[];
273
- /** @description This indicates if the item is for adults only. For more information about adult-only items on eBay, see <a href="https://pages.ebay.com/help/policies/adult-only.html" target="_blank">Adult items policy</a> for sellers and <a href="https://www.ebay.com/help/terms-conditions/default/searching-adult-items?id=4661" target="_blank">Adult-Only items on eBay</a> for buyers. */
274
153
  adultOnly?: boolean;
275
- /** @description (Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
276
154
  ageGroup?: string;
277
- /** @description A container for information about whether an item is qualified for the Authenticity Guarantee program.<br /><br />Under the Authenticity Guarantee program, the seller ships a purchased item to a a third-party authenticator who inspects the item and provides an authentication card for it before the item is shipped to the buyer. If the buyer returns the item, the authenticator first verifies that it is the same item in the same condition before returning it to the seller.<br /><br /><span class="tablenote"><b> Note: </b>Refer to the <a href="https://pages.ebay.com/authenticity-guarantee/" target="_blank">Authenticity Guarantee</a> page for more information.</span> */
278
155
  authenticityGuarantee?: components["schemas"]["AuthenticityGuaranteeProgram"];
279
- /** @description A container for information about whether an item is from a verified seller.</span> */
280
156
  authenticityVerification?: components["schemas"]["AuthenticityVerificationProgram"];
281
- /** @description A list of available coupons for the item. */
282
157
  availableCoupons?: (components["schemas"]["AvailableCoupon"])[];
283
- /**
284
- * Format: int32
285
- * @description This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.
286
- */
287
158
  bidCount?: number;
288
- /** @description (Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
289
159
  brand?: string;
290
- /** @description A comma separated list of all the purchase options available for the item. The values returned are: <ul> <li><code>FIXED_PRICE</code> - Indicates the buyer can purchase the item for a set price using the Buy It Now button. </li> <li><code>AUCTION</code> - Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.</li> <li><code>BEST_OFFER</code> - Indicates the buyer can send the seller a price they're willing to pay for the item. The seller can accept, reject, or send a counter offer. For more information on how this works, see <a href="https://www.ebay.com/help/buying/buy-now/making-best-offer?id=4019">Making a Best Offer</a>.</li> </ul> Code so that your app gracefully handles any future changes to this list. */
291
160
  buyingOptions?: (string)[];
292
- /** @description The ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children. */
293
161
  categoryId?: string;
294
- /** @description Text that shows the category hierarchy of the item. For example: Computers/Tablets &amp; Networking, Laptops &amp; Netbooks, PC Laptops &amp; Netbooks */
295
162
  categoryPath?: string;
296
- /** @description (Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
297
163
  color?: string;
298
- /** @description A short text description for the condition of the item, such as New or Used. For a list of condition names, see <a href="https://developer.ebay.com/devzone/finding/callref/enums/conditionIdList.html" target="_blank">Item Condition IDs and Names</a>. <br /><br />Code so that your app gracefully handles any future changes to this list. <br /><br /><span class="tablenote"><b> Note: </b>As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the <b>Cell Phones & Smartphones</b> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).</span> */
299
164
  condition?: string;
300
- /** @description A full text description for the condition of the item. This field elaborates on the value specified in the <b>condition</b> field and provides full details for the condition of the item. <br /><br /><span class="tablenote"><b> Note: </b>As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the <b>Cell Phones & Smartphones</b> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).</span> */
301
165
  conditionDescription?: string;
302
- /** @description The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see <a href="https://developer.ebay.com/devzone/finding/callref/enums/conditionIdList.html" target="_blank">Item Condition IDs and Names</a>. <br /><br />Code so that your app gracefully handles any future changes to this list. <br /><br /><span class="tablenote"><b> Note: </b>As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the <b>Cell Phones & Smartphones</b> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).</span> */
303
166
  conditionId?: string;
304
- /** @description The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items. */
305
167
  currentBidPrice?: components["schemas"]["ConvertedAmount"];
306
- /** @description The full description of the item that was created by the seller. This can be plain text or rich content and can be very large. */
307
168
  description?: string;
308
- /** @description This field indicates if the item can be purchased using the Buy <a href="/api-docs/buy/order/resources/methods">Order API</a>. <ul> <li>If the value of this field is <code>true</code>, this indicates that the item can be purchased using the <b> Order API</b>. </li> <li>If the value of this field is <code>false</code>, this indicates that the item cannot be purchased using the <b> Order API</b> and must be purchased on the eBay site.</li> </ul> */
309
169
  eligibleForInlineCheckout?: boolean;
310
- /** @description This indicates if the item can be purchased using Guest Checkout in the <a href="/api-docs/buy/order/resources/methods">Order API</a>. You can use this flag to exclude items from your inventory that are not eligible for Guest Checkout, such as gift cards. */
311
170
  enabledForGuestCheckout?: boolean;
312
- /** @description This indicates the <a href="https://en.wikipedia.org/wiki/European_Union_energy_label">European energy efficiency</a> rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating. <br /><br />The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models. <br /><br />When the manufacturer's specifications for this item are available, the link to this information is returned in the <b> productFicheWebUrl</b> field. */
313
171
  energyEfficiencyClass?: string;
314
- /** @description An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs. */
315
172
  epid?: string;
316
- /** @description The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned. */
317
173
  estimatedAvailabilities?: (components["schemas"]["EstimatedAvailability"])[];
318
- /** @description (Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
319
174
  gender?: string;
320
- /** @description The unique Global Trade Item number of the item as defined by <a href="https://www.gtin.info" target="_blank">https://www.gtin.info</a>. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value. */
321
175
  gtin?: string;
322
- /** @description The URL of the primary image of the item. The other images of the item are returned in the <b> additionalImages</b> container. */
323
176
  image?: components["schemas"]["Image"];
324
- /** @description The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. <br /><br />If the seller provided an ePID for the item, the seller's value is returned in the <b> epid</b> field. <br /><br /><span class="tablenote"><b> Note: </b> This field is returned only for authorized Partners.</span> */
325
177
  inferredEpid?: string;
326
- /** @description The URL of the View Item page of the item, which includes the affiliate tracking ID. This field is only returned if the eBay partner enables affiliate tracking for the item by including the <a href="/api-docs/buy/static/api-browse.html#Headers"><code>X-EBAY-C-ENDUSERCTX</code></a> request header in the method. <br /> <br /><span class="tablenote"><b>Note: </b> eBay Partner Network, in order to be commissioned for your sales, you must use this URL to forward your buyer to the ebay.com site. </span> */
327
178
  itemAffiliateWebUrl?: string;
328
- /** @description This timestamp indicates the date and time up to which the item can be purchased. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.<br /><br /><span class="tablenote"><b> Note: </b>This field is only returned for auction listings.</span> */
329
179
  itemEndDate?: string;
330
- /** @description The unique RESTful identifier of the item. */
331
180
  itemId?: string;
332
- /** @description The physical location of the item. */
333
181
  itemLocation?: components["schemas"]["Address"];
334
- /** @description The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay. */
335
182
  itemWebUrl?: string;
336
- /** @description The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page. */
337
183
  legacyItemId?: string;
338
- /** @description An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item. */
339
184
  localizedAspects?: (components["schemas"]["TypedNameValue"])[];
340
- /**
341
- * Format: int32
342
- * @description The number of items in a lot. In other words, a lot size is the number of items that are being sold together. <br /><br />A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below. <br /><br /><table border="1"> <tr> <tr> <th>Item</th> <th>Lot Definition</th> <th>Lot Size</th></tr> <tr> <td>A package of 24 AA batteries</td> <td>A box of 10 packages</td> <td>10 </td> </tr> <tr> <td>A P235/75-15 Goodyear tire </td> <td>4 tires </td> <td>4 </td> </tr> <tr> <td>Fashion Jewelry Rings </td> <td>Package of 100 assorted rings </td> <td>100 </td> </tr></table> <br /><br /><span class="tablenote"><b>Note: </b> Lots are not supported in all categories. </span>
343
- */
344
185
  lotSize?: number;
345
- /** @description The original price and the discount amount and percentage. */
346
186
  marketingPrice?: components["schemas"]["MarketingPrice"];
347
- /** @description (Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
348
187
  material?: string;
349
- /** @description The minimum price of the next bid, which means to place a bid it must to equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see <a href="https://www.ebay.com/help/buying/bidding/automatic-bidding?id=4014">Automatic bidding</a>. */
350
188
  minimumPriceToBid?: components["schemas"]["ConvertedAmount"];
351
- /** @description The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand. */
352
189
  mpn?: string;
353
- /** @description (Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
354
190
  pattern?: string;
355
- /** @description The payment methods for the item, including the payment method types, brands, and instructions for the buyer. */
356
191
  paymentMethods?: (components["schemas"]["PaymentMethod"])[];
357
- /** @description The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs.<br /><br /><span class="tablenote"><b> Note: </b>The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the <a href="/api-docs/static/rest-request-components.html#HTTP"><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying the supported marketplace (such as <code>EBAY_GB</code>) to see the VAT-inclusive pricing. For more information on VAT, refer to <a href="https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650&st=12&pos=1&query=Your%20VAT%20obligations%20in%20the%20EU&intent=VAT">VAT Obligations in the EU</a>.</span> */
358
192
  price?: components["schemas"]["ConvertedAmount"];
359
- /** @description Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PriceDisplayConditionEnum'>eBay API documentation</a> */
360
193
  priceDisplayCondition?: string;
361
- /** @description The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. <br /><br />When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.<br /><br /><span class="tablenote"><b> Note: </b> This container is returned if the <b> item_id</b> in the request is for an item group (items with variations, such as color and size). This container is also returned on a request for <b> item_group_ids</b>.</span> */
362
194
  primaryItemGroup?: components["schemas"]["ItemGroupSummary"];
363
- /** @description The container that returns the product rating details, such as review count, rating histogram, and average rating. */
364
195
  primaryProductReviewRating?: components["schemas"]["ReviewRating"];
365
- /** @description This field is returned as <code>true</code> if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.<br /><br />For more information, see <a href="https://pages.ebay.com/seller-center/listing-and-marketing/promoted-listings.html" target="_blank">Promoted Listings</a>. */
366
196
  priorityListing?: boolean;
367
- /** @description The container that returns the product information of the item. */
368
197
  product?: components["schemas"]["Product"];
369
- /** @description The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for <em> all</em> items with an EEK rating and is returned only if this information is available. The EEK rating of the item is returned in the <b> energyEfficiencyClass</b> field. */
370
198
  productFicheWebUrl?: string;
371
- /** @description An array of the qualified programs available for the item, such as EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.<br /><br />eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.<br /><br /><span class="tablenote"><b>Note: </b> eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.</span><br /><br />The eBay <a href="https://pages.ebay.com/authenticity-guarantee/" target="_blank">Authenticity Guarantee</a> program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers. */
372
199
  qualifiedPrograms?: (string)[];
373
- /**
374
- * Format: int32
375
- * @description The maximum number for a specific item that one buyer can purchase.
376
- */
377
200
  quantityLimitPerBuyer?: number;
378
- /** @description This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for. <p>If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold.</p> <p><b> Note: </b>This is returned only for auctions that have a reserve price.</p> */
379
201
  reservePriceMet?: boolean;
380
- /** @description The container that returns an overview of the seller's return policy. */
381
202
  returnTerms?: components["schemas"]["ItemReturnTerms"];
382
- /** @description The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information. */
383
203
  seller?: components["schemas"]["SellerDetail"];
384
- /** @description An identifier generated/incremented when a seller revises the item. There are two types of item revisions: <ul><li>Seller changes, such as changing the title</li> <li>eBay system changes, such as changing the quantity when an item is purchased</li></ul> This ID is changed <em> only</em> when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed. */
385
204
  sellerItemRevision?: string;
386
- /** @description An array of shipping options containers that have the details about cost, carrier, etc. of one shipping option. */
387
205
  shippingOptions?: (components["schemas"]["ShippingOption"])[];
388
- /** @description The container that returns the geographic regions to be included and excluded that define where the item can be shipped. */
389
206
  shipToLocations?: components["schemas"]["ShipToLocations"];
390
- /** @description This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.). */
391
207
  shortDescription?: string;
392
- /** @description (Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
393
208
  size?: string;
394
- /** @description (Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. <br /><br /><b> Valid Values: </b> <br />AU (Australia), <br />BR (Brazil), <br />CN (China), <br />DE (Germany), <br />EU (European Union), <br /> FR (France), <br /> IT (Italy), <br />JP (Japan), <br />MX (Mexico), <br />US (USA), <br /> UK (United Kingdom) <br /><br />Code so that your app gracefully handles any future changes to this list. */
395
209
  sizeSystem?: string;
396
- /** @description (Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
397
210
  sizeType?: string;
398
- /** @description A subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results. */
399
211
  subtitle?: string;
400
- /** @description The container for the tax information for the item. */
401
212
  taxes?: (components["schemas"]["Taxes"])[];
402
- /** @description The seller-created title of the item. <br><br><b> Maximum Length: </b> 80 characters */
403
213
  title?: string;
404
- /** @description This indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item; a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings. See the <a href="https://pages.ebay.com/topratedplus/index.html" target="_blank">Top Rated Plus Items </a> and <a href="https://pages.ebay.com/help/sell/top-rated.html target="_blank">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> help topics for more information. */
405
214
  topRatedBuyingExperience?: boolean;
406
- /** @description The URL to the image that shows the information on the tyre label. */
407
215
  tyreLabelImageUrl?: string;
408
- /**
409
- * Format: int32
410
- * @description This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items.
411
- */
412
216
  uniqueBidderCount?: number;
413
- /** @description This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices. <br /><br />For example: <br /><br /><code>"unitPricingMeasure": "100g",<br /> "unitPrice": {<br />&nbsp;&nbsp;"value": "7.99",<br />&nbsp;&nbsp;"currency": "GBP"</code> */
414
217
  unitPrice?: components["schemas"]["ConvertedAmount"];
415
- /** @description The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. <br /><br />For example, the following tells the buyer that the item is 7.99 per 100 grams. <br /><br /><code>"unitPricingMeasure": "100g",<br /> "unitPrice": {<br />&nbsp;&nbsp;"value": "7.99",<br />&nbsp;&nbsp;"currency": "GBP"</code> */
416
218
  unitPricingMeasure?: string;
417
219
  };
418
- /** @description This type is used to provide the expiration date of a coded coupon. */
419
220
  CouponConstraint: {
420
- /** @description This timestamp provides the expiration date of the coded coupon. */
421
221
  expirationDate?: string;
422
222
  };
423
- /** @description The type that defines the fields that can be returned in an error. */
424
223
  Error: {
425
- /** @description This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors. */
426
224
  category?: string;
427
- /** @description The name of the primary system where the error occurred. This is relevant for application errors. */
428
225
  domain?: string;
429
- /**
430
- * Format: int32
431
- * @description A unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
432
- */
433
226
  errorId?: number;
434
- /** @description An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any. */
435
227
  inputRefIds?: (string)[];
436
- /** @description A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem. */
437
228
  longMessage?: string;
438
- /** @description A description of the condition that caused the error or warning. */
439
229
  message?: string;
440
- /** @description An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any. */
441
230
  outputRefIds?: (string)[];
442
- /** @description An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning. */
443
231
  parameters?: (components["schemas"]["ErrorParameter"])[];
444
- /** @description The name of the subdomain in which the error or warning occurred. */
445
232
  subdomain?: string;
446
233
  };
447
- /** @description An array of name/value pairs that provide details regarding the error. */
448
234
  ErrorParameter: {
449
- /** @description This is the name of input field that caused an issue with the call request. */
450
235
  name?: string;
451
- /** @description This is the actual value that was passed in for the element specified in the <b> name</b> field. */
452
236
  value?: string;
453
237
  };
454
- /** @description The type that defines the fields for the estimated item availability information. */
455
238
  EstimatedAvailability: {
456
- /**
457
- * Format: int32
458
- * @description This field is return only when the seller sets their '<a href="#display-item-quantity">display item quantity</a>' preference to <b> Display "More than 10 available" in your listing (if applicable)</b>. The value of this field will be "10", which is the threshold value. <br /><br />Code so that your app gracefully handles any future changes to this value.
459
- */
460
239
  availabilityThreshold?: number;
461
- /** @description <a name="display-item-quantity"></a> This field is return only when the seller sets their <b> Display Item Quantity</b> preference to <b> Display "More than 10 available" in your listing (if applicable)</b>. The value of this field will be <code> MORE_THAN</code>. This indicates that the seller has more than the 'quantity display preference', which is 10, in stock for this item. <br /><br /> The following are the display item quantity preferences the seller can set. <br /><ul><li> <b> Display "More than 10 available" in your listing (if applicable) </b><ul> <li>If the seller enables this preference, this field is returned as long as there are more than 10 of this item in inventory.</li> <li> If the quantity is equal to 10 or drops below 10, this field is not returned and the estimated quantity of the item is returned in the <b> estimatedAvailableQuantity</b> field.</li></ul> </li> <li> <b> Display the exact quantity in your items</b> <br />If the seller enables this preference, the <b> availabilityThresholdType</b> and <b> availabilityThreshold</b> fields are not returned and the estimated quantity of the item is returned in the <b> estimatedAvailableQuantity</b> field.<br /><br /><b> Note: </b> Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. </li></ul> <br />Code so that your app gracefully handles any future changes to these preferences. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:AvailabilityThresholdEnum'>eBay API documentation</a> */
462
240
  availabilityThresholdType?: string;
463
- /** @description An array of available delivery options. <br><br><b> Valid Values: </b> SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, PICKUP_DROP_OFF, or DIGITAL_DELIVERY <br /><br />Code so that your app gracefully handles any future changes to this list. */
464
241
  deliveryOptions?: (string)[];
465
- /** @description An enumeration value representing the inventory status of this item.<br /><br /><span class="tablenote"><b> Note: </b>Be sure to review the <b>itemEndDate</b> field to determine whether the item is available for purchase.</span><br><br><b> Valid Values: </b> IN_STOCK, LIMITED_STOCK, or OUT_OF_STOCK <br /><br />Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:AvailabilityStatusEnum'>eBay API documentation</a> */
466
242
  estimatedAvailabilityStatus?: string;
467
- /**
468
- * Format: int32
469
- * @description The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.
470
- */
471
243
  estimatedAvailableQuantity?: number;
472
- /**
473
- * Format: int32
474
- * @description The estimated number of this item that have been sold.
475
- */
476
244
  estimatedSoldQuantity?: number;
477
245
  };
478
- /** @description Type the defines the details of an image, such as size and image URL. Currently, only <b> imageUrl</b> is populated. The <b> height</b> and <b> width</b> were added for future use. */
479
246
  Image: {
480
- /**
481
- * Format: int32
482
- * @description Reserved for future use.
483
- */
484
247
  height?: number;
485
- /** @description The URL of the image. */
486
248
  imageUrl?: string;
487
- /**
488
- * Format: int32
489
- * @description Reserved for future use.
490
- */
491
249
  width?: number;
492
250
  };
493
- /** @description The details of an item that can be purchased. */
494
251
  Item: {
495
- /** @description An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the <b> image.imageUrl</b> field. */
496
252
  additionalImages?: (components["schemas"]["Image"])[];
497
- /** @description This indicates if the item is for adults only. For more information about adult-only items on eBay, see <a href="https://pages.ebay.com/help/policies/adult-only.html" target="_blank">Adult items policy</a> for sellers and <a href="https://www.ebay.com/help/terms-conditions/default/searching-adult-items?id=4661" target="_blank">Adult-Only items on eBay</a> for buyers. */
498
253
  adultOnly?: boolean;
499
- /** @description (Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
500
254
  ageGroup?: string;
501
- /** @description A container for information about whether an item is qualified for the Authenticity Guarantee program.<br /><br />Under the Authenticity Guarantee program, the seller ships a purchased item to a a third-party authenticator who inspects the item and provides an authentication card for it before the item is shipped to the buyer. If the buyer returns the item, the authenticator first verifies that it is the same item in the same condition before returning it to the seller.<br /><br /><span class="tablenote"><b> Note: </b>Refer to the <a href="https://pages.ebay.com/authenticity-guarantee/" target="_blank">Authenticity Guarantee</a> page for more information.</span> */
502
255
  authenticityGuarantee?: components["schemas"]["AuthenticityGuaranteeProgram"];
503
- /** @description A container for information about whether an item is from a verified seller.</span> */
504
256
  authenticityVerification?: components["schemas"]["AuthenticityVerificationProgram"];
505
- /** @description A list of available coupons for the item. */
506
257
  availableCoupons?: (components["schemas"]["AvailableCoupon"])[];
507
- /**
508
- * Format: int32
509
- * @description This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.
510
- */
511
258
  bidCount?: number;
512
- /** @description (Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
513
259
  brand?: string;
514
- /** @description A comma separated list of all the purchase options available for the item. The values returned are: <ul> <li><code>FIXED_PRICE</code> - Indicates the buyer can purchase the item for a set price using the Buy It Now button. </li> <li><code>AUCTION</code> - Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.</li> <li><code>BEST_OFFER</code> - Indicates the buyer can send the seller a price they're willing to pay for the item. The seller can accept, reject, or send a counter offer. For more information on how this works, see <a href="https://www.ebay.com/help/buying/buy-now/making-best-offer?id=4019">Making a Best Offer</a>.</li> </ul> Code so that your app gracefully handles any future changes to this list. */
515
260
  buyingOptions?: (string)[];
516
- /** @description The ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children. */
517
261
  categoryId?: string;
518
- /** @description Text that shows the category hierarchy of the item. For example: Computers/Tablets &amp; Networking, Laptops &amp; Netbooks, PC Laptops &amp; Netbooks */
519
262
  categoryPath?: string;
520
- /** @description (Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
521
263
  color?: string;
522
- /** @description A short text description for the condition of the item, such as New or Used. For a list of condition names, see <a href="https://developer.ebay.com/devzone/finding/callref/enums/conditionIdList.html" target="_blank">Item Condition IDs and Names</a>. <br /><br />Code so that your app gracefully handles any future changes to this list. <br /><br /><span class="tablenote"><b> Note: </b>As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the <b>Cell Phones & Smartphones</b> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).</span> */
523
264
  condition?: string;
524
- /** @description A full text description for the condition of the item. This field elaborates on the value specified in the <b>condition</b> field and provides full details for the condition of the item. <br /><br /><span class="tablenote"><b> Note: </b>As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the <b>Cell Phones & Smartphones</b> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).</span> */
525
265
  conditionDescription?: string;
526
- /** @description The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see <a href="https://developer.ebay.com/devzone/finding/callref/enums/conditionIdList.html" target="_blank">Item Condition IDs and Names</a>. <br /><br />Code so that your app gracefully handles any future changes to this list. <br /><br /><span class="tablenote"><b> Note: </b>As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the <b>Cell Phones & Smartphones</b> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).</span> */
527
266
  conditionId?: string;
528
- /** @description The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items. */
529
267
  currentBidPrice?: components["schemas"]["ConvertedAmount"];
530
- /** @description The full description of the item that was created by the seller. This can be plain text or rich content and can be very large. */
531
268
  description?: string;
532
- /** @description This field indicates if the item can be purchased using the Buy <a href="/api-docs/buy/order/resources/methods">Order API</a>. <ul> <li>If the value of this field is <code>true</code>, this indicates that the item can be purchased using the <b> Order API</b>. </li> <li>If the value of this field is <code>false</code>, this indicates that the item cannot be purchased using the <b> Order API</b> and must be purchased on the eBay site.</li> </ul> */
533
269
  eligibleForInlineCheckout?: boolean;
534
- /** @description This indicates if the item can be purchased using Guest Checkout in the <a href="/api-docs/buy/order/resources/methods">Order API</a>. You can use this flag to exclude items from your inventory that are not eligible for Guest Checkout, such as gift cards. */
535
270
  enabledForGuestCheckout?: boolean;
536
- /** @description This indicates the <a href="https://en.wikipedia.org/wiki/European_Union_energy_label">European energy efficiency</a> rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating. <br /><br />The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models. <br /><br />When the manufacturer's specifications for this item are available, the link to this information is returned in the <b> productFicheWebUrl</b> field. */
537
271
  energyEfficiencyClass?: string;
538
- /** @description An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs. */
539
272
  epid?: string;
540
- /** @description The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned. */
541
273
  estimatedAvailabilities?: (components["schemas"]["EstimatedAvailability"])[];
542
- /** @description (Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
543
274
  gender?: string;
544
- /** @description The unique Global Trade Item number of the item as defined by <a href="https://www.gtin.info" target="_blank">https://www.gtin.info</a>. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value. */
545
275
  gtin?: string;
546
- /** @description The URL of the primary image of the item. The other images of the item are returned in the <b> additionalImages</b> container. */
547
276
  image?: components["schemas"]["Image"];
548
- /** @description The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. <br /><br />If the seller provided an ePID for the item, the seller's value is returned in the <b> epid</b> field. <br /><br /><span class="tablenote"><b> Note: </b> This field is returned only for authorized Partners.</span> */
549
277
  inferredEpid?: string;
550
- /** @description The URL of the View Item page of the item, which includes the affiliate tracking ID. This field is only returned if the eBay partner enables affiliate tracking for the item by including the <a href="/api-docs/buy/static/api-browse.html#Headers"><code>X-EBAY-C-ENDUSERCTX</code></a> request header in the method. <br /> <br /><span class="tablenote"><b>Note: </b> eBay Partner Network, in order to be commissioned for your sales, you must use this URL to forward your buyer to the ebay.com site. </span> */
551
278
  itemAffiliateWebUrl?: string;
552
- /** @description This timestamp indicates the date and time up to which the item can be purchased. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.<br /><br /><span class="tablenote"><b> Note: </b>This field is only returned for auction listings.</span> */
553
279
  itemEndDate?: string;
554
- /** @description The unique RESTful identifier of the item. */
555
280
  itemId?: string;
556
- /** @description The physical location of the item. */
557
281
  itemLocation?: components["schemas"]["Address"];
558
- /** @description The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay. */
559
282
  itemWebUrl?: string;
560
- /** @description The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page. */
561
283
  legacyItemId?: string;
562
- /** @description An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item. */
563
284
  localizedAspects?: (components["schemas"]["TypedNameValue"])[];
564
- /**
565
- * Format: int32
566
- * @description The number of items in a lot. In other words, a lot size is the number of items that are being sold together. <br /><br />A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below. <br /><br /><table border="1"> <tr> <tr> <th>Item</th> <th>Lot Definition</th> <th>Lot Size</th></tr> <tr> <td>A package of 24 AA batteries</td> <td>A box of 10 packages</td> <td>10 </td> </tr> <tr> <td>A P235/75-15 Goodyear tire </td> <td>4 tires </td> <td>4 </td> </tr> <tr> <td>Fashion Jewelry Rings </td> <td>Package of 100 assorted rings </td> <td>100 </td> </tr></table> <br /><br /><span class="tablenote"><b>Note: </b> Lots are not supported in all categories. </span>
567
- */
568
285
  lotSize?: number;
569
- /** @description The original price and the discount amount and percentage. */
570
286
  marketingPrice?: components["schemas"]["MarketingPrice"];
571
- /** @description (Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
572
287
  material?: string;
573
- /** @description The minimum price of the next bid, which means to place a bid it must to equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see <a href="https://www.ebay.com/help/buying/bidding/automatic-bidding?id=4014">Automatic bidding</a>. */
574
288
  minimumPriceToBid?: components["schemas"]["ConvertedAmount"];
575
- /** @description The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand. */
576
289
  mpn?: string;
577
- /** @description (Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
578
290
  pattern?: string;
579
- /** @description The payment methods for the item, including the payment method types, brands, and instructions for the buyer. */
580
291
  paymentMethods?: (components["schemas"]["PaymentMethod"])[];
581
- /** @description The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs.<br /><br /><span class="tablenote"><b> Note: </b>The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the <a href="/api-docs/static/rest-request-components.html#HTTP"><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying the supported marketplace (such as <code>EBAY_GB</code>) to see the VAT-inclusive pricing. For more information on VAT, refer to <a href="https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650&st=12&pos=1&query=Your%20VAT%20obligations%20in%20the%20EU&intent=VAT">VAT Obligations in the EU</a>.</span> */
582
292
  price?: components["schemas"]["ConvertedAmount"];
583
- /** @description Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PriceDisplayConditionEnum'>eBay API documentation</a> */
584
293
  priceDisplayCondition?: string;
585
- /** @description The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. <br /><br />When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.<br /><br /><span class="tablenote"><b> Note: </b> This container is returned only if the <b> item_id</b> in the request is for an item group (items with variations, such as color and size).</span> */
586
294
  primaryItemGroup?: components["schemas"]["ItemGroupSummary"];
587
- /** @description The container that returns the product rating details, such as review count, rating histogram, and average rating. */
588
295
  primaryProductReviewRating?: components["schemas"]["ReviewRating"];
589
- /** @description This field is returned as <code>true</code> if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.<br /><br />For more information, see <a href="https://pages.ebay.com/seller-center/listing-and-marketing/promoted-listings.html" target="_blank">Promoted Listings</a>. */
590
296
  priorityListing?: boolean;
591
- /** @description The container that returns the product information of the item. */
592
297
  product?: components["schemas"]["Product"];
593
- /** @description The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for <em> all</em> items with an EEK rating and is returned only if this information is available. The EEK rating of the item is returned in the <b> energyEfficiencyClass</b> field. */
594
298
  productFicheWebUrl?: string;
595
- /** @description An array of the qualified programs available for the item, such as EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.<br /><br /><span class="tablenote"><b>Note: </b> This container is only returned when the filters <b>deliveryCountry</b> and <b>deliveryPostalCode</b> are included in the request.</span><br /><br />eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.<br /><br /><span class="tablenote"><b>Note: </b> eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.</span><br /><br />The eBay <a href="https://pages.ebay.com/authenticity-guarantee/" target="_blank">Authenticity Guarantee</a> program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers. */
596
299
  qualifiedPrograms?: (string)[];
597
- /**
598
- * Format: int32
599
- * @description The maximum number for a specific item that one buyer can purchase.
600
- */
601
300
  quantityLimitPerBuyer?: number;
602
- /** @description This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for. <p>If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold.</p> <p><b> Note: </b>This is returned only for auctions that have a reserve price.</p> */
603
301
  reservePriceMet?: boolean;
604
- /** @description The container that returns an overview of the seller's return policy. */
605
302
  returnTerms?: components["schemas"]["ItemReturnTerms"];
606
- /** @description The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information. */
607
303
  seller?: components["schemas"]["SellerDetail"];
608
- /** @description An identifier generated/incremented when a seller revises the item. There are two types of item revisions: <ul><li>Seller changes, such as changing the title</li> <li>eBay system changes, such as changing the quantity when an item is purchased</li></ul> This ID is changed <em> only</em> when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed. */
609
304
  sellerItemRevision?: string;
610
- /** @description An array of shipping options containers that have the details about cost, carrier, etc. of one shipping option. */
611
305
  shippingOptions?: (components["schemas"]["ShippingOption"])[];
612
- /** @description The container that returns the geographic regions to be included and excluded that define where the item can be shipped. */
613
306
  shipToLocations?: components["schemas"]["ShipToLocations"];
614
- /** @description This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.). */
615
307
  shortDescription?: string;
616
- /** @description (Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
617
308
  size?: string;
618
- /** @description (Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. <br /><br /><b> Valid Values: </b> <br />AU (Australia), <br />BR (Brazil), <br />CN (China), <br />DE (Germany), <br />EU (European Union), <br /> FR (France), <br /> IT (Italy), <br />JP (Japan), <br />MX (Mexico), <br />US (USA), <br /> UK (United Kingdom) <br /><br />Code so that your app gracefully handles any future changes to this list. */
619
309
  sizeSystem?: string;
620
- /** @description (Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the <b> localizedAspects</b> container. */
621
310
  sizeType?: string;
622
- /** @description A subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results. */
623
311
  subtitle?: string;
624
- /** @description The container for the tax information for the item. */
625
312
  taxes?: (components["schemas"]["Taxes"])[];
626
- /** @description The seller-created title of the item. <br><br><b> Maximum Length: </b> 80 characters */
627
313
  title?: string;
628
- /** @description This indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item; a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings. See the <a href="https://pages.ebay.com/topratedplus/index.html" target="_blank">Top Rated Plus Items </a> and <a href="https://pages.ebay.com/help/sell/top-rated.html target="_blank">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> help topics for more information. */
629
314
  topRatedBuyingExperience?: boolean;
630
- /** @description The URL to the image that shows the information on the tyre label. */
631
315
  tyreLabelImageUrl?: string;
632
- /**
633
- * Format: int32
634
- * @description This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items.
635
- */
636
316
  uniqueBidderCount?: number;
637
- /** @description This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices. <br /><br />For example: <br /><br /><code>"unitPricingMeasure": "100g",<br /> "unitPrice": {<br />&nbsp;&nbsp;"value": "7.99",<br />&nbsp;&nbsp;"currency": "GBP"</code> */
638
317
  unitPrice?: components["schemas"]["ConvertedAmount"];
639
- /** @description The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. <br /><br />For example, the following tells the buyer that the item is 7.99 per 100 grams. <br /><br /><code>"unitPricingMeasure": "100g",<br /> "unitPrice": {<br />&nbsp;&nbsp;"value": "7.99",<br />&nbsp;&nbsp;"currency": "GBP"</code> */
640
318
  unitPricingMeasure?: string;
641
- /** @description An array of warning messages. These types of errors do not prevent the method from executing but should be checked. */
642
319
  warnings?: (components["schemas"]["Error"])[];
643
- /**
644
- * Format: int32
645
- * @description The number of users that have added the item to their watch list.<br /><br /><span class="tablenote"> <strong>Note:</strong> This field is restricted to applications that have been granted permission to access this feature. You must submit an <a href="https://developer.ebay.com/my/support/tickets?tab=app-check">App Check ticket</a> to request this access. In the App Check form, add a note to the <b>Application Title/Summary</b> and/or <b>Application Details</b> fields that you want access to Watch Count data in the Browse API.</span>
646
- */
647
320
  watchCount?: number;
648
321
  };
649
- /** @description The type that defines the fields for the item details. */
650
322
  ItemGroup: {
651
- /** @description An array of containers for a description and the item IDs of all the items that have this exact description. Often the item variations within an item group all have the same description. Instead of repeating this description in the item details of each item, a description that is shared by at least one other item is returned in this container. If the description is unique, it is returned in the <b> items.description</b> field. */
652
323
  commonDescriptions?: (components["schemas"]["CommonDescriptions"])[];
653
- /** @description An array of containers for all the item variation details, excluding the description. */
654
324
  items?: (components["schemas"]["Item"])[];
655
- /** @description An array of warning messages. These types of errors do not prevent the method from executing but should be checked. */
656
325
  warnings?: (components["schemas"]["Error"])[];
657
326
  };
658
- /** @description The type that defines the fields for the details of each item in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc. <br /><br /><span class="tablenote"><b> Note: </b> This container is returned only if the <b> item_id</b> in the request is an item group (parent ID of an item with variations).</span> */
659
327
  ItemGroupSummary: {
660
- /** @description An array of containers with the URLs for images that are in addition to the primary image of the item group. The primary image is returned in the <b> itemGroupImage</b> field. */
661
328
  itemGroupAdditionalImages?: (components["schemas"]["Image"])[];
662
- /** @description The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. */
663
329
  itemGroupHref?: string;
664
- /** @description The unique identifier for the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. */
665
330
  itemGroupId?: string;
666
- /** @description The URL of the primary image of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. */
667
331
  itemGroupImage?: components["schemas"]["Image"];
668
- /** @description The title of the item that appears on the item group page. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. */
669
332
  itemGroupTitle?: string;
670
- /** @description An enumeration value that indicates the type of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ItemGroupTypeEnum'>eBay API documentation</a> */
671
333
  itemGroupType?: string;
672
334
  };
673
- /** @description The type that defines the fields for the location of an item, such as information typically used for an address, including postal code, county, state/province, street address, city, and country (2-digit ISO code). */
674
335
  ItemLocationImpl: {
675
- /** @description The first line of the street address. */
676
336
  addressLine1?: string;
677
- /** @description The second line of the street address. This field may contain such values as an apartment or suite number. */
678
337
  addressLine2?: string;
679
- /** @description The city in which the item is located. <br /><br /><b>Restriction:</b> This field is populated in the <b> search</b> method response <i> only</i> when <b> fieldgroups</b> = <code>EXTENDED</code>. */
680
338
  city?: string;
681
- /** @description The two-letter <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> standard code that indicates the country in which the item is located. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay API documentation</a> */
682
339
  country?: string;
683
- /** @description The county in which the item is located. */
684
340
  county?: string;
685
- /** @description The postal code (or zip code in US) where the item is located. Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in <b>itemLocation.postalCode</b> via the API. */
686
341
  postalCode?: string;
687
- /** @description The state or province in which the item is located. */
688
342
  stateOrProvince?: string;
689
343
  };
690
- /** @description The type that defines the fields for the seller's return policy. */
691
344
  ItemReturnTerms: {
692
- /** @description This indicates if the seller has enabled the Extended Holiday Returns feature on the item. Extended Holiday Returns are only applicable during the US holiday season, and gives buyers extra time to return an item. This 'extra time' will typically extend beyond what is set through the <b> returnPeriod</b> value. */
693
345
  extendedHolidayReturnsOffered?: boolean;
694
- /** @description An enumeration value that indicates how a buyer is refunded when an item is returned. <br><br><b> Valid Values: </b> MONEY_BACK or MERCHANDISE_CREDIT <br /><br />Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:RefundMethodEnum'>eBay API documentation</a> */
695
346
  refundMethod?: string;
696
- /** @description This string field indicates the restocking fee percentage that the seller has set on the item. Sellers have the option of setting no restocking fee for an item, or they can set the percentage to 10, 15, or 20 percent. So, if the cost of the item was $100, and the restocking percentage was 20 percent, the buyer would be charged $20 to return that item, so instead of receiving a $100 refund, they would receive $80 due to the restocking fee. */
697
347
  restockingFeePercentage?: string;
698
- /** @description Text written by the seller describing what the buyer needs to do in order to return the item. */
699
348
  returnInstructions?: string;
700
- /** @description An enumeration value that indicates the alternative methods for a full refund when an item is returned. This field is returned if the seller offers the buyer an item replacement or exchange instead of a monetary refund. <br><br><b> Valid Values: </b> <ul><li><b> REPLACEMENT</b> - Indicates that the buyer has the option of receiving money back for the returned item, or they can choose to have the seller replace the item with an identical item.</li> <li><b> EXCHANGE</b> - Indicates that the buyer has the option of receiving money back for the returned item, or they can exchange the item for another similar item.</li></ul> Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ReturnMethodEnum'>eBay API documentation</a> */
701
349
  returnMethod?: string;
702
- /** @description The amount of time the buyer has to return the item after the purchase date. */
703
350
  returnPeriod?: components["schemas"]["TimeDuration"];
704
- /** @description Indicates whether the seller accepts returns for the item. */
705
351
  returnsAccepted?: boolean;
706
- /** @description This enumeration value indicates whether the buyer or seller is responsible for return shipping costs when an item is returned. <br><br><b> Valid Values: </b> <ul><li><b> SELLER</b> - Indicates the seller will pay for the shipping costs to return the item.</li> <li><b> BUYER</b> - Indicates the buyer will pay for the shipping costs to return the item.</li> </ul> Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ReturnShippingCostPayerEnum'>eBay API documentation</a> */
707
352
  returnShippingCostPayer?: string;
708
353
  };
709
- /** @description The type that defines the fields for the details of a specific item. */
710
354
  ItemSummary: {
711
- /** @description An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the <b> image.imageUrl</b> field. */
712
355
  additionalImages?: (components["schemas"]["Image"])[];
713
- /** @description This indicates if the item is for adults only. For more information about adult-only items on eBay, see <a href="https://pages.ebay.com/help/policies/adult-only.html" target="_blank">Adult items policy</a> for sellers and <a href="https://www.ebay.com/help/terms-conditions/default/searching-adult-items?id=4661" target="_blank">Adult-Only items on eBay</a> for buyers. */
714
356
  adultOnly?: boolean;
715
- /** @description This boolean attribute indicates if coupons are available for the item. */
716
357
  availableCoupons?: boolean;
717
- /**
718
- * Format: int32
719
- * @description This integer value indicates the total number of bids that have been placed for an auction item. This field is only returned for auction items.
720
- */
721
358
  bidCount?: number;
722
- /** @description A comma separated list of all the purchase options available for the item. <br><br><b> Values Returned: </b> <ul> <li><b>FIXED_PRICE</b> - Indicates the buyer can purchase the item for a set price using the Buy It Now button. </li> <li><b> AUCTION</b> - Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.</li> <li><b> BEST_OFFER</b> - Items where the buyer can send the seller a price they're willing to pay for the item. The seller can accept, reject, or send a counter offer. For details about Best Offer, see <a href="https://www.ebay.com/help/selling/listings/selling-buy-now/adding-best-offer-listing?id=4144" target="_blank">Best Offer</a>. </li></ul> Code so that your app gracefully handles any future changes to this list. */
723
359
  buyingOptions?: (string)[];
724
- /** @description This container returns the primary category ID of the item (as well as the secondary category if the item was listed in two categories). */
725
360
  categories?: (components["schemas"]["Category"])[];
726
- /** @description This indicates how well the item matches the <b>compatibility_filter</b> product attributes. <br><br><b> Valid Values: </b> EXACT or POSSIBLE <br /><br />Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:CompatibilityMatchEnum'>eBay API documentation</a> */
727
361
  compatibilityMatch?: string;
728
- /** @description This container returns only the product attributes that are compatible with the item. These attributes were specified in the <b>compatibility_filter</b> in the request. This means that if you passed in 5 attributes and only 4 are compatible, only those 4 are returned. If none of the attributes are compatible, this container is not returned. */
729
362
  compatibilityProperties?: (components["schemas"]["CompatibilityProperty"])[];
730
- /** @description The text describing the condition of the item, such as New or Used. For a list of condition names, see <a href="https://developer.ebay.com/devzone/finding/callref/enums/conditionIdList.html" target="_blank">Item Condition IDs and Names</a>. <br /><br />Code so that your app gracefully handles any future changes to this list. <br /><br /><span class="tablenote"><b> Note: </b>As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the <b>Cell Phones & Smartphones</b> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).</span> */
731
363
  condition?: string;
732
- /** @description The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see <a https://developer.ebay.com/devzone/finding/callref/enums/conditionIdList.html" target="_blank">Item Condition IDs and Names</a>. <br /><br />Code so that your app gracefully handles any future changes to this list.<br /><br /><span class="tablenote"><b> Note: </b>As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the <b>Cell Phones & Smartphones</b> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).</span> */
733
364
  conditionId?: string;
734
- /** @description This container returns the current highest bid for an auction item. The <b> value</b> field shows the dollar value of the current highest bid, and the <b> currency</b> field (3-digit ISO code) denotes the currency associated with that bid value. This field is only returned for auction items. */
735
365
  currentBidPrice?: components["schemas"]["ConvertedAmount"];
736
- /** @description This container returns the distance away that the item is from the <b> pickupPostalCode</b> value that was supplied in the method request. This container is only returned if the 'local pickup' filter fields are used in the request. */
737
366
  distanceFromPickupLocation?: components["schemas"]["TargetLocation"];
738
- /** @description This indicates the <a href="https://en.wikipedia.org/wiki/European_Union_energy_label">European energy efficiency</a> rating (EEK) of the item. Energy efficiency ratings apply to products listed by commercial vendors in electronics categories only. <br /><br />Currently, this field is only applicable for the Germany site, and is only returned if the seller specified the energy efficiency rating through item specifics at listing time. Rating values include <code>A+++</code>, <code>A++</code>, <code>A+</code>, <code>A</code>, <code>B</code>, <code>C</code>, <code>D</code>, <code>E</code>, <code>F</code>, and <code>G</code>. */
739
367
  energyEfficiencyClass?: string;
740
- /** @description An ePID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs. */
741
368
  epid?: string;
742
- /** @description The URL to the primary image of the item. */
743
369
  image?: components["schemas"]["Image"];
744
- /** @description The URL to the View Item page of the item, which includes the affiliate tracking ID. This field is only returned if the seller enables affiliate tracking for the item by including the <code><a href="/api-docs/buy/static/api-browse.html#Headers">X-EBAY-C-ENDUSERCTX</a></code> request header in the method. <br /> <br /><span class="tablenote"><b>Note: </b> eBay Partner Network, in order to receive a commission for your sales, you must use this URL to forward your buyer to the ebay.com site. </span> */
745
370
  itemAffiliateWebUrl?: string;
746
- /** @description The date and time up to which the item can be purchased. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.<br /><br /><span class="tablenote"><b> Note: </b>This field is not returned for Good 'Til Cancelled (GTC) listings.</span> */
747
371
  itemEndDate?: string;
748
- /** @description The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. <br /> <br /><span class="tablenote"> <b> Note: </b>This field is returned only for item groups.</span> */
749
372
  itemGroupHref?: string;
750
- /** @description The indicates the item group type. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. <br /><br />Currently only the <code>SELLER_DEFINED_VARIATIONS</code> is supported and indicates this is an item group created by the seller. <br /> <br /><span class="tablenote"> <b> Note: </b>This field is returned only for item groups.</span><br /><br />Code so that your app gracefully handles any future changes to this list. */
751
373
  itemGroupType?: string;
752
- /** @description The URI for the Browse API <a href="/api-docs/buy/browse/resources/item/methods/getItem">getItem</a> method, which can be used to retrieve more details about items in the search results. */
753
374
  itemHref?: string;
754
- /** @description The unique RESTful identifier of the item. */
755
375
  itemId?: string;
756
- /** @description This container returns the location of the item. This container consists of fields you typically see for an address, including postal code, county, state/province, street address, city, and country (2-digit ISO code). */
757
376
  itemLocation?: components["schemas"]["ItemLocationImpl"];
758
- /** @description The URL to the View Item page of the item. This enables you to include a "Report Item on eBay" hyperlink that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay. */
759
377
  itemWebUrl?: string;
760
- /** @description The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page. */
761
378
  legacyItemId?: string;
762
- /** @description This container is returned if the item is eligible for a seller discount and contains the item's original price, and the seller discount amount and percentage. */
763
379
  marketingPrice?: components["schemas"]["MarketingPrice"];
764
- /** @description This container returns the local pickup options available to the buyer. This container is only returned if the user is searching for local pickup items and set the local pickup filters in the method request. */
765
380
  pickupOptions?: (components["schemas"]["PickupOptionSummary"])[];
766
- /** @description The price of the item after it has been converted into another currency.<br /><br />The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must do one or more of the following to see VAT-inclusive pricing:<ul><li>Pass the <a href="/api-docs/static/rest-request-components.html#HTTP"><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying the supported marketplace (such as <code>EBAY_GB</code>)</li><li>Pass the <code>contextualLocation</code> values for the supported marketplace in the <a href="/api-docs/buy/static/api-browse.html#Headers"><code>X-EBAY-C-ENDUSERCTX</code></a> request header</li><li>Specify the supported marketplace using the <a href="/api-docs/buy/static/ref-buy-browse-filters.html#deliveryCountry"><code>deliveryCountry</code></a> <b>filter</b> URI parameter (such as <code>filter=deliveryCountry:GB</code>)</li></ul><span class="tablenote"><b> Note: </b>For more information on VAT, refer to <a href="https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650&st=12&pos=1&query=Your%20VAT%20obligations%20in%20the%20EU&intent=VAT">VAT Obligations in the EU</a>.</span> */
767
381
  price?: components["schemas"]["ConvertedAmount"];
768
- /** @description Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PriceDisplayConditionEnum'>eBay API documentation</a> */
769
382
  priceDisplayCondition?: string;
770
- /** @description This field is returned as <code>true</code> if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.<br /><br/>For more information, see <a href="https://pages.ebay.com/seller-center/listing-and-marketing/promoted-listings.html"target="_blank">Promoted Listings</a>. */
771
383
  priorityListing?: boolean;
772
- /** @description An array of the qualified programs available for the item, such as EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.<br /><br /><span class="tablenote"><b>Note: </b> This container is only returned when the filters <b>deliveryCountry</b> and <b>deliveryPostalCode</b> are included in the request.</span><br /><br />eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.<br /><br /><span class="tablenote"><b>Note: </b> eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.</span><br /><br />The eBay <a href="https://pages.ebay.com/authenticity-guarantee/" target="_blank">Authenticity Guarantee</a> program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers. */
773
384
  qualifiedPrograms?: (string)[];
774
- /** @description This container returns basic information about the seller of the item, such as name, feedback score, etc. */
775
385
  seller?: components["schemas"]["Seller"];
776
- /** @description This container returns the shipping options available to ship the item. */
777
386
  shippingOptions?: (components["schemas"]["ShippingOptionSummary"])[];
778
- /** @description This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.). Sometimes the title doesn't give enough information but the description is too big. Surfacing the <b>shortDescription</b> can often provide buyers with the additional information that could help them make a buying decision. <br /><br />For example: <br /><br /> <code> "<b> title</b>": "Petrel U42W FPV Drone RC Quadcopter w/HD Camera Live Video One Key Off / Landing", <br />"<b>shortDescription</b>": "1 U42W Quadcopter. Syma X5SW-V3 Wifi FPV RC Drone Quadcopter 2.4Ghz 6-Axis Gyro with Headless Mode. Syma X20 Pocket Drone 2.4Ghz Mini RC Quadcopter Headless Mode Altitude Hold. One Key Take Off / Landing function: allow beginner to easy to fly the drone without any skill.",</code> <br /><br /><b>Restriction: </b> This field is returned by the <b> search</b> method only when <b> fieldgroups</b> = <code>EXTENDED</code>. */
779
387
  shortDescription?: string;
780
- /** @description An array of thumbnail images for the item. */
781
388
  thumbnailImages?: (components["schemas"]["Image"])[];
782
- /** @description The seller-created title of the item. <br><br><b>Maximum Length: </b> 80 characters */
783
389
  title?: string;
784
- /** @description This indicates if the item is a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy, shipping the item in 1 business day with tracking provided, and the added comfort of knowing that this item is from an experienced seller with the highest buyer ratings. See the <a href="https://pages.ebay.com/topratedplus/index.html" target="_blank">Top Rated Plus Items </a> and <a href="https://pages.ebay.com/help/sell/top-rated.html" target="_blank">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> help topics for more information. */
785
390
  topRatedBuyingExperience?: boolean;
786
- /** @description The URL to the image that shows the information on the tyre label. */
787
391
  tyreLabelImageUrl?: string;
788
- /** @description The price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices. <br /><br />For example: <br /><br /><code>"unitPricingMeasure": "100g",<br /> "unitPrice": {<br />&nbsp;&nbsp;"value": "7.99",<br />&nbsp;&nbsp;"currency": "GBP"</code> */
789
392
  unitPrice?: components["schemas"]["ConvertedAmount"];
790
- /** @description The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. <br /><br />For example, the following tells the buyer that the item is 7.99 per 100 grams. <br /><br /><code>"unitPricingMeasure": "100g",<br /> "unitPrice": {<br />&nbsp;&nbsp;"value": "7.99",<br />&nbsp;&nbsp;"currency": "GBP"</code> */
791
393
  unitPricingMeasure?: string;
792
- /**
793
- * Format: int32
794
- * @description The number of users that have added the item to their watch list.<br /><br /><span class="tablenote"> <strong>Note:</strong> This field is restricted to applications that have been granted permission to access this feature. You must submit an <a href="https://developer.ebay.com/my/support/tickets?tab=app-check">App Check ticket</a> to request this access. In the App Check form, add a note to the <b>Application Title/Summary</b> and/or <b>Application Details</b> fields that you want access to Watch Count data in the Browse API.</span>
795
- */
796
394
  watchCount?: number;
797
395
  };
798
- /** @description Container for a list of items. */
799
396
  Items: {
800
- /** @description An arraylist of all the items. */
801
397
  items?: (components["schemas"]["CoreItem"])[];
802
- /**
803
- * Format: int32
804
- * @description The total number of items retrieved.
805
- */
806
398
  total?: number;
807
- /** @description An array of warning messages. These types of errors do not prevent the method from executing but should be checked. */
808
399
  warnings?: (components["schemas"]["Error"])[];
809
400
  };
810
- /** @description Type that defines the fields for the seller's address. */
811
401
  LegalAddress: {
812
- /** @description The first line of the street address. */
813
402
  addressLine1?: string;
814
- /** @description The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'. */
815
403
  addressLine2?: string;
816
- /** @description The city of the address. */
817
404
  city?: string;
818
- /** @description The two-letter <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166</a> standard of the country of the address. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay API documentation</a> */
819
405
  country?: string;
820
- /** @description The name of the country of the address. */
821
406
  countryName?: string;
822
- /** @description The name of the county of the address. */
823
407
  county?: string;
824
- /** @description The postal code of the address. */
825
408
  postalCode?: string;
826
- /** @description The state or province of the address. */
827
409
  stateOrProvince?: string;
828
410
  };
829
- /** @description The type that defines the fields that describe a seller discount. */
830
411
  MarketingPrice: {
831
- /** @description This container returns the monetary amount of the seller discount. */
832
412
  discountAmount?: components["schemas"]["ConvertedAmount"];
833
- /** @description This field expresses the percentage of the seller discount based on the value in the <b> originalPrice</b> container. */
834
413
  discountPercentage?: string;
835
- /** @description This container returns the monetary amount of the item without the discount. */
836
414
  originalPrice?: components["schemas"]["ConvertedAmount"];
837
- /** @description Indicates the pricing treatment (discount) that was applied to the price of the item. <br /><br /><span class="tablenote"><b>Note: </b> The pricing treatment affects the way and where the discounted price can be displayed.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PriceTreatmentEnum'>eBay API documentation</a> */
838
415
  priceTreatment?: string;
839
416
  };
840
417
  PaymentMethod: {
841
- /** @description The payment method type, such as credit card or cash. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PaymentMethodTypeEnum'>eBay API documentation</a> */
842
418
  paymentMethodType?: string;
843
- /** @description The payment method brands, including the payment method brand type and logo image. */
844
419
  paymentMethodBrands?: (components["schemas"]["PaymentMethodBrand"])[];
845
- /** @description The payment instructions for the buyer, such as <i>cash in person</i> or <i>contact seller</i>. */
846
420
  paymentInstructions?: (string)[];
847
- /** @description The seller instructions to the buyer, such as <i>accepts credit cards</i> or <i>see description</i>. */
848
421
  sellerInstructions?: (string)[];
849
422
  };
850
423
  PaymentMethodBrand: {
851
- /** @description The payment method brand, such as Visa or PayPal. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PaymentMethodBrandEnum'>eBay API documentation</a> */
852
424
  paymentMethodBrandType?: string;
853
- /** @description The details of the logo image, such as the size and URL.<br /><br /><span class="tablenote"> <b> Note: </b> Currently, only the <b>imageUrl</b> is populated.</span> */
854
425
  logoImage?: components["schemas"]["Image"];
855
426
  };
856
- /** @description The type that defines the fields for the local pickup options that are available for the item. It is used by the <b> pickupOptions</b> container. */
857
427
  PickupOptionSummary: {
858
- /** @description This container returns the local pickup options available to the buyer. Possible values are <code>ARRANGED_LOCATION</code> and <code>STORE</code>. */
859
428
  pickupLocationType?: string;
860
429
  };
861
- /** @description The type that defines the fields for the monetary value and currency of the price of the item. */
862
430
  Price: {
863
- /** @description The three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> code representing the currency of the amount in the <b> convertedFromValue</b> field. This value is the pre-conversion currency. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CurrencyCodeEnum'>eBay API documentation</a> */
864
431
  convertedFromCurrency?: string;
865
- /** @description The monetary amount before any conversion is performed, in the currency specified by the <b> convertedFromCurrency</b> field. This value is the pre-conversion amount. The <b> value</b> field contains the converted amount of this value, in the currency specified by the <b> currency</b> field. */
866
432
  convertedFromValue?: string;
867
- /** @description The three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> code representing the currency of the amount in the <b> value</b> field. If currency conversion/localization was performed, this is the post-conversion currency of the amount in the <b> value</b> field.<br /><br /><b> Default:</b> The currency of the user's country. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CurrencyCodeEnum'>eBay API documentation</a> */
868
433
  currency?: string;
869
- /** @description The amount of the currency specified in the <b> currency</b> field. The value of <b> currency</b> defaults to the standard currency used by the country of the eBay site offering the item. If currency conversion/localization was performed, this is the post-conversion amount.<br /><br /><b> Default:</b> The currency of the user's country. */
870
434
  value?: string;
871
435
  };
872
- /** @description The type that defines the fields for the product information of the item. */
873
436
  Product: {
874
- /** @description An array of containers with the URLs for the product images that are in addition to the primary image. */
875
437
  additionalImages?: (components["schemas"]["Image"])[];
876
- /** @description An array of product identifiers associated with the item. This container is returned if the seller has associated the eBay Product Identifier (ePID) with the item and in the request <b> fieldgroups</b> is set to <code>PRODUCT</code>. */
877
438
  additionalProductIdentities?: (components["schemas"]["AdditionalProductIdentity"])[];
878
- /** @description An array of containers for the product aspects. Each group contains the aspect group name and the aspect name/value pairs. */
879
439
  aspectGroups?: (components["schemas"]["AspectGroup"])[];
880
- /** @description The brand associated with product. To identify the product, this is always used along with MPN (manufacturer part number). */
881
440
  brand?: string;
882
- /** @description The rich description of an eBay product, which might contain HTML. */
883
441
  description?: string;
884
- /** @description An array of all the possible GTINs values associated with the product. A GTIN is a unique Global Trade Item number of the item as defined by <a href="https://www.gtin.info" target="_blank">https://www.gtin.info</a>. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value. */
885
442
  gtins?: (string)[];
886
- /** @description The primary image of the product. This is often a stock photo. */
887
443
  image?: components["schemas"]["Image"];
888
- /** @description An array of all possible MPN values associated with the product. A MPNs is manufacturer part number of the product. To identify the product, this is always used along with brand. */
889
444
  mpns?: (string)[];
890
- /** @description The title of the product. */
891
445
  title?: string;
892
446
  };
893
- /** @description The type that defines the fields for the product identifier type/value pairs of product associated with an item. */
894
447
  ProductIdentity: {
895
- /** @description The type of product identifier, such as UPC and EAN. */
896
448
  identifierType?: string;
897
- /** @description The product identifier value. */
898
449
  identifierValue?: string;
899
450
  };
900
- /** @description The type that defines the fields for product ratings. Only products that are in the eBay product catalog can be reviewed and rated. */
901
451
  RatingHistogram: {
902
- /**
903
- * Format: int32
904
- * @description The total number of user ratings that the product has received.
905
- */
906
452
  count?: number;
907
- /** @description This is the average rating for the product. As part of a product review, users rate the product. Products are rated from one star (terrible) to five stars (excellent), with each star having a corresponding point value - one star gets 1 point, two stars get 2 points, and so on. If a product had one four-star rating and one five-star rating, its average rating would be <code> 4.5</code>, and this is the value that would appear in this field. */
908
453
  rating?: string;
909
454
  };
910
- /** @description This type defines the fields for the various refinements of an item. You can use the information in this container to create histograms, which help shoppers choose exactly what they want. */
911
455
  Refinement: {
912
- /** @description An array of containers for the all the aspect refinements. */
913
456
  aspectDistributions?: (components["schemas"]["AspectDistribution"])[];
914
- /** @description An array of containers for the all the buying option refinements. */
915
457
  buyingOptionDistributions?: (components["schemas"]["BuyingOptionDistribution"])[];
916
- /** @description An array of containers for the all the category refinements. */
917
458
  categoryDistributions?: (components["schemas"]["CategoryDistribution"])[];
918
- /** @description An array of containers for the all the condition refinements. */
919
459
  conditionDistributions?: (components["schemas"]["ConditionDistribution"])[];
920
- /** @description The identifier of the category that most of the items are part of. */
921
460
  dominantCategoryId?: string;
922
461
  };
923
- /** @description This type is used to provide region details for a tax jurisdiction. */
924
462
  Region: {
925
- /** @description A localized text string that indicates the name of the region. Taxes are generally charged at the state/province level or at the country level in the case of VAT tax. */
926
463
  regionName?: string;
927
- /** @description An enumeration value that indicates the type of region for the tax jurisdiction. <br><br><b> Valid Values: </b> <ul><li><b> STATE_OR_PROVINCE </b> - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada.</li><li><b> COUNTRY </b> - Indicates the region is a single country.</li></ul> Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:RegionTypeEnum'>eBay API documentation</a> */
928
464
  regionType?: string;
929
465
  };
930
- /** @description The type that defines the fields and containers for the member's eBay cart information. */
931
466
  RemoteShopcartResponse: {
932
- /** @description An array of the items in the member's eBay cart. */
933
467
  cartItems?: (components["schemas"]["CartItem"])[];
934
- /** @description This is the cost of all the items in the member's eBay cart. This does not include taxes, shipping costs, discounts, etc. It is the sum of each item's <b> price</b> * <b> quantity</b>. */
935
468
  cartSubtotal?: components["schemas"]["Amount"];
936
- /** @description The URL of the member's eBay cart. */
937
469
  cartWebUrl?: string;
938
- /** @description An array of items in the cart that are unavailable. This can be for a variety of reasons such as, when the listing has ended or the item is out of stock. Because a cart never expires, these items will remain in the cart until they are removed. */
939
470
  unavailableCartItems?: (components["schemas"]["CartItem"])[];
940
- /** @description An array of warning messages. These type of errors do not prevent the call from executing but should be checked. */
941
471
  warnings?: (components["schemas"]["Error"])[];
942
472
  };
943
- /** @description The type that defines the fields for the <b>removeItem</b> request. */
944
473
  RemoveCartItemInput: {
945
- /** @description The identifier of the item in the cart to be removed. This ID is generated when the item was added to the cart. */
946
474
  cartItemId?: string;
947
475
  };
948
- /** @description The type that defines the fields for the rating of a product review. */
949
476
  ReviewRating: {
950
- /** @description The average rating given to a product based on customer reviews. */
951
477
  averageRating?: string;
952
- /** @description An array of containers for the product rating histograms that shows the review counts and the product rating. */
953
478
  ratingHistograms?: (components["schemas"]["RatingHistogram"])[];
954
- /**
955
- * Format: int32
956
- * @description The total number of reviews for the item.
957
- */
958
479
  reviewCount?: number;
959
480
  };
960
- /** @description The type that defines the fields for the image information. */
961
481
  SearchByImageRequest: {
962
- /** @description The Base64 string of the image. */
963
482
  image?: string;
964
483
  };
965
- /** @description The type that defines the fields for a paginated result set. The response consists of 0 or more sequenced <em> pages</em> where each page has 0 or more items. */
966
484
  SearchPagedCollection: {
967
- /** @description The auto-corrected inputs. */
968
485
  autoCorrections?: components["schemas"]["AutoCorrections"];
969
- /** @description The URI of the current page of results. <br /><br />The following example of the <b> search</b> method returns items 1 thru 5 from the list of items found. <br /><br /><code>https://api.ebay.com/buy/v1/item_summary/search?q=shirt&limit=5&offset=0</code>. */
970
486
  href?: string;
971
- /** @description An array of the items on this page. The items are sorted according to the sorting method specified in the request. */
972
487
  itemSummaries?: (components["schemas"]["ItemSummary"])[];
973
- /**
974
- * Format: int32
975
- * @description The value of the <b>limit</b> parameter submitted in the request, which is the maximum number of items to return on a page, from the result set. A result set is the complete set of items returned by the method.
976
- */
977
488
  limit?: number;
978
- /** @description The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. <br /><br />The following example of the <b> search</b> method returns items 5 thru 10 from the list of items found.<br /> <br /><code>https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=10 </code> */
979
489
  next?: string;
980
- /**
981
- * Format: int32
982
- * @description This value indicates the <b>offset</b> used for current page of items being returned. Assume the initial request used an <b>offset</b> of <code>0</code> and a <b>limit</b> of <code>3</code>. Then in the first page of results, this value would be <code>0</code>, and items 1-3 are returned. For the second page, this value is <code>3</code> and so on.
983
- */
984
490
  offset?: number;
985
- /** @description The URI for the previous page of results. This is returned if there is a previous page of results from the result set. <br /><br />The following example of the <b> search</b> method returns items 1 thru 5 from the list of items found, which would be the first set of items returned.<br /> <br /><code>https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=0</code> */
986
491
  prev?: string;
987
- /** @description The container for all the search refinements. */
988
492
  refinement?: components["schemas"]["Refinement"];
989
- /**
990
- * Format: int32
991
- * @description The total number of items that match the input criteria.
992
- */
993
493
  total?: number;
994
- /** @description The container with all the warnings for the request. */
995
494
  warnings?: (components["schemas"]["Error"])[];
996
495
  };
997
- /** @description The type that defines the fields for basic information about the seller of the item returned by the <b> item_summary</b> resource. */
998
496
  Seller: {
999
- /** @description The percentage of the total positive feedback. */
1000
497
  feedbackPercentage?: string;
1001
- /**
1002
- * Format: int32
1003
- * @description The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.
1004
- */
1005
498
  feedbackScore?: number;
1006
- /** @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. <br /><br />This field is returned only on the following sites. <br /><br />EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL <br /><br /><b> Valid Values:</b> BUSINESS or INDIVIDUAL <br /><br />Code so that your app gracefully handles any future changes to this list. */
1007
499
  sellerAccountType?: string;
1008
- /** @description The user name created by the seller for use on eBay. */
1009
500
  username?: string;
1010
501
  };
1011
- /** @description The type that defines the fields for basic and detailed information about the seller of the item returned by the <b> item</b> resource. */
1012
502
  SellerDetail: {
1013
- /** @description The percentage of the total positive feedback. */
1014
503
  feedbackPercentage?: string;
1015
- /**
1016
- * Format: int32
1017
- * @description The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.
1018
- */
1019
504
  feedbackScore?: number;
1020
- /** @description This 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 the following countries: <br /><br /> This field is returned only on the following sites. <br /><br />EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL <br /><br /><b> Valid Values:</b> BUSINESS or INDIVIDUAL <br /><br />Code so that your app gracefully handles any future changes to this list. */
1021
505
  sellerAccountType?: string;
1022
- /** @description The container with the seller's contact info and fields that are required by law. */
1023
506
  sellerLegalInfo?: components["schemas"]["SellerLegalInfo"];
1024
- /** @description The user name created by the seller for use on eBay. */
1025
507
  username?: string;
1026
508
  };
1027
- /** @description The type that defines the fields for the contact information for a seller. */
1028
509
  SellerLegalInfo: {
1029
- /** @description The seller's business email address. */
1030
510
  email?: string;
1031
- /** @description The seller' business fax number. */
1032
511
  fax?: string;
1033
- /** @description This is a free-form string created by the seller. This is information often found on business cards, such as address. This is information used by some countries. */
1034
512
  imprint?: string;
1035
- /** @description The seller's first name. */
1036
513
  legalContactFirstName?: string;
1037
- /** @description The seller's last name. */
1038
514
  legalContactLastName?: string;
1039
- /** @description The name of the seller's business. */
1040
515
  name?: string;
1041
- /** @description The seller's business phone number. */
1042
516
  phone?: string;
1043
- /** @description The seller's registration number. This is information used by some countries. */
1044
517
  registrationNumber?: string;
1045
- /** @description The container that returns the seller's address to be used to contact them. */
1046
518
  sellerProvidedLegalAddress?: components["schemas"]["LegalAddress"];
1047
- /** @description This is a free-form string created by the seller. This is the seller's terms or condition, which is in addition to the seller's return policies. */
1048
519
  termsOfService?: string;
1049
- /** @description An array of the seller's VAT (value added tax) IDs and the issuing country. VAT is a tax added by some European countries. */
1050
520
  vatDetails?: (components["schemas"]["VatDetail"])[];
1051
521
  };
1052
- /** @description The type that defines the fields for the country and postal code of where an item is to be shipped. */
1053
522
  ShipToLocation: {
1054
- /** @description The two-letter <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166</a> standard of the country for where the item is to be shipped. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay API documentation</a> */
1055
523
  country?: string;
1056
- /** @description The zip code (postal code) for where the item is to be shipped. */
1057
524
  postalCode?: string;
1058
525
  };
1059
- /** @description The type that defines the fields that include and exclude geographic regions affecting where the item can be shipped. The seller defines these regions when listing the item. */
1060
526
  ShipToLocations: {
1061
- /** @description An array of containers that express the large geographical regions, countries, state/provinces, or special locations within a country where the seller is not willing to ship to. */
1062
527
  regionExcluded?: (components["schemas"]["ShipToRegion"])[];
1063
- /** @description An array of containers that express the large geographical regions, countries, or state/provinces within a country where the seller is willing to ship to. Prospective buyers must look at the shipping regions under this container, as well as the shipping regions that are under the <b>regionExcluded</b> to see where the seller is willing to ship items. Sellers can specify that they ship 'Worldwide', but then add several large geographical regions (e.g. Asia, Oceania, Middle East) to the exclusion list, or sellers can specify that they ship to Europe and Africa, but then add several individual countries to the exclusion list. */
1064
528
  regionIncluded?: (components["schemas"]["ShipToRegion"])[];
1065
529
  };
1066
- /** @description This type is used provide details about included and excluded shipping regions. */
1067
530
  ShipToRegion: {
1068
- /** @description The unique identifier of the shipping region. The value returned here is dependent on the corresponding <b>regionType</b> value. The <b>regionId</b> value for a region does not vary based on the eBay marketplace. However, the corresponding <b>regionName</b> value for a region is a localized, text-based description of the shipping region. <br><br> If the <b>regionType</b> value is <code>WORLDWIDE</code>, the <b>regionId</b> value will also be <code>WORLDWIDE</code>.<br><br> If the <b>regionType</b> value is <code>WORLD_REGION</code>, the <b>regionId</b> value will be one of the following: <code>AFRICA</code>, <code>AMERICAS</code>, <code>ASIA</code>, <code>AUSTRALIA</code>, <code>CENTRAL_AMERICA_AND_CARIBBEAN</code>, <code>EUROPE</code>, <code>EUROPEAN_UNION</code>, <code>GREATER_CHINA</code>, <code>MIDDLE_EAST</code>, <code>NORTH_AMERICA</code>, <code>OCEANIA</code>, <code>SOUTH_AMERICA</code>, <code>SOUTHEAST_ASIA</code> or <code>CHANNEL_ISLANDS</code>.<br><br>If the <b>regionType</b> value is <code>COUNTRY</code>, the <b>regionId</b> value will be the two-letter code for the country, as defined in the <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166</a> standard.<br><br>If the <b>regionType</b> value is <code>STATE_OR_PROVINCE</code>, the <b>regionId</b> value will either be the two-letter code for US states and DC (as defined on this <a href="https://www.ssa.gov/international/coc-docs/states.html" target="_blank">Social Security Administration</a> page), or the two-letter code for Canadian provinces (as defined by this <a href="https://www.canadapost.ca/tools/pg/manual/PGaddress-e.asp?ecid=murl10006450#1442131" target="_blank">Canada Post</a> page).<br><br>If the <b>regionType</b> value is <code>COUNTRY_REGION</code>, the <b>regionId</b> value may be one of following: <code>_AH</code> (if a seller is not willing to ship to Alaska/Hawaii), <code>_PR</code> (if the seller is not willing to ship to US Protectorates), <code>_AP</code> (if seller is not willing to ship to a US Army or Fleet Post Office), and <code>PO_BOX</code> (if the seller is not willing to ship to a Post Office Box). */
1069
531
  regionId?: string;
1070
- /** @description A localized text string that indicates the name of the shipping region. The value returned here is dependent on the corresponding <b>regionType</b> value. <br><br> If the <b>regionType</b> value is <code>WORLDWIDE</code>, the <b>regionName</b> value will show <code>Worldwide</code>.<br><br> If the <b>regionType</b> value is <code>WORLD_REGION</code>, the <b>regionName</b> value will be a localized text string for one of the following large geographical regions: Africa, Americas, Asia, Australia, Central America and Caribbean, Europe, European Union, Greater China, Middle East, North America, Oceania, South America, Southeast Asia, or Channel Islands.<br><br>If the <b>regionType</b> value is <code>COUNTRY</code>, the <b>regionName</b> value will be a localized text string for any country in the world.<br><br>If the <b>regionType</b> value is <code>STATE_OR_PROVINCE</code>, the <b>regionName</b> value will be a localized text string for any US state or Canadian province. <br><br>If the <b>regionType</b> value is <code>COUNTRY_REGION</code>, the <b>regionName</b> value may be a localized version of one of the following: Alaska/Hawaii, US Protectorates, APO/FPO (Army or Fleet Post Office), or PO BOX. */
1071
532
  regionName?: string;
1072
- /** @description An enumeration value that indicates the level or type of shipping region. <br><br><b> Valid Values: </b> <ul><li><b> COUNTRY_REGION </b> - Indicates the region is a domestic region or special location within a country.</li><li><b> STATE_OR_PROVINCE </b> - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada.</li><li><b> COUNTRY </b> - Indicates the region is a single country.</li><li><b> WORLD_REGION </b> - Indicates the region is a world region, such as Africa, the Middle East, or Southeast Asia.</li><li><b> WORLDWIDE </b> - Indicates the region is the entire world. This value is only applicable for included shiping regions, and not excluded shipping regions.</li></ul> For more detail on the actual <b>regionName</b>/<b>regionId</b> values that will be returned based on the <b>regionType</b> value, see the <a href="/api-docs/buy/browse/resources/item/methods/getItem#response.shipToLocations.regionExcluded.regionId">regionId</a> and/or <a href="/api-docs/buy/browse/resources/item/methods/getItem#response.shipToLocations.regionExcluded.regionName">regionName</a> field descriptions.<br><br> Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:RegionTypeEnum'>eBay API documentation</a> */
1073
533
  regionType?: string;
1074
534
  };
1075
- /** @description The type that defines the fields for the details of a shipping provider. */
1076
535
  ShippingOption: {
1077
- /** @description Any per item additional shipping costs for a multi-item purchase. For example, let's say the shipping cost for a power cord is $3. But for an additional cord, the shipping cost is only $1. So if you bought 3 cords, the <b> shippingCost</b> would be $3 and this value would be $2 ($1 for each additional item). */
1078
536
  additionalShippingCostPerUnit?: components["schemas"]["ConvertedAmount"];
1079
- /** @description The deadline date that the item must be purchased by in order to be received by the buyer within the delivery window (<b> maxEstimatedDeliveryDate</b> and <b> minEstimatedDeliveryDate</b> fields). This field is returned only for items that are eligible for 'Same Day Handling'. For these items, the value of this field is what is displayed in the <b> Delivery</b> line on the View Item page. <br /><br />This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. */
1080
537
  cutOffDateUsedForEstimate?: string;
1081
- /** @description If the item is being shipped by eBay's <a href="https://pages.ebay.com/seller-center/shipping/global-shipping-program.html">Global Shipping Program</a>, this field returns <code>GLOBAL_SHIPPING</code>. Otherwise this field is null. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:FulfilledThroughEnum'>eBay API documentation</a> */
1082
538
  fulfilledThrough?: string;
1083
- /** @description Indicates if the seller has committed to shipping the item with eBay Guaranteed Delivery. With eBay Guaranteed Delivery, the seller is committed to getting the line item to the buyer within 4 business days or less. See the <a href="https://www.ebay.com/help/buying/shipping-delivery/buying-items-ebay-guaranteed-delivery?id=4641">Buying items with eBay Guaranteed Delivery</a> help topic for more details about eBay Guaranteed Delivery. */
1084
539
  guaranteedDelivery?: boolean;
1085
- /** @description The <a href="https://pages.ebay.com/seller-center/shipping/global-shipping-program.html">Global Shipping Program</a> import charges for this item. */
1086
540
  importCharges?: components["schemas"]["ConvertedAmount"];
1087
- /** @description The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. <br /> <br /> <span class="tablenote"> <b> Note: </b> For the best accuracy, always include the location of where the item is be shipped in the <code> contextualLocation</code> values of the <a href="/api-docs/buy/static/api-browse.html#Headers"> <code>X-EBAY-C-ENDUSERCTX</code></a> request header.</span> */
1088
541
  maxEstimatedDeliveryDate?: string;
1089
- /** @description The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. <br /> <br /><span class="tablenote"> <b> Note: </b> For the best accuracy, always include the location of where the item is be shipped in the <code> contextualLocation</code> values of the <a href="/api-docs/buy/static/api-browse.html#Headers"> <code>X-EBAY-C-ENDUSERCTX</code></a> request header.</span> */
1090
542
  minEstimatedDeliveryDate?: string;
1091
- /**
1092
- * Format: int32
1093
- * @description The number of items used when calculating the estimation information.
1094
- */
1095
543
  quantityUsedForEstimate?: number;
1096
- /** @description The name of the shipping provider, such as FedEx, or USPS. */
1097
544
  shippingCarrierCode?: string;
1098
- /** @description The final shipping cost for all the items after all discounts are applied.<br /><br /><span class="tablenote"><b> Note: </b>The cost does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the <a href="/api-docs/static/rest-request-components.html#HTTP"><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying the supported marketplace (such as <code>EBAY_GB</code>) to see the VAT-inclusive cost. For more information on VAT, refer to <a href="https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650&st=12&pos=1&query=Your%20VAT%20obligations%20in%20the%20EU&intent=VAT">VAT Obligations in the EU</a>.</span> */
1099
545
  shippingCost?: components["schemas"]["ConvertedAmount"];
1100
- /** @description Indicates the class of the shipping cost. <br /><br /><b> Valid Values: </b> FIXED or CALCULATED <br /><br />Code so that your app gracefully handles any future changes to this list. */
1101
546
  shippingCostType?: string;
1102
- /** @description The type of shipping service. For example, USPS First Class. */
1103
547
  shippingServiceCode?: string;
1104
- /** @description The container that returns the country and postal code of where the item is to be shipped. These values come from the <code>contextualLocation</code> values in the <a href="/api-docs/buy/static/api-browse.html#Headers"> <code>X-EBAY-C-ENDUSERCTX</code></a> request header. If the header is not submitted, marketplace is used. */
1105
548
  shipToLocationUsedForEstimate?: components["schemas"]["ShipToLocation"];
1106
- /** @description Any trademark symbol, such as &#8482; or &reg;, that needs to be shown in superscript next to the shipping service name. */
1107
549
  trademarkSymbol?: string;
1108
- /** @description The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc. */
1109
550
  type?: string;
1110
551
  };
1111
- /** @description The type that defines the fields for the shipping information. */
1112
552
  ShippingOptionSummary: {
1113
- /** @description Indicates if the seller has committed to shipping the item with eBay Guaranteed Delivery. With eBay Guaranteed Delivery, the seller is committed to getting the line item to the buyer within 4 business days or less. See the <a href="https://www.ebay.com/help/buying/shipping-delivery/buying-items-ebay-guaranteed-delivery?id=4641">Buying items with eBay Guaranteed Delivery</a> help topic for more details about eBay Guaranteed Delivery. */
1114
553
  guaranteedDelivery?: boolean;
1115
- /** @description The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. <br /> <br /> <span class="tablenote"> <b> Note: </b> For the best accuracy, always include the <code> contextualLocation</code> values in the <a href="/api-docs/buy/static/api-browse.html#Headers"> <code>X-EBAY-C-ENDUSERCTX</code></a> request header.</span> */
1116
554
  maxEstimatedDeliveryDate?: string;
1117
- /** @description The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. <br /> <br /><span class="tablenote"> <b> Note: </b> For the best accuracy, always include the <code> contextualLocation</code> values in the <a href="/api-docs/buy/static/api-browse.html#Headers"> <code>X-EBAY-C-ENDUSERCTX</code></a> request header.</span> */
1118
555
  minEstimatedDeliveryDate?: string;
1119
- /** @description This is the estimated price to ship the item.<br /><br />The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must do one or more of the following to see VAT-inclusive pricing:<ul><li>Pass the <a href="/api-docs/static/rest-request-components.html#HTTP"><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying the supported marketplace (such as <code>EBAY_GB</code>)</li><li>Pass the <code>contextualLocation</code> values for the supported marketplace in the <a href="/api-docs/buy/static/api-browse.html#Headers"><code>X-EBAY-C-ENDUSERCTX</code></a> request header</li><li>Specify the supported marketplace using the <a href="/api-docs/buy/static/ref-buy-browse-filters.html#deliveryCountry"><code>deliveryCountry</code></a> <b>filter</b> URI parameter (such as <code>filter=deliveryCountry:GB</code>)</li></ul><span class="tablenote"><b> Note: </b>For more information on VAT, refer to <a href="https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650&st=12&pos=1&query=Your%20VAT%20obligations%20in%20the%20EU&intent=VAT">VAT Obligations in the EU</a>.</span> */
1120
556
  shippingCost?: components["schemas"]["ConvertedAmount"];
1121
- /** @description Indicates the type of shipping used to ship the item. Possible values are <code> FIXED</code> (flat-rate shipping) and <code> CALCULATED</code> (shipping cost calculated based on item and buyer location). */
1122
557
  shippingCostType?: string;
1123
558
  };
1124
- /** @description The type that defines the fields for the distance between the item location and the buyer's location. */
1125
559
  TargetLocation: {
1126
- /** @description This value shows the unit of measurement used to measure the distance between the location of the item and the buyer's location. This value is typically <code> mi</code> or <code> km</code>. */
1127
560
  unitOfMeasure?: string;
1128
- /** @description This value indicates the distance (measured in the measurement unit in the <b> unitOfMeasure</b> field) between the item location and the buyer's location. */
1129
561
  value?: string;
1130
562
  };
1131
- /** @description The type that defines the fields for the tax jurisdiction details. */
1132
563
  TaxJurisdiction: {
1133
- /** @description The region of the tax jurisdiction. */
1134
564
  region?: components["schemas"]["Region"];
1135
- /** @description The identifier of the tax jurisdiction. */
1136
565
  taxJurisdictionId?: string;
1137
566
  };
1138
- /** @description The type that defines the tax fields. */
1139
567
  Taxes: {
1140
- /** @description This field is only returned if <code>true</code>, and indicates that eBay will collect tax (sales tax, Goods and Services tax, or VAT) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence. */
1141
568
  ebayCollectAndRemitTax?: boolean;
1142
- /** @description This indicates if tax was applied for the cost of the item. */
1143
569
  includedInPrice?: boolean;
1144
- /** @description This indicates if tax is applied for the shipping cost. */
1145
570
  shippingAndHandlingTaxed?: boolean;
1146
- /** @description The container that returns the tax jurisdiction. */
1147
571
  taxJurisdiction?: components["schemas"]["TaxJurisdiction"];
1148
- /** @description The percentage of tax. */
1149
572
  taxPercentage?: string;
1150
- /** @description This field indicates the type of tax that may be collected for the item. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:TaxType'>eBay API documentation</a> */
1151
573
  taxType?: string;
1152
574
  };
1153
- /** @description The type that defines the fields for a period of time in the time-measurement units supplied. */
1154
575
  TimeDuration: {
1155
- /** @description An enumeration value that indicates the units (such as hours) of the time span. The enumeration value in this field defines the period of time being used to measure the duration. <br><br><b> Valid Values: </b> YEAR, MONTH, DAY, HOUR, CALENDAR_DAY, BUSINESS_DAY, MINUTE, SECOND, or MILLISECOND <br /><br />Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:TimeDurationUnitEnum'>eBay API documentation</a> */
1156
576
  unit?: string;
1157
- /**
1158
- * Format: int32
1159
- * @description Retrieves the duration of the time span (no units).The value in this field indicates the number of years, months, days, hours, or minutes in the defined period.
1160
- */
1161
577
  value?: number;
1162
578
  };
1163
- /** @description The type that defines the fields for the name/value pairs for item aspects. */
1164
579
  TypedNameValue: {
1165
- /** @description The text representing the name of the aspect for the name/value pair, such as Color. */
1166
580
  name?: string;
1167
- /** @description This indicates if the value being returned is a string or an array of values. <br><br><b> Valid Values: </b> <ul><li><b> STRING</b> - Indicates the value returned is a string.</li> <li><b> STRING_ARRAY</b> - Indicates the value returned is an array of strings.</li></ul> Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ValueTypeEnum'>eBay API documentation</a> */
1168
581
  type?: string;
1169
- /** @description The value of the aspect for the name/value pair, such as Red. */
1170
582
  value?: string;
1171
583
  };
1172
- /** @description The type that defines the fields for the <b>updateQuantity</b> request. */
1173
584
  UpdateCartItemInput: {
1174
- /** @description The identifier of the item in the cart to be updated. This ID is generated when the item was added to the cart. */
1175
585
  cartItemId?: string;
1176
- /**
1177
- * Format: int32
1178
- * @description The new quantity for the item that is being updated.
1179
- */
1180
586
  quantity?: number;
1181
587
  };
1182
- /** @description The type the defines the fields for the VAT (value add tax) information. */
1183
588
  VatDetail: {
1184
- /** @description The two-letter <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166</a> standard of the country issuing the seller's VAT (value added tax) ID. VAT is a tax added by some European countries. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay API documentation</a> */
1185
589
  issuingCountry?: string;
1186
- /** @description The seller's VAT (value added tax) ID. VAT is a tax added by some European countries. */
1187
590
  vatId?: string;
1188
591
  };
1189
592
  };
@@ -1195,217 +598,149 @@ export interface components {
1195
598
  }
1196
599
  export type external = Record<string, never>;
1197
600
  export interface operations {
1198
- /** @description <p>This method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combination of these. </p><p><span class="tablenote"><b> Note: </b>Only FIXED_PRICE (Buy It Now) items are returned by default. However, this method does return items where both FIXED_PRICE and AUCTION are available as a buying option. After a bid has been placed, items become active auction items and are no longer returned by default, but they remain accessible by filtering for the AUCTION buying option.</span></p><p>This method also supports the following: <ul> <li>Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the <a href="#uri.filter">filter</a> parameter.</li> <li>Retrieving the refinements (metadata) of an item , such as item aspects (color, brand), condition, category, etc. using the <a href="#uri.fieldgroups">fieldgroups</a> parameter. </li> <li>Filtering by item aspects and other refinements using the <a href="#uri.aspect_filter">aspect_filter</a> parameter. </li> <li>Filtering for items that are compatible with a specific product, using the <a href="#uri.compatibility_filter">compatibility_filter</a> parameter. </li><li>Creating aspects histograms, which enables shoppers to drill down in each refinement narrowing the search results. </li> </ul></p> <p>For details and examples of these capabilities, see <a href="/api-docs/buy/static/api-browse.html">Browse API</a> in the Buying Integration Guide.</p> <h3><b> Pagination and sort controls</b></h3> <p>There are pagination controls (<b>limit</b> and <b>offset</b> fields) and <b> sort</b> query parameters that control/sort the data that is returned. By default, the results are sorted by &quot;Best Match&quot;. For more information about Best Match, see the eBay help page <a href="https://pages.ebay.com/help/sell/searchstanding.html" target="_blank">Best Match</a>. </p> <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item_summary/search?</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/item_summary/search?</code></li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b>Restrictions </b></h3> <p>This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network: </b> In order to receive a commission for your sales, you must use the URL returned in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the ebay.com site. </span> */
1199
601
  search: {
1200
602
  parameters: {
1201
603
  query?: {
1202
- /** @description This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspects pairs and the category, which is returned in the <b> dominantCategoryId</b> field, set <b> fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><b>Required: </b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter */
1203
604
  aspect_filter?: string;
1204
- /** @description A query parameter that enables auto correction.<br /><br /><b>Valid Values:</b> <code>KEYWORD</code> */
1205
605
  auto_correct?: string;
1206
- /** @description <a name="category_ids"></a>The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs.<br /><br /><b> For example: </b><br/><code>/buy/browse/v1/item_summary/search?category_ids=29792</code> <br /><br /><span class="tablenote"><b> Note: </b>Currently, you can pass in only one category ID per request.</span> <br /> <br />You can also use any combination of the <b> category_Ids</b>, <b> epid</b>, and <b> q</b> fields. This gives you additional control over the result set. <br /><br />For example, let's say you are looking of a toy phone. If you search for "phone", the result set will be mobile phones because this is the "Best Match" for this search. But if you also include the toy category ID, the results will be what you wanted. <br /><br /><b> For example: </b><br /><code>/buy/browse/v1/item_summary/search?q=phone&category_ids=220</code><br /> <br />The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site: <ul> <li>Use the <a href="https://pages.ebay.com/sellerinformation/news/categorychanges.html" target="_blank">Category Changes page</a>.</li> <li>Use the Taxonomy API. For details see <a href="/api-docs/buy/buy-categories.html">Get Categories for Buy APIs</a>. </li> <li>Submit the following method to get the <b> dominantCategoryId</b> for an item. <br /><br /><code>/buy/browse/v1/item_summary/search?q=<em> keyword</em>&fieldgroups=ASPECT_REFINEMENTS </code></li></ul> <span class="tablenote"> <b> Note:</b> If a top-level (L1) category is specified, you <b> must</b> also include the <b> q</b> query parameter.</span> <br /><br /><b> Required: </b> The method must have <b> category_ids</b>, <b> epid</b>, <b> gtin</b>, or <b> q</b> (or any combination of these) */
1207
606
  category_ids?: string;
1208
- /** @description The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.<br /><br /> <b>For example:</b><br /><code>/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469</code><br /><br />The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called "Charity Number". <ul><li>To find the charities eBay supports, you can search for a charity at <a href="https://charity.ebay.com/search" target="_blank">Charity Search </a> or go to <a href="https://www.ebay.com/b/Charity/bn_7114598164" target="_blank">Charity Shop</a>.</li> <li>To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for <a href="https://charity.ebay.com/charity/American-Red-Cross/3843" target="_blank">American Red Cross</a>, is <code>530196605</code>.</li></ul> You can also use any combination of the <code>category_Ids</code> and <code>q</code> fields with a <code>charity_Ids</code> to filter the result set. This gives you additional control over the result set. <br /><br /><b>Restriction: </b> This is supported only on the US and GB marketplaces.<br /><br /><b>Maximum: </b> 20 IDs <br /><br /><b>Required:</b> One ID */
1209
607
  charity_ids?: string;
1210
- /** @description This field specifies the attributes used to define a specific product. The service searches for items matching the keyword or matching the keyword and a product attribute value in the title of the item. <br /><br />For example, if the keyword is <code>brakes</code> and <code>compatibility-filter=Year:2018;Make:Honda</code>, the items returned are items with brakes, 2018, or Honda in the title. <br /><br />The service uses the product attributes to determine if the item is compatible. The service returns the attributes that are compatible and the <a href="/api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.compatibilityMatch"> CompatibilityMatchEnum</a> value that indicates how well the item matches the attributes. <br /><br />For the best compatibility results, submit all the attributes used to define the product. <br /><br /><b>Best Practice: </b> Submit all the <a href="/api-docs/buy/static/api-browse.html#product-attributes">product attributes</a> for the specific product. <br /><br />For more details, see <a href="/api-docs/buy/static/api-browse.html#Check">Check compatibility</a> in the Buy Integration Guide. <br /><br /> <span class="tablenote"><b>Note: </b> The only products supported are cars, trucks, and motorcycles. </span> <br /><br /> <p>For an example, see the <a href="/api-docs/buy/browse/resources/item_summary/methods/search#w4-w1-w5-ReturnItemsthatareCompatiblewiththeKeywordandVehicle-9">Samples</a> section. <br /><br /> <span class="tablenote"><b>Note: </b> Testing in Sandbox is only supported using mock data. See <a href="/api-docs/buy/static/api-browse.html#sbox-test">Testing search in the Sandbox</a> for details. </span> <br /><br /><b>Required: </b><ul> <li><b> q</b> (keyword)</li> <li> one fitment supported category ID (such as <code>33559</code> Brakes)</li> <li> a least one <a href="/api-docs/buy/static/api-browse.html#product-attributes">product attribute name/value pair</a></li></ul> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:CompatibilityFilter */
1211
608
  compatibility_filter?: string;
1212
- /** @description The ePID is the eBay product identifier of a product from the eBay product catalog. This field limits the results to only items in the specified ePID. <br /><br />The <b> Marketing</b> API <b>getMerchandisedProducts</b> method and the <b>Browse</b> API <b> getItem</b>, <b> getItemByLegacyId</b>, and <b> getItemsByItemGroup</b> calls return the ePID of the product. You can also use the <a href="/api-docs/commerce/catalog/resources/product_summary/methods/search">product_summary/search</a> method in the <b>Catalog</b> API to search for the ePID of the product. <br /><br /><b> For example: </b><br/><code>/buy/browse/v1/item_summary/search?epid=15032</code> <br /><br /><b> Maximum: </b> 1 <br /><br /><b> Required: </b> The method must have <b> category_ids</b>, <b> epid</b>, <b> gtin</b>, or <b> q</b> (or any combination of these) */
1213
609
  epid?: string;
1214
- /** @description This field is a comma separated list of values that lets you control what is returned in the response. The default is <b> MATCHING_ITEMS</b>, which returns the items that match the keyword or category specified. The other values return data that can be used to create histograms or provide additional information. <br /><br /><b> Valid Values: </b> <ul> <li><b> ASPECT_REFINEMENTS</b> - This returns the <a href="#response.refinement.aspectDistributions">aspectDistributions</a> container, which has the <b> dominantCategoryId</b>, <b> matchCount</b>, and <b> refinementHref</b> for the various aspects of the items found. For example, if you searched for 'Mustang', some of the aspect would be <b> Model Year</b>, <b> Exterior Color</b>, <b> Vehicle Mileage</b>, etc. <br /> <br /><span class="tablenote"> <b>Note: </b> ASPECT_REFINEMENTS are category specific.</span> <br /><br /></li> <li><b> BUYING_OPTION_REFINEMENTS</b> - This returns the <a href="#response.refinement.buyingOptionDistributions">buyingOptionDistributions</a> container, which has the <b> matchCount</b> and <b> refinementHref</b> for <b> AUCTION</b> and <b> FIXED_PRICE</b> (Buy It Now) items. <br /><br /><span class="tablenote"> <b>Note: </b>Classified items are not supported and only "Buy It Now" (non-auction) items are returned.</span> <br /><br /> </li> <li><b> CATEGORY_REFINEMENTS</b> - This returns the <a href="#response.refinement.categoryDistributions">categoryDistributions</a> container, which has the categories that the item is in. </li> <li><b> CONDITION_REFINEMENTS</b> - This returns the <a href="#response.refinement.conditionDistributions">conditionDistributions</a> container, such as <b> NEW</b>, <b> USED</b>, etc. Within these groups are multiple states of the condition. For example, <b> New </b> can be New without tag, New in box, New without box, etc. </li> <li><b> EXTENDED</b> - This returns the <a href="/api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.shortDescription">shortDescription</a> field, which provides condition and item aspect information and the <a href="/api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.itemLocation.city">itemLocation.city</a> field. </li> <li><b> MATCHING_ITEMS</b> - This is meant to be used with one or more of the refinement values above. You use this to return the specified refinements and all the matching items. </li> <li><b> FULL </b> - This returns all the refinement containers and all the matching items.</li> </ul> Code so that your app gracefully handles any future changes to this list. <br /><br /><b>Default: </b> MATCHING_ITEMS */
1215
610
  fieldgroups?: string;
1216
- /** @description This field supports multiple field filters that can be used to limit/customize the result set. <br /><br /><b> For example: </b><br /><code>/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50]</code><br /><br />You can also combine filters. <br /><code>/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50],sellers:{rpseller|bigSal} </code> <br /><br />The following are the supported filters. For details and examples for all the filters, see <a href="/api-docs/buy/static/ref-buy-browse-filters.html">Buy API Field Filters</a>. <div style="overflow-x:auto;"> <table> <tr> <td> <ul> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#bidCount">bidCount</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#buyingOptions">buyingOptions</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#charityOnly">charityOnly</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#conditionIds">conditionIds</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#conditions">conditions</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#deliveryCountry">deliveryCountry</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#deliveryOptions">deliveryOptions</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#deliveryPostalCode">deliveryPostalCode</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#excludeCategoryIds">excludeCategoryIds</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#excludeSellers">excludeSellers</a> </li> </ul></td> <td> <ul> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#guaranteedDeliveryInDays">guaranteedDeliveryInDays</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#itemEndDate">itemEndDate</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#itemLocationCountry">itemLocationCountry</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#itemStartDate">itemStartDate</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#maxDeliveryCost">maxDeliveryCost</a></li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#paymentMethods">paymentMethods</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#pickupCountry">pickupCountry</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#pickupPostalCode">pickupPostalCode</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#pickupRadius">pickupRadius</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#pickupRadiusUnit">pickupRadiusUnit</a> </li> </ul></td> <td> <ul> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#price">price</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#priceCurrency">priceCurrency</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#priorityListing">priorityListing</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#qualifiedPrograms">qualifiedPrograms</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#returnsAccepted">returnsAccepted</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#searchInDescription">searchInDescription</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#sellerAccountTypes">sellerAccountTypes</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#sellers">sellers</a> </li> </ul></td> </tr> </table> </div> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:FilterField */
1217
611
  filter?: string;
1218
- /** @description This field lets you search by the Global Trade Item Number of the item as defined by <a href="https://www.gtin.info" target="_blank">https://www.gtin.info</a>. You can search only by UPC (Universal Product Code). If you have other formats of GTIN, you need to search by keyword. <br /><br /><b> For example: </b><br/><code> /buy/browse/v1/item_summary/search?gtin=099482432621</code> <br /><br /> <b> Maximum: </b> 1 <br /><br /><b> Required: </b> The method must have <b> category_ids</b>, <b> epid</b>, <b> gtin</b>, or <b> q</b> (or any combination of these) */
1219
612
  gtin?: string;
1220
- /** @description The number of items, from the result set, returned in a single page. <br /><br /><b> Default:</b> 50 <br /><br /><b> Maximum number of items per page (limit): </b>200 <br /><br /> <b> Maximum number of items in a result set: </b> 10,000 */
1221
613
  limit?: string;
1222
- /** @description Specifies the number of items to skip in the result set. This is used with the <b> limit</b> field to control the pagination of the output. <br /><br />If <b> offset</b> is 0 and <b> limit</b> is 10, the method will retrieve items 1-10 from the list of items returned, if <b> offset</b> is 10 and <b> limit</b> is 10, the method will retrieve items 11 thru 20 from the list of items returned. <br /><br /><b> Valid Values</b>: 0-10,000 (inclusive) <br /> <br /> <b> Default:</b> 0 <br /> <br /> <b> Maximum number of items returned: </b> 10,000 */
1223
614
  offset?: string;
1224
- /** @description A string consisting of one or more keywords that are used to search for items on eBay. The keywords are handled as follows:<ul><li>If the keywords are separated by a space, it is treated as an AND. In the following example, the query returns items that have iphone <b>AND</b> ipad.<br /><br /><code>/buy/browse/v1/item_summary/search?q=iphone ipad</code><br/><br /></li><li>If the keywords are input using parentheses and separated by a comma, or if they are URL-encoded, it is treated as an OR. In the following examples, the query returns items that have iphone <b>OR</b> ipad.<br /><br /><code>/buy/browse/v1/item_summary/search?q=(iphone, ipad)</code><br /><br /><code>/buy/browse/v1/item_summary/search?q=%28iphone%2c%20ipad%29</code><br /><br /></li></ul><b>Restriction:</b> The <code>*</code> wildcard character is <b>not</b> allowed in this field.<br /><br /><b>Required:</b> The method must have <b>category_ids</b>, <b>epid</b>, <b>gtin</b>, or <b>q</b> (or any combination of these). */
1225
615
  q?: string;
1226
- /** @description Specifies the order and the field name to use to sort the items. <br /><br />You can sort items by price (in ascending or descending order) or by distance (only applicable if the <a href="/api-docs/buy/static/ref-buy-browse-filters.html#pickupCountry">"pickup" filters</a> are used, and only ascending order is supported). You can also sort items by listing date, with the most recently listed (newest) items appearing first.<br /><br /><span class="tablenote"><b>Note: </b> To sort in descending order, insert a hyphen (<code>-</code>) before the field name. If no <b>sort</b> parameter is submitted, the result set is sorted by &quot;<a href="https://pages.ebay.com/help/sell/searchstanding.html" target="_blank">Best Match</a>&quot;.</span><br /><br />The following are examples of using the <b> sort</b> query parameter.<br /><br /><table><tr><th>Sort</th><th>Result</th> </tr> <tr> <td><code>sort=price</code></td> <td> Sorts by <b> price</b> in ascending order (lowest price first)</td> </tr> <tr> <td><code>sort=-price</code></td> <td> Sorts by <b> price</b> in descending order (highest price first)</td> </tr> <tr> <td><code>sort=distance</code></td> <td> Sorts by <b> distance</b> in ascending order (shortest distance first)</td> </tr> <tr> <td><code>sort=newlyListed</code></td> <td>Sorts by <b>listing date</b> (most recently listed/newest items first)</td> </tr> <tr> <td><code>sort=endingSoonest</code></td> <td>Sorts by <b>date/time</b> the listing ends (listings nearest to end date/time first)</td> </tr> </table> <br /><b> Default: </b> Ascending For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:SortField */
1227
616
  sort?: string;
1228
617
  };
1229
618
  };
1230
619
  responses: {
1231
- /** @description OK */
1232
620
  200: {
1233
621
  content: {
1234
622
  "application/json": components["schemas"]["SearchPagedCollection"];
1235
623
  };
1236
624
  };
1237
- /** @description Bad Request */
1238
625
  400: never;
1239
- /** @description Conflict */
1240
626
  409: never;
1241
- /** @description Internal Server Error */
1242
627
  500: never;
1243
628
  };
1244
629
  };
1245
- /** @description <img src="/cms/img/docs/experimental-icon.svg" class="legend-icon experimental-icon" alt="Experimental Release" title="Experimental Release"> This is an <a href="https://developer.ebay.com/api-docs/static/versioning.html#experimental">Experimental</a> method. <p>This method searches for eBay items based on a image and retrieves summaries of the items. You pass in a Base64 image in the request payload and can refine the search by category, or eBay product ID (ePID), or a combination of these using URI parameters. <br /><br />To get the Base64 image string, you can use sites such as <a href="https://codebeautify.org/image-to-base64-converter" target="_blank">https://codebeautify.org/image-to-base64-converter</a>. </p> <p>This method also supports the following: <ul> <li>Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the <a href="#uri.filter">filter</a> parameter.</li> <li>Filtering by item aspects using the <a href="#uri.aspect_filter">aspect_filter</a> parameter. </li> </ul></p> <p>For details and examples of these capabilities, see <a href="/api-docs/buy/static/api-browse.html">Browse API</a> in the Buying Integration Guide.</p> <h3><b>Pagination and sort controls</b></h3> <p>There are pagination controls (<b>limit</b> and <b>offset</b> fields) and <b> sort</b> query parameters that control/sort the data that is returned. By default, the results are sorted by &quot;Best Match&quot;. For more information about Best Match, see the eBay help page <a href="https://pages.ebay.com/help/sell/searchstanding.html" target="_blank">Best Match</a>. </p> <h3><b> URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item_summary/search_by_image?</code></li> <li><b> Sandbox URL: </b>Due to the data available, this method is not supported in the eBay Sandbox. To test your integration, use the Production URL.</li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b>URL Encoding for Parameters</b></h3> <p>Query parameter values need to be URL encoded. For details, see <a href="/api-docs/static/rest-request-components.html#parameters">URL encoding query parameter values</a>. For readability, code examples in this document have not been URL encoded.</p> <h3><b>Restrictions </b></h3> <p>This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network: </b> In order to receive a commission for your sales, you must use the URL returned in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the ebay.com site. </span> */
1246
630
  searchByImage: {
1247
631
  parameters: {
1248
632
  query?: {
1249
- /** @description This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br /><b>Required: </b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter */
1250
633
  aspect_filter?: string;
1251
- /** @description The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs. <br /><br /><span class="tablenote"><b> Note: </b>Currently, you can pass in only one category ID per request.</span> <br /> <br />You can also use any combination of the <b> category_Ids</b> and <b> epid</b> fields. This gives you additional control over the result set.<br /> <br />The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site: <ul> <li>Use the <a href="https://pages.ebay.com/sellerinformation/news/categorychanges.html" target="_blank">Category Changes page</a>.</li> <li>Use the Taxonomy API. For details see <a href="/api-docs/buy/buy-categories.html">Get Categories for Buy APIs</a>. </li> <li>Submit the following method to get the <b> dominantCategoryId</b> for an item. <br /><code>/buy/browse/v1/item_summary/search?q=<em > keyword</em>&fieldgroups=ASPECT_REFINEMENTS </code></li></ul> <b> Required: </b> The method must have <b> category_ids</b> or <b> epid</b> (or any combination of these) */
1252
634
  category_ids?: string;
1253
- /** @description The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.<br /><br /> <b>For example:</b><br /><code>/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469</code><br /><br />The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called "Charity Number". <ul><li>To find the charities eBay supports, you can search for a charity at <a href="https://charity.ebay.com/search" target="_blank">Charity Search </a> or go to <a href="https://www.ebay.com/b/Charity/bn_7114598164" target="_blank">Charity Shop</a>.</li> <li>To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for <a href="https://charity.ebay.com/charity/American-Red-Cross/3843" target="_blank">American Red Cross</a>, is <code>530196605</code>.</li></ul> You can also use any combination of the <code>category_Ids</code> and <code>q</code> fields with a <code>charity_Ids</code> to filter the result set. This gives you additional control over the result set. <br /><br /><b>Restriction: </b> This is supported only on the US and GB marketplaces.<br /><br /><b>Maximum: </b> 20 IDs <br /><br /><b>Required:</b> One ID */
1254
635
  charity_ids?: string;
1255
- /** @description This field is a comma separated list of values that lets you control what is returned in the response. The default is <b> MATCHING_ITEMS</b>, which returns the items that match the keyword or category specified. The other values return data that can be used to create histograms or provide additional information. <br /><br /><b> Valid Values: </b> <ul> <li><b> ASPECT_REFINEMENTS</b> - This returns the <a href="#response.refinement.aspectDistributions">aspectDistributions</a> container, which has the <b> dominantCategoryId</b>, <b> matchCount</b>, and <b> refinementHref</b> for the various aspects of the items found. For example, if you searched for 'Mustang', some of the aspect would be <b> Model Year</b>, <b> Exterior Color</b>, <b> Vehicle Mileage</b>, etc. <br /> <br /><span class="tablenote"> <b>Note: </b> ASPECT_REFINEMENTS are category specific.</span> <br /><br /></li> <li><b> BUYING_OPTION_REFINEMENTS</b> - This returns the <a href="#response.refinement.buyingOptionDistributions">buyingOptionDistributions</a> container, which has the <b> matchCount</b> and <b> refinementHref</b> for <b> AUCTION</b> and <b> FIXED_PRICE</b> (Buy It Now) items. <br /><br /><span class="tablenote"> <b>Note: </b>Classified items are not supported and only "Buy It Now" (non-auction) items are returned.</span> <br /><br /> </li> <li><b> CATEGORY_REFINEMENTS</b> - This returns the <a href="#response.refinement.categoryDistributions">categoryDistributions</a> container, which has the categories that the item is in. </li> <li><b> CONDITION_REFINEMENTS</b> - This returns the <a href="#response.refinement.conditionDistributions">conditionDistributions</a> container, such as <b> NEW</b>, <b> USED</b>, etc. Within these groups are multiple states of the condition. For example, <b> New </b> can be New without tag, New in box, New without box, etc. </li> <li><b> EXTENDED</b> - This returns the <a href="/api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.shortDescription">shortDescription</a> field, which provides condition and item aspect information and the <a href="/api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.itemLocation.city">itemLocation.city</a> field. </li> <li><b> MATCHING_ITEMS</b> - This is meant to be used with one or more of the refinement values above. You use this to return the specified refinements and all the matching items. </li> <li><b> FULL </b> - This returns all the refinement containers and all the matching items.</li> </ul> Code so that your app gracefully handles any future changes to this list. <br /><br /><b>Default: </b> MATCHING_ITEMS */
1256
636
  fieldgroups?: string;
1257
- /** @description This field supports multiple field filters that can be used to limit/customize the result set. <br /><br /><b> For example: </b><br /><code>/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50]</code><br /><br />You can also combine filters. <br /><code>/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50],sellers:{rpseller|bigSal} </code> <br /><br />The following are the supported filters. For details and examples for all the filters, see <a href="/api-docs/buy/static/ref-buy-browse-filters.html">Buy API Field Filters</a>. <div style="overflow-x:auto;"> <table> <tr> <td> <ul> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#bidCount">bidCount</a> </li><li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#buyingOptions">buyingOptions</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#charityOnly">charityOnly</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#conditionIds">conditionIds</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#conditions">conditions</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#deliveryCountry">deliveryCountry</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#deliveryOptions">deliveryOptions</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#deliveryPostalCode">deliveryPostalCode</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#excludeCategoryIds">excludeCategoryIds</a> </li> </ul></td> <td> <ul> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#excludeSellers">excludeSellers</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#guaranteedDeliveryInDays">guaranteedDeliveryInDays</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#itemEndDate">itemEndDate</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#itemLocationCountry">itemLocationCountry</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#itemStartDate">itemStartDate</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#maxDeliveryCost">maxDeliveryCost</a></li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#paymentMethods">paymentMethods</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#pickupCountry">pickupCountry</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#pickupPostalCode">pickupPostalCode</a> </li> </ul> </td> <td> <ul> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#pickupRadius">pickupRadius</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#pickupRadiusUnit">pickupRadiusUnit</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#price">price</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#priceCurrency">priceCurrency</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#qualifiedPrograms">qualifiedPrograms</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#returnsAccepted">returnsAccepted</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#sellerAccountTypes">sellerAccountTypes</a> </li> <li><a href="/api-docs/buy/static/ref-buy-browse-filters.html#sellers">sellers</a> </li> </ul></td> </tr> </table> </div> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:FilterField */
1258
637
  filter?: string;
1259
- /** @description The number of items, from the result set, returned in a single page. <br /><br /><b> Default:</b> 50 <br /> <br /><b> Maximum number of items per page (limit): </b>200 <br /> <br /> <b> Maximum number of items in a result set: </b> 10,000 */
1260
638
  limit?: string;
1261
- /** @description The number of items to skip in the result set. This is used with the <b> limit</b> field to control the pagination of the output. <br /><br />If <b> offset</b> is 0 and <b> limit</b> is 10, the method will retrieve items 1-10 from the list of items returned, if <b> offset</b> is 10 and <b> limit</b> is 10, the method will retrieve items 11 thru 20 from the list of items returned. <br /><br /><b> Valid Values</b>: 0-10,000 (inclusive) <br /> <br /> <b> Default:</b> 0 <br /> <br /> <b> Maximum number of items returned: </b> 10,000 */
1262
639
  offset?: string;
1263
- /** @description Specifies the order and the field name to use to sort the items. <br /><br />You can sort items by price (in ascending or descending order) or by distance (only applicable if the <a href="/api-docs/buy/static/ref-buy-browse-filters.html#pickupCountry">"pickup" filters</a> are used, and only ascending order is supported). You can also sort items by listing date, with the most recently listed (newest) items appearing first.<br /><br /><span class="tablenote"><b>Note: </b> To sort in descending order, insert a hyphen (<code>-</code>) before the field name. If no <b>sort</b> parameter is submitted, the result set is sorted by &quot;<a href="https://pages.ebay.com/help/sell/searchstanding.html" target="_blank">Best Match</a>&quot;.</span><br /><br />The following are examples of using the <b> sort</b> query parameter.<br /><br /><table><tr><th>Sort</th><th>Result</th> </tr> <tr> <td><code>sort=price</code></td> <td> Sorts by <b> price</b> in ascending order (lowest price first)</td> </tr> <tr> <td><code>sort=-price</code></td> <td> Sorts by <b> price</b> in descending order (highest price first)</td> </tr> <tr> <td><code>sort=distance</code></td> <td> Sorts by <b> distance</b> in ascending order (shortest distance first)</td> </tr> <tr> <td><code>sort=newlyListed</code></td> <td>Sorts by <b>listing date</b> (most recently listed/newest items first)</td> </tr> <tr> <td><code>sort=endingSoonest</code></td> <td>Sorts by <b>date/time</b> the listing ends (listings nearest to end date/time first)</td> </tr> </table> <br /><b> Default: </b> Ascending For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:SortField */
1264
640
  sort?: string;
1265
641
  };
1266
642
  };
1267
- /** @description The container for the image information fields. */
1268
643
  requestBody?: {
1269
644
  content: {
1270
645
  "application/json": components["schemas"]["SearchByImageRequest"];
1271
646
  };
1272
647
  };
1273
648
  responses: {
1274
- /** @description OK */
1275
649
  200: {
1276
650
  content: {
1277
651
  "application/json": components["schemas"]["SearchPagedCollection"];
1278
652
  };
1279
653
  };
1280
- /** @description Bad Request */
1281
654
  400: never;
1282
- /** @description Conflict */
1283
655
  409: never;
1284
- /** @description Internal Server Error */
1285
656
  500: never;
1286
657
  };
1287
658
  };
1288
- /** @description <p>This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery, and other information the buyer needs to make a purchasing decision.</p><p>The Buy APIs are designed to let you create an eBay shopping experience in your app or website. This means you will need to know when something, such as the availability, quantity, etc., has changed in any eBay item you are offering. You can do this easily by setting the <b> fieldgroups</b> URI parameter. This parameter lets you control what is returned in the response.</p> <p>Setting <b> fieldgroups</b> to <code>COMPACT</code> reduces the response to only the five fields that you need in order to check if any item detail has changed. Setting <b> fieldgroups</b> to <code>PRODUCT</code>, adds additional fields to the default response that return information about the product of the item. You can use either <code>COMPACT</code> or <code>PRODUCT</code> but not both. For more information, see <a href="/api-docs/buy/browse/resources/item/methods/getItem#uri.fieldgroups">fieldgroups</a>.</p> <h3>URLs for this method</h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item/{item_id}</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/item/{item_id}</code></li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b> Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network: </b> In order to be commissioned for your sales, you must use the URL returned in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the ebay.com site. </span> */
1289
659
  getItem: {
1290
660
  parameters: {
1291
661
  query?: {
1292
- /** @description This parameter lets you control what is returned in the response. If you do not set this field, the method returns all the details of the item. <br /> <br /> <b> Valid Values: </b> <ul> <li> <b> PRODUCT</b> - This adds the <code>additionalImages</code>, <code>additionalProductIdentities</code>, <code>aspectGroups</code>, <code>description</code>, <code>gtins</code>, <code>image</code>, and <code>title</code> product fields to the response, which describe the product associated with the item. See <a href="/api-docs/buy/browse/resources/item/methods/getItem#response.product">Product</a> for more information about these fields.</li> <li><b> COMPACT</b> - This returns only the following fields, which let you quickly check if the availability or price of the item has changed, if the item has been revised by the seller, or if an item's top-rated plus status has changed for items you have stored. <ul> <li> <b> itemId</b> - The identifier of the item.<li><b>itemAffiliateWebURL</b> - The URL of the View Item page of the item, which includes the affiliate tracking ID. This field is only returned if the eBay partner enables affiliate tracking for the item by including the <code>X-EBAY-C-ENDUSERCTX</code> request header in the method.</li><li><b>ItemWebURL</b> - The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay.</li> <li><b>legacyItemId</b> - The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.</li> <li><b> sellerItemRevision</b> - An identifier generated/incremented when a seller revises the item. The follow are the two types of item revisions: <ul> <li><b> Seller changes</b>, such as changing the title</li> <li> <b> eBay system changes</b>, such as changing the quantity when an item is purchased.</li> </ul> This ID is changed <em> only</em> when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed. To check if the quantity has changed, use <b> estimatedAvailabilities.</b></li> <li><b>taxes</b> - A container for the tax information for the item, such as the tax jurisdiction, the tax percentage, and the tax type.</li> <li><b> topRatedBuyingExperience</b> - A boolean value indicating if this item is a top-rated plus item. A change in the item's top rated plus standing is not tracked by the revision ID. See <a href="/api-docs/buy/browse/resources/item/methods/getItem#response.topRatedBuyingExperience">topRatedBuyingExperience</a> for more information.</li> <li><b> price</b> - This is tracked by the revision ID but is returned here to enable you to quickly verify the price of the item.</li> <li><b> estimatedAvailabilities</b> - Returns the item availability information, which is based on the item's quantity. <b> Note:</b> Changes in quantity are not tracked by <b> sellerItemRevision</b>.</li><li><b>itemEndDate</b> - This is the scheduled end time of the listing.</li><li> <b>eligibleForInlineCheckout</b> - This parameter returns items based on whether or not the items can be purchased using the Buy <a href="/api-docs/buy/order/resources/methods">Order API</a>. <ul> <li>If the value of this field is <code>true</code>, this indicates that the item can be purchased using the <b> Order API</b>. </li> <li>If the value of this field is <code>false</code>, this indicates that the item cannot be purchased using the <b> Order API</b> and must be purchased on the eBay site.</li> </ul></ul> <b> For Example</b> <br /> <br />To check if a stored item's information is current, do following. <ol> <li>Pass in the item ID and set <b> fieldgroups</b> to COMPACT. <br /> <br /><code>item/v1|4**********8|0?fieldgroups=COMPACT</code> </li> <li>Do one of the following: <ul> <li>If the <b> sellerItemRevision</b> field is returned and you <em>haven't</em> stored a revision number for this item, record the number and pass in the item ID in the <b> getItem</b> method to get the latest information.</li> <li>If the revision number is different from the value you have stored, update the value and pass in the item ID in the <b> getItem</b> method to get the latest information.</li> <li>If the <b> sellerItemRevision</b> field is <em>not</em> returned or has not changed, where needed, update the item information with the information returned in the response.</li> </ul> </li> </ol></li> </ul> </ul> <p><b> Maximum value: </b> 1 <br />If more than one values is specified, the first value will be used. */
1293
662
  fieldgroups?: string;
1294
663
  };
1295
664
  path: {
1296
- /** @description The eBay RESTful identifier of an item. This ID is returned by the <b> Browse</b> and <b> Feed</b> API methods. <br /><br /> <b> RESTful Item ID Format: </b><code>v1</code>|<code><i>#</i></code>|<code><i>#</i></code> <br />For example: <code>v1|2**********2|0</code> or <code>v1|1**********2|4**********2</code> <br /><br />For more information about item ID for RESTful APIs, see the <a href="/api-docs/buy/static/api-browse.html#Legacy">Legacy API compatibility</a> section of the <i>Buy APIs Overview</i>. */
1297
665
  item_id: string;
1298
666
  };
1299
667
  };
1300
668
  responses: {
1301
- /** @description Success */
1302
669
  200: {
1303
670
  content: {
1304
671
  "application/json": components["schemas"]["Item"];
1305
672
  };
1306
673
  };
1307
- /** @description Bad Request */
1308
674
  400: never;
1309
- /** @description Not Found */
1310
675
  404: never;
1311
- /** @description Conflict */
1312
676
  409: never;
1313
- /** @description Internal Server Error */
1314
677
  500: never;
1315
678
  };
1316
679
  };
1317
- /** @description <p>This method is a bridge between the eBay legacy APIs, such as <b> Shopping</b>, and <b> Finding</b> and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an "item" and what the item ID represents. This method lets you use the legacy item ids retrieve the details of a specific item, such as description, price, and other information the buyer needs to make a purchasing decision. It also returns the RESTful item ID, which you can use with all the Buy API methods.</p> <p>For more information about how to use legacy ids with the Buy APIs, see <a href="/api-docs/buy/static/api-browse.html#Legacy">Legacy API compatibility</a> in the Buying Integration guide.</p> <p>This method returns the item details and requires you to pass in either the item ID of a non-variation item or the item ids of both the parent and child of an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.</p> <p>When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.</p> <p>The <b> fieldgroups</b> URI parameter lets you control what is returned in the response. Setting <b> fieldgroups</b> to <code>PRODUCT</code>, adds additional fields to the default response that return information about the product of the item. For more information, see <a href="/api-docs/buy/browse/resources/item/methods/getItemByLegacyItem#uri.fieldgroups">fieldgroups</a>.</p> <h3>URLs for this method</h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item/get_item_by_legacy_id?</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/item/get_item_by_legacy_id?</code></li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b> Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network: </b> In order to be commissioned for your sales, you must use the URL returned in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the ebay.com site. </span> */
1318
680
  getItemByLegacyId: {
1319
681
  parameters: {
1320
682
  query: {
1321
- /** @description This field lets you control what is returned in the response. If you do not set this field, the method returns all the details of the item. <b> Note</b>: In this method, the only value supported is <code>PRODUCT</code>. <p><b> Valid Values: </b><br /><br /> <b> PRODUCT</b> - This adds the <code>additionalImages</code>, <code>additionalProductIdentities</code>, <code>aspectGroups</code>, <code>description</code>, <code>gtins</code>, <code>image</code>, and <code>title</code> fields to the response, which describe the item's product. See <a href="/api-docs/buy/browse/resources/item/methods/getItemByLegacyItem#response.product">Product</a> for more information about these fields. <br /><br />Code so that your app gracefully handles any future changes to this list. */
1322
683
  fieldgroups?: string;
1323
- /** @description Specifies either: <ul> <li>The legacy item ID of an item that is <em>not</em> part of a group. </li> <li>The legacy item ID of a group, which is the ID of the "parent" of the group of items. <br /> <br /><span class="tablenote"> <b> Note: </b> If you pass in a group ID, you must also use the <b> legacy_variation_id</b> field and pass in the legacy ID of the specific item variation (child ID).</span></li></ul> Legacy ids are returned by APIs, such as the <a href="https://developer.ebay.com/devzone/finding/callref/index.html" target="_blank">Finding API</a>. <br /><br />The following is an example of using the value of the <b> ItemID</b> field for a specific item from Finding to get the RESTful <b> itemId</b> value. <br /> <br />&nbsp;&nbsp;&nbsp;<code> browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9 </code><br /><br /><b> Maximum: </b> 1 */
1324
684
  legacy_item_id: string;
1325
- /** @description Specifies the legacy item ID of a specific item in an item group, such as the red shirt size L. <br /><br />Legacy ids are returned by APIs, such as the <a href="https://developer.ebay.com/devzone/finding/callref/index.html" target="_blank">Finding API</a>. <br /><br /><b> Maximum: </b> 1 <br /><b> Requirement: </b> You must <b> always</b> pass in the <b> legacy_item_id </b> with the <b> legacy_variation_id</b> */
1326
685
  legacy_variation_id?: string;
1327
- /** @description Specifics the legacy SKU of the item. SKU are item ids created by the seller. <br /><br />Legacy SKUs are returned by eBay the <a href="https://developer.ebay.com/Devzone/shopping/docs/CallRef/index.html" target="_blank">Shopping API</a>. <br /><br />The following is an example of using the value of the <b> ItemID</b> and <b> SKU</b> fields to get the RESTful <b> itemId</b> value. <br /> <br />&nbsp;&nbsp;&nbsp;<code> browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9&amp;legacy_variation_sku=V**********M</code><br /><br /><b> Maximum: </b> 1 <br /><b> Requirement: </b> You must <b> always</b> pass in the <b> legacy_item_id </b> with the <b> legacy_variation_sku</b> */
1328
686
  legacy_variation_sku?: string;
1329
687
  };
1330
688
  };
1331
689
  responses: {
1332
- /** @description OK */
1333
690
  200: {
1334
691
  content: {
1335
692
  "application/json": components["schemas"]["Item"];
1336
693
  };
1337
694
  };
1338
- /** @description Bad Request */
1339
695
  400: never;
1340
- /** @description Not Found */
1341
696
  404: never;
1342
- /** @description Conflict */
1343
697
  409: never;
1344
- /** @description Internal Server Error */
1345
698
  500: never;
1346
699
  };
1347
700
  };
1348
- /** @description This method retrieves the details of specific items that the buyer needs to make a purchasing decision. <br><br><span class="tablenote"> <b>Note:</b> This is a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> available only to select Partners. <br><br>For this method, only the following fields are returned: <code>eligibleForInlineCheckout</code>, <code>estimatedAvailabilities</code>, <code>itemAffiliateWebUrl</code>, <code>itemId</code>, <code>itemWebUrl</code>, <code>legacyItemId</code>, <code>price</code>, <code>sellerItemRevision</code>, <code>taxes</code>, and <code>topRatedBuyingExperience</code>.</span> <h3>URLs for this method</h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item?</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/item?</code></li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b> Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network:</b> In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. */
1349
701
  getItems: {
1350
702
  parameters: {
1351
703
  query?: {
1352
- /** @description A list of item IDs. Item IDs are the eBay RESTful identifier of items. <br><br><b> RESTful Item ID Format: </b><code>v1</code>|<code><i>#</i></code>|<code><i>#</i></code><br>For example: <code>v1|2**********2|0</code> or <code>v1|1**********2|4**********2</code> <br><br>In any given request, either item_ids or item_group_ids can be retrieved. Attempting to retrieve both will result in an error. <br><br> In a request, multiple item_ids can be passed as comma separated values.<br><br><b> Maximum allowed itemIDs: </b> 20 <br><br>For more information about item IDs for RESTful APIs, see the <a href="/api-docs/buy/static/api-browse.html#Legacy">Legacy API compatibility</a> section of the <i>Buy APIs Overview</i>. */
1353
704
  item_ids?: string;
1354
- /** @description A list of item group IDs. Item group IDs are the eBay RESTful identifier of item groups. <br><br><b> RESTful Group Item ID Format: </b><code>############</code><br>For example: <code>3**********9</code><br><br>In any given request, either item_ids or item_group_ids can be retrieved. Attempting to retrieve both will result in an error.<br><br>In a request, multiple item_group_ids can be passed as comma separated values.<br><br><b> Maximum allowed itemGroupIDs: </b> 10 <br><br> */
1355
705
  item_group_ids?: string;
1356
706
  };
1357
707
  };
1358
708
  responses: {
1359
- /** @description Success */
1360
709
  200: {
1361
710
  content: {
1362
711
  "application/json": components["schemas"]["Items"];
1363
712
  };
1364
713
  };
1365
- /** @description Bad Request */
1366
714
  400: never;
1367
- /** @description Not Found */
1368
715
  404: never;
1369
- /** @description Conflict */
1370
716
  409: never;
1371
- /** @description Internal Server Error */
1372
717
  500: never;
1373
718
  };
1374
719
  };
1375
- /** @description <p>This method retrieves the details of the individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. </p> <p>You pass in the item group ID as a URI parameter. You use this method to show the item details of items with multiple aspects, such as color, size, storage capacity, etc. </p> <p>This method returns two main containers; <b> items</b> and <b> commonDescriptions</b>. The <b> items</b> container has an array of containers with the details of each item in the group. The <b> commonDescriptions</b> container has an array of containers for a description and the item ids of all the items that have this exact description. Because items within an item group often have the same description, this decreases the size of the response. </p> <h3>URLs for this method</h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/item/get_items_by_item_group?</code></li> </ul> </p> <h3><b> Request headers</b></h3> This method uses the <b>X-EBAY-C-ENDUSERCTX</b> request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, <a href="/api-docs/buy/static/api-browse.html#Headers">Request headers</a> in the Buying Integration Guide. <h3><b> Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> <span class="tablenote"><b>eBay Partner Network: </b> In order to be commissioned for your sales, you must use the URL returned in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the ebay.com site. </span> */
1376
720
  getItemsByItemGroup: {
1377
721
  parameters: {
1378
722
  query: {
1379
- /** @description Identifier of the item group to return. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. </p> <p>This ID is returned in the <b> itemGroupHref</b> field of the <a href="/api-docs/buy/browse/resources/item_summary/methods/search">search</a> and <a href="/api-docs/buy/browse/resources/item/methods/getItem">getItem</a> methods. <br /><br /><b> For Example: </b><code> https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?item_group_id=3**********6</code> */
1380
723
  item_group_id: string;
1381
724
  };
1382
725
  };
1383
726
  responses: {
1384
- /** @description OK */
1385
727
  200: {
1386
728
  content: {
1387
729
  "application/json": components["schemas"]["ItemGroup"];
1388
730
  };
1389
731
  };
1390
- /** @description Bad Request */
1391
732
  400: never;
1392
- /** @description Not Found */
1393
733
  404: never;
1394
- /** @description Conflict */
1395
734
  409: never;
1396
- /** @description Internal Server Error */
1397
735
  500: never;
1398
736
  };
1399
737
  };
1400
- /** @description This method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay. <br /><br />For example, to check the compatibility of a part, you pass in the item ID of the part as a URI parameter and specify all the attributes used to define a specific car in the <b> compatibilityProperties</b> container. If the call is successful, the response will be <b> COMPATIBLE</b>, <b> NOT_COMPATIBLE</b>, or <b> UNDETERMINED</b>. See <a href="/api-docs/buy/browse/resources/item/methods/checkCompatibility#response.compatibilityStatus">compatibilityStatus</a> for details. <br /><br /> <span class="tablenote"><b> Note: </b> The only products supported are cars, trucks, and motorcycles. </span><p> To find the attributes and values for a specific marketplace, you can use the compatibility methods in the <a href="/api-docs/commerce/taxonomy/resources/methods">Taxonomy API</a>. You can use this data to create menus to help buyers specify the product, such as their car.</p> <p> For more details and a list of the required attributes for the US marketplace that describe motor vehicles, see <a href="/api-docs/buy/static/api-browse.html#Check">Check compatibility</a> in the Buy Integration Guide</a>.</p> <p>For an example, see the <a href="/api-docs/buy/browse/resources/item/methods/checkCompatibility#h2-samples">Samples</a> section. </p> <h3>URLs for this method</h3> <p><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/item/{item_id}/check_compatibility</code> </p> <p><span class="tablenote"><b> Note: </b> This method is supported only on Production. </span></p> <h3><b> Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> */
1401
738
  checkCompatibility: {
1402
739
  parameters: {
1403
740
  header: {
1404
- /** @description The ID of the eBay marketplace you want to use. <b> Note: </b> This value is case sensitive.<br /><br />For example: <br />&nbsp;&nbsp;<code>X-EBAY-C-MARKETPLACE-ID = EBAY_US</code> <br /><br /> For a list of supported sites see, <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>. */
1405
741
  "X-EBAY-C-MARKETPLACE-ID": string;
1406
742
  };
1407
743
  path: {
1408
- /** @description The eBay RESTful identifier of an item (such as a part you want to check). This ID is returned by the <b> Browse</b> and <b> Feed</b> API methods. <br /><br /> <b> RESTful Item ID Format: </b><code>v1</code>|<code><i>#</i></code>|<code><i>#</i></code> <br />For example: <code>v1|2**********2|0</code> or <code>v1|1**********2|4**********2</code> <br /><br />For more information about item ID for RESTful APIs, see the <a href="/api-docs/buy/static/api-browse.html#Legacy">Legacy API compatibility</a> section of the <i>Buy APIs Overview</i>. */
1409
744
  item_id: string;
1410
745
  };
1411
746
  };
@@ -1415,23 +750,17 @@ export interface operations {
1415
750
  };
1416
751
  };
1417
752
  responses: {
1418
- /** @description OK */
1419
753
  200: {
1420
754
  content: {
1421
755
  "application/json": components["schemas"]["CompatibilityResponse"];
1422
756
  };
1423
757
  };
1424
- /** @description Bad Request */
1425
758
  400: never;
1426
- /** @description Not Found */
1427
759
  404: never;
1428
- /** @description Conflict */
1429
760
  409: never;
1430
- /** @description Internal Server Error */
1431
761
  500: never;
1432
762
  };
1433
763
  };
1434
- /** @description <span class="tablenote"><b>Note: </b><img src="/cms/img/docs/experimental-icon.svg" class="legend-icon experimental-icon" alt="Experimental Release" title="Experimental Release" alt="Experimental Release" title="Experimental Release" /> This is an <a href="https://developer.ebay.com/api-docs/static/versioning.html#experimental">Experimental</a> method that is available as a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> to select developers approved by business units.</span> <p>This method creates an eBay cart for the eBay member, if one does not exist, and adds items to that cart. Because a cart never expires, any item added to the cart will remain in the cart until it is removed. <br /><br />To use this method, you must submit a RESTful item ID and the quantity of the item. If the <b> quantity</b> value is greater than the number of available, the <b> quantity</b> value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the <b> quantity</b> value to 50, the service automatically changes the value of <b>quantity</b> to 15. <br /><br />The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, whether it has just been added to the cart or has been in the cart for some time, the item will be returned in the <b> unavailableCartItems</b> container.</p> <p span class="tablenote"><b>Note: </b>There are differences between how legacy APIs, such as Finding, and RESTful APIs, such as Browse, return the identifier of an "item" and what the item ID represents. If you have an item ID from one of the legacy APIs, you can use the legacy item ID with the <a href="/api-docs/buy/browse/resources/item/methods/getItemByLegacyId"> getItemByLegacyId</a> method to retrieve the RESTful ID for that item. For more information about how to use legacy IDs with the Buy APIs, see <a href="/api-docs/buy/static/api-browse.html#Legacy">Legacy API compatibility</a> in the Buying Integration guide.</p> <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/shopping_cart/add_item</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/add_item</code> <br /><br /><b>Note: </b>This method is not available in the eBay API Explorer.</li> </ul> </p> <h3><b>Restrictions </b></h3> <ul> <li>This method can be used only for eBay members.</li> <li>You can add only items with a FIXED_PRICE that accept PayPal as a payment. </li> </ul> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> */
1435
764
  addItem: {
1436
765
  requestBody?: {
1437
766
  content: {
@@ -1439,46 +768,32 @@ export interface operations {
1439
768
  };
1440
769
  };
1441
770
  responses: {
1442
- /** @description OK */
1443
771
  200: {
1444
772
  content: {
1445
773
  "application/json": components["schemas"]["RemoteShopcartResponse"];
1446
774
  };
1447
775
  };
1448
- /** @description No Content */
1449
776
  204: never;
1450
- /** @description Bad Request */
1451
777
  400: never;
1452
- /** @description Insufficient permissions to fulfill the request */
1453
778
  403: never;
1454
- /** @description Conflict */
1455
779
  409: never;
1456
- /** @description Internal Server Error */
1457
780
  500: never;
1458
781
  };
1459
782
  };
1460
- /** @description <span class="tablenote"><b>Note: </b><img src="/cms/img/docs/experimental-icon.svg" class="legend-icon experimental-icon" alt="Experimental Release" title="Experimental Release" /> This is an <a href="https://developer.ebay.com/api-docs/static/versioning.html#experimental">experimental</a> method that is available as a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> to select developers approved by business units.</span> <p>This method retrieves all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. There are no URI parameters or request payload. <br /><br />The response returns the summary details of all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If the cart is empty, the response is HTTP 204. </p> <br /><br /> The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, the item will be returned in the <b> unavailableCartItems</b> container. <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/shopping_cart/</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/</code> <br /><br /><b>Note: </b>This method is not available in the eBay API Explorer.</li> </ul> </p> <h3><b>Restrictions </b></h3> <p>This method can be used only for eBay members. For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> */
1461
783
  getShoppingCart: {
1462
784
  responses: {
1463
- /** @description OK */
1464
785
  200: {
1465
786
  content: {
1466
787
  "application/json": components["schemas"]["RemoteShopcartResponse"];
1467
788
  };
1468
789
  };
1469
- /** @description No Content */
1470
790
  204: never;
1471
- /** @description Bad Request */
1472
791
  400: never;
1473
- /** @description Forbidden */
1474
792
  403: never;
1475
- /** @description Not Found */
1476
793
  404: never;
1477
- /** @description Internal Server Error */
1478
794
  500: never;
1479
795
  };
1480
796
  };
1481
- /** @description <span class="tablenote"><b>Note: </b><img src="/cms/img/docs/experimental-icon.svg" class="legend-icon experimental-icon" alt="Experimental Release" title="Experimental Release" /> This is an <a href="https://developer.ebay.com/api-docs/static/versioning.html#experimental">experimental</a> method that is available as a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> to select developers approved by business units.</span> <p>This method removes a specific item from the eBay member's cart. You specify the ID of the item in the cart (<b>cartItemId</b>) that you want to remove. <br /><br />The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If you remove the last item in the cart, the response is HTTP 204.<br /><br /> The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, the item will be returned in the <b> unavailableCartItems</b> container.</p> <p span class="tablenote"><b>Note: </b> The <b> cartItemId</b> is not the same as the item ID. The <b> cartItemId</b> is the identifier of a specific item <i>in</i> the cart and is generated when the item was added to the cart.</span></p> <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/shopping_cart/remove_item</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/remove_item</code> <br /><br /><b>Note: </b>This method is not available in the eBay API Explorer.</li> </ul> </p> <h3><b>Restrictions </b></h3> <p>This method can be used only for eBay members. For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> */
1482
797
  removeItem: {
1483
798
  requestBody?: {
1484
799
  content: {
@@ -1486,25 +801,18 @@ export interface operations {
1486
801
  };
1487
802
  };
1488
803
  responses: {
1489
- /** @description OK */
1490
804
  200: {
1491
805
  content: {
1492
806
  "application/json": components["schemas"]["RemoteShopcartResponse"];
1493
807
  };
1494
808
  };
1495
- /** @description No Content */
1496
809
  204: never;
1497
- /** @description Bad Request */
1498
810
  400: never;
1499
- /** @description Insufficient permissions to fulfill the request */
1500
811
  403: never;
1501
- /** @description Conflict */
1502
812
  409: never;
1503
- /** @description Internal Server Error */
1504
813
  500: never;
1505
814
  };
1506
815
  };
1507
- /** @description <span class="tablenote"><b>Note: </b><img src="/cms/img/docs/experimental-icon.svg" class="legend-icon experimental-icon" alt="Experimental Release" title="Experimental Release" /> This is an <a href="https://developer.ebay.com/api-docs/static/versioning.html#experimental">experimental</a> method that is available as a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> to select developers approved by business units.</span> <p>This method updates the quantity value of a specific item in the eBay member's cart. You specify the ID of the item in the cart (<b>cartItemId</b>) and the new value for the quantity. If the <b> quantity</b> value is greater than the number of available, the <b> quantity</b> value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the <b> quantity</b> value to 50, the service automatically changes the value of <b>quantity</b> to 15. <br /><br />The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes "unavailable" such as, the listing has ended or the item is out of stock, the item will be returned in the <b> unavailableCartItems</b> container.</p> <p span class="tablenote"><b>Note: </b> The <b> cartItemId</b> is not the same as the item ID. The <b> cartItemId</b> is the identifier of a specific item <i>in</i> the cart and is generated when the item was added to the cart.</span></p> <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/browse/v1/shopping_cart/update_quantity</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/update_quantity</code> <br /><br /><b>Note: </b>This method is not available in the eBay API Explorer.</li> </ul> </p> <h3><b>Restrictions </b></h3> <p>This method can be used only for eBay members. For a list of supported sites and other restrictions, see <a href="/api-docs/buy/browse/overview.html#API">API Restrictions</a>.</p> */
1508
816
  updateQuantity: {
1509
817
  requestBody?: {
1510
818
  content: {
@@ -1512,19 +820,14 @@ export interface operations {
1512
820
  };
1513
821
  };
1514
822
  responses: {
1515
- /** @description OK */
1516
823
  200: {
1517
824
  content: {
1518
825
  "application/json": components["schemas"]["RemoteShopcartResponse"];
1519
826
  };
1520
827
  };
1521
- /** @description Bad Request */
1522
828
  400: never;
1523
- /** @description Insufficient permissions to fulfill the request */
1524
829
  403: never;
1525
- /** @description Conflict */
1526
830
  409: never;
1527
- /** @description Internal Server Error */
1528
831
  500: never;
1529
832
  };
1530
833
  };