Powersoft 365 API Documentation

search_item_nested_filters


POST /search_item_nested_filters

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

To get the TOTAL COUNT of list of items 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 items for the active ones and item brand in a list.

SQL: ItemActive = 1 And (BrandCode = N'NIKE' OR BrandCode=N'GUCCI' OR BrandCode =N'LEVIS')


To get a list of items for the search criteria.

Example to get all the items for the active ones and item brand in a list.

SQL: ItemActive = 1 And (BrandCode = N'NIKE' OR BrandCode=N'GUCCI' OR BrandCode =N'LEVIS')


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 items found based on user search criteria. 'N' = brings the list of the items found based on user search 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
display_fields string Comma separated list of the fields to be displayed in the response. If the value is empty or not passed all the fields will be included in the response.
filters
field_name string The field name the search criteria is applied. Required. Allowed values are:
  • ItemCode - 365 item code.
  • ItemName - item name.
  • ItemOtherName - item other name.
  • Cost - item cost.
  • AverageCost - item average cost.
  • WeightedAverageCost - item weighted average cost.
  • Length - item length.
  • Width - item width.
  • Height - item height.
  • Volume - item volume.
  • Weight - item weight.
  • MaximumPurchase - item maximum purchase price allowed.
  • MaximumSaleExclVat - item maximum sale price excluding VAT allowed.
  • Price1Excl - item price 1 excluding VAT.
  • Price1Incl - item price 1 including VAT.
  • Price2Excl - item price 2 excluding VAT.
  • Price2Incl - item price 2 including VAT.
  • Price3Excl - item price 3 excluding VAT.
  • Price3Incl - item price 3 including VAT.
  • Price4Excl - item price 4 excluding VAT.
  • Price4Incl - item price 4 including VAT.
  • Price5Excl - item price 5 excluding VAT.
  • Price5Incl - item price 5 including VAT.
  • Price6Excl - item price 6 excluding VAT.
  • Price6Incl - item price 6 including VAT.
  • Price7Excl - item price 7 excluding VAT.
  • Price7Incl - item price 7 including VAT.
  • Price8Excl - item price 8 excluding VAT.
  • Price8Incl - item price 8 including VAT.
  • Price9Excl - item price 9 excluding VAT.
  • Price9Incl - item price 9 including VAT.
  • Price10Excl - item price 10 excluding VAT.
  • Price10Incl - item price 10 including VAT.
  • MinimumPrice - item minimum price allowed.
  • TotalStockQty - item current stock on hand.
  • TotalPurchaseStockQty - item total purchase quantity ever.
  • LastModifiedDate - item last modified date.
  • QtyReserved - item total quantity reserved.
  • QtyOrdered -item total quantity ordered.
  • VariantCode - item variant code.
  • CreationDate - item creation date UTC.
  • TextVal1 - item extra text field 1.
  • TextVal2 - item extra text field 2.
  • TextVal3 - item extra text field 3.
  • TextVal4 - item extra text field 4.
  • TextVal5 - item extra text field 5.
  • NumVal1 - item extra numeric field 1.
  • NumVal2 - item extra numeric field 2.
  • NumVal3 - item extra numeric field 3.
  • NumVal4 - item extra numeric field 4.
  • NumVal5 - item extra numeric field 5.
  • DateVal1 - item extra date field 1.
  • DateVal2 - item extra date field 2.
  • DateVal3 - item extra date field 3.
  • DateVal4 - item extra date field 4.
  • DateVal5 - item extra date field 5.
  • ImportedCode - item 3rd party code imported.
  • WebSite - item web site memo field.
  • Specifications - item specifications memo field.
  • Other - item other information memo field.
  • ItemActive - item active status.
  • VatRate - item vat rate subunitar value (e.g. 0.19).
  • HasExpirationDate - item expiration date status.
  • HasLotNumber - item lot number status.
  • HasSerialNumber - item serial number status.
  • IsStorable - item storable status.
  • IsEcommerce - item E-commerce status.
  • IsJiniusEcommerce - item Jinius E-commerce status.
  • IsFarfetch - item Farfetch status.
  • IsSquare - item square status.
  • IsCube - item cube status
  • ForceModifier - item force modifier status
  • ItemBarcode - item barcode
  • ItemBrandCode - item brand code
  • ItemCategoryCode - item category code
  • ItemDepartmentCode - item department code
  • ItemSeasonCode - item season code
  • ItemModelCode - item model code
  • ItemColourCode - item colour code
  • ItemSizeCode - item size code
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 creation date descending, item name ascending and item code ascending. Allowed values are:
  • ItemCode - 365 item code.
  • ItemName - item name.
  • ItemOtherName - item other name.
  • Cost - item cost.
  • AverageCost - item average cost.
  • WeightedAverageCost - item weighted average cost.
  • Length - item length.
  • Width - item width.
  • Height - item height.
  • Volume - item volume.
  • Weight - item weight.
  • MaximumPurchase - item maximum purchase price allowed.
  • MaximumSaleExclVat - item maximum sale price excluding VAT allowed.
  • Price1Excl - item price 1 excluding VAT.
  • Price1Incl - item price 1 including VAT.
  • Price2Excl - item price 2 excluding VAT.
  • Price2Incl - item price 2 including VAT.
  • Price3Excl - item price 3 excluding VAT.
  • Price3Incl - item price 3 including VAT.
  • Price4Excl - item price 4 excluding VAT.
  • Price4Incl - item price 4 including VAT.
  • Price5Excl - item price 5 excluding VAT.
  • Price5Incl - item price 5 including VAT.
  • Price6Excl - item price 6 excluding VAT.
  • Price6Incl - item price 6 including VAT.
  • Price7Excl - item price 7 excluding VAT.
  • Price7Incl - item price 7 including VAT.
  • Price8Excl - item price 8 excluding VAT.
  • Price8Incl - item price 8 including VAT.
  • Price9Excl - item price 9 excluding VAT.
  • Price9Incl - item price 9 including VAT.
  • Price10Excl - item price 10 excluding VAT.
  • Price10Incl - item price 10 including VAT.
  • MinimumPrice - item minimum price allowed.
  • TotalStockQty - item current stock on hand.
  • TotalPurchaseStockQty - item total purchase quantity ever.
  • LastModifiedDate - item last modified date.
  • QtyReserved - item total quantity reserved.
  • QtyOrdered -item total quantity ordered.
  • VariantCode - item variant code.
  • CreationDate - item creation date UTC.
  • TextVal1 - item extra text field 1.
  • TextVal2 - item extra text field 2.
  • TextVal3 - item extra text field 3.
  • TextVal4 - item extra text field 4.
  • TextVal5 - item extra text field 5.
  • NumVal1 - item extra numeric field 1.
  • NumVal2 - item extra numeric field 2.
  • NumVal3 - item extra numeric field 3.
  • NumVal4 - item extra numeric field 4.
  • NumVal5 - item extra numeric field 5.
  • DateVal1 - item extra date field 1.
  • DateVal2 - item extra date field 2.
  • DateVal3 - item extra date field 3.
  • DateVal4 - item extra date field 4.
  • DateVal5 - item extra date field 5.
  • ImportedCode - item 3rd party code imported.
  • VatRate - item vat rate subunitar value (e.g. 0.19).
  • ItemBrandCode - item brand code
  • ItemCategoryCode - item category code
  • ItemDepartmentCode - item department code
  • ItemSeasonCode - item season code
  • ItemModelCode - item model code
  • ItemColourCode - item colour code
  • ItemSizeCode - item size code
sorting_direction string The direction the sorting is applied. Required. Allowed values are ascending and descending.

Example to get all active items flagged as ECommerce belong to categories 'WIRELESS','FRIDGE' and 'SHELF' and Item Name or Item Code or Item Barcode contains string 'HHT' .

SQL: ItemActive = 1 And Ecommerce=1 and ItemCategoryCode IN ('WIRELESS','FRIDGE','SHELF') and (ItemName like '%HHT%' or ItemCode like '%HHT%' or ItemBarcode Like '%HHT%')