OCAPI 19.5 changes since 17.6

The following sections describe all changes made to OCAPI since version 17.6.

Resources added, modified, or removed since 17.6

Resource Name Change Http Method URL Template API Details
AbTests Added DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/promotions/{promotion_id} Data N/A
AbTests Added PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/promotions/{promotion_id} Data N/A
AbTests Added DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/slot_configurations/{slot_id}/{slot_config_id} Data N/A
AbTests Added PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/slot_configurations/{slot_id}/{slot_config_id} Data N/A
AbTests Added DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id} Data N/A
AbTests Added PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id} Data N/A
Ai Added POST /ai/activities/{activity} Shop N/A
Ai Added GET /ai/product_recommendations/{recommender_name} Shop N/A
Baskets Added PUT /baskets/{basket_id}/agent Shop N/A
Baskets Added PUT /baskets/{basket_id}/storefront Shop N/A
Campaigns Added PATCH /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_id} Data N/A
Campaigns Changed PUT /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_id} Data More
Campaigns Changed DELETE /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id} Data More
Campaigns Changed PUT /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id} Data More
Catalogs Added PATCH /catalogs/{catalog_id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_product_options Data N/A
Catalogs Added DELETE /catalogs/{catalog_id}/shared_product_options/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_product_options/{id} Data N/A
Catalogs Added PATCH /catalogs/{catalog_id}/shared_product_options/{id} Data N/A
Catalogs Added PUT /catalogs/{catalog_id}/shared_product_options/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_product_options/{option_id}/values Data N/A
Catalogs Added DELETE /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Data N/A
Catalogs Added PATCH /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Data N/A
Catalogs Added PUT /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_variation_attributes Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values Data N/A
Catalogs Added DELETE /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Data N/A
Catalogs Added PATCH /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Data N/A
Catalogs Added PUT /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Data N/A
Catalogs Added DELETE /catalogs/{catalog_id}/shared_variation_attributes/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_variation_attributes/{id} Data N/A
Catalogs Added PATCH /catalogs/{catalog_id}/shared_variation_attributes/{id} Data N/A
Catalogs Added PUT /catalogs/{catalog_id}/shared_variation_attributes/{id} Data N/A
Categories Changed GET /categories/({id},...,{id}) Shop More
Categories Changed GET /categories/{id} Shop More
LogRequests Added GET /log_requests/ecdn/{id} Data N/A
LogRequests Added POST /log_requests/ecdn/{id} Data N/A
Orders Added PUT /orders/{order_no} Shop N/A
Permissions Added GET /permissions Data N/A
Permissions Added GET /permissions/bm Data N/A
Permissions Added GET /permissions/bm/functional Data N/A
Permissions Added GET /permissions/bm/locale Data N/A
Permissions Added GET /permissions/bm/module Data N/A
Permissions Added GET /permissions/bm/webdav Data N/A
Permissions Added GET /permissions/csc Data N/A
Permissions Added GET /permissions/csc/module Data N/A
ProductSearch Added GET /product_search/represented_products Shop N/A
ProductSearch Changed GET /product_search Shop More
Products Added GET /products/{product_id}/product_options Data N/A
Products Added DELETE /products/{product_id}/product_options/{id} Data N/A
Products Added GET /products/{product_id}/product_options/{id} Data N/A
Products Added PATCH /products/{product_id}/product_options/{id} Data N/A
Products Added PUT /products/{product_id}/product_options/{id} Data N/A
Products Added GET /products/{product_id}/product_options/{option_id}/values Data N/A
Products Added DELETE /products/{product_id}/product_options/{option_id}/values/{id} Data N/A
Products Added GET /products/{product_id}/product_options/{option_id}/values/{id} Data N/A
Products Added PATCH /products/{product_id}/product_options/{option_id}/values/{id} Data N/A
Products Added PUT /products/{product_id}/product_options/{option_id}/values/{id} Data N/A
Products Changed GET /products/{id} Data More
RoleSearch Changed POST /role_search Data More
Roles Added GET /roles/{id}/permissions Data N/A
Roles Added PUT /roles/{id}/permissions Data N/A
Roles Changed DELETE /roles/{id} Data More
Roles Changed PUT /roles/{id}/users/{login} Data More
Sites Added GET /sites/{site_id}/ai/recommender_names Data N/A
Sites Added DELETE /sites/{site_id}/cartridges/{cartridge_name} Data N/A
Sites Added POST /sites/{site_id}/cartridges/{cartridge_name} Data N/A
Sites Added PUT /sites/{site_id}/cartridges/{cartridge_name} Data N/A
SortingRuleSearch Added POST /sites/{site_id}/sorting_rule_search Data N/A
UserSearch Added POST /user_search Data N/A
Users Added GET /users Data N/A
Users Added DELETE /users/{login} Data N/A
Users Added GET /users/{login} Data N/A
Users Added PATCH /users/{login} Data N/A
Users Added PUT /users/{login} Data N/A

Documents added, modified, or removed since 17.6

Document Name Change API Details
ActivityRequest Added Shop API N/A
ActivityResult Added Shop API N/A
AiProduct Added Shop API N/A
ApplicationPermissions Added Data API N/A
BMPermissions Added Data API N/A
CSCPermissions Added Data API N/A
CartridgePathAddRequest Added Data API N/A
CartridgePathApiResponse Added Data API N/A
CartridgePathCreateRequest Added Data API N/A
CatalogCategoryId Added Data API N/A
EcdnLogFetchRequest Added Data API N/A
EcdnLogFetchResponse Added Data API N/A
ExportDataUnitsConfiguration Added Data API N/A
ExportGlobalDataConfiguration Added Data API N/A
ExportSitesConfiguration Added Data API N/A
FunctionalPermission Added Data API N/A
FunctionalPermissions Added Data API N/A
ImageGroup Added Data API N/A
LocalePermission Added Data API N/A
LocalePermissions Added Data API N/A
MenuAction Added Data API N/A
MenuItem Added Data API N/A
ModulePermissions Added Data API N/A
Order Changed Shop API More
PaymentMethod Changed Shop API More
Product Changed Data API More
Product Changed Shop API More
ProductOption Added Data API N/A
ProductOptionValue Added Data API N/A
ProductOptionValues Added Data API N/A
ProductOptions Added Data API N/A
ProductRecommendationsResult Added Shop API N/A
ProductRef Added Shop API N/A
ProductSearchHit Changed Shop API More
Recommender Added Data API N/A
RecommendersResult Added Data API N/A
Role Changed Data API More
RoleFunctionalPermission Added Data API N/A
RoleFunctionalPermissions Added Data API N/A
RoleLocalePermission Added Data API N/A
RoleLocalePermissions Added Data API N/A
RoleModulePermission Added Data API N/A
RoleModulePermissions Added Data API N/A
RolePermissions Added Data API N/A
RoleSearchRequest Added Data API N/A
RoleWebdavPermission Added Data API N/A
RoleWebdavPermissions Added Data API N/A
Roles Changed Data API More
Site Changed Data API More
SiteArchiveExportConfiguration Added Data API N/A
SortingRule Changed Data API More
SortingRuleSearchResult Added Data API N/A
User Changed Data API More
WebdavPermission Added Data API N/A
WebdavPermissions Added Data API N/A

Details about modified resources

The following requests have been modified since 17.6.

PUT /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_id}

