logo
API docs by Redocly

Ibexa DXP REST API (6.0.0)

Download OpenAPI specification:Download as YAMLDownload as JSON

Section

Get Sections

Returns a list of all Sections.

header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "SectionList": {
    }
}

Create new Section

Creates a new Section.

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The Section input schema encoded in XML or JSON format.

required
object (SectionInput)

Responses

Request samples

Content type
{
  • "SectionInput": {
    }
}

Response samples

Content type
{
  • "Section": {
    }
}

Get Section

Returns the Section by given Section ID.

path Parameters
sectionId
required
string
header Parameters
If-None-match
string

ETag

Responses

Response samples

Content type
{
  • "Section": {
    }
}

Delete Section

The given Section is deleted.

path Parameters
sectionId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update a Section

Updates a Section. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
sectionId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-Match
required
string

ETag

Request Body schema:
optional

The Section input schema encoded in XML or JSON.

required
object (SectionInput)

Responses

Request samples

Content type
{
  • "SectionInput": {
    }
}

Response samples

Content type
{
  • "Section": {
    }
}

Objects

Load content by remote ID

Loads content item for a given remote ID.

query Parameters
remoteId
required
string

Remote ID of the content item.

Responses

Create content item

Creates a draft assigned to the authenticated user. If a different user ID is given in the input, the draft is assigned to the given user but this action requires special permissions for the authenticated user (this is useful for content staging where the transfer process does not have to authenticate with the user who created the content item in the source server). The user needs to publish the content item if it should be visible.

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The ContentCreate schema encoded in XML or JSON format.

required
object (ContentCreate)

This class is used for creating a new content item.

Responses

Request samples

Content type
{
  • "ContentCreate": {
    }
}

Response samples

Content type
{
  • "Content": {
    }
}

Load content

Loads the content item for the given ID. Depending on the Accept header the current version is embedded (i.e. the current published version or if it does not exist, the draft of the authenticated user).

  • Content - If set, all information for the content item including the embedded current version is returned in XML or JSON format.
  • ContentInfo - If set, all information for the content item (excluding the current version) is returned in XML or JSON format.
path Parameters
contentId
required
integer
header Parameters
If-None-Match
string

If the provided ETag matches the current ETag then a "304 Not Modified" is returned. The ETag changes if the meta data has changed, this happens also if there is a new published version.

Responses

Response samples

Content type
{
  • "Content": {
    }
}

Delete Content

Deletes content item. If content item has multiple Locations, all of them will be deleted via delete a subtree.

path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update content

This method updates the content metadata which is independent from a version. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-match
required
string

Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned.

Request Body schema:
optional

The ContentUpdate schema encoded in XML or JSON format.

required
object (ContentInfo)

This class provides all version independent information of the content item.

Responses

Request samples

Content type
{
  • "ContentInfo": {
    }
}

Response samples

Content type
{
  • "ContentInfo": {
    }
}

Get current version

Redirects to the current version of the content item.

path Parameters
contentId
required
string

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Create a draft from current version

The system creates a new draft as a copy of the current version. COPY or POST with header X-HTTP-Method-Override COPY.

path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Hide content item

Makes or keep the content item invisible

path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Get Locations for content item

Loads all Locations for the given content item.

path Parameters
contentId
required
string
header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "LocationList": {
    }
}

Create new Location for content item

Creates a new Location for the given content item.

path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The LocationCreate schema encoded in XML or JSON format.

required
object (LocationCreate)

Responses

Request samples

Content type
{
  • "LocationCreate": {
    }
}

Response samples

Content type
{
  • "Location": {
    }
}

Get Object states of content item

Returns the Object states of a content item

path Parameters
contentId
required
string
header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "ContentObjectStates": {
    }
}

Set Object states of content item

Updates Object states of a content item. An Object state in the input overrides the state of the Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-Match
required
string

ETag

Request Body schema:
optional

The content item Object states input schema encoded in XML or JSON format.

required
object (ContentObjectStates)

Represents a list of object states.

Responses

Request samples

Content type
{
  • "ContentObjectStates": {
    }
}

Response samples

Content type
{
  • "ContentObjectStates": {
    }
}

Load Relations of content item

Redirects to the Relations of the current version.

path Parameters
contentId
required
string

Responses

Reveal content item

Makes or keep the content item visible

path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Delete translation (permanently)

Permanently deletes a translation from all versions of a content item.

path Parameters
contentId
required
string
languageCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

List versions

Returns a list of all versions of the content item. This method does not include fields and relations in the version elements of the response.

path Parameters
contentId
required
string

Responses

Response samples

Content type
{
  • "VersionList": {
    }
}

Load version

Loads a specific version of a content item. This method returns Fields and relations.

path Parameters
contentId
required
string
versionNo
required
string
header Parameters
If-None-Match
string

Only return the version if the given ETag is the not current one, otherwise a 304 is returned.

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Create a draft from a version

The system creates a new draft as a copy of the given version. COPY or POST with header X-HTTP-Method-Override COPY.

path Parameters
contentId
required
string
versionNo
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Delete content version

Deletes the content version.

path Parameters
contentId
required
string
versionNo
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update version

A specific draft is updated. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
contentId
required
string
versionNo
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-match
required
string

Performs the patch only if the specified ETag is the current one.

Request Body schema:
optional

The VersionUpdate schema encoded in XML or JSON format.

required
object (VersionUpdate)

This class is used to update a content version.

Responses

Request samples

Content type
{
  • "VersionUpdate": {
    }
}

Response samples

Content type
{
  • "Version": {
    }
}

Load Relations of content item version

Loads the Relations of the given version.

path Parameters
contentId
required
string
versionNo
required
string

Responses

Response samples

Content type
{
  • "Relations": {
    }
}

Create new Relation

Creates a new Relation of type COMMON for the given draft.

path Parameters
contentId
required
string
versionNo
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The RelationCreate schema encoded in XML or JSON format.

required
object (RelationCreate)

Responses

Request samples

Content type
{
  • "RelationCreate": {
    }
}

Response samples

Content type
{
  • "Relation": {
    }
}

Load Relation

Loads a Relation for the given content item.

path Parameters
contentId
required
string
versionNo
required
string
relationId
required
string

Responses

Response samples

Content type
{
  • "Relation": {
    }
}

Delete Relation

Deletes a Relation of the given draft.

path Parameters
contentId
required
string
versionNo
required
string
relationId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Delete translation from version draft

Removes a translation from a version draft.

path Parameters
contentId
required
string
versionNo
required
string
languageCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Type Groups

Get content type groups

Returns a list of all content type groups. If an identifier is provided, loads the content type group for this identifier.

Responses

Response samples

Content type
{
  • "ContentTypeGroupList": {
    }
}

Create content type group

Creates a new content type group.

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The content type group input schema encoded in XML or JSON.

ContentTypeGroupInput
required
object (ContentTypeGroupInput)

Responses

Request samples

Content type
{
  • "ContentTypeGroupInput": {
    }
}

Response samples

Content type
{
  • "ContentTypeGroup": {
    }
}

Get content type group

Returns the content type group with provided ID.

path Parameters
contentTypeGroupId
required
string
header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Delete content type group

Deletes the provided content type group.

path Parameters
contentTypeGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update content type group

Updates a content type group. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
contentTypeGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-Match
required
string

ETag causes patching only if the specified ETag is the current one. Otherwise a 412 is returned.

Request Body schema:
optional

The content type group input schema encoded in XML or JSON format.

ContentTypeGroupInput
required
object (ContentTypeGroupInput)

Responses

Request samples

Content type
{
  • "ContentTypeGroupInput": {
    }
}

Response samples

Content type
{
  • "ContentTypeGroup": {
    }
}

List content types for group

Returns a list of content types in the provided group.

path Parameters
contentTypeGroupId
required
string

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Create content type

Creates a new content type draft in the given content type group.

path Parameters
contentTypeGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The content type Create schema encoded in XML or JSON format.

required
object (ContentTypeCreate)

This class is used to create a content type.

Responses

Request samples

Content type
{
  • "ContentTypeCreate": {
    }
}

Response samples

Content type
{
  • "ContentType": {
    }
}

Type

List content types

Returns a list of content types.

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Filter content types

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (ContentTypeViewInput)

This class represents a content type view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Get content type

Returns the content type with the provided ID.

path Parameters
contentTypeId
required
string
header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "ContentType": {
    }
}

Create Draft

Creates a draft and updates it with the given data.

path Parameters
contentTypeId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The content type Update schema encoded in XML or JSON format.

required
object (ContentTypeUpdate)

This class is used to update a content type.

Responses

Request samples

Content type
{
  • "ContentTypeUpdate": {
    }
}

Response samples

Content type
{
  • "ContentTypeInfo": {
    }
}

Delete content type

Deletes the provided content type.

path Parameters
contentTypeId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Get content type draft

Returns the draft of the content type with the provided ID.

path Parameters
contentTypeId
required
string

Responses

Response samples

Content type
{
  • "ContentType": {
    }
}

Delete content type draft

Deletes the provided content type draft.

path Parameters
contentTypeId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update content type draft

Updates metadata of a draft. This method does not handle Field definitions. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
contentTypeId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The content type update schema encoded in XML or JSON format.

required
object (ContentTypeUpdate)

This class is used to update a content type.

Responses

Request samples

Content type
{
  • "ContentTypeUpdate": {
    }
}

Response samples

Content type
{
  • "ContentTypeInfo": {
    }
}

Get Draft Field definition list

Returns all Field definitions of the provided content type Draft.

path Parameters
contentTypeId
required
string

