OCAPI 19.1 changes since 18.3

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

Resources added, modified, or removed since 18.3

Resource Name Change Http Method URL Template API Details
Ai Added POST /ai/activities/{activity} Shop N/A
Ai Added GET /ai/product_recommendations/{recommender_name} Shop N/A
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
Products Changed GET /products/{id} Data More
Roles Added GET /roles/{id}/permissions Data N/A
Roles Added PUT /roles/{id}/permissions Data N/A
Roles Changed POST /roles/{id}/user_search 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
UserSearch Added POST /user_search Data N/A
Users Added GET /users Data N/A
Users Changed PATCH /users/{login} Data More
Users Changed PUT /users/{login} Data More

Documents added, modified, or removed since 18.3

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
Product Changed Data API More
Product Changed Shop API More
ProductRecommendationsResult Added Shop API N/A
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
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
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 18.3.

GET /products/{id}

Element Change API 18.3 19.1
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 /roles/{id}/user_search

Element Change API 18.3 19.1
Fault Added Data N/A

ExternalIdNotAllowedException(400): Thrown if the current server settings do not allow to query the external id or use it as sorting field.

PATCH /users/{login}

Element Change API 18.3 19.1
Fault Added Data N/A

ExternalIdNullException(400): If the external id is explicitly set to null for an externally managed user

Fault Added Data N/A

ExternalIdAlreadyExistsException(400): If another user with the same external id already exists.

Fault Added Data N/A

ExternalIdNotAllowedException(400): If the current server settings do not allow to set an external id.

PUT /users/{login}

Element Change API 18.3 19.1
Fault Added Data N/A

ExternalIdAlreadyExistsException(400): If another user with the same external id already exists.

Fault Added Data N/A

ExternalIdNotAllowedException(400): If the current server settings do not allow to set an external id.

Fault Added Data N/A

LocalUserCreationException(400): If creation of a local Business Manager user is not allowed with the current server settings.

Fault Added Data N/A

InvalidCredentialsException(400): If password or external id of the user are invalid.

Details about modified documents

The following documents have been modified since 18.3.

Product

Element Change API 18.3 19.1
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 18.3 19.1
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:

Role

Element Change API 18.3 19.1
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 18.3 19.1
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 18.3 19.1
Property Added Data N/A

Name: cartridges

Type: String

Description: The cartridge Path of the site

Constraints:

User

Element Change API 18.3 19.1
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: