list_modifiers
GET /list_modifiers
To get the TOTAL COUNT of the list of modifiers.
Use this method FIRST to determine how many total records there are.
After you call this method, then call the method below, and pass the required paging parameters.
/list_modifiers?token=XXXXX
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_modifiers": 9
}
GET /list_modifiers
To get a list of modifiers.
/list_modifiers?token=XXXXX&page_number=1&page_size=10
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| page_number |
The page number in the entire list. eg Page 1 |
| page_size |
The number of rows to return. eg 10 rows |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"list_modifiers": [
{
"modifier_code_365": "AVO",
"modifier_name": "AVOCADO",
"item_department_code_365": "N/A",
"item_department_name": "N/A",
"item_category_code_365": "01",
"item_category_name": "SANDWICH",
"charge_amount": 0.0000,
"display_on_invoice": false,
"item_code_365": "N/A",
"item_name": "N/A",
"display_colour": "#008000",
"pos_position": 1,
"to_delete": true
},
{
"modifier_code_365": "TOMATO",
"modifier_name": "TOMATOES",
"item_department_code_365": "N/A",
"item_department_name": "N/A",
"item_category_code_365": "SANDWICH",
"item_category_name": "SANDWICH",
"charge_amount": 0.0000,
"display_on_invoice": false,
"item_code_365": "N/A",
"item_name": "N/A",
"display_colour": " #FF0000",
"pos_position": 2,
"to_delete": true
}
]
}
GET /list_modifiers
To get the TOTAL COUNT of the list of modifiers by entity code (department or category).
Use this method FIRST to determine how many total records there are.
After you call this method, then call the method below, and pass the required paging parameters.
/list_modifiers?token=XXXXX&entity_type=category&entity_code_365=SANDWICH
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| entity_type |
Entity Type: department or category. Modifiers can be defined by category or department. |
| entity_code_365 |
365 item category or department code |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_modifiers": 2
}
GET /list_modifiers
To get a list of modifiers by entity code.
/list_modifiers?token=XXXXX&entity_type=category&entity_code_365=SANDWICH&page_number=1&page_size=10
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| entity_type |
Entity Type: department or category. Modifiers can be defined by category or department. |
| entity_code_365 |
365 item category or department code |
| page_number |
The page number in the entire list. eg Page 1 |
| page_size |
The number of rows to return. eg 10 rows |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"list_modifiers": [
{
"modifier_code_365": "AVO",
"modifier_name": "AVOCADO",
"item_department_code_365": "N/A",
"item_department_name": "N/A",
"item_category_code_365": "01",
"item_category_name": "SANDWICH",
"charge_amount": 0.0000,
"display_on_invoice": false,
"item_code_365": "N/A",
"item_name": "N/A",
"display_colour": "#008000",
"pos_position": 1,
"to_delete": true
},
{
"modifier_code_365": "TOMATO",
"modifier_name": "TOMATOES",
"item_department_code_365": "N/A",
"item_department_name": "N/A",
"item_category_code_365": "SANDWICH",
"item_category_name": "SANDWICH",
"charge_amount": 0.0000,
"display_on_invoice": false,
"item_code_365": "N/A",
"item_name": "N/A",
"display_colour": " #FF0000",
"pos_position": 2,
"to_delete": true
}
]
}