Powersoft 365 API Documentation

list_orders


Changelog

November 24, 2024
  • Option to filter the list based on the session date time. New fields for filter object: session_date_from_utc0 and session_date_to_utc0.
October 27, 2025
  • In the detail object added the list of item pictures URL: list_pictures_url

POST /list_orders

To get the TOTAL COUNT of list of orders 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.

To get a list of orders for multiple search criteria.


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 number of orders based on user filter criteria. 'N' = brings the list of the orders 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
orders_type string The type of the order. There are accepted the folowing values: all - for all orders, completed - for completed orders, cancelled - for cancelled orders and partialcompleted - for all orders completed partial
orders_365_number_selection string A comma separated list of 365 sales orders numbers (eg '00100001,00100002...'). If the value is empty then no search criteria by orders 365 number is applied.
orders_customer_selection string A comma separated list of 365 customer codes (eg '00100001,00100002...'). If the value is empty then no search criteria by customer order is applied.
orders_status_selection string A comma separated list of 365 orders status codes (eg 'APPROVED,INPROC,...'). If the value is empty then no search criteria by orders status is applied.
orders_payment_term_selection string A comma separated list of 365 orders payments terms codes (eg '30DAYS,45DAYS,...'). If the value is empty then no search criteria by orders payments terms is applied.
orders_delivery_term_selection string A comma separated list of 365 orders delivery terms codes (eg '30DAYS,45DAYS,...'). If the value is empty then no search criteria by orders payments terms is applied.
shopping_cart_code_selection string A comma separated list of shopping cart codes (eg 'CART0178, CART0179,...'). If the value is empty then no search criteria by shopping cart is applied.
orders_customer_email_selection string A comma separated list of delivery customers emails (eg 'jdoe@test.com,...'). If the value is empty then no search criteria by customers email is applied.
items_selection string A comma separated list of 365 items codes (eg 'ABC,COKE,1001,...'). If the value is empty then no search criteria by item is applied.
stores_selection string A comma separated list of 365 stores codes (eg '100,001,002,...'). If the value is empty then no search criteria by store is applied.
from_date string From date (order value date). The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date
to_date string To date (order value date). The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date
session_date_from_utc0 string UTC session from date. The date must be provided in format yyyy-mm-dd hh:mm:ss. Pass "" if you don't want selection by session date
session_date_to_utc0 string UTC session to date. The date must be provided in format yyyy-mm-dd hh:mm:ss. Pass "" if you don't want selection by session date
sorting_by string List is ordered by the value provided. Allowed values:"ShoppingCartCode", "Order365Number", "SessionDateTime", "ValueDate", "ValidUntil","DeliveryDate". If the value is not provided or is empty string then the list is ordered by default by order 365 number.
sorting_type string List is ordered ascending or descending by the value provided. Allowed values: "ascending" and "descending". Default value is ascending.
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.
includes_barcodes boolean If includes a list of the line item barcodes.
order_status_allows_transactions_type string Allowed values: "all", "onlyAllowTransactions" and "onlyDoesNotAllowTransactions". It filters the orders based on order status allow transactions flag. Not required. If is not provided or is empty value then all orders are displayed.

Returns

TOTAL COUNT of list of orders for multiple search criteria (only_counted='Y').

List of orders for multiple search criteria (only_counted='N').