Flipdish\Client\MenuSectionItemsApi

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

Method	HTTP request	Description
cloneMenuSectionItem	POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/clone	Clone menu section item
createMenuSectionItem	POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems	Create menu section item
createMenuSectionItemFromCatalogItems	POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/add-catalogitems	Create menu section items from a list of Catalog Items
deleteMenuSectionItem	DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}	Delete menu section item
deleteMenuSectionItemImage	DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/image	Delete menu section item image
getMenuItemById	GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}	Get menu item by identifier
getMenuItems	GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems	Get menu items
moveMenuItem	POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/setorder/{destinationDisplayOrder}	Move an Item within a menu
setSectionItemTax	POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/taxrate/{taxRateId}	Set tax rate for menu item
updateMenuSectionItem	POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}	Update menu section item
uploadMenuSectionItemImage	POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/image	Upload menu section item image

cloneMenuSectionItem

\Flipdish\Client\Models\RestApiResultMenuSectionItem cloneMenuSectionItem($menu_id, $menu_section_id, $menu_section_item_id)

Clone menu section item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$menu_section_item_id = 56; // int | Menu section item identifier

try {
    $result = $apiInstance->cloneMenuSectionItem($menu_id, $menu_section_id, $menu_section_item_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->cloneMenuSectionItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
menu_section_item_id	int	Menu section item identifier

Return type

\Flipdish\Client\Models\RestApiResultMenuSectionItem

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]

createMenuSectionItem

object createMenuSectionItem($menu_id, $menu_section_id, $menu_section_item)

Create menu section item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$menu_section_item = new \Flipdish\\Client\Models\MenuSectionItemBase(); // \Flipdish\\Client\Models\MenuSectionItemBase | Menu section item

try {
    $result = $apiInstance->createMenuSectionItem($menu_id, $menu_section_id, $menu_section_item);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->createMenuSectionItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
menu_section_item	\Flipdish\Client\Models\MenuSectionItemBase	Menu section item

Return type

object

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]

createMenuSectionItemFromCatalogItems

object createMenuSectionItemFromCatalogItems($menu_id, $menu_section_id, $create_from_catalog_items)

Create menu section items from a list of Catalog Items

BETA - this endpoint is under development, do not use it in your production system

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$create_from_catalog_items = new \Flipdish\\Client\Models\CreateMenuSectionItemFromCatalogItems(); // \Flipdish\\Client\Models\CreateMenuSectionItemFromCatalogItems | Information to create the new MenuSectionItems

try {
    $result = $apiInstance->createMenuSectionItemFromCatalogItems($menu_id, $menu_section_id, $create_from_catalog_items);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->createMenuSectionItemFromCatalogItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
create_from_catalog_items	\Flipdish\Client\Models\CreateMenuSectionItemFromCatalogItems	Information to create the new MenuSectionItems

Return type

object

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]

deleteMenuSectionItem

deleteMenuSectionItem($menu_id, $menu_section_id, $menu_section_item_id)

Delete menu section item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$menu_section_item_id = 56; // int | Menu section item identifier

try {
    $apiInstance->deleteMenuSectionItem($menu_id, $menu_section_id, $menu_section_item_id);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->deleteMenuSectionItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
menu_section_item_id	int	Menu section item identifier

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]

deleteMenuSectionItemImage

deleteMenuSectionItemImage($menu_id, $menu_section_id, $menu_section_item_id)

Delete menu section item image

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$menu_section_item_id = 56; // int | Menu section item identifier

try {
    $apiInstance->deleteMenuSectionItemImage($menu_id, $menu_section_id, $menu_section_item_id);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->deleteMenuSectionItemImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
menu_section_item_id	int	Menu section item identifier

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]

getMenuItemById

\Flipdish\Client\Models\RestApiResultMenuSectionItem getMenuItemById($menu_id, $menu_section_id, $menu_section_item_id)

Get menu item by identifier

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$menu_section_item_id = 56; // int | Menu item identifier

try {
    $result = $apiInstance->getMenuItemById($menu_id, $menu_section_id, $menu_section_item_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->getMenuItemById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
menu_section_item_id	int	Menu item identifier

Return type

\Flipdish\Client\Models\RestApiResultMenuSectionItem

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]

getMenuItems

\Flipdish\Client\Models\RestApiArrayResultMenuSectionItem getMenuItems($menu_id, $menu_section_id)

Get menu items

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier

try {
    $result = $apiInstance->getMenuItems($menu_id, $menu_section_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->getMenuItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier

Return type

\Flipdish\Client\Models\RestApiArrayResultMenuSectionItem

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]

moveMenuItem

moveMenuItem($menu_id, $menu_section_id, $menu_section_item_id, $destination_display_order)

Move an Item within a menu

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Section to put item in (will usually be original section)
$menu_section_item_id = 56; // int | ID of Item to be moved
$destination_display_order = 56; // int | New Display Order of item

try {
    $apiInstance->moveMenuItem($menu_id, $menu_section_id, $menu_section_item_id, $destination_display_order);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->moveMenuItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Section to put item in (will usually be original section)
menu_section_item_id	int	ID of Item to be moved
destination_display_order	int	New Display Order of item

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]

setSectionItemTax

setSectionItemTax($menu_id, $menu_section_id, $menu_section_item_id, $tax_rate_id)

Set tax rate for menu item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Section to put item in (will usually be original section)
$menu_section_item_id = 56; // int | ID of Item to be moved
$tax_rate_id = 56; // int | tax rate to be set against item

try {
    $apiInstance->setSectionItemTax($menu_id, $menu_section_id, $menu_section_item_id, $tax_rate_id);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->setSectionItemTax: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Section to put item in (will usually be original section)
menu_section_item_id	int	ID of Item to be moved
tax_rate_id	int	tax rate to be set against item

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]

updateMenuSectionItem

updateMenuSectionItem($menu_id, $menu_section_id, $menu_section_item_id, $menu_section_item, $undo_after)

Update menu section item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$menu_section_item_id = 56; // int | Menu section item identifier
$menu_section_item = new \Flipdish\\Client\Models\MenuSectionItemBase(); // \Flipdish\\Client\Models\MenuSectionItemBase | Menu section item (delta)
$undo_after = 1.2; // double | An optional time period, in hours, after which the hide-section operation will be undone

try {
    $apiInstance->updateMenuSectionItem($menu_id, $menu_section_id, $menu_section_item_id, $menu_section_item, $undo_after);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->updateMenuSectionItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
menu_section_item_id	int	Menu section item identifier
menu_section_item	\Flipdish\Client\Models\MenuSectionItemBase	Menu section item (delta)
undo_after	double	An optional time period, in hours, after which the hide-section operation will be undone	[optional]

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]

uploadMenuSectionItemImage

\Flipdish\Client\Models\RestApiStringResult uploadMenuSectionItemImage($menu_id, $menu_section_id, $menu_section_item_id, $image)

Upload menu section item image

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionItemsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$menu_section_item_id = 56; // int | Menu section item identifier
$image = "/path/to/file.txt"; // \SplFileObject | Menu section item image

try {
    $result = $apiInstance->uploadMenuSectionItemImage($menu_id, $menu_section_id, $menu_section_item_id, $image);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionItemsApi->uploadMenuSectionItemImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
menu_section_item_id	int	Menu section item identifier
image	\SplFileObject	Menu section item image

Return type

\Flipdish\Client\Models\RestApiStringResult

Authorization

oauth2

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json, text/json, application/xml, text/xml

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

FilesExpand file tree

MenuSectionItemsApi.md

Latest commit

History

MenuSectionItemsApi.md

File metadata and controls

Flipdish\Client\MenuSectionItemsApi

cloneMenuSectionItem

Example

Parameters

Return type

Authorization

HTTP request headers

createMenuSectionItem

Example

Parameters

Return type

Authorization

HTTP request headers

createMenuSectionItemFromCatalogItems

Example

Parameters

Return type

Authorization

HTTP request headers

deleteMenuSectionItem

Example

Parameters

Return type

Authorization

HTTP request headers

deleteMenuSectionItemImage

Example

Parameters

Return type

Authorization

HTTP request headers

getMenuItemById

Example

Parameters

Return type

Authorization

HTTP request headers

getMenuItems

Example

Parameters

Return type

Authorization

HTTP request headers

moveMenuItem

Example

Parameters

Return type

Authorization

HTTP request headers

setSectionItemTax

Example

Parameters

Return type

Authorization

HTTP request headers

updateMenuSectionItem

Example

Parameters

Return type

Authorization

HTTP request headers

uploadMenuSectionItemImage

Example

Parameters

Return type

Authorization

HTTP request headers