ADM-OPERATION-550 - Return a paginated list of Operations

get

https://example.com/v1/operations

Lists Operations visible to the caller, applying optional filters and sorting.

Feature flag

Available only when OPERATIONS is ON (otherwise 403).

Access control

dj-client = OPERATOR → sees every Operation (all stores).
dj-client = ACCOUNT → sees Operations where ownerId = callerUserId
and the caller still has right OPERATIONS_READ.

Filters

AND between different filter keys, OR between values of the same key.
Unknown values are ignored.

Sorting
Default is createdAt|desc (newest first).
startDate & endDate default ASC (soonest first).
name defaults ASC (A→Z).

ID Type Handling:
Optional idType query param allows choosing between internal and external identifiers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

size

int32

sort

array of strings

sort

type

string

Visibility type filter; accepts PUBLIC or PRIVATE.

status

string

Operation status filter; accepts DRAFT or ACTIVE or INACTIVE.

ids

array of strings

Filter by a list of operation identifiers

ids

name

string

Case-insensitive substring match on Operation name

startDateFrom

date-time

Return Operations starting on or after this ISO date (inclusive).

startDateTo

date-time

Return Operations starting on or before this ISO date (inclusive).

endDateFrom

date-time

Return Operations ending on or after this ISO date (inclusive).

endDateTo

date-time

Return Operations ending on or before this ISO date (inclusive).

ownerIds

array of strings

Filter by Owner user identifier (Operator only).

ownerIds

idType

string

Defaults to EXTERNAL_ID

Type of operation identifiers provided in the id query parameter.

DJUST_ID: Internal Djust ID
EXTERNAL_ID: External ID provided via external sync

locale

string

Locale to use for localized fields (e.g., name).
The provided locale must belong to the allowed locales of the store bound to the Operation.
If the provided locale is unknown for that store, the store default locale is used (fallback).

Headers

dj-client

string

enum

required

Specifies the client type making the request.

OPERATOR: Platform operator user.
ACCOUNT: Customer account user.
SUPPLIER: Supplier managing orders.

Allowed:

dj-api-key

string

required

API key required for authentication. Must be valid and linked to the requesting user.

dj-store

string

(Optional) Store ID in multi-store environments.

dj-store-view

string

(Optional) Store view ID in multi-store environments.

Responses

401

Authentication required.

403

Caller lacks the required scope.

422

One or more query parameters are invalid.

500

Unexpected server error.

200Paginated list of Operations.