Get Order Processes

Queries and retrieves order processes matching the specified criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The order process query filters and pagination settings.

string | null

Gets or sets a comma-separated list of process IDs to filter by.

string | null

Gets or sets a comma-separated list of order IDs to filter processes by.

string | null

Gets or sets the supplier ID to filter processes by.

string | null

Gets or sets a comma-separated list of order reference numbers to filter by.

string | null

Gets or sets a comma-separated list of process state values to filter by.

string | null

Gets or sets the start date for process date range filtering.

string | null

Gets or sets the end date for process date range filtering.

includeProcessIds
array of strings | null

Gets or sets a list of process IDs to explicitly include in results.

includeProcessIds
excludeProcessIds
array of strings | null

Gets or sets a list of process IDs to exclude from results.

excludeProcessIds
codes
array of strings | null

Gets or sets a list of process codes to filter by (exact match).

codes
codePrefixes
array of strings | null

Gets or sets a list of process code prefixes to filter by.

codePrefixes
includeCodes
array of strings | null

Gets or sets a list of process codes to explicitly include.

includeCodes
excludeCodes
array of strings | null

Gets or sets a list of process codes to exclude from results.

excludeCodes
includeRefNumbers
array of strings | null

Gets or sets a list of reference numbers to explicitly include.

includeRefNumbers
exludeRefNumbers
array of strings | null

Gets or sets a list of reference numbers to exclude from results.

exludeRefNumbers
includeOrderIds
array of strings | null

Gets or sets a list of order IDs to explicitly include.

includeOrderIds
excludeOrderIds
array of strings | null

Gets or sets a list of order IDs to exclude from results.

excludeOrderIds
types
array of objects | null

Gets or sets a list of order process types to filter by.

types
Allowed:
string
^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Gets or sets the minimum process amount for filtering.

string
^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Gets or sets the maximum process amount for filtering.

properties
array of objects | null

Gets or sets a list of process properties to filter by.

properties
tags
array of objects | null

Gets or sets a list of process tags to filter by.

tags
string | null

Gets or sets the environment identifier (e.g., Production, Staging).

string | null

Gets or sets the IP address of the calling application.

string | null

Gets or sets the user token for authentication context.

string | null

Gets or sets the session identifier of the current user session.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the numeric user identifier.

string | null

Gets or sets the IP address of the requesting user.

string | null

Gets or sets the envelope parameter for response shaping.

string | null

Gets or sets the thread identifier for request tracing and correlation.

includes
array of strings | null

Gets or sets the list of related entities to include in the response (e.g., Lines, Properties, Tags).

includes
string | null

Gets or sets the search keyword used for full-text or partial matching.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the page index for pagination (1-based).

string
^-?(?:0|[1-9]\d*)$

Gets or sets the number of records per page for pagination.

string | null

Gets or sets the sorting expression (e.g., "Created desc", "Name asc").

status
array of objects | null

Gets or sets the list of entity statuses to filter by.

status
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json