Element Change API 17.6 19.5
Title Changed Data Bind SlotConfiguration Bind Slot Configuration to Campaign
Body Changed Data None SlotConfigurationCampaignAssignment
Path Parameter Changed Data

Name: campaign_id

Description: The id of the campaign

Name: campaign_id

Description: The ID of the campaign.

Path Parameter Changed Data

Name: site_id

Description: The id of the site

Name: site_id

Description: The ID of the site.

Path Parameter Changed Data

Name: slot_id

Description: The of the slot

Name: slot_id

Description: The ID of the slot.

Path Parameter Changed Data

Name: slot_config_id

Description: The id of the slot configuration

Name: slot_config_id

Description: The ID of the slot configuration.

Fault Added Data N/A

IdConflictException(400): Indicates the ID in the URL does not match the ID in the request

bodyID (String)

urlID (String)

DELETE /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element Change API 17.6 19.5
Query Parameter Added Data N/A

Name: rule_context

Type: String

Description: The context in which the rule lives, either "site" or "global"the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=[<error>, <error>]

PUT /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element Change API 17.6 19.5
Description Changed Data Action to bind a single sorting rule to a given campaign. Lookup of the sorting rule is done in the site Action to bind a single sorting rule to a given campaign.
Query Parameter Added Data N/A

Name: rule_context

Type: String

Description: The context in which the rule lives, either "site" or "global"the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=[<error>, <error>]

GET /categories/({id},...,{id})

