list_completed_or_cancelled_orders
GET /list_completed_and_cancelled_orders
To get the TOTAL COUNT of completed and cancelled orders 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_completed_and_cancelled_orders?token=XXXXX&from_date=2016-09-01&to_date=2016-10-01
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| from_date |
datetime |
| to_date |
datetime |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_completed_and_cancelled_orders": 1
}
GET /list_completed_and_cancelled_orders
To get a list of completed and cancelled orders with details.
/list_completed_and_cancelled_orders?token=XXXXX&from_date=2016-09-01&to_date=2016-10-01&page_number=1&page_size=10
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| from_date |
datetime |
| to_date |
datetime |
| page_number |
The page number in the entire list. eg Page 1 |
| page_size |
The number of orders to return. eg 10 orders |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"list_completed_and_cancelled_orders": [
{
"order": {
"order_header": {
"shopping_cart_code": "CART1088",
"order_date_local": "2016-02-25 10:00:00",
"order_date_utc0": "2016-09-01 13:45:29",
"order_date_deliverby_utc0": "2016-03-25 08:00:00",
"customer_code_365": "00100001",
"customer_email": "jdoe@test.com",
"customer_name": "John Doe",
"total_sub": 42.02,
"total_discount": 2.52,
"total_vat": 7.5,
"total_grand": 47,
"comments": "special instructions",
"delivery_address_line_1": "39 Larnakos Ave",
"delivery_address_line_2": "",
"delivery_address_line_3": "Pallouriotissa",
"delivery_postal_code": "1641",
"delivery_town": "Nicosia",
"delivery_country_code_iso2": "CY",
"delivery_country_name": "CYPRUS",
"payment_term_code_365": "",
"delivery_term_code_365": "",
"order_status_code_365": "COMPLETED",
"order_status_name": "COMPLETED"
},
"list_order_details": [
{
"line_number": 1,
"item_code_365": "ARTICLE01-AZURE-240",
"item_name": "ARTICLE 01",
"line_quantity_ordered": 3,
"line_quantity_returned": 0,
"line_quantity_sold": 3,
"line_quantity_extra_sold": 0,
"line_total_sub": 25.21,
"line_total_discount": 2.52,
"line_total_discount_percentage": 10,
"line_total_vat": 4.31,
"line_total_vat_percentage": 19,
"line_total_grand": 27
},
{
"line_number": 2,
"item_code_365": "ARTICLE01-BLK-290",
"item_name": "ARTICLE 01",
"line_quantity_ordered": 1,
"line_quantity_returned": 0,
"line_quantity_sold": 1,
"line_quantity_extra_sold": 0,
"line_total_sub": 16.81,
"line_total_discount": 0,
"line_total_discount_percentage": 0,
"line_total_vat": 3.19,
"line_total_vat_percentage": 19,
"line_total_grand": 20
}
],
"list_order_payments": [
{
"payment_code_365": "00100063",
"payment_type_code_365": "JCC",
"payment_amount": 47,
"payment_date_local": "2016-02-25 10:00:00",
"payment_description": "",
"payment_comments": "",
"payment_cheque_date": ""
}
]
}
}
]
}