OCAPI 19.1 changes since 16.9

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

Resources added, modified, or removed since 16.9

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 POST /baskets/reference Shop N/A
Baskets Added PUT /baskets/{basket_id}/agent Shop N/A
Baskets Added GET /baskets/{basket_id}/approaching_discounts Shop N/A
Baskets Added DELETE /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id} Shop N/A
Baskets Added PATCH /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id} Shop N/A
Baskets Added PATCH /baskets/{basket_id}/price_adjustments/{price_adjustment_id} Shop N/A
Baskets Added PUT /baskets/{basket_id}/storefront Shop N/A
Baskets Changed PATCH /baskets/{basket_id} Shop More
Baskets Changed POST /baskets/{basket_id}/items Shop More
Campaigns Added PATCH /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_id} Data N/A
Campaigns Added DELETE /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id} Data N/A
Campaigns Added PUT /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id} Data N/A
Campaigns Changed PUT /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_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 Added GET /catalogs/{catalog_id}/categories Data N/A
Categories Changed GET /categories/({id},...,{id}) Shop More
Categories Changed GET /categories/{id} Shop More
Content Changed GET /content/({id},...,{id}) Shop More
Content Changed GET /content/{id} Shop More
ContentSearch Changed GET /content_search Shop More
Coupons Added GET /sites/{site_id}/coupons Data N/A
CustomObjects Changed GET /custom_objects/{object_type}/{key} Shop More
CustomerGroups Added GET /sites/{site_id}/customer_groups/{id}/members Data N/A
CustomerLists Added POST /customer_lists/{customer_list_id}/customer_search Data N/A
CustomerSearch Removed POST /customer_search Data N/A
Customers Added GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases Shop N/A
Customers Added POST /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases Shop N/A
Customers Added GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases/{purchase_id} Shop N/A
Customers Added PATCH /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases/{purchase_id} Shop N/A
Customers Changed GET /customers/{customer_id}/orders Shop More
Folders Changed GET /folders/({id},...,{id}) Shop More
Folders Changed GET /folders/{id} Shop More
Jobs Removed GET /jobs/{job_id}/executions Data N/A
Jobs Changed POST /jobs/{job_id}/executions Data 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
PriceAdjustmentLimits Added GET /price_adjustment_limits Shop N/A
ProductLists Changed GET /product_lists Shop More
ProductLists Changed GET /product_lists/{list_id} Shop More
ProductLists Changed GET /product_lists/{list_id}/items Shop More
ProductLists Changed GET /product_lists/{list_id}/items/{item_id} Shop More
ProductSearch Added GET /product_search/represented_products Shop N/A
ProductSearch Changed GET /product_search Shop More
ProductSearch Changed GET /product_search/availability Shop More
ProductSearch Changed GET /product_search/images Shop More
ProductSearch Changed GET /product_search/prices Shop More
ProductSearch Changed GET /product_search/variations Shop More
Products Added DELETE /products/{master_product_id}/variation_groups/{id} Data N/A
Products Added GET /products/{master_product_id}/variation_groups/{id} Data N/A
Products Added PATCH /products/{master_product_id}/variation_groups/{id} Data N/A
Products Added PUT /products/{master_product_id}/variation_groups/{id} Data N/A
Products Added DELETE /products/{master_product_id}/variations/{id} Data N/A
Products Added GET /products/{master_product_id}/variations/{id} Data N/A
Products Added PATCH /products/{master_product_id}/variations/{id} Data N/A
Products Added PUT /products/{master_product_id}/variations/{id} Data N/A
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 Added GET /products/{product_id}/variation_attributes/{attribute_id}/values Data N/A
Products Added DELETE /products/{product_id}/variation_attributes/{attribute_id}/values/{id} Data N/A
Products Added GET /products/{product_id}/variation_attributes/{attribute_id}/values/{id} Data N/A
Products Added PATCH /products/{product_id}/variation_attributes/{attribute_id}/values/{id} Data N/A
Products Added PUT /products/{product_id}/variation_attributes/{attribute_id}/values/{id} Data N/A
Products Added DELETE /products/{product_id}/variation_attributes/{id} Data N/A
Products Added GET /products/{product_id}/variation_attributes/{id} Data N/A
Products Added PATCH /products/{product_id}/variation_attributes/{id} Data N/A
Products Added PUT /products/{product_id}/variation_attributes/{id} Data N/A
Products Changed GET /products/{id} Data More
Products Changed GET /products/({id},...,{id}) Shop More
Products Changed GET /products/{id} Shop More
Products Changed GET /products/{id}/availability Shop More
Products Changed GET /products/{id}/bundled_products Shop More
Products Changed GET /products/{id}/images Shop More
Products Changed GET /products/{id}/links Shop More
Products Changed GET /products/{id}/options Shop More
Products Changed GET /products/{id}/prices Shop More
Products Changed GET /products/{id}/promotions Shop More
Products Changed GET /products/{id}/recommendations Shop More
Products Changed GET /products/{id}/set_products Shop More
Products Changed GET /products/{id}/variations Shop More
Promotions Changed GET /promotions Shop More
Promotions Changed GET /promotions/({id},...,{id}) Shop More
Promotions Changed GET /promotions/{id} Shop More
RoleSearch Added POST /role_search Data N/A
Roles Added GET /roles Data N/A
Roles Added DELETE /roles/{id} Data N/A
Roles Added GET /roles/{id} Data N/A
Roles Added PUT /roles/{id} Data N/A
Roles Added GET /roles/{id}/permissions Data N/A
Roles Added PUT /roles/{id}/permissions Data N/A
Roles Added POST /roles/{id}/user_search Data N/A
Roles Added GET /roles/{id}/users Data N/A
Roles Added DELETE /roles/{id}/users/{login} Data N/A
Roles Added PUT /roles/{id}/users/{login} Data N/A
SearchSuggestion Changed GET /search_suggestion Shop More
Site Changed GET /site Shop More
Sites Added GET /sites/{site_id}/slot_configurations Data N/A
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
SlotSearch Added POST /sites/{site_id}/slot_search Data N/A
Slots Added GET /sites/{site_id}/slots Data N/A
Stores Added GET /sites/{site_id}/stores Data N/A
Stores Changed GET /stores Shop More
Stores Changed GET /stores/({id},...,{id}) Shop More
Stores Changed GET /stores/{id} Shop More
SystemObjectDefinitionSearch Added POST /system_object_definition_search Data N/A
SystemObjectDefinitions Added GET /system_object_definitions Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type} Data N/A
SystemObjectDefinitions Added POST /system_object_definitions/{object_type}/attribute_definition_search Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_definitions Data N/A
SystemObjectDefinitions Added DELETE /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added PATCH /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added PUT /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added POST /system_object_definitions/{object_type}/attribute_group_search Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_groups Data N/A
SystemObjectDefinitions Added DELETE /system_object_definitions/{object_type}/attribute_groups/{group_id}/attribute_definitions/{def_id} Data N/A
SystemObjectDefinitions Added PUT /system_object_definitions/{object_type}/attribute_groups/{group_id}/attribute_definitions/{def_id} Data N/A
SystemObjectDefinitions Added DELETE /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
SystemObjectDefinitions Added PATCH /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
SystemObjectDefinitions Added PUT /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
UserSearch Added POST /user_search Data N/A
Users Added GET /users Data N/A
Users Added GET /users/this Data N/A
Users Added PATCH /users/this/password 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 16.9

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
ApproachingDiscount Added Shop API N/A
ApproachingDiscountResult Added Shop API N/A
BMPermissions Added Data API N/A
Basket Changed Shop API More
BasketReference Added Shop API N/A
BonusDiscountLineItem Added Shop API N/A
CSCPermissions Added Data API N/A
Campaign Changed Data API More
CampaignPromotionExperience Added Data API N/A
CampaignSlotConfigurationExperience Added Data API N/A
CampaignSortingRuleExperience Added Data API N/A
CartridgePathAddRequest Added Data API N/A
CartridgePathApiResponse Added Data API N/A
CartridgePathCreateRequest Added Data API N/A
Catalog Changed Data API More
CatalogCategoryId Added Data API N/A
Categories Added Data API N/A
Category Changed Data API More
ContentAsset Changed Data API More
ContentFolder Changed Data API More
Coupon Changed Data API More
Coupons Added Data API N/A
Customer Changed Data API More
Customer Changed Shop API More
CustomerAddress Changed Data API More
CustomerAddress Changed Shop API More
CustomerGroup Changed Data API More
CustomerGroupMember Changed Data API More
CustomerGroupMembers Added Data API N/A
CustomerPaymentCardRequest Changed Shop API More
CustomerPaymentInstrument Changed Shop API More
CustomerProductList Changed Shop API More
CustomerProductListItemPurchase Added Shop API N/A
CustomerProductListItemPurchaseResult Added Shop API N/A
CustomerSearchHit Added Data API N/A
CustomerSearchResult 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
GiftCertificate Changed Data API More
Image Removed Data API N/A
ImageGroup Added Data API N/A
InventoryList Changed Data API More
JobExecution Changed Data API More
JobExecutionParameter Added Data API N/A
JobExecutionRequest Added Data API N/A
JobStepExecution Changed Data API More
Locale Added Shop API N/A
LocalePermission Added Data API N/A
LocalePermissions Added Data API N/A
MarkupText Added Data API N/A
MediaFile Added Data API N/A
MenuAction Added Data API N/A
MenuItem Added Data API N/A
ModulePermissions Added Data API N/A
ObjectTypeDefinition Added Data API N/A
ObjectTypeDefinitionSearchResult Added Data API N/A
ObjectTypeDefinitions Added Data API N/A
OptionItem Changed Shop API More
Order Changed Shop API More
OrderPaymentCardRequest Changed Shop API More
OrderPaymentInstrument Changed Shop API More
PasswordChangeRequest Added Data API N/A
PaymentMethod Changed Shop API More
PriceAdjustment Changed Shop API More
PriceAdjustmentLimit Added Shop API N/A
PriceAdjustmentLimits Added Shop API N/A
Product Changed Data API More
Product Changed Shop API More
ProductInventoryRecord Changed Data API More
ProductItem 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
ProductSearchResult Changed Shop API More
Promotion Changed Data API More
PromotionLink Added Shop API N/A
PublicProductList Changed Shop API More
Recommender Added Data API N/A
RecommendersResult Added Data API N/A
Role Added Data API N/A
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
RoleSearchResult Added Data API N/A
RoleWebdavPermission Added Data API N/A
RoleWebdavPermissions Added Data API N/A
Roles Added Data API N/A
Site Changed Data API More
Site Changed Shop API More
SiteArchiveExportConfiguration Added Data API N/A
SiteArchiveImportConfiguration Added Data API N/A
SlotConfiguration Changed Data API More
SlotConfigurations Added Data API N/A
SlotContent Changed Data API More
SlotSearchResult Added Data API N/A
Slots Added Data API N/A
SourceCodeGroup Changed Data API More
Status Added Shop API N/A
Store Changed Data API More
Store Changed Shop API More
Stores Added Data API N/A
SuggestedPhrase Added Shop API N/A
SuggestedTerm Added Shop API N/A
SuggestedTerms Added Shop API N/A
Suggestion Changed Shop API More
SuggestionResult Changed Shop API More
User Added Data API N/A
UserSearchResult Added Data API N/A
Users Added Data API N/A
Variant Changed Data API More
VariationAttribute Changed Data API More
VariationAttributeValue 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 16.9.

