Skip to content

Latest commit

 

History

History
850 lines (621 loc) · 27 KB

OrdersApi.md

File metadata and controls

850 lines (621 loc) · 27 KB

OrdersApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
acceptOrder POST /api/v1.0/orders/{id}/accept
dispatchOrder POST /api/v1.0/orders/{id}/dispatch
getDeliveryInformation GET /api/v1.0/orders/{orderId}/deliveryinfo
getFulfillmentState GET /api/v1.0/orders/{orderId}/fulfillment/state
getFulfillmentStatusWithDetailsAndActions GET /api/v1.0/orders/{orderId}/fulfillment/state/details
getOrderById GET /api/v1.0/orders/{id}
getOrders GET /api/v1.0/orders
getOrdersSummary GET /api/v1.0/{appId}/orders/summaries
getOrdersSummaryNew GET /api/v1.0/{appId}/orders/summariesNew
getReadyToProcess GET /api/v1.0/{appId}/orders/ready_to_process
refundOrder POST /api/v1.0/orders/{id}/refund
rejectOrder POST /api/v1.0/orders/{id}/reject
searchFulfillmentStatuses GET /api/v1.0/{appId}/orders/fulfillmentstatuses
updateDeliveryInformation POST /api/v1.0/orders/{orderId}/deliveryinfo
updateFulfillmentState POST /api/v1.0/orders/{orderId}/fulfillment/state

acceptOrder

