The business model has the following endpoints:
Action | Method | Resource | Description |
---|---|---|---|
Get all |
|
| Get all businesses. |
Get |
|
| Get business with id |
Create |
|
| Create a business. |
Update |
|
| Update business with id |
Delete |
|
| Delete business with id |
The business model has the following attributes:
Attribute | Type | Required | Description | Whereable |
---|---|---|---|---|
name | string | no, required to create. | The business's name. | Yes |
string | no, required to create. | The business's email. | Yes | |
slug | string | no, required to create. | The business's slug. | Yes |
schedule | json | no | The business's schedule.more | No |
description | string | no | The business's description. | Yes |
about | string | no | The business's about. | Yes |
logo | base64 image, url image or file image. | no | The business's logo image. | No |
header | base64 image, url image or file image. | no | The business's header image. | No |
phone | string | no | The business's phone. | Yes |
cellphone | string | no | The business's cellphone. | Yes |
owner_id | integer | no | The business's owner, is the user id. | Yes |
city_id | integer | no | The business's city, is the city id. | Yes |
address | string | no | The business's address. | Yes |
address_notes | string | no | The business's address notes. | No |
zipcode | string | no | The business's zip/postal code. | Yes |
location | json | no | The business's location. (e.g. | No |
featured | boolean | no | If business is featured or not. | Yes |
timezone | string | no | The business's timezone. List valid timezone | No |
currency | string | no | The business's currency. | Yes |
printer_id | integer | no | The business's printer, is the printer id. | No |
minimum | float | no | The business's minimum purchase. | Yes |
delivery_price | float | no | The business's delivery price. | Yes |
always_deliver | boolean | no | If the business always delivers even without a delivery zone or not. | Yes |
tax_type | integer | no | The business's tax type. | Yes |
tax | float | no | The business's tax. | Yes |
delivery_time | string | no | The business's delivery time. (e.g. | No |
pickup_time | string | no | The business's pickup time. (e.g. | No |
service_fee | float | no | The business's service fee. | No |
fixed_usage_fee | float | no | The business's fixed usage fee. | No |
percentage_usage_fee | float | no | The business's percentage usage fee. | No |
enabled | boolean | no | The business's status. | Yes |
food | bolean | no | The business´s type FOOD status | Yes |
alchohol | bolean | no | The business´s type ALCOHOL status | Yes |
groceries | bolean | no | The business´s type GROCERIES status | Yes |
laundry | bolean | no | The business´s type LAUNDRY status | Yes |
use-printer | bolean | no | Use printers's status | No |