Skip to content

Latest commit

 

History

History
263 lines (195 loc) · 7.33 KB

DeliveryZoneApi.md

File metadata and controls

263 lines (195 loc) · 7.33 KB

Flipdish.Api.DeliveryZoneApi

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

Method HTTP request Description
AddDeliveryZone POST /api/v1.0/stores/{storeId}/deliveryzones
GetDeliveryZones GET /api/v1.0/stores/{storeId}/deliveryzones
RemoveDeliveryZone DELETE /api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}
UpdateDeliveryZone POST /api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}

AddDeliveryZone

RestApiResultDeliveryZone AddDeliveryZone (int? storeId, DeliveryZoneBase deliveryZoneBase)

Example

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

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

            var apiInstance = new DeliveryZoneApi();
            var storeId = 56;  // int? | 
            var deliveryZoneBase = new DeliveryZoneBase(); // DeliveryZoneBase | 

            try
            {
                RestApiResultDeliveryZone result = apiInstance.AddDeliveryZone(storeId, deliveryZoneBase);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliveryZoneApi.AddDeliveryZone: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
deliveryZoneBase DeliveryZoneBase

Return type

RestApiResultDeliveryZone

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]

GetDeliveryZones

RestApiArrayResultDeliveryZone GetDeliveryZones (int? storeId)

Example

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

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

            var apiInstance = new DeliveryZoneApi();
            var storeId = 56;  // int? | 

            try
            {
                RestApiArrayResultDeliveryZone result = apiInstance.GetDeliveryZones(storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliveryZoneApi.GetDeliveryZones: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?

Return type

RestApiArrayResultDeliveryZone

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]

RemoveDeliveryZone

void RemoveDeliveryZone (int? storeId, int? deliveryZoneId)

Example

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

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

            var apiInstance = new DeliveryZoneApi();
            var storeId = 56;  // int? | 
            var deliveryZoneId = 56;  // int? | 

            try
            {
                apiInstance.RemoveDeliveryZone(storeId, deliveryZoneId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliveryZoneApi.RemoveDeliveryZone: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
deliveryZoneId 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]

UpdateDeliveryZone

RestApiResultDeliveryZone UpdateDeliveryZone (int? storeId, int? deliveryZoneId, DeliveryZoneBase deliveryZone)

Example

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

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

            var apiInstance = new DeliveryZoneApi();
            var storeId = 56;  // int? | 
            var deliveryZoneId = 56;  // int? | 
            var deliveryZone = new DeliveryZoneBase(); // DeliveryZoneBase | 

            try
            {
                RestApiResultDeliveryZone result = apiInstance.UpdateDeliveryZone(storeId, deliveryZoneId, deliveryZone);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliveryZoneApi.UpdateDeliveryZone: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
deliveryZoneId int?
deliveryZone DeliveryZoneBase

Return type

RestApiResultDeliveryZone

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]