How can I filter my GET calls?

There are many parameters you can use to filter your GET calls to the ItemPath API. This guide will show you how to use operators and format your calls to get the results you want.

All arguments that can be added to a GET call are listed in the API documentation.

Arguments are added to the end of the URL, after a question mark (?). Multiple arguments are separated by an ampersand (&).

This is especially straightforward if using the ItemPath API Postman collection, as you can simply add arguments to the URL in the "Params" tab.

Comparison Operators

You can also use these operators in your arguments to refine your response results even further:

• "Not" operator: [not]
  Example: /transactions?motiveType=[not]5
• "Or" operator (for including multiple values): [or]
  Example: /transactions?type=[or]2;4
• "Nor" operator (for excluding multiple values): [nor]
  Example: /transactions?motiveType=[nor]5;6
• "Greater Than" operator: [gt]
  Example: /transactions?creationDate=[gt]yesterday
• "Less Than" operator: [lt]
  Example: /materials?netQuantity=[lt]0
• "Like" search operator: [like]
  Example: /materials?Info1=[like]valve
• "Not Like" search operator: [notlike]
  Example: /materials?Info1=[notlike]test

For a full description and applications of these comparators, see the explanation in the API course.

Formatting

API calls also require particular formatting. Using these formats incorrectly will return errors:

• Array objects

  Example: Adding Material Codes (alternate lookup codes) to a Material.

  { "name": "Example Material", "codes": ["Code1", "Code2"] }

Click here to see the lesson on array formatting.

• Date format

  Example 1: YYYY-MM-DDTHH:mm:ss.SSSSSS format.

  "creationDate": "2021-11-22T19:12:31.910000"

  Example 2: YYYY-MM-DD format.

  "creationDate": "2021-11-22"

  Example 3: other datetime parameters

  "creationDate": "today"

For the full list and examples of acceptable date formats, see the API course lesson.