HomeGuidesAPI ReferenceRelease Notes
Log In
API Reference

ADM-OPERATION-551 - Get variants associated with an Operation

get
https://example.com/v1/operations//lines

Returns the list of variants associated with a given Operation.


Feature flag

  • Requires OPERATIONS to be active.

Access control

  • OPERATOR clients can access any Operation.
  • ACCOUNT clients can only access Operations they own (ownerId = customerUserId), and only if the OPERATIONS_READ permission is granted and they belong to the effective store (header dj-store if provided, otherwise tenant default store).

Filters

  • Supported filters: variantIds, variantName, minQuantity, maxQuantity, recommendedQuantity.
  • Filters are combined with logical AND. Multiple values of the same filter use OR logic.
  • Unknown values are ignored.

Sorting

  • Default sorting is by variantId|asc.
  • Multiple sort criteria are supported among variantId, variantName, minQuantity, maxQuantity, and recommendedQuantity.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the Operation

Query Params
int32
int32
sort
array of strings

Format: property:direction (recommended) or property,direction (kept for backward compatibility).

sort
variantIds
array of strings

Filter by a list of external variant IDs.

  • Only external IDs are supported.
  • Unknown values are ignored.
  • If empty, all variants are returned (subject to other filters).
variantIds
string

Filter by variant name (case-insensitive, partial or exact match).
Example: "Shirt" will match "T-shirt".

int32

Filter variants where minQuantity equals this value

int32

Filter variants where maxQuantity equals this value

int32

Filter variants where recommendedQuantity equals this value

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
string
enum
required

Specifies the client type making the request.

  • OPERATOR: Platform operator user.

  • ACCOUNT: Customer account user.

  • SUPPLIER: Supplier managing orders.

Allowed:
string
required

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

string

(Optional) Store ID in multi-store environments.

string

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

Responses

400

Invalid query parameter format.

401

Unauthorized. Missing or invalid authentication token.

403

Forbidden. One of the following applies:

  • Access denied: only OPERATOR or ACCOUNT clients are allowed.
  • Operation feature is disabled.
  • Permission denied: caller lacks OPERATIONS_READ or store membership.
404

Operation not found.

500

Unexpected server error.

Updated 10 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 10 months ago

Did this page help you?