diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-elasticsearch-elasticsearch-index-group.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-elasticsearch-elasticsearch-index-group.html index f6800c8642..2510d778a4 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-elasticsearch-elasticsearch-index-group.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-elasticsearch-elasticsearch-index-group.html @@ -229,8 +229,8 @@
test
test
test
test
test
test
test
test
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.
+| 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. + |
The new SessionCreateController resource
+required | object (SessionInput) This class represents a session input. + |
{- "SessionInput": {
- "_media-type": "string",
- "_href": "string",
- "login": "string",
- "password": "string"
}
}{- "Session": {
- "_media-type": "application/vnd.ibexa.api.Session",
- "name": "eZSSID",
- "identifier": "go327ij2cirpo59pb6rrv2a4el2",
- "csrfToken": "23lkneri34ijajedfw39orj3j93",
- "User": {
- "_href": "/user/users/14",
- "_media-type": "application/vnd.ibexa.api.User+json"
}
}
}Get current user session, if any.
+| 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. + |
{- "Session": {
- "_media-type": "application/vnd.ibexa.api.Session",
- "name": "eZSSID",
- "identifier": "go327ij2cirpo59pb6rrv2a4el2",
- "csrfToken": "23lkneri34ijajedfw39orj3j93",
- "User": {
- "_href": "/user/users/14",
- "_media-type": "application/vnd.ibexa.api.User+json"
}
}
}Get the session's User information. Deprecated as of Ibexa DXP 4.6, use GET /user/sessions/current instead.
+| sessionId required | string |
| Cookie required | string {sessionName}={sessionID} + |
| X-CSRF-Token required | string The {csrfToken} needed on all unsafe HTTP methods with session. + |
| Accept required | string |
{- "Session": {
- "_media-type": "application/vnd.ibexa.api.Session",
- "name": "eZSSID",
- "identifier": "go327ij2cirpo59pb6rrv2a4el2",
- "csrfToken": "23lkneri34ijajedfw39orj3j93",
- "User": {
- "_href": "/user/users/14",
- "_media-type": "application/vnd.ibexa.api.User+json"
}
}
}Lists bookmarked Locations for the current user.
+| Accept required | string If set, the list is returned in XML or JSON format. + |
{- "BookmarkList": {
- "_media-type": "application/vnd.ibexa.api.BookmarkList+json",
- "count": 3,
- "items": [
- {
- "_media-type": "application/vnd.ibexa.api.Bookmark+json",
- "__href": "/api/ibexa/v2/bookmark/65",
- "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/57/65",
- "id": 65,
- "priority": 0,
- "hidden": false,
- "invisible": false,
- "explicitlyHidden": false,
- "ParentLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/57"
}, - "pathString": "/1/2/57/65/",
- "depth": 3,
- "childCount": 0,
- "remoteId": "aa538e305aea472eb221ce23d1cc4b50",
- "Children": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/57/65/children"
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/63"
}, - "sortField": "PATH",
- "sortOrder": "ASC",
- "UrlAliases": {
- "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/57/65/urlaliases"
}, - "ContentInfo": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/63",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/63",
- "_remoteId": "211e99934c8fef5900e4813b96ec5c87",
- "_id": 63,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/2"
}, - "Name": "Art3",
- "TranslatedName": "Art3",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/63/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/63/currentversion"
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/63/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2021-06-28T11:34:17+00:00",
- "publishedDate": "2021-06-28T11:34:17+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": false,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/63/objectstates"
}
}
}
}
}, - {
- "_media-type": "application/vnd.ibexa.api.Bookmark+json",
- "__href": "/api/ibexa/v2/bookmark/68",
- "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/58/68",
- "id": 68,
- "priority": 0,
- "hidden": false,
- "invisible": false,
- "explicitlyHidden": false,
- "ParentLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/58"
}, - "pathString": "/1/2/58/68/",
- "depth": 3,
- "childCount": 0,
- "remoteId": "b8cc4627dbc3ca693c85b6b06a8f7492",
- "Children": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/58/68/children"
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/67"
}, - "sortField": "PUBLISHED",
- "sortOrder": "DESC",
- "UrlAliases": {
- "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/58/68/urlaliases"
}, - "ContentInfo": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/67",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/67",
- "_remoteId": "180adb876af5755d65c1a362fcd619c8",
- "_id": 67,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/45"
}, - "Name": "Tip1",
- "TranslatedName": "Tip1",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/67/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/67/currentversion"
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/67/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2021-06-28T11:36:21+00:00",
- "publishedDate": "2021-06-28T11:36:21+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/67/objectstates"
}
}
}
}
}, - {
- "_media-type": "application/vnd.ibexa.api.Bookmark+json",
- "__href": "/api/ibexa/v2/bookmark/59",
- "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/59",
- "id": 59,
- "priority": 0,
- "hidden": false,
- "invisible": false,
- "explicitlyHidden": false,
- "ParentLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/2"
}, - "pathString": "/1/2/59/",
- "depth": 2,
- "childCount": 3,
- "remoteId": "fd949fc2eed1fff847d73021ff1a6ea9",
- "Children": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/59/children"
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/58"
}, - "sortField": "PATH",
- "sortOrder": "ASC",
- "UrlAliases": {
- "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json",
- "_href": "/api/ibexa/v2/content/locations/1/2/59/urlaliases"
}, - "ContentInfo": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/58",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/58",
- "_remoteId": "00b513aae54036a16e00fb3365c4b5f3",
- "_id": 58,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/1"
}, - "Name": "Dog Breed Catalog",
- "TranslatedName": "Dog Breed Catalog",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/58/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/58/currentversion"
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/58/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2021-06-28T11:23:10+00:00",
- "publishedDate": "2021-06-28T11:23:10+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/58/objectstates"
}
}
}
}
}
]
}
}Creates JWT authentication token.
+| Accept required | string If set, the token is returned in XML or JSON format. + |
| Content-Type required | string The SessionInput schema encoded in XML or JSON format. + |
The new JWT resource
+required | object (JWTInput) This class represents the input for a JWT authentication token + |
{- "JWTInput": {
- "_media-type": "string",
- "_href": "string",
- "username": "string",
- "password": "string"
}
}{- "JWT": {
- "_media-type": "application/vnd.ibexa.api.JWT+json",
- "_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3ODAsImV4cCI6MTYwMjg0NDM4MCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.0LHa799HwSwwfDBZd2V0q2xHwGt86PpyZamKnXHQyYI",
- "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3ODAsImV4cCI6MTYwMjg0NDM4MCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.0LHa799HwSwwfDBZd2V0q2xHwGt86PpyZamKnXHQyYI"
}
}Calendar event list.
+| Accept required | string If set, the calendar event list is returned in XML or JSON format. + |
{- "EventList": {
- "_media-type": "application/vnd.ibexa.api.EventList+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597104000&end=1598745600&count=10",
- "totalCount": 5,
- "events": [ ]
}
}Calendar event list grouped by day.
+| Accept required | string If set, the calendar event list grouped by day is returned in XML or JSON format. + |
{- "EventGroupList": {
- "_media-type": "application/vnd.ibexa.api.EventGroupList+json",
- "groups": [
- {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597104000&end=1597190400&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597104000",
- "endDate": "1597190400"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597190400&end=1597276800&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597190400",
- "endDate": "1597276800"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597276800&end=1597363200&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597276800",
- "endDate": "1597363200"
}, - "totalCount": 1,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597363200&end=1597449600&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597363200",
- "endDate": "1597449600"
}, - "totalCount": 1,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597449600&end=1597536000&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597449600",
- "endDate": "1597536000"
}, - "totalCount": 1,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597536000&end=1597622400&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597536000",
- "endDate": "1597622400"
}, - "totalCount": 1,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597622400&end=1597708800&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597622400",
- "endDate": "1597708800"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597708800&end=1597795200&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597708800",
- "endDate": "1597795200"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597795200&end=1597881600&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597795200",
- "endDate": "1597881600"
}, - "totalCount": 1,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597881600&end=1597968000&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597881600",
- "endDate": "1597968000"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1597968000&end=1598054400&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1597968000",
- "endDate": "1598054400"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1598054400&end=1598140800&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1598054400",
- "endDate": "1598140800"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1598140800&end=1598227200&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1598140800",
- "endDate": "1598227200"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1598227200&end=1598313600&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1598227200",
- "endDate": "1598313600"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1598313600&end=1598400000&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1598313600",
- "endDate": "1598400000"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1598400000&end=1598486400&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1598400000",
- "endDate": "1598486400"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1598486400&end=1598572800&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1598486400",
- "endDate": "1598572800"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1598572800&end=1598659200&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1598572800",
- "endDate": "1598659200"
}, - "totalCount": 0,
- "events": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.EventGroup+json",
- "_currentPage": "/api/ibexa/v2/calendar/event?start=1598659200&end=1598745600&count=10",
- "DateRange": {
- "_media-type": "application/vnd.ibexa.api.DateRange+json",
- "startDate": "1598659200",
- "endDate": "1598745600"
}, - "totalCount": 0,
- "events": [ ]
}
]
}
}A calendar action that e.g. reschedules or unschedules calendar events. The event type should always be copied from an event.
+| eventType required | string |
| Content-Type required | string |
The new EventExecuteActionController resource
+required | object (UnscheduleAction) This class represents events to unschedule + |
{- "UnscheduleAction": {
- "events": [
- "string"
]
}
}Loads list of all attributes. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attributes/view instead.
+| Accept required | string AttributeList - If set, the attributes list is returned in XML or JSON format. + |
{- "AttributeList": {
- "_media-type": "application/vnd.ibexa.api.AttributeList+json",
- "Attribute": [
- {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "attrib1",
- "name": "Attrib1",
- "description": "",
- "type": "Checkbox",
- "type_identifier": "checkbox",
- "value": true,
- "group": "Attribute Group Test",
- "position": 0,
- "options": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "attrib2",
- "name": "Attrib2",
- "description": "",
- "type": "Checkbox",
- "type_identifier": "checkbox",
- "value": true,
- "group": "Attribute Group Test",
- "position": 0,
- "options": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "attrib3",
- "name": "Attrib3",
- "description": "",
- "type": "Checkbox",
- "type_identifier": "checkbox",
- "value": true,
- "group": "Attribute Group Test",
- "position": 0,
- "options": [ ]
}
]
}
}Creates a new attribute.
+| Accept required | string If set, the new attribute is returned in XML or JSON format. + |
| Content-Type required | string The attribute schema encoded in XML or JSON format. + |
The new AttributeCreateController resource
+required | object (AttributeCreate) This class is used to create an attribute. + |
{- "AttributeCreate": {
- "identifier": "string",
- "type": "string",
- "group": "string",
- "names": { },
- "descriptions": { },
- "position": 0,
- "options": { }
}
}{- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "attr_group",
- "name": "Attribute Group",
- "description": "description",
- "type": "Checkbox",
- "type_identifier": "checkbox",
- "value": true,
- "group": "Attribute Group",
- "position": 0,
- "options": [ ]
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new AttributeViewController resource
+required | object (AttributeViewInput) This class represents an attribute view input. + |
{- "ViewInput": {
- "identifier": "string",
- "AttributeQuery": { }
}
}{- "AttributeView": {
- "_media-type": "application/vnd.ibexa.api.AttributeView+json",
- "identifier": "TitleView",
- "AttributeQuery": {
- "_media-type": "application/vnd.ibexa.api.AttributeQuery+json"
}, - "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 1,
- "AttributeList": {
- "_media-type": "application/vnd.ibexa.api.AttributeList+json",
- "Attribute": [
- {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "measure",
- "name": "measure",
- "description": "",
- "type": "Measurement",
- "type_identifier": "measurement",
- "group": "Test Attribute group",
- "position": 0,
- "options": {
- "type": "length",
- "unit": "centimeter",
- "measurementRange": {
- "minimum": 12,
- "maximum": 15
}, - "measurementDefaultRange": {
- "defaultRangeMinimumValue": null,
- "defaultRangeMaximumValue": null
}
}
}
]
}
}
}
}Loads given attribute.
+| id required | string |
| Accept required | string Attribute - If set, the given attribute is returned in XML or JSON format. + |
{- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "attr_group",
- "name": "Attribute Group",
- "description": "description",
- "type": "Checkbox",
- "type_identifier": "checkbox",
- "value": true,
- "group": "Attribute Group",
- "position": 0,
- "options": [ ]
}
}Updates an attribute.
+| id required | string |
| group_id required | string |
| Accept required | string If set, the updated attribute is returned in XML or JSON format. + |
| Content-Type required | string If set, the updated attribute group is returned in XML or JSON format. + |
The updated AttributeUpdateController resource
+required | object (AttributeUpdate) This class is used to update an attribute. + |
{- "AttributeUpdate": {
- "identifier": "string",
- "names": { },
- "descriptions": { },
- "position": 0,
- "options": { }
}
}{- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "attr_group",
- "name": "Attribute Group",
- "description": "description",
- "type": "Checkbox",
- "type_identifier": "checkbox",
- "value": true,
- "group": "Attribute Group",
- "position": 0,
- "options": [ ]
}
}Gets an Attribute Type by its identifier.
+| identifier required | string |
| Accept required | string If set, the Attribute Type is returned in XML or JSON format. + |
{- "AttributeType": {
- "identifier": "string",
- "name": "string"
}
}Returns a list of attribute groups. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attribute_groups/view instead.
+| Accept required | string AttributeGroupList - If set, the attribute group list is returned in XML or JSON format. + |
| Content-Type required | string The AttributeGroupListGet schema encoded in XML or JSON format. + |
required | object (AttributeGroupListGet) This class represents an attribute group list request. + |
{- "AttributeGroupListGet": {
- "prefix": "string",
- "offset": 0,
- "limit": 0
}
}{- "AttributeGroupList": {
- "_media-type": "application/vnd.ibexa.api.AttributeGroupList+json",
- "AttributeGroup": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
- "name": "Attribute Group Test",
- "identifier": "attr_group_test",
- "position": 0
}, - {
- "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
- "name": "Dimensions",
- "identifier": "ag_dimensions",
- "position": 0
}
]
}
}Creates a new attribute group.
+| Accept required | string If set, the new attribute group is returned in XML or JSON format. + |
| Content-Type required | string The AttributeGroup schema encoded in XML or JSON format. + |
The new AttributeGroupCreateController resource
+required | object (AttributeGroupCreate) This class is used to create an attribute group. + |
{- "AttributeGroupCreate": {
- "identifier": "string",
- "names": { },
- "position": 0
}
}{- "AttributeGroup": {
- "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
- "name": "Colors Group",
- "identifier": "ag_colors",
- "position": 0
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new AttributeGroupViewController resource
+required | object (AttributeGroupViewInput) This class represents an attribute group view input. + |
{- "ViewInput": {
- "identifier": "string",
- "AttributeGroupQuery": {
- "limit": "string",
- "offset": "string",
- "name_prefix": "string"
}
}
}{- "AttributeGroupView": {
- "_media-type": "application/vnd.ibexa.api.AttributeGroupView+json",
- "identifier": "TitleView",
- "AttributeGroupQuery": {
- "_media-type": "application/vnd.ibexa.api.AttributeGroupQuery+json"
}, - "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 1,
- "AttributeGroupList": {
- "_media-type": "application/vnd.ibexa.api.AttributeGroupList+json",
- "AttributeGroup": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
- "name": "Test Attribute group",
- "identifier": "test_attribute_group",
- "position": 0
}
]
}
}
}
}Returns the given attribute group.
+| id required | string |
| Accept required | string AttributeGroupGet - If set, the attribute group List is returned in XML or JSON format. + |
| Content-Type required | string An optional AttributeGroupGet schema encoded in XML or JSON format. + |
required | object (AttributeGroupGet) This class represents an attribute group query. + |
{- "AttributeGroupGet": {
- "languages": [
- "string"
]
}
}{- "AttributeGroup": {
- "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
- "name": "Colors Group",
- "identifier": "ag_colors",
- "position": 0
}
}Updates an attribute group.
+| id required | string |
| Accept required | string If set, the updated attribute group is returned in XML or JSON format. + |
| Content-Type required | string The attribute group update schema is sent in XML or JSON format. + |
The updated AttributeGroupUpdateController resource
+required | object (AttributeGroupUpdate) This class is used to update an attribute group. + |
{- "AttributeGroupUpdate": {
- "identifier": "string",
- "names": { },
- "position": 0
}
}{- "AttributeGroup": {
- "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
- "name": "Colors Group",
- "identifier": "ag_colors",
- "position": 0
}
}Creates a new catalog.
+| Accept required | string If set, the new catalog is returned in XML or JSON format. + |
| Content-Type required | string The catalog schema encoded in XML or JSON format. + |
The new CatalogCreateController resource
+required | object (CatalogCreate) This class is used to create a catalog. + |
{- "CatalogCreate": {
- "identifier": "string",
- "criteria": {
- "operator": "string",
- "value": [
- null
], - "target": "string",
- "valueData": null,
- "Specifications": [
- {
- "operator": "string",
- "valueFormat": "string",
- "valueTypes": 0,
- "valueCount": 0
}
]
}, - "names": { },
- "descriptions": { },
- "status": "string",
- "creator_id": 0
}
}{- "Catalog": {
- "_media-type": "application/vnd.ibexa.api.Catalog+json",
- "identifier": "test_catalog_copied",
- "name": "Snow Equipment updated",
- "description": "Snow Equipment catalog for 2022",
- "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "created": 1666091820,
- "modified": 1666091820,
- "status": "draft",
- "Criteria": [
- {
- "_media-type": "application/vnd.ibexa.api.ProductCode+json",
- "ProductCodeCriterion": {
- "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
- "codes": [
- "ski"
]
}
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
- "ProductAvailabilityCriterion": {
- "_media-type": "application/vnd.ibexa.api.ProductAvailabilityCriterion+json",
- "is_available": false
}
}, - {
- "_media-type": "application/vnd.ibexa.api.CreatedAt+json",
- "CreatedAtCriterion": {
- "_media-type": "application/vnd.ibexa.api.CreatedAtCriterion+json",
- "created_at": {
- "date": "2022-12-12 00:00:00.000000",
- "timezone_type": 3,
- "timezone": "Europe/Warsaw"
}, - "operator": ">="
}
}
]
}
}Copies a catalog.
+| identifier required | string |
| Accept required | string If set, the copied catalog is returned in XML or JSON format. + |
| Content-Type required | string If set, the copied catalog is returned in XML or JSON format. + |
The new CatalogCopyController resource
+required | object (CatalogCopy) This class is used to copy a catalog. + |
{- "CatalogCopy": {
- "identifier": "string",
- "creator_id": 0
}
}{- "Catalog": {
- "_media-type": "application/vnd.ibexa.api.Catalog+json",
- "identifier": "test_catalog_copied",
- "name": "Snow Equipment updated",
- "description": "Snow Equipment catalog for 2022",
- "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "created": 1666091820,
- "modified": 1666091820,
- "status": "draft",
- "Criteria": [
- {
- "_media-type": "application/vnd.ibexa.api.ProductCode+json",
- "ProductCodeCriterion": {
- "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
- "codes": [
- "ski"
]
}
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
- "ProductAvailabilityCriterion": {
- "_media-type": "application/vnd.ibexa.api.ProductAvailabilityCriterion+json",
- "is_available": false
}
}, - {
- "_media-type": "application/vnd.ibexa.api.CreatedAt+json",
- "CreatedAtCriterion": {
- "_media-type": "application/vnd.ibexa.api.CreatedAtCriterion+json",
- "created_at": {
- "date": "2022-12-12 00:00:00.000000",
- "timezone_type": 3,
- "timezone": "Europe/Warsaw"
}, - "operator": ">="
}
}
]
}
}Loads product filters available for catalogs.
+| Accept required | string If set, the filters are returned in XML or JSON format. + |
{- "ProductFilterList": {
- "_media-type": "application/vnd.ibexa.api.ProductFilterList+json",
- "ProductFilter": [
- {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "CreatedAtCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "CreatedAtRangeCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "ProductCategoryCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "ColorAttributeCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "FloatAttributeCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "FloatAttributeRangeCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "IntegerAttributeCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "IntegerAttributeRangeCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "SelectionAttributeCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "ProductCodeCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "ProductNameCriterion"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
- "name": "ProductAvailabilityCriterion"
}
]
}
}Loads product sort clauses available for catalogs.
+| Accept required | string If set, the clauses are returned in XML or JSON format. + |
{- "ProductSortClauseList": {
- "_media-type": "application/vnd.ibexa.api.ProductSortClauseList+json",
- "ProductSortClause": [
- {
- "_media-type": "application/vnd.ibexa.api.ProductSortClause+json",
- "name": "ProductName"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductSortClause+json",
- "name": "ProductCode"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductSortClause+json",
- "name": "ProductAvailability"
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductSortClause+json",
- "name": "CreatedAt"
}
]
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new CatalogViewController resource
+required | object (CatalogViewInput) This class represents a catalog view input. + |
{- "ViewInput": {
- "CatalogQuery": { }
}
}{- "CatalogView": {
- "_media-type": "application/vnd.ibexa.api.CatalogView+json",
- "identifier": "TitleView",
- "CatalogQuery": {
- "_media-type": "application/vnd.ibexa.api.CatalogQuery+json"
}, - "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 1,
- "CatalogList": {
- "_media-type": "application/vnd.ibexa.api.CatalogList+json",
- "Catalog": [
- {
- "_media-type": "application/vnd.ibexa.api.Catalog+json",
- "identifier": "test",
- "name": "test",
- "description": "",
- "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "created": 1665479475,
- "modified": 1665479475,
- "status": "draft",
- "Criteria": [
- {
- "_media-type": "application/vnd.ibexa.api.ProductCode+json",
- "ProductCodeCriterion": {
- "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
- "codes": [
- "test"
]
}
}
]
}
]
}
}
}
}Loads the given catalog.
+| identifier required | string |
| Accept required | string If set, the catalog is returned in XML or JSON format. + |
{- "Catalog": {
- "_media-type": "application/vnd.ibexa.api.Catalog+json",
- "identifier": "test_catalog_copied",
- "name": "Snow Equipment updated",
- "description": "Snow Equipment catalog for 2022",
- "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "created": 1666091820,
- "modified": 1666091820,
- "status": "draft",
- "Criteria": [
- {
- "_media-type": "application/vnd.ibexa.api.ProductCode+json",
- "ProductCodeCriterion": {
- "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
- "codes": [
- "ski"
]
}
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
- "ProductAvailabilityCriterion": {
- "_media-type": "application/vnd.ibexa.api.ProductAvailabilityCriterion+json",
- "is_available": false
}
}, - {
- "_media-type": "application/vnd.ibexa.api.CreatedAt+json",
- "CreatedAtCriterion": {
- "_media-type": "application/vnd.ibexa.api.CreatedAtCriterion+json",
- "created_at": {
- "date": "2022-12-12 00:00:00.000000",
- "timezone_type": 3,
- "timezone": "Europe/Warsaw"
}, - "operator": ">="
}
}
]
}
}Updates a catalog.
+| identifier required | string |
| Accept required | string If set, the updated catalog is returned in XML or JSON format. + |
| Content-Type required | string If set, the updated catalog is returned in XML or JSON format. + |
The updated CatalogUpdateController resource
+required | object (CatalogUpdate) This class is used to update a catalog. + |
{- "CatalogUpdate": {
- "identifier": "string",
- "transition": "string",
- "criteria": {
- "operator": "string",
- "value": [
- null
], - "target": "string",
- "valueData": null,
- "Specifications": [
- {
- "operator": "string",
- "valueFormat": "string",
- "valueTypes": 0,
- "valueCount": 0
}
]
}, - "names": { },
- "descriptions": { }
}
}{- "Catalog": {
- "_media-type": "application/vnd.ibexa.api.Catalog+json",
- "identifier": "test_catalog_copied",
- "name": "Snow Equipment updated",
- "description": "Snow Equipment catalog for 2022",
- "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "created": 1666091820,
- "modified": 1666091820,
- "status": "draft",
- "Criteria": [
- {
- "_media-type": "application/vnd.ibexa.api.ProductCode+json",
- "ProductCodeCriterion": {
- "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
- "codes": [
- "ski"
]
}
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
- "ProductAvailabilityCriterion": {
- "_media-type": "application/vnd.ibexa.api.ProductAvailabilityCriterion+json",
- "is_available": false
}
}, - {
- "_media-type": "application/vnd.ibexa.api.CreatedAt+json",
- "CreatedAtCriterion": {
- "_media-type": "application/vnd.ibexa.api.CreatedAtCriterion+json",
- "created_at": {
- "date": "2022-12-12 00:00:00.000000",
- "timezone_type": 3,
- "timezone": "Europe/Warsaw"
}, - "operator": ">="
}
}
]
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| identifier required | string |
| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new CatalogProductsViewController resource
+required | object (ProductViewInput) This class represents a product view input. + |
{- "ViewInput": {
- "ProductQuery": { }
}
}{- "ProductView": {
- "_media-type": "application/vnd.ibexa.api.ProductView+json",
- "identifier": "TitleView",
- "ProductQuery": {
- "_media-type": "application/vnd.ibexa.api.ProductQuery+json"
}, - "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 2,
- "ProductList": {
- "_media-type": "application/vnd.ibexa.api.ProductList+json",
- "Product": [
- {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "OTHER",
- "isBaseProduct": false,
- "isVariant": false,
- "name": "Other Office Desk",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "desk",
- "name": "Desk",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": false,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "color",
- "name": "Color",
- "description": "",
- "type": "Selection",
- "type_identifier": "selection",
- "group": "Desk",
- "position": 0,
- "options": {
- "choices": [
- {
- "label": {
- "eng-GB": "Black"
}, - "value": "black"
}, - {
- "label": {
- "eng-GB": "White"
}, - "value": "white"
}
]
}, - "value": null
}
}, - {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": false,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "width",
- "name": "Width",
- "description": "",
- "type": "Measurement (single)",
- "type_identifier": "measurement_single",
- "group": "Desk",
- "position": 0,
- "options": {
- "sign": "none",
- "type": "length",
- "unit": "centimeter",
- "defaultValue": null
}, - "value": null
}
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/67",
- "_remoteId": "c5c22c68912af81992b74851f158db4a",
- "_id": 67,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/53"
}, - "Name": "Other Office Desk",
- "TranslatedName": "Other Office Desk",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/67/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/67/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/67/versions/2",
- "VersionInfo": {
- "id": 529,
- "versionNo": 2,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-12T14:06:25+00:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-12T14:06:25+00:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Other Office Desk"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/67"
}
}, - "Fields": {
- "field": [
- {
- "id": 301,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Other Office Desk"
}, - {
- "id": 302,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 4,
- "code": "OTHER",
- "attributes": [
- "white",
- [ ]
]
}
}, - {
- "id": 303,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n"
}
}, - {
- "id": 304,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}, - {
- "id": 305,
- "fieldDefinitionIdentifier": "category",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment",
- "fieldValue": {
- "taxonomy_entries": [ ],
- "taxonomy": "product_categories"
}
}, - {
- "id": 306,
- "fieldDefinitionIdentifier": "field_64369cb9130a7",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_seo",
- "fieldValue": ""
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/67/versions/2/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/67/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-12T14:06:25+00:00",
- "publishedDate": "2023-04-12T11:59:17+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 2,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/67/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1681308385,
- "updated_at": 1681308385,
- "AttributesList": [
- {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "color",
- "name": "Color",
- "description": "",
- "type": "Selection",
- "type_identifier": "selection",
- "group": "Desk",
- "position": 0,
- "options": {
- "choices": [
- {
- "label": {
- "eng-GB": "Black"
}, - "value": "black"
}, - {
- "label": {
- "eng-GB": "White"
}, - "value": "white"
}
]
}, - "value": "white"
}, - {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "width",
- "name": "Width",
- "description": "",
- "type": "Measurement (single)",
- "type_identifier": "measurement_single",
- "group": "Desk",
- "position": 0,
- "options": {
- "sign": "none",
- "type": "length",
- "unit": "centimeter",
- "defaultValue": null
}, - "value": null
}
], - "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "160.00",
- "base_amount": "160.00",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}, - "money": "16000",
- "base_money": "16000"
}
}, - {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "ERGO",
- "isBaseProduct": false,
- "isVariant": false,
- "name": "Ergo Office Desk",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "desk",
- "name": "Desk",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": false,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "color",
- "name": "Color",
- "description": "",
- "type": "Selection",
- "type_identifier": "selection",
- "group": "Desk",
- "position": 0,
- "options": {
- "choices": [
- {
- "label": {
- "eng-GB": "Black"
}, - "value": "black"
}, - {
- "label": {
- "eng-GB": "White"
}, - "value": "white"
}
]
}, - "value": null
}
}, - {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": false,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "width",
- "name": "Width",
- "description": "",
- "type": "Measurement (single)",
- "type_identifier": "measurement_single",
- "group": "Desk",
- "position": 0,
- "options": {
- "sign": "none",
- "type": "length",
- "unit": "centimeter",
- "defaultValue": null
}, - "value": null
}
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/66",
- "_remoteId": "1e7449c13671b56ed3907929a2af3ad9",
- "_id": 66,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/53"
}, - "Name": "Ergo Office Desk",
- "TranslatedName": "Ergo Office Desk",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/2",
- "VersionInfo": {
- "id": 528,
- "versionNo": 2,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-12T14:06:14+00:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-12T14:06:14+00:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Ergo Office Desk"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/66"
}
}, - "Fields": {
- "field": [
- {
- "id": 295,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Ergo Office Desk"
}, - {
- "id": 296,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 3,
- "code": "ERGO",
- "attributes": [
- "black",
- [ ]
]
}
}, - {
- "id": 297,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n"
}
}, - {
- "id": 298,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}, - {
- "id": 299,
- "fieldDefinitionIdentifier": "category",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment",
- "fieldValue": {
- "taxonomy_entries": [ ],
- "taxonomy": "product_categories"
}
}, - {
- "id": 300,
- "fieldDefinitionIdentifier": "field_64369cb9130a7",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_seo",
- "fieldValue": ""
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/2/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-12T14:06:14+00:00",
- "publishedDate": "2023-04-12T11:58:00+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 2,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/66/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1681308374,
- "updated_at": 1681308374,
- "AttributesList": [
- {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "color",
- "name": "Color",
- "description": "",
- "type": "Selection",
- "type_identifier": "selection",
- "group": "Desk",
- "position": 0,
- "options": {
- "choices": [
- {
- "label": {
- "eng-GB": "Black"
}, - "value": "black"
}, - {
- "label": {
- "eng-GB": "White"
}, - "value": "white"
}
]
}, - "value": "black"
}, - {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "width",
- "name": "Width",
- "description": "",
- "type": "Measurement (single)",
- "type_identifier": "measurement_single",
- "group": "Desk",
- "position": 0,
- "options": {
- "sign": "none",
- "type": "length",
- "unit": "centimeter",
- "defaultValue": null
}, - "value": null
}
], - "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "99.00",
- "base_amount": "99.00",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}, - "money": "9900",
- "base_money": "9900"
}
}
]
}, - "aggregations": [
- {
- "_media-type": "application/vnd.ibexa.api.RangeAggregationResult+json",
- "name": "price",
- "entries": [
- {
- "_media-type": "application/vnd.ibexa.api.RangeAggregationResultEntry+json",
- "key": {
- "Range": {
- "_media-type": "application/vnd.ibexa.api.Range+json",
- "from": 0,
- "to": 10000
}
}, - "count": 1
}
]
}
]
}
}
}Loads the list of currencies.
+| Accept required | string CurrencyList - If set, the currency list returned in XML or JSON format. + |
{- "CurrencyList": {
- "_media-type": "application/vnd.ibexa.api.CurrencyList+json",
- "Currency": [
- {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 1,
- "code": "AFN",
- "subunits": 1,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 3,
- "code": "ALL",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 4,
- "code": "DZD",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 5,
- "code": "USD",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 6,
- "code": "AOA",
- "subunits": 2,
- "enabled": false
}
]
}
}Creates a new currency.
+| Accept required | string If set, the new currency is returned in JSON format. + |
| Content-Type required | string The Currency schema encoded in XML or JSON format. + |
The new CurrencyCreateController resource
+required | object (CurrencyCreate) This class is used to create currency. + |
{- "CurrencyCreate": {
- "code": "string",
- "subunits": 0,
- "enabled": true
}
}{- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 1,
- "code": "AFN",
- "subunits": 1,
- "enabled": false
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new CurrencyViewController resource
+required | object (CurrencyViewInput) This class represents a currency view input. + |
{- "ViewInput": {
- "CurrencyQuery": { }
}
}{- "CurrencyView": {
- "_media-type": "application/vnd.ibexa.api.CurrencyView+json",
- "identifier": "TitleView",
- "CurrencyQuery": {
- "_media-type": "application/vnd.ibexa.api.CurrencyQuery+json"
}, - "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 179,
- "CurrencyList": {
- "_media-type": "application/vnd.ibexa.api.CurrencyList+json",
- "Currency": [
- {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 1,
- "code": "AFN",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 3,
- "code": "ALL",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 4,
- "code": "DZD",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 5,
- "code": "USD",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 6,
- "code": "AOA",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 7,
- "code": "XCD",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 8,
- "code": "ARS",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 9,
- "code": "AMD",
- "subunits": 2,
- "enabled": false
}, - {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 10,
- "code": "AWG",
- "subunits": 2,
- "enabled": false
}
]
}
}
}
}Loads a currency.
+| id required | string |
| Accept required | string Currency - If set, the currency returned in XML or JSON format. + |
{- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 1,
- "code": "AFN",
- "subunits": 1,
- "enabled": false
}
}Updates a currency.
+| id required | string |
| Accept required | string If set, the updated currency is returned in XML or JSON format. + |
| Content-Type required | string The CurrencyUpdate schema encoded in XML or JSON format. + |
The updated CurrencyUpdateController resource
+required | object (CurrencyUpdate) This class is used to update currency. + |
{- "CurrencyUpdate": {
- "subunits": 0,
- "enabled": true
}
}{- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 1,
- "code": "AFN",
- "subunits": 1,
- "enabled": false
}
}Returns a list of customer groups
+| Accept required | string If set, the customer groups list is returned in XML or JSON format. + |
{- "CustomerGroupList": {
- "_media-type": "application/vnd.ibexa.api.CustomerGroupList+json",
- "CustomerGroup": [
- {
- "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
- "id": 1,
- "name": "Resellers",
- "identifier": "resellers",
- "description": "",
- "users": [ ],
- "global_price_rate": "0.00"
}, - {
- "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
- "id": 2,
- "name": "Contractors",
- "identifier": "contractors",
- "description": "",
- "users": [ ],
- "global_price_rate": "-20.00"
}
]
}
}Creates a new customer group.
+| Accept required | string If set, the new customer group is returned in XML or JSON format. + |
| Content-Type required | string The CustomerGroupCreate schema encoded in XML or JSON format. + |
The new CustomerGroupCreateController resource
+required | object (CustomerGroupCreate) This class is used to create a customer group. + |
{- "CustomerGroupCreate": {
- "identifier": "string",
- "names": { },
- "descriptions": { },
- "global_price_rate": "string"
}
}{- "CustomerGroup": {
- "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
- "id": 1,
- "name": "Customer Group",
- "identifier": "customer_group",
- "description": "",
- "users": [ ],
- "global_price_rate": "1.00"
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new CustomerGroupViewController resource
+required | object (CustomerGroupViewInput) This class represents a customer group view input. + |
{- "ViewInput": {
- "CustomerGroupQuery": { }
}
}{- "CustomerGroupView": {
- "_media-type": "application/vnd.ibexa.api.CustomerGroupView+json",
- "identifier": "TitleView",
- "CustomerGroupQuery": {
- "_media-type": "application/vnd.ibexa.api.CustomerGroupQuery+json"
}, - "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 1,
- "CustomerGroupList": {
- "_media-type": "application/vnd.ibexa.api.CustomerGroupList+json",
- "CustomerGroup": [
- {
- "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
- "id": 1,
- "name": "Business",
- "identifier": "business",
- "description": "Most trusted business customers, being our partners for at least 5 years.",
- "users": [ ],
- "global_price_rate": "15.00"
}
]
}
}
}
}Returns a customer group
+| identifier required | string |
| Accept required | string If set, the customer group is returned in XML or JSON format. + |
{- "CustomerGroup": {
- "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
- "id": 1,
- "name": "Customer Group",
- "identifier": "customer_group",
- "description": "",
- "users": [ ],
- "global_price_rate": "1.00"
}
}Updates the given customer group.
+| identifier required | string |
| Accept required | string If set, the updated customer group is returned in XML or JSON format. + |
| Content-Type required | string The CustomerGroupUpdate schema encoded in XML or JSON format. + |
The updated CustomerGroupUpdateController resource
+required | object (CustomerGroupUpdate) This class is used to update a customer group. + |
{- "CustomerGroupUpdate": {
- "names": { },
- "identifier": "string",
- "global_price_rate": "string",
- "descriptions": [
- "string"
]
}
}{- "CustomerGroup": {
- "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
- "id": 1,
- "name": "Customer Group",
- "identifier": "customer_group",
- "description": "",
- "users": [ ],
- "global_price_rate": "1.00"
}
}Returns a customer group
+| id required | integer |
| Accept required | string If set, the customer group is returned in XML or JSON format. + |
{- "CustomerGroup": {
- "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
- "id": 1,
- "name": "Customer Group",
- "identifier": "customer_group",
- "description": "",
- "users": [ ],
- "global_price_rate": "1.00"
}
}Returns a list of products. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/products/view instead.
+| Accept required | string If set, the products are returned in XML or JSON format. + |
| Content-Type required | string The product list schema encoded in XML or JSON format. + |
required | object (ProductListGet) This class represents a product list GET. + |
{- "ProductListGet": {
- "offset": 0,
- "limit": 0,
- "languages": [
- "string"
]
}
}{- "ProductList": {
- "_media-type": "application/vnd.ibexa.api.ProductList+json",
- "Product": [
- {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "wsk_98845",
- "name": "HUMMINGBIRD PRO DRY 9,2MM",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "d_rope",
- "name": "Dynamic ropes",
- "AttributeAssignmentList": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1645787815,
- "updated_at": 1645787815,
- "AttributesList": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "wsst_34456",
- "name": "Simond XC 60m",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "s_rope",
- "name": "Static ropes",
- "AttributeAssignmentList": [ ]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/141",
- "_remoteId": "86fdab24802923a9c30994858165ba9b",
- "_id": 141,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/54"
}, - "Name": "HUMMINGBIRD PRO DRY 9,2MM",
- "TranslatedName": "HUMMINGBIRD PRO DRY 9,2MM",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/141/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions/2",
- "VersionInfo": {
- "id": 618,
- "versionNo": 2,
- "status": "PUBLISHED",
- "modificationDate": "2022-05-27T09:29:33+00:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2022-05-27T09:29:33+00:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "HUMMINGBIRD PRO DRY 9,2MM"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/141"
}
}, - "Fields": {
- "field": [
- {
- "id": 612,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "HUMMINGBIRD PRO DRY 9,2MM"
}, - {
- "id": 613,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 25,
- "code": "wsk_98845",
- "attributes": [
- 10
]
}
}, - {
- "id": 614,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n"
}
}, - {
- "id": 615,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions/2/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/141/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2022-05-27T09:29:33+00:00",
- "publishedDate": "2022-05-27T06:51:36+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 2,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/141/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1645787893,
- "updated_at": 1645787893,
- "AttributesList": [ ]
}
]
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new ProductViewController resource
+required | object (ProductViewInput) This class represents a product view input. + |
{- "ViewInput": {
- "ProductQuery": { }
}
}{- "ProductView": {
- "_media-type": "application/vnd.ibexa.api.ProductView+json",
- "identifier": "TitleView",
- "ProductQuery": {
- "_media-type": "application/vnd.ibexa.api.ProductQuery+json"
}, - "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 2,
- "ProductList": {
- "_media-type": "application/vnd.ibexa.api.ProductList+json",
- "Product": [
- {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "OTHER",
- "isBaseProduct": false,
- "isVariant": false,
- "name": "Other Office Desk",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "desk",
- "name": "Desk",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": false,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "color",
- "name": "Color",
- "description": "",
- "type": "Selection",
- "type_identifier": "selection",
- "group": "Desk",
- "position": 0,
- "options": {
- "choices": [
- {
- "label": {
- "eng-GB": "Black"
}, - "value": "black"
}, - {
- "label": {
- "eng-GB": "White"
}, - "value": "white"
}
]
}, - "value": null
}
}, - {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": false,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "width",
- "name": "Width",
- "description": "",
- "type": "Measurement (single)",
- "type_identifier": "measurement_single",
- "group": "Desk",
- "position": 0,
- "options": {
- "sign": "none",
- "type": "length",
- "unit": "centimeter",
- "defaultValue": null
}, - "value": null
}
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/67",
- "_remoteId": "c5c22c68912af81992b74851f158db4a",
- "_id": 67,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/53"
}, - "Name": "Other Office Desk",
- "TranslatedName": "Other Office Desk",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/67/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/67/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/67/versions/2",
- "VersionInfo": {
- "id": 529,
- "versionNo": 2,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-12T14:06:25+00:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-12T14:06:25+00:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Other Office Desk"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/67"
}
}, - "Fields": {
- "field": [
- {
- "id": 301,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Other Office Desk"
}, - {
- "id": 302,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 4,
- "code": "OTHER",
- "attributes": [
- "white",
- [ ]
]
}
}, - {
- "id": 303,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n"
}
}, - {
- "id": 304,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}, - {
- "id": 305,
- "fieldDefinitionIdentifier": "category",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment",
- "fieldValue": {
- "taxonomy_entries": [ ],
- "taxonomy": "product_categories"
}
}, - {
- "id": 306,
- "fieldDefinitionIdentifier": "field_64369cb9130a7",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_seo",
- "fieldValue": ""
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/67/versions/2/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/67/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-12T14:06:25+00:00",
- "publishedDate": "2023-04-12T11:59:17+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 2,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/67/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1681308385,
- "updated_at": 1681308385,
- "AttributesList": [
- {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "color",
- "name": "Color",
- "description": "",
- "type": "Selection",
- "type_identifier": "selection",
- "group": "Desk",
- "position": 0,
- "options": {
- "choices": [
- {
- "label": {
- "eng-GB": "Black"
}, - "value": "black"
}, - {
- "label": {
- "eng-GB": "White"
}, - "value": "white"
}
]
}, - "value": "white"
}, - {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "width",
- "name": "Width",
- "description": "",
- "type": "Measurement (single)",
- "type_identifier": "measurement_single",
- "group": "Desk",
- "position": 0,
- "options": {
- "sign": "none",
- "type": "length",
- "unit": "centimeter",
- "defaultValue": null
}, - "value": null
}
], - "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "160.00",
- "base_amount": "160.00",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}, - "money": "16000",
- "base_money": "16000"
}
}, - {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "ERGO",
- "isBaseProduct": false,
- "isVariant": false,
- "name": "Ergo Office Desk",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "desk",
- "name": "Desk",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": false,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "color",
- "name": "Color",
- "description": "",
- "type": "Selection",
- "type_identifier": "selection",
- "group": "Desk",
- "position": 0,
- "options": {
- "choices": [
- {
- "label": {
- "eng-GB": "Black"
}, - "value": "black"
}, - {
- "label": {
- "eng-GB": "White"
}, - "value": "white"
}
]
}, - "value": null
}
}, - {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": false,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "width",
- "name": "Width",
- "description": "",
- "type": "Measurement (single)",
- "type_identifier": "measurement_single",
- "group": "Desk",
- "position": 0,
- "options": {
- "sign": "none",
- "type": "length",
- "unit": "centimeter",
- "defaultValue": null
}, - "value": null
}
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/66",
- "_remoteId": "1e7449c13671b56ed3907929a2af3ad9",
- "_id": 66,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/53"
}, - "Name": "Ergo Office Desk",
- "TranslatedName": "Ergo Office Desk",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/2",
- "VersionInfo": {
- "id": 528,
- "versionNo": 2,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-12T14:06:14+00:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-12T14:06:14+00:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Ergo Office Desk"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/66"
}
}, - "Fields": {
- "field": [
- {
- "id": 295,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Ergo Office Desk"
}, - {
- "id": 296,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 3,
- "code": "ERGO",
- "attributes": [
- "black",
- [ ]
]
}
}, - {
- "id": 297,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n"
}
}, - {
- "id": 298,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}, - {
- "id": 299,
- "fieldDefinitionIdentifier": "category",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment",
- "fieldValue": {
- "taxonomy_entries": [ ],
- "taxonomy": "product_categories"
}
}, - {
- "id": 300,
- "fieldDefinitionIdentifier": "field_64369cb9130a7",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_seo",
- "fieldValue": ""
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/2/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-12T14:06:14+00:00",
- "publishedDate": "2023-04-12T11:58:00+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 2,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/66/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1681308374,
- "updated_at": 1681308374,
- "AttributesList": [
- {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "color",
- "name": "Color",
- "description": "",
- "type": "Selection",
- "type_identifier": "selection",
- "group": "Desk",
- "position": 0,
- "options": {
- "choices": [
- {
- "label": {
- "eng-GB": "Black"
}, - "value": "black"
}, - {
- "label": {
- "eng-GB": "White"
}, - "value": "white"
}
]
}, - "value": "black"
}, - {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "width",
- "name": "Width",
- "description": "",
- "type": "Measurement (single)",
- "type_identifier": "measurement_single",
- "group": "Desk",
- "position": 0,
- "options": {
- "sign": "none",
- "type": "length",
- "unit": "centimeter",
- "defaultValue": null
}, - "value": null
}
], - "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "99.00",
- "base_amount": "99.00",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}, - "money": "9900",
- "base_money": "9900"
}
}
]
}, - "aggregations": [
- {
- "_media-type": "application/vnd.ibexa.api.RangeAggregationResult+json",
- "name": "price",
- "entries": [
- {
- "_media-type": "application/vnd.ibexa.api.RangeAggregationResultEntry+json",
- "key": {
- "Range": {
- "_media-type": "application/vnd.ibexa.api.Range+json",
- "from": 0,
- "to": 10000
}
}, - "count": 1
}
]
}
]
}
}
}Loads the given product.
+| code required | string |
| Accept required | string If set, the products are returned in XML or JSON format. + |
| Content-Type required | string An optional product schema encoded in XML or JSON format. + |
required | object (ProductGet) This class represents a product GET. + |
{- "ProductGet": {
- "languages": [
- "string"
]
}
}{- "Product": {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "wsk_98845",
- "name": "HUMMINGBIRD PRO DRY 9,2MM",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "d_rope",
- "name": "Dynamic ropes",
- "AttributeAssignmentList": [ ]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/141",
- "_remoteId": "86fdab24802923a9c30994858165ba9b",
- "_id": 141,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/54"
}, - "Name": "HUMMINGBIRD PRO DRY 9,2MM",
- "TranslatedName": "HUMMINGBIRD PRO DRY 9,2MM",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/141/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions/2",
- "VersionInfo": {
- "id": 618,
- "versionNo": 2,
- "status": "PUBLISHED",
- "modificationDate": "2022-05-27T09:29:33+00:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2022-05-27T09:29:33+00:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "HUMMINGBIRD PRO DRY 9,2MM"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/141"
}
}, - "Fields": {
- "field": [
- {
- "id": 612,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "HUMMINGBIRD PRO DRY 9,2MM"
}, - {
- "id": 613,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 25,
- "code": "wsk_98845",
- "attributes": [
- 10
]
}
}, - {
- "id": 614,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n"
}
}, - {
- "id": 615,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions/2/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/141/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2022-05-27T09:29:33+00:00",
- "publishedDate": "2022-05-27T06:51:36+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 2,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/141/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1645787815,
- "updated_at": 1645787815,
- "AttributesList": [ ]
}
}Updates product.
+| code required | string |
| Accept required | string If set, the updated product is returned in XML or JSON format. + |
| Content-Type required | string If set, the updated product is returned in XML or JSON format. + |
The updated ProductUpdateController resource
+required | object (ProductUpdate) This class is used to update a product. + |
{- "ProductUpdate": {
- "ContentUpdate": {
- "mainLanguageCode": "string",
- "Section": {
- "_media-type": "string",
- "_href": "string",
- "sectionId": 0,
- "identifier": "string",
- "name": "string"
}, - "MainLocation": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "priority": 0,
- "hidden": true,
- "invisible": true,
- "remoteId": "string",
- "ContentInfo": {
- "_media-type": "string",
- "_href": "string",
- "Content": {
- "_media-type": "string",
- "_href": "string",
- "_remoteId": "string",
- "_id": 0,
- "ContentType": {
- "_media-type": "string",
- "_href": "string"
}, - "Name": "string",
- "Versions": {
- "_media-type": "string",
- "_href": "string"
}, - "CurrentVersion": {
- "_media-type": "string",
- "_href": "string"
}, - "Section": {
- "_media-type": "string",
- "_href": "string"
}, - "Locations": {
- "_media-type": "string",
- "_href": "string"
}, - "Owner": {
- "_media-type": "string",
- "_href": "string"
}, - "lastModificationDate": "2019-08-24T14:15:22Z",
- "publishedDate": "2019-08-24T14:15:22Z",
- "mainLanguageCode": "string",
- "currentVersionNo": 0,
- "alwaysAvailable": true,
- "status": "string",
- "ObjectStates": {
- "_media-type": "string",
- "_href": "string"
}
}
}, - "ParentLocation": null,
- "Children": null,
- "pathString": "string",
- "depth": 0,
- "childCount": 0,
- "sortField": "PATH",
- "sortOrder": "ASC",
- "Content": null,
- "UrlAliases": null
}, - "alwaysAvailable": true,
- "remoteId": "string"
}, - "code": "string",
- "attributes": [
- { }
]
}
}{- "Product": {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "wsk_98845",
- "name": "HUMMINGBIRD PRO DRY 9,2MM",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "d_rope",
- "name": "Dynamic ropes",
- "AttributeAssignmentList": [ ]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/141",
- "_remoteId": "86fdab24802923a9c30994858165ba9b",
- "_id": 141,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/54"
}, - "Name": "HUMMINGBIRD PRO DRY 9,2MM",
- "TranslatedName": "HUMMINGBIRD PRO DRY 9,2MM",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/141/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions/2",
- "VersionInfo": {
- "id": 618,
- "versionNo": 2,
- "status": "PUBLISHED",
- "modificationDate": "2022-05-27T09:29:33+00:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2022-05-27T09:29:33+00:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "HUMMINGBIRD PRO DRY 9,2MM"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/141"
}
}, - "Fields": {
- "field": [
- {
- "id": 612,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "HUMMINGBIRD PRO DRY 9,2MM"
}, - {
- "id": 613,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 25,
- "code": "wsk_98845",
- "attributes": [
- 10
]
}
}, - {
- "id": 614,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n"
}
}, - {
- "id": 615,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions/2/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/141/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2022-05-27T09:29:33+00:00",
- "publishedDate": "2022-05-27T06:51:36+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 2,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/141/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1645787815,
- "updated_at": 1645787815,
- "AttributesList": [ ]
}
}Loads the list of product prices.
+| code required | string |
| Accept required | string PriceList - if set, the product price list is returned in JSON format. + |
{- "PriceList": {
- "_media-type": "application/vnd.ibexa.api.PriceList+json",
- "prices": [
- {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "id": 1,
- "amount": "12.00",
- "base_amount": "12.00",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}, - "money": "1200",
- "base_money": "1200"
}, - {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "id": 2,
- "amount": "12.00",
- "base_amount": "12.00",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 5,
- "code": "USD",
- "subunits": 2,
- "enabled": true
}, - "money": "1200",
- "base_money": "1200"
}
], - "totalCount": 2
}
}Create product price or custom price.
+| code required | string |
| Accept required | string The product price schema encoded in JSON format. + |
| Content-Type required | string If set, the new price is returned in JSON format. + |
The new PriceCreateController resource
+required | object (CustomPriceCreateStruct) This class represents a custom price creation structure. + |
{- "CustomPriceCreateStruct": {
- "amount": 0,
- "currency": "string",
- "customAmount": 0,
- "customerGroup": "string"
}
}{- "CustomPrice": {
- "_media-type": "application/vnd.ibexa.api.CustomPrice+json",
- "id": 3,
- "amount": "17.00",
- "base_amount": "35.00",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 5,
- "code": "USD",
- "subunits": 2,
- "enabled": true
}, - "money": "1700",
- "base_money": "3500",
- "custom_money": "1700",
- "custom_amount": "17.00",
- "custom_rule": null
}
}Get price in given currency.
+| code required | string |
| currencyCode required | string |
| Accept required | string If set, gets price in given currency in JSON format. + |
{- "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "id": 4,
- "amount": "0.09",
- "base_amount": "0.09",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 94,
- "code": "CHF",
- "subunits": 2,
- "enabled": true
}, - "money": "9",
- "base_money": "9"
}
}Get price in given currency and customer group.
+| code required | string |
| currencyCode required | string |
| customerGroupIdentifier required | string |
| Accept required | string If set, gets price in given currency and customer group in JSON format. + |
{- "CustomPrice": {
- "_media-type": "application/vnd.ibexa.api.CustomPrice+json",
- "id": 3,
- "amount": "17.00",
- "base_amount": "35.00",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 5,
- "code": "USD",
- "subunits": 2,
- "enabled": true
}, - "money": "1700",
- "base_money": "3500",
- "custom_money": "1700",
- "custom_amount": "17.00",
- "custom_rule": null
}
}Updates product price.
+| code required | string |
| id required | string |
| Accept required | string If set, updates product price. + |
| Content-Type required | string Update price or custom price for given currency. + |
The updated PriceUpdateController resource
+required | object (CustomPriceUpdateStruct) This class represents a custom price updating structure. + |
{- "CustomPriceUpdateStruct": {
- "amount": 0,
- "currency": "string",
- "customAmount": 0
}
}{- "CustomPrice": {
- "_media-type": "application/vnd.ibexa.api.CustomPrice+json",
- "id": 3,
- "amount": "17.00",
- "base_amount": "35.00",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 5,
- "code": "USD",
- "subunits": 2,
- "enabled": true
}, - "money": "1700",
- "base_money": "3500",
- "custom_money": "1700",
- "custom_amount": "17.00",
- "custom_rule": null
}
}Creates a new product.
+| productTypeIdentifier required | string |
| Accept required | string If set, the new product is returned in XML or JSON format. + |
| Content-Type required | string The product schema encoded in XML or JSON format. + |
The new ProductCreateController resource
+required | object (ProductCreate) This class is used to create a product. + |
{- "ProductCreate": {
- "ContentCreate": {
- "ContentType": {
- "_media-type": "string",
- "_href": "string",
- "_remoteId": "string",
- "_id": 0,
- "ContentType": {
- "_media-type": "string",
- "_href": "string"
}, - "Name": "string",
- "Versions": {
- "_media-type": "string",
- "_href": "string"
}, - "CurrentVersion": {
- "_media-type": "string",
- "_href": "string"
}, - "Section": {
- "_media-type": "string",
- "_href": "string"
}, - "Locations": {
- "_media-type": "string",
- "_href": "string"
}, - "Owner": {
- "_media-type": "string",
- "_href": "string"
}, - "lastModificationDate": "2019-08-24T14:15:22Z",
- "publishedDate": "2019-08-24T14:15:22Z",
- "mainLanguageCode": "string",
- "currentVersionNo": 0,
- "alwaysAvailable": true,
- "status": "string",
- "ObjectStates": {
- "_media-type": "string",
- "_href": "string"
}
}, - "Section": {
- "_href": "string"
}, - "User": 0,
- "alwaysAvailable": "string",
- "remoteId": "string",
- "mainLanguageCode": "string",
- "modificationDate": "2019-08-24T14:15:22Z",
- "LocationCreate": { },
- "fields": {
- "field": [
- { }
]
}
}, - "code": "string",
- "attributes": { }
}
}{- "Product": {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "wsk_98845",
- "name": "HUMMINGBIRD PRO DRY 9,2MM",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "d_rope",
- "name": "Dynamic ropes",
- "AttributeAssignmentList": [ ]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/141",
- "_remoteId": "86fdab24802923a9c30994858165ba9b",
- "_id": 141,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/54"
}, - "Name": "HUMMINGBIRD PRO DRY 9,2MM",
- "TranslatedName": "HUMMINGBIRD PRO DRY 9,2MM",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/141/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions/2",
- "VersionInfo": {
- "id": 618,
- "versionNo": 2,
- "status": "PUBLISHED",
- "modificationDate": "2022-05-27T09:29:33+00:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2022-05-27T09:29:33+00:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "HUMMINGBIRD PRO DRY 9,2MM"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/141"
}
}, - "Fields": {
- "field": [
- {
- "id": 612,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "HUMMINGBIRD PRO DRY 9,2MM"
}, - {
- "id": 613,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 25,
- "code": "wsk_98845",
- "attributes": [
- 10
]
}
}, - {
- "id": 614,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n"
}
}, - {
- "id": 615,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/141/versions/2/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/141/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2022-05-27T09:29:33+00:00",
- "publishedDate": "2022-05-27T06:51:36+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 2,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/141/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1645787815,
- "updated_at": 1645787815,
- "AttributesList": [ ]
}
}Returns a list of product types. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/product_types/view instead.
+| Accept required | string ProductTypeList - If set, the product type list is returned in XML or JSON format. + |
| Content-Type required | string The ProductTypeList schema encoded in XML or JSON format. + |
required | object (ProductTypeListGet) This class represents a product type list query. + |
{- "ProductTypeListGet": {
- "name_prefix": "string",
- "offset": 0,
- "limit": 0,
- "languages": [
- "string"
]
}
}{- "ProductTypeList": {
- "_media-type": "application/vnd.ibexa.api.ProductTypeList+json",
- "ProductType": [
- {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "s_rope",
- "name": "Static ropes",
- "AttributeAssignmentList": [ ]
}
]
}
}Creates a new product type.
+| Accept required | string If set, the new product type is returned in XML or JSON format. + |
| Content-Type required | string The ProductType schema encoded in XML or JSON format. + |
The new ProductTypeCreateController resource
+required | object (ProductTypeCreate) This class is used to create a product type. + |
{- "ProductTypeCreate": {
- "ContentTypeCreateStruct": { },
- "main_language_code": "string",
- "assigned_attributes": [
- {
- "identifier": "string",
- "is_required": true,
- "is_discriminator": true
}
]
}
}{- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "NEW",
- "name": "pt_1_updated",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": true,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "size",
- "name": "Size",
- "description": "",
- "type": "Integer",
- "type_identifier": "integer",
- "value": 5,
- "group": "Hat",
- "position": 0,
- "options": [ ]
}
}
]
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new ProductTypeViewController resource
+required | object (ProductTypeViewInput) This class represents a product type view input. + |
{- "ViewInput": {
- "ProductTypeQuery": { }
}
}{- "ProductTypeView": {
- "_media-type": "application/vnd.ibexa.api.ProductTypeView+json",
- "identifier": "TitleView",
- "ProductTypeQuery": {
- "_media-type": "application/vnd.ibexa.api.ProductTypeQuery+json"
}, - "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 1,
- "ProductTypeList": {
- "_media-type": "application/vnd.ibexa.api.ProductTypeList+json",
- "ProductType": [
- {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "climbing_shoe",
- "name": "New Product Type",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": false,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "measure",
- "name": "measure",
- "description": "",
- "type": "Measurement",
- "type_identifier": "measurement",
- "group": "Test Attribute group",
- "position": 0,
- "options": {
- "type": "length",
- "unit": "centimeter",
- "measurementRange": {
- "minimum": 12,
- "maximum": 15
}, - "measurementDefaultRange": {
- "defaultRangeMinimumValue": null,
- "defaultRangeMaximumValue": null
}
}
}
}, - {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": false,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "leather_color",
- "name": "leather color",
- "description": "",
- "type": "Color",
- "type_identifier": "color",
- "value": "#000000",
- "group": "Test Attribute group",
- "position": 0,
- "options": [ ]
}
}
]
}
]
}
}
}
}Updates product type.
+| id required | string |
| Accept required | string If set, the updated product type is returned in XML or JSON format. + |
| Content-Type required | string If set, the updated product type is returned in XML or JSON format. + |
The updated ProductTypeUpdateController resource
+required | object (ProductTypeUpdate) This class is used to update a product type. + |
{- "ProductTypeUpdate": {
- "ContentTypeUpdateStruct": {
- "identifier": "string",
- "remoteId": "string",
- "urlAliasSchema": "string",
- "nameSchema": "string",
- "isContainer": true,
- "mainLanguageCode": "string",
- "defaultSortField": "PATH",
- "defaultSortOrder": "ASC",
- "defaultAlwaysAvailable": true,
- "modifierId": 0,
- "modificationDate": "2019-08-24T14:15:22Z",
- "names": null,
- "descriptions": null
}, - "assigned_attributes": [
- {
- "identifier": "string",
- "is_required": true,
- "is_discriminator": true
}
]
}
}{- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "NEW",
- "name": "pt_1_updated",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": true,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "size",
- "name": "Size",
- "description": "",
- "type": "Integer",
- "type_identifier": "integer",
- "value": 5,
- "group": "Hat",
- "position": 0,
- "options": [ ]
}
}
]
}
}Loads the given product variant.
+| code required | string |
| Accept required | string If set, the product variant is returned in XML or JSON format. + |
{- "ProductVariant": {
- "_media-type": "application/vnd.ibexa.api.ProductVariant+json",
- "code": "test",
- "name": "Macbook Air ",
- "Product": {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "mac_air",
- "name": "Macbook Air",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "laptop",
- "name": "Laptop",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": true,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "number",
- "name": "number",
- "description": "",
- "type": "Float",
- "type_identifier": "float",
- "value": 1.5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}
}, - {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": true,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "testattr",
- "name": "testAttr",
- "description": "",
- "type": "Integer",
- "type_identifier": "integer",
- "value": 5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/152",
- "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441",
- "_id": 152,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/56"
}, - "Name": "Macbook Air",
- "TranslatedName": "Macbook Air",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/152/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions/1",
- "VersionInfo": {
- "id": 635,
- "versionNo": 1,
- "status": "PUBLISHED",
- "modificationDate": "2022-07-21T15:17:18+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2022-07-21T15:17:18+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Macbook Air"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/152"
}
}, - "Fields": {
- "field": [
- {
- "id": 716,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Macbook Air"
}, - {
- "id": 717,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 89,
- "code": "mac_air",
- "attributes": [ ]
}
}, - {
- "id": 718,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:ezxhtml=\"http://ibexa.co/xmlns/dxp/docbook/xhtml\" xmlns:ezcustom=\"http://ibexa.co/xmlns/dxp/docbook/custom\" version=\"5.0-variant ezpublish-1.0\"><para>test</para></section>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>test</p></section>\n"
}
}, - {
- "id": 719,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}, - {
- "id": 720,
- "fieldDefinitionIdentifier": "category",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment",
- "fieldValue": {
- "taxonomy_entries": [ ],
- "taxonomy": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/152/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2022-07-21T15:17:18+02:00",
- "publishedDate": "2022-07-21T15:17:18+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/152/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1658409438,
- "updated_at": 1658409438,
- "AttributesList": [ ]
}, - "DiscriminatorAttributesList": [ ]
}
}Generates new product variants based on selected (discriminator) attributes.
+| baseProductCode required | string |
| Accept required | string If set, the new product variant is returned in XML or JSON format. + |
| Content-Type required | string The product variant schema encoded in XML or JSON format. + |
The new ProductVariantGenereateController resource
+required | object (ProductVariantGenerate) This class is used to generate a product variant. + |
{- "ProductVariantGenerate": {
- "attributes": { }
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| baseProductCode required | string |
| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new ProductVariantViewController resource
+required | object (ProductVariantViewInput) This class represents a product variant view input. + |
{- "ViewInput": {
- "ProductVariantQuery": { }
}
}{- "ProductVariantView": {
- "_media-type": "application/vnd.ibexa.api.ProductVariantView+json",
- "identifier": "TitleView",
- "ProductVariantQuery": {
- "_media-type": "application/vnd.ibexa.api.ProductVariantQuery+json"
}, - "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 2,
- "ProductVariantList": {
- "_media-type": "application/vnd.ibexa.api.ProductVariantList+json",
- "ProductVariant": [
- {
- "_media-type": "application/vnd.ibexa.api.ProductVariant+json",
- "code": "test",
- "name": "Macbook Air 2/10",
- "Product": {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "mac_air",
- "name": "Macbook Air",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "laptop",
- "name": "Laptop",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": true,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "number",
- "name": "number",
- "description": "",
- "type": "Float",
- "type_identifier": "float",
- "value": 1.5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}
}, - {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": true,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "testattr",
- "name": "testAttr",
- "description": "",
- "type": "Integer",
- "type_identifier": "integer",
- "value": 5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/152",
- "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441",
- "_id": 152,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/56"
}, - "Name": "Macbook Air",
- "TranslatedName": "Macbook Air",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/152/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions/1",
- "VersionInfo": {
- "id": 635,
- "versionNo": 1,
- "status": "PUBLISHED",
- "modificationDate": "2022-07-21T15:17:18+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2022-07-21T15:17:18+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Macbook Air"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/152"
}
}, - "Fields": {
- "field": [
- {
- "id": 716,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Macbook Air"
}, - {
- "id": 717,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 89,
- "code": "mac_air",
- "attributes": [ ]
}
}, - {
- "id": 718,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:ezxhtml=\"http://ibexa.co/xmlns/dxp/docbook/xhtml\" xmlns:ezcustom=\"http://ibexa.co/xmlns/dxp/docbook/custom\" version=\"5.0-variant ezpublish-1.0\"><para>test</para></section>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>test</p></section>\n"
}
}, - {
- "id": 719,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}, - {
- "id": 720,
- "fieldDefinitionIdentifier": "category",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment",
- "fieldValue": {
- "taxonomy_entries": [ ],
- "taxonomy": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/152/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2022-07-21T15:17:18+02:00",
- "publishedDate": "2022-07-21T15:17:18+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/152/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1658409438,
- "updated_at": 1658409438,
- "AttributesList": [ ]
}, - "DiscriminatorAttributesList": [
- {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "number",
- "name": "number",
- "description": "",
- "type": "Float",
- "type_identifier": "float",
- "value": 1.5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}, - {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "testattr",
- "name": "testAttr",
- "description": "",
- "type": "Integer",
- "type_identifier": "integer",
- "value": 5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}
]
}, - {
- "_media-type": "application/vnd.ibexa.api.ProductVariant+json",
- "code": "fdsfds",
- "name": "Macbook Air 32/232",
- "Product": {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "mac_air",
- "name": "Macbook Air",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "laptop",
- "name": "Laptop",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": true,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "number",
- "name": "number",
- "description": "",
- "type": "Float",
- "type_identifier": "float",
- "value": 1.5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}
}, - {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": true,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "testattr",
- "name": "testAttr",
- "description": "",
- "type": "Integer",
- "type_identifier": "integer",
- "value": 5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/152",
- "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441",
- "_id": 152,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/56"
}, - "Name": "Macbook Air",
- "TranslatedName": "Macbook Air",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/152/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions/1",
- "VersionInfo": {
- "id": 635,
- "versionNo": 1,
- "status": "PUBLISHED",
- "modificationDate": "2022-07-21T15:17:18+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2022-07-21T15:17:18+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Macbook Air"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/152"
}
}, - "Fields": {
- "field": [
- {
- "id": 716,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Macbook Air"
}, - {
- "id": 717,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 89,
- "code": "mac_air",
- "attributes": [ ]
}
}, - {
- "id": 718,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:ezxhtml=\"http://ibexa.co/xmlns/dxp/docbook/xhtml\" xmlns:ezcustom=\"http://ibexa.co/xmlns/dxp/docbook/custom\" version=\"5.0-variant ezpublish-1.0\"><para>test</para></section>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>test</p></section>\n"
}
}, - {
- "id": 719,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}, - {
- "id": 720,
- "fieldDefinitionIdentifier": "category",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment",
- "fieldValue": {
- "taxonomy_entries": [ ],
- "taxonomy": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/152/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2022-07-21T15:17:18+02:00",
- "publishedDate": "2022-07-21T15:17:18+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/152/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1658409438,
- "updated_at": 1658409438,
- "AttributesList": [ ]
}, - "DiscriminatorAttributesList": [
- {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "number",
- "name": "number",
- "description": "",
- "type": "Float",
- "type_identifier": "float",
- "value": 1.5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}, - {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "testattr",
- "name": "testAttr",
- "description": "",
- "type": "Integer",
- "type_identifier": "integer",
- "value": 5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}
]
}
]
}
}
}
}Creates a new product variant.
+| baseProductCode required | string |
| Accept required | string If set, the new product variant is returned in XML or JSON format. + |
| Content-Type required | string The product variant schema encoded in XML or JSON format. + |
The new ProductVariantCreateController resource
+required | object (ProductVariantCreate) This class is used to create a product variant. + |
{- "ProductVariantCreate": {
- "code": "string",
- "attributes": { }
}
}Updates product variant.
+| code required | string |
| Accept required | string If set, the updated product variant is returned in XML or JSON format. + |
| Content-Type required | string The product variant update schema encoded in XML or JSON format. + |
The updated ProductVariantUpdateController resource
+required | object (ProductVariantUpdate) This class is used to update a product variant. + |
{- "ProductVariantUpdate": {
- "code": "string",
- "attributes": { }
}
}{- "ProductVariant": {
- "_media-type": "application/vnd.ibexa.api.ProductVariant+json",
- "code": "test",
- "name": "Macbook Air ",
- "Product": {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "mac_air",
- "name": "Macbook Air",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "laptop",
- "name": "Laptop",
- "AttributeAssignmentList": [
- {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": true,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "number",
- "name": "number",
- "description": "",
- "type": "Float",
- "type_identifier": "float",
- "value": 1.5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}
}, - {
- "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
- "is_required": false,
- "is_discriminator": true,
- "Attribute": {
- "_media-type": "application/vnd.ibexa.api.Attribute+json",
- "identifier": "testattr",
- "name": "testAttr",
- "description": "",
- "type": "Integer",
- "type_identifier": "integer",
- "value": 5,
- "group": "test",
- "position": 0,
- "options": {
- "min": 4,
- "max": 5
}
}
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/152",
- "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441",
- "_id": 152,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/56"
}, - "Name": "Macbook Air",
- "TranslatedName": "Macbook Air",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/152/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions/1",
- "VersionInfo": {
- "id": 635,
- "versionNo": 1,
- "status": "PUBLISHED",
- "modificationDate": "2022-07-21T15:17:18+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2022-07-21T15:17:18+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Macbook Air"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/152"
}
}, - "Fields": {
- "field": [
- {
- "id": 716,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Macbook Air"
}, - {
- "id": 717,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 89,
- "code": "mac_air",
- "attributes": [ ]
}
}, - {
- "id": 718,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:ezxhtml=\"http://ibexa.co/xmlns/dxp/docbook/xhtml\" xmlns:ezcustom=\"http://ibexa.co/xmlns/dxp/docbook/custom\" version=\"5.0-variant ezpublish-1.0\"><para>test</para></section>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>test</p></section>\n"
}
}, - {
- "id": 719,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}, - {
- "id": 720,
- "fieldDefinitionIdentifier": "category",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment",
- "fieldValue": {
- "taxonomy_entries": [ ],
- "taxonomy": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/152/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2022-07-21T15:17:18+02:00",
- "publishedDate": "2022-07-21T15:17:18+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/152/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1658409438,
- "updated_at": 1658409438,
- "AttributesList": [ ]
}, - "DiscriminatorAttributesList": [ ]
}
}Loads the list of regions.
+| Accept required | string RegionList - If set, the regions list returned in XML or JSON format. + |
{- "RegionList": {
- "_media-type": "application/vnd.ibexa.api.RegionList+json",
- "Region": [
- {
- "_media-type": "application/vnd.ibexa.api.Region+json",
- "identifier": "france"
}, - {
- "_media-type": "application/vnd.ibexa.api.Region+json",
- "identifier": "__REGION_2__"
}, - {
- "_media-type": "application/vnd.ibexa.api.Region+json",
- "identifier": "__REGION_1__"
}, - {
- "_media-type": "application/vnd.ibexa.api.Region+json",
- "identifier": "foo"
}, - {
- "_media-type": "application/vnd.ibexa.api.Region+json",
- "identifier": "bar"
}
]
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new RegionViewController resource
+required | object (RegionViewInput) This class represents a region view input. + |
{- "ViewInput": {
- "RegionQuery": { }
}
}{- "RegionView": {
- "_media-type": "application/vnd.ibexa.api.RegionView+json",
- "identifier": "TitleView",
- "RegionQuery": {
- "_media-type": "application/vnd.ibexa.api.RegionQuery+json"
}, - "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 2,
- "RegionList": {
- "_media-type": "application/vnd.ibexa.api.RegionList+json",
- "Region": [
- {
- "_media-type": "application/vnd.ibexa.api.Region+json",
- "identifier": "region_1"
}, - {
- "_media-type": "application/vnd.ibexa.api.Region+json",
- "identifier": "region_2"
}
]
}
}
}
}Loads a VAT category for the given region.
+| region required | string |
| Accept required | string If set, the VAT category list returned in XML or JSON format. + |
{- "VatCategoryList": {
- "_media-type": "application/vnd.ibexa.api.VatCategoryList+json",
- "VatCategory": [
- {
- "_media-type": "application/vnd.ibexa.api.VatCategory+json",
- "identifier": "standard",
- "region": "region_1",
- "vatValue": 18
}, - {
- "_media-type": "application/vnd.ibexa.api.VatCategory+json",
- "identifier": "reduced",
- "region": "region_1",
- "vatValue": 6
}, - {
- "_media-type": "application/vnd.ibexa.api.VatCategory+json",
- "identifier": "none",
- "region": "region_1",
- "vatValue": null
}
]
}
}Loads a VAT category for the given identifier.
+| region required | string |
| identifier required | string |
| Accept required | string If set, the VAT category list returned in XML or JSON format. + |
{- "VatCategory": {
- "_media-type": "application/vnd.ibexa.api.VatCategory+json",
- "identifier": "standard",
- "region": "region_1",
- "vatValue": 18
}
}Bulk removes several taxonomy entries.
+| taxonomyName required | string |
| Content-Type required | string Target Entries schema encoded in XML or JSON format. + |
required | object (TaxonomyEntryBulkRemove) This class is used to bulk remove taxonomy entries. + |
{- "TaxonomyEntryBulkRemove": {
- "entries": [
- 0
]
}
}Bulk move several taxonomy entries relative to sibling.
+| taxonomyName required | string |
| Content-Type required | string The Entry moves schema encoded in XML or JSON format. + |
The new TaxonomyEntryBulkMoveController resource
+required | object (TaxonomyEntryBulkMove) This class is used to bulk move taxonomy entries. + |
{- "TaxonomyEntryBulkMove": {
- "entries": [
- {
- "entry": 0,
- "sibling": 0,
- "position": "string"
}
]
}
}Gets taxonomy entry Assignment by its ID.
+| taxonomyName required | string |
| id required | string |
| Accept required | string If set, the Assignment is returned in XML or JSON format. + |
{- "TaxonomyEntryAssignment": {
- "id": 0,
- "content": {
- "_media-type": "string",
- "_href": "string",
- "Content": {
- "_media-type": "string",
- "_href": "string",
- "_remoteId": "string",
- "_id": 0,
- "ContentType": {
- "_media-type": "string",
- "_href": "string"
}, - "Name": "string",
- "Versions": {
- "_media-type": "string",
- "_href": "string"
}, - "CurrentVersion": {
- "_media-type": "string",
- "_href": "string"
}, - "Section": {
- "_media-type": "string",
- "_href": "string"
}, - "Locations": {
- "_media-type": "string",
- "_href": "string"
}, - "Owner": {
- "_media-type": "string",
- "_href": "string"
}, - "lastModificationDate": "2019-08-24T14:15:22Z",
- "publishedDate": "2019-08-24T14:15:22Z",
- "mainLanguageCode": "string",
- "currentVersionNo": 0,
- "alwaysAvailable": true,
- "status": "string",
- "ObjectStates": {
- "_media-type": "string",
- "_href": "string"
}
}
}, - "entry": {
- "_media-type": "string",
- "_href": "string",
- "TaxonomyEntry": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "identifier": "string",
- "name": "string",
- "content": {
- "_media-type": "string",
- "_href": "string"
}, - "taxonomy": "string"
}
}
}
}Assigns taxonomy entry to a content item.
+| taxonomyName required | string |
| Content-Type required | string |
The new TaxonomyEntryAssignmentAssignController resource
+required | object (TaxonomyEntryAssignToContent) This class is used to assign taxonomy entry to content. + |
{- "TaxonomyEntryAssignToContent": {
- "content": 0,
- "entries": [
- 0
]
}
}Gets taxonomy entries assigned to a content item by its ID.
+| taxonomyName required | string |
| contentId required | string |
| Accept required | string If set, the assignments are returned in XML or JSON format. + |
{- "EntryAssignmentCollection": {
- "_media-type": "application/vnd.ibexa.api.EntryAssignmentCollection+json",
- "content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/1",
- "_remoteId": "9459d3c29e15006e45197295722c7ade",
- "_id": 1,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/1"
}, - "Name": "Ibexa Platform",
- "TranslatedName": "Ibexa Platform",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/1/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/1/currentversion"
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/1/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-01-01T00:00:00+00:00",
- "publishedDate": "2015-11-30T13:10:46+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 10,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/1/objectstates"
}
}
}, - "assignments": [
- {
- "_media-type": "application/vnd.ibexa.api.TaxonomyEntryAssignment+json",
- "id": 1,
- "content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/1",
- "_remoteId": "9459d3c29e15006e45197295722c7ade",
- "_id": 1,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/1"
}, - "Name": "Ibexa Platform",
- "TranslatedName": "Ibexa Platform",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/1/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/1/currentversion"
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/1/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-01-01T00:00:00+00:00",
- "publishedDate": "2015-11-30T13:10:46+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 10,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/1/objectstates"
}
}
}, - "entry": {
- "_media-type": "application/vnd.ibexa.api.TaxonomyEntry+json",
- "TaxonomyEntry": {
- "_media-type": "application/vnd.ibexa.api.TaxonomyEntry+json",
- "id": 3,
- "identifier": "example",
- "name": "Example",
- "contentId": 65,
- "content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/65"
}, - "taxonomy": "tags"
}
}
}
]
}
}Unassigns taxonomy entry from a content item.
+| taxonomyName required | string |
| Content-Type required | string |
The new TaxonomyEntryAssignmentUnassignController resource
+required | object (TaxonomyEntryUnassignFromContent) This class is used to unassign taxonomy entry from content. + |
{- "TaxonomyEntryUnassignFromContent": {
- "content": 0,
- "entries": [
- 0
]
}
}Loads taxonomy Entry by its Content ID.
+| taxonomyName required | string |
| contentId required | string |
| Accept required | string If set, the Taxonomy Entry is returned in XML or JSON format. + |
{- "TaxonomyEntry": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "identifier": "string",
- "name": "string",
- "content": {
- "_media-type": "string",
- "_href": "string"
}, - "taxonomy": "string"
}
}Loads taxonomy Entry by its Entry identifier.
+| taxonomyName required | string |
| identifier required | string |
| Accept required | string If set, the Taxonomy Entry is returned in XML or JSON format. + |
{- "TaxonomyEntry": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "identifier": "string",
- "name": "string",
- "content": {
- "_media-type": "string",
- "_href": "string"
}, - "taxonomy": "string"
}
}Loads taxonomy Entry by its Entry ID.
+| taxonomyName required | string |
| id required | string |
| Accept required | string If set, the Taxonomy Entry is returned in XML or JSON format. + |
{- "TaxonomyEntry": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "identifier": "string",
- "name": "string",
- "content": {
- "_media-type": "string",
- "_href": "string"
}, - "taxonomy": "string"
}
}Lists segment groups.
+| Accept required | string If set, the list of segment groups is returned in XML or JSON format. + |
{- "SegmentGroupList": {
- "_media-type": "application/vnd.ibexa.api.SegmentGroupList+json",
- "_href": "/api/ibexa/v2/segment_groups",
- "SegmentGroup": [
- {
- "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
- "_href": "/api/ibexa/v2/segment_groups/corporate_accounts",
- "id": 1,
- "identifier": "corporate_accounts",
- "name": "Corporate Accounts"
}
]
}
}Loads segment group.
+| identifier required | string |
| Accept required | string If set, the segment group is returned in XML or JSON format. + |
{- "SegmentGroup": {
- "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
- "_href": "/api/ibexa/v2/segment_groups/corporate_accounts",
- "id": 1,
- "identifier": "corporate_accounts",
- "name": "Corporate Accounts"
}
}Lists segment group's segments.
+| identifier required | string |
| Accept required | string If set, the segment group is returned in XML or JSON format. + |
{- "SegmentList": {
- "_media-type": "application/vnd.ibexa.api.SegmentList+json",
- "_href": "/api/ibexa/v2/segment_groups/corporate_accounts/segments",
- "Segment": [ ]
}
}Loads the identified segment.
+| identifier required | string |
| Accept required | string If set, the segment is returned in XML or JSON + |
{- "Segment": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "identifier": "string",
- "name": "string",
- "SegmentGroup": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "identifier": "string",
- "name": "string"
}
}
}Provides basic information about Corporate Account endpoints and configuration.
+| Accept required | string If set, helps to determine response format. + |
{- "CorporateAccountRoot": {
- "_media-type": "application/vnd.ibexa.api.CorporateAccountRoot+json",
- "links": [
- {
- "_media-type": "application/vnd.ibexa.api.CompaniesList+json",
- "_rel": "ca-companies",
- "_href": "/api/ibexa/v2/corporate/companies"
}, - {
- "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json",
- "_rel": "ca-types",
- "_href": "/api/ibexa/v2/content/typegroups?identifier=corporate_account"
}, - {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_rel": "ca-types-company",
- "_href": "/api/ibexa/v2/content/types/48"
}, - {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_rel": "ca-types-member",
- "_href": "/api/ibexa/v2/content/types/47"
}, - {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_rel": "ca-types-address",
- "_href": "/api/ibexa/v2/content/types/49"
}, - {
- "_media-type": "application/vnd.ibexa.api.SalesRepresentativesList+json",
- "_rel": "ca-sales-representatives",
- "_href": "/api/ibexa/v2/corporate/sales-representatives"
}, - {
- "_media-type": "application/vnd.ibexa.api.Role+json",
- "_rel": "ca-role-admin",
- "_href": "/api/ibexa/v2/user/roles/14"
}, - {
- "_media-type": "application/vnd.ibexa.api.Role+json",
- "_rel": "ca-role-buyer",
- "_href": "/api/ibexa/v2/user/roles/15"
}
]
}
}Returns paginated list of available companies.
+| Accept required | string If set, helps to determine response format. + |
{- "CompanyList": {
- "_media-type": "application/vnd.ibexa.api.CompanyList+json",
- "companies": [
- {
- "_media-type": "application/vnd.ibexa.api.Company+json",
- "id": 66,
- "name": "Ibexa AS",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/66",
- "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377",
- "_id": 66,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/48"
}, - "Name": "Ibexa AS",
- "TranslatedName": "Ibexa AS",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/1",
- "VersionInfo": {
- "id": 593,
- "versionNo": 1,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-03T13:09:40+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-03T13:09:40+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Ibexa AS"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/66"
}
}, - "Fields": {
- "field": [
- {
- "id": 295,
- "fieldDefinitionIdentifier": "active",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_boolean",
- "fieldValue": true
}, - {
- "id": 296,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Ibexa AS"
}, - {
- "id": 297,
- "fieldDefinitionIdentifier": "vat",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "123 456 789"
}, - {
- "id": 298,
- "fieldDefinitionIdentifier": "website",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
}, - {
- "id": 299,
- "fieldDefinitionIdentifier": "customer_group",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_customer_group",
- "fieldValue": {
- "customer_group_id": 1
}
}, - {
- "id": 300,
- "fieldDefinitionIdentifier": "sales_rep",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 14,
- "destinationContentHref": "/api/ibexa/v2/content/objects/14"
}
}, - {
- "id": 301,
- "fieldDefinitionIdentifier": "contact",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 74,
- "destinationContentHref": "/api/ibexa/v2/content/objects/74"
}
}, - {
- "id": 302,
- "fieldDefinitionIdentifier": "default_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 69,
- "destinationContentHref": "/api/ibexa/v2/content/objects/69"
}
}, - {
- "id": 303,
- "fieldDefinitionIdentifier": "billing_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_address",
- "fieldValue": {
- "name": "Headquarters",
- "country": "NO",
- "fields": {
- "region": "Company HQ location region",
- "locality": "Company HQ location city",
- "street": "Company HQ location street and building",
- "postal_code": "00000",
- "email": "company@email.invalid",
- "phone_number": "+47 000 000 000"
}
}
}, - {
- "id": 305,
- "fieldDefinitionIdentifier": "members",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 67,
- "destinationContentHref": "/api/ibexa/v2/content/objects/67"
}
}, - {
- "id": 304,
- "fieldDefinitionIdentifier": "address_book",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 68,
- "destinationContentHref": "/api/ibexa/v2/content/objects/68"
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/6/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/67"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-03T13:09:40+02:00",
- "publishedDate": "2023-03-31T14:33:36+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/66/objectstates"
}
}, - "billingAddress": {
- "name": "Headquarters",
- "country": "NO",
- "fields": {
- "region": "Company HQ location region",
- "locality": "Company HQ location city",
- "street": "Company HQ location street and building",
- "postal_code": "00000",
- "email": "company@email.invalid",
- "phone_number": "+47 000 000 000"
}
}, - "contactId": 74,
- "salesRepresentativeId": 80,
- "defaultAddressId": 69,
- "addressBookId": 68,
- "membersId": 67,
- "MemberList": {
- "_media-type": "application/vnd.ibexa.api.MemberList+json",
- "_href": "/api/ibexa/v2/corporate/companies/66/members"
}, - "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/67"
}, - "locationPath": "/1/65/67/",
- "isActive": true
}, - {
- "_media-type": "application/vnd.ibexa.api.Company+json",
- "id": 75,
- "name": "QNTM Group AB",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/75",
- "_remoteId": "1d7eaec5b4371f7a35f253d15ecd5258",
- "_id": 75,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/48"
}, - "Name": "QNTM Group AB",
- "TranslatedName": "QNTM Group AB",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/75/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/75/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/75/versions/3",
- "VersionInfo": {
- "id": 546,
- "versionNo": 3,
- "status": "PUBLISHED",
- "modificationDate": "2023-03-31T15:24:49+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-03-31T15:24:49+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "QNTM Group AB"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/75"
}
}, - "Fields": {
- "field": [
- {
- "id": 341,
- "fieldDefinitionIdentifier": "active",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_boolean",
- "fieldValue": true
}, - {
- "id": 342,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "QNTM Group AB"
}, - {
- "id": 343,
- "fieldDefinitionIdentifier": "vat",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "123 456 789"
}, - {
- "id": 344,
- "fieldDefinitionIdentifier": "website",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
}, - {
- "id": 345,
- "fieldDefinitionIdentifier": "customer_group",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_customer_group",
- "fieldValue": {
- "customer_group_id": 1
}
}, - {
- "id": 346,
- "fieldDefinitionIdentifier": "sales_rep",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 14,
- "destinationContentHref": "/api/ibexa/v2/content/objects/14"
}
}, - {
- "id": 347,
- "fieldDefinitionIdentifier": "contact",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": null
}
}, - {
- "id": 348,
- "fieldDefinitionIdentifier": "default_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": null
}
}, - {
- "id": 349,
- "fieldDefinitionIdentifier": "billing_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_address",
- "fieldValue": {
- "name": null,
- "country": null,
- "fields": [ ]
}
}, - {
- "id": 351,
- "fieldDefinitionIdentifier": "members",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 76,
- "destinationContentHref": "/api/ibexa/v2/content/objects/76"
}
}, - {
- "id": 350,
- "fieldDefinitionIdentifier": "address_book",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 77,
- "destinationContentHref": "/api/ibexa/v2/content/objects/77"
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/75/versions/3/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/76"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/75/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-03-31T15:24:49+02:00",
- "publishedDate": "2023-03-31T15:24:48+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 3,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/75/objectstates"
}
}, - "billingAddress": {
- "name": null,
- "country": null,
- "fields": [ ]
}, - "contactId": null,
- "salesRepresentativeId": 14,
- "defaultAddressId": null,
- "addressBookId": 77,
- "membersId": 76,
- "MemberList": {
- "_media-type": "application/vnd.ibexa.api.MemberList+json",
- "_href": "/api/ibexa/v2/corporate/companies/75/members"
}, - "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/76"
}, - "locationPath": "/1/65/76/",
- "isActive": true
}
]
}
}Creates a CompanyCreateController resource.
+| Accept required | string If set, the new company is returned in XML or JSON format. + |
| Content-Type required | string The CompanyCreate schema encoded in XML or JSON format. + |
The new CompanyCreateController resource
+required | object (CompanyCreate) This class is used to create a company. + |
{- "CompanyCreate": {
- "fields": {
- "field": [
- {
- "id": 0,
- "fieldDefinitionIdentifier": "string",
- "languageCode": "string",
- "fieldTypeIdentifier": "string",
- "fieldValue": null
}
]
}
}
}{- "Company": {
- "_media-type": "application/vnd.ibexa.api.Company+json",
- "id": 66,
- "name": "Ibexa AS",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/66",
- "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377",
- "_id": 66,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/48"
}, - "Name": "Ibexa AS",
- "TranslatedName": "Ibexa AS",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/1",
- "VersionInfo": {
- "id": 593,
- "versionNo": 1,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-03T13:09:40+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-03T13:09:40+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Ibexa AS"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/66"
}
}, - "Fields": {
- "field": [
- {
- "id": 295,
- "fieldDefinitionIdentifier": "active",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_boolean",
- "fieldValue": true
}, - {
- "id": 296,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Ibexa AS"
}, - {
- "id": 297,
- "fieldDefinitionIdentifier": "vat",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "123 456 789"
}, - {
- "id": 298,
- "fieldDefinitionIdentifier": "website",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
}, - {
- "id": 299,
- "fieldDefinitionIdentifier": "customer_group",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_customer_group",
- "fieldValue": {
- "customer_group_id": 1
}
}, - {
- "id": 300,
- "fieldDefinitionIdentifier": "sales_rep",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 14,
- "destinationContentHref": "/api/ibexa/v2/content/objects/14"
}
}, - {
- "id": 301,
- "fieldDefinitionIdentifier": "contact",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 74,
- "destinationContentHref": "/api/ibexa/v2/content/objects/74"
}
}, - {
- "id": 302,
- "fieldDefinitionIdentifier": "default_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 69,
- "destinationContentHref": "/api/ibexa/v2/content/objects/69"
}
}, - {
- "id": 303,
- "fieldDefinitionIdentifier": "billing_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_address",
- "fieldValue": {
- "name": "Headquarters",
- "country": "NO",
- "fields": {
- "region": "Company HQ location region",
- "locality": "Company HQ location city",
- "street": "Company HQ location street and building",
- "postal_code": "00000",
- "email": "company@email.invalid",
- "phone_number": "+47 000 000 000"
}
}
}, - {
- "id": 305,
- "fieldDefinitionIdentifier": "members",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 67,
- "destinationContentHref": "/api/ibexa/v2/content/objects/67"
}
}, - {
- "id": 304,
- "fieldDefinitionIdentifier": "address_book",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 68,
- "destinationContentHref": "/api/ibexa/v2/content/objects/68"
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/1/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/67"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-03T13:09:40+02:00",
- "publishedDate": "2023-03-31T14:33:36+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/66/objectstates"
}
}, - "billingAddress": {
- "name": "Headquarters",
- "country": "NO",
- "fields": {
- "region": "Company HQ location region",
- "locality": "Company HQ location city",
- "street": "Company HQ location street and building",
- "postal_code": "00000",
- "email": "company@email.invalid",
- "phone_number": "+47 000 000 000"
}
}, - "contactId": 74,
- "salesRepresentativeId": 80,
- "defaultAddressId": 69,
- "addressBookId": 68,
- "membersId": 67,
- "MemberList": {
- "_media-type": "application/vnd.ibexa.api.MemberList+json",
- "_href": "/api/ibexa/v2/corporate/companies/66/members"
}, - "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/67"
}, - "locationPath": "/1/65/67/",
- "isActive": true
}
}Returns the company by given company ID.
+| companyId required | string |
| Accept required | string If set, the company is returned in XML or JSON format. + |
| If-None-match required | string ETag + |
{- "Company": {
- "_media-type": "application/vnd.ibexa.api.Company+json",
- "id": 66,
- "name": "Ibexa AS",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/66",
- "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377",
- "_id": 66,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/48"
}, - "Name": "Ibexa AS",
- "TranslatedName": "Ibexa AS",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/1",
- "VersionInfo": {
- "id": 593,
- "versionNo": 1,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-03T13:09:40+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-03T13:09:40+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Ibexa AS"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/66"
}
}, - "Fields": {
- "field": [
- {
- "id": 295,
- "fieldDefinitionIdentifier": "active",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_boolean",
- "fieldValue": true
}, - {
- "id": 296,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Ibexa AS"
}, - {
- "id": 297,
- "fieldDefinitionIdentifier": "vat",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "123 456 789"
}, - {
- "id": 298,
- "fieldDefinitionIdentifier": "website",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
}, - {
- "id": 299,
- "fieldDefinitionIdentifier": "customer_group",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_customer_group",
- "fieldValue": {
- "customer_group_id": 1
}
}, - {
- "id": 300,
- "fieldDefinitionIdentifier": "sales_rep",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 14,
- "destinationContentHref": "/api/ibexa/v2/content/objects/14"
}
}, - {
- "id": 301,
- "fieldDefinitionIdentifier": "contact",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 74,
- "destinationContentHref": "/api/ibexa/v2/content/objects/74"
}
}, - {
- "id": 302,
- "fieldDefinitionIdentifier": "default_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 69,
- "destinationContentHref": "/api/ibexa/v2/content/objects/69"
}
}, - {
- "id": 303,
- "fieldDefinitionIdentifier": "billing_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_address",
- "fieldValue": {
- "name": "Headquarters",
- "country": "NO",
- "fields": {
- "region": "Company HQ location region",
- "locality": "Company HQ location city",
- "street": "Company HQ location street and building",
- "postal_code": "00000",
- "email": "company@email.invalid",
- "phone_number": "+47 000 000 000"
}
}
}, - {
- "id": 305,
- "fieldDefinitionIdentifier": "members",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 67,
- "destinationContentHref": "/api/ibexa/v2/content/objects/67"
}
}, - {
- "id": 304,
- "fieldDefinitionIdentifier": "address_book",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 68,
- "destinationContentHref": "/api/ibexa/v2/content/objects/68"
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/1/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/67"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-03T13:09:40+02:00",
- "publishedDate": "2023-03-31T14:33:36+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/66/objectstates"
}
}, - "billingAddress": {
- "name": "Headquarters",
- "country": "NO",
- "fields": {
- "region": "Company HQ location region",
- "locality": "Company HQ location city",
- "street": "Company HQ location street and building",
- "postal_code": "00000",
- "email": "company@email.invalid",
- "phone_number": "+47 000 000 000"
}
}, - "contactId": 74,
- "salesRepresentativeId": 80,
- "defaultAddressId": 69,
- "addressBookId": 68,
- "membersId": 67,
- "MemberList": {
- "_media-type": "application/vnd.ibexa.api.MemberList+json",
- "_href": "/api/ibexa/v2/corporate/companies/66/members"
}, - "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/67"
}, - "locationPath": "/1/65/67/",
- "isActive": true
}
}The given company is deleted.
+| companyId required | string |
| Accept required | string If set, in the case of an error the error message is returned in XML or JSON format. + |
| X-CSRF-Token required | string Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session. + |
Updates a company. PATCH or POST with header X-HTTP-Method-Override PATCH.
+| companyId required | string |
| Accept required | string If set, the updated company is returned in XML or JSON format. + |
| Content-Type required | string The company input schema encoded in XML or JSON. + |
| If-Match required | string ETag + |
The updated CompanyUpdateController resource
+required | object (CompanyUpdate) This class is used to update a Company. + |
{- "CompanyUpdate": {
- "fields": {
- "field": [
- {
- "id": 0,
- "fieldDefinitionIdentifier": "string",
- "languageCode": "string",
- "fieldTypeIdentifier": "string",
- "fieldValue": null
}
]
}
}
}{- "Company": {
- "_media-type": "application/vnd.ibexa.api.Company+json",
- "id": 66,
- "name": "Ibexa AS",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/66",
- "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377",
- "_id": 66,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/48"
}, - "Name": "Ibexa AS",
- "TranslatedName": "Ibexa AS",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/1",
- "VersionInfo": {
- "id": 593,
- "versionNo": 1,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-03T13:09:40+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-03T13:09:40+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Ibexa AS"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/66"
}
}, - "Fields": {
- "field": [
- {
- "id": 295,
- "fieldDefinitionIdentifier": "active",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_boolean",
- "fieldValue": true
}, - {
- "id": 296,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Ibexa AS"
}, - {
- "id": 297,
- "fieldDefinitionIdentifier": "vat",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "123 456 789"
}, - {
- "id": 298,
- "fieldDefinitionIdentifier": "website",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
}, - {
- "id": 299,
- "fieldDefinitionIdentifier": "customer_group",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_customer_group",
- "fieldValue": {
- "customer_group_id": 1
}
}, - {
- "id": 300,
- "fieldDefinitionIdentifier": "sales_rep",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 14,
- "destinationContentHref": "/api/ibexa/v2/content/objects/14"
}
}, - {
- "id": 301,
- "fieldDefinitionIdentifier": "contact",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 74,
- "destinationContentHref": "/api/ibexa/v2/content/objects/74"
}
}, - {
- "id": 302,
- "fieldDefinitionIdentifier": "default_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 69,
- "destinationContentHref": "/api/ibexa/v2/content/objects/69"
}
}, - {
- "id": 303,
- "fieldDefinitionIdentifier": "billing_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_address",
- "fieldValue": {
- "name": "Headquarters",
- "country": "NO",
- "fields": {
- "region": "Company HQ location region",
- "locality": "Company HQ location city",
- "street": "Company HQ location street and building",
- "postal_code": "00000",
- "email": "company@email.invalid",
- "phone_number": "+47 000 000 000"
}
}
}, - {
- "id": 305,
- "fieldDefinitionIdentifier": "members",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 67,
- "destinationContentHref": "/api/ibexa/v2/content/objects/67"
}
}, - {
- "id": 304,
- "fieldDefinitionIdentifier": "address_book",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 68,
- "destinationContentHref": "/api/ibexa/v2/content/objects/68"
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/versions/1/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/67"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/66/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-03T13:09:40+02:00",
- "publishedDate": "2023-03-31T14:33:36+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/66/objectstates"
}
}, - "billingAddress": {
- "name": "Headquarters",
- "country": "NO",
- "fields": {
- "region": "Company HQ location region",
- "locality": "Company HQ location city",
- "street": "Company HQ location street and building",
- "postal_code": "00000",
- "email": "company@email.invalid",
- "phone_number": "+47 000 000 000"
}
}, - "contactId": 74,
- "salesRepresentativeId": 80,
- "defaultAddressId": 69,
- "addressBookId": 68,
- "membersId": 67,
- "MemberList": {
- "_media-type": "application/vnd.ibexa.api.MemberList+json",
- "_href": "/api/ibexa/v2/corporate/companies/66/members"
}, - "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/67"
}, - "locationPath": "/1/65/67/",
- "isActive": true
}
}Returns paginated list of a given company members.
+| companyId required | string |
| 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 |
| Accept required | string Enum: "application/vnd.ibexa.api.MemberList+xml" "application/vnd.ibexa.api.MemberList+json" If set, helps to determine response format. + |
{- "MemberList": {
- "_media-type": "application/vnd.ibexa.api.MemberList+json",
- "_href": "/api/ibexa/v2/corporate/companies/139/members",
- "members": [
- {
- "_media-type": "application/vnd.ibexa.api.Member+json",
- "_href": "/api/ibexa/v2/corporate/companies/139/members/144",
- "id": 144,
- "name": "Jay Kowalski",
- "Company": {
- "_media-type": "application/vnd.ibexa.api.Company+json",
- "id": 139,
- "name": "Ibexa Sp. z o. o.",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/139",
- "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2",
- "_id": 139,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/48"
}, - "Name": "Ibexa Sp. z o. o.",
- "TranslatedName": "Ibexa Sp. z o. o.",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/139/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions/6",
- "VersionInfo": {
- "id": 677,
- "versionNo": 6,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-28T16:10:13+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-28T16:10:13+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Ibexa Sp. z o. o."
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/139"
}
}, - "Fields": {
- "field": [
- {
- "id": 673,
- "fieldDefinitionIdentifier": "active",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_boolean",
- "fieldValue": true
}, - {
- "id": 674,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Ibexa Sp. z o. o."
}, - {
- "id": 675,
- "fieldDefinitionIdentifier": "vat",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "123 456 789"
}, - {
- "id": 676,
- "fieldDefinitionIdentifier": "website",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
}, - {
- "id": 677,
- "fieldDefinitionIdentifier": "customer_group",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_customer_group",
- "fieldValue": {
- "customer_group_id": 1
}
}, - {
- "id": 678,
- "fieldDefinitionIdentifier": "sales_rep",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 14,
- "destinationContentHref": "/api/ibexa/v2/content/objects/14"
}
}, - {
- "id": 679,
- "fieldDefinitionIdentifier": "contact",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 144,
- "destinationContentHref": "/api/ibexa/v2/content/objects/144"
}
}, - {
- "id": 680,
- "fieldDefinitionIdentifier": "default_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 142,
- "destinationContentHref": "/api/ibexa/v2/content/objects/142"
}
}, - {
- "id": 681,
- "fieldDefinitionIdentifier": "billing_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_address",
- "fieldValue": {
- "name": "HQ",
- "country": "PL",
- "fields": {
- "region": "Silesia",
- "locality": "Katowice",
- "street": "Gliwicka 6/5",
- "postal_code": "40-079",
- "email": "company@email.invalid",
- "phone_number": "+48 000 000 000"
}
}
}, - {
- "id": 683,
- "fieldDefinitionIdentifier": "members",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 140,
- "destinationContentHref": "/api/ibexa/v2/content/objects/140"
}
}, - {
- "id": 682,
- "fieldDefinitionIdentifier": "address_book",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 141,
- "destinationContentHref": "/api/ibexa/v2/content/objects/141"
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions/6/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/139/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-28T16:10:13+02:00",
- "publishedDate": "2023-04-28T15:44:55+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 6,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/139/objectstates"
}
}, - "billingAddress": {
- "name": "HQ",
- "country": "PL",
- "fields": {
- "region": "Silesia",
- "locality": "Katowice",
- "street": "Gliwicka 6/5",
- "postal_code": "40-079",
- "email": "company@email.invalid",
- "phone_number": "+48 000 000 000"
}
}, - "contactId": 144,
- "salesRepresentativeId": 14,
- "defaultAddressId": 142,
- "addressBookId": 141,
- "membersId": 140,
- "MemberList": {
- "_media-type": "application/vnd.ibexa.api.MemberList+json",
- "_href": "/api/ibexa/v2/corporate/companies/139/members"
}, - "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140"
}, - "locationPath": "/1/65/140/",
- "isActive": true
}, - "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/144",
- "_id": 144,
- "_remoteId": "1b3938c16adfa29996f3afff0b4a0032",
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/47"
}, - "name": "Jay Kowalski",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions"
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140/141/145"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/144/locations"
}, - "Groups": {
- "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json",
- "_href": "/api/ibexa/v2/user/users/144/groups"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "publishDate": "2023-04-28T16:10:03+02:00",
- "lastModificationDate": "2023-04-28T16:17:07+02:00",
- "mainLanguageCode": "eng-GB",
- "alwaysAvailable": true,
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions/6",
- "VersionInfo": {
- "id": 683,
- "versionNo": 6,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-28T16:17:07+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-28T16:17:06+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Jay Kowalski"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/144"
}
}, - "Fields": {
- "field": [
- {
- "id": 698,
- "fieldDefinitionIdentifier": "first_name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Jay"
}, - {
- "id": 699,
- "fieldDefinitionIdentifier": "last_name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Kowalski"
}, - {
- "id": 700,
- "fieldDefinitionIdentifier": "phone_number",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "+48 123 123 456"
}, - {
- "id": 701,
- "fieldDefinitionIdentifier": "user",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_user",
- "fieldValue": {
- "hasStoredLogin": true,
- "contentId": 144,
- "login": "jay.kowalski",
- "email": "jay.kowalski@email.invalid",
- "passwordUpdatedAt": 1682691427,
- "enabled": false,
- "maxLogin": 5,
- "plainPassword": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/user/default_profile_image/initials.svg?initials=JK#profile_image",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}, - "login": "jay.kowalski",
- "email": "jay.kowalski@email.invalid",
- "enabled": false,
- "UserGroups": {
- "_media-type": "application/vnd.ibexa.api.UserGroupList+json",
- "_href": "/api/ibexa/v2/user/users/144/groups"
}, - "Roles": {
- "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json",
- "_href": "/api/ibexa/v2/user/users/144/roles"
}
}, - "Role": {
- "_media-type": "application/vnd.ibexa.api.Role+json",
- "_href": "/api/ibexa/v2/user/roles/15",
- "identifier": "Company Buyer",
- "Policies": {
- "_media-type": "application/vnd.ibexa.api.PolicyList+json",
- "_href": "/api/ibexa/v2/user/roles/15/policies"
}
}
}
]
}
}Creates a company member.
+| companyId required | string |
| Accept required | string If set, the new member is returned in XML or JSON format. + |
| Content-Type required | string The CompanyCreate schema encoded in XML or JSON format. + |
The new MemberCreateController resource
+required | object (MemberCreate) This class is used to create a member. + |
{- "MemberCreate": {
- "login": "string",
- "email": "string",
- "password": "string",
- "Role": {
- "_media-type": "string",
- "_href": "string"
}, - "fields": {
- "field": [
- {
- "id": 0,
- "fieldDefinitionIdentifier": "string",
- "languageCode": "string",
- "fieldTypeIdentifier": "string",
- "fieldValue": null
}
]
}
}
}{- "Member": {
- "_media-type": "application/vnd.ibexa.api.Member+json",
- "_href": "/api/ibexa/v2/corporate/companies/139/members/144",
- "id": 144,
- "name": "Jay Kowalski",
- "Company": {
- "_media-type": "application/vnd.ibexa.api.Company+json",
- "id": 139,
- "name": "Ibexa Sp. z o. o.",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/139",
- "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2",
- "_id": 139,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/48"
}, - "Name": "Ibexa Sp. z o. o.",
- "TranslatedName": "Ibexa Sp. z o. o.",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/139/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions/6",
- "VersionInfo": {
- "id": 677,
- "versionNo": 6,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-28T16:10:13+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-28T16:10:13+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Ibexa Sp. z o. o."
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/139"
}
}, - "Fields": {
- "field": [
- {
- "id": 673,
- "fieldDefinitionIdentifier": "active",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_boolean",
- "fieldValue": true
}, - {
- "id": 674,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Ibexa Sp. z o. o."
}, - {
- "id": 675,
- "fieldDefinitionIdentifier": "vat",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "123 456 789"
}, - {
- "id": 676,
- "fieldDefinitionIdentifier": "website",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
}, - {
- "id": 677,
- "fieldDefinitionIdentifier": "customer_group",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_customer_group",
- "fieldValue": {
- "customer_group_id": 1
}
}, - {
- "id": 678,
- "fieldDefinitionIdentifier": "sales_rep",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 14,
- "destinationContentHref": "/api/ibexa/v2/content/objects/14"
}
}, - {
- "id": 679,
- "fieldDefinitionIdentifier": "contact",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 144,
- "destinationContentHref": "/api/ibexa/v2/content/objects/144"
}
}, - {
- "id": 680,
- "fieldDefinitionIdentifier": "default_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 142,
- "destinationContentHref": "/api/ibexa/v2/content/objects/142"
}
}, - {
- "id": 681,
- "fieldDefinitionIdentifier": "billing_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_address",
- "fieldValue": {
- "name": "HQ",
- "country": "PL",
- "fields": {
- "region": "Silesia",
- "locality": "Katowice",
- "street": "Gliwicka 6/5",
- "postal_code": "40-079",
- "email": "company@email.invalid",
- "phone_number": "+48 000 000 000"
}
}
}, - {
- "id": 683,
- "fieldDefinitionIdentifier": "members",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 140,
- "destinationContentHref": "/api/ibexa/v2/content/objects/140"
}
}, - {
- "id": 682,
- "fieldDefinitionIdentifier": "address_book",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 141,
- "destinationContentHref": "/api/ibexa/v2/content/objects/141"
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions/6/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/139/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-28T16:10:13+02:00",
- "publishedDate": "2023-04-28T15:44:55+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 6,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/139/objectstates"
}
}, - "billingAddress": {
- "name": "HQ",
- "country": "PL",
- "fields": {
- "region": "Silesia",
- "locality": "Katowice",
- "street": "Gliwicka 6/5",
- "postal_code": "40-079",
- "email": "company@email.invalid",
- "phone_number": "+48 000 000 000"
}
}, - "contactId": 144,
- "salesRepresentativeId": 14,
- "defaultAddressId": 142,
- "addressBookId": 141,
- "membersId": 140,
- "MemberList": {
- "_media-type": "application/vnd.ibexa.api.MemberList+json",
- "_href": "/api/ibexa/v2/corporate/companies/139/members"
}, - "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140"
}, - "locationPath": "/1/65/140/",
- "isActive": true
}, - "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/144",
- "_id": 144,
- "_remoteId": "1b3938c16adfa29996f3afff0b4a0032",
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/47"
}, - "name": "Jay Kowalski",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions"
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140/141/145"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/144/locations"
}, - "Groups": {
- "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json",
- "_href": "/api/ibexa/v2/user/users/144/groups"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "publishDate": "2023-04-28T16:10:03+02:00",
- "lastModificationDate": "2023-04-28T16:17:07+02:00",
- "mainLanguageCode": "eng-GB",
- "alwaysAvailable": true,
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions/6",
- "VersionInfo": {
- "id": 683,
- "versionNo": 6,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-28T16:17:07+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-28T16:17:06+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Jay Kowalski"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/144"
}
}, - "Fields": {
- "field": [
- {
- "id": 698,
- "fieldDefinitionIdentifier": "first_name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Jay"
}, - {
- "id": 699,
- "fieldDefinitionIdentifier": "last_name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Kowalski"
}, - {
- "id": 700,
- "fieldDefinitionIdentifier": "phone_number",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "+48 123 123 456"
}, - {
- "id": 701,
- "fieldDefinitionIdentifier": "user",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_user",
- "fieldValue": {
- "hasStoredLogin": true,
- "contentId": 144,
- "login": "jay.kowalski",
- "email": "jay.kowalski@email.invalid",
- "passwordUpdatedAt": 1682691427,
- "enabled": false,
- "maxLogin": 5,
- "plainPassword": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/user/default_profile_image/initials.svg?initials=JK#profile_image",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}, - "login": "jay.kowalski",
- "email": "jay.kowalski@email.invalid",
- "enabled": false,
- "UserGroups": {
- "_media-type": "application/vnd.ibexa.api.UserGroupList+json",
- "_href": "/api/ibexa/v2/user/users/144/groups"
}, - "Roles": {
- "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json",
- "_href": "/api/ibexa/v2/user/users/144/roles"
}
}, - "Role": {
- "_media-type": "application/vnd.ibexa.api.Role+json",
- "_href": "/api/ibexa/v2/user/roles/15",
- "identifier": "Company Buyer",
- "Policies": {
- "_media-type": "application/vnd.ibexa.api.PolicyList+json",
- "_href": "/api/ibexa/v2/user/roles/15/policies"
}
}
}
}Returns the company member by given member ID.
+| companyId required | string |
| memberId required | string |
| Accept required | string If set, the company member is returned in XML or JSON format. + |
{- "Member": {
- "_media-type": "application/vnd.ibexa.api.Member+json",
- "_href": "/api/ibexa/v2/corporate/companies/139/members/144",
- "id": 144,
- "name": "Jay Kowalski",
- "Company": {
- "_media-type": "application/vnd.ibexa.api.Company+json",
- "id": 139,
- "name": "Ibexa Sp. z o. o.",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/139",
- "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2",
- "_id": 139,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/48"
}, - "Name": "Ibexa Sp. z o. o.",
- "TranslatedName": "Ibexa Sp. z o. o.",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/139/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions/6",
- "VersionInfo": {
- "id": 677,
- "versionNo": 6,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-28T16:10:13+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-28T16:10:13+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Ibexa Sp. z o. o."
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/139"
}
}, - "Fields": {
- "field": [
- {
- "id": 673,
- "fieldDefinitionIdentifier": "active",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_boolean",
- "fieldValue": true
}, - {
- "id": 674,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Ibexa Sp. z o. o."
}, - {
- "id": 675,
- "fieldDefinitionIdentifier": "vat",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "123 456 789"
}, - {
- "id": 676,
- "fieldDefinitionIdentifier": "website",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
}, - {
- "id": 677,
- "fieldDefinitionIdentifier": "customer_group",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_customer_group",
- "fieldValue": {
- "customer_group_id": 1
}
}, - {
- "id": 678,
- "fieldDefinitionIdentifier": "sales_rep",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 14,
- "destinationContentHref": "/api/ibexa/v2/content/objects/14"
}
}, - {
- "id": 679,
- "fieldDefinitionIdentifier": "contact",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 144,
- "destinationContentHref": "/api/ibexa/v2/content/objects/144"
}
}, - {
- "id": 680,
- "fieldDefinitionIdentifier": "default_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 142,
- "destinationContentHref": "/api/ibexa/v2/content/objects/142"
}
}, - {
- "id": 681,
- "fieldDefinitionIdentifier": "billing_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_address",
- "fieldValue": {
- "name": "HQ",
- "country": "PL",
- "fields": {
- "region": "Silesia",
- "locality": "Katowice",
- "street": "Gliwicka 6/5",
- "postal_code": "40-079",
- "email": "company@email.invalid",
- "phone_number": "+48 000 000 000"
}
}
}, - {
- "id": 683,
- "fieldDefinitionIdentifier": "members",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 140,
- "destinationContentHref": "/api/ibexa/v2/content/objects/140"
}
}, - {
- "id": 682,
- "fieldDefinitionIdentifier": "address_book",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 141,
- "destinationContentHref": "/api/ibexa/v2/content/objects/141"
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions/6/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/139/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-28T16:10:13+02:00",
- "publishedDate": "2023-04-28T15:44:55+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 6,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/139/objectstates"
}
}, - "billingAddress": {
- "name": "HQ",
- "country": "PL",
- "fields": {
- "region": "Silesia",
- "locality": "Katowice",
- "street": "Gliwicka 6/5",
- "postal_code": "40-079",
- "email": "company@email.invalid",
- "phone_number": "+48 000 000 000"
}
}, - "contactId": 144,
- "salesRepresentativeId": 14,
- "defaultAddressId": 142,
- "addressBookId": 141,
- "membersId": 140,
- "MemberList": {
- "_media-type": "application/vnd.ibexa.api.MemberList+json",
- "_href": "/api/ibexa/v2/corporate/companies/139/members"
}, - "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140"
}, - "locationPath": "/1/65/140/",
- "isActive": true
}, - "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/144",
- "_id": 144,
- "_remoteId": "1b3938c16adfa29996f3afff0b4a0032",
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/47"
}, - "name": "Jay Kowalski",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions"
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140/141/145"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/144/locations"
}, - "Groups": {
- "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json",
- "_href": "/api/ibexa/v2/user/users/144/groups"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "publishDate": "2023-04-28T16:10:03+02:00",
- "lastModificationDate": "2023-04-28T16:17:07+02:00",
- "mainLanguageCode": "eng-GB",
- "alwaysAvailable": true,
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions/6",
- "VersionInfo": {
- "id": 683,
- "versionNo": 6,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-28T16:17:07+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-28T16:17:06+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Jay Kowalski"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/144"
}
}, - "Fields": {
- "field": [
- {
- "id": 698,
- "fieldDefinitionIdentifier": "first_name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Jay"
}, - {
- "id": 699,
- "fieldDefinitionIdentifier": "last_name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Kowalski"
}, - {
- "id": 700,
- "fieldDefinitionIdentifier": "phone_number",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "+48 123 123 456"
}, - {
- "id": 701,
- "fieldDefinitionIdentifier": "user",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_user",
- "fieldValue": {
- "hasStoredLogin": true,
- "contentId": 144,
- "login": "jay.kowalski",
- "email": "jay.kowalski@email.invalid",
- "passwordUpdatedAt": 1682691427,
- "enabled": false,
- "maxLogin": 5,
- "plainPassword": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/user/default_profile_image/initials.svg?initials=JK#profile_image",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}, - "login": "jay.kowalski",
- "email": "jay.kowalski@email.invalid",
- "enabled": false,
- "UserGroups": {
- "_media-type": "application/vnd.ibexa.api.UserGroupList+json",
- "_href": "/api/ibexa/v2/user/users/144/groups"
}, - "Roles": {
- "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json",
- "_href": "/api/ibexa/v2/user/users/144/roles"
}
}, - "Role": {
- "_media-type": "application/vnd.ibexa.api.Role+json",
- "_href": "/api/ibexa/v2/user/roles/15",
- "identifier": "Company Buyer",
- "Policies": {
- "_media-type": "application/vnd.ibexa.api.PolicyList+json",
- "_href": "/api/ibexa/v2/user/roles/15/policies"
}
}
}
}The given company member is deleted.
+| companyId required | string |
| memberId required | string |
| Accept required | string If set, in the case of an error the error message is returned in XML or JSON format. + |
| X-CSRF-Token required | string Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session. + |
Updates a company member. PATCH or POST with header X-HTTP-Method-Override PATCH.
+| companyId required | string |
| memberId required | string |
| Accept required | string If set, the updated company member is returned in XML or JSON format. + |
| Content-Type required | string The company input schema encoded in XML or JSON. + |
| If-Match required | string ETag + |
The updated MemberUpdateController resource
+required | object (MemberUpdate) This class is used to update a member. + |
{- "MemberUpdate": {
- "email": "string",
- "password": "string",
- "enabled": true,
- "maxLogin": 0,
- "Role": {
- "_media-type": "string",
- "_href": "string"
}, - "fields": {
- "field": [
- {
- "id": 0,
- "fieldDefinitionIdentifier": "string",
- "languageCode": "string",
- "fieldTypeIdentifier": "string",
- "fieldValue": null
}
]
}
}
}{- "Member": {
- "_media-type": "application/vnd.ibexa.api.Member+json",
- "_href": "/api/ibexa/v2/corporate/companies/139/members/144",
- "id": 144,
- "name": "Jay Kowalski",
- "Company": {
- "_media-type": "application/vnd.ibexa.api.Company+json",
- "id": 139,
- "name": "Ibexa Sp. z o. o.",
- "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/139",
- "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2",
- "_id": 139,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/48"
}, - "Name": "Ibexa Sp. z o. o.",
- "TranslatedName": "Ibexa Sp. z o. o.",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/139/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions/6",
- "VersionInfo": {
- "id": 677,
- "versionNo": 6,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-28T16:10:13+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-28T16:10:13+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Ibexa Sp. z o. o."
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/139"
}
}, - "Fields": {
- "field": [
- {
- "id": 673,
- "fieldDefinitionIdentifier": "active",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_boolean",
- "fieldValue": true
}, - {
- "id": 674,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Ibexa Sp. z o. o."
}, - {
- "id": 675,
- "fieldDefinitionIdentifier": "vat",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "123 456 789"
}, - {
- "id": 676,
- "fieldDefinitionIdentifier": "website",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
}, - {
- "id": 677,
- "fieldDefinitionIdentifier": "customer_group",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_customer_group",
- "fieldValue": {
- "customer_group_id": 1
}
}, - {
- "id": 678,
- "fieldDefinitionIdentifier": "sales_rep",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 14,
- "destinationContentHref": "/api/ibexa/v2/content/objects/14"
}
}, - {
- "id": 679,
- "fieldDefinitionIdentifier": "contact",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 144,
- "destinationContentHref": "/api/ibexa/v2/content/objects/144"
}
}, - {
- "id": 680,
- "fieldDefinitionIdentifier": "default_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 142,
- "destinationContentHref": "/api/ibexa/v2/content/objects/142"
}
}, - {
- "id": 681,
- "fieldDefinitionIdentifier": "billing_address",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_address",
- "fieldValue": {
- "name": "HQ",
- "country": "PL",
- "fields": {
- "region": "Silesia",
- "locality": "Katowice",
- "street": "Gliwicka 6/5",
- "postal_code": "40-079",
- "email": "company@email.invalid",
- "phone_number": "+48 000 000 000"
}
}
}, - {
- "id": 683,
- "fieldDefinitionIdentifier": "members",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 140,
- "destinationContentHref": "/api/ibexa/v2/content/objects/140"
}
}, - {
- "id": 682,
- "fieldDefinitionIdentifier": "address_book",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_object_relation",
- "fieldValue": {
- "destinationContentId": 141,
- "destinationContentHref": "/api/ibexa/v2/content/objects/141"
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/139/versions/6/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/139/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-04-28T16:10:13+02:00",
- "publishedDate": "2023-04-28T15:44:55+02:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 6,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/139/objectstates"
}
}, - "billingAddress": {
- "name": "HQ",
- "country": "PL",
- "fields": {
- "region": "Silesia",
- "locality": "Katowice",
- "street": "Gliwicka 6/5",
- "postal_code": "40-079",
- "email": "company@email.invalid",
- "phone_number": "+48 000 000 000"
}
}, - "contactId": 144,
- "salesRepresentativeId": 14,
- "defaultAddressId": 142,
- "addressBookId": 141,
- "membersId": 140,
- "MemberList": {
- "_media-type": "application/vnd.ibexa.api.MemberList+json",
- "_href": "/api/ibexa/v2/corporate/companies/139/members"
}, - "Location": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140"
}, - "locationPath": "/1/65/140/",
- "isActive": true
}, - "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/144",
- "_id": 144,
- "_remoteId": "1b3938c16adfa29996f3afff0b4a0032",
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/47"
}, - "name": "Jay Kowalski",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions"
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/65/140/141/145"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/144/locations"
}, - "Groups": {
- "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json",
- "_href": "/api/ibexa/v2/user/users/144/groups"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "publishDate": "2023-04-28T16:10:03+02:00",
- "lastModificationDate": "2023-04-28T16:17:07+02:00",
- "mainLanguageCode": "eng-GB",
- "alwaysAvailable": true,
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions/6",
- "VersionInfo": {
- "id": 683,
- "versionNo": 6,
- "status": "PUBLISHED",
- "modificationDate": "2023-04-28T16:17:07+02:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-04-28T16:17:06+02:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Jay Kowalski"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/144"
}
}, - "Fields": {
- "field": [
- {
- "id": 698,
- "fieldDefinitionIdentifier": "first_name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Jay"
}, - {
- "id": 699,
- "fieldDefinitionIdentifier": "last_name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Kowalski"
}, - {
- "id": 700,
- "fieldDefinitionIdentifier": "phone_number",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "+48 123 123 456"
}, - {
- "id": 701,
- "fieldDefinitionIdentifier": "user",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_user",
- "fieldValue": {
- "hasStoredLogin": true,
- "contentId": 144,
- "login": "jay.kowalski",
- "email": "jay.kowalski@email.invalid",
- "passwordUpdatedAt": 1682691427,
- "enabled": false,
- "maxLogin": 5,
- "plainPassword": null
}
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/user/default_profile_image/initials.svg?initials=JK#profile_image",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}, - "login": "jay.kowalski",
- "email": "jay.kowalski@email.invalid",
- "enabled": false,
- "UserGroups": {
- "_media-type": "application/vnd.ibexa.api.UserGroupList+json",
- "_href": "/api/ibexa/v2/user/users/144/groups"
}, - "Roles": {
- "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json",
- "_href": "/api/ibexa/v2/user/users/144/roles"
}
}, - "Role": {
- "_media-type": "application/vnd.ibexa.api.Role+json",
- "_href": "/api/ibexa/v2/user/roles/15",
- "identifier": "Company Buyer",
- "Policies": {
- "_media-type": "application/vnd.ibexa.api.PolicyList+json",
- "_href": "/api/ibexa/v2/user/roles/15/policies"
}
}
}
}Returns paginated list of available sales representatives.
+| Accept required | string If set, helps to determine response format. + |
{- "SalesRepresentativesList": {
- "_media-type": "application/vnd.ibexa.api.SalesRepresentativesList+json",
- "users": [
- {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/75",
- "_id": 75,
- "_remoteId": "f262e2fa12ae105b78a1b654e87a0874",
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/4"
}, - "name": "John Black",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/75/versions"
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/10"
}, - "MainLocation": {
- "_media-type": "application/vnd.ibexa.api.Location+json",
- "_href": "/api/ibexa/v2/content/locations/1/5/64/76"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/75/locations"
}, - "Groups": {
- "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json",
- "_href": "/api/ibexa/v2/user/users/75/groups"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "publishDate": "2023-06-20T07:33:17+00:00",
- "lastModificationDate": "2023-06-20T07:33:17+00:00",
- "mainLanguageCode": "eng-GB",
- "alwaysAvailable": true,
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/75/versions/1",
- "VersionInfo": {
- "id": 536,
- "versionNo": 1,
- "status": "PUBLISHED",
- "modificationDate": "2023-06-20T07:33:17+00:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-06-20T07:33:17+00:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "John Black"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/75"
}
}, - "Fields": {
- "field": [
- {
- "id": 339,
- "fieldDefinitionIdentifier": "first_name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "John"
}, - {
- "id": 340,
- "fieldDefinitionIdentifier": "last_name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Black"
}, - {
- "id": 341,
- "fieldDefinitionIdentifier": "user_account",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_user",
- "fieldValue": {
- "hasStoredLogin": true,
- "contentId": 75,
- "login": "John Black",
- "email": "j.black@ibexa.co",
- "passwordUpdatedAt": 1687246397,
- "enabled": true,
- "maxLogin": 0,
- "plainPassword": null
}
}, - {
- "id": 342,
- "fieldDefinitionIdentifier": "signature",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_text",
- "fieldValue": null
}, - {
- "id": 343,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image",
- "fieldValue": null
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/75/versions/1/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/user/default_profile_image/initials.svg?initials=JB#profile_image",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}, - "login": "John Black",
- "email": "j.black@ibexa.co",
- "enabled": true,
- "UserGroups": {
- "_media-type": "application/vnd.ibexa.api.UserGroupList+json",
- "_href": "/api/ibexa/v2/user/users/75/groups"
}, - "Roles": {
- "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json",
- "_href": "/api/ibexa/v2/user/users/75/roles"
}
}
]
}
}Lists last activity log groups and their entries.
+| Accept required | string If set, the list is returned in XML or JSON format. + |
{- "ActivityLogGroupList": {
- "_media-type": "application/vnd.ibexa.api.ActivityLogGroupList+json",
- "_href": "/api/ibexa/v2/activity-log-group/list",
- "ActivityLogGroups": [
- {
- "_media-type": "application/vnd.ibexa.api.ActivityLogGroup+json",
- "user_id": 14,
- "logged_at": 1707478796,
- "ActivityLogEntries": [
- {
- "_media-type": "application/vnd.ibexa.api.ActivityLog+json",
- "object_id": "396",
- "object_class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content",
- "action": "create",
- "data": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.ActivityLog+json",
- "object_id": "396",
- "object_class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content",
- "action": "publish",
- "data": [ ]
}
]
}, - {
- "_media-type": "application/vnd.ibexa.api.ActivityLogGroup+json",
- "user_id": 14,
- "logged_at": 1707475048,
- "ActivityLogEntries": [
- {
- "_media-type": "application/vnd.ibexa.api.ActivityLog+json",
- "object_id": "395",
- "object_class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content",
- "action": "create",
- "data": [ ]
}, - {
- "_media-type": "application/vnd.ibexa.api.ActivityLog+json",
- "object_id": "395",
- "object_class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content",
- "action": "publish",
- "data": [ ]
}
]
}
]
}
}Creates Cart from payload.
+| Content-Type required | string The CartCreate schema encoded in XML or JSON format. + |
| Accept required | string If set, the created Cart is returned in XML or JSON format. + |
The new CartCreateController resource
+required | object (CartCreate) This class represents a new Cart to create + |
{- "CartCreate": {
- "name": "string",
- "currencyCode": "string",
- "context": { }
}
}{- "Cart": {
- "_media-type": "application/vnd.ibexa.api.Cart+json",
- "id": 12,
- "identifier": "fafccc4b-cce1-40d7-8d23-29ad41638581",
- "name": "Default",
- "createdAt": "2023-10-12T10:02:51+00:00",
- "updatedAt": "2023-10-12T10:02:51+00:00",
- "owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}, - "entries": [ ]
}
}Executes a query and returns a View including the results.
+| Accept required | string The CartView schema is returned in XML or JSON format. + |
| Content-Type required | string The CartViewInput schema is posted in XML or JSON format. + |
The new CartViewController resource
+required | object (CartViewInput) This class represents a cart view input. + |
{- "CartViewInput": {
- "identifier": "string",
- "CartQuery": { }
}
}{- "CartView": {
- "identifier": "string",
- "Result": {
- "count": 0,
- "Result": { }
}
}
}Gets Cart by its identifier.
+| identifier required | string |
| Accept required | string The Cart is returned in XML or JSON format. + |
{- "Cart": {
- "_media-type": "application/vnd.ibexa.api.Cart+json",
- "id": 12,
- "identifier": "fafccc4b-cce1-40d7-8d23-29ad41638581",
- "name": "Default",
- "createdAt": "2023-10-12T10:02:51+00:00",
- "updatedAt": "2023-10-12T10:02:51+00:00",
- "owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}, - "entries": [ ]
}
}Updates identified Cart's metadata from payload.
+| identifier required | string |
| Content-Type required | string The CartMetadataUpdate schema encoded in XML or JSON format. + |
| Accept required | string If set, the updated Cart is returned in XML or JSON format. + |
The updated CartUpdateController resource
+required | object (CartMetadataUpdate) This class represents the update of cart metadata. + |
{- "CartMetadataUpdate": {
- "identifier": "string",
- "defaultLanguageCode": "string",
- "names": [
- {
- "_languageCode": "string",
- "#text": "string"
}
], - "descriptions": [
- {
- "_languageCode": "string",
- "#text": "string"
}
]
}
}{- "Cart": {
- "id": 0,
- "identifier": "string",
- "owner": {
- "_media-type": "string",
- "_href": "string"
}, - "Currency": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "code": "string",
- "subunits": 0,
- "enabled": true
}, - "entries": [
- {
- "identifier": "string",
- "id": 0,
- "names": [
- { }
], - "quantity": 0,
- "Price": {
- "_media-type": "string",
- "_href": "string",
- "amount": "string",
- "base_amount": "string",
- "Currency": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "code": "string",
- "subunits": 0,
- "enabled": true
}, - "money": "string",
- "base_money": "string"
}
}
]
}
}Adds an entry to the cart referenced by its identifier
+| identifier required | string |
| Content-Type required | string The CartEntryAdd schema encoded in XML or JSON format. + |
| Accept required | string If set, the updated Cart is returned in XML or JSON format. + |
The new CartEntryCreateController resource
+required | object (CartEntryAdd) This class represents a cart entry + |
{- "CartEntryAdd": {
- "quantity": 0,
- "Product": null,
- "context": { }
}
}{- "Cart": {
- "id": 0,
- "identifier": "string",
- "owner": {
- "_media-type": "string",
- "_href": "string"
}, - "Currency": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "code": "string",
- "subunits": 0,
- "enabled": true
}, - "entries": [
- {
- "identifier": "string",
- "id": 0,
- "names": [
- { }
], - "quantity": 0,
- "Price": {
- "_media-type": "string",
- "_href": "string",
- "amount": "string",
- "base_amount": "string",
- "Currency": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "code": "string",
- "subunits": 0,
- "enabled": true
}, - "money": "string",
- "base_money": "string"
}
}
]
}
}Removes the given entry from the given Cart.
+| identifier required | string |
| entryId required | string |
| Accept required | string If set, the updated Cart is returned in XML or JSON format. + |
{- "Cart": {
- "id": 0,
- "identifier": "string",
- "owner": {
- "_media-type": "string",
- "_href": "string"
}, - "Currency": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "code": "string",
- "subunits": 0,
- "enabled": true
}, - "entries": [
- {
- "identifier": "string",
- "id": 0,
- "names": [
- { }
], - "quantity": 0,
- "Price": {
- "_media-type": "string",
- "_href": "string",
- "amount": "string",
- "base_amount": "string",
- "Currency": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "code": "string",
- "subunits": 0,
- "enabled": true
}, - "money": "string",
- "base_money": "string"
}
}
]
}
}Updates the given entry from the given Cart.
+| identifier required | string |
| entryId required | string |
| Content-Type required | string The CartEntryUpdate schema encoded in XML or JSON format. + |
| Accept required | string If set, the updated Cart is returned in XML or JSON format. + |
The updated CartEntryUpdateController resource
+required | object (CartEntryUpdate) |
{- "CartEntryUpdate": {
- "quantity": 0,
- "context": { }
}
}{- "Cart": {
- "id": 0,
- "identifier": "string",
- "owner": {
- "_media-type": "string",
- "_href": "string"
}, - "Currency": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "code": "string",
- "subunits": 0,
- "enabled": true
}, - "entries": [
- {
- "identifier": "string",
- "id": 0,
- "names": [
- { }
], - "quantity": 0,
- "Price": {
- "_media-type": "string",
- "_href": "string",
- "amount": "string",
- "base_amount": "string",
- "Currency": {
- "_media-type": "string",
- "_href": "string",
- "id": 0,
- "code": "string",
- "subunits": 0,
- "enabled": true
}, - "money": "string",
- "base_money": "string"
}
}
]
}
}Gets a summary of the given Cart.
+| identifier required | string |
| Accept required | string If set, the Cart Summary is returned in XML or JSON format. + |
{- "CartSummary": {
- "_media-type": "application/vnd.ibexa.api.CartSummary+json",
- "_href": "/api/ibexa/v2/cart/fdfb2e95-b0b9-4f17-b0cc-08d4d2cfd8f1/summary",
- "id": 1,
- "identifier": "fdfb2e95-b0b9-4f17-b0cc-08d4d2cfd8f1",
- "name": "Updated",
- "createdAt": "2023-01-10T12:48:40+00:00",
- "updatedAt": "2023-01-10T12:49:10+00:00",
- "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "SummaryEntryCollection": {
- "_media-type": "application/vnd.ibexa.api.SummaryEntryCollection+json",
- "count": "1",
- "SummaryEntry": [
- {
- "_media-type": "application/vnd.ibexa.api.CartSummaryEntry+json",
- "identifier": "ddf3d7bf-ca17-4eff-8265-2d7e00877a91",
- "id": 1,
- "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Flipper Zero"
}
]
}, - "quantity": 2,
- "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "RestPrice": {
- "_media-type": "application/vnd.ibexa.api.RestPrice+json",
- "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "100",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}
}, - "formatted": "€1.00"
}
}, - "PriceInclVat": {
- "_media-type": "application/vnd.ibexa.api.PriceInclVat+json",
- "RestPrice": {
- "_media-type": "application/vnd.ibexa.api.RestPrice+json",
- "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "12300",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}
}, - "formatted": "€123.00"
}
}, - "SubtotalPrice": {
- "_media-type": "application/vnd.ibexa.api.SubtotalPrice+json",
- "RestPrice": {
- "_media-type": "application/vnd.ibexa.api.RestPrice+json",
- "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "20000",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}
}, - "formatted": "€200.00"
}
}, - "SubtotalPriceInclVat": {
- "_media-type": "application/vnd.ibexa.api.SubtotalPriceInclVat+json",
- "RestPrice": {
- "_media-type": "application/vnd.ibexa.api.RestPrice+json",
- "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "24600",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}
}, - "formatted": "€246.00"
}
}, - "VatCategory": {
- "_media-type": "application/vnd.ibexa.api.VatCategory+json",
- "identifier": "default",
- "region": "poland",
- "vatValue": 23
}, - "Product": {
- "_media-type": "application/vnd.ibexa.api.Product+json",
- "code": "0001",
- "name": "Flipper Zero",
- "ProductType": {
- "_media-type": "application/vnd.ibexa.api.ProductType+json",
- "identifier": "tool",
- "name": "Tool",
- "AttributeAssignmentList": [ ]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.Content+json",
- "_href": "/api/ibexa/v2/content/objects/67",
- "_remoteId": "3a12e8a3480143ce0159a55e152533b1",
- "_id": 67,
- "ContentType": {
- "_media-type": "application/vnd.ibexa.api.ContentType+json",
- "_href": "/api/ibexa/v2/content/types/50"
}, - "Name": "Flipper Zero",
- "TranslatedName": "Flipper Zero",
- "Versions": {
- "_media-type": "application/vnd.ibexa.api.VersionList+json",
- "_href": "/api/ibexa/v2/content/objects/67/versions"
}, - "CurrentVersion": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/67/currentversion",
- "Version": {
- "_media-type": "application/vnd.ibexa.api.Version+json",
- "_href": "/api/ibexa/v2/content/objects/67/versions/1",
- "VersionInfo": {
- "id": 527,
- "versionNo": 1,
- "status": "PUBLISHED",
- "modificationDate": "2023-01-10T12:44:41+00:00",
- "Creator": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "creationDate": "2023-01-10T12:44:41+00:00",
- "initialLanguageCode": "eng-GB",
- "languageCodes": "eng-GB",
- "VersionTranslationInfo": {
- "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
- "Language": [
- {
- "languageCode": "eng-GB"
}
]
}, - "names": {
- "value": [
- {
- "_languageCode": "eng-GB",
- "#text": "Flipper Zero"
}
]
}, - "Content": {
- "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
- "_href": "/api/ibexa/v2/content/objects/67"
}
}, - "Fields": {
- "field": [
- {
- "id": 300,
- "fieldDefinitionIdentifier": "name",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_string",
- "fieldValue": "Flipper Zero"
}, - {
- "id": 301,
- "fieldDefinitionIdentifier": "product_specification",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_product_specification",
- "fieldValue": {
- "id": 1,
- "code": "0001",
- "attributes": [ ]
}
}, - {
- "id": 302,
- "fieldDefinitionIdentifier": "description",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_richtext",
- "fieldValue": {
- "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n",
- "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n"
}
}, - {
- "id": 303,
- "fieldDefinitionIdentifier": "image",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_image_asset",
- "fieldValue": {
- "destinationContentId": null,
- "alternativeText": null,
- "source": null
}
}, - {
- "id": 304,
- "fieldDefinitionIdentifier": "category",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment",
- "fieldValue": {
- "taxonomy_entries": [
- 3
], - "taxonomy": "product_categories"
}
}, - {
- "id": 305,
- "fieldDefinitionIdentifier": "field_63bd5d67f1817",
- "languageCode": "eng-GB",
- "fieldTypeIdentifier": "ibexa_seo",
- "fieldValue": ""
}
]
}, - "Relations": {
- "_media-type": "application/vnd.ibexa.api.RelationList+json",
- "_href": "/api/ibexa/v2/content/objects/67/versions/1/relations",
- "Relation": [ ]
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}
}
}, - "Section": {
- "_media-type": "application/vnd.ibexa.api.Section+json",
- "_href": "/api/ibexa/v2/content/sections/1"
}, - "Locations": {
- "_media-type": "application/vnd.ibexa.api.LocationList+json",
- "_href": "/api/ibexa/v2/content/objects/67/locations"
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "lastModificationDate": "2023-01-10T12:44:41+00:00",
- "publishedDate": "2023-01-10T12:44:41+00:00",
- "mainLanguageCode": "eng-GB",
- "currentVersionNo": 1,
- "alwaysAvailable": true,
- "isHidden": false,
- "status": "PUBLISHED",
- "ObjectStates": {
- "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
- "_href": "/api/ibexa/v2/content/objects/67/objectstates"
}
}, - "Thumbnail": {
- "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
- "resource": "/placeholder",
- "width": null,
- "height": null,
- "mimeType": "image/svg+xml"
}, - "created_at": 1673354681,
- "updated_at": 1673354681,
- "AttributesList": [ ],
- "Availability": {
- "_media-type": "application/vnd.ibexa.api.Availability+json",
- "is_available": true,
- "stock": 100,
- "is_infinite": false
}, - "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "100.00",
- "base_amount": "100.00",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}, - "money": "10000",
- "base_money": "10000"
}
}
}
]
}, - "TotalPrice": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "RestPrice": {
- "_media-type": "application/vnd.ibexa.api.RestPrice+json",
- "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "20000",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}
}, - "formatted": "€200.00"
}
}, - "TotalPriceInclVat": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "RestPrice": {
- "_media-type": "application/vnd.ibexa.api.RestPrice+json",
- "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "24600",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}
}, - "formatted": "€246.00"
}
}, - "vatCategorySummary": [
- {
- "_media-type": "application/vnd.ibexa.api.VatCategorySummary+json",
- "VatCategory": {
- "_media-type": "application/vnd.ibexa.api.VatCategory+json",
- "identifier": "default",
- "region": "poland",
- "vatValue": 23
}, - "RestPrice": {
- "_media-type": "application/vnd.ibexa.api.RestPrice+json",
- "Price": {
- "_media-type": "application/vnd.ibexa.api.Price+json",
- "amount": "4600",
- "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}
}, - "formatted": "€46.00"
}
}
], - "Currency": {
- "_media-type": "application/vnd.ibexa.api.Currency+json",
- "id": 2,
- "code": "EUR",
- "subunits": 2,
- "enabled": true
}
}
}Loads an order by its identifier (UUID).
+| identifier required | string |
| Accept required | string Order - If set, the order returned in XML or JSON format. + |
{- "Order": {
- "_media-type": "application/vnd.ibexa.api.Order+json",
- "id": 2,
- "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898",
- "created": {
- "date": "2023-04-18 09:06:02.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "modified": {
- "date": "2023-04-18 09:06:02.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "status": "pending",
- "OrderUser": {
- "_media-type": "application/vnd.ibexa.api.OrderUser+json",
- "id": 14,
- "name": "Administrator",
- "email": "aa@aa.aa"
}, - "OrderCurrency": {
- "_media-type": "application/vnd.ibexa.api.OrderCurrency+json",
- "id": 1,
- "code": "EUR"
}, - "OrderValue": {
- "_media-type": "application/vnd.ibexa.api.OrderValue+json",
- "vat": {
- "amount": "10",
- "currency": "EUR"
}, - "total_gross": {
- "amount": "10",
- "currency": "EUR"
}, - "total_net": {
- "amount": "10",
- "currency": "EUR"
}
}, - "OrderCompany": {
- "_media-type": "application/vnd.ibexa.api.OrderCompany+json",
- "id": 68,
- "name": "Apple"
}, - "OrderItemsList": [
- {
- "_media-type": "application/vnd.ibexa.api.OrderItem+json",
- "quantity": 10,
- "OrderItemValue": {
- "_media-type": "application/vnd.ibexa.api.OrderItemValue+json",
- "unit_price_gross": {
- "amount": "110",
- "currency": "EUR"
}, - "unit_price_net": {
- "amount": "100",
- "currency": "EUR"
}, - "vat_rate": "10.00",
- "subtotal_price_gross": {
- "amount": "1100",
- "currency": "EUR"
}, - "subtotal_price_net": {
- "amount": "1000",
- "currency": "EUR"
}
}, - "OrderItemProduct": {
- "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json",
- "id": 1,
- "code": "test",
- "name": "Test"
}, - "context": {
- "foo": "bar",
- "baz": true
}
}
], - "context": {
- "foo": "bar",
- "baz": 123
}
}
}Loads an order by its numerical ID.
+| id required | string |
| Accept required | string Order - If set, the order returned in XML or JSON format. + |
{- "Order": {
- "_media-type": "application/vnd.ibexa.api.Order+json",
- "id": 2,
- "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898",
- "created": {
- "date": "2023-04-18 09:06:02.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "modified": {
- "date": "2023-04-18 09:06:02.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "status": "pending",
- "OrderUser": {
- "_media-type": "application/vnd.ibexa.api.OrderUser+json",
- "id": 14,
- "name": "Administrator",
- "email": "aa@aa.aa"
}, - "OrderCurrency": {
- "_media-type": "application/vnd.ibexa.api.OrderCurrency+json",
- "id": 1,
- "code": "EUR"
}, - "OrderValue": {
- "_media-type": "application/vnd.ibexa.api.OrderValue+json",
- "vat": {
- "amount": "10",
- "currency": "EUR"
}, - "total_gross": {
- "amount": "10",
- "currency": "EUR"
}, - "total_net": {
- "amount": "10",
- "currency": "EUR"
}
}, - "OrderCompany": {
- "_media-type": "application/vnd.ibexa.api.OrderCompany+json",
- "id": 68,
- "name": "Apple"
}, - "OrderItemsList": [
- {
- "_media-type": "application/vnd.ibexa.api.OrderItem+json",
- "quantity": 10,
- "OrderItemValue": {
- "_media-type": "application/vnd.ibexa.api.OrderItemValue+json",
- "unit_price_gross": {
- "amount": "110",
- "currency": "EUR"
}, - "unit_price_net": {
- "amount": "100",
- "currency": "EUR"
}, - "vat_rate": "10.00",
- "subtotal_price_gross": {
- "amount": "1100",
- "currency": "EUR"
}, - "subtotal_price_net": {
- "amount": "1000",
- "currency": "EUR"
}
}, - "OrderItemProduct": {
- "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json",
- "id": 1,
- "code": "test",
- "name": "Test"
}, - "context": {
- "foo": "bar",
- "baz": true
}
}
], - "context": {
- "foo": "bar",
- "baz": 123
}
}
}Updates an order.
+| id required | string |
| Accept required | string If set, the updated order is returned in XML or JSON format. + |
| Content-Type required | string The OrderUpdate schema encoded in XML or JSON format. + |
The updated OrderUpdateController resource
+required | object (OrderUpdate) This class is used to update order. + |
{- "OrderUpdate": {
- "status": "string",
- "transition": "string"
}
}{- "Order": {
- "_media-type": "application/vnd.ibexa.api.Order+json",
- "id": 2,
- "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898",
- "created": {
- "date": "2023-04-18 09:06:02.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "modified": {
- "date": "2023-04-18 09:06:02.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "status": "pending",
- "OrderUser": {
- "_media-type": "application/vnd.ibexa.api.OrderUser+json",
- "id": 14,
- "name": "Administrator",
- "email": "aa@aa.aa"
}, - "OrderCurrency": {
- "_media-type": "application/vnd.ibexa.api.OrderCurrency+json",
- "id": 1,
- "code": "EUR"
}, - "OrderValue": {
- "_media-type": "application/vnd.ibexa.api.OrderValue+json",
- "vat": {
- "amount": "10",
- "currency": "EUR"
}, - "total_gross": {
- "amount": "10",
- "currency": "EUR"
}, - "total_net": {
- "amount": "10",
- "currency": "EUR"
}
}, - "OrderCompany": {
- "_media-type": "application/vnd.ibexa.api.OrderCompany+json",
- "id": 68,
- "name": "Apple"
}, - "OrderItemsList": [
- {
- "_media-type": "application/vnd.ibexa.api.OrderItem+json",
- "quantity": 10,
- "OrderItemValue": {
- "_media-type": "application/vnd.ibexa.api.OrderItemValue+json",
- "unit_price_gross": {
- "amount": "110",
- "currency": "EUR"
}, - "unit_price_net": {
- "amount": "100",
- "currency": "EUR"
}, - "vat_rate": "10.00",
- "subtotal_price_gross": {
- "amount": "1100",
- "currency": "EUR"
}, - "subtotal_price_net": {
- "amount": "1000",
- "currency": "EUR"
}
}, - "OrderItemProduct": {
- "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json",
- "id": 1,
- "code": "test",
- "name": "Test"
}, - "context": {
- "foo": "bar",
- "baz": true
}
}
], - "context": {
- "foo": "bar",
- "baz": 123
}
}
}Loads a list of orders.
+| Accept required | string OrderList - If set, the orders list returned in XML or JSON format. + |
{- "OrderList": {
- "_media-type": "application/vnd.ibexa.api.OrderList+json",
- "Order": [
- {
- "_media-type": "application/vnd.ibexa.api.Order+json",
- "id": 2,
- "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898",
- "created": {
- "date": "2023-04-18 09:06:02.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "modified": {
- "date": "2023-04-18 09:06:02.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "status": "pending",
- "OrderUser": {
- "_media-type": "application/vnd.ibexa.api.OrderUser+json",
- "id": 14,
- "name": "Administrator",
- "email": "aa@aa.aa"
}, - "OrderCurrency": {
- "_media-type": "application/vnd.ibexa.api.OrderCurrency+json",
- "id": 1,
- "code": "EUR"
}, - "OrderValue": {
- "_media-type": "application/vnd.ibexa.api.OrderValue+json",
- "vat": {
- "amount": "10",
- "currency": "EUR"
}, - "total_gross": {
- "amount": "10",
- "currency": "EUR"
}, - "total_net": {
- "amount": "10",
- "currency": "EUR"
}
}, - "OrderCompany": {
- "_media-type": "application/vnd.ibexa.api.OrderCompany+json",
- "id": 68,
- "name": "Apple"
}, - "OrderItemsList": [
- {
- "_media-type": "application/vnd.ibexa.api.OrderItem+json",
- "quantity": 10,
- "OrderItemValue": {
- "_media-type": "application/vnd.ibexa.api.OrderItemValue+json",
- "unit_price_gross": {
- "amount": "110",
- "currency": "EUR"
}, - "unit_price_net": {
- "amount": "100",
- "currency": "EUR"
}, - "vat_rate": "10.00",
- "subtotal_price_gross": {
- "amount": "1100",
- "currency": "EUR"
}, - "subtotal_price_net": {
- "amount": "1000",
- "currency": "EUR"
}
}, - "OrderItemProduct": {
- "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json",
- "id": 1,
- "code": "test",
- "name": "Test"
}, - "context": {
- "foo": "bar",
- "baz": true
}
}
], - "context": {
- "foo": "bar",
- "baz": 123
}
}, - {
- "_media-type": "application/vnd.ibexa.api.Order+json",
- "id": 3,
- "identifier": "79b20ac4-fe23-4566-a9c2-b81966431026",
- "created": {
- "date": "2023-04-18 09:44:34.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "modified": {
- "date": "2023-04-18 09:44:34.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "status": "pending",
- "OrderUser": {
- "_media-type": "application/vnd.ibexa.api.OrderUser+json",
- "id": 14,
- "name": "Administrator",
- "email": "aa@aa.aa"
}, - "OrderCurrency": {
- "_media-type": "application/vnd.ibexa.api.OrderCurrency+json",
- "id": 1,
- "code": "EUR"
}, - "OrderValue": {
- "_media-type": "application/vnd.ibexa.api.OrderValue+json",
- "vat": {
- "amount": "10",
- "currency": "EUR"
}, - "total_gross": {
- "amount": "10",
- "currency": "EUR"
}, - "total_net": {
- "amount": "10",
- "currency": "EUR"
}
}, - "OrderCompany": {
- "_media-type": "application/vnd.ibexa.api.OrderCompany+json",
- "id": 68,
- "name": "Apple"
}, - "OrderItemsList": [
- {
- "_media-type": "application/vnd.ibexa.api.OrderItem+json",
- "quantity": 10,
- "OrderItemValue": {
- "_media-type": "application/vnd.ibexa.api.OrderItemValue+json",
- "unit_price_gross": {
- "amount": "110",
- "currency": "EUR"
}, - "unit_price_net": {
- "amount": "100",
- "currency": "EUR"
}, - "vat_rate": "10.00",
- "subtotal_price_gross": {
- "amount": "1100",
- "currency": "EUR"
}, - "subtotal_price_net": {
- "amount": "1000",
- "currency": "EUR"
}
}, - "OrderItemProduct": {
- "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json",
- "id": 1,
- "code": "test",
- "name": "Test"
}, - "context": {
- "foo": "bar",
- "baz": true
}
}
], - "context": {
- "foo": "bar",
- "baz": 123
}
}
]
}
}Creates a new order.
+| Accept required | string If set, the new order is returned in JSON format. + |
| Content-Type required | string The Order schema encoded in XML or JSON format. + |
The new OrderCreateController resource
+required | object (OrderCreate) This class is used to create order. + |
{- "OrderCreate": {
- "source": "string",
- "OrderUser": {
- "id": null,
- "name": "string",
- "email": "string"
}, - "OrderCurrency": {
- "id": 0,
- "code": "string"
}, - "OrderValue": {
- "vat": "string",
- "total_gross": "string",
- "total_net": "string"
}, - "OrderCompany": {
- "id": 0,
- "name": "string"
}, - "items": [
- {
- "OrderItem": {
- "OrderItemValue": {
- "unit_price_gross": "string",
- "unit_price_net": "string",
- "vat_rate": "string",
- "subtotal_price_gross": "string",
- "subtotal_price_net": "string"
}, - "OrderItemProduct": {
- "id": 0,
- "code": "string",
- "name": "string"
}, - "quantity": 0,
- "context": { }
}
}
]
}
}{- "Order": {
- "_media-type": "application/vnd.ibexa.api.Order+json",
- "id": 2,
- "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898",
- "created": {
- "date": "2023-04-18 09:06:02.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "modified": {
- "date": "2023-04-18 09:06:02.000000",
- "timezone_type": 3,
- "timezone": "UTC"
}, - "status": "pending",
- "OrderUser": {
- "_media-type": "application/vnd.ibexa.api.OrderUser+json",
- "id": 14,
- "name": "Administrator",
- "email": "aa@aa.aa"
}, - "OrderCurrency": {
- "_media-type": "application/vnd.ibexa.api.OrderCurrency+json",
- "id": 1,
- "code": "EUR"
}, - "OrderValue": {
- "_media-type": "application/vnd.ibexa.api.OrderValue+json",
- "vat": {
- "amount": "10",
- "currency": "EUR"
}, - "total_gross": {
- "amount": "10",
- "currency": "EUR"
}, - "total_net": {
- "amount": "10",
- "currency": "EUR"
}
}, - "OrderCompany": {
- "_media-type": "application/vnd.ibexa.api.OrderCompany+json",
- "id": 68,
- "name": "Apple"
}, - "OrderItemsList": [
- {
- "_media-type": "application/vnd.ibexa.api.OrderItem+json",
- "quantity": 10,
- "OrderItemValue": {
- "_media-type": "application/vnd.ibexa.api.OrderItemValue+json",
- "unit_price_gross": {
- "amount": "110",
- "currency": "EUR"
}, - "unit_price_net": {
- "amount": "100",
- "currency": "EUR"
}, - "vat_rate": "10.00",
- "subtotal_price_gross": {
- "amount": "1100",
- "currency": "EUR"
}, - "subtotal_price_net": {
- "amount": "1000",
- "currency": "EUR"
}
}, - "OrderItemProduct": {
- "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json",
- "id": 1,
- "code": "test",
- "name": "Test"
}, - "context": {
- "foo": "bar",
- "baz": true
}
}
], - "context": {
- "foo": "bar",
- "baz": 123
}
}
}Creates a PaymentMethodCreateController resource.
+| Accept required | string If set, the created Payment Method is returned in XML or JSON format. + |
| Content-Type required | string The Payment Method input schema encoded in XML or JSON. + |
The new PaymentMethodCreateController resource
+required | object (PaymentMethodCreateStruct) |
{- "PaymentMethodCreateStruct": {
- "identifier": "string",
- "type": "string",
- "names": { },
- "descriptions": [
- "string"
], - "enabled": true,
- "options": { }
}
}{- "PaymentMethod": {
- "_media-type": "application/vnd.ibexa.api.PaymentMethod+json",
- "identifier": "bank_transfer",
- "id": 1,
- "enabled": true,
- "name": "Bank transfer",
- "description": "Bank transfer"
}
}Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.
+| Accept required | string The view in XML or JSON format. + |
| Content-Type required | string The view input in XML or JSON format. + |
The new PaymentMethodFindController resource
+required | object (PaymentMethodViewInput) |
{- "PaymentMethodViewInput": {
- "identifier": "string",
- "PaymentMethodQuery": { }
}
}{- "PaymentMethodView": {
- "_media-type": "application/vnd.ibexa.api.PaymentMethodView+json",
- "identifier": "example",
- "Result": {
- "_media-type": "application/vnd.ibexa.api.ViewResult+json",
- "count": 4,
- "PaymentMethodList": [
- {
- "_media-type": "application/vnd.ibexa.api.PaymentMethod+json",
- "identifier": "bank_transfer",
- "id": 1,
- "enabled": true,
- "name": "Bank transfer",
- "description": "Bank transfer"
}, - {
- "_media-type": "application/vnd.ibexa.api.PaymentMethod+json",
- "identifier": "cash_on_delivery",
- "id": 2,
- "enabled": true,
- "name": "Cash on delivery",
- "description": "Cash on delivery"
}, - {
- "_media-type": "application/vnd.ibexa.api.PaymentMethod+json",
- "identifier": "invoice",
- "id": 3,
- "enabled": true,
- "name": "Invoice",
- "description": "Invoice"
}, - {
- "_media-type": "application/vnd.ibexa.api.PaymentMethod+json",
- "identifier": "paypal",
- "id": 4,
- "enabled": true,
- "name": "PayPal",
- "description": "PayPal"
}
]
}
}
}Loads an payment method by its identifier.
+| identifier required | string |
| Accept required | string Payment Method - If set, the payment method returned in XML or JSON format. + |
{- "PaymentMethod": {
- "_media-type": "application/vnd.ibexa.api.PaymentMethod+json",
- "identifier": "bank_transfer",
- "id": 1,
- "enabled": true,
- "name": "Bank transfer",
- "description": "Bank transfer"
}
}Updates the PaymentMethodUpdateController resource.
+| identifier required | string |
| Accept required | string If set, the updated Payment Method is returned in XML or JSON format. + |
| Content-Type required | string The Payment Method input schema encoded in XML or JSON. + |
The updated PaymentMethodUpdateController resource
+required | object (PaymentMethodUpdateStruct) |
{- "PaymentMethodUpdateStructParser": {
- "identifier": "string",
- "names": { },
- "descriptions": [
- "string"
], - "enabled": true,
- "options": [
- null
]
}
}{- "PaymentMethod": {
- "_media-type": "application/vnd.ibexa.api.PaymentMethod+json",
- "identifier": "bank_transfer",
- "id": 1,
- "enabled": true,
- "name": "Bank transfer",
- "description": "Bank transfer"
}
}Loads an payment method by its id.
+| id required | string |
| Accept required | string Payment Method - If set, the payment method returned in XML or JSON format. + |
{- "PaymentMethod": {
- "_media-type": "application/vnd.ibexa.api.PaymentMethod+json",
- "identifier": "bank_transfer",
- "id": 1,
- "enabled": true,
- "name": "Bank transfer",
- "description": "Bank transfer"
}
}Loads a list of shipments.
+| Accept required | string If set, the shipments are returned in XML or JSON format. + |
{- "ShipmentRefList": {
- "_media-type": "application/vnd.ibexa.api.ShipmentRefList+json",
- "_href": "/api/ibexa/v2/shipments",
- "shipmentRefList": [
- {
- "_media-type": "application/vnd.ibexa.api.Shipment+json",
- "_href": "/api/ibexa/v2/shipments/foo"
}, - {
- "_media-type": "application/vnd.ibexa.api.Shipment+json",
- "_href": "/api/ibexa/v2/shipments/bar"
}, - {
- "_media-type": "application/vnd.ibexa.api.Shipment+json",
- "_href": "/api/ibexa/v2/shipments/baz"
}, - {
- "_media-type": "application/vnd.ibexa.api.Shipment+json",
- "_href": "/api/ibexa/v2/shipments/qux"
}
]
}
}Loads a single shipment based on its identifier.
+| identifier required | string |
| Accept required | string If set, the shipment is returned in XML or JSON format. + |
{- "Shipment": {
- "_media-type": "application/vnd.ibexa.api.Shipment+json",
- "_href": "/api/ibexa/v2/shipments/new_identifier",
- "id": 1,
- "identifier": "new_identifier",
- "status": "prepared",
- "transitions": {
- "transitionList": [
- "send-to-carrier",
- "cancel"
]
}, - "Order": {
- "_media-type": "application/vnd.ibexa.api.Order+json",
- "_href": "/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f"
}, - "Amount": {
- "value": "2257",
- "currency": "EUR"
}, - "createdAt": "2023-06-26T15:40:28+02:00",
- "updatedAt": "2023-06-26T15:40:28+02:00",
- "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "Method": {
- "_media-type": "application/vnd.ibexa.api.ShippingMethod+json",
- "_href": "/api/ibexa/v2/shipping/methods/parcel_locker_delivery"
}
}
}Updates a shipment.
+| identifier required | string |
| Accept required | string If set, the updated shipment is returned in XML or JSON format. + |
| Content-Type required | string The ShipmentUpdate schema encoded in XML or JSON format. + |
The updated ShipmentUpdateController resource
+required | object (ShipmentUpdate) This class represents the update of a shipment. + |
{- "ShipmentUpdate": {
- "identifier": "string",
- "transition": "string",
- "Owner": {
- "_media-type": "string",
- "_href": "string"
}, - "Context": { }
}
}{- "Shipment": {
- "_media-type": "application/vnd.ibexa.api.Shipment+json",
- "_href": "/api/ibexa/v2/shipments/new_identifier",
- "id": 1,
- "identifier": "new_identifier",
- "status": "prepared",
- "transitions": {
- "transitionList": [
- "send-to-carrier",
- "cancel"
]
}, - "Order": {
- "_media-type": "application/vnd.ibexa.api.Order+json",
- "_href": "/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f"
}, - "Amount": {
- "value": "2257",
- "currency": "EUR"
}, - "createdAt": "2023-06-26T15:40:28+02:00",
- "updatedAt": "2023-06-26T15:40:28+02:00",
- "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "Method": {
- "_media-type": "application/vnd.ibexa.api.ShippingMethod+json",
- "_href": "/api/ibexa/v2/shipping/methods/parcel_locker_delivery"
}
}
}Loads shipping methods types.
+| Accept required | string Shipping method type reference - if set, the shipping method is returned in XML or JSON format. + |
{- "ShippingMethodTypesList": {
- "_media-type": "application/vnd.ibexa.api.ShippingMethodTypesList+json",
- "_href": "/api/ibexa/v2/shipping/method-types",
- "ShippingMethodTypes": [
- {
- "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json",
- "_href": "/api/ibexa/v2/shipping/method-types/flat_rate",
- "identifier": "flat_rate",
- "name": "Flat rate"
}, - {
- "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json",
- "_href": "/api/ibexa/v2/shipping/method-types/free",
- "identifier": "free",
- "name": "Free shipping"
}
]
}
}Loads shipping methods type based on their identifiers.
+| identifier required | string |
| Accept required | string Shipping method type - if set, the shipping method is returned in XML or JSON format. + |
{- "ShippingMethodType": {
- "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json",
- "_href": "/api/ibexa/v2/shipping/method-types/flat_rate",
- "identifier": "flat_rate",
- "name": "Flat rate"
}
}Loads shipping methods.
+| Accept required | string Shipping method reference - if set, the shipping method is returned in XML or JSON format. + |
{- "ShippingMethodRefList": {
- "_media-type": "application/vnd.ibexa.api.ShippingMethodRefList+json",
- "_href": "/api/ibexa/v2/shipping/methods",
- "ShippingMethodRefs": [
- {
- "_media-type": "application/vnd.ibexa.api.ShippingMethod+json",
- "_href": "/api/ibexa/v2/shipping/methods/parcel_delivery"
}, - {
- "_media-type": "application/vnd.ibexa.api.ShippingMethod+json",
- "_href": "/api/ibexa/v2/shipping/methods/parcel_locker_delivery"
}
]
}
}Loads shipping method based on its identifier.
+| identifier required | string |
| Accept required | string Shipping method - if set, the shipping method is returned in XML or JSON format. + |
{- "ShippingMethod": {
- "_media-type": "application/vnd.ibexa.api.ShippingMethod+json",
- "_href": "/api/ibexa/v2/shipping/methods/method1",
- "identifier": "method1",
- "name": "AmE Method 1",
- "names": {
- "value": [
- {
- "_languageCode": "eng-US",
- "#text": "AmE Method 1"
}, - {
- "_languageCode": "eng-GB",
- "#text": "BrE Method 1"
}
]
}, - "description": "AmE Description of Method 1",
- "descriptions": {
- "value": [
- {
- "_languageCode": "eng-US",
- "#text": "AmE Description of Method 1"
}, - {
- "_languageCode": "eng-GB",
- "#text": "BrE Description of Method 1"
}
]
}, - "enabled": true,
- "options": {
- "option": [
- {
- "_key": "price",
- "#text": "20.0000"
}, - {
- "_key": "currency",
- "#text": "EUR"
}
]
}, - "regions": {
- "RegionRefList": [
- {
- "_media-type": "application/vnd.ibexa.api.Region+json",
- "_href": "/api/ibexa/v2/product/catalog/regions/default"
}
]
}, - "type": {
- "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json",
- "_href": "/api/ibexa/v2/shipping/method-types/flat_rate"
}
}
}Creates a new collaboration session with participants and returns the session details.
+Session creation payload
+required | object |
{- "ExampleSessionCreate": {
- "ParticipantListCreate": {
- "ParticipantListCreate": {
- "ParticipantCreate": [
- {
- "_media-type": "application/vnd.ibexa.api.InternalParticipantCreate+json",
- "scope": "view"
}
]
}
}, - "subject": "string"
}
}{- "CollaborationSession": {
- "_media-type": "application/vnd.ibexa.api.ExampleSession+json",
- "createdAt": "2023-11-15T10:30:00+00:00",
- "id": 123,
- "token": "abc123def456ghi789",
- "updatedAt": "2023-11-15T14:45:00+00:00",
- "ParticipantList": {
- "_media-type": "application/vnd.ibexa.api.ParticipantList+json",
- "Participants": [
- {
- "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
- "createdAt": "2023-11-15T10:30:00+00:00",
- "id": 1,
- "name": "John Doe",
- "scope": "edit",
- "updatedAt": "2023-11-15T10:30:00+00:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
- "createdAt": "2023-11-15T11:00:00+00:00",
- "email": "guest@example.com",
- "id": 2,
- "name": "guest@example.com",
- "scope": "view",
- "updatedAt": "2023-11-15T11:00:00+00:00"
}
]
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "subject": "Project Collaboration Session",
- "isActive": true,
- "hasPublicLink": false
}
}Retrieves a collaboration session by its token.
+| sessionToken required | string The session token to retrieve. + |
{- "CollaborationSession": {
- "_media-type": "application/vnd.ibexa.api.ExampleSession+json",
- "createdAt": "2023-11-15T10:30:00+00:00",
- "id": 123,
- "token": "abc123def456ghi789",
- "updatedAt": "2023-11-15T14:45:00+00:00",
- "ParticipantList": {
- "_media-type": "application/vnd.ibexa.api.ParticipantList+json",
- "Participants": [
- {
- "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
- "createdAt": "2023-11-15T10:30:00+00:00",
- "id": 1,
- "name": "John Doe",
- "scope": "edit",
- "updatedAt": "2023-11-15T10:30:00+00:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
- "createdAt": "2023-11-15T11:00:00+00:00",
- "email": "guest@example.com",
- "id": 2,
- "name": "guest@example.com",
- "scope": "view",
- "updatedAt": "2023-11-15T11:00:00+00:00"
}
]
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "subject": "Project Collaboration Session",
- "isActive": true,
- "hasPublicLink": false
}
}Updates collaboration session properties.
+| sessionToken required | string The session token to update. + |
Session update payload
+required | object |
{- "ExampleSessionUpdate": {
- "hasPublicLink": true
}
}{- "CollaborationSession": {
- "_media-type": "application/vnd.ibexa.api.ExampleSession+json",
- "createdAt": "2023-11-15T10:30:00+00:00",
- "id": 123,
- "token": "abc123def456ghi789",
- "updatedAt": "2023-11-15T14:45:00+00:00",
- "ParticipantList": {
- "_media-type": "application/vnd.ibexa.api.ParticipantList+json",
- "Participants": [
- {
- "User": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
- "createdAt": "2023-11-15T10:30:00+00:00",
- "id": 1,
- "name": "John Doe",
- "scope": "edit",
- "updatedAt": "2023-11-15T10:30:00+00:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
- "createdAt": "2023-11-15T11:00:00+00:00",
- "email": "guest@example.com",
- "id": 2,
- "name": "guest@example.com",
- "scope": "view",
- "updatedAt": "2023-11-15T11:00:00+00:00"
}
]
}, - "Owner": {
- "_media-type": "application/vnd.ibexa.api.User+json",
- "_href": "/api/ibexa/v2/user/users/14"
}, - "subject": "Project Collaboration Session",
- "isActive": true,
- "hasPublicLink": false
}
}Creates an invitation for a participant to join a collaboration session.
+| sessionToken required | string The session token. + |
Invitation creation payload
+required | object |
{- "InvitationCreate": {
- "email": "user@example.com",
- "context": {
- "single_value": "string",
- "simple_array": [
- "string"
], - "extended_array": {
- "property1": "string",
- "property2": "string"
}
}
}
}{- "Invitation": {
- "_media-type": "string",
- "id": 0,
- "status": "pending",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "context": [ ],
}
}Retrieves a list of all participants in a collaboration session.
+| sessionToken required | string The session token. + |
{- "ParticipantList": {
- "Participants": [
- {
- "User": {
- "_href": "/api/ibexa/v2/user/users/14",
- "_media-type": "application/vnd.ibexa.api.User+json"
}, - "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
- "createdAt": "2023-11-15T10:30:00+00:00",
- "id": 1,
- "name": "John Doe",
- "scope": "edit",
- "updatedAt": "2023-11-15T10:30:00+00:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
- "createdAt": "2023-11-15T11:00:00+00:00",
- "email": "guest@example.com",
- "id": 2,
- "name": "guest@example.com",
- "scope": "view",
- "updatedAt": "2023-11-15T11:00:00+00:00"
}
], - "_media-type": "application/vnd.ibexa.api.ParticipantList+json"
}
}Adds new participants to an existing collaboration session.
+| sessionToken required | string The session token. + |
Participant list creation payload
+required | object |
{- "ParticipantListCreate": {
- "ParticipantCreate": [
- {
- "_media-type": "application/vnd.ibexa.api.InternalParticipantCreate+json",
- "scope": "view"
}
]
}
}{- "ParticipantList": {
- "Participants": [
- {
- "User": {
- "_href": "/api/ibexa/v2/user/users/14",
- "_media-type": "application/vnd.ibexa.api.User+json"
}, - "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
- "createdAt": "2023-11-15T10:30:00+00:00",
- "id": 1,
- "name": "John Doe",
- "scope": "edit",
- "updatedAt": "2023-11-15T10:30:00+00:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
- "createdAt": "2023-11-15T11:00:00+00:00",
- "email": "guest@example.com",
- "id": 2,
- "name": "guest@example.com",
- "scope": "view",
- "updatedAt": "2023-11-15T11:00:00+00:00"
}
], - "_media-type": "application/vnd.ibexa.api.ParticipantList+json"
}
}Updates properties of a participant in a collaboration session.
+| sessionToken required | string The session token. + |
| participantId required | integer The participant ID to update. + |
Participant update payload
+required | object |
{- "ExternalParticipantUpdate": {
- "scope": "view"
}
}{- "Participant": {
- "_media-type": "string",
- "id": 0,
- "name": "string",
- "scope": "string",
- "email": "user@example.com",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}{- "ActionTypeList": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionTypeList+json",
- "_href": "/api/ibexa/v2/ai/action-types",
- "ActionType": [
- {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "generate_alt_text",
- "name": "Generate alternative text",
- "inputIdentifier": "image",
- "outputIdentifier": "text",
- "options": {
- "width": 512,
- "height": 512,
- "image_quality": 85
}
}, - {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}
]
}
}Returns an action type by its unique string identifier.
+| identifier required | string Example: generate_alt_text |
{- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "generate_alt_text",
- "name": "Generate alternative text",
- "inputIdentifier": "image",
- "outputIdentifier": "text",
- "options": {
- "width": 512,
- "height": 512,
- "image_quality": 85
}
}
}{- "ActionConfigurationList": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfigurationList+json",
- "_href": "/api/ibexa/v2/ai/actions",
- "ActionConfiguration": [
- {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "rewrite_with_friendly_tone",
- "name": "Rewrite in friendly tone",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}, - "actionTypeOptions": [ ],
- "actionHandlerIdentifier": "openai-text-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "Rewrite text in friendly tone. Preserve meaning and crucial information.",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:16:47+02:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "rewrite_with_professional_tone",
- "name": "Rewrite in professional tone",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}, - "actionTypeOptions": [ ],
- "actionHandlerIdentifier": "openai-text-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "Rewrite text in professional tone. Preserve meaning and crucial information.",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:16:47+02:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "summarize_text",
- "name": "Summarize",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}, - "actionTypeOptions": [ ],
- "actionHandlerIdentifier": "openai-text-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "Summarize text into one sentence. Preserve meaning and crucial information.",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:16:47+02:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "expand_text",
- "name": "Expand text",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}, - "actionTypeOptions": [ ],
- "actionHandlerIdentifier": "openai-text-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "Expand the given text by 25%. Preserve meaning and crucial information.",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:16:47+02:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "shorten_text",
- "name": "Shorten text",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}, - "actionTypeOptions": [ ],
- "actionHandlerIdentifier": "openai-text-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "Shorten the given text by 25%. Preserve meaning and crucial information.",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:16:47+02:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "proofread",
- "name": "Proofread",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}, - "actionTypeOptions": [ ],
- "actionHandlerIdentifier": "openai-text-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "Rewrite given text to identify and fix grammatical and punctuation errors. Preserve meaning and crucial information.",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:16:47+02:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "improve_readability",
- "name": "Improve readability",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}, - "actionTypeOptions": [ ],
- "actionHandlerIdentifier": "openai-text-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "Rewrite this content to improve readability. Preserve meaning and crucial information.",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:16:47+02:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "gen_alt_text",
- "name": "Generate alternative text",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "generate_alt_text",
- "name": "Generate alternative text",
- "inputIdentifier": "image",
- "outputIdentifier": "text",
- "options": {
- "width": 512,
- "height": 512,
- "image_quality": 85
}
}, - "actionTypeOptions": {
- "max_length": 140
}, - "actionHandlerIdentifier": "openai-image-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:16:47+02:00"
}
]
}
}Returns action configuration list based on the given query.
+| X-Csrf-Token required | string CSRF token obtained during the authentication. + |
The new ActionConfigurationListController resource
+| query | string |
| action_type_identifier | string |
| enabled | boolean |
| limit | integer |
| page | integer |
{- "query": "string",
- "action_type_identifier": "string",
- "enabled": true,
- "limit": 0,
- "page": 0
}{- "ActionConfigurationList": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfigurationList+json",
- "_href": "/api/ibexa/v2/ai/actions",
- "ActionConfiguration": [
- {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "rewrite_with_professional_tone",
- "name": "Rewrite in professional tone",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}, - "actionTypeOptions": [ ],
- "actionHandlerIdentifier": "openai-text-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "Rewrite text in professional tone. Preserve meaning and crucial information.",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:16:47+02:00"
}, - {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "rewrite_with_friendly_tone",
- "name": "Rewrite in friendly tone",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}, - "actionTypeOptions": [ ],
- "actionHandlerIdentifier": "openai-text-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "Rewrite text in friendly tone. Preserve meaning and crucial information.",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:16:47+02:00"
}
]
}
}Executes the given AI Action using configured ActionConfiguration or ActionHandler, if passed. Might consume AI agent resources.
+| actionConfigurationIdentifier required | string Examples:
Configured action name (obtain by listing the configured actions via GET |
| X-Csrf-Token required | string CSRF token obtained during the authentication. + |
Input to execute the action. An Input type must match the action type.
+required | object |
required | object (RuntimeContext) |
{- "Image": {
- "base64": "string"
}, - "RuntimeContext": { }
}{- "AltText": {
- "_media-type": "application/vnd.ibexa.api.ai.AltText+json",
- "Text": {
- "_media-type": "application/vnd.ibexa.api.ai.Text+json",
- "text": [
- "Blurred image of an open laptop on a desk with paperwork and another laptop in the background."
]
}
}
}Returns an action configuration by its unique string identifier.
+| identifier required | string Example: rewrite_with_friendly_tone |
{- "ActionConfiguration": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
- "identifier": "rewrite_with_friendly_tone",
- "name": "Rewrite in friendly tone",
- "description": "",
- "enabled": true,
- "ActionType": {
- "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
- "identifier": "refine_text",
- "name": "Refine text",
- "inputIdentifier": "text",
- "outputIdentifier": "text",
- "options": [ ]
}, - "actionTypeOptions": [ ],
- "actionHandlerIdentifier": "openai-text-to-text",
- "actionHandlerOptions": {
- "max_tokens": 4000,
- "temperature": 1,
- "prompt": "Rewrite text in friendly tone. Preserve meaning and crucial information.",
- "model": "gpt-4-turbo"
}, - "createdAt": "2025-08-07T13:16:47+02:00",
- "updatedAt": "2025-08-07T13:18:00+02:00"
}
}Returns a list of all defined discounts
+| offset | integer |
| limit | integer Example: limit=25 |
{- "DiscountList": {
- "_media-type": "application/vnd.ibexa.api.DiscountList+json",
- "Discount": [
- {
- "_media-type": "application/vnd.ibexa.api.Discount+json",
- "id": 2,
- "identifier": "my_discount_identifier",
- "name": "My Discount",
- "type": "cart",
- "label": "My Discount label",
- "labelDescription": "My Discount description",
- "priority": 1,
- "isEnabled": true,
- "createdAt": "2025-08-18T11:28:43+02:00",
- "updatedAt": "2025-08-18T11:28:43+02:00",
- "startDate": "2025-08-01T00:00:00+02:00",
- "endDate": "2025-08-31T23:59:59+02:00",
- "DiscountRule": {
- "_media-type": "application/vnd.ibexa.api.DiscountRule.FixedAmount+json",
- "type": "fixed_amount",
- "expressionValues": {
- "discount_amount": "12"
}
}, - "DiscountConditions": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json",
- "identifier": "is_in_currency",
- "expressionValues": {
- "currency_code": "PLN"
}
}
], - "DiscountTranslations": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
- "languageCode": "eng-GB",
- "name": "My Discount",
- "description": "My Discount description",
- "label": "My Discount label",
- "labelDescription": "My Discount description"
}
]
}, - {
- "_media-type": "application/vnd.ibexa.api.Discount+json",
- "id": 3,
- "identifier": "my_another_discount",
- "name": "My Another Discount",
- "type": "catalog",
- "label": "Catalog discount label",
- "labelDescription": "Catalog discount description",
- "priority": 1,
- "isEnabled": true,
- "createdAt": "2025-08-18T11:58:37+02:00",
- "updatedAt": "2025-08-18T11:58:37+02:00",
- "startDate": "2025-08-18T09:57:14+02:00",
- "DiscountRule": {
- "_media-type": "application/vnd.ibexa.api.DiscountRule.Percentage+json",
- "type": "percentage",
- "expressionValues": {
- "discount_percentage": "10"
}
}, - "DiscountConditions": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json",
- "identifier": "is_in_currency",
- "expressionValues": {
- "currency_code": "PLN"
}
}
], - "DiscountTranslations": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
- "languageCode": "eng-GB",
- "name": "My Another Discount",
- "description": "My Another Discount Description",
- "label": "Catalog discount label",
- "labelDescription": "Catalog discount description"
}
]
}
]
}
}Creates a new discount
+| X-Csrf-Token required | string CSRF token obtained during the authentication. + |
The new DiscountCreateController resource
+| 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 |
{- "identifier": "string",
- "type": "cart",
- "priority": 1,
- "isEnabled": true,
- "userId": 0,
- "rule": {
- "type": "fixed_amount",
- "amount": "string"
}, - "conditions": [
- {
- "class": "string",
- "parameters": [
- null
]
}
], - "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "translations": [
- {
- "languageCode": "string",
- "name": "string",
- "description": "string",
- "label": "string",
- "labelDescription": "string"
}
], - "context": { }
}{- "Discount": {
- "_media-type": "application/vnd.ibexa.api.Discount+json",
- "id": 2,
- "identifier": "my_discount_identifier",
- "name": "My Discount",
- "type": "cart",
- "label": "My Discount label",
- "labelDescription": "My Discount description",
- "priority": 1,
- "isEnabled": true,
- "createdAt": "2025-08-18T11:28:43+02:00",
- "updatedAt": "2025-08-18T11:28:43+02:00",
- "startDate": "2025-08-01T00:00:00+02:00",
- "endDate": "2025-08-31T23:59:59+02:00",
- "DiscountRule": {
- "_media-type": "application/vnd.ibexa.api.DiscountRule.FixedAmount+json",
- "type": "fixed_amount",
- "expressionValues": {
- "discount_amount": "12"
}
}, - "DiscountConditions": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json",
- "identifier": "is_in_currency",
- "expressionValues": {
- "currency_code": "PLN"
}
}
], - "DiscountTranslations": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
- "languageCode": "eng-GB",
- "name": "My Discount",
- "description": "My Discount description",
- "label": "My Discount label",
- "labelDescription": "My Discount description"
}
]
}
}Returns a discount item by its unique string identifier.
+| identifier required | string Example: my_discount_identifier |
{- "Discount": {
- "_media-type": "application/vnd.ibexa.api.Discount+json",
- "id": 2,
- "identifier": "my_discount_identifier",
- "name": "My Discount",
- "type": "cart",
- "label": "My Discount label",
- "labelDescription": "My Discount description",
- "priority": 1,
- "isEnabled": true,
- "createdAt": "2025-08-18T11:28:43+02:00",
- "updatedAt": "2025-08-18T11:28:43+02:00",
- "startDate": "2025-08-01T00:00:00+02:00",
- "endDate": "2025-08-31T23:59:59+02:00",
- "DiscountRule": {
- "_media-type": "application/vnd.ibexa.api.DiscountRule.FixedAmount+json",
- "type": "fixed_amount",
- "expressionValues": {
- "discount_amount": "12"
}
}, - "DiscountConditions": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json",
- "identifier": "is_in_currency",
- "expressionValues": {
- "currency_code": "PLN"
}
}
], - "DiscountTranslations": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
- "languageCode": "eng-GB",
- "name": "My Discount",
- "description": "My Discount description",
- "label": "My Discount label",
- "labelDescription": "My Discount description"
}
]
}
}Updates a new discount
+| identifier required | string Example: my_discount_identifier |
| X-Csrf-Token required | string CSRF token obtained during the authentication. + |
The updated DiscountUpdateController resource
+| 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 |
{- "identifier": "string",
- "priority": 1,
- "isEnabled": true,
- "userId": 0,
- "lastContributorId": 0,
- "rule": {
- "type": "fixed_amount",
- "amount": "string"
}, - "conditions": [
- {
- "class": "string",
- "parameters": [
- null
]
}
], - "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "translations": [
- {
- "languageCode": "string",
- "name": "string",
- "description": "string",
- "label": "string",
- "labelDescription": "string"
}
], - "context": { }
}{- "Discount": {
- "_media-type": "application/vnd.ibexa.api.Discount+json",
- "id": 2,
- "identifier": "my_discount_identifier",
- "name": "My Discount",
- "type": "cart",
- "label": "My Discount label",
- "labelDescription": "My Discount description",
- "priority": 1,
- "isEnabled": true,
- "createdAt": "2025-08-18T11:28:43+02:00",
- "updatedAt": "2025-08-18T11:28:43+02:00",
- "startDate": "2025-08-01T00:00:00+02:00",
- "endDate": "2025-08-31T23:59:59+02:00",
- "DiscountRule": {
- "_media-type": "application/vnd.ibexa.api.DiscountRule.FixedAmount+json",
- "type": "fixed_amount",
- "expressionValues": {
- "discount_amount": "12"
}
}, - "DiscountConditions": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json",
- "identifier": "is_in_currency",
- "expressionValues": {
- "currency_code": "PLN"
}
}
], - "DiscountTranslations": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
- "languageCode": "eng-GB",
- "name": "My Discount",
- "description": "My Discount description",
- "label": "My Discount label",
- "labelDescription": "My Discount description"
}
]
}
}Returns a discount item by its ID.
+| id required | integer Example: 1 |
{- "Discount": {
- "_media-type": "application/vnd.ibexa.api.Discount+json",
- "id": 2,
- "identifier": "my_discount_identifier",
- "name": "My Discount",
- "type": "cart",
- "label": "My Discount label",
- "labelDescription": "My Discount description",
- "priority": 1,
- "isEnabled": true,
- "createdAt": "2025-08-18T11:28:43+02:00",
- "updatedAt": "2025-08-18T11:28:43+02:00",
- "startDate": "2025-08-01T00:00:00+02:00",
- "endDate": "2025-08-31T23:59:59+02:00",
- "DiscountRule": {
- "_media-type": "application/vnd.ibexa.api.DiscountRule.FixedAmount+json",
- "type": "fixed_amount",
- "expressionValues": {
- "discount_amount": "12"
}
}, - "DiscountConditions": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json",
- "identifier": "is_in_currency",
- "expressionValues": {
- "currency_code": "PLN"
}
}
], - "DiscountTranslations": [
- {
- "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
- "languageCode": "eng-GB",
- "name": "My Discount",
- "description": "My Discount description",
- "label": "My Discount label",
- "labelDescription": "My Discount description"
}
]
}
}