Responses

Response samples

Content type
{
  • "FieldDefinitions": {
    }
}

Add content type Draft Field definition

Creates a new Field definition for the given content type.

path Parameters
contentTypeId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The Field Definition Create schema encoded in XML or JSON format.

required
object (FieldDefinitionCreate)

Responses

Request samples

Content type
{
  • "FieldDefinitionCreate": {
    }
}

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get content type Draft Field definition

Returns the Field definition by the given ID.

path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string

Responses

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Delete content type Draft Field definition

Deletes the provided Field definition.

path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update content type Draft Field definition

Updates the attributes of a Field definition.

path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The Field definition update schema encoded in XML or JSON format.

required
object (FieldDefinitionUpdate)

Responses

Request samples

Content type
{
  • "FieldDefinitionUpdate": {
    }
}

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get Field definition list

Returns all Field definitions of the provided content type.

path Parameters
contentTypeId
required
string

Responses

Response samples

Content type
{
  • "FieldDefinitions": {
    }
}

Get Field definition

Returns the Field definition by the given ID.

path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string

Responses

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get groups of content type

Returns the content type group to which content type belongs to.

path Parameters
contentTypeId
required
string

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

Link group to content type

Links a content type group to the content type and returns the updated group list.

path Parameters
contentTypeId
required
string
query Parameters
group
required
string

Destination content type group URI; for example with content type group 4: ?group=/api/ibexa/v2/content/typegroups/4

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

Unlink group from content type

Removes the given group from the content type and returns the updated group list.

path Parameters
contentTypeId
required
string
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

User

Load current User

Loads the current user.

header Parameters
Accept
required
string

If set, the User is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

List Users

Load Users either for a given remote ID or Role.

header Parameters
Accept
required
string

UserList - If set, the User list is returned in XML or JSON format. UserRefList - If set, the link list of Users is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

Verify Users

Verifies if there are Users matching given filter.

Responses

Load User

Loads User with the given ID.

path Parameters
userId
required
string
header Parameters
Accept
required
string

If set, the User is returned in XML or JSON format.

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

Delete User

Deletes the given User.

path Parameters
userId
required
string

Responses

Update User

Updates a User.

path Parameters
userId
required
string
header Parameters
Accept
required
string

If set, the updated User is returned in XML or JSON format.

Content-Type
required
string

The UserUpdate schema encoded in XML or JSON format.

If-Match
required
string

Performs a PATCH only if the specified ETag is the current one.

Request Body schema:
optional

The updated UserUpdateController resource

required
object (UserUpdate)

This class is used to update a User.

Responses

Request samples

Content type
{
  • "UserUpdate": {
    }
}

Response samples

Content type
{
  • "User": {
    }
}

Load user drafts

Loads user's drafts

path Parameters
userId
required
string
header Parameters
Accept
required
string

If set, the version list is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "VersionList": {
    }
}

Load Groups of User

Returns a list of User Groups the User belongs to. The returned list includes the resources for unassigning a User Group if the User is in multiple groups.

path Parameters
userId
required
string
header Parameters
Accept
required
string

If set, the link list of User Groups is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Assign User Group

Assigns the User to a User Group.

path Parameters
userId
required
string
header Parameters
Accept
required
string

If set, the link list of User Groups is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Unassign User Group

Unassigns the User from a User Group.

path Parameters
userId
required
string
groupId
required
string
header Parameters
Accept
required
string

If set, the link list of User Groups is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Load Roles for User

Returns a list of all Roles assigned to the given User.

path Parameters
userId
required
string

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Assign Role to User

Assigns a Role to a user.

path Parameters
userId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The RoleAssignInput schema encoded in XML or JSON format.

required
object (RoleAssignInput)

This class represents a Role assign input.

Responses

Request samples

Content type
{
  • "RoleAssignInput": {
    }
}

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load User Role Assignment

Returns a Role assignment to the given User.

path Parameters
userId
required
string
roleId
required
string

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Unassign Role from User

The given Role is removed from the user.

path Parameters
userId
required
string
roleId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

View user segments

Return user's segment list.

path Parameters
userId
required
string

Responses

Response samples

Content type
{
  • "UserSegmentList": {
    }
}

Assign Segments to User

Assigns Segments from payload to User given by ID.

path Parameters
userId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token. Used for POST, PATCH and DELETE requests.

Request Body schema:
optional

The UserSegmentAssignInput schema encoded in XML or JSON format.

required
object (UserSegmentAssignInput)

Responses

Request samples

Content type
{
  • "UserSegmentAssignInput": {
    }
}

Unassign Segment from User

The Segment designated by its identifier is unassigned from the User given by ID.

path Parameters
userId
required
string
segmentIdentifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token. Used for POST, PATCH and DELETE requests.

Responses

User Group

Load User Groups

Loads User Groups for either an an ID or a remote ID or a Role.

header Parameters
Accept
required
string

UserGroupList - If set, the User Group List is returned in XML or JSON format. UserGroupRefList - If set, the link list of User Group is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "UserGroupList": {
    }
}

Get root User Group

Redirects to the root User Group.

Responses

Create a top level User Group

Creates a top level User Group under the root. To create a child group under a parent group use '/user/groups/{path}/subgroups'.

header Parameters
Accept
required
string

If set, the new User Group is returned in XML or JSON format.

Content-Type
required
string

The UserGroupCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new UserGroupCreateController resource

required
object (UserGroupCreate)

This class is used to create a User Group.

Responses

Request samples

Content type
{
  • "UserGroupCreate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load User Group

Loads User Groups for the given {path}.

path Parameters
path
required
string
header Parameters
Accept
required
string

If set, the new User Group is returned in XML or JSON format.

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "UserGroup": {
    }
}

Delete User Group

The given User Group is deleted.

path Parameters
path
required
string

Responses

Update User Group

Updates a User Group. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
path
required
string
header Parameters
Accept
required
string

If set, the new User Group is returned in XML or JSON format.

Content-Type
required
string

The UserGroupUpdate schema encoded in XML or JSON format.

If-Match
required
string

Performs the PATCH only if the specified ETag is the current one. Otherwise a 412 is returned.

Request Body schema:
optional

The updated UserGroupUpdateController resource

required
object (UserGroupUpdate)

This class is used to update a User group in the Repository.

Responses

Request samples

Content type
{
  • "UserGroupUpdate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load Roles for User Group

Returns a list of all Roles assigned to the given User Group.

path Parameters
path
required
string

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Assign Role to User Group

Assigns a Role to a User Group.

path Parameters
path
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The RoleAssignInput schema encoded in XML or JSON format.

required
object (RoleAssignInput)

This class represents a Role assign input.

Responses

Request samples

Content type
{
  • "RoleAssignInput": {
    }
}

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load User Group Role Assignment

Returns a Role assignment of the given User Group.

path Parameters
path
required
string
roleId
required
string

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Unassign Role from User Group

The given Role is removed from the User or User Group.

path Parameters
path
required
string
roleId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load subgroups

Returns a list of the subgroups.

path Parameters
path
required
string
header Parameters
Accept
required
string

UserGroupList - If set, the User Group list is returned in XML or JSON format. UserGroupRefList - If set, the link list of User Groups is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "UserGroupList": {
    }
}

Create User Group

Creates a new User Group under the given parent. To create a top level group use '/user/groups/subgroups'.

path Parameters
path
required
string
header Parameters
Accept
required
string

If set, the new User Group is returned in XML or JSON format.

Content-Type
required
string

The UserGroupCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new UserGroupCreateController resource

required
object (UserGroupCreate)

This class is used to create a User Group.

Responses

Request samples

Content type
{
  • "UserGroupCreate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load Users of Group

Loads the Users of the Group with the given ID.

path Parameters
path
required
string
header Parameters
Accept
required
string

UserList - If set, the User list returned in XML or JSON format. UserRefList - If set, the link list of Users returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "_media-type": "string",
  • "_href": "string",
  • "User": []
}

Create User

Creates a new User in the given Group.

path Parameters
path
required
string
header Parameters
Accept
required
string

If set, the new User is returned in XML or JSON format.

Content-Type
required
string

The UserCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new UserCreateController resource

required
object (UserCreate)

This class is used to create a User.

Responses

Request samples

Content type
{
  • "UserCreate": {
    }
}

Response samples

Content type
{
  • "User": {
    }
}

User Role

Load Roles

Returns a list of all Roles.

Responses

Response samples

Content type
{
  • "RoleList": {
    }
}

Create Role or Role draft

Creates a new Role or Role draft.

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The RoleInput schema encoded in XML or JSON.

required
object (RoleInput)

This class represents a Role input.

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Role

Loads a Role for the given ID.

path Parameters
id
required
string
header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Create Role Draft

Creates a new Role draft from an existing Role.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Delete Role

The given Role and all assignments to Users or User Groups are deleted.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update Role

Updates a Role. PATCH or POST with header X-HTTP-Method-Override PATCH

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-Match
required
string

ETag Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned.

Request Body schema:
optional

The RoleInput schema encoded in XML or JSON format.

required
object (RoleInput)

This class represents a Role input.

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Role draft

Loads a Role draft by original Role ID.

path Parameters
id
required
string
header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Delete Role draft

The given Role draft is deleted.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update Role draft

Updates a Role draft. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-Match
required
string

Performs a PATCH only if the specified ETag is the current one. Otherwise a 412 is returned.

Request Body schema:
optional

The RoleInput schema encoded in XML or JSON format.

required
object (RoleInput)

This class represents a Role input.

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Policies

