OrdersApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| ordersControllerFetchStatus | GET /v1/orders/{transaction_number} | Get order status update |
| ordersControllerFind | GET /v1/orders | Get customer order history |
| ordersControllerReorder | GET /v1/orders/{order_id}/reorder | Get re-order plan |
ordersControllerFetchStatus
OrderPartialClass ordersControllerFetchStatus(transaction_number)
Get order status update
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| transaction_number | String | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
ordersControllerFind
OrderEntity ordersControllerFind(id, max_order_date, min_order_date, status, order_type, meal_plan, limit, offset)
Get customer order history
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Customer ID that you passed to us | [default to null] |
| max_order_date | String | ISO8601 compliant order date string | [optional] [default to null] |
| min_order_date | String | ISO8601 compliant order date string | [optional] [default to null] |
| status | String | Order status filter | [optional] [default to null] [enum: new, out_for_delivery, accepted, ready, cancelled, completed, refunded, expired, payment_failed, payment_pending] |
| order_type | String | Order type | [optional] [default to null] [enum: delivery, pickup, third_party_pickup, curbside_pickup] |
| meal_plan | Boolean | Toggle meal plan filter, returns orders that are part of a meal plan ONLY if set to true Defaults to false | [optional] [default to null] |
| limit | BigDecimal | The number of record to return, 0 means all will be returned | [optional] [default to null] |
| offset | BigDecimal | The number of records to skip | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
ordersControllerReorder
ReorderEntity ordersControllerReorder(order_id)
Get re-order plan
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| order_id | String | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json