list_customer_item_price_list
POST /list_customer_item_price_list
To get the TOTAL COUNT of list of customers items price list for multiple search criteria.
Use this method with only_counted = 'Y' FIRST to determine how many total records there are for the given criteria.
After you call this method with only_counted = 'Y', then call again this method with only_counted = 'N', and pass the required paging parameters.
{
"api_credentials": {
"token": "XXXXX"
},
"filter_define": {
"only_counted":"Y",
"page_number":"1",
"page_size": "100",
"price_list_type": "all",
"price_list_lock_type":"all",
"discount_type": "all",
"applied_to_price_selection":"",
"effective_date_from": "",
"effective_date_to": "",
"expired_date_from": "",
"expired_date_to": ""
}
}
To get a list of customers items price list for multiple search criteria.
{
"api_credentials": {
"token": "XXXXX"
},
"filter_define": {
"only_counted":"N",
"page_number":"1",
"page_size": "100",
"price_list_type": "all",
"price_list_lock_type":"all",
"discount_type": "all",
"applied_to_price_selection":"",
"effective_date_from": "",
"effective_date_to": "",
"expired_date_from": "",
"expired_date_to": ""
}
}
| field |
type |
description |
| api_credentials
|
| token |
string |
Credentials provided by Powersoft that allow access to the API |
| filter_define
|
| only_counted |
string |
'Y' = brings only the total of customers items price list found based on user filter criteria. 'N' = brings the list of the customers items price list found based on user filter criteria |
| page_number |
integer |
The page number in the entire list. eg Page 1. |
| page_size |
integer |
The number of rows to return. eg 10 rows |
| price_list_type |
string |
Only 'active', 'inactive','expired' and 'all' values are allowed. |
| price_list_lock_type |
string |
Only 'locked', 'notlocked' and 'all' values are allowed. |
| discount_type |
string |
Only 'fixedprice', 'discountpercentage', 'discountvalue' and 'all' values are allowed. |
| applied_to_price_selection |
integer |
| Comma separated list of prices to which the discount is applied to.
|
| 0
|
Default price. It is the price defined at the store level
|
| 1
|
Price 1
|
| 2
|
Price 2
|
| 3
|
Price 3
|
| 4
|
Price 4
|
| 5
|
Price 5
|
| 6
|
Price 6
|
| 7
|
Price 7
|
| 8
|
Price 8
|
| 9
|
Price 9
|
| 10
|
Price 10
|
| 87
|
Weighted Average Cost
|
| 88
|
Average Cost
|
| 99
|
Latest Cost
|
|
| effective_from_date |
string |
Effective date from. The date must be provided in format yyyy-mm-dd |
| effective_date_to |
string |
Effective date to. The date must be provided in format yyyy-mm-dd |
| expired_from_date |
string |
Expired date from. The date must be provided in format yyyy-mm-dd |
| expired_date_to |
string |
Expired date to. The date must be provided in format yyyy-mm-dd |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_price_lists": 4,
"list_price_lists": [
{
"price_list_header": {
"price_list_number": "SP1000000015",
"price_list_name": "TEST",
"price_list_active": true,
"price_list_locked": false,
"effective_date": "2020-03-01",
"expired_date": "2020-03-31",
"discount_type": "fixedprice",
"value": 1.1000,
"applied_to_price": 0,
"value_includes_vat": true,
"show_discount_on_invoice": false,
"rounding_price": false,
"rounding_value": 0.0000
},
"list_price_list_details": [
{
"selection_applied_to": "CUSTOMER",
"selection_level": "Customer",
"selection_entity_code": "ALL",
"parameters": null
}
]
},
{
"price_list_header": {
"price_list_number": "SP1000000016",
"price_list_name": "TEST 2",
"price_list_active": false,
"price_list_locked": false,
"effective_date": "2020-03-01",
"expired_date": "2020-03-31",
"discount_type": "fixedprice",
"value": 1.1000,
"applied_to_price": 0,
"value_includes_vat": true,
"show_discount_on_invoice": false,
"rounding_price": false,
"rounding_value": 0.0000
},
"list_price_list_details": [
{
"selection_applied_to": "CUSTOMER",
"selection_level": "Customer",
"selection_entity_code": "ALL",
"parameters": null
}
]
},
{
"price_list_header": {
"price_list_number": "SP1000000017",
"price_list_name": "TEST3",
"price_list_active": true,
"price_list_locked": false,
"effective_date": "2020-03-01",
"expired_date": "2020-03-31",
"discount_type": "fixedprice",
"value": 1.1000,
"applied_to_price": 0,
"value_includes_vat": true,
"show_discount_on_invoice": false,
"rounding_price": false,
"rounding_value": 0.0000
},
"list_price_list_details": [
{
"selection_applied_to": "CUSTOMER",
"selection_level": "Customer",
"selection_entity_code": "ALL",
"parameters": null
},
{
"selection_applied_to": "ITEM",
"selection_level": "Item",
"selection_entity_code": "8718951231665",
"parameters": {
"discount_type": "fixedprice",
"value": 3.2900,
"applied_to_price": 0,
"value_includes_vat": true,
"show_discount_on_invoice": false,
"rounding_price": false,
"rounding_value": 0.0000
}
},
{
"selection_applied_to": "ITEM",
"selection_level": "Item",
"selection_entity_code": "8718951231573",
"parameters": {
"discount_type": "fixedprice",
"value": 3.2900,
"applied_to_price": 0,
"value_includes_vat": true,
"show_discount_on_invoice": false,
"rounding_price": false,
"rounding_value": 0.0000
}
},
{
"selection_applied_to": "ITEM",
"selection_level": "Item",
"selection_entity_code": "8718951231542",
"parameters": {
"discount_type": "fixedprice",
"value": 3.2900,
"applied_to_price": 0,
"value_includes_vat": true,
"show_discount_on_invoice": false,
"rounding_price": false,
"rounding_value": 0.0000
}
},
{
"selection_applied_to": "ITEM",
"selection_level": "Item",
"selection_entity_code": "5290068005795",
"parameters": {
"discount_type": "fixedprice",
"value": 2.1900,
"applied_to_price": 0,
"value_includes_vat": true,
"show_discount_on_invoice": false,
"rounding_price": false,
"rounding_value": 0.0000
}
}
]
},
{
"price_list_header": {
"price_list_number": "SP1000000026",
"price_list_name": "TEST2222222",
"price_list_active": true,
"price_list_locked": false,
"effective_date": "2020-03-01",
"expired_date": "2020-08-31",
"discount_type": "fixedprice",
"value": 2.5000,
"applied_to_price": 0,
"value_includes_vat": true,
"show_discount_on_invoice": false,
"rounding_price": false,
"rounding_value": 0.0000
},
"list_price_list_details": [
{
"selection_applied_to": "CUSTOMER",
"selection_level": "Customer",
"selection_entity_code": "ALL",
"parameters": null
},
{
"selection_applied_to": "ITEM",
"selection_level": "Item",
"selection_entity_code": "ΖΥΓΙΣΤΙΚΟ ΚΟΠΗΣ",
"parameters": {
"discount_type": "fixedprice",
"value": 2.5000,
"applied_to_price": 0,
"value_includes_vat": true,
"show_discount_on_invoice": false,
"rounding_price": false,
"rounding_value": 0.0000
}
}
]
}
]
}
If in the detail object the parameters object is null it means the price list has not been defined by item in 365 and the values applied are the ones presented in the header object.