Loads Policies for the given Role.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "PolicyList": {
    }
}

Create Policy

Creates a Policy

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

If set, the updated Policy is returned in XML or JSON format.

required
object (PolicyCreate)

This class is used to create a Policy.

Responses

Request samples

Content type
{
  • "PolicyCreate": {
    }
}

Response samples

Content type
{
  • "Policy": {
    }
}

Delete Policies

All Policies of the given Role are deleted.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Load Policy

Loads a Policy for the given module and function.

path Parameters
policyId
required
string
roleId
required
string

RolePolicyLoadByIdController identifier

header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "Policy": {
    }
}

Delete Policy

Deletes given Policy.

path Parameters
policyId
required
string
roleId
required
string

RolePolicyDeleteController identifier

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update Policy

Updates a Policy. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
policyId
required
string
roleId
required
string

RolePolicyUpdateController identifier

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-Match
required
string

Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned.

Request Body schema:
optional

If set, the updated Policy is returned in XML or JSON format.

required
object (PolicyUpdate)

This class is used to update a Policy.

Responses

Request samples

Content type
{
  • "PolicyUpdate": {
    }
}

Response samples

Content type
{
  • "Policy": {
    }
}

User Policy

List Policies for User

Search all Policies which are applied to a given User.

Responses

Response samples

Content type
{
  • "PolicyList": {
    }
}

Language

Language list

Lists languages

Responses

Response samples

Content type
{
  • "LanguageList": {
    }
}

Get language

Retrieves a LanguageLoadByIdController resource.

path Parameters
code
required
string

Responses

Response samples

Content type
{
  • "Language": {
    }
}

Location

Load Locations by id/remoteId/urlAlias

Loads the Location for a given ID (x), remote ID or URL alias.

Responses

Response samples

Content type
{
  • "Location": {
    }
}

Load Location

Loads the Location for the given path e.g. '/content/locations/1/2/61'.

path Parameters
path
required
string
header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "Location": {
    }
}

Delete subtree

Deletes the complete subtree for the given path. Every content item which does not have any other Location is deleted. Otherwise the deleted Location is removed from the content item. The children are recursively deleted.

path Parameters
path
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update Location

Updates the Location. This method can also be used to hide/reveal a Location via the hidden field in the LocationUpdate. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
path
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-Match
required
string

ETag

Request Body schema:
optional

The LocationUpdate schema encoded in XML or JSON format.

required
object (LocationUpdateStruct)

This class is used for updating Location meta data.

Responses

Request samples

Content type
{
  • "LocationUpdate": {
    }
}

Response samples

Content type
{
  • "Location": {
    }
}

Get child Locations.

Loads all child Locations for the given parent Location.

path Parameters
path
required
string

Responses

Response samples

Content type
{
  • "LocationList": {
    }
}

List URL aliases for Location

Returns the list of URL aliases for a Location.

path Parameters
path
required
string

Responses

Response samples

Content type
{
  • "UrlAliasRefList": {
    }
}

Object State Groups

List Object state groups

Returns a list of all Object state groups.

header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "ObjectStateGroupList": {
    }
}

Create Object state group

Creates a new Object state group.

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The Object state group input schema encoded in XML or JSON format.

required
object (ObjectStateGroupCreate)

This class represents a value for creating Object state groups.

Responses

Request samples

Content type
{
  • "ObjectStateGroupCreate": {
    }
}

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

Get Object state group

Returns the Object state group with the provided ID.

path Parameters
objectStateGroupId
required
string
header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

Delete Object state group

Deletes the given Object state group including Object states.

path Parameters
objectStateGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update Object state group

Updates an Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
objectStateGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-Match
required
string

ETag

Request Body schema:
optional

The Object state group input schema encoded in XML or JSON format.

required
object (ObjectStateGroupUpdate)

This class represents a value for updating Object state groups.

Responses

Request samples

Content type
{
  • "ObjectStateGroupUpdate": {
    }
}

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

List Object states

Returns a list of all Object states of the given group.

path Parameters
objectStateGroupId
required
string
header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "ObjectStateList": {
    }
}

Create Object state

Creates a new Object state.

path Parameters
objectStateGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The Object state input schema encoded in XML or JSON format.

required
object (ObjectStateCreate)

This class represents a value for creating Object states.

Responses

Request samples

Content type
{
  • "ObjectStateCreate": {
    }
}

Response samples

Content type
{
  • "ObjectState": {
    }
}

Get Object state

Returns the Object state.

path Parameters
objectStateGroupId
required
string
objectStateId
required
string
header Parameters
If-None-Match
string

ETag

Responses

Response samples

Content type
{
  • "ObjectState": {
    }
}

Delete Object state

Deletes provided Object state.

path Parameters
objectStateGroupId
required
string
objectStateId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Update Object state

Updates an Object state. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
objectStateGroupId
required
string
objectStateId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

If-Match
required
string

ETag

Request Body schema:
optional

The Object state input schema encoded in XML or JSON format.

required
object (ObjectStateUpdate)

This class represents a value for updating Object states.

Responses

Request samples

Content type
{
  • "ObjectStateUpdate": {
    }
}

Response samples

Content type
{
  • "ObjectState": {
    }
}

Trash

List Trash items

Returns a list of all items in the Trash.

Responses

Response samples

Content type
{
  • "Trash": {
    }
}

Empty Trash

Empties the Trash.

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Get Trash item

Returns the item in Trash with the provided ID.

path Parameters
trashItemid
required
string

Responses

Response samples

Content type
{
  • "TrashItem": {
    }
}

Delete Trash item

Deletes the provided item from Trash.

path Parameters
trashItemid
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Url Wildcard

List URL wildcards

Returns a list of URL wildcards.

Responses

Response samples

Content type
{
  • "UrlWildcardList": {
    }
}

Create URL wildcard

Creates a new URL wildcard.

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The URL Wildcard input schema encoded in XML or JSON format.

required
object (UrlWildcardCreate)

Creates a new URL wildcard.

Responses

Request samples

Content type
{
  • "URLWildcardCreate": {
    }
}

Response samples

Content type
{
  • "UrlWildcard": {
    }
}

Get URL wildcard

Returns the URL wildcard with the given ID.

path Parameters
wildcardId
required
string

Responses

Response samples

Content type
{
  • "UrlWildcard": {
    }
}

Delete URL wildcard

Deletes the given URL wildcard.

path Parameters
wildcardId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Url Alias

List global URL aliases

Returns the list of global URL aliases.

Responses

Response samples

Content type
{
  • "UrlAliasRefList": {
    }
}

Create URL alias

Creates a URL alias.

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The URL alias input schema encoded in XML or JSON format.

required
object (UrlAliasCreate)

Responses

Request samples

Content type
{
  • "UrlAliasCreate": {
    }
}

Response samples

Content type
{
  • "UrlAlias": {
    }
}

Get URL alias

Returns the URL alias with the given ID.

path Parameters
urlAliasId
required
string

Responses

Response samples

Content type
{
  • "UrlAlias": {
    }
}

Delete URL alias

Deletes the provided URL alias.

path Parameters
urlAliasId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Views

Controller for Repository Views (Search, mostly).

Search content

Executes a query and returns a View including the results. View input reflects the criteria model of the public PHP API. Refer to Search Criteria Reference

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (ViewInput)

This class represents a View input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.View+xml; version=1.1
<?xml version="1.0" encoding="UTF-8"?>
<View href="/views/TitleView" media-type="application/vnd.ibexa.api.View+xml; version=1.1">
  <identifier>TitleView</identifier>
  <User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/>
  <public>false</public>
  <LocationQuery>
    <Filter>
      <ParentLocationIdCriterion>2</ParentLocationIdCriterion>
    </Filter>
    <limit>10</limit>
    <offset>0</offset>
    <SortClauses>
      <ContentName>ascending</ContentName>
    </SortClauses>
    <FacetBuilders>
      <contentTypeFacetBuilder/>
    </FacetBuilders>
  </LocationQuery>
  <Result href="/content/views/view1234/results"
    media-type="application/vnd.ibexa.api.ViewResult+xml" count="34" time="31" maxScore="1.0">
    <searchHits>
      <searchHit score="1.0" index="installid1234567890">
        <hightlight/>
        <value>
          <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2">
            <id>2</id>
            <priority>0</priority>
            <hidden>false</hidden>
            <invisible>false</invisible>
            <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1"/>
            <pathString>/1/2/</pathString>
            <depth>1</depth>
            <childCount>8</childCount>
            <remoteId>f3e90596361e31d496d4026eb624c983</remoteId>
            <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/children"/>
            <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/>
            <sortField>PRIORITY</sortField>
            <sortOrder>ASC</sortOrder>
            <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/urlaliases"/>
          </Location>

        </value>
      </searchHit>
      <!-- ... -->
    </searchHits>
    <facets>
      <contentTypeFacet>
        <contentTypeFacetEntry>
          <contentType href="/content/types/1"  media-type="application/vnd.ibexa.api.ContentType+xml"/>
          <count>3</count>
        </contentTypeFacetEntry>
        <contentTypeFacetEntry>
          <contentType href="/content/types/7"  media-type="application/vnd.ibexa.api.ContentType+xml"/>
          <count>9</count>
        </contentTypeFacetEntry>
        <contentTypeFacetEntry>
          <contentType href="/content/types/11"  media-type="application/vnd.ibexa.api.ContentType+xml"/>
          <count>1</count>
        </contentTypeFacetEntry>
        <contentTypeFacetEntry>
          <contentType href="/content/types/15"  media-type="application/vnd.ibexa.api.ContentType+xml"/>
          <count>8</count>
        </contentTypeFacetEntry>
      </contentTypeFacet>
    </facets>
  </Result>