acceptOrder(id, acceptObject)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
Integer id = 56; // Integer | 
Accept acceptObject = new Accept(); // Accept | 
try {
    apiInstance.acceptOrder(id, acceptObject);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#acceptOrder");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer
acceptObject Accept

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

dispatchOrder

dispatchOrder(id)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
Integer id = 56; // Integer | 
try {
    apiInstance.dispatchOrder(id);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#dispatchOrder");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getDeliveryInformation

RestApiResultOrderDeliveryInformation getDeliveryInformation(orderId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
Integer orderId = 56; // Integer | 
try {
    RestApiResultOrderDeliveryInformation result = apiInstance.getDeliveryInformation(orderId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#getDeliveryInformation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
orderId Integer

Return type

RestApiResultOrderDeliveryInformation

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getFulfillmentState

RestApiResultOrderFulfillmentStatus getFulfillmentState(orderId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
Integer orderId = 56; // Integer | 
try {
    RestApiResultOrderFulfillmentStatus result = apiInstance.getFulfillmentState(orderId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#getFulfillmentState");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
orderId Integer

Return type

RestApiResultOrderFulfillmentStatus

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getFulfillmentStatusWithDetailsAndActions

RestApiResultOrderFulfillmentStatusWithConfigurationActions getFulfillmentStatusWithDetailsAndActions(orderId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
Integer orderId = 56; // Integer | 
try {
    RestApiResultOrderFulfillmentStatusWithConfigurationActions result = apiInstance.getFulfillmentStatusWithDetailsAndActions(orderId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#getFulfillmentStatusWithDetailsAndActions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
orderId Integer

Return type

RestApiResultOrderFulfillmentStatusWithConfigurationActions

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getOrderById

RestApiResultOrder getOrderById(id)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
Integer id = 56; // Integer | 
try {
    RestApiResultOrder result = apiInstance.getOrderById(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#getOrderById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer

Return type

RestApiResultOrder

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getOrders

RestApiPaginationResultOrder getOrders(physicalRestaurantId, state, from, to, page, limit)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
List<Integer> physicalRestaurantId = Arrays.asList(56); // List<Integer> | 
List<String> state = Arrays.asList("state_example"); // List<String> | 
OffsetDateTime from = OffsetDateTime.now(); // OffsetDateTime | 
OffsetDateTime to = OffsetDateTime.now(); // OffsetDateTime | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
try {
    RestApiPaginationResultOrder result = apiInstance.getOrders(physicalRestaurantId, state, from, to, page, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#getOrders");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
physicalRestaurantId List<Integer> [optional]
state List<String> [optional] [enum: Created, PlacedCanBeCancelled, ReadyToProcess, AcceptedByRestaurant, Dispatched, Delivered, Cancelled, ManualReview, RejectedByStore, RejectedByFlipdish, RejectedAutomatically, RejectedAfterBeingAccepted, AcceptedAndRefunded, PendingPayment]
from OffsetDateTime [optional]
to OffsetDateTime [optional]
page Integer [optional]
limit Integer [optional]

Return type

RestApiPaginationResultOrder

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getOrdersSummary

RestApiPaginationResultOrderSummary getOrdersSummary(appId, searchQuery, physicalRestaurantId, state, page, limit, orderByRequestedForTime, channels, orderIds, from, to, logSql)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
String appId = "appId_example"; // String | 
String searchQuery = "searchQuery_example"; // String | 
List<Integer> physicalRestaurantId = Arrays.asList(56); // List<Integer> | 
List<String> state = Arrays.asList("state_example"); // List<String> | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
Boolean orderByRequestedForTime = true; // Boolean | 
List<String> channels = Arrays.asList("channels_example"); // List<String> | 
List<Integer> orderIds = Arrays.asList(56); // List<Integer> | 
OffsetDateTime from = OffsetDateTime.now(); // OffsetDateTime | 
OffsetDateTime to = OffsetDateTime.now(); // OffsetDateTime | 
Boolean logSql = true; // Boolean | 
try {
    RestApiPaginationResultOrderSummary result = apiInstance.getOrdersSummary(appId, searchQuery, physicalRestaurantId, state, page, limit, orderByRequestedForTime, channels, orderIds, from, to, logSql);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#getOrdersSummary");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
searchQuery String [optional]
physicalRestaurantId List<Integer> [optional]
state List<String> [optional] [enum: Created, PlacedCanBeCancelled, ReadyToProcess, AcceptedByRestaurant, Dispatched, Delivered, Cancelled, ManualReview, RejectedByStore, RejectedByFlipdish, RejectedAutomatically, RejectedAfterBeingAccepted, AcceptedAndRefunded, PendingPayment]
page Integer [optional]
limit Integer [optional]
orderByRequestedForTime Boolean [optional]
channels List<String> [optional] [enum: Unknown, Ios, Android, Web, Kiosk, Pos, TelephoneCall, Sms, PwaAndroid, PwaIos, Google, Photon]
orderIds List<Integer> [optional]
from OffsetDateTime [optional]
to OffsetDateTime [optional]
logSql Boolean [optional]

Return type

RestApiPaginationResultOrderSummary

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getOrdersSummaryNew

RestApiPaginationResultOrderSummary getOrdersSummaryNew(appId, searchQuery, physicalRestaurantId, state, page, limit, orderByRequestedForTime, channels, orderIds, from, to, logSql)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
String appId = "appId_example"; // String | 
String searchQuery = "searchQuery_example"; // String | 
List<Integer> physicalRestaurantId = Arrays.asList(56); // List<Integer> | 
List<String> state = Arrays.asList("state_example"); // List<String> | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
Boolean orderByRequestedForTime = true; // Boolean | 
List<String> channels = Arrays.asList("channels_example"); // List<String> | 
List<Integer> orderIds = Arrays.asList(56); // List<Integer> | 
OffsetDateTime from = OffsetDateTime.now(); // OffsetDateTime | 
OffsetDateTime to = OffsetDateTime.now(); // OffsetDateTime | 
Boolean logSql = true; // Boolean | 
try {
    RestApiPaginationResultOrderSummary result = apiInstance.getOrdersSummaryNew(appId, searchQuery, physicalRestaurantId, state, page, limit, orderByRequestedForTime, channels, orderIds, from, to, logSql);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#getOrdersSummaryNew");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
searchQuery String [optional]
physicalRestaurantId List<Integer> [optional]
state List<String> [optional] [enum: Created, PlacedCanBeCancelled, ReadyToProcess, AcceptedByRestaurant, Dispatched, Delivered, Cancelled, ManualReview, RejectedByStore, RejectedByFlipdish, RejectedAutomatically, RejectedAfterBeingAccepted, AcceptedAndRefunded, PendingPayment]
page Integer [optional]
limit Integer [optional]
orderByRequestedForTime Boolean [optional]
channels List<String> [optional] [enum: Unknown, Ios, Android, Web, Kiosk, Pos, TelephoneCall, Sms, PwaAndroid, PwaIos, Google, Photon]
orderIds List<Integer> [optional]
from OffsetDateTime [optional]
to OffsetDateTime [optional]
logSql Boolean [optional]

Return type

RestApiPaginationResultOrderSummary

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getReadyToProcess

OrderList getReadyToProcess(appId, storeId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
String appId = "appId_example"; // String | 
List<Integer> storeId = Arrays.asList(56); // List<Integer> | 
try {
    OrderList result = apiInstance.getReadyToProcess(appId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#getReadyToProcess");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeId List<Integer> [optional]

Return type

OrderList

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

refundOrder

refundOrder(id, refundObject)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
Integer id = 56; // Integer | 
Refund refundObject = new Refund(); // Refund | 
try {
    apiInstance.refundOrder(id, refundObject);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#refundOrder");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer
refundObject Refund

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

rejectOrder

rejectOrder(id, rejectObject)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
Integer id = 56; // Integer | 
Reject rejectObject = new Reject(); // Reject | 
try {
    apiInstance.rejectOrder(id, rejectObject);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#rejectOrder");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer
rejectObject Reject

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

searchFulfillmentStatuses

RestApiArrayResultOrderFulfillmentStatus searchFulfillmentStatuses(appId, orderIds)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
String appId = "appId_example"; // String | 
String orderIds = "orderIds_example"; // String | 
try {
    RestApiArrayResultOrderFulfillmentStatus result = apiInstance.searchFulfillmentStatuses(appId, orderIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#searchFulfillmentStatuses");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
orderIds String

Return type

RestApiArrayResultOrderFulfillmentStatus

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

updateDeliveryInformation

updateDeliveryInformation(orderId, deliveryInformation)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
Integer orderId = 56; // Integer | 
OrderDeliveryInformationBase deliveryInformation = new OrderDeliveryInformationBase(); // OrderDeliveryInformationBase | 
try {
    apiInstance.updateDeliveryInformation(orderId, deliveryInformation);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#updateDeliveryInformation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
orderId Integer
deliveryInformation OrderDeliveryInformationBase

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

updateFulfillmentState

updateFulfillmentState(orderId, fulfillmentStatusRequest)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OrdersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OrdersApi apiInstance = new OrdersApi();
Integer orderId = 56; // Integer | 
OrderFulfillmentStatusUpdate fulfillmentStatusRequest = new OrderFulfillmentStatusUpdate(); // OrderFulfillmentStatusUpdate | 
try {
    apiInstance.updateFulfillmentState(orderId, fulfillmentStatusRequest);
} catch (ApiException e) {
    System.err.println("Exception when calling OrdersApi#updateFulfillmentState");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
orderId Integer
fulfillmentStatusRequest OrderFulfillmentStatusUpdate

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml