Powersoft 365 API Documentation

search_order_nested_filters


POST /search_order_nested_filters

The call can be used for complex search in fields using the logical operator provided by the user.

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

Example to get total orders for the customer code provided and the shopping cart code in a list.

SQL: CustomerCode = N'10000008' And (ShoppingCartCode = N'CART08012018001' OR ShoppingCartCode=N'CART08012018002' OR ShoppingCartCode=N'CART10012018010')

Example to get total pending orders with ValueDate Between #2025-01-01# AND #2025-03-17#


To get a list of orders for the search criteria.

Example to get all the orders for the customer code provided and the shopping cart code in a list.

SQL: CustomerCode = N'10000008' And (ShoppingCartCode = N'CART08012018001' OR ShoppingCartCode=N'CART08012018002' OR ShoppingCartCode=N'CART10012018010')

Example to get list of all pending orders with ValueDate Between #2025-01-01# AND #2025-03-17#


field type description
api_credentials
token string Credentials provided by Powersoft that allow access to the API
search_options
only_counted string 'Y' = brings only the total of orders found based on user search criteria. 'N' = brings the list of the orders found based on user search criteria
order_type string 'pending' = Search only in the pending orders. 'completed' = Search only in the completed items. 'cancelled'= search only in cancelled orders. 'partialcompleted'= search only in partial completed orders. 'all' = search in all orders
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
filters
field_name string The field name the search criteria is applied. Required. Allowed values are:
  • OrderNumber - 365 order number.
  • ShoppingCartCode - order number provided by the 3rd party software.
  • StoreCode - 365 store code.
  • StationCode - 365 station code.
  • CustomerCode - 365 order customer code.
  • CustomerName - order customer name.
  • CustomerShortName - order customer short name.
  • CustomerTel1 - order customer telephone mumber 1.
  • CustomerTel2 - order customer telephone mumber 2.
  • CustomerMobile - order customer mobile number.
  • CustomerFax - order customer fax.
  • CustomerEmail - order customer email.
  • CustomerWebsite - order customer web site.
  • CustomerAdress1 - order customer address 1.
  • CustomerAdress2 - order customer address 2.
  • CustomerAdress3 - order customer address 3.
  • CustomerPostalCode - order customer postal code.
  • CustomerTown - order customer town.
  • CustomerCountryISO - order customer country ISO2 code.
  • AgentCode - order agent code.
  • AgentFirstName - order agent first name.
  • AgentLastName - order agent last name.
  • UserCode - order user code.
  • PaymentTermCode - 365 payment term code.
  • DeliveryTermCode - 365 delivery term code.
  • DeliveryCustomerName - order delivery customer name.
  • DeliveryCustomerEmail - order delivery customer email.
  • DeliveryCustomerAddress1 - order delivery customer address line 1.
  • DeliveryCustomerAddress2 - order delivery customer address line 2.
  • DeliveryCustomerAddress3 - order delivery customer address line 3.
  • DeliveryCustomerPostalCode - order delivery customer postal code.
  • DeliveryCustomerTown - order delivery customer town.
  • DeliveryCountryCodeISO2 - order delivery country ISO2.
  • StatusCode - pending order status code.
  • TotalAmount - order amount before discount and VAT.
  • VatAmount - order VAT amount.
  • TotalDiscountAmount - order total discount amount including additional at the end of the order.
  • AdditionalDiscountPercentage - order additional discount percentage at the end of the order.
  • AdditionalDiscountAmount - order additional discount amount at the end of the order.
  • DepositAmount - order additional deposit amount.
  • ValueDate - order value date.
  • ValidUntilDate - order valid until date.
  • DeliveryDate - order delivery date.
  • SessionDateTime - order session date/time.
  • EUC - order flagged as EUC.
  • Export - order flagged as export.
  • Law11E - order flagged as law 11E.
  • IgnoreVAT - order flagged as ignore VAT.
search_operator string Search operator type. Required. Allowed values are:
  • StartsWith
  • Contains
  • NotContains
  • Equals
  • NotEquals
  • EndsWith
  • IsEmpty
  • IsNotEmpty
  • InList
  • NotInList
  • IsLess
  • IsLessOrEqual
  • IsGreater
  • IsGreaterOrEqual
field_value string Expression searched. Required. Minimum 3 characters needs to be provided for fields type string.
logical_operator string Logical operator for nested filters or combined criteria. Allowed values AND, OR. Required. For the last level of the filters the logical operator even is provided is ignored.
sorting
field_name string The field name the sorting is applied. Optional. If the value is not provided the default sorting is by order number ascending. Allowed values are:
  • OrderNumber - 365 order number.
  • ShoppingCartCode - order number provided by the 3rd party software.
  • StoreCode - 365 store code.
  • CustomerCode - 365 order customer code.
  • CustomerName - order customer name.
  • StatusCode - pending order status code.
  • TotalAmount - order amount before discount and VAT.
  • VatAmount - order VAT amount.
  • TotalDiscountAmount - order total discount amount including additional at the end of the order.
  • ValueDate - order value date.
  • ValidUntilDate - order valid until date.
  • DeliveryDate - order delivery date.
  • SessionDateTime - order session date/time.
  • DeliveryCustomerEmail - order delivery customer email.
sorting_direction string The direction the sorting is applied. Required. Allowed values are ascending and descending.