list_pending_orders_header
Changelog
March 04, 2026
- The property order_estimated_arrival_date has been added to the header object in the response
|
GET /list_pending_orders_header
To get the TOTAL COUNT of pending 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_pending_orders_header?token=XXXXX&display_all=true
| field |
type |
description |
| token |
string |
Credentials provided by Powersoft that allow access to the API |
| display_all |
boolean |
If the value is false the list contains only the orders with shopping cart code provided, otherwise all orders will be listed. Default value is false. Not required parameter. |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_pending_orders": 2
}
GET /list_pending_orders_header
To get a list of pending orders without details, only the header.
/list_pending_orders_header?token=XXXXX&page_number=1&page_size=10&display_all=true
| field |
type |
description |
| token |
string |
Credentials provided by Powersoft that allow access to the API |
| 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 |
| display_all |
boolean |
If the value is false the list contains only the orders with shopping cart code provided, otherwise all orders will be listed. Default value is false. Not required parameter. |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"list_pending_orders": [
{
"shopping_cart_code": "CART123",
"order_date_local": "2014-12-17 10:00:00",
"order_date_utc0": "2014-12-17 08:00:00",
"order_date_deliverby_utc0": "2014-12-24",
"customer_code_365": "00100001",
"customer_email": "jdoe@test.com",
"customer_name": "John Doe",
"total_sub": 25.21,
"total_discount": 0,
"total_vat": 4.79,
"total_grand": 30,
"comments": "special instructions",
"delivery_address_line_1": "10 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": "APPROVED",
"order_status_name": "Approved"
},
{
"shopping_cart_code": "CART123",
"order_date_local": "2014-12-17 10:00:00",
"order_date_utc0": "2014-12-17 08:00:00",
"order_date_deliverby_utc0": "2014-12-24",
"customer_code_365": "00100001",
"customer_email": "jdoe@test.com",
"customer_name": "John Doe",
"total_sub": 25.21,
"total_discount": 2.52,
"total_vat": 4.31,
"total_grand": 27,
"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": "APPROVED",
"order_status_name": "Approved"
}
]
}