Get Style by Style Number
GET /api_user/style/details |
Request
Method:
GET |
URL:
/api_user/style/details |
Data:
style_number： T11877 |
Response
Data:
_status_ : response status number, 1=success 2=failure _result_code_: response status text, success or error style_data： Style Number: Description: "custom_field[Delivery Date]":"29/12/2021", "custom_field[Estimated Qty]":"123", "custom_field[Apparel Type]":"Jeans", "custom_field[Apparel Unique Feat]":"Zip Front;Fully Lined", ... |
Example: See attached image.
Search Style by Keywords
GET /api_user/style/search |
Request
Method:
GET |
URL:
/api_user/style/search |
Data:
search_content： search keywords, e.g. 'abc' page： pagination, e.g. 2 or 5 |
Response
Data:
_status_ : response status number, 1=success 2=failure _result_code_： response status text, success or error pagination_data： current_page: current page page_count: total number of pages total_count: total number of records styles: search matched styles Style Number: Description: … |
Example: See attached image.
Create Style
POST /api_user/style/create |
Request
Method:
POST |
URL:
/api_user/style/create |
Data: (full example, JSON format)
{ "data":{ "style_number":"STYLE_002", "brand_code":"TEST_1", "category_code":"TEST_2", "collection_code":"TEST_3", "sub_category_code":"TEST_4", "sub_type_code":"TEST_5", "story_code":"TEST_6", "gender_code":"TEST_10", "season":"SEASON TEST_7", "description":"aaccdd", "type_code":"TEST_8", "size_scale_code":"SIZE SCALE TEST_9" } } |
Key points:
style_number: required
search are based on 'code'
other field requirement is based on 'Site Settings > Application Settings > Style > Mandatory fields (optional)' settings, for example: type, description will be required if they have been set as required fields on admin
Signature example:
See image 2
Request example1:
See image 3
Request example2
See Image [7] attached below
Response
Data:
{ "data": { "_status_": 1, "_result_code_": "Success", "_message_": "Style [STYLE_002] has been successfully created." } } |
Update Style
PUT /api_user/style/{style_number}/update |
Request
Method:
PUT |
URL:
/api_user/style/{style_number}/update |
Data: (full example, JSON format)
{ "data":{ "style_number":"update style 123", "description":"style description 123", "composition":"aaasse", "brand_code":"TEST_1", "category_code":"TEST_2", "collection_code":"TEST_3", "sub_category_code":"TEST_4", "sub_type_code":"TEST_5", "story_code":"TEST_6", "gender_code":"TEST_10", "season":"SEASON TEST_7", "type_code":"TEST_8", "size_scale_code":"SIZE SCALE TEST_9", "design_number":"ssd", "cost_center":"TEST_11", "tariff_code":"TEST_12", "license_code":"TEST_13", "style_status":"Approved" , "custom_field[Delivery Date]":"29/12/2021", "custom_field[Estimated Qty]":"123", "custom_field[Apparel Type]":"Jeans", "custom_field[Apparel Unique Feat]":"Zip Front;Fully Lined", } } |
Key points:
the style number on URL is the target style number
the style number on request body is the pending update value
all fields are optional
if key is not set = no update
if key is set, value is empty string = update value to empty string
if key is set, value is non-empty string = update value to non-empty string
Signature example:
See image 1
Request example1:
See image 2
Request example2:
See image 3
Response
Data:
{ "data": { "_status_": 1, "_result_code_": "Success", "_message_": "Style [STYLE_002] updated successfully." } } |
Delete Style
DELETE /api_user/style/{style_number}/delete |
Request
Method:
DELETE |
URL:
/api_user/style/{style_number}/delete |
Data (null)
Signature example:
See image 1
Request example1:
See image 2
Request example2:
See image 3
Response
Data:
{ "data": { "_status_": 1, "_result_code_": "Success", "_message_": "Style [STYLE_002] deleted successfully." } } |