Skip to content

Latest commit

 

History

History
114 lines (76 loc) · 2.87 KB

OrderBatchesApi.md

File metadata and controls

114 lines (76 loc) · 2.87 KB
Raw

Flipdish.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, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.OrderBatchesApi();
let appId = "appId_example"; // String | 
let opts = {
  'storeIds': [null], // [Number] | 
  'createdFrom': new Date("2013-10-20T19:20:30+01:00"), // Date | 
  'createdTo': new Date("2013-10-20T19:20:30+01:00") // Date | 
};
apiInstance.getAllOrderBatches(appId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
storeIds [Number] [optional]
createdFrom Date [optional]
createdTo Date [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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.OrderBatchesApi();
let appId = "appId_example"; // String | 
let orderBatchId = 56; // Number | 
apiInstance.getOrderBatch(appId, orderBatchId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
orderBatchId Number

Return type

RestApiResultOrderBatch

Authorization

oauth2

HTTP request headers

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