PATCH /baskets/{basket_id}

Element Change API 16.9 19.1
Description Changed Shop Updates a basket. Only the currency of the basket and the custom properties of the basket and of the shipping items will be considered. Updates a basket. Only the currency of the basket, source code, and the custom properties of the basket and of the shipping items will be considered.
Fault Added Shop N/A

SourceCodeNotFoundException(404): Indicates that the provided code was not found.

sourceCode (String)

Fault Added Shop N/A

SourceCodeInactiveException(400): Indicates that the provided code is not currently active.

sourceCode (String)

POST /baskets/{basket_id}/items

Element Change API 16.9 19.1
Title Changed Shop Add item to a basket Add items to a basket
Description Changed Shop Adds a new item to a basket.

The added item is associated with the specified shipment. If no shipment id is specified, the added item is associated with the default shipment.

Considered values from the request body are:
  • product_id: a valid product id. This is the id of the product to be added to the basket. If the product is already in the basket, the API either increments the quantity of the existing product line item or creates a new product line item, based on the site preference 'Add Product Behavior'. For option products and product bundles containing variation masters, the API creates a new product line item regardless of the site preference.
  • shipment_id: a valid shipment id (optional). This is the id of the shipment in which the product item is created.
  • quantity: a number between 0.01 and 999. This is the quantity of the product to order.
  • inventory_id: a valid inventory id (optional). This is the id of the inventory from which the item is allocated.
  • option_items/option_value_id: a valid option value id. This is an option value for an option item of an option product.

    This is only possible if the product item is an option product. To set option values, you must specify a collection of option items in the option_items property. These option items must contain option_id and option_value_id. Also, the values you specify must be valid for the option product that this product item represents. Otherwise, the server throws an InvalidProductOptionItemException or an InvalidProductOptionValueItemException.
  • custom properties in the form c_<CUSTOM_NAME>: the custom property must correspond to a custom attribute (<CUSTOM_NAME>) defined for ProductLineItem. The value of this property must be valid for the type of custom attribute defined for ProductLineItem.
