list_models
GET /list_models
To get the TOTAL COUNT of models for search criteria.
Use this method FIRST to determine how many total records there are for the given criteria.
After you call this method, then call the method below, and pass the required paging parameters.
/list_models?token=XXXXX&active_type=active
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| active_type |
'active' = Only the active models. 'inactive' = Only the inactive models. 'all' = All the models(active and inactive) |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_models": 1
}
GET /list_models
To get a list of models.
/list_models?token=XXXXX&active_type=active&page_number=1&page_size=10
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| active_type |
'active' = Only the active models. 'inactive' = Only the inactive models. 'all' = All the models(active and inactive) |
| 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_models": [
{
"model_code_365": "ARTICLE01",
"model_name": "ARTICLE 01",
"model_name_2": "ARTICLE 01",
"active": true,
"vat_code_365": "019",
"vat_percent": 19,
"price_excl": 168.07,
"price_incl": 200,
"specifications": "",
"notes": "",
"category_code_365": "CAT3",
"category_name": "CAT3",
"dept_code_365": "",
"dept_name": "",
"brand_code_365": "LEVINTZA",
"brand_name": "LEVINTZA",
"season_code_365": "2013S",
"season_name": "2013 SUMMER",
"fabric_code_365": "",
"fabric_name": "",
"size_group_code_365": "24-40",
"size_group_name": "24 - 40",
"attribute_1_code_365": "",
"attribute_1_name": "",
"attribute_2_code_365": "",
"attribute_2_name": "",
"attribute_3_code_365": "",
"attribute_3_name": "",
"attribute_4_code_365": "ATTR4",
"attribute_4_name": "ATTRIBUTE4",
"attribute_5_code_365": "",
"attribute_5_name": "",
"attribute_6_code_365": "",
"attribute_6_name": "",
"um_code_365": "",
"um_name": "",
"model_length": 0,
"model_width": 0,
"model_height": 0,
"model_volume": 0,
"model_weight": 0,
"boolean_field_1_value": false,
"boolean_field_2_value": false,
"boolean_field_3_value": false,
"boolean_field_4_value": false,
"boolean_field_5_value": false,
"text_field_1_value": "",
"text_field_2_value": "",
"text_field_3_value": "",
"text_field_4_value": "",
"text_field_5_value": "",
"number_field_1_value": 0,
"number_field_2_value": 0,
"number_field_3_value": 0,
"number_field_4_value": 0,
"number_field_5_value": 0,
"date_field_1_value": "",
"date_field_2_value": "",
"date_field_3_value": "",
"date_field_4_value": "",
"date_field_5_value": ""
}
],
"failed_model": null
}
POST /list_models
To get the TOTAL COUNT of list of models 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":0,
"page_size":0,
"active_type":"all",
"ecommerce_type":"all",
"categories_selection":"",
"departments_selection": "",
"models_supplier_selection":"",
"brands_selection":"",
"seasons_selection":"",
"sizes_group_selection":"",
"attributes_1_selection":"",
"attributes_2_selection":"",
"attributes_3_selection":"",
"attributes_4_selection":"",
"attributes_5_selection":"",
"attributes_6_selection":"",
"keyword_search_model_code_365":"",
"keyword_search_model_name":"",
"text_field_value_1_selection": "",
"text_field_value_2_selection": "",
"text_field_value_3_selection": "",
"text_field_value_4_selection": "",
"text_field_value_5_selection": "",
"number_field_value_1_selection": "",
"number_field_value_2_selection": "",
"number_field_value_3_selection": "",
"number_field_value_4_selection": "",
"number_field_value_5_selection": "",
"date_field_value_1_selection": "",
"date_field_value_2_selection": "",
"date_field_value_3_selection": "",
"date_field_value_4_selection": "",
"date_field_value_5_selection": "",
"boolean_field_value_1": "",
"boolean_field_value_2": "",
"boolean_field_value_3": "",
"boolean_field_value_4": "",
"boolean_field_value_5": "",
"date_field_1_value_from": "",
"date_field_1_value_to": "",
"date_field_2_value_from": "",
"date_field_2_value_to": "",
"date_field_3_value_from": "",
"date_field_3_value_to": "",
"date_field_4_value_from": "",
"date_field_4_value_to": "",
"date_field_5_value_from": "",
"date_field_5_value_to": "",
"last_modified_from":"",
"last_modified_to":""
}
}
To get a list of models for multiple search criteria.
{
"api_credentials": {
"token": "XXXXX"
},
"filter_define": {
"only_counted": "N",
"page_number":1,
"page_size":10,
"active_type":"all",
"ecommerce_type":"all",
"categories_selection":"",
"departments_selection": "",
"models_supplier_selection":"",
"brands_selection":"",
"seasons_selection":"",
"sizes_group_selection":"",
"attributes_1_selection":"",
"attributes_2_selection":"",
"attributes_3_selection":"",
"attributes_4_selection":"",
"attributes_5_selection":"",
"attributes_6_selection":"",
"keyword_search_model_code_365":"",
"keyword_search_model_name":"",
"request_password_365":"",
"text_field_value_1_selection": "",
"text_field_value_2_selection": "",
"text_field_value_3_selection": "",
"text_field_value_4_selection": "",
"text_field_value_5_selection": "",
"number_field_value_1_selection": "",
"number_field_value_2_selection": "",
"number_field_value_3_selection": "",
"number_field_value_4_selection": "",
"number_field_value_5_selection": "",
"date_field_value_1_selection": "",
"date_field_value_2_selection": "",
"date_field_value_3_selection": "",
"date_field_value_4_selection": "",
"date_field_value_5_selection": "",
"boolean_field_value_1": "",
"boolean_field_value_2": "",
"boolean_field_value_3": "",
"boolean_field_value_4": "",
"boolean_field_value_5": "",
"date_field_1_value_from": "",
"date_field_1_value_to": "",
"date_field_2_value_from": "",
"date_field_2_value_to": "",
"date_field_3_value_from": "",
"date_field_3_value_to": "",
"date_field_4_value_from": "",
"date_field_4_value_to": "",
"date_field_5_value_from": "",
"date_field_5_value_to": "",
"last_modified_from":"",
"last_modified_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 models found based on user filter criteria. 'N' = brings the list of the models 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 |
| active_type |
string |
'active' = Only the active models. 'inactive' = Only the inactive models. 'all' = All the models(active and inactive) |
| ecommerce_type |
string |
'eCommerceOnly' = Only models flagged as eCommerce. 'NoteCommerce' = Only the models which are not flagged as eCommerce. 'all' = All the models(flagged or not as eCommerce) |
| categories_selection |
string |
A comma separated list of 365 models categories codes (eg 'SHOES,CLOTHES,...'). If the value is empty then no search criteria by model category is applied. |
| departments_selection |
string |
A comma separated list of 365 models departments codes (eg 'MEN,WOMEN,CHILDREN,...'). If the value is empty then no search criteria by model department is applied. |
| models_supplier_selection |
string |
A comma separated list of 365 models suppliers codes (eg '10000001,10000004,10000009,...'). If the value is empty then no search criteria by model supplier is applied. |
| brands_selection |
string |
A comma separated list of 365 brands codes (eg 'GUCCI,LEVINTZA,...'). If the value is empty then no search criteria by brands is applied. |
| seasons_selection |
string |
A comma separated list of 365 seasons codes (eg '2015S,2016W,...'). If the value is empty then no search criteria by season is applied. |
| sizes_group_selection |
string |
A comma separated list of 365 sizes groups codes (eg 'SML,10-20,...'). If the value is empty then no search criteria by size group is applied. |
| attributes_1_selection |
string |
A comma separated list of 365 attributes 1 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 1 is applied. |
| attributes_2_selection |
string |
A comma separated list of 365 attributes 2 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 2 is applied. |
| attributes_3_selection |
string |
A comma separated list of 365 attributes 3 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 3 is applied. |
| attributes_4_selection |
string |
A comma separated list of 365 attributes 4 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 4 is applied. |
| attributes_5_selection |
string |
A comma separated list of 365 attributes 5 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 5 is applied. |
| attributes_6_selection |
string |
A comma separated list of 365 attributes 6 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 6 is applied. |
| keyword_search_model_code_365 |
string |
The keyword search in 365 model code. The system looks for all models codes that contain the word provided |
| keyword_search_model_name |
string |
The keyword search in model first description, name. The system looks for all models first descriptions that contain the word provided |
| request_password_365 |
string |
Request password as registered in 365 BASE64 encoded - optionally. The password is necessary if the user needs to have the model cost. Password is provided by Powersoft. |
| text_field_value_1_selection |
string |
A comma separated list of values to be searched in extra field text value 1 (eg 'filter,panel,...'). If the value is empty then no search criteria by text field 1 is applied. |
| text_field_value_2_selection |
string |
A comma separated list of values to be searched in extra field text value 2 (eg 'filter,panel,...'). If the value is empty then no search criteria by text field 2 is applied. |
| text_field_value_3_selection |
string |
A comma separated list of values to be searched in extra field text value 3 (eg 'filter,panel,...'). If the value is empty then no search criteria by text field 3 is applied. |
| text_field_value_4_selection |
string |
A comma separated list of values to be searched in extra field text value 4 (eg 'filter,panel,...'). If the value is empty then no search criteria by text field 4 is applied. |
| text_field_value_5_selection |
string |
A comma separated list of values to be searched in extra field text value 5 (eg 'filter,panel,...'). If the value is empty then no search criteria by text field 5 is applied. |
| number_field_value_1_selection |
string |
A comma separated list of values to be searched in extra field number value 1 (eg '102,125.35,...'). If the value is empty then no search criteria by number field 1 is applied. |
| number_field_value_2_selection |
string |
A comma separated list of values to be searched in extra field number value 2 (eg '102,125.35,...'). If the value is empty then no search criteria by number field 2 is applied. |
| number_field_value_3_selection |
string |
A comma separated list of values to be searched in extra field number value 3 (eg '102,125.35,...'). If the value is empty then no search criteria by number field 3 is applied. |
| number_field_value_4_selection |
string |
A comma separated list of values to be searched in extra field number value 4 (eg '102,125.35,...'). If the value is empty then no search criteria by number field 4 is applied. |
| number_field_value_5_selection |
string |
A comma separated list of values to be searched in extra field number value 5 (eg '102,125.35,...'). If the value is empty then no search criteria by number field 5 is applied. |
| date_field_value_1_selection |
string |
A comma separated list of values to be searched in extra field date value 1 (eg '2020-01-15,2021-10-25,...'). If the value is empty then no search criteria by date field 1 is applied. |
| date_field_value_2_selection |
string |
A comma separated list of values to be searched in extra field date value 2 (eg '2020-01-15,2021-10-25,...'). If the value is empty then no search criteria by date field 2 is applied. |
| date_field_value_3_selection |
string |
A comma separated list of values to be searched in extra field date value 3 (eg '2020-01-15,2021-10-25,...'). If the value is empty then no search criteria by date field 3 is applied. |
| date_field_value_4_selection |
string |
A comma separated list of values to be searched in extra field date value 4 (eg '2020-01-15,2021-10-25,...'). If the value is empty then no search criteria by date field 4 is applied. |
| date_field_value_5_selection |
string |
A comma separated list of values to be searched in extra field date value 5 (eg '2020-01-15,2021-10-25,...'). If the value is empty then no search criteria by date field 5 is applied. |
| boolean_field_value_1 |
string |
Allowed values 0, 1 or empty. If the value is empty then no search criteria by boolean_field_value_1 is applied. |
| boolean_field_value_2 |
string |
Allowed values 0, 1 or empty. If the value is empty then no search criteria by boolean_field_value_2 is applied. |
| boolean_field_value_3 |
string |
Allowed values 0, 1 or empty. If the value is empty then no search criteria by boolean_field_value_3 is applied. |
| boolean_field_value_4 |
string |
Allowed values 0, 1 or empty. If the value is empty then no search criteria by boolean_field_value_4 is applied. |
| boolean_field_value_5 |
string |
Allowed values 0, 1 or empty. If the value is empty then no search criteria by boolean_field_value_5 is applied. |
| date_field_1_value_from |
string |
Date field 1 from. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 1. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value. |
| date_field_1_value_to |
string |
Date field 1 to. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 1. If the from date is empty and to date has a value the system applies the criteria less or equal than to value. |
| date_field_2_value_from |
string |
Date field 2 from. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 2. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value. |
| date_field_2_value_to |
string |
Date field 2 to. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 2. If the from date is empty and to date has a value the system applies the criteria less or equal than to value. |
| date_field_3_value_from |
string |
Date field 3 from. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 3. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value. |
| date_field_3_value_to |
string |
Date field 3 to. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 3. If the from date is empty and to date has a value the system applies the criteria less or equal than to value. |
| date_field_4_value_from |
string |
Date field 4 from. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 4. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value. |
| date_field_4_value_to |
string |
Date field 4 to. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 4. If the from date is empty and to date has a value the system applies the criteria less or equal than to value. |
| date_field_5_value_from |
string |
Date field 5 from. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 5. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value. |
| date_field_5_value_to |
string |
Date field 5 to. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 5. If the from date is empty and to date has a value the system applies the criteria less or equal than to value. |
| last_modified_from |
string |
Last modified date from. The date must be provided in format yyyy-mm-dd HH:mm:ss. Pass "" if you don't want selection by last modified date. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value. |
| last_modified_to |
string |
Last modified date to. The date must be provided in format yyyy-mm-dd HH:mm:ss. Pass "" if you don't want selection by last modified date. If the from date is empty and to date has a value the system applies the criteria less or equal than to value. |
Returns
TOTAL COUNT of list of models for multiple search criteria (only_counted='Y').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_models": 2,
"list_models": null
}
List of models for multiple search criteria (only_counted='N').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_models": 2,
"list_models": [
{
"model_code_365": "ARTICLE01",
"model_name": "ARTICLE 01",
"model_name_2": "ARTICLE 01",
"active": true,
"vat_code_365": "019",
"vat_percent": 19,
"supplier_code_365": "10000001",
"supplier_name": "DEFAULT SUPPLIER",
"model_cost": 0,
"price_excl": 168.07,
"price_incl": 200,
"specifications": "",
"notes": "",
"category_code_365": "CAT3",
"category_name": "CAT3",
"dept_code_365": "",
"dept_name": "",
"brand_code_365": "LEVINTZA",
"brand_name": "LEVINTZA",
"season_code_365": "2013S",
"season_name": "2013 SUMMER",
"fabric_code_365": "",
"fabric_name": "",
"size_group_code_365": "24-40",
"size_group_name": "24 - 40",
"attribute_1_code_365": "ATTR1",
"attribute_1_name": "ATTRIBUTE 1",
"attribute_2_code_365": "",
"attribute_2_name": "",
"attribute_3_code_365": "",
"attribute_3_name": "",
"attribute_4_code_365": "",
"attribute_4_name": "",
"attribute_5_code_365": "",
"attribute_5_name": "",
"attribute_6_code_365": "",
"attribute_6_name": "",
"um_code_365": "",
"um_name": "",
"model_length": 15,
"model_width": 0,
"model_height": 0,
"model_volume": 0,
"model_weight": 0,
"boolean_field_1_value": false,
"boolean_field_2_value": false,
"boolean_field_3_value": false,
"boolean_field_4_value": false,
"boolean_field_5_value": false,
"text_field_1_value": "",
"text_field_2_value": "",
"text_field_3_value": "",
"text_field_4_value": "",
"text_field_5_value": "",
"number_field_1_value": 0,
"number_field_2_value": 0,
"number_field_3_value": 0,
"number_field_4_value": 0,
"number_field_5_value": 0,
"date_field_1_value": "",
"date_field_2_value": "",
"date_field_3_value": "",
"date_field_4_value": "",
"date_field_5_value": ""
},
{
"model_code_365": "ARTICLE02",
"model_name": "ARTICLE 02",
"model_name_2": "ARTICLE 02",
"active": true,
"vat_code_365": "019",
"vat_percent": 19,
"supplier_code_365": "10000001",
"supplier_name": "DEFAULT SUPPLIER",
"model_cost": 0,
"price_excl": 4.16,
"price_incl": 4.95,
"specifications": "",
"notes": "",
"category_code_365": "CAT3",
"category_name": "CAT3",
"dept_code_365": "KIT2",
"dept_name": "KITCHEN",
"brand_code_365": "GUCCI",
"brand_name": "GUCCI",
"season_code_365": "",
"season_name": "",
"fabric_code_365": "",
"fabric_name": "",
"size_group_code_365": "24-40",
"size_group_name": "24 - 40",
"attribute_1_code_365": "",
"attribute_1_name": "",
"attribute_2_code_365": "",
"attribute_2_name": "",
"attribute_3_code_365": "",
"attribute_3_name": "",
"attribute_4_code_365": "",
"attribute_4_name": "",
"attribute_5_code_365": "",
"attribute_5_name": "",
"attribute_6_code_365": "",
"attribute_6_name": "",
"um_code_365": "",
"um_name": "",
"model_length": 0,
"model_width": 0,
"model_height": 0,
"model_volume": 0,
"model_weight": 0,
"boolean_field_1_value": false,
"boolean_field_2_value": false,
"boolean_field_3_value": false,
"boolean_field_4_value": false,
"boolean_field_5_value": false,
"text_field_1_value": "",
"text_field_2_value": "",
"text_field_3_value": "",
"text_field_4_value": "",
"text_field_5_value": "",
"number_field_1_value": 0,
"number_field_2_value": 0,
"number_field_3_value": 0,
"number_field_4_value": 0,
"number_field_5_value": 0,
"date_field_1_value": "",
"date_field_2_value": "",
"date_field_3_value": "",
"date_field_4_value": "",
"date_field_5_value": ""
}
]
}