From 563aa62673efbefc506c69405ed8ede39e127778 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 17 Aug 2026 14:32:36 +0200 Subject: [PATCH 1/7] API Refs workflow must fail on error (#3352) --- tools/api_refs/api_refs.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/tools/api_refs/api_refs.sh b/tools/api_refs/api_refs.sh index 26efb47fe2..d0a3a8333c 100755 --- a/tools/api_refs/api_refs.sh +++ b/tools/api_refs/api_refs.sh @@ -1,6 +1,7 @@ #!/usr/bin/env bash set +x; +set -e; AUTH_JSON=$(realpath ${1:-~/.composer/auth.json}); # Path to an auth.json file allowing to install the targeted edition and version PHP_API_OUTPUT_DIR=${2:-./docs/api/php_api/php_api_reference}; # Path to the directory where the built PHP API Reference is hosted From 5b911218c406c2c04bdd51e1ee0b853ed8fd6c41 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 18 Aug 2026 14:29:48 +0200 Subject: [PATCH 2/7] Fix links (#3353) * Update actito.com links * Update symfony.com links --- docs/commerce/order_management/configure_order_management.md | 2 +- docs/commerce/payment/configure_payment.md | 2 +- docs/commerce/shipping_management/configure_shipment.md | 2 +- docs/commerce/transactional_emails/transactional_emails.md | 4 ++-- docs/discounts/discounts_api.md | 2 +- docs/discounts/extend_discounts.md | 2 +- docs/ibexa_products/ibexa_commerce.md | 2 +- .../infrastructure_and_maintenance/cache/persistence_cache.md | 4 ++-- docs/templating/templates/templates.md | 2 +- docs/update_and_migration/from_2.5/to_3.3.md | 2 +- 10 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/commerce/order_management/configure_order_management.md b/docs/commerce/order_management/configure_order_management.md index 05be3fa4ea..8e08c03840 100644 --- a/docs/commerce/order_management/configure_order_management.md +++ b/docs/commerce/order_management/configure_order_management.md @@ -13,7 +13,7 @@ When you work with your Commerce implementation, you can modify and customize th ## Configure order processing workflow -Order processing workflow relies on a [Symfony Workflow]([[= symfony_doc =]]/components/workflow.html). +Order processing workflow relies on a [Symfony Workflow]([[= symfony_doc =]]/workflow.html). Each transition represents a separate order processing step. ### Default order processing configuration diff --git a/docs/commerce/payment/configure_payment.md b/docs/commerce/payment/configure_payment.md index 1bb7cdc5b0..eb2347031f 100644 --- a/docs/commerce/payment/configure_payment.md +++ b/docs/commerce/payment/configure_payment.md @@ -13,7 +13,7 @@ When you work with your Commerce implementation, you can review and modify the p ## Configure payment workflow -Payment workflow relies on a [Symfony Workflow]([[= symfony_doc =]]/components/workflow.html). +Payment workflow relies on a [Symfony Workflow]([[= symfony_doc =]]/workflow.html). Each transition represents a separate payment step. ### Default payment workflow configuration diff --git a/docs/commerce/shipping_management/configure_shipment.md b/docs/commerce/shipping_management/configure_shipment.md index 9bc88d3915..69b2140091 100644 --- a/docs/commerce/shipping_management/configure_shipment.md +++ b/docs/commerce/shipping_management/configure_shipment.md @@ -13,7 +13,7 @@ When you work with your Commerce implementation, you can review and modify the s ## Configure shipment workflow -Shipment workflow relies on a [Symfony Workflow]([[= symfony_doc =]]/components/workflow.html). +Shipment workflow relies on a [Symfony Workflow]([[= symfony_doc =]]/workflow.html). Each transition represents a separate shipment step. The default fallback workflow is `ibexa_shipment`, which is prepended at bundle level. diff --git a/docs/commerce/transactional_emails/transactional_emails.md b/docs/commerce/transactional_emails/transactional_emails.md index 275c486b71..23df8abdca 100644 --- a/docs/commerce/transactional_emails/transactional_emails.md +++ b/docs/commerce/transactional_emails/transactional_emails.md @@ -5,7 +5,7 @@ edition: commerce # Transactional emails -Transactional emails are messages that [[= product_name =]] can send through [Actito](https://www.actito.com/en-BE/) gateway to your end-users to notify them about changes in the status of various actions taken in relation to your commerce presence. +Transactional emails are messages that [[= product_name =]] can send through [Actito](https://actito.com/en) gateway to your end-users to notify them about changes in the status of various actions taken in relation to your commerce presence. By default, notifications are sent in relation to the following events, to an email address of the end-user who has originated these events: @@ -40,7 +40,7 @@ Symfony Flex installs and activates the package. ### Configure Actito integration -Before you can start configuring the notifier engine to process and dispatch notifications to be forwarded as transactional emails, you must first obtain and configure an [Actito license](https://www.actito.com/en-BE/pricing/nk). +Before you can start configuring the notifier engine to process and dispatch notifications to be forwarded as transactional emails, you must first obtain and configure an [Actito license](https://actito.com/en/pricing/). Once you gain access to the Actito dashboard: diff --git a/docs/discounts/discounts_api.md b/docs/discounts/discounts_api.md index 640253b016..544391cc21 100644 --- a/docs/discounts/discounts_api.md +++ b/docs/discounts/discounts_api.md @@ -29,7 +29,7 @@ Discounts are applied in two places, listed in the [`DiscountType`](/api/php_api Regardless of activation place, discounts always apply to products and reduce their base price. To define when a discount activates and how the price is reduced, use rules and conditions. -They use the [Symfony Expression language]([[= symfony_doc=]]/components/expression_language.html) to express their logic. +They use the [Symfony Expression language]([[= symfony_doc=]]/expression_language.html) to express their logic. ### Rules diff --git a/docs/discounts/extend_discounts.md b/docs/discounts/extend_discounts.md index 3b34494d21..36180af222 100644 --- a/docs/discounts/extend_discounts.md +++ b/docs/discounts/extend_discounts.md @@ -20,7 +20,7 @@ Together with the existing [events](event_reference.md) and the [Discounts PHP A With custom [conditions](discounts_api.md#conditions) and [rules](discounts_api.md#rules) you can create more advanced discounts that apply only in specific scenarios. -For both of them, you need to specify their logic with [Symfony's expression language](https://symfony.com/doc/current/components/expression_language.html). +For both of them, you need to specify their logic with [Symfony's expression language]([[= symfony_doc =]]/expression_language.html). ### Available expressions diff --git a/docs/ibexa_products/ibexa_commerce.md b/docs/ibexa_products/ibexa_commerce.md index 67392155bf..e7e4d0a1bc 100644 --- a/docs/ibexa_products/ibexa_commerce.md +++ b/docs/ibexa_products/ibexa_commerce.md @@ -87,7 +87,7 @@ You can set up your search engine using [[= product_name_com =]] to help clients #### Transactional emails -Commerce allows you to send transactional emails - messages that [[= product_name_base =]] can send through the [Actito](https://www.actito.com/en-BE/) gateway to your end-users. +Commerce allows you to send transactional emails - messages that [[= product_name_base =]] can send through the [Actito](https://actito.com/en) gateway to your end-users. These emails include notifications about changes in the status of various actions taken in relation to your commerce presence. With this feature you can also [create email campaigns](transactional_emails.md#create-email-campaigns) to engage users and increase sales. diff --git a/docs/infrastructure_and_maintenance/cache/persistence_cache.md b/docs/infrastructure_and_maintenance/cache/persistence_cache.md index 66b1d11955..4c4f43ca93 100644 --- a/docs/infrastructure_and_maintenance/cache/persistence_cache.md +++ b/docs/infrastructure_and_maintenance/cache/persistence_cache.md @@ -46,7 +46,7 @@ To see where and how to contribute additional caches, refer to the [source code] !!! note Current implementation uses [Symfony application cache]([[= symfony_doc =]]/cache.html#system-cache-and-application-cache). - It technically supports the following cache backends: [APCu, Array, Chain, Doctrine, Filesystem, PDO & Doctrine DBAL, Php Array, Proxy, Redis]([[= symfony_doc =]]/components/cache/cache_pools.html#creating-cache-pools). + It technically supports the following cache backends: [APCu, Array, Chain, Doctrine, Filesystem, PDO & Doctrine DBAL, Php Array, Proxy, Redis]([[= symfony_doc =]]/cache.html#available-cache-adapters). [[= product_name =]] officially supports only using Filesystem for single server and Redis/Valkey for clustered setups. Use of [Redis/Valkey](#redisvalkey) as shared cache backend is a requirement for use in clustering setup. @@ -267,7 +267,7 @@ $pool->save($cacheItem); return $myObject; ``` -For more info on usage, see [Symfony Cache's documentation]([[= symfony_doc =]]/components/cache.html). +For more info on usage, see [Symfony Cache's documentation]([[= symfony_doc =]]/cache.html). ### Clearing persistence cache diff --git a/docs/templating/templates/templates.md b/docs/templating/templates/templates.md index 820453b77f..0b582f5598 100644 --- a/docs/templating/templates/templates.md +++ b/docs/templating/templates/templates.md @@ -93,7 +93,7 @@ twig_variables: {{ custom_variable.nested_variable }} ``` -You can use [Symfony Expression language]([[= symfony_doc =]]/components/expression_language.html) to access other values, for example: +You can use [Symfony Expression language]([[= symfony_doc =]]/expression_language.html) to access other values, for example: ``` yaml params: diff --git a/docs/update_and_migration/from_2.5/to_3.3.md b/docs/update_and_migration/from_2.5/to_3.3.md index 0d8992a0b7..83d44e3455 100644 --- a/docs/update_and_migration/from_2.5/to_3.3.md +++ b/docs/update_and_migration/from_2.5/to_3.3.md @@ -10,7 +10,7 @@ Before you start this procedure, make sure you have completed the previous step, ## 5. Update to v3.3 -[[= product_name =]] v3.3 uses [Symfony Flex]([[= symfony_doc =]]/quick_tour/flex_recipes.html). +[[= product_name =]] v3.3 uses [Symfony Flex](https://symfony.com/tour/flex-recipes). When updating from v3.2 to v3.3, you need to follow a special update procedure. !!! note From c2dbd52677ff9d5228d79d77eed80049a6839252 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Tue, 18 Aug 2026 15:33:58 +0200 Subject: [PATCH 3/7] [PHP API Ref] Added translations-management package --- tools/api_refs/api_refs.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/api_refs/api_refs.sh b/tools/api_refs/api_refs.sh index d0a3a8333c..7899fbc48a 100755 --- a/tools/api_refs/api_refs.sh +++ b/tools/api_refs/api_refs.sh @@ -11,7 +11,7 @@ REST_API_OPENAPI_FILE_JSON=${5:-./docs/api/rest_api/rest_api_reference/openapi.j DXP_EDITION='commerce'; # Edition from and for which the Reference is built DXP_VERSION="${DXP_VERSION:-5.0.*}"; # Version from and for which the Reference is built; can be overridden by the DXP_VERSION env var (e.g. v5.0.x-dev for a dev build) -DXP_ADD_ONS=(automated-translation rector integrated-help fieldtype-richtext-rte connector-anthropic connector-gemini shopping-list cdp connector-raptor connector-quable mcp); # Packages not included in $DXP_EDITION but added to the Reference, listed without their vendor "ibexa" +DXP_ADD_ONS=(automated-translation rector integrated-help fieldtype-richtext-rte connector-anthropic connector-gemini shopping-list cdp connector-raptor connector-quable mcp translations-management); # Packages not included in $DXP_EDITION but added to the Reference, listed without their vendor "ibexa" DXP_EDITIONS=(oss headless experience commerce); # Available editions ordered by ascending capabilities SF_VERSION='7.4'; # Symfony version used by Ibexa DXP PHPDOC_VERSION='3.10.0'; # Version of phpDocumentor used to build the Reference From d44a994de7e4b41c48d712c7e73d6b6b0e1ac272 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 18 Aug 2026 15:35:10 +0200 Subject: [PATCH 4/7] Fix API Refs CI's Git user (#3355) fatal: empty ident name (for ) not allowed --- .github/workflows/api_refs.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index cc51f8b54a..01a6feed9f 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -124,6 +124,9 @@ jobs: fi composer config --global http-basic.updates.ibexa.co $SATIS_NETWORK_KEY $SATIS_NETWORK_TOKEN + git config --global user.name "${GITHUB_ACTOR}" + git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" + if [[ '4.6' != $BASE_BRANCH ]]; then tools/api_refs/api_refs.sh # Fix escape character: @@ -140,8 +143,6 @@ jobs: env: BASE_BRANCH: ${{ steps.version_and_branches.outputs.base_branch }} run: | - git config --global user.name "${GITHUB_ACTOR}" - git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" git add docs/api/php_api/php_api_reference/ if [[ '4.6' != $BASE_BRANCH ]]; then git add tools/api_refs/.phpdoc/template/package-edition-map.twig From 2aeeecb7b6fbcf64acbf75f29fddfbd8816d221a Mon Sep 17 00:00:00 2001 From: "ibexa-workflow-automation-1[bot]" Date: Thu, 20 Aug 2026 15:56:47 +0000 Subject: [PATCH 5/7] PHP API Ref HTML --- ...ion-Invitation-InvitationUpdateStruct.html | 57 +- .../classes/Ibexa-Contracts-Core-Ibexa.html | 2 +- ...ontentTypeOwnedBySomeoneElseException.html | 305 +++ ...re-SiteAccess-ConfigResolverInterface.html | 106 +- ...eSchema-Database-DatabasePlatformName.html | 435 +++ ...ema-Database-DatabasePlatformResolver.html | 392 +++ ...Page-Block-Definition-BlockDefinition.html | 201 +- ...Block-Definition-ReactBlockDefinition.html | 201 +- ...rmBuilder-Notifications-FormSubmitted.html | 6 +- ...acts-Messenger-Stamp-DeduplicateStamp.html | 40 +- ...racts-Messenger-Stamp-SiteAccessStamp.html | 495 ++++ ...oTranslate-Action-TranslateTextAction.html | 1004 +++++++ ...nslate-AutoTranslationReviewOperation.html | 532 ++++ ...Translate-AutoTranslationReviewStatus.html | 451 ++++ ...te-AutoTranslationReviewStatusContext.html | 396 +++ ...iActionConfigurationResolverInterface.html | 387 +++ ...Config-ProviderConfigurationInterface.html | 644 +++++ ...ncyInjection-AutoTranslateServiceTags.html | 654 +++++ ...oTranslate-Event-BeforeTranslateEvent.html | 697 +++++ ...nt-AutoTranslate-Event-TranslateEvent.html | 751 ++++++ ...anslationDraftCreationFailedException.html | 408 +++ ...-Exception-EmptyLanguageCodeException.html | 392 +++ ...ranslate-Exception-EmptyTextException.html | 365 +++ ...mptyTranslatedBlockAttributeException.html | 309 +++ ...-InvalidAutoTranslateRequestException.html | 408 +++ ...on-InvalidLanguageCodeFormatException.html | 420 +++ ...ption-LanguageCodeConversionException.html | 405 +++ ...n-LanguageNormalizerNotFoundException.html | 392 +++ ...ceLanguageTranslationMissingException.html | 405 +++ ...upportedLanguagesUnavailableException.html | 405 +++ ...on-TargetLanguageUnavailableException.html | 391 +++ ...slate-Exception-TextTooLargeException.html | 406 +++ ...tedPayloadStructureViolationException.html | 308 +++ ...eption-TranslationHttpClientException.html | 308 +++ ...xception-TranslationProviderException.html | 308 +++ ...Exception-TranslatorNotFoundException.html | 391 +++ ...ption-UnsupportedActionInputException.html | 406 +++ ...xception-UnsupportedLanguageException.html | 420 +++ ...-Exception-ValidatorNotFoundException.html | 405 +++ ...e-Http-TranslationHttpClientInterface.html | 387 +++ ...etadataValidationRetryPolicyInterface.html | 502 ++++ ...ovider-AiTranslationProviderInterface.html | 642 +++++ ...rovider-ConfigurableProviderInterface.html | 642 +++++ ...ormalizer-LanguageNormalizerInterface.html | 490 ++++ ...nslate-Provider-ProviderListInterface.html | 461 ++++ ...Provider-TranslationProviderInterface.html | 555 ++++ ...e-Transformer-Field-EncodedFieldValue.html | 501 ++++ ...-Field-FieldValueTransformerInterface.html | 558 ++++ ...taAwareFieldValueTransformerInterface.html | 713 +++++ ...Field-MetadataEncodingFailureHandling.html | 404 +++ ...eld-MetadataValidationFailureHandling.html | 443 +++ ...ockAttributeValueTransformerInterface.html | 548 ++++ ...kAttribute-EncodedBlockAttributeValue.html | 559 ++++ ...ansformer-PayloadTransformerInterface.html | 470 ++++ ...utoTranslate-TranslationDataInterface.html | 440 +++ ...Translate-TranslationRequestInterface.html | 440 +++ ...ranslate-TranslationResponseInterface.html | 398 +++ ...Translate-TranslationServiceInterface.html | 474 ++++ ...ent-AutoTranslate-TranslatorInterface.html | 536 ++++ ...te-Validator-DefaultProviderValidator.html | 685 +++++ ...-AutoTranslate-Validator-LanguageRole.html | 400 +++ ...-Validator-ProviderValidatorInterface.html | 630 +++++ ...or-ProviderValidatorRegistryInterface.html | 407 +++ ...tor-ValidationPolicyResolverInterface.html | 413 +++ ...Translate-Validator-ValidationProfile.html | 358 +++ ...ption-AlreadyExistsExceptionInterface.html | 301 +++ ...tion-InvalidRequestExceptionInterface.html | 301 +++ ...-Exception-NotFoundExceptionInterface.html | 301 +++ ...ntentSideBySideTranslationCreateEvent.html | 744 +++++ ...oductSideBySideTranslationCreateEvent.html | 798 ++++++ ...ideBySideTranslationNotFoundException.html | 436 +++ ...vice-SideBySideExclusionRuleInterface.html | 387 +++ ...ice-SideBySideSupportCheckerInterface.html | 456 ++++ ...SideBySideTranslationServiceInterface.html | 682 +++++ ...-Values-Content-SideBySideTranslation.html | 717 +++++ ...ent-SideBySideTranslationAccessResult.html | 723 +++++ ...Content-SideBySideTranslationFallback.html | 501 ++++ ...nt-SideBySideTranslationFieldMetadata.html | 678 +++++ docs/api/php_api/php_api_reference/index.html | 1930 +++++++++++-- .../php_api_reference/js/searchIndex.js | 1320 +++++++++ .../php_api_reference/namespaces/default.html | 2 +- .../ibexa-contracts-activitylog-event.html | 2 +- ...ibexa-contracts-activitylog-exception.html | 2 +- ...ivitylog-values-activitylog-criterion.html | 2 +- ...vitylog-values-activitylog-sortclause.html | 2 +- ...tracts-activitylog-values-activitylog.html | 2 +- .../ibexa-contracts-activitylog-values.html | 2 +- .../ibexa-contracts-activitylog.html | 2 +- .../ibexa-contracts-adminui-autosave.html | 2 +- ...-contracts-adminui-component-renderer.html | 2 +- .../ibexa-contracts-adminui-component.html | 2 +- .../ibexa-contracts-adminui-contenttype.html | 2 +- .../ibexa-contracts-adminui-controller.html | 2 +- .../ibexa-contracts-adminui-event.html | 2 +- .../ibexa-contracts-adminui-exception.html | 2 +- .../ibexa-contracts-adminui-focusmode.html | 2 +- ...ntracts-adminui-form-actiondispatcher.html | 2 +- ...ontracts-adminui-form-data-formmapper.html | 2 +- .../ibexa-contracts-adminui-form-data.html | 2 +- ...exa-contracts-adminui-form-datamapper.html | 2 +- .../ibexa-contracts-adminui-form.html | 2 +- .../ibexa-contracts-adminui-menu.html | 2 +- .../ibexa-contracts-adminui-notification.html | 2 +- .../ibexa-contracts-adminui-permission.html | 2 +- ...-contracts-adminui-previewurlresolver.html | 2 +- .../ibexa-contracts-adminui-resolver.html | 2 +- .../ibexa-contracts-adminui-rest.html | 2 +- .../ibexa-contracts-adminui-tab.html | 2 +- .../ibexa-contracts-adminui-ui-action.html | 2 +- .../ibexa-contracts-adminui-ui-config.html | 2 +- .../ibexa-contracts-adminui-ui.html | 2 +- ...-contracts-adminui-universaldiscovery.html | 2 +- .../namespaces/ibexa-contracts-adminui.html | 2 +- ...contracts-automatedtranslation-client.html | 2 +- ...tedtranslation-encoder-blockattribute.html | 2 +- ...ts-automatedtranslation-encoder-field.html | 2 +- ...ontracts-automatedtranslation-encoder.html | 2 +- ...tracts-automatedtranslation-exception.html | 2 +- .../ibexa-contracts-automatedtranslation.html | 2 +- .../ibexa-contracts-calendar-eventaction.html | 2 +- .../ibexa-contracts-calendar-eventsource.html | 2 +- .../ibexa-contracts-calendar-eventtype.html | 2 +- .../namespaces/ibexa-contracts-calendar.html | 2 +- .../ibexa-contracts-cart-event.html | 2 +- .../ibexa-contracts-cart-exception.html | 2 +- .../ibexa-contracts-cart-fileprocessor.html | 2 +- ...contracts-cart-permission-policy-cart.html | 2 +- ...bexa-contracts-cart-permission-policy.html | 2 +- .../ibexa-contracts-cart-permission.html | 2 +- ...-contracts-cart-value-query-criterion.html | 2 +- .../ibexa-contracts-cart-value-query.html | 2 +- .../ibexa-contracts-cart-value.html | 2 +- .../namespaces/ibexa-contracts-cart.html | 2 +- .../ibexa-contracts-cdp-exception.html | 2 +- .../ibexa-contracts-cdp-export-content.html | 2 +- .../ibexa-contracts-cdp-export-dataset.html | 2 +- .../ibexa-contracts-cdp-export-product.html | 2 +- .../ibexa-contracts-cdp-export-transport.html | 2 +- .../ibexa-contracts-cdp-export-user.html | 2 +- .../ibexa-contracts-cdp-export.html | 2 +- .../ibexa-contracts-cdp-membership.html | 2 +- ...xa-contracts-cdp-value-webhook-action.html | 2 +- .../ibexa-contracts-cdp-value-webhook.html | 2 +- .../namespaces/ibexa-contracts-cdp-value.html | 2 +- .../ibexa-contracts-cdp-webhook.html | 2 +- .../namespaces/ibexa-contracts-cdp.html | 2 +- .../ibexa-contracts-checkout-address.html | 2 +- ...ntracts-checkout-discounts-datamapper.html | 2 +- .../ibexa-contracts-checkout-discounts.html | 2 +- .../ibexa-contracts-checkout-event.html | 2 +- .../ibexa-contracts-checkout-exception.html | 2 +- ...bexa-contracts-checkout-order-factory.html | 2 +- .../ibexa-contracts-checkout-order.html | 2 +- .../ibexa-contracts-checkout-payment.html | 2 +- ...xa-contracts-checkout-policy-checkout.html | 2 +- .../ibexa-contracts-checkout-policy.html | 2 +- .../ibexa-contracts-checkout-reorder.html | 2 +- ...ontracts-checkout-value-paymentmethod.html | 2 +- ...exa-contracts-checkout-value-workflow.html | 2 +- .../ibexa-contracts-checkout-value.html | 2 +- .../ibexa-contracts-checkout-workflow.html | 2 +- .../namespaces/ibexa-contracts-checkout.html | 2 +- ...contracts-collaboration-configuration.html | 2 +- ...tracts-collaboration-invitation-event.html | 2 +- ...laboration-invitation-query-criterion.html | 2 +- ...aboration-invitation-query-sortclause.html | 2 +- ...tracts-collaboration-invitation-query.html | 2 +- ...xa-contracts-collaboration-invitation.html | 2 +- ...-collaboration-notification-recipient.html | 2 +- ...-contracts-collaboration-notification.html | 2 +- ...racts-collaboration-participant-event.html | 2 +- ...a-contracts-collaboration-participant.html | 2 +- ...ntracts-collaboration-realtimeediting.html | 2 +- ...racts-collaboration-rest-input-parser.html | 2 +- ...xa-contracts-collaboration-rest-input.html | 2 +- ...a-contracts-collaboration-rest-values.html | 2 +- .../ibexa-contracts-collaboration-rest.html | 2 +- ...bexa-contracts-collaboration-security.html | 2 +- ...contracts-collaboration-session-event.html | 2 +- ...collaboration-session-query-criterion.html | 2 +- ...ollaboration-session-query-sortclause.html | 2 +- ...contracts-collaboration-session-query.html | 2 +- ...ibexa-contracts-collaboration-session.html | 2 +- .../ibexa-contracts-collaboration.html | 2 +- .../ibexa-contracts-connect-ai.html | 2 +- .../ibexa-contracts-connect-exception.html | 2 +- ...nect-resource-custompropertystructure.html | 2 +- ...tracts-connect-resource-datastructure.html | 2 +- ...ibexa-contracts-connect-resource-hook.html | 2 +- ...a-contracts-connect-resource-scenario.html | 2 +- ...ibexa-contracts-connect-resource-team.html | 2 +- ...a-contracts-connect-resource-template.html | 2 +- .../ibexa-contracts-connect-resource.html | 2 +- ...nect-response-custompropertystructure.html | 2 +- ...tracts-connect-response-datastructure.html | 2 +- ...ibexa-contracts-connect-response-hook.html | 2 +- ...a-contracts-connect-response-scenario.html | 2 +- ...ibexa-contracts-connect-response-team.html | 2 +- ...a-contracts-connect-response-template.html | 2 +- .../ibexa-contracts-connect-response.html | 2 +- ...acts-connect-value-blueprint-metadata.html | 2 +- ...tracts-connect-value-blueprint-module.html | 2 +- ...exa-contracts-connect-value-blueprint.html | 2 +- .../ibexa-contracts-connect-value.html | 2 +- .../namespaces/ibexa-contracts-connect.html | 2 +- ...ibexa-contracts-connector-dam-handler.html | 2 +- .../ibexa-contracts-connector-dam-search.html | 2 +- ...exa-contracts-connector-dam-variation.html | 2 +- .../ibexa-contracts-connector-dam-view.html | 2 +- .../ibexa-contracts-connector-dam.html | 2 +- .../namespaces/ibexa-contracts-connector.html | 2 +- ...contracts-connectorai-action-datatype.html | 2 +- ...xa-contracts-connectorai-action-event.html | 2 +- ...tracts-connectorai-action-imagetotext.html | 2 +- ...contracts-connectorai-action-response.html | 2 +- ...tracts-connectorai-action-texttoimage.html | 2 +- ...cts-connectorai-action-texttotaxonomy.html | 2 +- ...ntracts-connectorai-action-texttotext.html | 2 +- .../ibexa-contracts-connectorai-action.html | 2 +- ...connectorai-actionconfiguration-event.html | 2 +- ...i-actionconfiguration-query-criterion.html | 2 +- ...-actionconfiguration-query-sortclause.html | 2 +- ...connectorai-actionconfiguration-query.html | 2 +- ...racts-connectorai-actionconfiguration.html | 2 +- ...bexa-contracts-connectorai-actiontype.html | 2 +- .../ibexa-contracts-connectorai-events.html | 2 +- .../ibexa-contracts-connectorai-prompt.html | 2 +- ...-contracts-connectorai-rest-exception.html | 2 +- .../ibexa-contracts-connectorai-rest.html | 2 +- .../ibexa-contracts-connectorai.html | 2 +- .../ibexa-contracts-connectoropenai.html | 2 +- ...xa-contracts-connectorpayum-generator.html | 2 +- ...bexa-contracts-connectorpayum-payment.html | 2 +- ...bexa-contracts-connectorpayum-storage.html | 2 +- .../ibexa-contracts-connectorpayum.html | 2 +- ...contracts-connectorqualifio-exception.html | 2 +- ...exa-contracts-connectorqualifio-value.html | 2 +- .../ibexa-contracts-connectorqualifio.html | 2 +- ...ntracts-connectorraptor-configuration.html | 2 +- ...acts-connectorraptor-content-resolver.html | 2 +- ...exa-contracts-connectorraptor-content.html | 2 +- ...exa-contracts-connectorraptor-message.html | 2 +- ...onnectorraptor-raptorclient-exception.html | 2 +- ...ts-connectorraptor-raptorclient-model.html | 2 +- ...ontracts-connectorraptor-raptorclient.html | 2 +- ...connectorraptor-recommendations-value.html | 2 +- ...racts-connectorraptor-recommendations.html | 2 +- ...nectorraptor-tracking-contextprovider.html | 2 +- ...tracts-connectorraptor-tracking-event.html | 2 +- ...xa-contracts-connectorraptor-tracking.html | 2 +- .../ibexa-contracts-connectorraptor.html | 2 +- ...ts-contentforms-content-form-provider.html | 2 +- ...a-contracts-contentforms-content-form.html | 2 +- .../ibexa-contracts-contentforms-content.html | 2 +- ...a-contracts-contentforms-data-content.html | 2 +- .../ibexa-contracts-contentforms-data.html | 2 +- .../ibexa-contracts-contentforms-event.html | 2 +- ...bexa-contracts-contentforms-fieldtype.html | 2 +- .../ibexa-contracts-contentforms.html | 2 +- .../ibexa-contracts-core-collection.html | 2 +- ...xa-contracts-core-container-apiloader.html | 2 +- .../ibexa-contracts-core-container.html | 2 +- .../ibexa-contracts-core-event-mapper.html | 2 +- ...ibexa-contracts-core-event-nameschema.html | 2 +- .../ibexa-contracts-core-event-view.html | 2 +- .../ibexa-contracts-core-event.html | 2 +- .../ibexa-contracts-core-exception.html | 2 +- ...a-contracts-core-fieldtype-binarybase.html | 2 +- ...ore-fieldtype-generic-validationerror.html | 2 +- ...bexa-contracts-core-fieldtype-generic.html | 2 +- ...tracts-core-fieldtype-validationerror.html | 2 +- .../ibexa-contracts-core-fieldtype.html | 2 +- .../namespaces/ibexa-contracts-core-io.html | 2 +- ...tracts-core-limitation-target-builder.html | 2 +- ...bexa-contracts-core-limitation-target.html | 2 +- .../ibexa-contracts-core-limitation.html | 2 +- ...xa-contracts-core-mvc-eventsubscriber.html | 2 +- .../ibexa-contracts-core-mvc-templating.html | 2 +- .../ibexa-contracts-core-mvc-view.html | 2 +- .../namespaces/ibexa-contracts-core-mvc.html | 2 +- .../ibexa-contracts-core-options.html | 2 +- ...a-contracts-core-persistence-bookmark.html | 2 +- ...cts-core-persistence-content-language.html | 2 +- ...re-persistence-content-location-trash.html | 2 +- ...cts-core-persistence-content-location.html | 2 +- ...-core-persistence-content-objectstate.html | 2 +- ...cts-core-persistence-content-relation.html | 2 +- ...acts-core-persistence-content-section.html | 2 +- ...s-core-persistence-content-type-group.html | 2 +- ...ntracts-core-persistence-content-type.html | 2 +- ...cts-core-persistence-content-urlalias.html | 2 +- ...-core-persistence-content-urlwildcard.html | 2 +- ...xa-contracts-core-persistence-content.html | 2 +- ...acts-core-persistence-filter-doctrine.html | 2 +- ...ntracts-core-persistence-filter-query.html | 2 +- ...exa-contracts-core-persistence-filter.html | 2 +- ...ntracts-core-persistence-notification.html | 2 +- ...xa-contracts-core-persistence-setting.html | 2 +- .../ibexa-contracts-core-persistence-url.html | 2 +- ...ibexa-contracts-core-persistence-user.html | 2 +- ...racts-core-persistence-userpreference.html | 2 +- .../ibexa-contracts-core-persistence.html | 2 +- .../namespaces/ibexa-contracts-core-pool.html | 2 +- ...contracts-core-repository-collections.html | 2 +- ...a-contracts-core-repository-decorator.html | 2 +- ...ibexa-contracts-core-repository-event.html | 2 +- ...racts-core-repository-events-bookmark.html | 2 +- ...tracts-core-repository-events-content.html | 2 +- ...ts-core-repository-events-contenttype.html | 2 +- ...racts-core-repository-events-language.html | 2 +- ...racts-core-repository-events-location.html | 2 +- ...s-core-repository-events-notification.html | 2 +- ...ts-core-repository-events-objectstate.html | 2 +- ...contracts-core-repository-events-role.html | 2 +- ...tracts-core-repository-events-section.html | 2 +- ...tracts-core-repository-events-setting.html | 2 +- ...ontracts-core-repository-events-token.html | 2 +- ...ontracts-core-repository-events-trash.html | 2 +- ...-contracts-core-repository-events-url.html | 2 +- ...racts-core-repository-events-urlalias.html | 2 +- ...ts-core-repository-events-urlwildcard.html | 2 +- ...contracts-core-repository-events-user.html | 2 +- ...core-repository-events-userpreference.html | 2 +- ...bexa-contracts-core-repository-events.html | 2 +- ...-contracts-core-repository-exceptions.html | 9 +- ...ository-iterator-batchiteratoradapter.html | 2 +- ...xa-contracts-core-repository-iterator.html | 2 +- ...ibexa-contracts-core-repository-lists.html | 2 +- ...-contracts-core-repository-nameschema.html | 2 +- ...itory-strategy-contentthumbnail-field.html | 2 +- ...-repository-strategy-contentthumbnail.html | 2 +- ...xa-contracts-core-repository-strategy.html | 2 +- ...a-contracts-core-repository-validator.html | 2 +- ...racts-core-repository-values-bookmark.html | 2 +- ...ository-values-content-draftlist-item.html | 2 +- ...e-repository-values-content-draftlist.html | 2 +- ...alues-content-query-aggregation-field.html | 2 +- ...es-content-query-aggregation-location.html | 2 +- ...lues-content-query-aggregation-ranges.html | 2 +- ...tory-values-content-query-aggregation.html | 2 +- ...-values-content-query-criterion-image.html | 2 +- ...lues-content-query-criterion-location.html | 2 +- ...lues-content-query-criterion-operator.html | 2 +- ...-values-content-query-criterion-value.html | 2 +- ...sitory-values-content-query-criterion.html | 2 +- ...ues-content-query-sortclause-location.html | 2 +- ...alues-content-query-sortclause-target.html | 2 +- ...values-content-query-sortclause-trash.html | 2 +- ...itory-values-content-query-sortclause.html | 2 +- ...-core-repository-values-content-query.html | 2 +- ...tory-values-content-relationlist-item.html | 2 +- ...epository-values-content-relationlist.html | 2 +- ...lues-content-search-aggregationresult.html | 2 +- ...core-repository-values-content-search.html | 2 +- ...-core-repository-values-content-trash.html | 2 +- ...s-content-urlwildcard-query-criterion.html | 2 +- ...-content-urlwildcard-query-sortclause.html | 2 +- ...tory-values-content-urlwildcard-query.html | 2 +- ...repository-values-content-urlwildcard.html | 2 +- ...tracts-core-repository-values-content.html | 2 +- ...ry-values-contenttype-query-criterion.html | 2 +- ...y-values-contenttype-query-sortclause.html | 2 +- ...e-repository-values-contenttype-query.html | 2 +- ...ts-core-repository-values-contenttype.html | 2 +- ...ntracts-core-repository-values-filter.html | 2 +- ...y-values-notification-query-criterion.html | 2 +- ...-repository-values-notification-query.html | 2 +- ...s-core-repository-values-notification.html | 2 +- ...ts-core-repository-values-objectstate.html | 2 +- ...tracts-core-repository-values-setting.html | 2 +- ...ontracts-core-repository-values-token.html | 2 +- ...ts-core-repository-values-translation.html | 2 +- ...ts-core-repository-values-trash-query.html | 2 +- ...ontracts-core-repository-values-trash.html | 2 +- ...repository-values-url-query-criterion.html | 2 +- ...epository-values-url-query-sortclause.html | 2 +- ...acts-core-repository-values-url-query.html | 2 +- ...-contracts-core-repository-values-url.html | 2 +- ...ore-repository-values-user-limitation.html | 2 +- ...contracts-core-repository-values-user.html | 2 +- ...core-repository-values-userpreference.html | 2 +- ...bexa-contracts-core-repository-values.html | 2 +- .../ibexa-contracts-core-repository.html | 2 +- ...ibexa-contracts-core-search-embedding.html | 2 +- ...ibexa-contracts-core-search-fieldtype.html | 2 +- .../ibexa-contracts-core-search.html | 2 +- .../ibexa-contracts-core-siteaccess.html | 2 +- ...-contracts-core-specification-content.html | 2 +- .../ibexa-contracts-core-specification.html | 2 +- .../ibexa-contracts-core-token.html | 2 +- ...-contracts-core-validation-constraint.html | 2 +- .../ibexa-contracts-core-validation.html | 2 +- ...ibexa-contracts-core-variation-values.html | 2 +- .../ibexa-contracts-core-variation.html | 2 +- .../namespaces/ibexa-contracts-core.html | 2 +- ...a-contracts-corepersistence-exception.html | 2 +- ...exa-contracts-corepersistence-gateway.html | 2 +- .../ibexa-contracts-corepersistence.html | 2 +- ...oresearch-persistence-criterionmapper.html | 2 +- ...bexa-contracts-coresearch-persistence.html | 2 +- ...cts-coresearch-values-query-criterion.html | 2 +- ...ts-coresearch-values-query-sortclause.html | 2 +- ...exa-contracts-coresearch-values-query.html | 2 +- .../ibexa-contracts-coresearch-values.html | 2 +- .../ibexa-contracts-coresearch.html | 2 +- ...porateaccount-customerportal-pickrule.html | 2 +- ...racts-corporateaccount-customerportal.html | 2 +- ...ateaccount-event-application-workflow.html | 2 +- ...ts-corporateaccount-event-application.html | 2 +- ...tracts-corporateaccount-event-company.html | 2 +- ...ntracts-corporateaccount-event-member.html | 2 +- ...orporateaccount-event-shippingaddress.html | 2 +- ...bexa-contracts-corporateaccount-event.html | 2 +- ...-contracts-corporateaccount-exception.html | 2 +- ...bexa-contracts-corporateaccount-order.html | 2 +- ...contracts-corporateaccount-permission.html | 2 +- ...corporateaccount-salesrepresentatives.html | 2 +- ...xa-contracts-corporateaccount-service.html | 2 +- ...ts-corporateaccount-values-limitation.html | 2 +- ...rporateaccount-values-query-criterion.html | 2 +- ...ntracts-corporateaccount-values-query.html | 2 +- ...exa-contracts-corporateaccount-values.html | 2 +- .../ibexa-contracts-corporateaccount.html | 2 +- ...ontracts-dashboard-block-quickactions.html | 2 +- .../ibexa-contracts-dashboard-block.html | 2 +- .../ibexa-contracts-dashboard-exceptions.html | 2 +- ...shboard-iterator-batchiteratoradapter.html | 2 +- .../ibexa-contracts-dashboard-iterator.html | 2 +- .../ibexa-contracts-dashboard-values.html | 2 +- .../namespaces/ibexa-contracts-dashboard.html | 2 +- .../ibexa-contracts-designengine.html | 2 +- ...a-contracts-discounts-admin-form-data.html | 2 +- ...-contracts-discounts-admin-form-event.html | 2 +- ...ntracts-discounts-admin-form-listener.html | 2 +- .../ibexa-contracts-discounts-admin-form.html | 2 +- ...-contracts-discounts-admin-formmapper.html | 2 +- .../ibexa-contracts-discounts-admin.html | 2 +- .../ibexa-contracts-discounts-event-step.html | 2 +- .../ibexa-contracts-discounts-event.html | 2 +- .../ibexa-contracts-discounts-exception.html | 2 +- .../ibexa-contracts-discounts-policy.html | 2 +- ...racts-discounts-value-query-criterion.html | 2 +- ...acts-discounts-value-query-sortclause.html | 2 +- ...ibexa-contracts-discounts-value-query.html | 2 +- ...bexa-contracts-discounts-value-struct.html | 2 +- .../ibexa-contracts-discounts-value.html | 2 +- .../namespaces/ibexa-contracts-discounts.html | 2 +- .../ibexa-contracts-discountscodes-event.html | 2 +- ...xa-contracts-discountscodes-exception.html | 2 +- ...-contracts-discountscodes-value-query.html | 2 +- ...contracts-discountscodes-value-struct.html | 2 +- .../ibexa-contracts-discountscodes-value.html | 2 +- .../ibexa-contracts-discountscodes.html | 2 +- ...bexa-contracts-doctrineschema-builder.html | 2 +- ...exa-contracts-doctrineschema-database.html | 292 ++ .../ibexa-contracts-doctrineschema-event.html | 2 +- ...xa-contracts-doctrineschema-exception.html | 2 +- .../ibexa-contracts-doctrineschema.html | 10 +- ...asticsearch-elasticsearch-index-group.html | 2 +- ...cts-elasticsearch-elasticsearch-index.html | 2 +- ...contracts-elasticsearch-elasticsearch.html | 2 +- ...contracts-elasticsearch-mapping-event.html | 2 +- ...ibexa-contracts-elasticsearch-mapping.html | 2 +- ...a-contracts-elasticsearch-query-event.html | 2 +- .../ibexa-contracts-elasticsearch-query.html | 2 +- ...s-elasticsearch-repository-exceptions.html | 2 +- ...earch-repository-values-content-query.html | 2 +- ...asticsearch-repository-values-content.html | 2 +- ...racts-elasticsearch-repository-values.html | 2 +- ...xa-contracts-elasticsearch-repository.html | 2 +- .../ibexa-contracts-elasticsearch.html | 2 +- ...bexa-contracts-fieldtypeaddress-event.html | 2 +- .../ibexa-contracts-fieldtypeaddress.html | 2 +- ...dtypepage-fieldtype-landingpage-model.html | 2 +- ...s-fieldtypepage-fieldtype-landingpage.html | 2 +- ...e-page-block-attribute-formtypemapper.html | 2 +- ...e-page-block-attribute-valueconverter.html | 2 +- ...pepage-fieldtype-page-block-attribute.html | 2 +- ...epage-fieldtype-page-block-definition.html | 2 +- ...ts-fieldtypepage-fieldtype-page-block.html | 2 +- ...-fieldtypepage-fieldtype-page-service.html | 2 +- ...ontracts-fieldtypepage-fieldtype-page.html | 2 +- ...exa-contracts-fieldtypepage-fieldtype.html | 2 +- ...cheduleblock-timeline-event-processor.html | 2 +- ...typepage-scheduleblock-timeline-event.html | 2 +- ...-fieldtypepage-scheduleblock-timeline.html | 2 +- ...contracts-fieldtypepage-scheduleblock.html | 2 +- .../ibexa-contracts-fieldtypepage.html | 2 +- .../ibexa-contracts-fieldtypequery.html | 2 +- ...racts-fieldtyperichtext-configuration.html | 2 +- ...-contracts-fieldtyperichtext-richtext.html | 2 +- .../ibexa-contracts-fieldtyperichtext.html | 2 +- ...contracts-fieldtyperichtextrte-config.html | 2 +- ...xa-contracts-fieldtyperichtextrte-tos.html | 2 +- .../ibexa-contracts-fieldtyperichtextrte.html | 2 +- ...contracts-formbuilder-fieldtype-field.html | 2 +- ...contracts-formbuilder-fieldtype-model.html | 2 +- ...ibexa-contracts-formbuilder-fieldtype.html | 2 +- ...-contracts-formbuilder-formsubmission.html | 2 +- ...a-contracts-formbuilder-notifications.html | 2 +- .../ibexa-contracts-formbuilder.html | 2 +- ...ation-inputhandler-fieldtype-richtext.html | 2 +- ...aphql-mutation-inputhandler-fieldtype.html | 2 +- ...ntracts-graphql-mutation-inputhandler.html | 2 +- .../ibexa-contracts-graphql-mutation.html | 2 +- ...domain-content-mapper-fielddefinition.html | 2 +- ...-graphql-schema-domain-content-mapper.html | 2 +- ...ntracts-graphql-schema-domain-content.html | 2 +- ...ibexa-contracts-graphql-schema-domain.html | 2 +- .../ibexa-contracts-graphql-schema.html | 2 +- .../namespaces/ibexa-contracts-graphql.html | 2 +- .../ibexa-contracts-httpcache-handler.html | 2 +- ...ibexa-contracts-httpcache-purgeclient.html | 2 +- ...xa-contracts-httpcache-responsetagger.html | 2 +- .../namespaces/ibexa-contracts-httpcache.html | 2 +- .../ibexa-contracts-imageeditor-event.html | 2 +- ...ibexa-contracts-imageeditor-optimizer.html | 2 +- .../ibexa-contracts-imageeditor.html | 2 +- ...ontracts-integratedhelp-builder-block.html | 2 +- ...bexa-contracts-integratedhelp-builder.html | 2 +- .../ibexa-contracts-integratedhelp-event.html | 2 +- ...-contracts-integratedhelp-producttour.html | 2 +- ...exa-contracts-integratedhelp-renderer.html | 2 +- .../ibexa-contracts-integratedhelp.html | 2 +- .../ibexa-contracts-mcp-attribute.html | 2 +- .../namespaces/ibexa-contracts-mcp.html | 2 +- ...ibexa-contracts-measurement-converter.html | 2 +- ...s-measurement-product-query-criterion.html | 2 +- ...a-contracts-measurement-product-query.html | 2 +- .../ibexa-contracts-measurement-product.html | 2 +- ...ontracts-measurement-value-definition.html | 2 +- .../ibexa-contracts-measurement-value.html | 2 +- .../ibexa-contracts-measurement.html | 2 +- .../ibexa-contracts-messenger-stamp.html | 9 +- .../ibexa-contracts-messenger-transport.html | 2 +- .../namespaces/ibexa-contracts-messenger.html | 2 +- .../ibexa-contracts-migration-event.html | 2 +- .../ibexa-contracts-migration-exception.html | 2 +- ...-contracts-migration-metadata-storage.html | 2 +- .../ibexa-contracts-migration-metadata.html | 2 +- ...cts-migration-serializer-denormalizer.html | 2 +- ...racts-migration-serializer-normalizer.html | 2 +- .../ibexa-contracts-migration-serializer.html | 2 +- ...bexa-contracts-migration-stepexecutor.html | 2 +- .../namespaces/ibexa-contracts-migration.html | 2 +- ...ibexa-contracts-notifications-service.html | 2 +- ...acts-notifications-systemnotification.html | 2 +- ...acts-notifications-value-notification.html | 2 +- ...ontracts-notifications-value-recipent.html | 2 +- .../ibexa-contracts-notifications-value.html | 2 +- .../ibexa-contracts-notifications.html | 2 +- .../ibexa-contracts-oauth2client-client.html | 2 +- ...ntracts-oauth2client-exception-client.html | 2 +- ...-oauth2client-exception-resourceowner.html | 2 +- ...bexa-contracts-oauth2client-exception.html | 2 +- ...exa-contracts-oauth2client-repository.html | 2 +- ...-contracts-oauth2client-resourceowner.html | 2 +- .../ibexa-contracts-oauth2client.html | 2 +- ...ibexa-contracts-ordermanagement-event.html | 2 +- ...a-contracts-ordermanagement-exception.html | 2 +- ...ontracts-ordermanagement-notification.html | 2 +- ...ontracts-ordermanagement-policy-order.html | 2 +- ...bexa-contracts-ordermanagement-policy.html | 2 +- ...anagement-value-order-query-criterion.html | 2 +- ...nagement-value-order-query-sortclause.html | 2 +- ...cts-ordermanagement-value-order-query.html | 2 +- ...contracts-ordermanagement-value-order.html | 2 +- ...racts-ordermanagement-value-orderitem.html | 2 +- ...ontracts-ordermanagement-value-struct.html | 2 +- ...ibexa-contracts-ordermanagement-value.html | 2 +- ...xa-contracts-ordermanagement-workflow.html | 2 +- .../ibexa-contracts-ordermanagement.html | 2 +- .../ibexa-contracts-pagebuilder-event.html | 2 +- ...ibexa-contracts-pagebuilder-exception.html | 2 +- ...acts-pagebuilder-pagebuilder-timeline.html | 2 +- ...exa-contracts-pagebuilder-pagebuilder.html | 2 +- ...racts-pagebuilder-siteaccess-selector.html | 2 +- ...bexa-contracts-pagebuilder-siteaccess.html | 2 +- .../ibexa-contracts-pagebuilder-timeline.html | 2 +- .../ibexa-contracts-pagebuilder.html | 2 +- .../ibexa-contracts-payment-exception.html | 2 +- .../ibexa-contracts-payment-notification.html | 2 +- ...ibexa-contracts-payment-payment-event.html | 2 +- ...-contracts-payment-payment-permission.html | 2 +- ...racts-payment-payment-query-criterion.html | 2 +- ...acts-payment-payment-query-sortclause.html | 2 +- ...ibexa-contracts-payment-payment-query.html | 2 +- ...xa-contracts-payment-payment-workflow.html | 2 +- .../ibexa-contracts-payment-payment.html | 2 +- ...contracts-payment-paymentmethod-event.html | 2 +- ...tracts-payment-paymentmethod-iterator.html | 2 +- ...acts-payment-paymentmethod-permission.html | 2 +- ...payment-paymentmethod-query-criterion.html | 2 +- ...ayment-paymentmethod-query-sortclause.html | 2 +- ...contracts-payment-paymentmethod-query.html | 2 +- ...-contracts-payment-paymentmethod-type.html | 2 +- ...contracts-payment-paymentmethod-voter.html | 2 +- ...ibexa-contracts-payment-paymentmethod.html | 2 +- .../namespaces/ibexa-contracts-payment.html | 2 +- ...ons-repository-values-user-limitation.html | 2 +- ...ts-permissions-repository-values-user.html | 2 +- ...ntracts-permissions-repository-values.html | 2 +- ...bexa-contracts-permissions-repository.html | 2 +- .../ibexa-contracts-permissions.html | 2 +- ...xa-contracts-personalization-criteria.html | 2 +- ...personalization-serializer-normalizer.html | 2 +- ...-contracts-personalization-serializer.html | 2 +- ...exa-contracts-personalization-storage.html | 2 +- ...ibexa-contracts-personalization-value.html | 2 +- .../ibexa-contracts-personalization.html | 2 +- ...oductcatalog-catalogfilters-attribute.html | 2 +- ...ntracts-productcatalog-catalogfilters.html | 2 +- ...ibexa-contracts-productcatalog-config.html | 2 +- ...ibexa-contracts-productcatalog-events.html | 2 +- ...a-contracts-productcatalog-exceptions.html | 2 +- ...xa-contracts-productcatalog-form-data.html | 2 +- ...xa-contracts-productcatalog-form-type.html | 2 +- .../ibexa-contracts-productcatalog-form.html | 2 +- ...catalog-iterator-batchiteratoradapter.html | 2 +- ...exa-contracts-productcatalog-iterator.html | 2 +- ...tracts-productcatalog-local-attribute.html | 2 +- ...ts-productcatalog-local-codegenerator.html | 2 +- ...contracts-productcatalog-local-events.html | 2 +- ...cts-productcatalog-local-values-asset.html | 2 +- ...alog-local-values-attributedefinition.html | 2 +- ...ctcatalog-local-values-attributegroup.html | 2 +- ...s-productcatalog-local-values-product.html | 2 +- ...oductcatalog-local-values-producttype.html | 2 +- ...contracts-productcatalog-local-values.html | 2 +- .../ibexa-contracts-productcatalog-local.html | 2 +- ...a-contracts-productcatalog-nameschema.html | 2 +- ...uctcatalog-permission-contextprovider.html | 2 +- ...permission-policy-attributedefinition.html | 2 +- ...alog-permission-policy-attributegroup.html | 2 +- ...ductcatalog-permission-policy-catalog.html | 2 +- ...uctcatalog-permission-policy-commerce.html | 2 +- ...talog-permission-policy-customergroup.html | 2 +- ...ductcatalog-permission-policy-product.html | 2 +- ...catalog-permission-policy-producttype.html | 2 +- ...acts-productcatalog-permission-policy.html | 2 +- ...a-contracts-productcatalog-permission.html | 2 +- ...-contracts-productcatalog-rest-output.html | 2 +- .../ibexa-contracts-productcatalog-rest.html | 2 +- ...contracts-productcatalog-values-asset.html | 2 +- ...alog-values-attributedefinition-query.html | 2 +- ...uctcatalog-values-attributedefinition.html | 2 +- ...-productcatalog-values-attributegroup.html | 2 +- ...ts-productcatalog-values-availability.html | 2 +- ...atalog-values-catalog-query-criterion.html | 2 +- ...s-productcatalog-values-catalog-query.html | 2 +- ...ntracts-productcatalog-values-catalog.html | 2 +- ...atalog-values-common-query-sortclause.html | 2 +- ...ts-productcatalog-values-common-query.html | 2 +- ...ontracts-productcatalog-values-common.html | 2 +- ...atalog-values-content-query-criterion.html | 2 +- ...talog-values-content-query-sortclause.html | 2 +- ...s-productcatalog-values-content-query.html | 2 +- ...ntracts-productcatalog-values-content.html | 2 +- ...talog-values-currency-query-criterion.html | 2 +- ...alog-values-currency-query-sortclause.html | 2 +- ...-productcatalog-values-currency-query.html | 2 +- ...tracts-productcatalog-values-currency.html | 2 +- ...-values-customergroup-query-criterion.html | 2 +- ...uctcatalog-values-customergroup-query.html | 2 +- ...s-productcatalog-values-customergroup.html | 2 +- ...uctcatalog-values-price-create-struct.html | 2 +- ...ts-productcatalog-values-price-create.html | 2 +- ...uctcatalog-values-price-delete-struct.html | 2 +- ...ts-productcatalog-values-price-delete.html | 2 +- ...tcatalog-values-price-query-criterion.html | 2 +- ...cts-productcatalog-values-price-query.html | 2 +- ...uctcatalog-values-price-update-struct.html | 2 +- ...ts-productcatalog-values-price-update.html | 2 +- ...contracts-productcatalog-values-price.html | 2 +- ...product-productlist-aggregationresult.html | 2 +- ...uctcatalog-values-product-productlist.html | 2 +- ...alog-values-product-query-aggregation.html | 2 +- ...oduct-query-attributecriterionbuilder.html | 2 +- ...atalog-values-product-query-criterion.html | 2 +- ...talog-values-product-query-sortclause.html | 2 +- ...s-productcatalog-values-product-query.html | 2 +- ...ntracts-productcatalog-values-product.html | 2 +- ...cts-productcatalog-values-producttype.html | 2 +- ...catalog-values-region-query-criterion.html | 2 +- ...ts-productcatalog-values-region-query.html | 2 +- ...ontracts-productcatalog-values-region.html | 2 +- ...cts-productcatalog-values-vatcategory.html | 2 +- ...ibexa-contracts-productcatalog-values.html | 2 +- ...ductcatalog-viewmatcher-locationbased.html | 2 +- ...oductcatalog-viewmatcher-productbased.html | 2 +- ...tcatalog-viewmatcher-producttypebased.html | 2 +- ...-contracts-productcatalog-viewmatcher.html | 2 +- .../ibexa-contracts-productcatalog.html | 2 +- ...logdatetimeattribute-search-criterion.html | 2 +- ...roductcatalogdatetimeattribute-search.html | 2 +- ...racts-productcatalogdatetimeattribute.html | 2 +- ...talogsymbolattribute-search-criterion.html | 2 +- ...-productcatalogsymbolattribute-search.html | 2 +- ...s-productcatalogsymbolattribute-value.html | 2 +- ...ntracts-productcatalogsymbolattribute.html | 2 +- .../ibexa-contracts-rector-factory.html | 2 +- .../ibexa-contracts-rector-sets.html | 2 +- .../namespaces/ibexa-contracts-rector.html | 2 +- .../ibexa-contracts-rest-event.html | 2 +- .../ibexa-contracts-rest-exceptions.html | 2 +- .../ibexa-contracts-rest-input.html | 2 +- ...bexa-contracts-rest-output-exceptions.html | 2 +- .../ibexa-contracts-rest-output.html | 2 +- .../ibexa-contracts-rest-uriparser.html | 2 +- .../namespaces/ibexa-contracts-rest.html | 2 +- .../ibexa-contracts-scheduler-repository.html | 2 +- ...ibexa-contracts-scheduler-valueobject.html | 2 +- .../namespaces/ibexa-contracts-scheduler.html | 2 +- .../ibexa-contracts-search-event-service.html | 2 +- .../ibexa-contracts-search-event.html | 2 +- .../ibexa-contracts-search-mapper.html | 2 +- ...exa-contracts-search-model-suggestion.html | 2 +- .../ibexa-contracts-search-model.html | 2 +- .../ibexa-contracts-search-provider.html | 2 +- ...xa-contracts-search-service-decorator.html | 2 +- .../ibexa-contracts-search-service.html | 2 +- ...xa-contracts-search-sortingdefinition.html | 2 +- .../namespaces/ibexa-contracts-search.html | 2 +- .../ibexa-contracts-segmentation-event.html | 2 +- ...bexa-contracts-segmentation-exception.html | 2 +- .../ibexa-contracts-segmentation.html | 2 +- .../ibexa-contracts-seo-renderer-tag.html | 2 +- .../ibexa-contracts-seo-renderer.html | 2 +- .../ibexa-contracts-seo-resolver.html | 2 +- .../namespaces/ibexa-contracts-seo-value.html | 2 +- .../namespaces/ibexa-contracts-seo.html | 2 +- .../ibexa-contracts-share-collaboration.html | 2 +- .../ibexa-contracts-share-event.html | 2 +- .../ibexa-contracts-share-mapper-action.html | 2 +- .../ibexa-contracts-share-mapper.html | 2 +- ...exa-contracts-share-permission-mapper.html | 2 +- .../ibexa-contracts-share-permission.html | 2 +- .../ibexa-contracts-share-ui-component.html | 2 +- .../namespaces/ibexa-contracts-share-ui.html | 2 +- .../ibexa-contracts-share-values.html | 2 +- .../namespaces/ibexa-contracts-share.html | 2 +- ...terator-batchiteratoradapter-shipment.html | 2 +- ...hipping-iterator-batchiteratoradapter.html | 2 +- .../ibexa-contracts-shipping-iterator.html | 2 +- ...ntracts-shipping-local-shippingmethod.html | 2 +- .../ibexa-contracts-shipping-local.html | 2 +- ...ibexa-contracts-shipping-notification.html | 2 +- ...ontracts-shipping-shipment-permission.html | 2 +- ...cts-shipping-shipment-query-criterion.html | 2 +- ...ts-shipping-shipment-query-sortclause.html | 2 +- ...exa-contracts-shipping-shipment-query.html | 2 +- .../ibexa-contracts-shipping-shipment.html | 2 +- ...ts-shipping-shippingmethod-permission.html | 2 +- ...ontracts-shipping-shippingmethod-type.html | 2 +- ...ntracts-shipping-shippingmethod-voter.html | 2 +- ...exa-contracts-shipping-shippingmethod.html | 2 +- ...-value-shippingmethod-query-criterion.html | 2 +- ...s-shipping-value-shippingmethod-query.html | 2 +- ...ntracts-shipping-value-shippingmethod.html | 2 +- .../ibexa-contracts-shipping-value.html | 2 +- .../ibexa-contracts-shipping-workflow.html | 2 +- .../namespaces/ibexa-contracts-shipping.html | 2 +- .../ibexa-contracts-shoppinglist-event.html | 2 +- ...bexa-contracts-shoppinglist-exception.html | 2 +- .../ibexa-contracts-shoppinglist-form.html | 2 +- ...nglist-permission-policy-shoppinglist.html | 2 +- ...tracts-shoppinglist-permission-policy.html | 2 +- ...exa-contracts-shoppinglist-permission.html | 2 +- ...xa-contracts-shoppinglist-persistence.html | 2 +- .../ibexa-contracts-shoppinglist-query.html | 2 +- ...ts-shoppinglist-value-query-criterion.html | 2 +- ...racts-shoppinglist-value-query-filter.html | 2 +- ...s-shoppinglist-value-query-sortclause.html | 2 +- ...xa-contracts-shoppinglist-value-query.html | 2 +- .../ibexa-contracts-shoppinglist-value.html | 2 +- .../ibexa-contracts-shoppinglist.html | 2 +- .../ibexa-contracts-sitecontext-event.html | 2 +- ...ibexa-contracts-sitecontext-exception.html | 2 +- ...tracts-sitecontext-previewurlresolver.html | 2 +- .../ibexa-contracts-sitecontext.html | 2 +- .../ibexa-contracts-sitefactory-events.html | 2 +- .../ibexa-contracts-sitefactory-service.html | 2 +- ...ontracts-sitefactory-servicedecorator.html | 2 +- ...a-contracts-sitefactory-values-design.html | 2 +- ...ts-sitefactory-values-query-criterion.html | 2 +- ...xa-contracts-sitefactory-values-query.html | 2 +- ...exa-contracts-sitefactory-values-site.html | 2 +- .../ibexa-contracts-sitefactory-values.html | 2 +- .../ibexa-contracts-sitefactory.html | 2 +- .../ibexa-contracts-solr-fieldmapper.html | 2 +- ...-solr-query-common-aggregationvisitor.html | 2 +- .../ibexa-contracts-solr-query-common.html | 2 +- .../ibexa-contracts-solr-query.html | 2 +- ...textractor-aggregationresultextractor.html | 2 +- .../ibexa-contracts-solr-resultextractor.html | 2 +- .../namespaces/ibexa-contracts-solr.html | 2 +- .../ibexa-contracts-storefront-exception.html | 2 +- ...ibexa-contracts-storefront-menu-event.html | 2 +- .../ibexa-contracts-storefront-menu.html | 2 +- ...contracts-storefront-repository-event.html | 2 +- ...ibexa-contracts-storefront-repository.html | 2 +- .../ibexa-contracts-storefront.html | 2 +- ...ontracts-taxonomy-embedding-exception.html | 2 +- .../ibexa-contracts-taxonomy-embedding.html | 2 +- .../ibexa-contracts-taxonomy-event.html | 2 +- ...cts-taxonomy-search-query-aggregation.html | 2 +- ...racts-taxonomy-search-query-criterion.html | 2 +- ...contracts-taxonomy-search-query-value.html | 2 +- ...ibexa-contracts-taxonomy-search-query.html | 2 +- .../ibexa-contracts-taxonomy-search.html | 2 +- ...-contracts-taxonomy-service-decorator.html | 2 +- .../ibexa-contracts-taxonomy-service.html | 2 +- .../ibexa-contracts-taxonomy-value.html | 2 +- .../namespaces/ibexa-contracts-taxonomy.html | 2 +- ...ationsmanagement-autotranslate-action.html | 289 ++ ...ationsmanagement-autotranslate-config.html | 296 ++ ...ent-autotranslate-dependencyinjection.html | 289 ++ ...lationsmanagement-autotranslate-event.html | 296 ++ ...onsmanagement-autotranslate-exception.html | 416 +++ ...slationsmanagement-autotranslate-http.html | 289 ++ ...totranslate-policy-metadatavalidation.html | 293 ++ ...ationsmanagement-autotranslate-policy.html | 290 ++ ...translate-provider-languagenormalizer.html | 293 ++ ...ionsmanagement-autotranslate-provider.html | 323 +++ ...ement-autotranslate-transformer-field.html | 321 +++ ...ransformer-landingpage-blockattribute.html | 304 +++ ...autotranslate-transformer-landingpage.html | 294 ++ ...smanagement-autotranslate-transformer.html | 310 +++ ...onsmanagement-autotranslate-validator.html | 324 +++ ...-translationsmanagement-autotranslate.html | 419 +++ ...acts-translationsmanagement-exception.html | 299 +++ ...anslationsmanagement-sidebyside-event.html | 296 ++ ...ationsmanagement-sidebyside-exception.html | 289 ++ ...slationsmanagement-sidebyside-service.html | 296 ++ ...smanagement-sidebyside-values-content.html | 314 +++ ...nslationsmanagement-sidebyside-values.html | 290 ++ ...cts-translationsmanagement-sidebyside.html | 322 +++ ...bexa-contracts-translationsmanagement.html | 298 ++ ...xa-contracts-twigcomponents-attribute.html | 2 +- .../ibexa-contracts-twigcomponents-event.html | 2 +- ...xa-contracts-twigcomponents-exception.html | 2 +- ...exa-contracts-twigcomponents-renderer.html | 2 +- .../ibexa-contracts-twigcomponents.html | 2 +- .../ibexa-contracts-user-controller.html | 2 +- ...a-contracts-user-invitation-exception.html | 2 +- ...contracts-user-invitation-persistence.html | 2 +- ...ibexa-contracts-user-invitation-query.html | 2 +- .../ibexa-contracts-user-invitation.html | 2 +- .../ibexa-contracts-user-notification.html | 2 +- .../ibexa-contracts-user-passwordreset.html | 2 +- .../ibexa-contracts-user-usersetting.html | 2 +- .../namespaces/ibexa-contracts-user.html | 2 +- ...xa-contracts-versioncomparison-engine.html | 2 +- ...contracts-versioncomparison-fieldtype.html | 2 +- ...xa-contracts-versioncomparison-result.html | 2 +- ...a-contracts-versioncomparison-service.html | 2 +- .../ibexa-contracts-versioncomparison.html | 2 +- ...ibexa-contracts-workflow-event-action.html | 2 +- .../ibexa-contracts-workflow-event.html | 2 +- ...ow-factory-workflowdefinitionmetadata.html | 2 +- .../ibexa-contracts-workflow-factory.html | 2 +- ...ontracts-workflow-persistence-handler.html | 2 +- .../ibexa-contracts-workflow-persistence.html | 2 +- .../ibexa-contracts-workflow-provider.html | 2 +- .../ibexa-contracts-workflow-registry.html | 2 +- .../ibexa-contracts-workflow-service.html | 2 +- ...acts-workflow-supportstrategy-matcher.html | 2 +- ...xa-contracts-workflow-supportstrategy.html | 2 +- .../namespaces/ibexa-contracts-workflow.html | 2 +- .../namespaces/ibexa-contracts.html | 10 +- .../php_api_reference/namespaces/ibexa.html | 2 +- .../php_api_reference/reports/deprecated.html | 2390 +++++++++++++---- .../php_api_reference/reports/errors.html | 1930 +++++++++++-- .../php_api_reference/reports/markers.html | 1930 +++++++++++-- .../.phpdoc/template/package-edition-map.twig | 4 + 875 files changed, 51773 insertions(+), 2124 deletions(-) create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Exceptions-ContentTypeOwnedBySomeoneElseException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-Database-DatabasePlatformName.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-Database-DatabasePlatformResolver.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Messenger-Stamp-SiteAccessStamp.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Action-TranslateTextAction.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-AutoTranslationReviewOperation.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-AutoTranslationReviewStatus.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-AutoTranslationReviewStatusContext.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Config-AiActionConfigurationResolverInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Config-ProviderConfigurationInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-DependencyInjection-AutoTranslateServiceTags.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Event-BeforeTranslateEvent.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Event-TranslateEvent.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-AutoTranslationDraftCreationFailedException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-EmptyLanguageCodeException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-EmptyTextException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-EmptyTranslatedBlockAttributeException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-InvalidAutoTranslateRequestException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-InvalidLanguageCodeFormatException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-LanguageCodeConversionException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-LanguageNormalizerNotFoundException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-SourceLanguageTranslationMissingException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-SupportedLanguagesUnavailableException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-TargetLanguageUnavailableException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-TextTooLargeException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-TranslatedPayloadStructureViolationException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-TranslationHttpClientException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-TranslationProviderException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-TranslatorNotFoundException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-UnsupportedActionInputException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-UnsupportedLanguageException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Exception-ValidatorNotFoundException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Http-TranslationHttpClientInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Policy-MetadataValidation-MetadataValidationRetryPolicyInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Provider-AiTranslationProviderInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Provider-ConfigurableProviderInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Provider-LanguageNormalizer-LanguageNormalizerInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Provider-ProviderListInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Provider-TranslationProviderInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Transformer-Field-EncodedFieldValue.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Transformer-Field-FieldValueTransformerInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Transformer-Field-MetadataAwareFieldValueTransformerInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Transformer-Field-MetadataEncodingFailureHandling.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Transformer-Field-MetadataValidationFailureHandling.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Transformer-LandingPage-BlockAttribute-BlockAttributeValueTransformerInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Transformer-LandingPage-BlockAttribute-EncodedBlockAttributeValue.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Transformer-PayloadTransformerInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-TranslationDataInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-TranslationRequestInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-TranslationResponseInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-TranslationServiceInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-TranslatorInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Validator-DefaultProviderValidator.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Validator-LanguageRole.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Validator-ProviderValidatorInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Validator-ProviderValidatorRegistryInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Validator-ValidationPolicyResolverInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Validator-ValidationProfile.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-Exception-AlreadyExistsExceptionInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-Exception-InvalidRequestExceptionInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-Exception-NotFoundExceptionInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Event-OnContentSideBySideTranslationCreateEvent.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Event-OnProductSideBySideTranslationCreateEvent.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Exception-SideBySideTranslationNotFoundException.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Service-SideBySideExclusionRuleInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Service-SideBySideSupportCheckerInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-SideBySideTranslationServiceInterface.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Values-Content-SideBySideTranslation.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Values-Content-SideBySideTranslationAccessResult.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Values-Content-SideBySideTranslationFallback.html create mode 100644 docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Values-Content-SideBySideTranslationFieldMetadata.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-doctrineschema-database.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-action.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-config.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-dependencyinjection.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-event.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-exception.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-http.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-policy-metadatavalidation.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-policy.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-provider-languagenormalizer.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-provider.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-transformer-field.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-transformer-landingpage-blockattribute.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-transformer-landingpage.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-transformer.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate-validator.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-autotranslate.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-exception.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-event.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-exception.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-service.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-values-content.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-values.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside.html create mode 100644 docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement.html diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-InvitationUpdateStruct.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-InvitationUpdateStruct.html index 92e9aa441b..c68657e46b 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-InvitationUpdateStruct.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-InvitationUpdateStruct.html @@ -241,7 +241,7 @@

InvitationUpdateStruct.php : - 13 + 15
Final
@@ -250,6 +250,9 @@

Extends ValueObject +
+ Implements + TranslationContainerInterface

The base class for all value objects and structs.

@@ -286,7 +289,7 @@

InvitationUpdateStruct.php : - 26 + 28
@@ -363,7 +366,7 @@

InvitationUpdateStruct.php : - 53 + 55
@@ -400,7 +403,7 @@

InvitationUpdateStruct.php : - 37 + 39
@@ -429,6 +432,43 @@

Return values

string|null

+
+

+ publicgetTranslationMessages() + ¶ +

+
+ InvitationUpdateStruct.php + : + 68 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public static getTranslationMessages() : array<string|int, mixed>
+
+
+
+
+
+

Return values

+

array<string|int, mixed>

+ +

publicsetContext() @@ -437,7 +477,7 @@

InvitationUpdateStruct.php : - 61 + 63

@@ -499,7 +539,7 @@

InvitationUpdateStruct.php : - 45 + 47
@@ -671,6 +711,11 @@

getStatus() + +
  • + + getTranslationMessages() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html index 3deb788c81..2a7d6e0170 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html @@ -284,7 +284,7 @@

    - 
    public mixed VERSION = '5.0.9'
    + 
    public mixed VERSION = '5.0.10'
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Exceptions-ContentTypeOwnedBySomeoneElseException.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Exceptions-ContentTypeOwnedBySomeoneElseException.html new file mode 100644 index 0000000000..30cc0a0c3e --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Exceptions-ContentTypeOwnedBySomeoneElseException.html @@ -0,0 +1,305 @@ + + + + + ContentTypeOwnedBySomeoneElseException | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +

    + ContentTypeOwnedBySomeoneElseException

    + +
    + ContentTypeOwnedBySomeoneElseException.php + : + 11 + +
    +
    Interface
    + +
    + Extends + Exception
    +
    +

    Marker interface for all Repository related exceptions.

    + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-SiteAccess-ConfigResolverInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-SiteAccess-ConfigResolverInterface.html index 6efcc1a4ad..e13b489ffd 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-SiteAccess-ConfigResolverInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-SiteAccess-ConfigResolverInterface.html @@ -267,7 +267,74 @@

    +

    + Constants¶ +

    +
    +

    + publicSCOPE_DEFAULT ¶ +

    +
    + ConfigResolverInterface.php + : + 23 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public string SCOPE_DEFAULT = 'default'
    +
    +
    +
    + + +
    +

    + publicSCOPE_GLOBAL ¶ +

    +
    + ConfigResolverInterface.php + : + 21 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public string SCOPE_GLOBAL = 'global'
    +
    +
    +
    + +

    Methods¶

    @@ -280,7 +347,7 @@

    ConfigResolverInterface.php : - 49 + 53
    @@ -318,7 +385,7 @@

    ConfigResolverInterface.php : - 30 + 34
    @@ -335,7 +402,7 @@

    - 
    public getParameter(string $paramName[, string $namespace = null ][, string $scope = null ]) : mixed
    + 
    public getParameter(string $paramName[, string|null $namespace = null ][, string|null $scope = null ]) : mixed
    @@ -378,7 +445,7 @@

    Parameters

    $namespace - string + string|null null @@ -396,7 +463,7 @@

    Parameters

    $scope - string + string|null null @@ -421,7 +488,7 @@

    ConfigResolverInterface.php : - 39 + 43
    @@ -438,7 +505,7 @@

    - 
    public hasParameter(string $paramName[, string $namespace = null ][, string $scope = null ]) : bool
    + 
    public hasParameter(string $paramName[, string|null $namespace = null ][, string|null $scope = null ]) : bool
    @@ -481,7 +548,7 @@

    Parameters

    $namespace - string + string|null null @@ -499,7 +566,7 @@

    Parameters

    $scope - string + string|null null @@ -526,7 +593,7 @@

    ConfigResolverInterface.php : - 44 + 48
    @@ -595,6 +662,25 @@

    Parameters

    • Response samples

    Content type
    {
    • "PolicyList": {
      }
    }

    Language

    Language list

    /api/ibexa/v2/user/policies

    Response samples

    Content type
    {
    • "PolicyList": {
      }
    }

    Language

    Language list

    Lists languages

    -
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Responses

    Response samples

    Content type
    {
    • "LanguageList": {
      }
    }

    Get language

    /api/ibexa/v2/languages

    Response samples

    Content type
    {
    • "LanguageList": {
      }
    }

    Get language

    Retrieves a LanguageLoadByIdController resource.

    -
    path Parameters
    code
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    path Parameters
    code
    required
    string

    Responses

    Response samples

    Content type
    {
    • "Language": {
      }
    }

    Location

    Load Locations by id/remoteId/urlAlias

    /api/ibexa/v2/languages/{code}

    Response samples

    Content type
    {
    • "Language": {
      }
    }

    Location

    Load Locations by id/remoteId/urlAlias

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

    -
    header Parameters
    Accept
    required
    string

    Responses

    Responses

    Response samples

    Content type
    {
    • "Location": {
      }
    }

    Load Location

    /api/ibexa/v2/content/locations

    Response samples

    Content type
    {
    • "Location": {
      }
    }

    Load Location

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

    -
    path Parameters
    path
    required
    string
    header Parameters
    Accept
    required
    string

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

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

    ETag

    -

    Responses

    Responses

    Response samples

    Content type
    {
    • "Location": {
      }
    }

    Delete subtree

    /api/ibexa/v2/content/locations/{path}

    Response samples

    Content type
    {
    • "Location": {
      }
    }

    Delete subtree

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

    -
    path Parameters
    path
    required
    string

    Responses

    Update Location

    /api/ibexa/v2/content/locations/{path}

    Update Location

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

    -
    path Parameters
    path
    required
    string
    header Parameters
    Accept
    required
    string

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

    -
    Content-Type
    required
    string

    The LocationUpdate schema encoded in XML or JSON format.

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

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

    If-Match
    required
    string

    ETag

    -
    Request Body schema:
    optional

    The updated LocationUpdateController resource

    +
    Request Body schema:
    optional

    The LocationUpdate schema encoded in XML or JSON format.

    required
    object (LocationUpdateStruct)

    This class is used for updating Location meta data.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "LocationUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Location": {
      }
    }

    Get child Locations.

    /api/ibexa/v2/content/locations/{path}

    Request samples

    Content type
    {
    • "LocationUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Location": {
      }
    }

    Get child Locations.

    Loads all child Locations for the given parent Location.

    -
    path Parameters
    path
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    path Parameters
    path
    required
    string

    Responses

    Response samples

    Content type
    {
    • "LocationList": {
      }
    }

    List URL aliases for Location

    /api/ibexa/v2/content/locations/{path}/children

    Response samples

    Content type
    {
    • "LocationList": {
      }
    }

    List URL aliases for Location

    Returns the list of URL aliases for a Location.

    -
    path Parameters
    path
    required
    string
    header Parameters
    Accept
    required
    string

    If set, the URL alias list contains only references and is returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "UrlAliasRefList": {
      }
    }

    Object State Groups

    List Object state groups

    /api/ibexa/v2/content/locations/{path}/urlaliases

    Response samples

    Content type
    {
    • "UrlAliasRefList": {
      }
    }

    Object State Groups

    List Object state groups

    Returns a list of all Object state groups.

    -
    header Parameters
    Accept
    required
    string

    If set, the Object state group list is returned in XML or JSON format.

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

    ETag

    Responses

    Response samples

    Content type
    {
    • "ObjectStateGroupList": {
      }
    }

    Create Object state group

    /api/ibexa/v2/content/objectstategroups

    Response samples

    Content type
    {
    • "ObjectStateGroupList": {
      }
    }

    Create Object state group

    Creates a new Object state group.

    -
    header Parameters
    Accept
    required
    string

    If set, the new Object state group is returned in XML or JSON format.

    -
    Content-Type
    required
    string

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

    -
    Request Body schema:
    optional

    The new ObjectStateGroupCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

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

    +
    Request Body schema:
    optional

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

    required
    object (ObjectStateGroupCreate)

    This class represents a value for creating Object state groups.

    Responses

    Request samples

    Content type
    {
    • "ObjectStateGroupCreate": {
      }
    }

    Response samples

    Content type
    {
    • "ObjectStateGroup": {
      }
    }

    Get Object state group

    /api/ibexa/v2/content/objectstategroups

    Request samples

    Content type
    {
    • "ObjectStateGroupCreate": {
      }
    }

    Response samples

    Content type
    {
    • "ObjectStateGroup": {
      }
    }

    Get Object state group

    Returns the Object state group with the provided ID.

    -
    path Parameters
    objectStateGroupId
    required
    string
    header Parameters
    Accept
    required
    string

    If set, the Object state group is returned in XML or JSON format.

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

    ETag

    Responses

    Response samples

    Content type
    {
    • "ObjectStateGroup": {
      }
    }

    Delete Object state group

    /api/ibexa/v2/content/objectstategroups/{objectStateGroupId}

    Response samples

    Content type
    {
    • "ObjectStateGroup": {
      }
    }

    Delete Object state group

    Deletes the given Object state group including Object states.

    -
    path Parameters
    objectStateGroupId
    required
    string

    Responses

    Update Object state group

    /api/ibexa/v2/content/objectstategroups/{objectStateGroupId}

    Update Object state group

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

    -
    path Parameters
    objectStateGroupId
    required
    string
    header Parameters
    Accept
    required
    string

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

    -
    Content-Type
    required
    string

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

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

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

    If-Match
    required
    string

    ETag

    -
    Request Body schema:
    optional

    The updated ObjectStateGroupUpdateController resource

    +
    Request Body schema:
    optional

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

    required
    object (ObjectStateGroupUpdate)

    This class represents a value for updating Object state groups.

    Responses

    Request samples

    Content type
    {
    • "ObjectStateGroupUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "ObjectStateGroup": {
      }
    }

    List Object states

    /api/ibexa/v2/content/objectstategroups/{objectStateGroupId}

    Request samples

    Content type
    {
    • "ObjectStateGroupUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "ObjectStateGroup": {
      }
    }

    List Object states

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

    -
    path Parameters
    objectStateGroupId
    required
    string
    header Parameters
    Accept
    required
    string

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

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

    ETag

    Responses

    Response samples

    Content type
    {
    • "ObjectStateList": {
      }
    }

    Create Object state

    /api/ibexa/v2/content/objectstategroups/{objectStateGroupId}/objectstates

    Response samples

    Content type
    {
    • "ObjectStateList": {
      }
    }

    Create Object state

    Creates a new Object state.

    -
    path Parameters
    objectStateGroupId
    required
    string
    header Parameters
    Accept
    required
    string

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

    -
    Content-Type
    required
    string

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

    -
    Request Body schema:
    optional

    The new ObjectStateCreateController resource

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

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

    +
    Request Body schema:
    optional

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

    required
    object (ObjectStateCreate)

    This class represents a value for creating Object states.

    Responses

    Request samples

    Content type
    {
    • "ObjectStateCreate": {
      }
    }

    Response samples

    Content type
    {
    • "ObjectState": {
      }
    }

    Get Object state

    /api/ibexa/v2/content/objectstategroups/{objectStateGroupId}/objectstates

    Request samples

    Content type
    {
    • "ObjectStateCreate": {
      }
    }

    Response samples

    Content type
    {
    • "ObjectState": {
      }
    }

    Get Object state

    Returns the Object state.

    -
    path Parameters
    objectStateGroupId
    required
    string
    objectStateId
    required
    string
    header Parameters
    Accept
    required
    string

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

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

    ETag

    Responses

    Response samples

    Content type
    {
    • "ObjectState": {
      }
    }

    Delete Object state

    /api/ibexa/v2/content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}

    Response samples

    Content type
    {
    • "ObjectState": {
      }
    }

    Delete Object state

    Deletes provided Object state.

    -
    path Parameters
    objectStateGroupId
    required
    string
    objectStateId
    required
    string

    Responses

    Update Object state

    /api/ibexa/v2/content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}

    Update Object state

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

    -
    path Parameters
    objectStateGroupId
    required
    string
    objectStateId
    required
    string
    header Parameters
    Accept
    required
    string

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

    -
    Content-Type
    required
    string

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

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

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

    If-Match
    required
    string

    ETag

    -
    Request Body schema:
    optional

    The updated ObjectStateUpdateController resource

    +
    Request Body schema:
    optional

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

    required
    object (ObjectStateUpdate)

    This class represents a value for updating Object states.

    Responses

    Request samples

    Content type
    {
    • "ObjectStateUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "ObjectState": {
      }
    }

    Trash

    List Trash items

    /api/ibexa/v2/content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}

    Request samples

    Content type
    {
    • "ObjectStateUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "ObjectState": {
      }
    }

    Trash

    List Trash items

    Returns a list of all items in the Trash.

    -
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "Trash": {
      }
    }

    Empty Trash

    /api/ibexa/v2/content/trash

    Response samples

    Content type
    {
    • "Trash": {
      }
    }

    Empty Trash

    Empties the Trash.

    -

    Responses

    Get Trash item

    /api/ibexa/v2/content/trash

    Get Trash item

    Returns the item in Trash with the provided ID.

    -
    path Parameters
    trashItemid
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    path Parameters
    trashItemid
    required
    string

    Responses

    Response samples

    Content type
    {
    • "TrashItem": {
      }
    }

    Delete Trash item

    /api/ibexa/v2/content/trash/{trashItemid}

    Response samples

    Content type
    {
    • "TrashItem": {
      }
    }

    Delete Trash item

    Deletes the provided item from Trash.

    -
    path Parameters
    trashItemid
    required
    string

    Responses

    Url Wildcard

    List URL wildcards

    /api/ibexa/v2/content/trash/{trashItemid}

    Url Wildcard

    List URL wildcards

    Returns a list of URL wildcards.

    -
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "UrlWildcardList": {
      }
    }

    Create URL wildcard

    /api/ibexa/v2/content/urlwildcards

    Response samples

    Content type
    {
    • "UrlWildcardList": {
      }
    }

    Create URL wildcard

    Creates a new URL wildcard.

    -
    header Parameters
    Accept
    required
    string

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

    -
    Content-Type
    required
    string

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

    -
    Request Body schema:
    optional

    The new URLWildcardCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

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

    +
    Request Body schema:
    optional

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

    required
    object (UrlWildcardCreate)

    Creates a new URL wildcard.

    Responses

    Request samples

    Content type
    {
    • "URLWildcardCreate": {
      }
    }

    Response samples

    Content type
    {
    • "UrlWildcard": {
      }
    }

    Get URL wildcard

    /api/ibexa/v2/content/urlwildcards

    Request samples

    Content type
    {
    • "URLWildcardCreate": {
      }
    }

    Response samples

    Content type
    {
    • "UrlWildcard": {
      }
    }

    Get URL wildcard

    Returns the URL wildcard with the given ID.

    -
    path Parameters
    wildcardId
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "UrlWildcard": {
      }
    }

    Delete URL wildcard

    /api/ibexa/v2/content/urlwildcards/{wildcardId}

    Response samples

    Content type
    {
    • "UrlWildcard": {
      }
    }

    Delete URL wildcard

    Deletes the given URL wildcard.

    -
    path Parameters
    wildcardId
    required
    string

    Responses

    Url Alias

    List global URL aliases

    /api/ibexa/v2/content/urlwildcards/{wildcardId}

    Url Alias

    List global URL aliases

    Returns the list of global URL aliases.

    -
    header Parameters
    Accept
    required
    string

    If set, the URL alias list contains only references and is returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "UrlAliasRefList": {
      }
    }

    Create URL alias

    /api/ibexa/v2/content/urlaliases

    Response samples

    Content type
    {
    • "UrlAliasRefList": {
      }
    }

    Create URL alias

    Creates a URL alias.

    -
    header Parameters
    Accept
    required
    string

    If set, the created URL alias is returned in XML or JSON format.

    -
    Content-Type
    required
    string

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

    -
    Request Body schema:
    optional

    The new URLAliasCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

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

    +
    Request Body schema:
    optional

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

    required
    object (UrlAliasCreate)

    Responses

    Request samples

    Content type
    {
    • "UrlAliasCreate": {
      }
    }

    Response samples

    Content type
    {
    • "UrlAlias": {
      }
    }

    Get URL alias

    /api/ibexa/v2/content/urlaliases

    Request samples

    Content type
    {
    • "UrlAliasCreate": {
      }
    }

    Response samples

    Content type
    {
    • "UrlAlias": {
      }
    }

    Get URL alias

    Returns the URL alias with the given ID.

    -
    path Parameters
    urlAliasId
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "UrlAlias": {
      }
    }

    Delete URL alias

    /api/ibexa/v2/content/urlaliases/{urlAliasId}

    Response samples

    Content type
    {
    • "UrlAlias": {
      }
    }

    Delete URL alias

    Deletes the provided URL alias.

    -
    path Parameters
    urlAliasId
    required
    string

    Responses

    Views

    Controller for Repository Views (Search, mostly).

    -

    Search content

    Search content

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

    -
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new Views resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

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

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (ViewInput)

    This class represents a View input.

    -

    Responses

    Responses

    Response samples

    Content type
    {
    • "Session": {
      }
    }

    Bookmark

    List of bookmarks

    /api/ibexa/v2/user/sessions/{sessionId}/refresh

    Response samples

    Content type
    {
    • "Session": {
      }
    }

    Bookmark

    List of bookmarks

    Lists bookmarked Locations for the current user.

    -
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Responses

    Response samples

    Content type
    {
    • "BookmarkList": {
      }
    }

    Create bookmark

    /api/ibexa/v2/bookmark

    Response samples

    Content type
    {
    • "BookmarkList": {
      }
    }

    Check if Location is bookmarked

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

    +
    path Parameters
    locationId
    required
    integer

    Responses

    Create bookmark

    Add given Location to bookmarks of the current user.

    -
    path Parameters
    locationId
    required
    string

    Responses

    Delete bookmark

    /api/ibexa/v2/bookmark/{locationId}

    Delete bookmark

    Deletes the given Location from bookmarks of the current user.

    -
    path Parameters
    locationId
    required
    string

    Responses

    Check if Location is bookmarked

    /api/ibexa/v2/bookmark/{locationId}

    Check if Location is bookmarked

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

    -
    path Parameters
    locationId
    required
    string

    Responses

    path Parameters
    locationId
    required
    integer

    Responses

    User Token

    Create JWT token

    Error - Unauthorized

    Request samples

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

    Response samples

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

    Calendar

    Calendar list

    /api/ibexa/v2/user/token/jwt

    Request samples

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

    Response samples

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

    Calendar

    Calendar list

    Calendar event list.

    -
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    query Parameters
    start
    required
    integer (UnixTimestamp)

    timestamp (seconds since the Unix Epoch).

    +
    end
    required
    integer (UnixTimestamp)

    timestamp.

    +
    count
    integer

    Maximum number of events returned (10 by default).

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

    Comma-separated list of type identifiers.

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

    comma-separated list of language codes.

    +
    cursor
    string
    Example: cursor=MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy

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

    +

    Responses

    Response samples

    Content type
    {
    • "EventList": {
      }
    }

    Calendar list grouped by day

    /api/ibexa/v2/calendar/event

    Response samples

    Content type
    {
    • "EventList": {
      }
    }

    Calendar list grouped by day

    Calendar event list grouped by day.

    -
    header Parameters
    Accept
    required
    string

    If set, the calendar event list grouped by day is returned in XML or JSON format.

    -

    Responses

    query Parameters
    start
    required
    integer (UnixTimestamp)

    timestamp (seconds since the Unix Epoch).

    +
    end
    required
    integer (UnixTimestamp)

    timestamp.

    +
    count
    integer

    Maximum number of events returned (10 by default).

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

    Comma-separated list of type identifiers.

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

    comma-separated list of language codes.

    +
    cursor
    string
    Example: cursor=MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy

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

    +

    Responses

    Response samples

    Content type
    {
    • "EventGroupList": {
      }
    }

    Calendar action

    /api/ibexa/v2/calendar/event/grouped-by-day

    Response samples

    Content type
    {
    • "EventGroupList": {
      }
    }

    Calendar action

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

    -
    path Parameters
    eventType
    required
    string
    header Parameters
    Content-Type
    required
    string
    Request Body schema:
    optional

    The new EventExecuteActionController resource

    -
    required
    object (UnscheduleAction)

    This class represents events to unschedule

    -

    Responses

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

    The type of event to execute an action on.

    +
    Request Body schema:
    required

    Data for the calendar action to execute

    +
    required
    object (RescheduleAction)

    This class represents events to reschedule

    +

    Responses

    Request samples

    Content type
    {
    • "UnscheduleAction": {
      }
    }

    Product Attribute

    Load attributes (deprecated)

    /api/ibexa/v2/calendar/event/{eventType}

    Request samples

    Content type
    {
    • "RescheduleAction": {
      }
    }

    Product Attribute

    Load attributes (deprecated)

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

    -
    header Parameters
    Accept
    required
    string

    AttributeList - If set, the attributes list is returned in XML or JSON format.

    -

    Responses

    Request Body schema:
    optional

    Attribute filter

    +
    required
    object (AttributeListGet)

    This class represents an attribute list query

    +

    Responses

    Response samples

    Content type
    {
    • "AttributeList": {
      }
    }

    Create attribute

    /api/ibexa/v2/product/catalog/attributes

    Request samples

    Content type
    {
    • "AttributeListGet": {
      }
    }

    Response samples

    Content type
    {
    • "AttributeList": {
      }
    }

    Create attribute

    Creates a new attribute.

    -
    header Parameters
    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.

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

    The new AttributeCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

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

    The attribute schema encoded in XML or JSON format.

    required
    object (AttributeCreate)

    This class is used to create an attribute.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Delete attribute translation

    /api/ibexa/v2/product/catalog/attributes

    Request samples

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

    Response samples

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

    Delete attribute translation

    The given translation is removed from the attribute.

    -
    path Parameters
    id
    required
    string
    languageCode
    required
    string

    Responses

    Filter attributes

    /api/ibexa/v2/product/catalog/attributes/translation/{id}/{languageCode}

    Filter attributes

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

    -
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new AttributeViewController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (AttributeViewInput)

    This class represents an attribute view input.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "AttributeView": {
      }
    }

    Load attribute

    /api/ibexa/v2/product/catalog/attributes/view

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "AttributeView": {
      }
    }

    Load attribute

    Loads given attribute.

    -
    path Parameters
    id
    required
    string
    header Parameters
    Accept
    required
    string

    Attribute - If set, the given attribute is returned in XML or JSON format.

    -

    Responses

    path Parameters
    id
    required
    string

    Responses

    Response samples

    Content type
    {
    • "Attribute": {
      }
    }

    Delete attribute

    /api/ibexa/v2/product/catalog/attributes/{id}

    Response samples

    Content type
    {
    • "Attribute": {
      }
    }

    Delete attribute

    The given attribute is removed from the attribute group.

    -
    path Parameters
    id
    required
    string

    Responses

    Update attribute

    /api/ibexa/v2/product/catalog/attributes/{id}

    Update attribute

    Updates an attribute.

    -
    path Parameters
    id
    required
    string
    group_id
    required
    string
    header Parameters
    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.

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

    The updated AttributeUpdateController resource

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

    The CSRF token is required when passing user session.

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

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

    required
    object (AttributeUpdate)

    This class is used to update an attribute.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Product Attribute Type

    List Attribute Types

    /api/ibexa/v2/product/catalog/attributes/{id}/{group_id}

    Request samples

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

    Response samples

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

    Product Attribute Type

    List Attribute Types

    Lists all Attribute Types.

    -
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "AttributeTypeList": {
      }
    }

    Get Attribute Type

    /api/ibexa/v2/product/catalog/attribute_types

    Response samples

    Content type
    {
    • "AttributeTypeList": {
      }
    }

    Get Attribute Type

    Gets an Attribute Type by its identifier.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "AttributeType": {
      }
    }

    Product Attribute Group

    Load attribute groups (deprecated)

    /api/ibexa/v2/product/catalog/attribute_types/{identifier}

    Response samples

    Content type
    {
    • "AttributeType": {
      }
    }

    Product Attribute Group

    Load attribute groups (deprecated)

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

    -
    header Parameters
    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.

    -
    Request Body schema: application/vnd.ibexa.api.AttributeGroupListGet+json
    optional
    required
    object (AttributeGroupListGet)
    Request Body schema: application/vnd.ibexa.api.AttributeGroupListGet+json
    optional

    The AttributeGroupListGet schema encoded in XML or JSON format.

    +
    required
    object (AttributeGroupListGet)

    This class represents an attribute group list request.

    -

    Responses

    Responses

    Request samples

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

    Response samples

    Content type
    {
    • "AttributeGroupList": {
      }
    }

    Create attribute group

    /api/ibexa/v2/product/catalog/attribute_groups

    Request samples

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

    Response samples

    Content type
    {
    • "AttributeGroupList": {
      }
    }

    Create attribute group

    Creates a new attribute group.

    -
    header Parameters
    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.

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

    The new AttributeGroupCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

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

    The AttributeGroup schema encoded in XML or JSON format.

    required
    object (AttributeGroupCreate)

    This class is used to create an attribute group.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Delete attribute group translation

    /api/ibexa/v2/product/catalog/attribute_groups

    Request samples

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

    Response samples

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

    Delete attribute group translation

    Deletes given translation from attribute group.

    -
    path Parameters
    id
    required
    string
    languageCode
    required
    string

    Responses

    Filter attribute groups

    /api/ibexa/v2/product/catalog/attribute_groups/translation/{id}/{languageCode}

    Filter attribute groups

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

    -
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new AttributeGroupViewController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (AttributeGroupViewInput)

    This class represents an attribute group view input.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "AttributeGroupView": {
      }
    }

    Load attribute group

    /api/ibexa/v2/product/catalog/attribute_groups/view

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "AttributeGroupView": {
      }
    }

    Load attribute group

    Returns the given attribute group.

    -
    path Parameters
    id
    required
    string
    header Parameters
    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.

    -
    Request Body schema:
    optional
    required
    object (AttributeGroupGet)
    path Parameters
    id
    required
    string
    Request Body schema:
    optional

    An optional AttributeGroupGet schema encoded in XML or JSON format.

    +
    required
    object (AttributeGroupGet)

    This class represents an attribute group query.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "AttributeGroupGet": {
      }
    }

    Response samples

    Content type
    {
    • "AttributeGroup": {
      }
    }

    Delete attribute group

    /api/ibexa/v2/product/catalog/attribute_groups/{id}

    Request samples

    Content type
    {
    • "AttributeGroupGet": {
      }
    }

    Response samples

    Content type
    {
    • "AttributeGroup": {
      }
    }

    Delete attribute group

    Deletes an attribute group.

    -
    path Parameters
    id
    required
    string

    Responses

    Update attribute group

    /api/ibexa/v2/product/catalog/attribute_groups/{id}

    Update attribute group

    Updates an attribute group.

    -
    path Parameters
    id
    required
    string
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The updated AttributeGroupUpdateController resource

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

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

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

    required
    object (AttributeGroupUpdate)

    This class is used to update an attribute group.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "AttributeGroupUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "AttributeGroup": {
      }
    }

    Product Catalog

    Create catalog

    /api/ibexa/v2/product/catalog/attribute_groups/{id}

    Request samples

    Content type
    {
    • "AttributeGroupUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "AttributeGroup": {
      }
    }

    Product Catalog

    Create catalog

    Creates a new catalog.

    -
    header Parameters
    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.

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

    The new CatalogCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

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

    The catalog schema encoded in XML or JSON format.

    required
    object (CatalogCreate)

    This class is used to create a catalog.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Copy catalog

    /api/ibexa/v2/product/catalog/catalogs

    Request samples

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

    Response samples

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

    Copy catalog

    Copies a catalog.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    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.

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

    The new CatalogCopyController resource

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

    The CSRF token is required when passing user session.

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

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

    required
    object (CatalogCopy)

    This class is used to copy a catalog.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Load catalog filters

    /api/ibexa/v2/product/catalog/catalogs/copy/{identifier}

    Request samples

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

    Response samples

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

    Load catalog filters

    Loads product filters available for catalogs.

    -
    header Parameters
    Accept
    required
    string

    If set, the filters are returned in XML or JSON format.

    -

    Responses

    Responses

    Response samples

    Content type
    {
    • "ProductFilterList": {
      }
    }

    Load catalog sort clauses

    /api/ibexa/v2/product/catalog/catalogs/filters

    Response samples

    Content type
    {
    • "ProductFilterList": {
      }
    }

    Load catalog sort clauses

    Loads product sort clauses available for catalogs.

    -
    header Parameters
    Accept
    required
    string

    If set, the clauses are returned in XML or JSON format.

    -

    Responses

    Responses

    Response samples

    Content type
    {
    • "ProductSortClauseList": {
      }
    }

    Filter catalogs

    /api/ibexa/v2/product/catalog/catalogs/sort_clauses

    Response samples

    Content type
    {
    • "ProductSortClauseList": {
      }
    }

    Filter catalogs

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

    -
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new CatalogViewController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (CatalogViewInput)

    This class represents a catalog view input.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "CatalogView": {
      }
    }

    Load catalog

    /api/ibexa/v2/product/catalog/catalogs/view

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "CatalogView": {
      }
    }

    Load catalog

    Loads the given catalog.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

    Content type
    {
    • "Catalog": {
      }
    }

    Delete catalog

    /api/ibexa/v2/product/catalog/catalogs/{identifier}

    Response samples

    Content type
    {
    • "Catalog": {
      }
    }

    Delete catalog

    Deletes the given catalog.

    -
    path Parameters
    identifier
    required
    string

    Responses

    Update catalog

    /api/ibexa/v2/product/catalog/catalogs/{identifier}

    Update catalog

    Updates a catalog.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    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.

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

    The updated CatalogUpdateController resource

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

    The CSRF token is required when passing user session.

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

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

    required
    object (CatalogUpdate)

    This class is used to update a catalog.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Filter catalog products

    /api/ibexa/v2/product/catalog/catalogs/{identifier}

    Request samples

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

    Response samples

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

    Filter catalog products

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

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new CatalogProductsViewController resource

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

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (ProductViewInput)

    This class represents a product view input.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "ProductView": {
      }
    }

    Product Currency

    Load currencies

    /api/ibexa/v2/product/catalog/catalogs/{identifier}/products/view

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "ProductView": {
      }
    }

    Product Currency

    Load currencies

    Loads the list of currencies.

    -
    header Parameters
    Accept
    required
    string

    CurrencyList - If set, the currency list returned in XML or JSON format.

    -

    Responses

    Response samples

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

    Create currency

    /api/ibexa/v2/product/catalog/currencies

    Response samples

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

    Create currency

    Creates a new currency.

    -
    header Parameters
    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.

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

    The new CurrencyCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

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

    The Currency schema encoded in XML or JSON format.

    required
    object (CurrencyCreate)

    This class is used to create currency.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Filter currencies

    /api/ibexa/v2/product/catalog/currencies

    Request samples

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

    Response samples

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

    Filter currencies

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

    -
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new CurrencyViewController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (CurrencyViewInput)

    This class represents a currency view input.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "CurrencyView": {
      }
    }

    Load currency

    /api/ibexa/v2/product/catalog/currencies/view

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "CurrencyView": {
      }
    }

    Load currency

    Loads a currency.

    -
    path Parameters
    id
    required
    string
    header Parameters
    Accept
    required
    string

    Currency - If set, the currency returned in XML or JSON format.

    -

    Responses

    Response samples

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

    Delete currency

    /api/ibexa/v2/product/catalog/currencies/{id}

    Response samples

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

    Delete currency

    Deletes the given currency.

    -
    path Parameters
    id
    required
    string

    Responses

    Update currency

    /api/ibexa/v2/product/catalog/currencies/{id}

    Update currency

    Updates a currency.

    -
    path Parameters
    id
    required
    string
    header Parameters
    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.

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

    The updated CurrencyUpdateController resource

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

    The CSRF token is required when passing user session.

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

    The CurrencyUpdate schema encoded in XML or JSON format.

    required
    object (CurrencyUpdate)

    This class is used to update currency.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Product Customer Group

    Load customer groups

    /api/ibexa/v2/product/catalog/currencies/{id}

    Request samples

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

    Response samples

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

    Product Customer Group

    Load customer groups

    Returns a list of customer groups

    -
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Responses

    Response samples

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

    Create customer group

    /api/ibexa/v2/product/catalog/customer_groups

    Response samples

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

    Create customer group

    Creates a new customer group.

    -
    header Parameters
    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.

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

    The new CustomerGroupCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

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

    The CustomerGroupCreate schema encoded in XML or JSON format.

    required
    object (CustomerGroupCreate)

    This class is used to create a customer group.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Filter customer groups

    /api/ibexa/v2/product/catalog/customer_groups

    Request samples

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

    Response samples

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

    Filter customer groups

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

    -
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new CustomerGroupViewController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (CustomerGroupViewInput)

    This class represents a customer group view input.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "CustomerGroupView": {
      }
    }

    Load customer group

    /api/ibexa/v2/product/catalog/customer_groups/view

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "CustomerGroupView": {
      }
    }

    Load customer group

    Returns a customer group

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

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

    Delete customer group

    /api/ibexa/v2/product/catalog/customer_groups/{identifier}

    Response samples

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

    Delete customer group

    Deletes the given customer group.

    -
    path Parameters
    identifier
    required
    string

    Responses

    Update customer group

    /api/ibexa/v2/product/catalog/customer_groups/{identifier}

    Update customer group

    Updates the given customer group.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    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.

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

    The updated CustomerGroupUpdateController resource

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

    The CSRF token is required when passing user session.

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

    The CustomerGroupUpdate schema encoded in XML or JSON format.

    required
    object (CustomerGroupUpdate)

    This class is used to update a customer group.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Load customer group

    /api/ibexa/v2/product/catalog/customer_groups/{identifier}

    Request samples

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

    Response samples

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

    Load customer group

    Returns a customer group

    -
    path Parameters
    id
    required
    integer
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    path Parameters
    id
    required
    integer

    Responses

    Response samples

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

    Product

    Load products list (deprecated)

    /api/ibexa/v2/product/catalog/customer_groups/{id}

    Response samples

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

    Product

    Load products list (deprecated)

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

    -
    header Parameters
    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.

    -
    Request Body schema: application/vnd.ibexa.api.ProductListGet+json
    optional
    required
    object (ProductListGet)
    Request Body schema: application/vnd.ibexa.api.ProductListGet+json
    optional

    The product list schema encoded in XML or JSON format.

    +
    required
    object (ProductListGet)

    This class represents a product list GET.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Filter products

    /api/ibexa/v2/product/catalog/products

    Request samples

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

    Response samples

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

    Filter products

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

    -
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new ProductViewController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (ProductViewInput)

    This class represents a product view input.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "ProductView": {
      }
    }

    Load the given product

    /api/ibexa/v2/product/catalog/products/view

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "ProductView": {
      }
    }

    Load the given product

    Loads the given product.

    -
    path Parameters
    code
    required
    string
    header Parameters
    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.

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

    An optional product schema encoded in XML or JSON format.

    +
    required
    object (ProductGet)

    This class represents a product GET.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Update product

    /api/ibexa/v2/product/catalog/products/{code}

    Request samples

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

    Response samples

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

    Update product

    Updates product.

    -
    path Parameters
    code
    required
    string
    header Parameters
    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.

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

    The updated ProductUpdateController resource

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

    The CSRF token is required when passing user session.

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

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

    required
    object (ProductUpdate)

    This class is used to update a product.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Load the list of product prices

    /api/ibexa/v2/product/catalog/products/{code}

    Request samples

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

    Response samples

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

    Load the list of product prices

    Loads the list of product prices.

    -
    path Parameters
    code
    required
    string
    header Parameters
    Accept
    required
    string

    PriceList - if set, the product price list is returned in JSON format.

    -

    Responses

    Response samples

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

    Create product price or custom price

    /api/ibexa/v2/product/catalog/products/{code}/prices

    Response samples

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

    Create product price or custom price

    Create product price or custom price.

    -
    path Parameters
    code
    required
    string
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The new PriceCreateController resource

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

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The product price schema encoded in JSON format.

    required
    object (CustomPriceCreateStruct)

    This class represents a custom price creation structure.

    Responses

    Request samples

    Content type
    {
    • "CustomPriceCreateStruct": {
      }
    }

    Response samples

    Content type
    {
    • "CustomPrice": {
      }
    }

    Get price in given currency

    /api/ibexa/v2/product/catalog/products/{code}/prices

    Request samples

    Content type
    {
    • "CustomPriceCreateStruct": {
      }
    }

    Response samples

    Content type
    {
    • "CustomPrice": {
      }
    }

    Get price in given currency

    Get price in given currency.

    -
    path Parameters
    code
    required
    string
    currencyCode
    required
    string
    header Parameters
    Accept
    required
    string

    If set, gets price in given currency in JSON format.

    -

    Responses

    Response samples

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

    Get price in given currency and customer group

    /api/ibexa/v2/product/catalog/products/{code}/prices/{currencyCode}

    Response samples

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

    Get price in given currency and customer group

    Get price in given currency and customer group.

    -
    path Parameters
    code
    required
    string
    currencyCode
    required
    string
    customerGroupIdentifier
    required
    string
    header Parameters
    Accept
    required
    string

    If set, gets price in given currency and customer group in JSON format.

    -

    Responses

    Response samples

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

    Delete product price

    /api/ibexa/v2/product/catalog/products/{code}/prices/{currencyCode}/customer-group/{customerGroupIdentifier}

    Response samples

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

    Delete product price

    Deletes product price.

    -
    path Parameters
    code
    required
    string
    id
    required
    string
    header Parameters
    Accept
    required
    string

    If set, deletes price of given id.

    -
    Content-Type
    required
    string

    Delete product price.

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

    The CSRF token is required when passing user session.

    Responses

    Update product price

    /api/ibexa/v2/product/catalog/products/{code}/prices/{id}

    Update product price

    Updates product price.

    -
    path Parameters
    code
    required
    string
    id
    required
    string
    header Parameters
    Accept
    required
    string

    If set, updates product price.

    -
    Content-Type
    required
    string

    Update price or custom price for given currency.

    -
    Request Body schema:
    optional

    The updated PriceUpdateController resource

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

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    Update price or custom price for given currency.

    required
    object (CustomPriceUpdateStruct)

    This class represents a custom price updating structure.

    Responses

    Request samples

    Content type
    {
    • "CustomPriceUpdateStruct": {
      }
    }

    Response samples

    Content type
    {
    • "CustomPrice": {
      }
    }

    Delete product

    /api/ibexa/v2/product/catalog/products/{code}/prices/{id}

    Request samples

    Content type
    {
    • "CustomPriceUpdateStruct": {
      }
    }

    Response samples

    Content type
    {
    • "CustomPrice": {
      }
    }

    Delete product

    Deletes the given product.

    -
    path Parameters
    identifier
    required
    string

    Responses

    Create product

    /api/ibexa/v2/product/catalog/products/{identifier}

    Create product

    Creates a new product.

    -
    path Parameters
    productTypeIdentifier
    required
    string
    header Parameters
    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.

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

    The new ProductCreateController resource

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

    The CSRF token is required when passing user session.

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

    The product schema encoded in XML or JSON format.

    required
    object (ProductCreate)

    This class is used to create a product.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Product Type

    Load product types (deprecated)

    /api/ibexa/v2/product/catalog/products/{productTypeIdentifier}

    Request samples

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

    Response samples

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

    Product Type

    Load product types (deprecated)

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

    -
    header Parameters
    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.

    -
    Request Body schema:
    optional
    required
    object (ProductTypeListGet)
    Request Body schema:
    optional

    The ProductTypeList schema encoded in XML or JSON format.

    +
    required
    object (ProductTypeListGet)

    This class represents a product type list query.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ProductTypeListGet": {
      }
    }

    Response samples

    Content type
    {
    • "ProductTypeList": {
      }
    }

    Create product type

    /api/ibexa/v2/product/catalog/product_types

    Request samples

    Content type
    {
    • "ProductTypeListGet": {
      }
    }

    Response samples

    Content type
    {
    • "ProductTypeList": {
      }
    }

    Create product type

    Creates a new product type.

    -
    header Parameters
    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.

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

    The new ProductTypeCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

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

    The ProductType schema encoded in XML or JSON format.

    required
    object (ProductTypeCreate)

    This class is used to create a product type.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Check product type usage

    /api/ibexa/v2/product/catalog/product_types

    Request samples

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

    Response samples

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

    Check product type usage

    Checks whether the product type is in use.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    Responses

    Response samples

    Content type
    {
    • "ProductTypeUsage": {
      }
    }

    Filter product types

    /api/ibexa/v2/product/catalog/product_types/is_used/{identifier}

    Response samples

    Content type
    {
    • "ProductTypeUsage": {
      }
    }

    Filter product types

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

    -
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new ProductTypeViewController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (ProductTypeViewInput)

    This class represents a product type view input.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "ProductTypeView": {
      }
    }

    Load product type

    /api/ibexa/v2/product/catalog/product_types/view

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "ProductTypeView": {
      }
    }

    Load product type

    Returns the given product type.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    Responses

    Response samples

    Content type
    {
    • "ProductTypeUsage": {
      }
    }

    Delete product type

    /api/ibexa/v2/product/catalog/product_types/{identifier}

    Response samples

    Content type
    {
    • "ProductType": {
      }
    }

    Delete product type

    Deletes the given product type.

    -
    path Parameters
    id
    required
    string

    Responses

    Update product type

    /api/ibexa/v2/product/catalog/product_types/{id}

    Update product type

    Updates product type.

    -
    path Parameters
    id
    required
    string
    header Parameters
    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.

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

    The updated ProductTypeUpdateController resource

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

    The CSRF token is required when passing user session.

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

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

    required
    object (ProductTypeUpdate)

    This class is used to update a product type.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Product Variant

    Load product variant

    /api/ibexa/v2/product/catalog/product_types/{id}

    Request samples

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

    Response samples

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

    Product Variant

    Load product variant

    Loads the given product variant.

    -
    path Parameters
    code
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    path Parameters
    code
    required
    string

    Responses

    Response samples

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

    Generate product variants

    /api/ibexa/v2/product/catalog/product_variant/{code}

    Response samples

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

    Generate product variants

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

    -
    path Parameters
    baseProductCode
    required
    string
    header Parameters
    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.

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

    The new ProductVariantGenereateController resource

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

    The CSRF token is required when passing user session.

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

    The product variant schema encoded in XML or JSON format.

    required
    object (ProductVariantGenerate)

    This class is used to generate a product variant.

    Responses

    Request samples

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

    Filter product variants

    /api/ibexa/v2/product/catalog/product_variants/generate/{baseProductCode}

    Request samples

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

    Filter product variants

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

    -
    path Parameters
    baseProductCode
    required
    string
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new ProductVariantViewController resource

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

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (ProductVariantViewInput)

    This class represents a product variant view input.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "ProductVariantView": {
      }
    }

    Create product variant

    /api/ibexa/v2/product/catalog/product_variants/view/{baseProductCode}

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "ProductVariantView": {
      }
    }

    Create product variant

    Creates a new product variant.

    -
    path Parameters
    baseProductCode
    required
    string
    header Parameters
    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.

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

    The new ProductVariantCreateController resource

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

    The CSRF token is required when passing user session.

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

    The product variant schema encoded in XML or JSON format.

    required
    object (ProductVariantCreate)

    This class is used to create a product variant.

    Responses

    Request samples

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

    Delete product variant

    /api/ibexa/v2/product/catalog/product_variants/{baseProductCode}

    Request samples

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

    Delete product variant

    Deletes the given product variant.

    -
    path Parameters
    code
    required
    string

    Responses

    Update product variant

    /api/ibexa/v2/product/catalog/product_variants/{code}

    Update product variant

    Updates product variant.

    -
    path Parameters
    code
    required
    string
    header Parameters
    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.

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

    The updated ProductVariantUpdateController resource

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

    The CSRF token is required when passing user session.

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

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

    required
    object (ProductVariantUpdate)

    This class is used to update a product variant.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Product Region

    Load regions

    /api/ibexa/v2/product/catalog/product_variants/{code}

    Request samples

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

    Response samples

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

    Product Region

    Load regions

    Loads the list of regions.

    -
    header Parameters
    Accept
    required
    string

    RegionList - If set, the regions list returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "RegionList": {
      }
    }

    Filter regions

    /api/ibexa/v2/product/catalog/regions

    Response samples

    Content type
    {
    • "RegionList": {
      }
    }

    Filter regions

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

    -
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new RegionViewController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token is required when passing user session.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    required
    object (RegionViewInput)

    This class represents a region view input.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "RegionView": {
      }
    }

    Load region

    /api/ibexa/v2/product/catalog/regions/view

    Request samples

    Content type
    {
    • "ViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "RegionView": {
      }
    }

    Load region

    Loads a region by its identifier

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    Responses

    Response samples

    Content type
    {
    • "Region": {
      }
    }

    Product Vat

    Load VAT region

    /api/ibexa/v2/product/catalog/regions/{identifier}

    Response samples

    Content type
    {
    • "Region": {
      }
    }

    Product Vat

    Load VAT region

    Loads a VAT category for the given region.

    -
    path Parameters
    region
    required
    string
    header Parameters
    Accept
    required
    string

    If set, the VAT category list returned in XML or JSON format.

    -

    Responses

    path Parameters
    region
    required
    string

    Responses

    Response samples

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

    Load VAT specific region

    /api/ibexa/v2/product/catalog/vat/{region}

    Response samples

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

    Load VAT specific region

    Loads a VAT category for the given identifier.

    -
    path Parameters
    region
    required
    string
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    If set, the VAT category list returned in XML or JSON format.

    -

    Responses

    path Parameters
    region
    required
    string
    identifier
    required
    string

    Responses

    Response samples

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

    Taxonomy

    Delete Entries

    /api/ibexa/v2/product/catalog/vat/{region}/{identifier}

    Response samples

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

    Taxonomy

    Delete Entries

    Bulk removes several taxonomy entries.

    -
    path Parameters
    taxonomyName
    required
    string
    header Parameters
    Content-Type
    required
    string

    Target Entries schema encoded in XML or JSON format.

    -
    Request Body schema:
    optional
    required
    object (TaxonomyEntryBulkRemove)
    path Parameters
    taxonomyName
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    +
    Request Body schema:
    optional

    TaxonomyEntryBulkRemove schema encoded in XML or JSON format.

    +
    required
    object (TaxonomyEntryBulkRemove)

    This class is used to bulk remove taxonomy entries.

    Responses

    Request samples

    Content type
    {
    • "TaxonomyEntryBulkRemove": {
      }
    }

    Move Entries

    /api/ibexa/v2/taxonomy/{taxonomyName}/entries

    Request samples

    Content type
    {
    • "TaxonomyEntryBulkRemove": {
      }
    }

    Move Entries

    Bulk move several taxonomy entries relative to sibling.

    -
    path Parameters
    taxonomyName
    required
    string
    header Parameters
    Content-Type
    required
    string

    The Entry moves schema encoded in XML or JSON format.

    -
    Request Body schema:
    optional

    The new TaxonomyEntryBulkMoveController resource

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

    The CSRF token.

    +
    Request Body schema:
    optional

    The TaxonomyEntryBulkMove schema encoded in XML or JSON format.

    required
    object (TaxonomyEntryBulkMove)

    This class is used to bulk move taxonomy entries.

    Responses

    Request samples

    Content type
    {
    • "TaxonomyEntryBulkMove": {
      }
    }

    Get Assignment by ID

    /api/ibexa/v2/taxonomy/{taxonomyName}/entries/move

    Request samples

    Content type
    {
    • "TaxonomyEntryBulkMove": {
      }
    }

    Get Assignment by ID

    Gets taxonomy entry Assignment by its ID.

    -
    path Parameters
    taxonomyName
    required
    string
    id
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "TaxonomyEntryAssignment": {
      }
    }

    Assign entry

    /api/ibexa/v2/taxonomy/{taxonomyName}/entry-assignment/{id}

    Response samples

    Content type
    {
    • "TaxonomyEntryAssignment": {
      }
    }

    Assign entry

    Assigns taxonomy entry to a content item.

    -
    path Parameters
    taxonomyName
    required
    string
    header Parameters
    Content-Type
    required
    string
    Request Body schema: application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json
    optional

    The new TaxonomyEntryAssignmentAssignController resource

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

    The CSRF token.

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

    TaxonomyEntryAssignToContent schema encoded in JSON format.

    required
    object (TaxonomyEntryAssignToContent)

    This class is used to assign taxonomy entry to content.

    Responses

    Request samples

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

    Get Assignments to a Content

    /api/ibexa/v2/taxonomy/{taxonomyName}/entry-assignments/assign-to-content

    Request samples

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

    Get Assignments to a Content

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

    -
    path Parameters
    taxonomyName
    required
    string
    contentId
    required
    string
    header Parameters
    Accept
    required
    string

    If set, the assignments are returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "EntryAssignmentCollection": {
      }
    }

    Unassign entry

    /api/ibexa/v2/taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}

    Response samples

    Content type
    {
    • "EntryAssignmentCollection": {
      }
    }

    Unassign entry

    Unassigns taxonomy entry from a content item.

    -
    path Parameters
    taxonomyName
    required
    string
    header Parameters
    Content-Type
    required
    string
    Request Body schema: application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json
    optional

    The new TaxonomyEntryAssignmentUnassignController resource

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

    The CSRF token.

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

    TaxonomyEntryUnassignFromContent schema encoded in JSON format.

    required
    object (TaxonomyEntryUnassignFromContent)

    This class is used to unassign taxonomy entry from content.

    Responses

    Request samples

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

    Get Entry by Content ID

    /api/ibexa/v2/taxonomy/{taxonomyName}/entry-assignments/unassign-from-content

    Request samples

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

    Get Entry by Content ID

    Loads taxonomy Entry by its Content ID.

    -
    path Parameters
    taxonomyName
    required
    string
    contentId
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "TaxonomyEntry": {
      }
    }

    Get Entry by identifier

    /api/ibexa/v2/taxonomy/{taxonomyName}/entry/content-id/{contentId}

    Response samples

    Content type
    {
    • "TaxonomyEntry": {
      }
    }

    Get Entry by identifier

    Loads taxonomy Entry by its Entry identifier.

    -
    path Parameters
    taxonomyName
    required
    string
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "TaxonomyEntry": {
      }
    }

    Get Entry by ID

    /api/ibexa/v2/taxonomy/{taxonomyName}/entry/identifier/{identifier}

    Response samples

    Content type
    {
    • "TaxonomyEntry": {
      }
    }

    Get Entry by ID

    Loads taxonomy Entry by its Entry ID.

    -
    path Parameters
    taxonomyName
    required
    string
    id
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "TaxonomyEntry": {
      }
    }

    Segmentation

    List segment groups ExperienceCommerce

    /api/ibexa/v2/taxonomy/{taxonomyName}/entry/{id}

    Response samples

    Content type
    {
    • "TaxonomyEntry": {
      }
    }

    Segmentation

    List segment groups ExperienceCommerce

    Lists segment groups.

    -
    header Parameters
    Accept
    required
    string

    If set, the list of segment groups is returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "SegmentGroupList": {
      }
    }

    Load segment group ExperienceCommerce

    /api/ibexa/v2/segment_groups

    Response samples

    Content type
    {
    • "SegmentGroupList": {
      }
    }

    Load segment group ExperienceCommerce

    Loads segment group.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "SegmentGroup": {
      }
    }

    List segment group's segments ExperienceCommerce

    /api/ibexa/v2/segment_groups/{identifier}

    Response samples

    Content type
    {
    • "SegmentGroup": {
      }
    }

    List segment group's segments ExperienceCommerce

    Lists segment group's segments.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Response samples

    Content type
    {
    • "SegmentList": {
      }
    }

    Load segment ExperienceCommerce

    /api/ibexa/v2/segment_groups/{identifier}/segments

    Response samples

    Content type
    {
    • "SegmentList": {
      }
    }

    Load segment ExperienceCommerce

    Loads the identified segment.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    If set, the segment is returned in XML or JSON

    -

    Responses

    Response samples

    Content type
    {
    • "Segment": {
      }
    }

    Corporate Account

    Root Resource ExperienceCommerce

    /api/ibexa/v2/segments/{identifier}

    Response samples

    Content type
    {
    • "Segment": {
      }
    }

    Corporate Account

    Root Resource ExperienceCommerce

    Provides basic information about Corporate Account endpoints and configuration.

    -
    header Parameters
    Accept
    required
    string

    If set, helps to determine response format.

    -

    Responses

    Response samples

    Content type
    {
    • "CorporateAccountRoot": {
      }
    }

    Read list of companies ExperienceCommerce

    /api/ibexa/v2/corporate

    Response samples

    Content type
    {
    • "CorporateAccountRoot": {
      }
    }

    Read list of companies ExperienceCommerce

    Returns paginated list of available companies.

    -
    header Parameters
    Accept
    required
    string

    If set, helps to determine response format.

    -

    Responses

    Response samples

    Content type
    {
    • "CompanyList": {
      }
    }

    Create a company ExperienceCommerce

    /api/ibexa/v2/corporate/companies

    Response samples

    Content type
    {
    • "CompanyList": {
      }
    }

    Create a company ExperienceCommerce

    Creates a CompanyCreateController resource.

    -
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The new CompanyCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

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

    +
    Request Body schema:
    optional

    The CompanyCreate schema encoded in XML or JSON format.

    required
    object (CompanyCreate)

    This class is used to create a company.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "CompanyCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Get company ExperienceCommerce

    /api/ibexa/v2/corporate/companies

    Request samples

    Content type
    {
    • "CompanyCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Get company ExperienceCommerce

    Returns the company by given company ID.

    -
    path Parameters
    companyId
    required
    string
    header Parameters
    Accept
    required
    string

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

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

    ETag

    -

    Responses

    Responses

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Delete company ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Delete company ExperienceCommerce

    The given company is deleted.

    -
    path Parameters
    companyId
    required
    string
    header Parameters
    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
    path Parameters
    companyId
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

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

    Responses

    Update a company ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}

    Update a company ExperienceCommerce

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

    -
    path Parameters
    companyId
    required
    string
    header Parameters
    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.

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

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

    If-Match
    required
    string

    ETag

    -
    Request Body schema:
    optional

    The updated CompanyUpdateController resource

    +
    Request Body schema:
    optional

    The company input schema encoded in XML or JSON.

    required
    object (CompanyUpdate)

    This class is used to update a Company.

    Responses

    Request samples

    Content type
    {
    • "CompanyUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Read list of company members ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}

    Request samples

    Content type
    {
    • "CompanyUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Read list of company members ExperienceCommerce

    Returns paginated list of a given company members.

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

    DateTime as a UNIX timestamp

    -
    sort[ContentName]
    string
    Enum: "ascending" "descending"
    sort[DatePublished]
    string
    Enum: "ascending" "descending"
    sort[DateModified]
    string
    Enum: "ascending" "descending"
    offset
    integer
    limit
    integer
    header Parameters
    Accept
    required
    string
    Enum: "application/vnd.ibexa.api.MemberList+xml" "application/vnd.ibexa.api.MemberList+json"

    If set, helps to determine response format.

    -

    Responses

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

    Responses

    Response samples

    Content type
    {
    • "MemberList": {
      }
    }

    Create a company member ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}/members

    Response samples

    Content type
    {
    • "MemberList": {
      }
    }

    Create a company member ExperienceCommerce

    Creates a company member.

    -
    path Parameters
    companyId
    required
    string
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The new MemberCreateController resource

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

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

    +
    Request Body schema:
    optional

    The MemberCreate schema encoded in XML or JSON format.

    required
    object (MemberCreate)

    This class is used to create a member.

    Responses

    Request samples

    Content type
    {
    • "MemberCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Get company member ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}/members

    Request samples

    Content type
    {
    • "MemberCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Get company member ExperienceCommerce

    Returns the company member by given member ID.

    -
    path Parameters
    companyId
    required
    string
    memberId
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    path Parameters
    companyId
    required
    string
    memberId
    required
    string

    Responses

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Delete company member ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}/members/{memberId}

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Delete company member ExperienceCommerce

    The given company member is deleted.

    -
    path Parameters
    companyId
    required
    string
    memberId
    required
    string
    header Parameters
    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
    path Parameters
    companyId
    required
    string
    memberId
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

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

    Responses

    Update a company member ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}/members/{memberId}

    Update a company member ExperienceCommerce

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

    -
    path Parameters
    companyId
    required
    string
    memberId
    required
    string
    header Parameters
    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.

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

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

    If-Match
    required
    string

    ETag

    -
    Request Body schema:
    optional

    The updated MemberUpdateController resource

    +
    Request Body schema:
    optional

    The company input schema encoded in XML or JSON.

    required
    object (MemberUpdate)

    This class is used to update a member.

    Responses

    Request samples

    Content type
    {
    • "MemberUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Read list of sales representatives ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}/members/{memberId}

    Request samples

    Content type
    {
    • "MemberUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Read list of sales representatives ExperienceCommerce

    Returns paginated list of available sales representatives.

    -
    header Parameters
    Accept
    required
    string

    If set, helps to determine response format.

    -

    Responses

    Response samples

    Content type
    {
    • "SalesRepresentativesList": {
      }
    }

    Activity Log

    List of activity log groups ExperienceCommerce

    /api/ibexa/v2/corporate/sales-representatives

    Response samples

    Content type
    {
    • "SalesRepresentativesList": {
      }
    }

    Activity Log

    List of activity log groups ExperienceCommerce

    Lists last activity log groups and their entries.

    -
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    Responses

    Response samples

    Content type
    {
    • "ActivityLogGroupList": {
      }
    }

    Cart

    Create Cart Commerce

    /api/ibexa/v2/activity-log-group/list

    Response samples

    Content type
    {
    • "ActivityLogGroupList": {
      }
    }

    List of activity log groups ExperienceCommerce

    Lists last activity log groups and their entries.

    +
    header Parameters
    X-CSRF-Token
    required
    string

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

    +
    Request Body schema:
    optional

    The query to filter activity log groups.

    +
    required
    object (ActivityLogGroupListInput)

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

    +

    Responses

    Request samples

    Content type
    {
    • "ActivityLogGroupListInput": {
      }
    }

    Response samples

    Content type
    {
    • "ActivityLogGroupList": {
      }
    }

    Cart

    Create Cart Commerce

    Creates Cart from payload.

    -
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The new CartCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    +
    Request Body schema:
    optional

    The CartCreate schema encoded in XML or JSON format.

    required
    object (CartCreate)

    This class represents a new Cart to create

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "CartCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Filter carts Commerce

    /api/ibexa/v2/cart

    Request samples

    Content type
    {
    • "CartCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Filter carts Commerce

    Executes a query and returns a View including the results.

    -
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The new CartViewController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    +
    Request Body schema:
    optional

    The CartViewInput schema is posted in XML or JSON format.

    required
    object (CartViewInput)

    This class represents a cart view input.

    Responses

    Request samples

    Content type
    {
    • "CartViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "CartView": {
      }
    }

    Get Cart Commerce

    /api/ibexa/v2/cart/view

    Request samples

    Content type
    {
    • "CartViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "CartView": {
      }
    }

    Get Cart Commerce

    Gets Cart by its identifier.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    The Cart is returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Delete Cart Commerce

    /api/ibexa/v2/cart/{identifier}

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Delete Cart Commerce

    Deletes Cart by its identifier.

    -
    path Parameters
    identifier
    required
    string

    Responses

    Update Cart's metadata Commerce

    /api/ibexa/v2/cart/{identifier}

    Update Cart's metadata Commerce

    Updates identified Cart's metadata from payload.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The updated CartUpdateController resource

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

    The CSRF token.

    +
    Request Body schema:
    optional

    The CartMetadataUpdate schema encoded in XML or JSON format.

    required
    object (CartMetadataUpdate)

    This class represents the update of cart metadata.

    Responses

    Request samples

    Content type
    {
    • "CartMetadataUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Empty Cart Commerce

    /api/ibexa/v2/cart/{identifier}

    Request samples

    Content type
    {
    • "CartMetadataUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Empty Cart Commerce

    Empties the given Cart.

    -
    path Parameters
    identifier
    required
    string

    Responses

    Add Entry to Cart Commerce

    /api/ibexa/v2/cart/{identifier}/empty

    Add Entry to Cart Commerce

    Adds an entry to the cart referenced by its identifier

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The new CartEntryCreateController resource

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

    The CSRF token.

    +
    Request Body schema:
    optional

    The CartEntryAdd schema encoded in XML or JSON format.

    required
    object (CartEntryAdd)

    This class represents a cart entry

    Responses

    Request samples

    Content type
    {
    • "CartEntryAdd": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Remove Entry from Cart Commerce

    /api/ibexa/v2/cart/{identifier}/entry

    Request samples

    Content type
    {
    • "CartEntryAdd": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Remove Entry from Cart Commerce

    Removes the given entry from the given Cart.

    -
    path Parameters
    identifier
    required
    string
    entryId
    required
    string
    header Parameters
    Accept
    required
    string

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

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

    The CSRF token.

    Responses

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Update Entry from Cart Commerce

    /api/ibexa/v2/cart/{identifier}/entry/{entryId}

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Update Entry from Cart Commerce

    Updates the given entry from the given Cart.

    -
    path Parameters
    identifier
    required
    string
    entryId
    required
    string
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The updated CartEntryUpdateController resource

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

    The CSRF token.

    +
    Request Body schema:
    optional

    The CartEntryUpdate schema encoded in XML or JSON format.

    required
    object (CartEntryUpdate)

    Responses

    Request samples

    Content type
    {
    • "CartEntryUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Move Selected Cart Entries to Default Shopping List Commerce

    /api/ibexa/v2/cart/{identifier}/entry/{entryId}

    Request samples

    Content type
    {
    • "CartEntryUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Move Selected Cart Entries to Default Shopping List Commerce

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

    path Parameters
    identifier
    required
    string

    The Cart identifier

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    -
    Request Body schema:
    optional

    The new MoveCartEntriesToShoppingListController resource

    +
    Request Body schema:
    optional

    The CartEntryIdentifiers schema encoded in XML or JSON format.

    required
    object (CartEntryIdentifiers)

    This class represents a list of cart entry identifiers

    Responses

    Request samples

    Content type
    { }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Selected Cart Entries to Specific Shopping List Commerce

    /api/ibexa/v2/cart/{identifier}/move-entries-to-shopping-list

    Request samples

    Content type
    {
    • "CartEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Selected Cart Entries to Specific Shopping List Commerce

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

    path Parameters
    identifier
    required
    string

    The Cart identifier

    @@ -4006,8 +3824,8 @@ " class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">

    The Shopping List identifier

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    -
    Request Body schema:
    optional

    The new MoveCartEntriesToShoppingListController resource

    +
    Request Body schema:
    optional

    The CartEntryIdentifiers schema encoded in XML or JSON format.

    required
    object (CartEntryIdentifiers)

    This class represents a list of cart entry identifiers

    Responses

    Request samples

    Content type
    { }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Cart to Default Shopping List Commerce

    /api/ibexa/v2/cart/{identifier}/move-entries-to-shopping-list/{shoppingListIdentifier}

    Request samples

    Content type
    {
    • "CartEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Cart to Default Shopping List Commerce

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

    path Parameters
    identifier
    required
    string

    The Cart identifier

    @@ -4034,7 +3852,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the cart identifier doesn't match any existing resource.

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Cart to Specific Shopping List Commerce

    /api/ibexa/v2/cart/{identifier}/move-to-shopping-list

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Cart to Specific Shopping List Commerce

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

    path Parameters
    identifier
    required
    string

    The Cart identifier

    @@ -4050,19 +3868,17 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the cart or shopping list identifier doesn't match any existing resource.

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Cart Summary Commerce

    /api/ibexa/v2/cart/{identifier}/move-to-shopping-list/{shoppingListIdentifier}

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Cart Summary Commerce

    Gets a summary of the given Cart.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

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

    -

    Responses

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

    Content type
    {
    • "CartSummary": {
      }
    }

    Shopping List

    List shopping lists CommerceLTS Update

    /api/ibexa/v2/cart/{identifier}/summary

    Response samples

    Content type
    {
    • "CartSummary": {
      }
    }

    Shopping List

    List shopping lists CommerceLTS Update

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

    query Parameters
    limit
    integer
    Default: 25

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

    @@ -4092,12 +3908,12 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - The user is not authorized to list shopping lists.

    Response samples

    Content type
    {
    • "ShoppingListCollection": {
      }
    }

    Create shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list

    Response samples

    Content type
    {
    • "ShoppingListCollection": {
      }
    }

    Create shopping list CommerceLTS Update

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

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    -
    Request Body schema:
    optional

    The new ShoppingListCreateController resource

    +
    Request Body schema:
    optional

    Shopping list to create

    required
    object (ShoppingListCreate)

    Creates a new shopping list.

    Responses

    Request samples

    Content type
    {
    • "ShoppingListCreate": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add entries to default shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list

    Request samples

    Content type
    {
    • "ShoppingListCreate": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add entries to default shopping list CommerceLTS Update

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

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    -
    Request Body schema:
    optional

    The new ShoppingListAddToDefaultEntriesController resource

    +
    Request Body schema:
    optional

    Entries to add to the default shopping list

    required
    object (ShoppingListEntriesAdd)

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

    Responses

    Request samples

    Content type
    {
    • "ShoppingListEntriesAdd": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Get shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/default/entries

    Request samples

    Content type
    {
    • "ShoppingListEntriesAdd": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Get shopping list CommerceLTS Update

    Gets a shopping list by its identifier.

    path Parameters
    identifier
    required
    string

    The shopping list identifier (UUID)

    @@ -4144,7 +3960,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the identifier does not match any shopping list.

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Delete shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Delete shopping list CommerceLTS Update

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

    path Parameters
    identifier
    required
    string

    The shopping list identifier (UUID).

    @@ -4160,14 +3976,14 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - Shopping list with the given identifier does not exist.

    Update shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}

    Update shopping list CommerceLTS Update

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

    path Parameters
    identifier
    required
    string

    The shopping list identifier (UUID).

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    -
    Request Body schema:
    optional

    The updated ShoppingListUpdateController resource

    +
    Request Body schema:
    optional

    Shopping list metadata to update

    required
    object (ShoppingListUpdate)

    Updates an existing shopping list.

    Responses

    Request samples

    Content type
    {
    • "ShoppingListUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add Selected Entries from Shopping List to Default Cart CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}

    Request samples

    Content type
    {
    • "ShoppingListUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add Selected Entries from Shopping List to Default Cart CommerceLTS Update

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

    path Parameters
    identifier
    required
    string

    The Shopping List identifier

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    -
    Request Body schema:
    optional

    The new AddEntriesToCartController resource

    +
    Request Body schema:
    optional

    The ShoppingListEntryIdentifiers schema encoded in XML or JSON format.

    required
    object (ShoppingListEntryIdentifiers)

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

    Responses

    Request samples

    Content type
    { }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Selected Entries from Shopping List to Specific Cart CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/add-entries-to-cart

    Request samples

    Content type
    {
    • "ShoppingListEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Selected Entries from Shopping List to Specific Cart CommerceLTS Update

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

    path Parameters
    identifier
    required
    string

    The Shopping List identifier

    @@ -4212,8 +4028,8 @@ " class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">

    The Cart identifier

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    -
    Request Body schema:
    optional

    The new AddEntriesToCartController resource

    +
    Request Body schema:
    optional

    The ShoppingListEntryIdentifiers schema encoded in XML or JSON format.

    required
    object (ShoppingListEntryIdentifiers)

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

    Responses

    Request samples

    Content type
    { }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Shopping List to Default Cart CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/add-entries-to-cart/{cartIdentifier}

    Request samples

    Content type
    {
    • "ShoppingListEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Shopping List to Default Cart CommerceLTS Update

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

    path Parameters
    identifier
    required
    string

    The Shopping List identifier

    @@ -4240,7 +4056,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the shopping list identifier doesn't match any existing resource.

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Shopping List to Specific Cart CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/add-to-cart

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Shopping List to Specific Cart CommerceLTS Update

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

    path Parameters
    identifier
    required
    string

    The Shopping List identifier

    @@ -4256,7 +4072,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the shopping list or cart identifier doesn't match any existing resource.

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Clear shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/add-to-cart/{cartIdentifier}

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Clear shopping list CommerceLTS Update

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

    path Parameters
    identifier
    required
    string

    The unique identifier (UUID) of the shopping list.

    @@ -4272,14 +4088,14 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - Shopping list not found.

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add entries to shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/clear

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add entries to shopping list CommerceLTS Update

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

    path Parameters
    identifier
    required
    string

    The unique identifier (UUID) of the shopping list.

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    -
    Request Body schema:
    optional

    The new ShoppingListAddEntriesController resource

    +
    Request Body schema:
    optional

    Entries to add to the shopping list

    required
    object (ShoppingListEntriesAdd)

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

    Responses

    Request samples

    Content type
    {
    • "ShoppingListEntriesAdd": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Remove entries from shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/entries

    Request samples

    Content type
    {
    • "ShoppingListEntriesAdd": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Remove entries from shopping list CommerceLTS Update

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

    path Parameters
    identifier
    required
    string

    The unique identifier (UUID) of the shopping list.

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    -
    Request Body schema:
    optional

    The new ShoppingListRemoveEntriesController resource

    +
    Request Body schema:
    optional

    Entries to remove from shopping list

    required
    object (ShoppingListEntriesRemove)

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

    Responses

    Request samples

    Content type
    {
    • "ShoppingListEntriesRemove": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Orders

    Cancel order Commerce

    /api/ibexa/v2/shopping-list/{identifier}/entries/remove

    Request samples

    Content type
    {
    • "ShoppingListEntriesRemove": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Orders

    Cancel order Commerce

    Cancels the given order.

    -
    path Parameters
    id
    required
    string

    Responses

    Load order by identifier Commerce

    /api/ibexa/v2/orders/order/cancel/{id}

    Load order by identifier Commerce

    Loads an order by its identifier (UUID).

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    Order - If set, the order returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "Order": {
      }
    }

    Load order by ID Commerce

    /api/ibexa/v2/orders/order/{identifier}

    Response samples

    Content type
    {
    • "Order": {
      }
    }

    Load order by ID Commerce

    Loads an order by its numerical ID.

    -
    path Parameters
    id
    required
    string
    header Parameters
    Accept
    required
    string

    Order - If set, the order returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "Order": {
      }
    }

    Update order Commerce

    /api/ibexa/v2/orders/order/{id}

    Response samples

    Content type
    {
    • "Order": {
      }
    }

    Update order Commerce

    Updates an order.

    -
    path Parameters
    id
    required
    string
    header Parameters
    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.

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

    The updated OrderUpdateController resource

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

    The CSRF token.

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

    The OrderUpdate schema encoded in XML or JSON format.

    required
    object (OrderUpdate)

    This class is used to update order.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Load orders Commerce

    /api/ibexa/v2/orders/order/{id}

    Request samples

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

    Response samples

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

    Load orders Commerce

    Loads a list of orders.

    -
    header Parameters
    Accept
    required
    string

    OrderList - If set, the orders list returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "OrderList": {
      }
    }

    Create order Commerce

    /api/ibexa/v2/orders/orders

    Response samples

    Content type
    {
    • "OrderList": {
      }
    }

    Create order Commerce

    Creates a new order.

    -
    header Parameters
    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.

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

    The new OrderCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

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

    The Order schema encoded in XML or JSON format.

    required
    object (OrderCreate)

    This class is used to create order.

    -

    Responses

    Responses

    Request samples

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

    Response samples

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

    Payments

    Create payment method Commerce

    /api/ibexa/v2/orders/orders

    Request samples

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

    Response samples

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

    Payments

    Create payment method Commerce

    Creates a PaymentMethodCreateController resource.

    -
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The new PaymentMethodCreateController resource

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    +
    Request Body schema:
    optional

    The Payment Method input schema encoded in XML or JSON.

    required
    object (PaymentMethodCreateStruct)

    Responses

    Request samples

    Content type
    {
    • "PaymentMethodCreateStruct": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    List payment methods Commerce

    /api/ibexa/v2/payment-method

    Request samples

    Content type
    {
    • "PaymentMethodCreateStruct": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    List payment methods Commerce

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

    -
    header Parameters
    Accept
    required
    string

    The view in XML or JSON format.

    -
    Content-Type
    required
    string

    The view input in XML or JSON format.

    -
    Request Body schema:
    optional

    The new PaymentMethodFindController resource

    -
    required
    object (PaymentMethodViewInput)

    Responses

    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    +
    Request Body schema:
    optional

    The view input in XML or JSON format.

    +
    required
    object (PaymentMethodViewInput)

    Responses

    Request samples

    Content type
    {
    • "PaymentMethodViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethodView": {
      }
    }

    Load payment method by identifier Commerce

    /api/ibexa/v2/payment-method/view

    Request samples

    Content type
    {
    • "PaymentMethodViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethodView": {
      }
    }

    Load payment method by identifier Commerce

    Loads an payment method by its identifier.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    Payment Method - If set, the payment method returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    Delete payment method Commerce

    /api/ibexa/v2/payment-method/{identifier}

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    Delete payment method Commerce

    Removes the PaymentMethodDeleteController resource.

    -
    path Parameters
    identifier
    required
    string

    Responses

    Update payment method Commerce

    /api/ibexa/v2/payment-method/{identifier}

    Update payment method Commerce

    Updates the PaymentMethodUpdateController resource.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The updated PaymentMethodUpdateController resource

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

    The CSRF token.

    +
    Request Body schema:
    optional

    The Payment Method input schema encoded in XML or JSON.

    required
    object (PaymentMethodUpdateStruct)

    Responses

    Request samples

    Content type
    {
    • "PaymentMethodUpdateStructParser": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    Load payment method by id Commerce

    /api/ibexa/v2/payment-method/{identifier}

    Request samples

    Content type
    {
    • "PaymentMethodUpdateStructParser": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    Load payment method by id Commerce

    Loads an payment method by its id.

    -
    path Parameters
    id
    required
    string
    header Parameters
    Accept
    required
    string

    Payment Method - If set, the payment method returned in XML or JSON format.

    -

    Responses

    Response samples

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

    Shipping

    Load shipments Commerce

    /api/ibexa/v2/payment-method/{id}

    Response samples

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

    Shipping

    Create shipment Commerce

    Creates a shipment.

    +
    path Parameters
    orderIdentifier
    required
    string

    The order's identifier to create a shipment for.

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    +
    Request Body schema:
    optional

    The shipment to create.

    +
    required
    object (ShipmentCreate)

    This class represents the creation of a shipment.

    +

    Responses

    Request samples

    Content type
    {
    • "ShipmentCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Load shipments Commerce

    Loads a list of shipments.

    -
    header Parameters
    Accept
    required
    string

    If set, the shipments are returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "ShipmentRefList": {
      }
    }

    Load a single shipment based on its identifier Commerce

    /api/ibexa/v2/shipments

    Response samples

    Content type
    {
    • "ShipmentRefList": {
      }
    }

    Load a single shipment based on its identifier Commerce

    Loads a single shipment based on its identifier.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

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

    +
    path Parameters
    identifier
    required
    string

    The shipment identifier.

    Responses

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Delete shipment Commerce

    /api/ibexa/v2/shipments/{identifier}

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Delete shipment Commerce

    Deletes a shipment.

    -
    path Parameters
    identifier
    required
    string

    Responses

    Update shipment Commerce

    /api/ibexa/v2/shipments/{identifier}

    Update shipment Commerce

    Updates a shipment.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    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.

    -
    Request Body schema:
    optional

    The updated ShipmentUpdateController resource

    +
    path Parameters
    identifier
    required
    string

    The shipment identifier.

    +
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    +
    Request Body schema:
    optional

    The ShipmentUpdate schema encoded in XML or JSON format.

    required
    object (ShipmentUpdate)

    This class represents the update of a shipment.

    -

    Responses

    Responses

    Request samples

    Content type
    {
    • "ShipmentUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Load shipping methods types Commerce

    /api/ibexa/v2/shipments/{identifier}

    Request samples

    Content type
    {
    • "ShipmentUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Load shipping methods types Commerce

    Loads shipping methods types.

    -
    header Parameters
    Accept
    required
    string

    Shipping method type reference - if set, the shipping method is returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "ShippingMethodTypesList": {
      }
    }

    Load shipping method type based on its identifier Commerce

    /api/ibexa/v2/shipping/method-types

    Response samples

    Content type
    {
    • "ShippingMethodTypesList": {
      }
    }

    Load shipping method type based on its identifier Commerce

    Loads shipping methods type based on their identifiers.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    Shipping method type - if set, the shipping method is returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "ShippingMethodType": {
      }
    }

    Load shipping methods Commerce

    /api/ibexa/v2/shipping/method-types/{identifier}

    Response samples

    Content type
    {
    • "ShippingMethodType": {
      }
    }

    Load shipping methods Commerce

    Loads shipping methods.

    -
    header Parameters
    Accept
    required
    string

    Shipping method reference - if set, the shipping method is returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "ShippingMethodRefList": {
      }
    }

    Load shipping method based on its identifier Commerce

    /api/ibexa/v2/shipping/methods

    Response samples

    Content type
    {
    • "ShippingMethodRefList": {
      }
    }

    Load shipping method based on its identifier Commerce

    Loads shipping method based on its identifier.

    -
    path Parameters
    identifier
    required
    string
    header Parameters
    Accept
    required
    string

    Shipping method - if set, the shipping method is returned in XML or JSON format.

    -

    Responses

    Response samples

    Content type
    {
    • "ShippingMethod": {
      }
    }

    Collaboration Sessions

    Create collaboration session

    /api/ibexa/v2/shipping/methods/{identifier}

    Response samples

    Content type
    {
    • "ShippingMethod": {
      }
    }

    Collaboration Sessions

    Create collaboration session

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

    Request Body schema:
    optional

    Session creation payload

    @@ -4720,93 +4536,93 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the session or participant does not exist.

    Request samples

    Content type
    {
    • "ExternalParticipantUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Participant": {
      }
    }

    Connector AI

    Get action types list.

    /api/ibexa/v2/collaboration/sessions/{sessionToken}/participants/{participantId}

    Request samples

    Content type
    {
    • "ExternalParticipantUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Participant": {
      }
    }

    Connector AI

    Get action types list.

    Returns action types list.

    -

    Responses

    Responses

    Response samples

    Content type
    {
    • "ActionTypeList": {
      }
    }

    Get an action type by its unique identifier.

    /api/ibexa/v2/ai/action-types

    Response samples

    Content type
    {
    • "ActionTypeList": {
      }
    }

    Get an action type by its unique identifier.

    Returns an action type by its unique string identifier.

    -
    path Parameters
    identifier
    required
    string
    Example: generate_alt_text

    Responses

    path Parameters
    identifier
    required
    string
    Example: generate_alt_text

    Responses

    Response samples

    Content type
    {
    • "ActionType": {
      }
    }

    Get action configuration list.

    /api/ibexa/v2/ai/action-types/{identifier}

    Response samples

    Content type
    {
    • "ActionType": {
      }
    }

    Get action configuration list.

    Returns action configuration list.

    -

    Responses

    Responses

    Response samples

    Content type
    {
    • "ActionConfigurationList": {
      }
    }

    Query action configuration list.

    /api/ibexa/v2/ai/actions

    Response samples

    Content type
    {
    • "ActionConfigurationList": {
      }
    }

    Query action configuration list.

    Returns action configuration list based on the given query.

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

    CSRF token obtained during the authentication.

    -
    Request Body schema:
    optional

    The new ActionConfigurationListController resource

    -
    query
    string
    action_type_identifier
    string
    enabled
    boolean
    limit
    integer
    page
    integer

    Responses

    Request Body schema:
    optional

    Query action configuration search criteria

    +
    query
    string
    action_type_identifier
    string
    enabled
    boolean
    limit
    integer
    page
    integer

    Responses

    Request samples

    Content type
    {
    • "ActionConfigurationListInput": {
      }
    }

    Response samples

    Content type
    {
    • "ActionConfigurationList": {
      }
    }

    Execute the given AI action

    /api/ibexa/v2/ai/actions

    Request samples

    Content type
    {
    • "ActionConfigurationListInput": {
      }
    }

    Response samples

    Content type
    {
    • "ActionConfigurationList": {
      }
    }

    Execute the given AI action

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

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

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

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

    CSRF token obtained during the authentication.

    Request Body schema:
    optional

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

    -
    required
    object
    required
    object (RuntimeContext)

    Responses

    Request samples

    Content type
    {
    • "GenerateAltText": {
      }
    }

    Response samples

    Content type
    {
    • "AltText": {
      }
    }

    Get an action configuration by its unique identifier.

    /api/ibexa/v2/ai/actions/{actionConfigurationIdentifier}/execute

    Request samples

    Content type
    {
    • "GenerateAltText": {
      }
    }

    Response samples

    Content type
    {
    • "AltText": {
      }
    }

    Get an action configuration by its unique identifier.

    Returns an action configuration by its unique string identifier.

    -
    path Parameters
    identifier
    required
    string
    Example: rewrite_with_friendly_tone

    Responses

    path Parameters
    identifier
    required
    string
    Example: rewrite_with_friendly_tone

    Responses

    Response samples

    Content type
    {
    • "ActionConfiguration": {
      }
    }

    Discounts

    Get discounts Commerce

    /api/ibexa/v2/ai/actions/{identifier}

    Response samples

    Content type
    {
    • "ActionConfiguration": {
      }
    }

    Discounts

    Get discounts Commerce

    Returns a list of all defined discounts

    -
    query Parameters
    offset
    integer
    limit
    integer
    Example: limit=25

    Responses

    query Parameters
    offset
    integer
    limit
    integer
    Example: limit=25

    Responses

    Response samples

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

    Create a discount Commerce

    /api/ibexa/v2/discounts

    Response samples

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

    Create a discount Commerce

    Creates a new discount

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

    CSRF token obtained during the authentication.

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

    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

    Responses

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

    The DiscountCreate schema

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

    Responses

    Request samples

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

    Response samples

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

    Get a discount item by its unique identifier. Commerce

    /api/ibexa/v2/discounts

    Request samples

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

    Response samples

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

    Get a discount item by its unique identifier. Commerce

    Returns a discount item by its unique string identifier.

    -
    path Parameters
    identifier
    required
    string
    Example: my_discount_identifier

    Responses

    path Parameters
    identifier
    required
    string
    Example: my_discount_identifier

    Responses

    Response samples

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

    Delete a discount item Commerce

    /api/ibexa/v2/discounts/{identifier}

    Response samples

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

    Delete a discount item Commerce

    Deletes an existing discount item by its unique identifier

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

    CSRF token obtained during the authentication.

    Responses

    Update a discount Commerce

    /api/ibexa/v2/discounts/{identifier}

    Update a discount Commerce

    Updates a new discount

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

    CSRF token obtained during the authentication.

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

    The 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

    Responses

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

    The DiscountUpdate schema

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

    Responses

    Request samples

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

    Response samples

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

    Disables a discount Commerce

    /api/ibexa/v2/discounts/{identifier}

    Request samples

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

    Response samples

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

    Disables a discount Commerce

    Disables a discount item by its unique identifier

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

    CSRF token obtained during the authentication.

    Responses

    Enables a discount Commerce

    /api/ibexa/v2/discounts/{identifier}/disable

    Enables a discount Commerce

    Enables a discount item by its unique identifier

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

    CSRF token obtained during the authentication.

    Responses

    Get a discount item Commerce

    /api/ibexa/v2/discounts/{identifier}/enable

    Get a discount item Commerce

    Returns a discount item by its ID.

    -
    path Parameters
    id
    required
    integer
    Example: 1

    Responses

    path Parameters
    id
    required
    integer
    Example: 1

    Responses

    Request samples

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