This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
udropship:umarketplace:m2:rma-api [2022/04/26 06:25] wtsergo |
udropship:umarketplace:m2:rma-api [2022/04/26 07:18] (current) wtsergo [Create RMA] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== uMarketplace | + | ====== uMarketplace |
| | ||
===== Introduction ===== | ===== Introduction ===== | ||
- | The uReturn API add-on extends Magento 2 REST/Soap API and allow admin and vendor utilize it to create/ | + | The uReturn |
To get more technical details check: | To get more technical details check: | ||
- // | - // | ||
Line 17: | Line 17: | ||
'' | '' | ||
< | < | ||
- | POST http:// | + | POST http:// |
- | {" | + | {" |
</ | </ | ||
'' | '' | ||
RESPONSE | RESPONSE | ||
- | " | ||
'' | '' | ||
+ | < | ||
+ | " | ||
+ | </ | ||
===== Create RMA ===== | ===== Create RMA ===== | ||
Line 31: | Line 33: | ||
- [[https:// | - [[https:// | ||
- | Once it's done and you have all required entity IDs you are ready to create RMA. | + | Once it's done and you have all required entity IDs you are ready to create RMA. Request payload expect '' |
'' | '' | ||
Line 37: | Line 39: | ||
'' | '' | ||
< | < | ||
- | POST http://magento241.loc/ | + | POST http://magento.loc/ |
{ | { | ||
" | " | ||
Line 52: | Line 54: | ||
] | ] | ||
} | } | ||
- | }\\ | + | } |
</ | </ | ||
'' | '' | ||
RESPONSE | RESPONSE | ||
+ | '' | ||
+ | < | ||
" | " | ||
+ | </ | ||
+ | |||
+ | ===== Get list of RMAs (possible to filter) ===== | ||
+ | |||
+ | In order to get list of RMAs perform /// | ||
+ | |||
'' | '' | ||
+ | Example: | ||
+ | '' | ||
+ | < | ||
+ | GET http:// | ||
+ | </ | ||
+ | '' | ||
+ | RESPONSE | ||
+ | '' | ||
+ | |||
+ | < | ||
+ | { | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Get Single RMA Info ===== | ||
+ | |||
+ | In order to get single RMA information perform /// | ||
+ | |||
+ | '' | ||
+ | Example: | ||
+ | '' | ||
+ | < | ||
+ | GET http:// | ||
+ | </ | ||
+ | '' | ||
+ | RESPONSE | ||
+ | '' | ||
+ | < | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Add comment to RMA ===== | ||
+ | |||
+ | In order to add comment to RMA perform /// | ||
+ | |||
+ | |||
+ | '' | ||
+ | Example: | ||
+ | '' | ||
+ | < | ||
+ | POST http:// | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | '' | ||
+ | RESPONSE | ||
+ | '' | ||
+ | < | ||
+ | true | ||
+ | </ | ||
+ | |||
+ | ===== Get RMA Comments List ===== | ||
+ | |||
+ | In order to get list of RMA comments perform /// | ||
+ | |||
+ | '' | ||
+ | Example: | ||
+ | '' | ||
+ | < | ||
+ | GET http:// | ||
+ | </ | ||
+ | '' | ||
+ | RESPONSE | ||
+ | '' | ||
+ | < | ||
+ | { | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | ] | ||
+ | }, | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Add tracking number to RMA ===== | ||
+ | |||
+ | In order to add tracking number to RMA perform /// | ||
+ | |||
+ | '' | ||
+ | Example: | ||
+ | '' | ||
+ | < | ||
+ | POST http:// | ||
+ | {" | ||
+ | </ | ||
+ | RESPONSE | ||
+ | < | ||
+ | 2 | ||
+ | </ | ||
+ | |||
+ | ===== Delete tracking number from RMA ===== | ||
+ | |||
+ | In order to delete tracking number from RMA perform /// | ||
+ | |||
+ | '' | ||
+ | Example: | ||
+ | '' | ||
+ | < | ||
+ | POST http:// | ||
+ | </ | ||
+ | '' | ||
+ | RESPONSE | ||
+ | '' | ||
+ | < | ||
+ | true | ||
+ | </ | ||