Adds new items to a basket.

The added items are associated with the specified shipment. If no shipment id is specified, the added items are associated with the default shipment.

Considered values from the request body, for each item are:
  • product_id: a valid product id. This is the id of the product to be added to the basket. If the product is already in the basket, the API either increments the quantity of the existing product line item or creates a new product line item, based on the site preference 'Add Product Behavior'. For option products and product bundles containing variation masters, the API creates a new product line item regardless of the site preference.
  • shipment_id: a valid shipment id (optional). This is the id of the shipment in which the product item is created.
  • quantity: a number between 0.01 and 999. This is the quantity of the product to order.
  • inventory_id: a valid inventory id (optional). This is the id of the inventory from which the item is allocated.
  • bonus_discount_line_item_id: a valid bonus discount line item id (optional). This is the id of the bonus discount line item for which the added product is a selected bonus product.
  • option_items/option_value_id: a valid option value id. This is an option value for an option item of an option product.

    This is only possible if the product item is an option product. To set option values, you must specify a collection of option items in the option_items property. These option items must contain option_id and option_value_id. Also, the values you specify must be valid for the option product that this product item represents. Otherwise, the server throws an InvalidProductOptionItemException or an InvalidProductOptionValueItemException.
  • custom properties in the form c_<CUSTOM_NAME>: the custom property must correspond to a custom attribute (<CUSTOM_NAME>) defined for ProductLineItem. The value of this property must be valid for the type of custom attribute defined for ProductLineItem.

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