Element Change API 17.6 19.5
Description Changed Shop When you use the URL template below, the server returns multiple categories (a result object of category documents). You can use this template as a convenient way of obtaining multiple categories in a single request, instead of issuing separate requests for each category. You can specify multiple ids (up to a maximum of 50). You must enclose the list of ids in parentheses. If a category identifier contains a parenthesis or the separator sign, you must URL encode the character. Please note, using a large value for levels parameter may cause performance issues in case of a large and deep category tree. The server only returns online categories. When you use the URL template below, the server returns multiple categories (a result object of category documents). You can use this template as a convenient way of obtaining multiple categories in a single request, instead of issuing separate requests for each category. You can specify multiple ids (up to a maximum of 50). You must enclose the list of ids in parentheses. If a category identifier contains a parenthesis or the separator sign, you must URL encode the character. The server only returns online categories.
Query Parameter Changed Shop

Name: levels

Description: Specifies how many levels of nested subcategories you want the server to return. The default value is 1.

Name: levels

Description: Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2.

GET /categories/{id}

Element Change API 17.6 19.5
Description Changed Shop When you use the URL template below, the server returns a category identified by its id; by default, the server also returns the first level of subcategories, but you can specify another level by setting the levels parameter. Please note, using a large value for levels may cause performance issues in case of a large and deep category tree. The server only returns online categories. When you use the URL template below, the server returns a category identified by its id; by default, the server also returns the first level of subcategories, but you can specify another level by setting the levels parameter. The server only returns online categories.
Query Parameter Changed Shop

Name: levels

Description: Specifies how many levels of nested subcategories you want the server to return. The default value is 1.

Name: levels

Description: Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2.

GET /product_search

Element Change API 17.6 19.5
Query Parameter Changed Shop

Name: refine

Description: Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = "|"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported:
  • cgid: Allows to refine per single category id. Multiple category ids are not supported.
  • price: Allows to refine per single price range. Multiple price ranges are not supported.
  • pmid: Allows to refine per promotion id(s).
  • orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

Name: refine

Description: Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = "|"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported:
  • cgid: Allows to refine per single category id. Multiple category ids are not supported.
  • price: Allows to refine per single price range. Multiple price ranges are not supported.
  • pmid: Allows to refine per promotion id(s).
  • htypes: Allow to refine by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
  • orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.
Query Parameter Changed Shop

Name: expand

Description: The expand parameter. A comma separated list with the allowed values (availability, images, prices, variations)

Name: expand

Description: The expand parameter. A comma separated list with the allowed values (availability, images, prices, represented_products, variations)

GET /products/{id}

Element Change API 17.6 19.5
Query Parameter Changed Data

Name: expand

Description: The list of expansions that can be applied to the product. They are:
  • 'all' will retrieve all the product properties.
  • 'availability' will retrieve the following properties:
    • ats
    • in_stock
    • online
  • 'images' will retrieve the following properties:
    • image
    • image_groups
  • 'all_images' used with images will retrieve the following properties, including the images specified for its variants and variation groups:
    • image
    • image_groups
  • 'prices' will retrieve the following properties:
    • price
    • price_currency
  • 'variations' will retrieve the following properties:
    • master
    • variation_attributes
    • variation_groups
    • variation_values
    • variants
Note that only variants with variation values are retrieved for a product of type variation master.

Name: expand

Description: The list of expansions that can be applied to the product. They are:
  • 'all' will retrieve all the product properties.
  • 'availability' will retrieve the following properties:
    • ats
    • in_stock
    • online
  • 'images' will retrieve the following properties:
    • image
    • image_groups
  • 'all_images' used with images will retrieve the following properties, including the images specified for its variants and variation groups:
    • image
    • image_groups
  • 'categories' will retrieve the following properties:
    • assigned_categories
  • 'options' will retrieve the following properties:
    • product_options
  • 'prices' will retrieve the following properties:
    • price
    • price_currency
  • 'variations' will retrieve the following properties:
    • master
    • variation_attributes
    • variation_groups
    • variation_values
    • variants
  • 'sets' will retrieve the following properties:
    • set_products
    • product_sets
  • 'bundles' will retrieve the following properties:
    • product_bundles
    • bundled_products
Note that only variants with variation values are retrieved for a product of type variation master.

POST /role_search

Element Change API 17.6 19.5
Description Changed Data Searches for access roles.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

  • id - String
  • description - String

The output of the query can also be sorted. These are the list of sortable attributes:

  • id - String
  • description - String
Searches for access roles.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

  • id - String
  • description - String

Optionally, a user ID (the user login) can be specified. When it is supplied, the search for roles is limited to the roles assigned to this user. When expanding the permissions for the roles, all effective permissions for this user can be retrieved.