</View>

User Session

Create session (login a User)

Performs a login for the user or checks if session exists and returns the session and session cookie. The client will need to remember both session name/ID and CSRF token as this is for security reasons not exposed via GET.

header Parameters
Accept
required
string

If set, the session is returned in XML or JSON format.

Content-Type
required
string

The SessionInput schema encoded in XML or JSON format.

Cookie
required
string

Only needed for session's checking {sessionName}={sessionID}.

X-CSRF-Token
required
string

Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The new SessionCreateController resource

required
object (SessionInput)

This class represents a session input.

Responses

Request samples

Content type
{
  • "SessionInput": {
    }
}

Response samples

Content type
{
  • "Session": {
    }
}

Get current session

Get current user session, if any.

header Parameters
Cookie
required
string

Only needed for session's checking {sessionName}={sessionID}.

Accept
required
string

If set, the session is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "Session": {
    }
}

Delete session (logout a User)

The user session is removed i.e. the user is logged out.

path Parameters
sessionId
required
string
header Parameters
Cookie
required
string

{sessionName}={sessionID}

X-CSRF-Token
required
string

The {csrfToken} needed on all unsafe HTTP methods with session.

Responses

Refresh session (deprecated)

Get the session's User information. Deprecated as of Ibexa DXP 4.6, use GET /user/sessions/current instead.

path Parameters
sessionId
required
string
header Parameters
Cookie
required
string

{sessionName}={sessionID}

X-CSRF-Token
required
string

The {csrfToken} needed on all unsafe HTTP methods with session.

Accept
required
string

Responses

Response samples

Content type
{
  • "Session": {
    }
}

Bookmark

List of bookmarks

Lists bookmarked Locations for the current user.

Responses

Response samples

Content type
{
  • "BookmarkList": {
    }
}

Check if Location is bookmarked

Checks if the given Location is bookmarked by the current user.

path Parameters
locationId
required
integer

Responses

Create bookmark

Add given Location to bookmarks of the current user.

path Parameters
locationId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Delete bookmark

Deletes the given Location from bookmarks of the current user.

path Parameters
locationId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Responses

Check if Location is bookmarked

Checks if the given Location is bookmarked by the current user.

path Parameters
locationId
required
integer

Responses

User Token

Create JWT token

Creates JWT authentication token.

Request Body schema: application/vnd.ibexa.api.JWTInput+json
optional

The credentials in JWTInput JSON format.

required
object (JWTInput)

This class represents the input for a JWT authentication token

Responses

Request samples

Content type
application/vnd.ibexa.api.JWTInput+json
{
  • "JWTInput": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.JWT+json
{
  • "JWT": {
    }
}

Calendar

Calendar list

Calendar event list.

query Parameters
start
required
integer (UnixTimestamp)

timestamp (seconds since the Unix Epoch).

end
required
integer (UnixTimestamp)

timestamp.

count
integer

Maximum number of events returned (10 by default).

types
Array of strings
Example: types=future_publication,future_hide,page_block_reveal,page_block_hide

Comma-separated list of type identifiers.

languages
Array of strings
Example: languages=eng-GB,fre-FR

comma-separated list of language codes.

cursor
string
Example: cursor=MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy

Pagination cursor. It's the representation of the event to start the page afterward, as the concatenation of the timestamp, the event type, and the event identifier with a colon separator ("::"), encoded in base64. For example "1778264040:future_hide:future_hide:2" ("future_hide:2" is the ID) encoded as "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy"

Responses

Response samples

Content type
{
  • "EventList": {
    }
}

Calendar list grouped by day

Calendar event list grouped by day.

query Parameters
start
required
integer (UnixTimestamp)

timestamp (seconds since the Unix Epoch).

end
required
integer (UnixTimestamp)

timestamp.

count
integer

Maximum number of events returned (10 by default).

types
Array of strings
Example: types=future_publication,future_hide,page_block_reveal,page_block_hide

Comma-separated list of type identifiers.

languages
Array of strings
Example: languages=eng-GB,fre-FR

comma-separated list of language codes.

cursor
string
Example: cursor=MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy

Pagination cursor. It's the representation of the event to start the page afterward, as the concatenation of the timestamp, the event type, and the event identifier with a colon separator ("::"), encoded in base64. For example "1778264040:future_hide:future_hide:2" ("future_hide:2" is the ID) encoded as "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy"

Responses

Response samples

Content type
{
  • "EventGroupList": {
    }
}

Calendar action

A calendar action that e.g. reschedules or unschedules calendar events. The event type should always be copied from an event.

path Parameters
eventType
required
string
Enum: "future_publication" "future_hide"

The type of event to execute an action on.

Request Body schema:
required

Data for the calendar action to execute

required
object (RescheduleAction)

This class represents events to reschedule

Responses

Request samples

Content type
{
  • "RescheduleAction": {
    }
}

Product Attribute

Load attributes (deprecated)

Loads list of all attributes. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attributes/view instead.

Request Body schema:
optional

Attribute filter

required
object (AttributeListGet)

This class represents an attribute list query

Responses

Request samples

Content type
{
  • "AttributeListGet": {
    }
}

Response samples

Content type
{
  • "AttributeList": {
    }
}

Create attribute

Creates a new attribute.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.AttributeCreate+json
optional

The attribute schema encoded in XML or JSON format.

required
object (AttributeCreate)

This class is used to create an attribute.

Responses

Request samples

Content type
application/vnd.ibexa.api.AttributeCreate+json
{
  • "AttributeCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Attribute+json
{
  • "Attribute": {
    }
}

Delete attribute translation

The given translation is removed from the attribute.

path Parameters
id
required
string
languageCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Filter attributes

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (AttributeViewInput)

This class represents an attribute view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "AttributeView": {
    }
}

Load attribute

Loads given attribute.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "Attribute": {
    }
}

Delete attribute

The given attribute is removed from the attribute group.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Update attribute

Updates an attribute.

path Parameters
id
required
string
group_id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.AttributeUpdate+json
optional

If set, the updated attribute group is returned in XML or JSON format.

required
object (AttributeUpdate)

This class is used to update an attribute.

Responses

Request samples

Content type
application/vnd.ibexa.api.AttributeUpdate+json
{
  • "AttributeUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Attribute+json
{
  • "Attribute": {
    }
}

Product Attribute Type

List Attribute Types

Lists all Attribute Types.

Responses

Response samples

Content type
{
  • "AttributeTypeList": {
    }
}

Get Attribute Type

Gets an Attribute Type by its identifier.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "AttributeType": {
    }
}

Product Attribute Group

Load attribute groups (deprecated)

Returns a list of attribute groups. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attribute_groups/view instead.

Request Body schema: application/vnd.ibexa.api.AttributeGroupListGet+json
optional

The AttributeGroupListGet schema encoded in XML or JSON format.

required
object (AttributeGroupListGet)

This class represents an attribute group list request.

Responses

Request samples

Content type
application/vnd.ibexa.api.AttributeGroupListGet+json
{
  • "AttributeGroupListGet": {
    }
}

Response samples

Content type
{
  • "AttributeGroupList": {
    }
}

Create attribute group

Creates a new attribute group.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.AttributeGroupCreate+json
optional

The AttributeGroup schema encoded in XML or JSON format.

required
object (AttributeGroupCreate)

This class is used to create an attribute group.

Responses

Request samples

Content type
application/vnd.ibexa.api.AttributeGroupCreate+json
{
  • "AttributeGroupCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.AttributeGroup+json
{
  • "AttributeGroup": {
    }
}

Delete attribute group translation

Deletes given translation from attribute group.

path Parameters
id
required
string
languageCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Filter attribute groups

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (AttributeGroupViewInput)

This class represents an attribute group view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "AttributeGroupView": {
    }
}

Load attribute group

Returns the given attribute group.

path Parameters
id
required
string
Request Body schema:
optional

An optional AttributeGroupGet schema encoded in XML or JSON format.

required
object (AttributeGroupGet)

This class represents an attribute group query.

Responses

Request samples

Content type
{
  • "AttributeGroupGet": {
    }
}

Response samples

Content type
{
  • "AttributeGroup": {
    }
}

Delete attribute group

Deletes an attribute group.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Update attribute group

Updates an attribute group.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The attribute group update schema is sent in XML or JSON format.

required
object (AttributeGroupUpdate)

This class is used to update an attribute group.

Responses

Request samples

Content type
{
  • "AttributeGroupUpdate": {
    }
}

Response samples

Content type
{
  • "AttributeGroup": {
    }
}

Product Catalog

Create catalog

Creates a new catalog.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.CatalogCreate+json
optional

The catalog schema encoded in XML or JSON format.

required
object (CatalogCreate)

This class is used to create a catalog.

Responses

Request samples

Content type
application/vnd.ibexa.api.CatalogCreate+json
{
  • "CatalogCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.CatalogCreate+json
{
  • "Catalog": {
    }
}

Copy catalog

Copies a catalog.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.CatalogCopy+json
optional

If set, the copied catalog is returned in XML or JSON format.

required
object (CatalogCopy)

This class is used to copy a catalog.

Responses

Request samples

Content type
application/vnd.ibexa.api.CatalogCopy+json
{
  • "CatalogCopy": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Catalog+json
{
  • "Catalog": {
    }
}

Load catalog filters

Loads product filters available for catalogs.

Responses

Response samples

Content type
{
  • "ProductFilterList": {
    }
}

Load catalog sort clauses

Loads product sort clauses available for catalogs.

Responses

Response samples

Content type
{
  • "ProductSortClauseList": {
    }
}

Filter catalogs

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (CatalogViewInput)

This class represents a catalog view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CatalogView": {
    }
}

Load catalog

Loads the given catalog.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "Catalog": {
    }
}

Delete catalog

Deletes the given catalog.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Update catalog

Updates a catalog.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.CatalogUpdate+json
optional

If set, the updated catalog is returned in XML or JSON format.

required
object (CatalogUpdate)

This class is used to update a catalog.

Responses

Request samples

Content type
application/vnd.ibexa.api.CatalogUpdate+json
{
  • "CatalogUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Catalog+json
{
  • "Catalog": {
    }
}

Filter catalog products

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (ProductViewInput)

This class represents a product view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductView": {
    }
}

Product Currency

Load currencies

Loads the list of currencies.

Responses

Response samples

Content type
application/vnd.ibexa.api.CurrencyList+json
{
  • "CurrencyList": {
    }
}

Create currency

Creates a new currency.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.CurrencyCreate+json
optional

The Currency schema encoded in XML or JSON format.

required
object (CurrencyCreate)

This class is used to create currency.

Responses

Request samples

Content type
application/vnd.ibexa.api.CurrencyCreate+json
{
  • "CurrencyCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Currency+json
{
  • "Currency": {
    }
}

Filter currencies

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (CurrencyViewInput)

This class represents a currency view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CurrencyView": {
    }
}

Load currency

Loads a currency.

path Parameters
id
required
string

Responses

Response samples

Content type
application/vnd.ibexa.api.Currency+json
{
  • "Currency": {
    }
}

Delete currency

Deletes the given currency.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Update currency

Updates a currency.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.CurrencyUpdate+json
optional

The CurrencyUpdate schema encoded in XML or JSON format.

required
object (CurrencyUpdate)

This class is used to update currency.

Responses

Request samples

Content type
application/vnd.ibexa.api.CurrencyUpdate+json
{
  • "CurrencyUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Currency+json
{
  • "Currency": {
    }
}

Product Customer Group

Load customer groups

Returns a list of customer groups

Responses

Response samples

Content type
application/vnd.ibexa.api.CustomerGroupList+json
{
  • "CustomerGroupList": {
    }
}

Create customer group

Creates a new customer group.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.CustomerGroupCreate+json
optional

The CustomerGroupCreate schema encoded in XML or JSON format.

required
object (CustomerGroupCreate)

This class is used to create a customer group.

Responses

Request samples

Content type
application/vnd.ibexa.api.CustomerGroupCreate+json
{
  • "CustomerGroupCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.CustomerGroup+json
{
  • "CustomerGroup": {
    }
}

Filter customer groups

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (CustomerGroupViewInput)

This class represents a customer group view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CustomerGroupView": {
    }
}

Load customer group

Returns a customer group

path Parameters
identifier
required
string

Responses

Response samples

Content type
application/vnd.ibexa.api.CustomerGroup+json
{
  • "CustomerGroup": {
    }
}

Delete customer group

Deletes the given customer group.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Update customer group

Updates the given customer group.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.CustomerGroupUpdate+json
optional

The CustomerGroupUpdate schema encoded in XML or JSON format.

required
object (CustomerGroupUpdate)

This class is used to update a customer group.

Responses

Request samples

Content type
application/vnd.ibexa.api.CustomerGroupUpdate+json
{
  • "CustomerGroupUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.CustomerGroup+json
{
  • "CustomerGroup": {
    }
}

Load customer group

Returns a customer group

path Parameters
id
required
integer

Responses

Response samples

Content type
application/vnd.ibexa.api.CustomerGroup+json
{
  • "CustomerGroup": {
    }
}

Product

Load products list (deprecated)

Returns a list of products. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/products/view instead.

Request Body schema: application/vnd.ibexa.api.ProductListGet+json
optional

The product list schema encoded in XML or JSON format.

required
object (ProductListGet)

This class represents a product list GET.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductListGet+json
{
  • "ProductListGet": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.ProductList+json
{
  • "ProductList": {
    }
}

Filter products

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (ProductViewInput)

This class represents a product view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductView": {
    }
}

Load the given product

Loads the given product.

path Parameters
code
required
string
Request Body schema: application/vnd.ibexa.api.ProductGet+json
optional

An optional product schema encoded in XML or JSON format.

required
object (ProductGet)

This class represents a product GET.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductGet+json
{
  • "ProductGet": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Product+json
{
  • "Product": {
    }
}

Update product

Updates product.

path Parameters
code
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.ProductUpdate+json
optional

If set, the updated product is returned in XML or JSON format.

required
object (ProductUpdate)

This class is used to update a product.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductUpdate+json
{
  • "ProductUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Product+json
{
  • "Product": {
    }
}

Load the list of product prices

Loads the list of product prices.

path Parameters
code
required
string

Responses

Response samples

Content type
application/vnd.ibexa.api.PriceList+json
{
  • "PriceList": {
    }
}

Create product price or custom price

Create product price or custom price.

path Parameters
code
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The product price schema encoded in JSON format.

required
object (CustomPriceCreateStruct)

This class represents a custom price creation structure.

Responses

Request samples

Content type
{
  • "CustomPriceCreateStruct": {
    }
}

Response samples

Content type
{
  • "CustomPrice": {
    }
}

Get price in given currency

Get price in given currency.

path Parameters
code
required
string
currencyCode
required
string

Responses

Response samples

Content type
application/vnd.ibexa.api.Price+json
{
  • "Price": {
    }
}

Get price in given currency and customer group

Get price in given currency and customer group.

path Parameters
code
required
string
currencyCode
required
string
customerGroupIdentifier
required
string

Responses

Response samples

Content type
application/vnd.ibexa.api.CustomPrice+json
{
  • "CustomPrice": {
    }
}

Delete product price

Deletes product price.

path Parameters
code
required
string
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Update product price

Updates product price.

path Parameters
code
required
string
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

Update price or custom price for given currency.

required
object (CustomPriceUpdateStruct)

This class represents a custom price updating structure.

Responses

Request samples

Content type
{
  • "CustomPriceUpdateStruct": {
    }
}

Response samples

Content type
{
  • "CustomPrice": {
    }
}

Delete product

Deletes the given product.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Create product

Creates a new product.

path Parameters
productTypeIdentifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.ProductCreate+json
optional

The product schema encoded in XML or JSON format.

required
object (ProductCreate)

This class is used to create a product.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductCreate+json
{
  • "ProductCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.ProductCreate+json
{
  • "Product": {
    }
}

Product Type

Load product types (deprecated)

Returns a list of product types. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/product_types/view instead.

Request Body schema:
optional

The ProductTypeList schema encoded in XML or JSON format.

required
object (ProductTypeListGet)

This class represents a product type list query.

Responses

Request samples

Content type
{
  • "ProductTypeListGet": {
    }
}

Response samples

Content type
{
  • "ProductTypeList": {
    }
}

Create product type

Creates a new product type.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.ProductTypeCreate+json
optional

The ProductType schema encoded in XML or JSON format.

required
object (ProductTypeCreate)

This class is used to create a product type.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductTypeCreate+json
{
  • "ProductTypeCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.ProductType+json
{
  • "ProductType": {
    }
}

Check product type usage

Checks whether the product type is in use.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "ProductTypeUsage": {
    }
}

Filter product types

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (ProductTypeViewInput)

This class represents a product type view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductTypeView": {
    }
}

Load product type

Returns the given product type.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "ProductType": {
    }
}

Delete product type

Deletes the given product type.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Update product type

Updates product type.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.ProductTypeUpdate+json
optional

If set, the updated product type is returned in XML or JSON format.

required
object (ProductTypeUpdate)

This class is used to update a product type.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductTypeUpdate+json
{
  • "ProductTypeUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.ProductType+json
{
  • "ProductType": {
    }
}

Product Variant

Load product variant

Loads the given product variant.

path Parameters
code
required
string

Responses

Response samples

Content type
application/vnd.ibexa.api.ProductVariant+json
{
  • "ProductVariant": {
    }
}

Generate product variants

Generates new product variants based on selected (discriminator) attributes.

path Parameters
baseProductCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.ProductVariantGenerate+json
optional

The product variant schema encoded in XML or JSON format.

required
object (ProductVariantGenerate)

This class is used to generate a product variant.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductVariantGenerate+json
{
  • "ProductVariantGenerate": {
    }
}

Filter product variants

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

path Parameters
baseProductCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (ProductVariantViewInput)

This class represents a product variant view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductVariantView": {
    }
}

Create product variant

Creates a new product variant.

path Parameters
baseProductCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.ProductVariantCreate+json
optional

The product variant schema encoded in XML or JSON format.

required
object (ProductVariantCreate)

This class is used to create a product variant.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductVariantCreate+json
{
  • "ProductVariantCreate": {
    }
}

Delete product variant

Deletes the given product variant.

path Parameters
code
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Responses

Update product variant

Updates product variant.

path Parameters
code
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema: application/vnd.ibexa.api.ProductVariantUpdate+json
optional

The product variant update schema encoded in XML or JSON format.

required
object (ProductVariantUpdate)

This class is used to update a product variant.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductVariantUpdate+json
{
  • "ProductVariantUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.ProductVariant+json
{
  • "ProductVariant": {
    }
}

Product Region

Load regions

Loads the list of regions.

Responses

Response samples

Content type
{
  • "RegionList": {
    }
}

Filter regions

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (RegionViewInput)

This class represents a region view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "RegionView": {
    }
}

Load region

Loads a region by its identifier

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "Region": {
    }
}

Product Vat

Load VAT region

Loads a VAT category for the given region.

path Parameters
region
required
string

Responses

Response samples

Content type
application/vnd.ibexa.api.VatCategoryList+json
{
  • "VatCategoryList": {
    }
}

Load VAT specific region

Loads a VAT category for the given identifier.

path Parameters
region
required
string
identifier
required
string

Responses

Response samples

Content type
application/vnd.ibexa.api.VatCategory+json
{
  • "VatCategory": {
    }
}

Taxonomy

Delete Entries

Bulk removes several taxonomy entries.

path Parameters
taxonomyName
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

TaxonomyEntryBulkRemove schema encoded in XML or JSON format.

required
object (TaxonomyEntryBulkRemove)

This class is used to bulk remove taxonomy entries.

Responses

Request samples

Content type
{
  • "TaxonomyEntryBulkRemove": {
    }
}

Move Entries

Bulk move several taxonomy entries relative to sibling.

path Parameters
taxonomyName
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The TaxonomyEntryBulkMove schema encoded in XML or JSON format.

required
object (TaxonomyEntryBulkMove)

This class is used to bulk move taxonomy entries.

Responses

Request samples

Content type
{
  • "TaxonomyEntryBulkMove": {
    }
}

Get Assignment by ID

Gets taxonomy entry Assignment by its ID.

path Parameters
taxonomyName
required
string
id
required
string

Responses

Response samples

Content type
{
  • "TaxonomyEntryAssignment": {
    }
}

Assign entry

Assigns taxonomy entry to a content item.

path Parameters
taxonomyName
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema: application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json
optional

TaxonomyEntryAssignToContent schema encoded in JSON format.

required
object (TaxonomyEntryAssignToContent)

This class is used to assign taxonomy entry to content.

Responses

Request samples

Content type
application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json
{
  • "TaxonomyEntryAssignToContent": {
    }
}

Get Assignments to a Content

Gets taxonomy entries assigned to a content item by its ID.

path Parameters
taxonomyName
required
string
contentId
required
string

Responses

Response samples

Content type
{
  • "EntryAssignmentCollection": {
    }
}

Unassign entry

Unassigns taxonomy entry from a content item.

path Parameters
taxonomyName
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema: application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json
optional

TaxonomyEntryUnassignFromContent schema encoded in JSON format.

required
object (TaxonomyEntryUnassignFromContent)

This class is used to unassign taxonomy entry from content.

Responses

Request samples

Content type
application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json
{
  • "TaxonomyEntryUnassignFromContent": {
    }
}

Get Entry by Content ID

Loads taxonomy Entry by its Content ID.

path Parameters
taxonomyName
required
string
contentId
required
string

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Get Entry by identifier

Loads taxonomy Entry by its Entry identifier.

path Parameters
taxonomyName
required
string
identifier
required
string

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Get Entry by ID

Loads taxonomy Entry by its Entry ID.

path Parameters
taxonomyName
required
string
id
required
string

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Segmentation

List segment groups ExperienceCommerce

Lists segment groups.

Responses

Response samples

Content type
{
  • "SegmentGroupList": {
    }
}

Load segment group ExperienceCommerce

Loads segment group.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "SegmentGroup": {
    }
}

List segment group's segments ExperienceCommerce

Lists segment group's segments.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "SegmentList": {
    }
}

Load segment ExperienceCommerce

Loads the identified segment.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "Segment": {
    }
}

Corporate Account

Root Resource ExperienceCommerce

Provides basic information about Corporate Account endpoints and configuration.

Responses

Response samples

Content type
{
  • "CorporateAccountRoot": {
    }
}

Read list of companies ExperienceCommerce

Returns paginated list of available companies.

Responses

Response samples

Content type
{
  • "CompanyList": {
    }
}

Create a company ExperienceCommerce

Creates a CompanyCreateController resource.

header Parameters
X-CSRF-Token
required
string

Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The CompanyCreate schema encoded in XML or JSON format.

required
object (CompanyCreate)

This class is used to create a company.

Responses

Request samples

Content type
{
  • "CompanyCreate": {
    }
}

Response samples

Content type
{
  • "Company": {
    }
}

Get company ExperienceCommerce

Returns the company by given company ID.

path Parameters
companyId
required
string
header Parameters
If-None-match
string

ETag

Responses

Response samples

Content type
{
  • "Company": {
    }
}

Delete company ExperienceCommerce

The given company is deleted.

path Parameters
companyId
required
string
header Parameters
X-CSRF-Token
required
string

Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

Responses

Update a company ExperienceCommerce

Updates a company. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
companyId
required
string
header Parameters
X-CSRF-Token
required
string

Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

If-Match
required
string

ETag

Request Body schema:
optional

The company input schema encoded in XML or JSON.

required
object (CompanyUpdate)

This class is used to update a Company.

Responses

Request samples

Content type
{
  • "CompanyUpdate": {
    }
}

Response samples

Content type
{
  • "Company": {
    }
}

Read list of company members ExperienceCommerce

Returns paginated list of a given company members.

path Parameters
companyId
required
string
query Parameters
filter[DateMetadataCriterion][Target]
string
Enum: "created" "modified" "published"
filter[DateMetadataCriterion][Operator]
string
Enum: "eq" "gt" "gte" "lt" "lte"
filter[DateMetadataCriterion][Value]
integer

DateTime as a UNIX timestamp

sort[ContentName]
string
Enum: "ascending" "descending"
sort[DatePublished]
string
Enum: "ascending" "descending"
sort[DateModified]
string
Enum: "ascending" "descending"
offset
integer
limit
integer

Responses

Response samples

Content type
{
  • "MemberList": {
    }
}

Create a company member ExperienceCommerce

Creates a company member.

path Parameters
companyId
required
string
header Parameters
X-CSRF-Token
required
string

Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The MemberCreate schema encoded in XML or JSON format.

required
object (MemberCreate)

This class is used to create a member.

Responses

Request samples

Content type
{
  • "MemberCreate": {
    }
}

Response samples

Content type
{
  • "Member": {
    }
}

Get company member ExperienceCommerce

Returns the company member by given member ID.

path Parameters
companyId
required
string
memberId
required
string

Responses

Response samples

Content type
{
  • "Member": {
    }
}

Delete company member ExperienceCommerce

The given company member is deleted.

path Parameters
companyId
required
string
memberId
required
string
header Parameters
X-CSRF-Token
required
string

Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

Responses

Update a company member ExperienceCommerce

Updates a company member. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
companyId
required
string
memberId
required
string
header Parameters
X-CSRF-Token
required
string

Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

If-Match
required
string

ETag

Request Body schema:
optional

The company input schema encoded in XML or JSON.

required
object (MemberUpdate)

This class is used to update a member.

Responses

Request samples

Content type
{
  • "MemberUpdate": {
    }
}

Response samples

Content type
{
  • "Member": {
    }
}

Read list of sales representatives ExperienceCommerce

Returns paginated list of available sales representatives.

Responses

Response samples

Content type
{
  • "SalesRepresentativesList": {
    }
}

Activity Log

List of activity log groups ExperienceCommerce

Lists last activity log groups and their entries.

Responses

Response samples

Content type
{
  • "ActivityLogGroupList": {
    }
}

List of activity log groups ExperienceCommerce

Lists last activity log groups and their entries.

header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

Request Body schema:
optional

The query to filter activity log groups.

required
object (ActivityLogGroupListInput)

This class represents the activity log group search query's criteria and sort clauses.

Responses

Request samples

Content type
{
  • "ActivityLogGroupListInput": {
    }
}

Response samples

Content type
{
  • "ActivityLogGroupList": {
    }
}

Cart

Create Cart Commerce

Creates Cart from payload.

header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The CartCreate schema encoded in XML or JSON format.

required
object (CartCreate)

This class represents a new Cart to create

Responses

Request samples

Content type
{
  • "CartCreate": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Filter carts Commerce

Executes a query and returns a View including the results.

header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The CartViewInput schema is posted in XML or JSON format.

required
object (CartViewInput)

This class represents a cart view input.

Responses

Request samples

Content type
{
  • "CartViewInput": {
    }
}

Response samples

Content type
{
  • "CartView": {
    }
}

Get Cart Commerce

Gets Cart by its identifier.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "Cart": {
    }
}

Delete Cart Commerce

Deletes Cart by its identifier.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Responses

Update Cart's metadata Commerce

Updates identified Cart's metadata from payload.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The CartMetadataUpdate schema encoded in XML or JSON format.

required
object (CartMetadataUpdate)

This class represents the update of cart metadata.

Responses

Request samples