Element Change API 16.9 19.1
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)

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

Element Change API 16.9 19.1
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.
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.
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 16.9 19.1
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.
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.
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 /content/({id},...,{id})

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /content/{id}

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /content_search

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /custom_objects/{object_type}/{key}

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /customers/{customer_id}/orders

Element Change API 16.9 19.1
Query Parameter Added Shop N/A

Name: from

Type: String

Description: The from date specifying the date time range to filter orders (inclusive, null allowed, ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ).

Constraints:

Query Parameter Added Shop N/A

Name: until

Type: String

Description: The until date specifying the date time range to filter orders (inclusive, null allowed, ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ).

Constraints:

Query Parameter Added Shop N/A

Name: status

Type: String

Description: The order status of the orders to be retrieved. Status included: created, new, open, completed, cancelled, replaced, failed.

Constraints:

Fault Added Shop N/A

InvalidOrderStatusException(400): Thrown if specified status is unknown.

status (String)

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

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /folders/{id}

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

POST /jobs/{job_id}/executions

Element Change API 16.9 19.1
Description Changed Data Executes the job with the given job ID by creating and returning a job execution for it. The job might still be executed when the job execution is returned. Executes the job with the given job ID by creating and returning a job execution for it. The job might still be executed when the job execution is returned. Note that this resource is also intended for running system jobs.
Body Changed Data None String

GET /product_lists

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /product_lists/{list_id}

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /product_lists/{list_id}/items

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /product_lists/{list_id}/items/{item_id}

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /product_search

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.
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 /product_search/availability

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /product_search/images

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /product_search/prices

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /product_search/variations

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /products/{id}