Optionally, a (single) permission can be specified. When it is supplied, the search for roles is limited to the roles having this permission. When expanding the users for the roles, all users having this permission can be retrieved.

The output of the query can also be sorted. These are the list of sortable attributes:

  • id - String
  • description - String
Body Changed Data SearchRequest RoleSearchRequest
Fault Added Data N/A

InvalidSearchQueryException(400): Throws when one of the search request restrictions is violated

fault (String)

DELETE /roles/{id}

Element Change API 17.6 19.5
Fault Added Data N/A

RoleNotFoundException(404): Thrown if the given role does not exist

id (String)

PUT /roles/{id}/users/{login}

Element Change API 17.6 19.5
Fault Added Data N/A

InvalidRoleException(400): Thrown if the access role with the given id does not exist.

roleId (String)

Fault Added Data N/A

InvalidUserLoginException(400): Thrown if a user with the given login does not exist.

login (String)

Fault Removed Data

RoleNotFoundException(404): Thrown if the access role with the given id does not exist.

id (String)

N/A
Fault Removed Data

UserNotFoundException(404): Thrown if a user with the given login does not exist.

login (String)

N/A

Details about modified documents

The following documents have been modified since 17.6.

Order

Element Change API 17.6 19.5
Property Added Shop N/A

Name: global_party_id

Type: String

Description: globalPartyId is managed by Customer 360. Its value can be changed.

Constraints:

PaymentMethod

Element Change API 17.6 19.5
Property Added Shop N/A

Name: payment_processor_id

Type: String

Description: The payment processor ID.

Constraints:

Product

Element Change API 17.6 19.5
Property Added Data N/A

Name: assigned_categories

Type: [CatalogCategoryId]

Description: The catalog categories that the product is assigned to

Constraints:

Property Added Data N/A

Name: bundled_products

Type: [Product]

Description: The array of bundled products which the product includes.

Constraints:

Property Added Data N/A

Name: image_groups

Type: [ImageGroup]

Description: The array of product image groups.

Constraints:

Property Added Data N/A

Name: product_bundles

Type: [Product]

Description: The array of product bundles which the product belongs to.

Constraints:

Property Added Data N/A

Name: product_options

Type: [ProductOption]

Description: The array of product options. This is applicable for products of type "option".

Constraints:

Property Added Data N/A

Name: product_sets

Type: [Product]

Description: The array of product sets which the product belongs to.

Constraints:

Property Added Data N/A

Name: set_products

Type: [Product]

Description: The array of set products which the product includes.

Constraints:

Product

Element Change API 17.6 19.5
Property Added Shop N/A

Name: valid_from

Type: [DateTime]

Description: The time when product is valid from.

Constraints:

Property Added Shop N/A

Name: valid_to

Type: [DateTime]

Description: The time when product is valid to.

Constraints:

ProductSearchHit

Element Change API 17.6 19.5
Property Added Shop N/A

Name: hit_type

Type: String

Description: The type information for the search hit.

Constraints:

Property Added Shop N/A

Name: represented_product

Type: ProductRef

Description: The first represented product.

Constraints:

Property Added Shop N/A

Name: represented_products

Type: [ProductRef]

Description: All the represented products.

Constraints:

Role

Element Change API 17.6 19.5
Property Added Data N/A

Name: permissions

Type: RolePermissions

Description: The permissions assigned to the access role. Available through expands.

Constraints:

Roles

Element Change API 17.6 19.5
Property Added Data N/A

Name: permissions

Type: RolePermissions

Description: The permissions assigned to the access role. Available through expands.

Constraints:

Site

Element Change API 17.6 19.5
Property Added Data N/A

Name: cartridges

Type: String

Description: The cartridge Path of the site

Constraints:

SortingRule

Element Change API 17.6 19.5
Property Added Data N/A

Name: rule_context

Type: String

Description: The context of the rule, either site or global

Constraints:

User

Element Change API 17.6 19.5
Property Added Data N/A

Name: external_id

Type: String

Description: The external id. This attribute is only valid when the user uses centralized authentication.

Constraints: maxLength=256

Property Added Data N/A

Name: link

Type: String

Description: URL that is used to get this instance. This property is computed and cannot be modified.

Constraints:

Property Added Data N/A

Name: password

Type: String

Description: The password. This attribute is only used to set the password upon user creation. This attribute is only valid when the user does not use centralized authentication.

Constraints:

Property Added Data N/A

Name: roles

Type: [String]

Description: List of role ids the user is assigned to.

Constraints: