https://github.com/thomasnguyen244/magento2-module-rental-compatible
The extension create REST API for Magenest_RentalSystem module.
https://github.com/thomasnguyen244/magento2-module-rental-compatible
magento2 rental-system rental-system-rest-api
Last synced: 7 months ago
JSON representation
The extension create REST API for Magenest_RentalSystem module.
- Host: GitHub
- URL: https://github.com/thomasnguyen244/magento2-module-rental-compatible
- Owner: thomasnguyen244
- License: gpl-3.0
- Created: 2024-03-15T15:59:33.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-15T16:02:11.000Z (over 1 year ago)
- Last Synced: 2025-02-02T12:51:33.762Z (8 months ago)
- Topics: magento2, rental-system, rental-system-rest-api
- Language: PHP
- Homepage: https://www.buymeacoffee.com/workwiththomas
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING.txt
Awesome Lists containing this project
README
# Magento 2 module Rental System REST API
``workwiththomas/module-rental-compatible``
The extension create REST API for Magenest_RentalSystem module.
## Main Functionalities
Create rental order with endpoint as this:
```
POST: /V1/thomas-rentalsystem/createOrder
Body payload:
{
email: String!,
addressId: int!,
storeId: int!,
payment: String,
shipping: String,
items: [
{
sku: String!,
rental_price: float!,
local_pickup: 1,
has_time: 1,
qty: int!,
rental_from: String!,
rental_to: String!,
rental_options: {
"items": [
{
id: int,
value: String
},
{
id: int,
value: String
},...
]
}
},
....
]
}
Response: string - order increment id
```
addressId: is id of recored in table
Example:
POST: ``/V1/thomas-rentalsystem/createOrder``
```
Body payload:
{
"email" : "customer1@gmail.com",
"storeId" : 1,
"addressId" : 10,
"items" : [
{
"sku": "car-for-rent-1002",
"rental_price": 100,
"local_pickup": 1,
"has_time": 1,
"qty": 1,
"rental_from": "02/14 11:00",
"rental_to": "02/16 12:00",
"rental_options": {
"items": [
{
"id" : 6,
"value" : "5.00_10_2_fixed"
},
{
"id" : 7,
"value" : "11.00_12_3_perhour"
},
{
"id" : 8,
"value" : "20.00_23_4_perday"
}
]
}
}
]
}
```
## Donation
If this project help you reduce time to develop, you can give me a cup of coffee :)
[](https://www.buymeacoffee.com/workwiththomas)
## Installation
- Before install, please purchase and setup module [Rental System Core](https://confluence.izysync.com/display/DOC/Rental+System+Installation+Guide)
### Type 1: Zip file
- Unzip the zip file in `app/code/Thomas`
- Enable the module by running `php bin/magento module:enable Thomas_RentalCompatible`
- Apply database updates by running `php bin/magento setup:upgrade --keep-generated`
- Flush the cache by running `php bin/magento cache:flush`
### Type 2: Composer
- Make the module available in a composer repository for example:
- private repository `repo.magento.com`
- public repository `packagist.org`
- public github repository as vcs
- Add the composer repository to the configuration by running `composer config repositories.repo.magento.com composer https://repo.magento.com/`
- Install the module composer by running `composer require workwiththomas/module-offline-payments`
- enable the module by running `php bin/magento module:enable Thomas_RentalCompatible`
- apply database updates by running `php bin/magento setup:upgrade --keep-generated`
- Flush the cache by running `php bin/magento cache:flush`
## Configuration
- Config for module on admin > stores > Magenest > Rental System Create Order
- Config option:
+ Enabled
+ Default Payment Method
+ Default Shipping Method
## Specifications
## Attributes
## How to work
-