Element Change API 16.9 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.

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

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.
Query Parameter Added Shop N/A

Name: all_images

Type: Boolean

Description: The flag that indicates whether to retrieve the whole image model for the requested product.

Constraints:

GET /products/{id}

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.
Query Parameter Added Shop N/A

Name: all_images

Type: Boolean

Description: The flag that indicates whether to retrieve the whole image model for the requested product.

Constraints:

GET /products/{id}/availability

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /products/{id}/bundled_products

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /products/{id}/images

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /products/{id}/links

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /products/{id}/options

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /products/{id}/prices

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /products/{id}/promotions

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /products/{id}/recommendations

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /products/{id}/set_products

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /products/{id}/variations

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /promotions

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

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

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /promotions/{id}

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /search_suggestion

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /site

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /stores

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

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

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

GET /stores/{id}

Element Change API 16.9 19.1
Authentication Added Shop N/A JWT: Authentication via Customer JWT token.

Details about modified documents

The following documents have been modified since 16.9.

Basket

Element Change API 16.9 19.1
Property Added Shop N/A

Name: bonus_discount_line_items

Type: [BonusDiscountLineItem]

Description: The bonus discount line items of the line item container.

Constraints:

Property Added Shop N/A

Name: inventory_reservation_expiry

Type: Date

Description:

Constraints:

Property Added Shop N/A

Name: source_code

Type: String

Description: Gets the source code assigned to this basket.

Constraints:

Property Changed Shop

Name: creation_date

Description: Gets the creation date of this basket.

Name: creation_date

Description: Returns the value of attribute 'creationDate'.

Property Changed Shop

Name: last_modified

Description: Gets the last date this basket was modified last.

Name: last_modified

Description: Returns the value of attribute 'lastModified'.

Campaign

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Catalog

Element Change API 16.9 19.1
Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Data

Name: creation_date

Type: DateTime

Description: The creation date of catalog. It is read only.

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Category

Element Change API 16.9 19.1
Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Data

Name: creation_date

Type: DateTime

Description: The date when the category is created. This is a computed attribute and cannot be modified.

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

ContentAsset

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

ContentFolder

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Coupon

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Customer

Element Change API 16.9 19.1
Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Added Data N/A

Name: primary_address

Type: CustomerAddress

Description: The customers primary or default address.

Constraints:

Property Changed Data

Name: creation_date

Description: The date when the customer was first created in the system.

Name: creation_date

Description: Returns the value of attribute 'creationDate'.

Customer

Element Change API 16.9 19.1
Property Added Shop N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Added Shop N/A

Name: note

Type: String

Description: The customer's note.

Constraints:

Property Changed Shop

Name: creation_date

Description: The customer's creation date.

Name: creation_date

Description: Returns the value of attribute 'creationDate'.

CustomerAddress

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

CustomerAddress

Element Change API 16.9 19.1
Property Added Shop N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Shop N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

CustomerGroup

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

CustomerGroupMember

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

CustomerPaymentCardRequest

Element Change API 16.9 19.1
Property Changed Shop

Name: credit_card_expired

Description:

Name: credit_card_expired

Description: A flag indicating if the credit card is expired.

CustomerPaymentInstrument

Element Change API 16.9 19.1
Property Added Shop N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Shop N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

CustomerProductList

Element Change API 16.9 19.1
Property Added Shop N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Shop N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

GiftCertificate

Element Change API 16.9 19.1
Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Data

Name: creation_date

Type: DateTime

Description: The creation date of the gift certificate.

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

InventoryList

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

JobExecution

Element Change API 16.9 19.1
Property Added Data N/A

Name: parameters

Type: [JobExecutionParameter]

Description: List of all job execution parameters.

Constraints:

JobStepExecution

Element Change API 16.9 19.1
Property Added Data N/A

Name: chunk_size

Type: Integer

Description: The chunk size for a chunk oriented step execution, otherwise null.

Constraints:

Property Added Data N/A

Name: is_chunk_oriented

Type: boolean

Description: True if this execution represents a chunk oriented step execution.

Constraints:

Property Added Data N/A

Name: item_filter_count

Type: Integer

Description: The current number of items that have been filtered for a chunk oriented step execution, otherwise null.

Constraints:

Property Added Data N/A

Name: item_write_count

Type: Integer

Description: The current number of items that have been written for a chunk oriented step execution, otherwise null.

Constraints:

Property Added Data N/A

Name: total_item_count

Type: Long

Description: The total number of items that will be processed for a chunk oriented step execution (null if unknown), otherwise null.

Constraints:

OptionItem

Element Change API 16.9 19.1
Property Added Shop N/A

Name: bonus_discount_line_item_id

Type: String

Description: The id of the bonus discount line item this bonus product relates to.

Constraints:

Property Added Shop N/A

Name: gift

Type: boolean

Description: Returns true if the item is a gift.

Constraints:

Property Added Shop N/A

Name: gift_message

Type: String

Description: The gift message.

Constraints:

Order

Element Change API 16.9 19.1
Property Added Shop N/A

Name: bonus_discount_line_items

Type: [BonusDiscountLineItem]

Description: The bonus discount line items of the line item container.

Constraints:

Property Added Shop N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Added Shop N/A

Name: source_code

Type: String

Description: Gets the source code assigned to this basket.

Constraints:

Property Changed Shop

Name: creation_date

Type: DateTime

Description: The order creation date. This property follows the ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ. The time zone of the date time is always UTC.

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

OrderPaymentCardRequest

Element Change API 16.9 19.1
Property Changed Shop

Name: credit_card_expired

Description:

Name: credit_card_expired

Description: A flag indicating if the credit card is expired.

OrderPaymentInstrument

Element Change API 16.9 19.1
Property Added Shop N/A

Name: authorization_status

Type: Status

Description: The authorization status of the payment transaction.

Constraints:

PaymentMethod

Element Change API 16.9 19.1
Property Added Shop N/A

Name: payment_processor_id

Type: String

Description: The payment processor ID.

Constraints:

PriceAdjustment

Element Change API 16.9 19.1
Property Added Shop N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Shop

Name: creation_date

Description: The creation date

Name: creation_date

Description: Returns the value of attribute 'creationDate'.

Product

Element Change API 16.9 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: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

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: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

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:

Property Changed Data

Name: image

Type: Image

Name: image

Type: MediaFile

Property Changed Data

Name: long_description

Type: [String]

Description: The localized product long description.

Name: long_description

Type: [MarkupText]

Description: The localized long description of the product.

Property Changed Data

Name: short_description

Type: [String]

Description: The localized product short description.

Name: short_description

Type: [MarkupText]

Description: The localized short description of the product.

Product

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

ProductInventoryRecord

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

ProductItem

Element Change API 16.9 19.1
Property Added Shop N/A

Name: bonus_discount_line_item_id

Type: String

Description: The id of the bonus discount line item this bonus product relates to.

Constraints:

Property Added Shop N/A

Name: gift

Type: boolean

Description: Returns true if the item is a gift.

Constraints:

Property Added Shop N/A

Name: gift_message

Type: String

Description: The gift message.

Constraints:

ProductSearchHit

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

ProductSearchResult

Element Change API 16.9 19.1
Property Added Shop N/A

Name: search_phrase_suggestions

Type: Suggestion

Description: The suggestion given by the system for the submitted search phrase.

Constraints:

Property Removed Shop

Name: suggested_search_phrase

Type: String

Description: The suggestion given by the system if no result was found for the submitted search phrase.

Constraints:

N/A

Promotion

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

PublicProductList

Element Change API 16.9 19.1
Property Added Shop N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Shop N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Site

Element Change API 16.9 19.1
Property Added Data N/A

Name: cartridges

Type: String

Description: The cartridge Path of the site

Constraints:

Site

Element Change API 16.9 19.1
Property Added Shop N/A

Name: default_currency

Type: String

Description: The currency mnemonic of the site.

Constraints:

Property Removed Shop

Name: currency

Type: String

Description: The currency mnemonic of the site.

Constraints:

N/A
Property Changed Shop

Name: allowed_locales

Type: [String]

Name: allowed_locales

Type: [Locale]

SlotConfiguration

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Data

Name: callout_msg

Type: [String]

Name: callout_msg

Type: [MarkupText]

SlotContent

Element Change API 16.9 19.1
Property Changed Data

