Skip to content

Latest commit

 

History

History
120 lines (86 loc) · 3.58 KB

OrderBatchesApi.md

File metadata and controls

120 lines (86 loc) · 3.58 KB

OrderBatchesApi

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

Method HTTP request Description
getAllOrderBatches GET /api/v1.0/{appId}/order-batches
getOrderBatch GET /api/v1.0/{appId}/order-batches/{orderBatchId}

getAllOrderBatches

RestApiArrayResultOrderBatch getAllOrderBatches(appId, storeIds, createdFrom, createdTo)

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.OrderBatchesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

OrderBatchesApi apiInstance = new OrderBatchesApi();
String appId = "appId_example"; // String | 
List<Integer> storeIds = Arrays.asList(56); // List<Integer> | 
OffsetDateTime createdFrom = OffsetDateTime.now(); // OffsetDateTime | 
OffsetDateTime createdTo = OffsetDateTime.now(); // OffsetDateTime | 
try {
    RestApiArrayResultOrderBatch result = apiInstance.getAllOrderBatches(appId, storeIds, createdFrom, createdTo);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderBatchesApi#getAllOrderBatches");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeIds List<Integer> [optional]
createdFrom OffsetDateTime [optional]
createdTo OffsetDateTime [optional]

Return type

RestApiArrayResultOrderBatch

Authorization

oauth2

HTTP request headers

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

getOrderBatch

RestApiResultOrderBatch getOrderBatch(appId, orderBatchId)

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.OrderBatchesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

OrderBatchesApi apiInstance = new OrderBatchesApi();
String appId = "appId_example"; // String | 
Integer orderBatchId = 56; // Integer | 
try {
    RestApiResultOrderBatch result = apiInstance.getOrderBatch(appId, orderBatchId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderBatchesApi#getOrderBatch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
orderBatchId Integer

Return type

RestApiResultOrderBatch

Authorization

oauth2

HTTP request headers

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