Content type
{
  • "CartMetadataUpdate": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Empty Cart Commerce

Empties the given Cart.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Responses

Add Entry to Cart Commerce

Adds an entry to the cart referenced by its identifier

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The CartEntryAdd schema encoded in XML or JSON format.

required
object (CartEntryAdd)

This class represents a cart entry

Responses

Request samples

Content type
{
  • "CartEntryAdd": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Remove Entry from Cart Commerce

Removes the given entry from the given Cart.

path Parameters
identifier
required
string
entryId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Responses

Response samples

Content type
{
  • "Cart": {
    }
}

Update Entry from Cart Commerce

Updates the given entry from the given Cart.

path Parameters
identifier
required
string
entryId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The CartEntryUpdate schema encoded in XML or JSON format.

required
object (CartEntryUpdate)

Responses

Request samples

Content type
{
  • "CartEntryUpdate": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Move Selected Cart Entries to Default Shopping List Commerce

Moves selected entries from the given Cart to the default Shopping List (save for later). After moving, selected entries are removed from the cart.

path Parameters
identifier
required
string

The Cart identifier

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Request Body schema:
optional

The CartEntryIdentifiers schema encoded in XML or JSON format.

required
object (CartEntryIdentifiers)

This class represents a list of cart entry identifiers

Responses

Request samples

Content type
{
  • "CartEntryIdentifiers": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Move Selected Cart Entries to Specific Shopping List Commerce

Moves selected entries from the given Cart to the specified Shopping List (save for later). After moving, selected entries are removed from the cart.

path Parameters
identifier
required
string

The Cart identifier

shoppingListIdentifier
required
string

The Shopping List identifier

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Request Body schema:
optional

The CartEntryIdentifiers schema encoded in XML or JSON format.

required
object (CartEntryIdentifiers)

This class represents a list of cart entry identifiers

Responses

Request samples

Content type
{
  • "CartEntryIdentifiers": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Move Cart to Default Shopping List Commerce

Moves all entries from the given Cart to the default Shopping List (save for later). After moving, entries are removed from the cart.

path Parameters
identifier
required
string

The Cart identifier

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Responses

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Move Cart to Specific Shopping List Commerce

Moves all entries from the given Cart to the specified Shopping List (save for later). After moving, entries are removed from the cart.

path Parameters
identifier
required
string

The Cart identifier

shoppingListIdentifier
required
string

The Shopping List identifier

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Responses

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Cart Summary Commerce

Gets a summary of the given Cart.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "CartSummary": {
    }
}

Shopping List

List shopping lists CommerceLTS Update

Returns a list of shopping lists owned by the current user.

query Parameters
limit
integer
Default: 25

The maximum number of shopping lists to return. Default is 25.

offset
integer
Default: 0

The offset for pagination. Default is 0.

name
string

Filter shopping lists by name (partial match).

createdFrom
string <date-time>

Filter shopping lists created on or after this date (ISO 8601 format).

createdTo
string <date-time>

Filter shopping lists created on or before this date (ISO 8601 format).

updatedFrom
string <date-time>

Filter shopping lists updated on or after this date (ISO 8601 format).

updatedTo
string <date-time>

Filter shopping lists updated on or before this date (ISO 8601 format).

isDefault
string
Enum: "true" "false"

Filter shopping lists by default flag. Use "true" for default lists only, "false" for non-default lists only.

ownerId
integer

Filter shopping lists by owner user ID.

sort
string
Enum: "name" "is_default" "created_at" "updated_at"

Sort shopping lists by field. Available fields: name, is_default, created_at, updated_at.

order
string
Default: "asc"
Enum: "asc" "desc"

Sort direction. Default is "asc".

Responses

Response samples

Content type
{
  • "ShoppingListCollection": {
    }
}

Create shopping list CommerceLTS Update

Creates a new shopping list for the current user. The list will be owned by the authenticated user.

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Request Body schema:
optional

Shopping list to create

required
object (ShoppingListCreate)

Creates a new shopping list.

Responses

Request samples

Content type
{
  • "ShoppingListCreate": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Add entries to default shopping list CommerceLTS Update

Adds one or more product entries to the default shopping list. If the default shopping list does not exist, it will be created automatically.

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Request Body schema:
optional

Entries to add to the default shopping list

required
object (ShoppingListEntriesAdd)

Adds one or more product entries to an existing shopping list.

Responses

Request samples

Content type
{
  • "ShoppingListEntriesAdd": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Get shopping list CommerceLTS Update

Gets a shopping list by its identifier.

path Parameters
identifier
required
string

The shopping list identifier (UUID)

Responses

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Delete shopping list CommerceLTS Update

Deletes a shopping list by its identifier. The default shopping list cannot be deleted.

path Parameters
identifier
required
string

The shopping list identifier (UUID).

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Responses

Update shopping list CommerceLTS Update

Updates an existing shopping list. Only the name can be updated.

path Parameters
identifier
required
string

The shopping list identifier (UUID).

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Request Body schema:
optional

Shopping list metadata to update

required
object (ShoppingListUpdate)

Updates an existing shopping list.

Responses

Request samples

Content type
{
  • "ShoppingListUpdate": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Add Selected Entries from Shopping List to Default Cart CommerceLTS Update

Adds selected entries from the given Shopping List to the default Cart (creates a new Cart if not found).

path Parameters
identifier
required
string

The Shopping List identifier

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Request Body schema:
optional

The ShoppingListEntryIdentifiers schema encoded in XML or JSON format.

required
object (ShoppingListEntryIdentifiers)

This class represents a list of shopping list entry identifiers to add to cart

Responses

Request samples

Content type
{
  • "ShoppingListEntryIdentifiers": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Add Selected Entries from Shopping List to Specific Cart CommerceLTS Update

Adds selected entries from the given Shopping List to the specified Cart.

path Parameters
identifier
required
string

The Shopping List identifier

cartIdentifier
required
string

The Cart identifier

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Request Body schema:
optional

The ShoppingListEntryIdentifiers schema encoded in XML or JSON format.

required
object (ShoppingListEntryIdentifiers)

This class represents a list of shopping list entry identifiers to add to cart

Responses

Request samples

Content type
{
  • "ShoppingListEntryIdentifiers": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Add Shopping List to Default Cart CommerceLTS Update

Adds all entries from the given Shopping List to the default Cart (creates a new Cart if not found).

path Parameters
identifier
required
string

The Shopping List identifier

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Responses

Response samples

Content type
{
  • "Cart": {
    }
}

Add Shopping List to Specific Cart CommerceLTS Update

Adds all entries from the given Shopping List to the specified Cart.

path Parameters
identifier
required
string

The Shopping List identifier

cartIdentifier
required
string

The Cart identifier

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Responses

Response samples

Content type
{
  • "Cart": {
    }
}

Clear shopping list CommerceLTS Update

Removes all entries from a shopping list while keeping the list itself.

path Parameters
identifier
required
string

The unique identifier (UUID) of the shopping list.

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Responses

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Add entries to shopping list CommerceLTS Update

Adds one or more product entries to an existing shopping list.

path Parameters
identifier
required
string

The unique identifier (UUID) of the shopping list.

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Request Body schema:
optional

Entries to add to the shopping list

required
object (ShoppingListEntriesAdd)

Adds one or more product entries to an existing shopping list.

Responses

Request samples

Content type
{
  • "ShoppingListEntriesAdd": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Remove entries from shopping list CommerceLTS Update

Removes one or more product entries from an existing shopping list by their identifiers.

path Parameters
identifier
required
string

The unique identifier (UUID) of the shopping list.

header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

Request Body schema:
optional

Entries to remove from shopping list

required
object (ShoppingListEntriesRemove)

Removes one or more entries from a shopping list by their identifiers.

Responses

Request samples

Content type
{
  • "ShoppingListEntriesRemove": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Orders

Cancel order Commerce

Cancels the given order.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Responses

Load order by identifier Commerce

Loads an order by its identifier (UUID).

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "Order": {
    }
}

Load order by ID Commerce

Loads an order by its numerical ID.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "Order": {
    }
}

Update order Commerce

Updates an order.

path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema: application/vnd.ibexa.api.OrderUpdate+json
optional

The OrderUpdate schema encoded in XML or JSON format.

required
object (OrderUpdate)

This class is used to update order.

Responses

Request samples

Content type
application/vnd.ibexa.api.OrderUpdate+json
{
  • "OrderUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Order+json
{
  • "Order": {
    }
}

Load orders Commerce

Loads a list of orders.

Responses

Response samples

Content type
{
  • "OrderList": {
    }
}

Create order Commerce

Creates a new order.

header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema: application/vnd.ibexa.api.OrderCreate+json
optional

The Order schema encoded in XML or JSON format.

required
object (OrderCreate)

This class is used to create order.

Responses

Request samples

Content type
application/vnd.ibexa.api.OrderCreate+json
{
  • "OrderCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Order+json
{
  • "Order": {
    }
}

Payments

Create payment method Commerce

Creates a PaymentMethodCreateController resource.

header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The Payment Method input schema encoded in XML or JSON.

required
object (PaymentMethodCreateStruct)

Responses

Request samples

Content type
{
  • "PaymentMethodCreateStruct": {
    }
}

Response samples

Content type
{
  • "PaymentMethod": {
    }
}

List payment methods Commerce

Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The view input in XML or JSON format.

required
object (PaymentMethodViewInput)

Responses

Request samples

Content type
{
  • "PaymentMethodViewInput": {
    }
}

Response samples

Content type
{
  • "PaymentMethodView": {
    }
}

Load payment method by identifier Commerce

Loads an payment method by its identifier.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "PaymentMethod": {
    }
}

Delete payment method Commerce

Removes the PaymentMethodDeleteController resource.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Responses

Update payment method Commerce

Updates the PaymentMethodUpdateController resource.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The Payment Method input schema encoded in XML or JSON.

required
object (PaymentMethodUpdateStruct)

Responses

Request samples

Content type
{
  • "PaymentMethodUpdateStructParser": {
    }
}

Response samples

Content type
{
  • "PaymentMethod": {
    }
}

Load payment method by id Commerce

Loads an payment method by its id.

path Parameters
id
required
string

Responses

Response samples

Content type
application/vnd.ibexa.api.PaymentMethod+json
{
  • "PaymentMethod": {
    }
}

Shipping

Create shipment Commerce

Creates a shipment.

path Parameters
orderIdentifier
required
string

The order's identifier to create a shipment for.

header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The shipment to create.

required
object (ShipmentCreate)

This class represents the creation of a shipment.

Responses

Request samples

Content type
{
  • "ShipmentCreate": {
    }
}

Response samples

Content type
{
  • "Shipment": {
    }
}

Load shipments Commerce

Loads a list of shipments.

Responses

Response samples

Content type
{
  • "ShipmentRefList": {
    }
}

Load a single shipment based on its identifier Commerce

Loads a single shipment based on its identifier.

path Parameters
identifier
required
string

The shipment identifier.

Responses

Response samples

Content type
{
  • "Shipment": {
    }
}

Delete shipment Commerce

Deletes a shipment.

path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

Responses

Update shipment Commerce

Updates a shipment.

path Parameters
identifier
required
string

The shipment identifier.

header Parameters
X-CSRF-Token
required
string

The CSRF token.

Request Body schema:
optional

The ShipmentUpdate schema encoded in XML or JSON format.

required
object (ShipmentUpdate)

This class represents the update of a shipment.

Responses

Request samples

Content type
{
  • "ShipmentUpdate": {
    }
}

Response samples

Content type
{
  • "Shipment": {
    }
}

Load shipping methods types Commerce

Loads shipping methods types.

Responses

Response samples

Content type
{
  • "ShippingMethodTypesList": {
    }
}

Load shipping method type based on its identifier Commerce

Loads shipping methods type based on their identifiers.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "ShippingMethodType": {
    }
}

Load shipping methods Commerce

Loads shipping methods.

Responses

Response samples

Content type
{
  • "ShippingMethodRefList": {
    }
}

Load shipping method based on its identifier Commerce

Loads shipping method based on its identifier.

path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "ShippingMethod": {
    }
}

Collaboration Sessions

Create collaboration session

Creates a new collaboration session with participants and returns the session details.

Request Body schema:
optional

Session creation payload

required
object

Responses

Request samples

Content type
{
  • "ExampleSessionCreate": {
    }
}

Response samples

Content type
{
  • "CollaborationSession": {
    }
}

Get collaboration session

Retrieves a collaboration session by its token.

path Parameters
sessionToken
required
string

The session token to retrieve.

Responses

Response samples

Content type
{
  • "CollaborationSession": {
    }
}

Delete collaboration session

Deletes a collaboration session and removes all associated data.

path Parameters
sessionToken
required
string

The session token to delete.

Responses

Update collaboration session

Updates collaboration session properties.

path Parameters
sessionToken
required
string

The session token to update.

Request Body schema:
optional

Session update payload

required
object

Responses

Request samples

Content type
{
  • "ExampleSessionUpdate": {
    }
}

Response samples

Content type
{
  • "CollaborationSession": {
    }
}

Create invitation in collaboration session

Creates an invitation for a participant to join a collaboration session.

path Parameters
sessionToken
required
string

The session token.

Request Body schema:
optional

Invitation creation payload

required
object

Responses

Request samples

Content type
{
  • "InvitationCreate": {
    }
}

Response samples

Content type
{
  • "Invitation": {
    }
}

List collaboration session participants

Retrieves a list of all participants in a collaboration session.

path Parameters
sessionToken
required
string

The session token.

Responses

Response samples

Content type
{
  • "ParticipantList": {
    }
}

Add participants to collaboration session

Adds new participants to an existing collaboration session.

path Parameters
sessionToken
required
string

The session token.

Request Body schema:
optional

Participant list creation payload

required
object

Responses

Request samples

Content type
{
  • "ParticipantListCreate": {
    }
}

Response samples

Content type
{
  • "ParticipantList": {
    }
}

Remove participant from collaboration session

Removes a participant from a collaboration session.

path Parameters
sessionToken
required
string

The session token.

participantId
required
integer

The participant ID to remove.

Responses

Update participant in collaboration session

Updates properties of a participant in a collaboration session.

path Parameters
sessionToken
required
string

The session token.

participantId
required
integer

The participant ID to update.

Request Body schema:
optional

Participant update payload

required
object

Responses

Request samples

Content type
{
  • "ExternalParticipantUpdate": {
    }
}

Response samples

Content type
{
  • "Participant": {
    }
}

Connector AI

Get action types list.

Returns action types list.

Responses

Response samples

Content type
{
  • "ActionTypeList": {
    }
}

Get an action type by its unique identifier.

Returns an action type by its unique string identifier.

path Parameters
identifier
required
string
Example: generate_alt_text

Responses

Response samples

Content type
{
  • "ActionType": {
    }
}

Get action configuration list.

Returns action configuration list.

Responses

Response samples

Content type
{
  • "ActionConfigurationList": {
    }
}

Query action configuration list.

Returns action configuration list based on the given query.

header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

Request Body schema:
optional

Query action configuration search criteria

query
string
action_type_identifier
string
enabled
boolean
limit
integer
page
integer

Responses

Request samples

Content type
{
  • "ActionConfigurationListInput": {
    }
}

Response samples

Content type
{
  • "ActionConfigurationList": {
    }
}

Execute the given AI action

Executes the given AI Action using configured ActionConfiguration or ActionHandler, if passed. Might consume AI agent resources.

path Parameters
actionConfigurationIdentifier
required
string
Examples:
  • rewrite_with_friendly_tone -
  • rewrite_with_professional_tone -
  • summarize_text -
  • expand_text -
  • shorten_text -
  • proofread -
  • improve_readability -
  • gen_alt_text -

Configured action name (obtain by listing the configured actions via GET /api/ibexa/v2/ai/actions endpoint).

header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

Request Body schema:
optional

Input to execute the action. An Input type must match the action type.

required
object
required
object (RuntimeContext)

Responses

Request samples

Content type
{
  • "GenerateAltText": {
    }
}

Response samples

Content type
{
  • "AltText": {
    }
}

Get an action configuration by its unique identifier.

Returns an action configuration by its unique string identifier.

path Parameters
identifier
required
string
Example: rewrite_with_friendly_tone

Responses

Response samples

Content type
{
  • "ActionConfiguration": {
    }
}

Discounts

Get discounts Commerce

Returns a list of all defined discounts

query Parameters
offset
integer
limit
integer
Example: limit=25

Responses

Response samples

Content type
application/vnd.ibexa.api.DiscountList+json
{
  • "DiscountList": {
    }
}

Create a discount Commerce

Creates a new discount

header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

Request Body schema: application/vnd.ibexa.api.DiscountCreate+json
optional

The DiscountCreate schema

identifier
required
string non-empty
type
required
string
Enum: "cart" "catalog"
priority
required
integer [ 1 .. 10 ]
isEnabled
required
boolean
userId
required
integer
required
object
Array of objects
startDate
string <date-time>
endDate
string <date-time>
createdAt
string <date-time>
updatedAt
string <date-time>
required
Array of objects non-empty
object

Responses

Request samples

Content type
application/vnd.ibexa.api.DiscountCreate+json
{
  • "DiscountCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Discount+json
{
  • "Discount": {
    }
}

Get a discount item by its unique identifier. Commerce

Returns a discount item by its unique string identifier.

path Parameters
identifier
required
string
Example: my_discount_identifier

Responses

Response samples

Content type
application/vnd.ibexa.api.Discount+json
{
  • "Discount": {
    }
}

Delete a discount item Commerce

Deletes an existing discount item by its unique identifier

path Parameters
identifier
required
string
Example: my_discount_identifier
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

Responses

Update a discount Commerce

Updates a new discount

path Parameters
identifier
required
string
Example: my_discount_identifier
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

Request Body schema: application/vnd.ibexa.api.DiscountUpdate+json
optional

The DiscountUpdate schema

identifier
required
string non-empty
priority
integer [ 1 .. 10 ]
isEnabled
boolean
userId
integer
lastContributorId
integer
object
Array of objects
startDate
string <date-time>
endDate
string <date-time>
createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects non-empty
object

Responses

Request samples

Content type
application/vnd.ibexa.api.DiscountUpdate+json
{
  • "DiscountUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Discount+json
{
  • "Discount": {
    }
}

Disables a discount Commerce

Disables a discount item by its unique identifier

path Parameters
identifier
required
string
Example: my_discount_identifier
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

Responses

Enables a discount Commerce

Enables a discount item by its unique identifier

path Parameters
identifier
required
string
Example: my_discount_identifier
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

Responses

Get a discount item Commerce

Returns a discount item by its ID.

path Parameters
id
required
integer
Example: 1

Responses

Response samples

Content type
application/vnd.ibexa.api.Discount+json
{
  • "Discount": {
    }
}

Apply discount code Commerce

Apply a discount code on a cart given by its identifier.

path Parameters
cartIdentifier
required
string
header Parameters
X-CSRF-Token
required
string
Request Body schema: application/vnd.ibexa.api.DiscountCode+json
optional

The discount code to apply

required
object (DiscountCode)

Responses

Request samples

Content type
application/vnd.ibexa.api.DiscountCode+json
{
  • "DiscountCode": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.DiscountCode+json
{
  • "DiscountCode": {
    }
}

Drop discount code Commerce

Unapply a discount code from a cart given by its identifier.

path Parameters
cartIdentifier
required
string
header Parameters
X-CSRF-Token
required
string
Request Body schema: application/vnd.ibexa.api.DiscountCode+json
optional

The discount code to drop

required
object (DiscountCode)

Responses

Request samples

Content type
application/vnd.ibexa.api.DiscountCode+json
{
  • "DiscountCode": {
    }
}