Name: body

Type: [String]

Name: body

Type: [MarkupText]

SourceCodeGroup

Element Change API 16.9 19.1
Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Data

Name: creation_date

Type: DateTime

Description: The creation date, read only

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Store

Element Change API 16.9 19.1
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Added Data N/A

Name: pos_enabled

Type: Boolean

Description: Whether this store uses our Store product for Point-of-Sale

Constraints:

Property Removed Data

Name: demandware_pos_enabled

Type: Boolean

Description: Whether this store uses Store for Point-of-Sale

Constraints:

N/A
Property Changed Data

Name: image

Type: String

Constraints: maxLength=256

Name: image

Type: MediaFile

Constraints:

Property Changed Data

Name: store_events

Type: [String]

Name: store_events

Type: [MarkupText]

Property Changed Data

Name: store_hours

Type: [String]

Name: store_hours

Type: [MarkupText]

Store

Element Change API 16.9 19.1
Property Added Shop N/A

Name: pos_enabled

Type: Boolean

Description: Whether this store uses Store Point-of-Sale.

Constraints:

Property Removed Shop

Name: demandware_pos_enabled

Type: Boolean

Description: Whether this store uses Store Point-of-Sale.

Constraints:

N/A

Suggestion

Element Change API 16.9 19.1
Property Added Shop N/A

Name: suggested_phrases

Type: [SuggestedPhrase]

Description: A list of suggested phrases. This list can be empty.

Constraints:

Property Added Shop N/A

Name: suggested_terms

Type: [SuggestedTerms]

Description: A list of suggested terms. This list can be empty.

Constraints:

SuggestionResult

Element Change API 16.9 19.1
Property Added Shop N/A

Name: brand_suggestions

Type: Suggestion

Description: Returns the suggested brands.

Constraints:

Property Added Shop N/A

Name: category_suggestions

Type: Suggestion

Description: Returns the suggested categories.

Constraints:

Property Added Shop N/A

Name: content_suggestions

Type: Suggestion

Description: Returns the suggested content.

Constraints:

Property Added Shop N/A

Name: custom_suggestions

Type: Suggestion

Description: Returns the suggested custom suggestions.

Constraints:

Property Added Shop N/A

Name: product_suggestions

Type: Suggestion

Description: Returns the suggested products.

Constraints:

Property Removed Shop

Name: suggested_phrases

Type: [String]

Description: The suggested phrases.

Constraints:

N/A
Property Removed Shop

Name: suggestions

Type: [Suggestion]

Description: The sorted list of search hits. This list can be empty.

Constraints:

N/A

Variant

Element Change API 16.9 19.1
Property Added Data N/A

Name: variation_attributes

Type: [VariationAttribute]

Description: variation attributes

Constraints:

Property Changed Data

Name: image

Type: Image

Name: image

Type: MediaFile

VariationAttribute

Element Change API 16.9 19.1
Property Added Data N/A

Name: attribute_definition_id

Type: String

Description: The id of the requested attribute definition.

Constraints: mandatory=true, nullable=false

Property Added Data N/A

Name: attribute_definition_name

Type: [String]

Description: The localized display name of the variation attribute definition.

Constraints:

Property Added Data N/A

Name: default_value

Type: String

Description: default variation attribute value

Constraints:

Property Added Data N/A

Name: link

Type: String

Description: URL that is used to get this instance

Constraints:

Property Added Data N/A

Name: shared

Type: boolean

Description: Returns the value of attribute 'shared' if attribute is local or shared

Constraints:

Property Added Data N/A

Name: slicing

Type: boolean

Description: Returns the value of attribute 'slicing'.

Constraints:

Property Added Data N/A

Name: variation_attribute_type

Type: Enum {string, int, unknown}

Description: variation attribute type

Constraints:

VariationAttributeValue

Element Change API 16.9 19.1
Property Added Data N/A

Name: link

Type: String

Description:

Constraints:

Property Added Data N/A

Name: position

Type: Double

Description: The position of the value among all values of a variation attribute.

Constraints:

Property Changed Data

Name: image

Type: Image

Name: image

Type: MediaFile

Property Changed Data

Name: image_swatch

Type: Image

Name: image_swatch

Type: MediaFile