webapi.xml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497
  1. <?xml version="1.0"?>
  2. <!--
  3. /**
  4. * Copyright © Magento, Inc. All rights reserved.
  5. * See COPYING.txt for license details.
  6. */
  7. -->
  8. <routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  9. xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Webapi:etc/webapi.xsd">
  10. <!-- Managing Cart -->
  11. <route url="/V1/carts/:cartId" method="GET">
  12. <service class="Magento\Quote\Api\CartRepositoryInterface" method="get"/>
  13. <resources>
  14. <resource ref="Magento_Cart::manage" />
  15. </resources>
  16. </route>
  17. <route url="/V1/carts/search" method="GET">
  18. <service class="Magento\Quote\Api\CartRepositoryInterface" method="getList"/>
  19. <resources>
  20. <resource ref="Magento_Cart::manage" />
  21. </resources>
  22. </route>
  23. <route url="/V1/carts/" method="POST">
  24. <service class="Magento\Quote\Api\CartManagementInterface" method="createEmptyCart"/>
  25. <resources>
  26. <resource ref="Magento_Cart::manage" />
  27. </resources>
  28. </route>
  29. <route url="/V1/customers/:customerId/carts" method="POST">
  30. <service class="Magento\Quote\Api\CartManagementInterface" method="createEmptyCartForCustomer"/>
  31. <resources>
  32. <resource ref="Magento_Cart::manage" />
  33. </resources>
  34. </route>
  35. <route url="/V1/carts/:cartId" method="PUT">
  36. <service class="Magento\Quote\Api\CartManagementInterface" method="assignCustomer"/>
  37. <resources>
  38. <resource ref="Magento_Cart::manage" />
  39. </resources>
  40. </route>
  41. <!-- Managing my Cart -->
  42. <route url="/V1/carts/mine" method="POST">
  43. <service class="Magento\Quote\Api\CartManagementInterface" method="createEmptyCartForCustomer"/>
  44. <resources>
  45. <resource ref="self" />
  46. </resources>
  47. <data>
  48. <parameter name="customerId" force="true">%customer_id%</parameter>
  49. </data>
  50. </route>
  51. <route url="/V1/carts/mine" method="GET">
  52. <service class="Magento\Quote\Api\CartManagementInterface" method="getCartForCustomer"/>
  53. <resources>
  54. <resource ref="self" />
  55. </resources>
  56. <data>
  57. <parameter name="customerId" force="true">%customer_id%</parameter>
  58. </data>
  59. </route>
  60. <route url="/V1/carts/mine" method="PUT">
  61. <service class="Magento\Quote\Api\CartRepositoryInterface" method="save"/>
  62. <resources>
  63. <resource ref="self" />
  64. </resources>
  65. <data>
  66. <parameter name="cartId" force="true">%cart_id%</parameter>
  67. </data>
  68. </route>
  69. <route url="/V1/carts/mine/order" method="PUT">
  70. <service class="Magento\Quote\Api\CartManagementInterface" method="placeOrder"/>
  71. <resources>
  72. <resource ref="self" />
  73. </resources>
  74. <data>
  75. <parameter name="cartId" force="true">%cart_id%</parameter>
  76. </data>
  77. </route>
  78. <!-- Managing guest carts -->
  79. <route url="/V1/guest-carts/:cartId" method="GET">
  80. <service class="Magento\Quote\Api\GuestCartRepositoryInterface" method="get"/>
  81. <resources>
  82. <resource ref="anonymous" />
  83. </resources>
  84. </route>
  85. <!-- No getList for anonymous guest cart users -->
  86. <route url="/V1/guest-carts" method="POST">
  87. <service class="Magento\Quote\Api\GuestCartManagementInterface" method="createEmptyCart"/>
  88. <resources>
  89. <resource ref="anonymous" />
  90. </resources>
  91. </route>
  92. <route url="/V1/guest-carts/:cartId" method="PUT">
  93. <service class="Magento\Quote\Api\GuestCartManagementInterface" method="assignCustomer"/>
  94. <resources>
  95. <resource ref="self" />
  96. </resources>
  97. </route>
  98. <route url="/V1/guest-carts/:cartId/order" method="PUT">
  99. <service class="Magento\Quote\Api\GuestCartManagementInterface" method="placeOrder"/>
  100. <resources>
  101. <resource ref="anonymous" />
  102. </resources>
  103. </route>
  104. <!-- Managing Cart Shipment Method -->
  105. <route url="/V1/carts/:cartId/shipping-methods" method="GET">
  106. <service class="Magento\Quote\Api\ShippingMethodManagementInterface" method="getList"/>
  107. <resources>
  108. <resource ref="Magento_Cart::manage" />
  109. </resources>
  110. </route>
  111. <route url="/V1/carts/:cartId/estimate-shipping-methods" method="POST">
  112. <service class="Magento\Quote\Api\ShipmentEstimationInterface" method="estimateByExtendedAddress"/>
  113. <resources>
  114. <resource ref="Magento_Cart::manage" />
  115. </resources>
  116. </route>
  117. <route url="/V1/carts/:cartId/estimate-shipping-methods-by-address-id" method="POST">
  118. <service class="Magento\Quote\Api\ShippingMethodManagementInterface" method="estimateByAddressId"/>
  119. <resources>
  120. <resource ref="Magento_Cart::manage" />
  121. </resources>
  122. </route>
  123. <!-- Managing My Cart Shipment Method -->
  124. <route url="/V1/carts/mine/shipping-methods" method="GET">
  125. <service class="Magento\Quote\Api\ShippingMethodManagementInterface" method="getList"/>
  126. <resources>
  127. <resource ref="self" />
  128. </resources>
  129. <data>
  130. <parameter name="cartId" force="true">%cart_id%</parameter>
  131. </data>
  132. </route>
  133. <route url="/V1/carts/mine/estimate-shipping-methods" method="POST">
  134. <service class="Magento\Quote\Api\ShipmentEstimationInterface" method="estimateByExtendedAddress"/>
  135. <resources>
  136. <resource ref="self" />
  137. </resources>
  138. <data>
  139. <parameter name="cartId" force="true">%cart_id%</parameter>
  140. </data>
  141. </route>
  142. <route url="/V1/carts/mine/estimate-shipping-methods-by-address-id" method="POST">
  143. <service class="Magento\Quote\Api\ShippingMethodManagementInterface" method="estimateByAddressId"/>
  144. <resources>
  145. <resource ref="self" />
  146. </resources>
  147. <data>
  148. <parameter name="cartId" force="true">%cart_id%</parameter>
  149. </data>
  150. </route>
  151. <!-- Managing Guest Cart Shipment Method -->
  152. <route url="/V1/guest-carts/:cartId/shipping-methods" method="GET">
  153. <service class="Magento\Quote\Api\GuestShippingMethodManagementInterface" method="getList"/>
  154. <resources>
  155. <resource ref="anonymous" />
  156. </resources>
  157. </route>
  158. <route url="/V1/guest-carts/:cartId/estimate-shipping-methods" method="POST">
  159. <service class="Magento\Quote\Api\GuestShipmentEstimationInterface" method="estimateByExtendedAddress"/>
  160. <resources>
  161. <resource ref="anonymous" />
  162. </resources>
  163. </route>
  164. <!-- Managing Cart Items -->
  165. <route url="/V1/carts/:cartId/items" method="GET">
  166. <service class="Magento\Quote\Api\CartItemRepositoryInterface" method="getList"/>
  167. <resources>
  168. <resource ref="Magento_Cart::manage" />
  169. </resources>
  170. </route>
  171. <route url="/V1/carts/:quoteId/items" method="POST">
  172. <service class="Magento\Quote\Api\CartItemRepositoryInterface" method="save"/>
  173. <resources>
  174. <resource ref="Magento_Cart::manage" />
  175. </resources>
  176. </route>
  177. <route url="/V1/carts/:cartId/items/:itemId" method="PUT">
  178. <service class="Magento\Quote\Api\CartItemRepositoryInterface" method="save"/>
  179. <resources>
  180. <resource ref="Magento_Cart::manage" />
  181. </resources>
  182. </route>
  183. <route url="/V1/carts/:cartId/items/:itemId" method="DELETE">
  184. <service class="Magento\Quote\Api\CartItemRepositoryInterface" method="deleteById"/>
  185. <resources>
  186. <resource ref="Magento_Cart::manage" />
  187. </resources>
  188. </route>
  189. <!-- Managing Guest Cart Items -->
  190. <route url="/V1/guest-carts/:cartId/items" method="GET">
  191. <service class="Magento\Quote\Api\GuestCartItemRepositoryInterface" method="getList"/>
  192. <resources>
  193. <resource ref="anonymous" />
  194. </resources>
  195. </route>
  196. <route url="/V1/guest-carts/:cartId/items" method="POST">
  197. <service class="Magento\Quote\Api\GuestCartItemRepositoryInterface" method="save"/>
  198. <resources>
  199. <resource ref="anonymous" />
  200. </resources>
  201. </route>
  202. <route url="/V1/guest-carts/:cartId/items/:itemId" method="PUT">
  203. <service class="Magento\Quote\Api\GuestCartItemRepositoryInterface" method="save"/>
  204. <resources>
  205. <resource ref="anonymous" />
  206. </resources>
  207. </route>
  208. <route url="/V1/guest-carts/:cartId/items/:itemId" method="DELETE">
  209. <service class="Magento\Quote\Api\GuestCartItemRepositoryInterface" method="deleteById"/>
  210. <resources>
  211. <resource ref="anonymous" />
  212. </resources>
  213. </route>
  214. <!-- Managing my Cart Items -->
  215. <route url="/V1/carts/mine/items" method="GET">
  216. <service class="Magento\Quote\Api\CartItemRepositoryInterface" method="getList"/>
  217. <resources>
  218. <resource ref="self" />
  219. </resources>
  220. <data>
  221. <parameter name="cartId" force="true">%cart_id%</parameter>
  222. </data>
  223. </route>
  224. <route url="/V1/carts/mine/items" method="POST">
  225. <service class="Magento\Quote\Api\CartItemRepositoryInterface" method="save"/>
  226. <resources>
  227. <resource ref="self" />
  228. </resources>
  229. <data>
  230. <parameter name="cartId" force="true">%cart_id%</parameter>
  231. </data>
  232. </route>
  233. <route url="/V1/carts/mine/items/:itemId" method="PUT">
  234. <service class="Magento\Quote\Api\CartItemRepositoryInterface" method="save"/>
  235. <resources>
  236. <resource ref="self" />
  237. </resources>
  238. <data>
  239. <parameter name="cartId" force="true">%cart_id%</parameter>
  240. </data>
  241. </route>
  242. <route url="/V1/carts/mine/items/:itemId" method="DELETE">
  243. <service class="Magento\Quote\Api\CartItemRepositoryInterface" method="deleteById"/>
  244. <resources>
  245. <resource ref="self" />
  246. </resources>
  247. <data>
  248. <parameter name="cartId" force="true">%cart_id%</parameter>
  249. </data>
  250. </route>
  251. <!-- Managing Cart Payment -->
  252. <route url="/V1/carts/:cartId/selected-payment-method" method="GET">
  253. <service class="Magento\Quote\Api\PaymentMethodManagementInterface" method="get"/>
  254. <resources>
  255. <resource ref="Magento_Cart::manage" />
  256. </resources>
  257. </route>
  258. <route url="/V1/carts/:cartId/selected-payment-method" method="PUT">
  259. <service class="Magento\Quote\Api\PaymentMethodManagementInterface" method="set"/>
  260. <resources>
  261. <resource ref="Magento_Cart::manage" />
  262. </resources>
  263. </route>
  264. <route url="/V1/carts/:cartId/payment-methods" method="GET">
  265. <service class="Magento\Quote\Api\PaymentMethodManagementInterface" method="getList"/>
  266. <resources>
  267. <resource ref="Magento_Cart::manage" />
  268. </resources>
  269. </route>
  270. <!-- Managing Guest Cart Payment -->
  271. <route url="/V1/guest-carts/:cartId/selected-payment-method" method="GET">
  272. <service class="Magento\Quote\Api\GuestPaymentMethodManagementInterface" method="get"/>
  273. <resources>
  274. <resource ref="anonymous" />
  275. </resources>
  276. </route>
  277. <route url="/V1/guest-carts/:cartId/selected-payment-method" method="PUT">
  278. <service class="Magento\Quote\Api\GuestPaymentMethodManagementInterface" method="set"/>
  279. <resources>
  280. <resource ref="anonymous" />
  281. </resources>
  282. </route>
  283. <route url="/V1/guest-carts/:cartId/payment-methods" method="GET">
  284. <service class="Magento\Quote\Api\GuestPaymentMethodManagementInterface" method="getList"/>
  285. <resources>
  286. <resource ref="anonymous" />
  287. </resources>
  288. </route>
  289. <!-- Managing my Cart Payment -->
  290. <route url="/V1/carts/mine/selected-payment-method" method="GET">
  291. <service class="Magento\Quote\Api\PaymentMethodManagementInterface" method="get"/>
  292. <resources>
  293. <resource ref="self" />
  294. </resources>
  295. <data>
  296. <parameter name="cartId" force="true">%cart_id%</parameter>
  297. </data>
  298. </route>
  299. <route url="/V1/carts/mine/selected-payment-method" method="PUT">
  300. <service class="Magento\Quote\Api\PaymentMethodManagementInterface" method="set"/>
  301. <resources>
  302. <resource ref="self" />
  303. </resources>
  304. <data>
  305. <parameter name="cartId" force="true">%cart_id%</parameter>
  306. </data>
  307. </route>
  308. <route url="/V1/carts/mine/payment-methods" method="GET">
  309. <service class="Magento\Quote\Api\PaymentMethodManagementInterface" method="getList"/>
  310. <resources>
  311. <resource ref="self" />
  312. </resources>
  313. <data>
  314. <parameter name="cartId" force="true">%cart_id%</parameter>
  315. </data>
  316. </route>
  317. <!-- Managing Cart Billing address -->
  318. <route url="/V1/carts/:cartId/billing-address" method="GET">
  319. <service class="Magento\Quote\Api\BillingAddressManagementInterface" method="get"/>
  320. <resources>
  321. <resource ref="Magento_Cart::manage" />
  322. </resources>
  323. </route>
  324. <route url="/V1/carts/:cartId/billing-address" method="POST">
  325. <service class="Magento\Quote\Api\BillingAddressManagementInterface" method="assign"/>
  326. <resources>
  327. <resource ref="Magento_Cart::manage" />
  328. </resources>
  329. </route>
  330. <!-- Managing Guest Cart Billing address -->
  331. <route url="/V1/guest-carts/:cartId/billing-address" method="GET">
  332. <service class="Magento\Quote\Api\GuestBillingAddressManagementInterface" method="get"/>
  333. <resources>
  334. <resource ref="anonymous" />
  335. </resources>
  336. </route>
  337. <route url="/V1/guest-carts/:cartId/billing-address" method="POST">
  338. <service class="Magento\Quote\Api\GuestBillingAddressManagementInterface" method="assign"/>
  339. <resources>
  340. <resource ref="anonymous" />
  341. </resources>
  342. </route>
  343. <!-- Managing My Cart Billing address -->
  344. <route url="/V1/carts/mine/billing-address" method="GET">
  345. <service class="Magento\Quote\Api\BillingAddressManagementInterface" method="get"/>
  346. <resources>
  347. <resource ref="self" />
  348. </resources>
  349. <data>
  350. <parameter name="cartId" force="true">%cart_id%</parameter>
  351. </data>
  352. </route>
  353. <route url="/V1/carts/mine/billing-address" method="POST">
  354. <service class="Magento\Quote\Api\BillingAddressManagementInterface" method="assign"/>
  355. <resources>
  356. <resource ref="self" />
  357. </resources>
  358. <data>
  359. <parameter name="cartId" force="true">%cart_id%</parameter>
  360. </data>
  361. </route>
  362. <!-- Managing Cart Coupons -->
  363. <route url="/V1/carts/:cartId/coupons" method="GET">
  364. <service class="Magento\Quote\Api\CouponManagementInterface" method="get"/>
  365. <resources>
  366. <resource ref="Magento_Cart::manage" />
  367. </resources>
  368. </route>
  369. <route url="/V1/carts/:cartId/coupons/:couponCode" method="PUT">
  370. <service class="Magento\Quote\Api\CouponManagementInterface" method="set"/>
  371. <resources>
  372. <resource ref="Magento_Cart::manage" />
  373. </resources>
  374. </route>
  375. <route url="/V1/carts/:cartId/coupons" method="DELETE">
  376. <service class="Magento\Quote\Api\CouponManagementInterface" method="remove"/>
  377. <resources>
  378. <resource ref="Magento_Cart::manage" />
  379. </resources>
  380. </route>
  381. <!-- Managing Guest Cart Coupons -->
  382. <route url="/V1/guest-carts/:cartId/coupons" method="GET">
  383. <service class="Magento\Quote\Api\GuestCouponManagementInterface" method="get"/>
  384. <resources>
  385. <resource ref="anonymous" />
  386. </resources>
  387. </route>
  388. <route url="/V1/guest-carts/:cartId/coupons/:couponCode" method="PUT">
  389. <service class="Magento\Quote\Api\GuestCouponManagementInterface" method="set"/>
  390. <resources>
  391. <resource ref="anonymous" />
  392. </resources>
  393. </route>
  394. <route url="/V1/guest-carts/:cartId/coupons" method="DELETE">
  395. <service class="Magento\Quote\Api\GuestCouponManagementInterface" method="remove"/>
  396. <resources>
  397. <resource ref="anonymous" />
  398. </resources>
  399. </route>
  400. <!-- Managing mine Cart Coupons -->
  401. <route url="/V1/carts/mine/coupons" method="GET">
  402. <service class="Magento\Quote\Api\CouponManagementInterface" method="get"/>
  403. <resources>
  404. <resource ref="self" />
  405. </resources>
  406. <data>
  407. <parameter name="cartId" force="true">%cart_id%</parameter>
  408. </data>
  409. </route>
  410. <route url="/V1/carts/mine/coupons/:couponCode" method="PUT">
  411. <service class="Magento\Quote\Api\CouponManagementInterface" method="set"/>
  412. <resources>
  413. <resource ref="self" />
  414. </resources>
  415. <data>
  416. <parameter name="cartId" force="true">%cart_id%</parameter>
  417. </data>
  418. </route>
  419. <route url="/V1/carts/mine/coupons" method="DELETE">
  420. <service class="Magento\Quote\Api\CouponManagementInterface" method="remove"/>
  421. <resources>
  422. <resource ref="self" />
  423. </resources>
  424. <data>
  425. <parameter name="cartId" force="true">%cart_id%</parameter>
  426. </data>
  427. </route>
  428. <!-- Managing Cart Order -->
  429. <route url="/V1/carts/:cartId/order" method="PUT">
  430. <service class="Magento\Quote\Api\CartManagementInterface" method="placeOrder"/>
  431. <resources>
  432. <resource ref="Magento_Cart::manage" />
  433. </resources>
  434. </route>
  435. <!-- Managing Cart Total -->
  436. <route url="/V1/carts/:cartId/totals" method="GET">
  437. <service class="Magento\Quote\Api\CartTotalRepositoryInterface" method="get"/>
  438. <resources>
  439. <resource ref="Magento_Cart::manage" />
  440. </resources>
  441. </route>
  442. <route url="/V1/guest-carts/:cartId/collect-totals" method="PUT">
  443. <service class="Magento\Quote\Api\GuestCartTotalManagementInterface" method="collectTotals"/>
  444. <resources>
  445. <resource ref="anonymous"/>
  446. </resources>
  447. </route>
  448. <!-- Managing Guest Cart Total -->
  449. <route url="/V1/guest-carts/:cartId/totals" method="GET">
  450. <service class="Magento\Quote\Api\GuestCartTotalRepositoryInterface" method="get"/>
  451. <resources>
  452. <resource ref="anonymous" />
  453. </resources>
  454. </route>
  455. <!-- Managing My Cart Total -->
  456. <route url="/V1/carts/mine/totals" method="GET">
  457. <service class="Magento\Quote\Api\CartTotalRepositoryInterface" method="get"/>
  458. <resources>
  459. <resource ref="self" />
  460. </resources>
  461. <data>
  462. <parameter name="cartId" force="true">%cart_id%</parameter>
  463. </data>
  464. </route>
  465. <route url="/V1/carts/mine/collect-totals" method="PUT">
  466. <service class="Magento\Quote\Api\CartTotalManagementInterface" method="collectTotals"/>
  467. <resources>
  468. <resource ref="self" />
  469. </resources>
  470. <data>
  471. <parameter name="cartId" force="true">%cart_id%</parameter>
  472. </data>
  473. </route>
  474. </routes>