Methods
beginPreparing(id, estimated_preparing_sec) → {Promise.<any>}
Set a order as preparing with estimated time
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string
|
The id of the Order Object |
estimated_preparing_sec |
int
|
The amount of time the Order will take before it will be prepared |
Returns:
- Type:
-
Promise.<any>
cancel(id, reason, description) → {Promise.<any>}
Cancel a order, must be authenticated as vendor
- Source:
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
id |
string
|
The id of the Order Object |
|
reason |
string
|
input type OrderCancellationReason enum indicating reason |
|
description |
String
|
null |
Additional details on order cancellation |
Returns:
- Type:
-
Promise.<any>
complete(id) → {Promise.<any>}
Complete an order
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string
|
The id of the Order Object |
Returns:
- Type:
-
Promise.<any>
create(order, dryopt, clear_cartopt) → {Promise.<any>}
Place a new order, you must be authenticated as a customer to use this
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
order |
Object
|
The Order Object |
|
dry |
Boolean
|
<optional> |
Indicator for dry order placement |
clear_cart |
Boolean
|
<optional> |
Indicator to clear all cart after order placement |
Returns:
- Type:
-
Promise.<any>
- The id of the Order Object
prepared(id) → {Promise.<any>}
Set order as prepared
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string
|
The id of the Order Object |
Returns:
- Type:
-
Promise.<any>