Get Order by Order Number
GET /api_user/order/details |
Request
Method:
GET |
URL:
/api_user/order/details |
Data:
order_number：PO07670 |
Response
_status_ : response status number, 1=success 2=failure _result_code_: response status text, success or error order_data: Order Number: 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 Order by Keywords
GET /api_user/order/search |
Request
Method:
GET |
URL:
/api_user/order/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 orders: search matched orders order number: style number: description: ... |
Create Order
POST /api_user/order/create |
Request
Method:
POST |
URL:
/api_user/order/create |
Key points:
All fields are required (except origin_code, warehouse, destination_code)
Search are based on 'code'
Other field requirements is based on 'Site Settings > Application Settings > Order > Mandatory fields (optional)' settings, for example: origin, warehouse will be required if they have been set as required fields on admin
Response
Data:
{ "data": { "_status_": 1, "_result_code_": "Success", "_message_": "Order [ORDER_004] has been successfully created." } } |
Update Order
PUT /api_user/order/{order_number}/update |
Request
Method:
PUT |
URL:
/api_user/order/{order_number}/update |
Data (full example, JSON format)
{ "data":{ "order_number":"ORDER_005", "order_type":"Production", "agent_code":"TEST_001", "factory_code":"TEST_2", "terms_code":"TEST_3", "customer_code":"TEST_1", "gwp":"TEST TEST TEST 1", "customer_ref_no":"TEST TEST TEST 2", "licensed_sub_no":"TEST TEST TEST 3", "vessel":"TEST TEST TEST 4", "destination_code":"TEST_4", "warehouse":"TEST_6", "origin_code":"TEST_5", "in_store_date":"14/03/2021", "start_date":"14/04/2021", "etd_date":"14/05/2021", "eta_date":"14/06/2021", "stopped_date":"14/07/2021", "advertised_date":"14/08/2021", "order_status":"In Production", "freight_status_code":"TEST_7", "shipping_method_code":"TEST_8", "department_code":"TEST_9", "buyer_code":"TEST_10", "season":"TEST_11", "story_code":"TEST_12", "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 order number on URL is the target order number
the order 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
search are based on 'code'
Signature example:
See image 1
Request example1:
See image 2
Request example2:
See image 3
Response
Data:
{ "data": { "_status_": 1, "_result_code_": "Success", "_message_": "Order [ORDER_002] updated successfully." } } |
Delete Order
DELETE /api_user/order/{order_number}/delete |
Request
Method:
DELETE |
URL:
/api_user/order/{order_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_": "Order [ORDER_002] deleted successfully." } } |