Skip to content

Latest commit

 

History

History
1000 lines (756 loc) · 29.5 KB

OrdersApi.md

File metadata and controls

1000 lines (756 loc) · 29.5 KB

Flipdish.Api.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

void AcceptOrder (int? id, Accept acceptObject)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class AcceptOrderExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var id = 56;  // int? | 
            var acceptObject = new Accept(); // Accept | 

            try
            {
                apiInstance.AcceptOrder(id, acceptObject);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.AcceptOrder: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id int?
acceptObject Accept

Return type

void (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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DispatchOrder

void DispatchOrder (int? id)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DispatchOrderExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var id = 56;  // int? | 

            try
            {
                apiInstance.DispatchOrder(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.DispatchOrder: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id int?

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDeliveryInformation

RestApiResultOrderDeliveryInformation GetDeliveryInformation (int? orderId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetDeliveryInformationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var orderId = 56;  // int? | 

            try
            {
                RestApiResultOrderDeliveryInformation result = apiInstance.GetDeliveryInformation(orderId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.GetDeliveryInformation: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
orderId int?

Return type

RestApiResultOrderDeliveryInformation

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFulfillmentState

RestApiResultOrderFulfillmentStatus GetFulfillmentState (int? orderId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetFulfillmentStateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var orderId = 56;  // int? | 

            try
            {
                RestApiResultOrderFulfillmentStatus result = apiInstance.GetFulfillmentState(orderId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.GetFulfillmentState: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
orderId int?

Return type

RestApiResultOrderFulfillmentStatus

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFulfillmentStatusWithDetailsAndActions

RestApiResultOrderFulfillmentStatusWithConfigurationActions GetFulfillmentStatusWithDetailsAndActions (int? orderId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetFulfillmentStatusWithDetailsAndActionsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var orderId = 56;  // int? | 

            try
            {
                RestApiResultOrderFulfillmentStatusWithConfigurationActions result = apiInstance.GetFulfillmentStatusWithDetailsAndActions(orderId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.GetFulfillmentStatusWithDetailsAndActions: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
orderId int?

Return type

RestApiResultOrderFulfillmentStatusWithConfigurationActions

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOrderById

RestApiResultOrder GetOrderById (int? id)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetOrderByIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var id = 56;  // int? | 

            try
            {
                RestApiResultOrder result = apiInstance.GetOrderById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.GetOrderById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id int?

Return type

RestApiResultOrder

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOrders

RestApiPaginationResultOrder GetOrders (List<int?> physicalRestaurantId = null, List state = null, DateTime? from = null, DateTime? to = null, int? page = null, int? limit = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetOrdersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var physicalRestaurantId = new List<int?>(); // List<int?> |  (optional) 
            var state = state_example;  // List<string> |  (optional) 
            var from = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var to = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultOrder result = apiInstance.GetOrders(physicalRestaurantId, state, from, to, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.GetOrders: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
physicalRestaurantId List<int?> [optional]
state List<string> [optional]
from DateTime? [optional]
to DateTime? [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultOrder

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOrdersSummary

RestApiPaginationResultOrderSummary GetOrdersSummary (string appId, string searchQuery = null, List<int?> physicalRestaurantId = null, List state = null, int? page = null, int? limit = null, bool? orderByRequestedForTime = null, List channels = null, List<int?> orderIds = null, DateTime? from = null, DateTime? to = null, bool? logSql = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetOrdersSummaryExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var appId = appId_example;  // string | 
            var searchQuery = searchQuery_example;  // string |  (optional) 
            var physicalRestaurantId = new List<int?>(); // List<int?> |  (optional) 
            var state = state_example;  // List<string> |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var orderByRequestedForTime = true;  // bool? |  (optional) 
            var channels = channels_example;  // List<string> |  (optional) 
            var orderIds = new List<int?>(); // List<int?> |  (optional) 
            var from = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var to = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var logSql = true;  // bool? |  (optional) 

            try
            {
                RestApiPaginationResultOrderSummary result = apiInstance.GetOrdersSummary(appId, searchQuery, physicalRestaurantId, state, page, limit, orderByRequestedForTime, channels, orderIds, from, to, logSql);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.GetOrdersSummary: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
searchQuery string [optional]
physicalRestaurantId List<int?> [optional]
state List<string> [optional]
page int? [optional]
limit int? [optional]
orderByRequestedForTime bool? [optional]
channels List<string> [optional]
orderIds List<int?> [optional]
from DateTime? [optional]
to DateTime? [optional]
logSql bool? [optional]

Return type

RestApiPaginationResultOrderSummary

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOrdersSummaryNew

RestApiPaginationResultOrderSummary GetOrdersSummaryNew (string appId, string searchQuery = null, List<int?> physicalRestaurantId = null, List state = null, int? page = null, int? limit = null, bool? orderByRequestedForTime = null, List channels = null, List<int?> orderIds = null, DateTime? from = null, DateTime? to = null, bool? logSql = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetOrdersSummaryNewExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var appId = appId_example;  // string | 
            var searchQuery = searchQuery_example;  // string |  (optional) 
            var physicalRestaurantId = new List<int?>(); // List<int?> |  (optional) 
            var state = state_example;  // List<string> |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var orderByRequestedForTime = true;  // bool? |  (optional) 
            var channels = channels_example;  // List<string> |  (optional) 
            var orderIds = new List<int?>(); // List<int?> |  (optional) 
            var from = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var to = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var logSql = true;  // bool? |  (optional) 

            try
            {
                RestApiPaginationResultOrderSummary result = apiInstance.GetOrdersSummaryNew(appId, searchQuery, physicalRestaurantId, state, page, limit, orderByRequestedForTime, channels, orderIds, from, to, logSql);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.GetOrdersSummaryNew: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
searchQuery string [optional]
physicalRestaurantId List<int?> [optional]
state List<string> [optional]
page int? [optional]
limit int? [optional]
orderByRequestedForTime bool? [optional]
channels List<string> [optional]
orderIds List<int?> [optional]
from DateTime? [optional]
to DateTime? [optional]
logSql bool? [optional]

Return type

RestApiPaginationResultOrderSummary

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetReadyToProcess

OrderList GetReadyToProcess (string appId, List<int?> storeId = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetReadyToProcessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var appId = appId_example;  // string | 
            var storeId = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                OrderList result = apiInstance.GetReadyToProcess(appId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.GetReadyToProcess: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId List<int?> [optional]

Return type

OrderList

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RefundOrder

void RefundOrder (int? id, Refund refundObject)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class RefundOrderExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var id = 56;  // int? | 
            var refundObject = new Refund(); // Refund | 

            try
            {
                apiInstance.RefundOrder(id, refundObject);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.RefundOrder: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id int?
refundObject Refund

Return type

void (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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RejectOrder

void RejectOrder (int? id, Reject rejectObject)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class RejectOrderExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var id = 56;  // int? | 
            var rejectObject = new Reject(); // Reject | 

            try
            {
                apiInstance.RejectOrder(id, rejectObject);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.RejectOrder: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id int?
rejectObject Reject

Return type

void (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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchFulfillmentStatuses

RestApiArrayResultOrderFulfillmentStatus SearchFulfillmentStatuses (string appId, string orderIds)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class SearchFulfillmentStatusesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var appId = appId_example;  // string | 
            var orderIds = orderIds_example;  // string | 

            try
            {
                RestApiArrayResultOrderFulfillmentStatus result = apiInstance.SearchFulfillmentStatuses(appId, orderIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.SearchFulfillmentStatuses: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateDeliveryInformation

void UpdateDeliveryInformation (int? orderId, OrderDeliveryInformationBase deliveryInformation)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UpdateDeliveryInformationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var orderId = 56;  // int? | 
            var deliveryInformation = new OrderDeliveryInformationBase(); // OrderDeliveryInformationBase | 

            try
            {
                apiInstance.UpdateDeliveryInformation(orderId, deliveryInformation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.UpdateDeliveryInformation: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
orderId int?
deliveryInformation OrderDeliveryInformationBase

Return type

void (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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateFulfillmentState

void UpdateFulfillmentState (int? orderId, OrderFulfillmentStatusUpdate fulfillmentStatusRequest)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UpdateFulfillmentStateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var orderId = 56;  // int? | 
            var fulfillmentStatusRequest = new OrderFulfillmentStatusUpdate(); // OrderFulfillmentStatusUpdate | 

            try
            {
                apiInstance.UpdateFulfillmentState(orderId, fulfillmentStatusRequest);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.UpdateFulfillmentState: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
orderId int?
fulfillmentStatusRequest OrderFulfillmentStatusUpdate

Return type

void (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

[Back to top] [Back to API list] [Back to Model list] [Back to README]