ADM-OPERATION-100 - Create a new Operation

post

https://example.com/v1/operations

Creates a new Operation in DRAFT status.

Feature flag

Requires OPERATIONS to be active

Access control

OPERATOR: always allowed
ACCOUNT: allowed only if the caller has OPERATIONS_CREATE and is attached to the effective store (see Store scoping).

Store scoping

If dj-store is provided: this store is used for creation.
If dj-store is omitted: the tenant default store is used as fallback.
ACCOUNT must be attached to the chosen store (provided or default) or the request is rejected with 403.

Constraints

Required fields: names, externalId, type, startDate
type (PUBLIC / PRIVATE) cannot be changed after creation.
names and descriptions must use IETF BCP 47 locales (e.g., en-US, fr-FR) and each provided locale must belong to the store allowed locales; otherwise the request is rejected (400).
startDate must be less than or equal to endDate when endDate is provided.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customFieldValues

array of objects

Array of custom field id and custom field value

customFieldValues

descriptions

object

Optional translated descriptions keyed by IETF BCP 47 locale; each provided locale must be allowed for the store

endDate

date-time

Planned activation end date

externalId

string

required

Unique business code for the Operation

names

object

required

Translated names keyed by IETF BCP 47 locale; each provided locale must be allowed for the store

startDate

date-time

required

Planned activation start date

type

string

required

Visibility type of the Operation

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

400

Invalid request payload.

Missing or invalid fields
Invalid date range (startDate must be ≤ endDate)
Invalid locale (provided locale not allowed for the store)

401

Authentication failed

403

Forbidden.

Unauthorized client value (unexpected dj-client)
Access denied (missing OPERATIONS_CREATE or not attached to the effective store)
Feature flag OPERATIONS is disabled

201Operation successfully created