1. Help Center
  2. Client FAQs & Guides

Installing Simplr's Magento 2.x Extension

STEP 1 

  • Download the zip file of the extension by clicking here.
  • Unzip the file
  • Create a folder {Magento 2 root}/app/code/Simplr/SimplrExtension
  • Copy the contents from the unzipped folder

STEP 2

Enable Module (from the {Magento root} folder)

php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Available methods:

1. Extension version:

GET :serverPath/rest/all/V1/simplr/version

2. Lists orders that match specified search criteria:

GET :serverPath/rest/all/V1/simplr/orders/

Information about search searchCriteria - https://devdocs.magento.com/guides/v2.3/rest/performing-searches.html

3. Loads a specified order:

GET :serverPath/rest/all/V1/simplr/orders/:id/

4. Cancels a specified order:

POST :serverPath/rest/all/V1/simplr/orders/:id/cancel

5. Create offline refund for order:

POST :serverPath/rest/all/V1/simplr/orders/:id/refund

Refund post body:

{
"items": [
{
"extension_attributes": {},
"order_item_id": 0,
"qty": 0
}
],
"notify": true,
"appendComment": true,
"comment": {
"extension_attributes": {},
"comment": "string",
"is_visible_on_front": 0
},
"arguments": {
"shipping_amount": 0,
"adjustment_positive": 0,
"adjustment_negative": 0,
"extension_attributes": {
"return_to_stock_items": [
0
]
}
}
}