OCAPI 20.8 changes since 16.2

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

Resources added, modified, or removed since 16.2

Resource Name Change Http Method URL Template API Details
AbTestSearch Added POST /sites/{site_id}/ab_test_search Data N/A
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
AbTests Added DELETE /sites/{site_id}/ab_tests/{id} Data N/A
AbTests Added GET /sites/{site_id}/ab_tests/{id} Data N/A
AbTests Added PATCH /sites/{site_id}/ab_tests/{id} Data N/A
AbTests Added PUT /sites/{site_id}/ab_tests/{id} Data N/A
AbTests Added DELETE /sites/{site_id}/ab_tests/{id}/segments/{segment_id} Data N/A
AbTests Added GET /sites/{site_id}/ab_tests/{id}/segments/{segment_id} Data N/A
AbTests Added PATCH /sites/{site_id}/ab_tests/{id}/segments/{segment_id} Data N/A
AbTests Added PUT /sites/{site_id}/ab_tests/{id}/segments/{segment_id} Data N/A
Alerts Added GET /alerts/descriptors Data N/A
Alerts Added GET /alerts/descriptors/{application_id} Data N/A
Alerts Added GET /alerts/descriptors/{application_id}/{application_context_path}/{message_id} Data N/A
Alerts Added PATCH /alerts/descriptors/{application_id}/{application_context_path}/{message_id}/revalidate Data N/A
Alerts Added GET /alerts/items Data N/A
Alerts Added GET /alerts/items/{application_id} Data N/A
Alerts Added DELETE /alerts/items/{application_id}/{application_context_path}/{message_id}/{context_object_id} Data N/A
Alerts Added GET /alerts/items/{application_id}/{application_context_path}/{message_id}/{context_object_id} Data N/A
Alerts Added GET /alerts/usersettings Data N/A
Alerts Added PATCH /alerts/usersettings Data 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 DELETE /baskets/{basket_id}/notes/{note_id} Shop N/A
Baskets Added PATCH /baskets/{basket_id}/price_adjustments/{price_adjustment_id} Shop N/A
Baskets Added DELETE /baskets/{basket_id}/shipments/{shipment_id} Shop N/A
Baskets Added PUT /baskets/{basket_id}/storefront Shop N/A
Baskets Changed DELETE /baskets/{basket_id} Shop More
Baskets Changed PATCH /baskets/{basket_id} Shop More
Baskets Changed PUT /baskets/{basket_id}/billing_address Shop More
Baskets Changed POST /baskets/{basket_id}/coupons Shop More
Baskets Changed DELETE /baskets/{basket_id}/coupons/{coupon_item_id} Shop More
Baskets Changed PUT /baskets/{basket_id}/customer Shop More
Baskets Changed POST /baskets/{basket_id}/gift_certificate_items Shop More
Baskets Changed POST /baskets/{basket_id}/items Shop More
Baskets Changed DELETE /baskets/{basket_id}/items/{item_id} Shop More
Baskets Changed PATCH /baskets/{basket_id}/items/{item_id} Shop More
Baskets Changed POST /baskets/{basket_id}/payment_instruments Shop More
Baskets Changed DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id} Shop More
Baskets Changed PATCH /baskets/{basket_id}/payment_instruments/{payment_instrument_id} Shop More
Baskets Changed POST /baskets/{basket_id}/price_adjustments Shop More
Baskets Changed DELETE /baskets/{basket_id}/price_adjustments/{price_adjustment_id} Shop More
Baskets Changed POST /baskets/{basket_id}/shipments Shop More
Baskets Changed PATCH /baskets/{basket_id}/shipments/{shipment_id} Shop More
Baskets Changed PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_address Shop More
Baskets Changed PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_method Shop More
Campaigns Added DELETE /sites/{site_id}/campaigns/{campaign_id}/promotions/{promotion_id} Data N/A
Campaigns Added PUT /sites/{site_id}/campaigns/{campaign_id}/promotions/{promotion_id} Data N/A
Campaigns Added DELETE /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_id} Data N/A
Campaigns Added PATCH /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_id} Data N/A
Campaigns Added PUT /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 PATCH /sites/{site_id}/campaigns/{campaign_id} Data More
CatalogSearch Added POST /catalog_search Data N/A
Catalogs Added GET /catalogs Data N/A
Catalogs Added GET /catalogs/{catalog_id} Data N/A
Catalogs Added PATCH /catalogs/{catalog_id} Data N/A
Catalogs Added POST /catalogs/{catalog_id}/category_search 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 Added DELETE /catalogs/{catalog_id}/categories/{category_id} Data N/A
Categories Added GET /catalogs/{catalog_id}/categories/{category_id} Data N/A
Categories Added PATCH /catalogs/{catalog_id}/categories/{category_id} Data N/A
Categories Added PUT /catalogs/{catalog_id}/categories/{category_id} Data N/A
Categories Added DELETE /catalogs/{catalog_id}/categories/{category_id}/products/{product_id} Data N/A
Categories Added GET /catalogs/{catalog_id}/categories/{category_id}/products/{product_id} Data N/A
Categories Added PATCH /catalogs/{catalog_id}/categories/{category_id}/products/{product_id} Data N/A
Categories Added PUT /catalogs/{catalog_id}/categories/{category_id}/products/{product_id} Data N/A
Categories Changed GET /categories/({id},...,{id}) Shop More
Categories Changed GET /categories/{id} Shop More
CategoryLinks Added GET /catalogs/{catalog_id}/categories/{category_id}/category_links Data N/A
CategoryLinks Added DELETE /catalogs/{catalog_id}/categories/{category_id}/category_links/{target_catalog_id}/{target_category_id}/{type} Data N/A
CategoryLinks Added GET /catalogs/{catalog_id}/categories/{category_id}/category_links/{target_catalog_id}/{target_category_id}/{type} Data N/A
CategoryLinks Added PATCH /catalogs/{catalog_id}/categories/{category_id}/category_links/{target_catalog_id}/{target_category_id}/{type} Data N/A
CategoryLinks Added PUT /catalogs/{catalog_id}/categories/{category_id}/category_links/{target_catalog_id}/{target_category_id}/{type} Data N/A
CategoryProductAssignmentSearch Added POST /catalogs/{catalog_id}/categories/{category_id}/category_product_assignment_search Data N/A
CategorySearch Added POST /category_search Data N/A
CodeVersions Added GET /code_versions Data N/A
CodeVersions Added DELETE /code_versions/{code_version_id} Data N/A
CodeVersions Added GET /code_versions/{code_version_id} Data N/A
CodeVersions Added PATCH /code_versions/{code_version_id} Data N/A
CodeVersions Added PUT /code_versions/{code_version_id} Data N/A
Content Changed GET /content/({id},...,{id}) Shop More
Content Changed GET /content/{id} Shop More
ContentSearch Changed GET /content_search Shop More
CouponRedemptionSearch Added POST /sites/{site_id}/coupon_redemption_search Data N/A
Coupons Added GET /sites/{site_id}/coupons Data N/A
Coupons Added GET /sites/{site_id}/coupons/{coupon_id}/campaigns Data N/A
Coupons Added GET /sites/{site_id}/coupons/{coupon_id}/campaigns/{campaign_id}/promotions Data N/A
Coupons Added GET /sites/{site_id}/coupons/{coupon_id}/codes Data N/A
Coupons Added POST /sites/{site_id}/coupons/{coupon_id}/multiple_codes Data N/A
Coupons Added GET /sites/{site_id}/coupons/{coupon_id}/promotions Data N/A
Coupons Changed PATCH /sites/{site_id}/coupons/{coupon_id} Data More
CustomObjectDefinitions Added POST /custom_object_definitions/{object_type}/attribute_definition_search Data N/A
CustomObjectDefinitions Added GET /custom_object_definitions/{object_type}/attribute_definitions Data N/A
CustomObjectDefinitions Added DELETE /custom_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
CustomObjectDefinitions Added GET /custom_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
CustomObjectDefinitions Added PATCH /custom_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
CustomObjectDefinitions Added PUT /custom_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
CustomObjectDefinitions Added POST /custom_object_definitions/{object_type}/attribute_group_search Data N/A
CustomObjectDefinitions Added GET /custom_object_definitions/{object_type}/attribute_groups Data N/A
CustomObjectDefinitions Added DELETE /custom_object_definitions/{object_type}/attribute_groups/{group_id}/attribute_definitions/{def_id} Data N/A
CustomObjectDefinitions Added PUT /custom_object_definitions/{object_type}/attribute_groups/{group_id}/attribute_definitions/{def_id} Data N/A
CustomObjectDefinitions Added DELETE /custom_object_definitions/{object_type}/attribute_groups/{id} Data N/A
CustomObjectDefinitions Added GET /custom_object_definitions/{object_type}/attribute_groups/{id} Data N/A
CustomObjectDefinitions Added PATCH /custom_object_definitions/{object_type}/attribute_groups/{id} Data N/A
CustomObjectDefinitions Added PUT /custom_object_definitions/{object_type}/attribute_groups/{id} Data N/A
CustomObjects Changed PATCH /custom_objects/{object_type}/{key} Data More
CustomObjects Changed GET /custom_objects/{object_type}/{key} Shop More
CustomerGroupSearch Added POST /sites/{site_id}/customer_group_search Data N/A
CustomerGroups Added GET /sites/{site_id}/customer_groups Data N/A
CustomerGroups Added DELETE /sites/{site_id}/customer_groups/{id} Data N/A
CustomerGroups Added GET /sites/{site_id}/customer_groups/{id} Data N/A
CustomerGroups Added PATCH /sites/{site_id}/customer_groups/{id} Data N/A
CustomerGroups Added PUT /sites/{site_id}/customer_groups/{id} Data N/A
CustomerGroups Added POST /sites/{site_id}/customer_groups/{id}/member_search Data N/A
CustomerGroups Added GET /sites/{site_id}/customer_groups/{id}/members Data N/A
CustomerGroups Added DELETE /sites/{site_id}/customer_groups/{id}/members/{customer_no} Data N/A
CustomerGroups Added GET /sites/{site_id}/customer_groups/{id}/members/{customer_no} Data N/A
CustomerGroups Added PUT /sites/{site_id}/customer_groups/{id}/members/{customer_no} Data N/A
CustomerLists Added POST /customer_lists/{customer_list_id}/customer_search Data N/A
CustomerLists Added PUT /customer_lists/{list_id}/customers/{customer_no} Data N/A
CustomerLists Changed PATCH /customer_lists/{list_id}/customers/{customer_no} Data More
CustomerLists Changed PATCH /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id} Data More
CustomerSearch Removed POST /customer_search Data N/A
Customers Added DELETE /customers/auth Shop N/A
Customers Added POST /customers/auth/trustedsystem Shop N/A
Customers Added POST /customers/{customer_id}/auth Shop N/A
Customers Added GET /customers/{customer_id}/product_lists Shop N/A
Customers Added POST /customers/{customer_id}/product_lists Shop N/A
Customers Added DELETE /customers/{customer_id}/product_lists/{list_id} Shop N/A
Customers Added GET /customers/{customer_id}/product_lists/{list_id} Shop N/A
Customers Added PATCH /customers/{customer_id}/product_lists/{list_id} Shop N/A
Customers Added GET /customers/{customer_id}/product_lists/{list_id}/items Shop N/A
Customers Added POST /customers/{customer_id}/product_lists/{list_id}/items Shop N/A
Customers Added DELETE /customers/{customer_id}/product_lists/{list_id}/items/{item_id} Shop N/A
Customers Added GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id} Shop N/A
Customers Added PATCH /customers/{customer_id}/product_lists/{list_id}/items/{item_id} Shop 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 PATCH /customers/{customer_id} Shop More
Customers Changed GET /customers/{customer_id}/addresses Shop More
Customers Changed PATCH /customers/{customer_id}/addresses/{address_name} Shop More
Customers Changed GET /customers/{customer_id}/orders Shop More
Customers Changed GET /customers/{customer_id}/payment_instruments/{payment_instrument_id} Shop More
Folders Changed GET /folders/({id},...,{id}) Shop More
Folders Changed GET /folders/{id} Shop More
GiftCertificates Added GET /sites/{site_id}/gift_certificates Data N/A
GiftCertificates Changed PATCH /sites/{site_id}/gift_certificates/{merchant_id} Data More
GlobalPreferences Added GET /global_preferences/preference_groups/{group_id}/{instance_type} Data N/A
GlobalPreferences Added PATCH /global_preferences/preference_groups/{group_id}/{instance_type} Data N/A
InventoryLists Added GET /inventory_lists Data N/A
InventoryLists Changed PATCH /inventory_lists/{id} Data More
JobExecutionSearch Added POST /job_execution_search Data N/A
Jobs Added POST /jobs/{job_id}/executions Data N/A
Jobs Added DELETE /jobs/{job_id}/executions/{id} Data N/A
Jobs Added GET /jobs/{job_id}/executions/{id} Data N/A
Libraries Added PATCH /libraries/{library_id}/folder_assignments/{content_id}/{folder_id} Data N/A
Libraries Changed PATCH /libraries/{library_id}/content/{content_id} Data More
Libraries Changed PUT /libraries/{library_id}/folder_assignments/{content_id}/{folder_id} Data More
Libraries Changed PATCH /libraries/{library_id}/folders/{folder_id} Data More
LocaleInfo Added GET /locale_info/locales Data N/A
LogRequests Added POST /log_requests/ecdn Data N/A
LogRequests Added GET /log_requests/ecdn/{id} Data N/A
OcapiConfigs Added DELETE /ocapi_configs/{clientId} Data N/A
OcapiConfigs Added GET /ocapi_configs/{clientId} Data N/A
OcapiConfigs Added POST /ocapi_configs/{clientId} Data N/A
OcapiConfigs Added PUT /ocapi_configs/{clientId} Data N/A
OrderSearch Changed POST /order_search Shop More
Orders Added PATCH /orders/{order_no} Shop N/A
Orders Added PUT /orders/{order_no} Shop N/A
Orders Added DELETE /orders/{order_no}/notes/{note_id} Shop N/A
Orders Changed POST /orders Shop More
Orders Changed POST /orders/{order_no}/payment_instruments Shop More
Orders Changed DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id} Shop More
Orders Changed PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id} Shop More
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
ProductInventoryRecords Added GET /inventory_lists/{inventory_list_id}/product_inventory_records Data N/A
ProductInventoryRecords Added DELETE /inventory_lists/{inventory_list_id}/product_inventory_records/{product_id} Data N/A
ProductInventoryRecords Added GET /inventory_lists/{inventory_list_id}/product_inventory_records/{product_id} Data N/A
ProductInventoryRecords Added PATCH /inventory_lists/{inventory_list_id}/product_inventory_records/{product_id} Data N/A
ProductInventoryRecords Added PUT /inventory_lists/{inventory_list_id}/product_inventory_records/{product_id} Data N/A
ProductLists Added GET /product_lists/{list_id}/items/{item_id} Shop N/A
ProductLists Removed POST /product_lists Shop N/A
ProductLists Removed DELETE /product_lists/{list_id} Shop N/A
ProductLists Removed PATCH /product_lists/{list_id} Shop N/A
ProductLists Removed POST /product_lists/{list_id}/items Shop N/A
ProductLists Removed DELETE /product_lists/{list_id}/items/{item_id} Shop N/A
ProductLists Removed PATCH /product_lists/{list_id}/items/{item_id} 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
ProductSearch Added POST /product_search Data N/A
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/{id} Data N/A
Products Added GET /products/{id} Data N/A
Products Added PATCH /products/{id} Data N/A
Products Added PUT /products/{id} Data N/A
Products Added GET /products/{master_product_id}/variation_groups Data N/A
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 GET /products/{master_product_id}/variations 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 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 Added GET /products/{id}/shipping_methods Shop N/A
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
PromotionCampaignAssignmentSearch Added POST /sites/{site_id}/promotion_campaign_assignment_search Data N/A
PromotionSearch Added POST /sites/{site_id}/promotion_search Data N/A
Promotions Added DELETE /sites/{site_id}/promotions/{id} Data N/A
Promotions Added GET /sites/{site_id}/promotions/{id} Data N/A
Promotions Added PATCH /sites/{site_id}/promotions/{id} Data N/A
Promotions Added PUT /sites/{site_id}/promotions/{id} Data N/A
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
Settings Added GET /settings/logging/custom Data N/A
Settings Added PATCH /settings/logging/custom Data N/A
Site Changed GET /site Shop More
SitePreferences Added POST /site_preferences/preference_groups/{group_id}/{instance_type}/preference_search Data N/A
SitePreferences Added GET /site_preferences/preference_groups/{group_id}/{instance_type}/preferences/{preference_id} Data N/A
SiteSearch Added POST /site_search Data N/A
Sites Added GET /sites Data N/A
Sites Added GET /sites/{site_id}/ab_tests Data N/A
Sites Added GET /sites/{site_id}/ai/recommender_names Data N/A
Sites Added POST /sites/{site_id}/cartridges Data N/A
Sites Added PUT /sites/{site_id}/cartridges Data N/A
Sites Added DELETE /sites/{site_id}/cartridges/{cartridge_name} Data N/A
Sites Added GET /sites/{site_id}/locale_info/locales Data N/A
Sites Added PATCH /sites/{site_id}/orders/{order_no} Data N/A
Sites Added PUT /sites/{site_id}/orders/{order_no}/confirmation_status Data N/A
Sites Added PUT /sites/{site_id}/orders/{order_no}/export_status Data N/A
Sites Added PUT /sites/{site_id}/orders/{order_no}/external_status Data N/A
Sites Added PATCH /sites/{site_id}/orders/{order_no}/payment_instruments/{payment_instrument_id} Data N/A
Sites Added PATCH /sites/{site_id}/orders/{order_no}/payment_instruments/{payment_instrument_id}/transaction Data N/A
Sites Added PUT /sites/{site_id}/orders/{order_no}/payment_status Data N/A
Sites Added PUT /sites/{site_id}/orders/{order_no}/shipments/{shipment_id}/shipping_address Data N/A
Sites Added PUT /sites/{site_id}/orders/{order_no}/shipping_status Data N/A
Sites Added PUT /sites/{site_id}/orders/{order_no}/status Data N/A
Sites Added GET /sites/{site_id}/site_preferences/preference_groups/{group_id}/{instance_type} Data N/A
Sites Added PATCH /sites/{site_id}/site_preferences/preference_groups/{group_id}/{instance_type} Data N/A
Sites Added GET /sites/{site_id}/slot_configurations Data N/A
Sites Changed PATCH /sites/{site_id}/custom_objects/{object_type}/{key} Data More
SlotConfigurationCampaignAssignmentSearch Added POST /sites/{site_id}/slot_configuration_campaign_assignment_search Data N/A
SlotConfigurations Changed PATCH /sites/{site_id}/slots/{slot_id}/slot_configurations/{configuration_id} Data More
SlotSearch Added POST /sites/{site_id}/slot_search Data N/A
Slots Added GET /sites/{site_id}/slots Data N/A
Slots Added GET /sites/{site_id}/slots/{slot_id}/{context_type} Data N/A
SortingRuleSearch Added POST /sites/{site_id}/sorting_rule_search Data N/A
SourceCodeGroupSearch Added POST /sites/{site_id}/source_code_group_search Data N/A
SourceCodeGroups Added GET /sites/{site_id}/source_code_groups Data N/A
SourceCodeGroups Added DELETE /sites/{site_id}/source_code_groups/{id} Data N/A
SourceCodeGroups Added GET /sites/{site_id}/source_code_groups/{id} Data N/A
SourceCodeGroups Added PATCH /sites/{site_id}/source_code_groups/{id} Data N/A
SourceCodeGroups Added PUT /sites/{site_id}/source_code_groups/{id} Data N/A
Stores Added GET /sites/{site_id}/stores Data N/A
Stores Changed PATCH /sites/{site_id}/stores/{id} Data More
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
VariantSearch Added POST /products/{id}/variant_search Data N/A

Documents added, modified, or removed since 16.2

Document Name Change API Details
AbTest Added Data API N/A
AbTestGroup Added Data API N/A
AbTestSearchResult Added Data API N/A
AbTestSegment Added Data API N/A
AbTestSegmentStats Added Data API N/A
AbTestTrigger Added Data API N/A
AbTests Added Data API N/A
AddressLink Removed Shop API N/A
AlertDescriptor Added Data API N/A
AlertDescriptorSettings Added Data API N/A
AlertDescriptors Added Data API N/A
AlertDescriptorsRevalidationRequest Added Data API N/A
AlertItem Added Data API N/A
AlertItems Added Data API N/A
AlertSettings Added Data 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
Campaigns Added Data API N/A
CartridgePathAddRequest Added Data API N/A
CartridgePathApiResponse Added Data API N/A
CartridgePathCreateRequest Added Data API N/A
Catalog Added Data API N/A
CatalogCategoryId Added Data API N/A
CatalogSearchResult Added Data API N/A
Catalogs Added Data API N/A
Categories Added Data API N/A
Category Added Data API N/A
Category Changed Shop API More
CategoryLink Added Data API N/A
CategoryLinks Added Data API N/A
CategoryProductAssignment Added Data API N/A
CategoryProductAssignmentSearchRequest Added Data API N/A
CategoryProductAssignmentSearchResult Added Data API N/A
CategorySearchResult Added Data API N/A
CodeVersion Added Data API N/A
CodeVersionResult Added Data API N/A
ContentAsset Changed Data API More
ContentFolder Changed Data API More
ContentFolderAssignment Changed Data API More
Coupon Changed Data API More
CouponCode Added Data API N/A
CouponCodes Added Data API N/A
CouponMultiCodesRequest Added Data API N/A
CouponRedemption Added Data API N/A
CouponRedemptionSearchResult Added Data API N/A
Coupons Added Data API N/A
CustomLogSettings Added Data API N/A
CustomObject Changed Data API More
Customer Changed Data API More
Customer Changed Shop API More
CustomerAddress Changed Data API More
CustomerAddress Changed Shop API More
CustomerAddressLink Added Shop API N/A
CustomerGroup Added Data API N/A
CustomerGroupMember Added Data API N/A
CustomerGroupMemberResult Added Data API N/A
CustomerGroupMemberSearchResult Added Data API N/A
CustomerGroupMembers Added Data API N/A
CustomerGroupResult Added Data API N/A
CustomerGroupSearchResult Added Data API N/A
CustomerGroups Added Data API N/A
CustomerPaymentCardRequest Changed Shop API More
CustomerPaymentInstrument Changed Shop API More
CustomerProductList Added Shop API N/A
CustomerProductListItem Added Shop API N/A
CustomerProductListItemLink Added Shop API N/A
CustomerProductListItemPurchase Added Shop API N/A
CustomerProductListItemPurchaseResult Added Shop API N/A
CustomerProductListItemResult Added Shop API N/A
CustomerProductListRegistrant Added Shop API N/A
CustomerProductListResult Added Shop API N/A
CustomerSearchHit Added Data API N/A
CustomerSearchHit Changed Data API More
CustomerSearchRequest Changed Data API More
CustomerSearchResult Changed Data API More
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
GiftCertificates Added Data API N/A
ImageGroup Added Data API N/A
InventoryList Changed Data API More
InventoryLists Added Data API N/A
JobExecution Added Data API N/A
JobExecutionParameter Added Data API N/A
JobExecutionRequest Added Data API N/A
JobExecutionResult Added Data API N/A
JobExecutionSearchResult Added Data API N/A
JobStepExecution Added Data API N/A
Locale Added Data API N/A
Locale Added Shop API N/A
LocalePermission Added Data API N/A
LocalePermissions Added Data API N/A
LocaleResult Added Data API N/A
LogCategory Added Data API N/A
MarkupText Added Data API N/A
Master Added Data API N/A
Master Changed Shop API More
MediaFile Added Data API N/A
MenuAction Added Data API N/A
MenuItem Added Data API N/A
ModulePermissions Added Data API N/A
Note Changed Shop API More
ObjectAttributeDefinition Added Data API N/A
ObjectAttributeDefinitionSearchResult Added Data API N/A
ObjectAttributeDefinitions Added Data API N/A
ObjectAttributeGroup Added Data API N/A
ObjectAttributeGroupSearchResult Added Data API N/A
ObjectAttributeGroups Added Data API N/A
ObjectAttributeValueDefinition Added Data API N/A
ObjectTypeDefinition Added Data API N/A
ObjectTypeDefinitionSearchResult Added Data API N/A
ObjectTypeDefinitions Added Data API N/A
OcapiConfigsApiRequest Added Data API N/A
OcapiConfigsApiResponse Added Data API N/A
OptionItem Changed Shop API More
Order Changed Shop API More
OrderConfirmationStatusUpdateRequest Added Data API N/A
OrderExportStatusUpdateRequest Added Data API N/A
OrderExternalStatusUpdateRequest Added Data API N/A
OrderPaymentCardRequest Changed Shop API More
OrderPaymentInstrument Changed Shop API More
OrderPaymentStatusUpdateRequest Added Data API N/A
OrderSearchHit Changed Shop API More
OrderSearchRequest Changed Shop API More
OrderSearchResult Changed Shop API More
OrderShippingStatusUpdateRequest Added Data API N/A
OrderStatusUpdateRequest Added Data API N/A
OrderUpdateRequest Added Data API N/A
OrganizationPreferences Added Data API N/A
PasswordChangeRequest Added Data API N/A
PathRecord Added Data API N/A
PathRecord Added Shop API N/A
PaymentInstrumentUpdateRequest Added Data API N/A
PaymentMethod Changed Shop API More
PaymentTransactionUpdateRequest Added Data API N/A
PreferenceValue Added Data API N/A
PreferenceValueSearchResult Added Data API N/A
PriceAdjustment Changed Shop API More
PriceAdjustmentLimit Added Shop API N/A
PriceAdjustmentLimits Added Shop API N/A
Product Added Data API N/A
Product Changed Shop API More
ProductInventoryRecord Added Data API N/A
ProductInventoryRecordAllocation Added Data API N/A
ProductInventoryRecords Added Data API N/A
ProductItem Changed Shop API More
ProductList Removed Shop API N/A
ProductListEvent Removed Shop API N/A
ProductListEvent Added Shop API N/A
ProductListItemLink Removed Shop API N/A
ProductListItemReference Added Shop API N/A
ProductListItemResult Removed Shop API N/A
ProductListRegistrant Added Shop API N/A
ProductListRegistrant Removed Shop API N/A
ProductListResult Removed Shop API N/A
ProductListShippingAddress Removed Shop API N/A
ProductListShippingAddress Added Shop API N/A
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 Added Data API N/A
ProductSearchResult Changed Shop API More
ProductSimpleLink Added Shop API N/A
ProductType Added Data API N/A
Promotion Added Data API N/A
PromotionABTestGroupAssignment Added Data API N/A
PromotionAssignmentInformation Added Data API N/A
PromotionCampaignAssignment Added Data API N/A
PromotionCampaignAssignmentSearchResult Added Data API N/A
PromotionLink Added Shop API N/A
PromotionSearchResult Added Data API N/A
Promotions Added Data API N/A
PublicProductList Added Shop API N/A
PublicProductListItem Added Shop API N/A
PublicProductListItemResult Added Shop API N/A
PublicProductListLink Added Shop API N/A
PublicProductListResult Added Shop API N/A
Recommender Added Data API N/A
RecommendersResult Added Data API N/A
ResourceInfo Added Data API N/A
ResourceObject 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
RoleSearchRequest 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
Rule Added Data API N/A
SearchIndexUpdateConfiguration Added Data API N/A
ShippingAddressUpdateRequest Added Data API N/A
ShippingMethod Changed Shop API More
Site Changed Data API More
Site Changed Shop API More
SiteArchiveExportConfiguration Added Data API N/A
SiteArchiveImportConfiguration Added Data API N/A
SitePreferences Added Data API N/A
SiteResourceInfo Added Data API N/A
SiteSearchResult Added Data API N/A
Sites Added Data API N/A
Slot Added Data API N/A
SlotConfiguration Changed Data API More
SlotConfigurationABTestGroupAssignment Added Data API N/A
SlotConfigurationAssignmentInformation Added Data API N/A
SlotConfigurationCampaignAssignment Added Data API N/A
SlotConfigurationCampaignAssignmentSearchResult Added Data API N/A
SlotConfigurations Added Data API N/A
SlotContent Changed Data API More
SlotSearchResult Added Data API N/A
Slots Added Data API N/A
SortingRule Added Data API N/A
SortingRuleSearchResult Added Data API N/A
SortingRuleStep Added Data API N/A
SourceCodeGroup Added Data API N/A
SourceCodeGroupSearchResult Added Data API N/A
SourceCodeGroups Added Data API N/A
SourceCodeRedirectInfo Added Data API N/A
SourceCodeSpecification Added Data API N/A
Status Added Data API N/A
Status Added Shop API N/A
StatusMetadata Added Data 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
Tag Added Data API N/A
TrustedSystemAuthRequest Added Shop API N/A
User Added Data API N/A
UserSearchResult Added Data API N/A
Users Added Data API N/A
Variant Added Data API N/A
Variant Changed Shop API More
VariantSearchResult Added Data API N/A
Variants Added Data API N/A
VariationAttribute Added Data API N/A
VariationAttributeValue Added Data API N/A
VariationAttributeValues Added Data API N/A
VariationAttributes Added Data API N/A
VariationGroup Added Data API N/A
VariationGroup Changed Shop API More
VariationGroups Added Data API N/A
VersionRangeObject Added Data API N/A
WebdavPermission Added Data API N/A
WebdavPermissions Added Data API N/A

Details about modified resources

The following requests have been modified since 16.2.

DELETE /baskets/{basket_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: E-Tag to match to basket.

Constraints:

N/A
Fault Added Shop N/A

BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown.

basketId (String)
Fault Changed Shop

InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth.

InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth.

PATCH /baskets/{basket_id}

Element Change API 16.2 20.8
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.
Header Parameter Removed Shop

Name: If-Match

Type: String

Description:

Constraints:

N/A
Fault Added Shop N/A

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

sourceCode (String)
Fault Added Shop N/A

UnsupportedCurrencyException(400): Indicates that the basket cannot be updated because the requested currency is not supported by the site.

currency (String)
Fault Added Shop N/A

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

sourceCode (String)

PUT /baskets/{basket_id}/billing_address

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description:

Constraints:

N/A

POST /baskets/{basket_id}/coupons

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: The ETag header value contained in the server response.

Constraints:

N/A

DELETE /baskets/{basket_id}/coupons/{coupon_item_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

PUT /baskets/{basket_id}/customer

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

POST /baskets/{basket_id}/gift_certificate_items

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

POST /baskets/{basket_id}/items

Element Change API 16.2 20.8
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.
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: The ETag header value contained in the server response.

Constraints:

N/A
Fault Added Shop N/A

BonusDiscountLineItemNotFoundException(400): Indicates that the provided bonus discount line item id is not present in the current basket.

bonusDiscountLineItemId (String)
Fault Added Shop N/A

InvalidBonusProductException(400): Indicates that the selected bonus product is not an applicable product for the bonus discount line item provided.

productId (String)

bonusDiscountLineItemId (String)
Fault Added Shop N/A

BonusProductQuantityException(400): Indicates that the quantity of the product to be added will result in the number of selected bonus choice products to exceed the amount that the user is permitted to select.

bonusDiscountLineItemId (String)

DELETE /baskets/{basket_id}/items/{item_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A
Fault Added Shop N/A

ProductItemNotFoundException(404): Indicates that the product item with the given product item id is unknown.

itemId (String)
Fault Changed Shop

InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth.

InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth.
Fault Changed Shop

BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown.

basketId (String)

BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown.

basketId (String)

PATCH /baskets/{basket_id}/items/{item_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

POST /baskets/{basket_id}/payment_instruments

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A
Fault Added Shop N/A

PaymentInstrumentNotFoundException(404): Indicates that the payment instrument with the given payment instrument number is unknown.

paymentInstrumentId (String)

PATCH /baskets/{basket_id}/payment_instruments/{payment_instrument_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

POST /baskets/{basket_id}/price_adjustments

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

DELETE /baskets/{basket_id}/price_adjustments/{price_adjustment_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

POST /baskets/{basket_id}/shipments

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: The ETag header value contained in the server response

Constraints:

N/A

PATCH /baskets/{basket_id}/shipments/{shipment_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description:

Constraints:

N/A

PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_address

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: The ETag header value contained in the server response.

Constraints:

N/A

PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_method

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

PATCH /sites/{site_id}/campaigns/{campaign_id}

Element Change API 16.2 20.8
Description Changed Data Updates the campaign with the specified information. The request must include the If-Match header, which holds the last known base-point information. The value of this header is an "ETag" representing the campaign state. If the request does not contain an If-Match header with the current server customer "ETag", a 409 (IfMatchRequiredException) fault is returned. If the If-Match header does not match the current server campaign "ETag", a 412 (InvalidIfMatchException) fault is returned. Updates the campaign with the specified information.
Header Parameter Removed Data

Name: If-Match

Type: String

Description: must match the last eTag

Constraints:

N/A
Fault Added Data N/A

CampaignDuplicateException(400): if a campaign exists already in the site with the given campaign id.

campaignId (String)

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

Element Change API 16.2 20.8
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.
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.2 20.8
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.
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.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /content/{id}

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /content_search

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

PATCH /sites/{site_id}/coupons/{coupon_id}

Element Change API 16.2 20.8
Description Changed Data Updates the coupon with the specified information. The request must include the If-Match header, which holds the last known base-point information. The value of this header is an "ETag" representing the coupon state. If the request does not contain an If-Match header with the current server customer "ETag", a 409 (IfMatchRequiredException) fault is returned. If the If-Match header does not match the current server coupon "ETag", a 412 (InvalidIfMatchException) fault is returned. Updates the coupon with the specified information.
Header Parameter Removed Data

Name: If-Match

Type: String

Description: Must match the last eTag.

Constraints:

N/A
Fault Added Data N/A

CouponUpdateForbiddenException(403): Thrown when trying to update a broken coupon, that should be deleted and re-created.

couponId (String)
Fault Added Data N/A

CouponLegacyUpdateForbiddenException(403): Thrown when trying to update a legacy coupon.

couponId (String)

PATCH /custom_objects/{object_type}/{key}

Element Change API 16.2 20.8
Header Parameter Removed Data

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

GET /custom_objects/{object_type}/{key}

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

PATCH /customer_lists/{list_id}/customers/{customer_no}

Element Change API 16.2 20.8
Description Changed Data Updates the customer with the specified information. The customer number is allowed to be updated but will result in a CustomerNumberAlreadyInUseException if there is already another customer with the same customer number existing. Updates the customer with the specified information. The customer number is allowed to be updated but will result in a CustomerNumberAlreadyInUseException if there is already another customer with the same customer number existing.
Header Parameter Removed Data

Name: If-Match

Type: String

Description: The ETag header value contained in the server response

Constraints:

N/A

PATCH /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id}

Element Change API 16.2 20.8
Header Parameter Removed Data

Name: If-Match

Type: String

Description: The ETag header value contained in the server response

Constraints:

N/A

PATCH /customers/{customer_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description:

Constraints:

N/A

GET /customers/{customer_id}/addresses

Element Change API 16.2 20.8
Description Changed Shop Returns a sorted pageable list of all customer addresses in the address book. The default page size is 10 customer addresses. The addresses are sorted so that the preferred address is always sorted first. The remaining addresses are sorted alphabetically by ID. Returns a sorted pageable list of all customer addresses in the address book. The default page size is 10 customer addresses. The addresses are sorted so that the preferred address is always sorted first. The remaining addresses are sorted alphabetically by ID.

When the customer cannot be found CustomerNotFoundException is thrown in a case of an agent but an empty result list is returned in a case of JWT.
Query Parameter Changed Shop

Name: start

Description: The result set index to return the first instance for. Default value is 0.

Name: start

Description: The result set index to return the first instance for. Default value is 0.
Query Parameter Changed Shop

Name: count

Description: The maximum number of instances per request. Default value is 25.

Name: count

Description: The maximum number of instances per request. Default value is 25.
Fault Changed Shop

InvalidCustomerException(400): If customerId URL parameter does not match the verified customer represented by the JWT, not relevant when using OAuth.

InvalidCustomerException(400): If customerId URL parameter does not match the verified customer represented by the JWT, not relevant when using OAuth.

PATCH /customers/{customer_id}/addresses/{address_name}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

GET /customers/{customer_id}/orders

Element Change API 16.2 20.8
Path Parameter Changed Shop

Name: customer_id

Description: the customer UUID

Name: customer_id

Description: the customer uuid
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 /customers/{customer_id}/payment_instruments/{payment_instrument_id}

Element Change API 16.2 20.8
Path Parameter Changed Shop

Name: payment_instrument_id

Description: the id of the payment instrument to be retrieved

Name: payment_instrument_id

Description: the id of the payment instrument to be retrievedCustomer
Fault Removed Shop

InvalidCustomerException(400): Indicates that the customerId URL parameter does not match the verified customer represented by the JWT, not relevant when using OAuth.

 N/A

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

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /folders/{id}

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

PATCH /sites/{site_id}/gift_certificates/{merchant_id}

Element Change API 16.2 20.8
Description Changed Data Updates the gift certificate with the specified information using merchant ID. The request must include the If-Match header, which holds the last known base-point information. The value of this header is an "ETag" representing the gift certificate state. If the request does not contain an If-Match header with the current server customer "ETag", a 409 (IfMatchRequiredException) fault is returned. If the If-Match header does not match the current server gift certificate "ETag", a 412 (InvalidIfMatchException) fault is returned. Updates the gift certificate with the specified information using merchant ID.
Header Parameter Removed Data

Name: If-Match

Type: String

Description: must match the last eTag

Constraints:

N/A

PATCH /inventory_lists/{id}

Element Change API 16.2 20.8
Header Parameter Removed Data

Name: If-Match

Type: String

Description:

Constraints:

N/A

PATCH /libraries/{library_id}/content/{content_id}

Element Change API 16.2 20.8
Description Changed Data Updates a content asset. In the request, the If-Match header is required. The value of the header is an 'ETag' representing the last known base-point information for the content asset. If the header is missing, the server returns a 409 (IfMatchRequiredException) fault. If the header value does not match the server's 'ETag', the server returns a 412 (InvalidIfMatchException) fault. The delta information for the library folder containing the content asset is updated atomically: the information is written completely or not at all. If the content asset is locked, the server returns a 409 (ResourceLockedException) fault. Updates a content asset. In the request, the If-Match header is required. The value of the header is an 'ETag' representing the last known base-point information for the content asset. If the header is missing, the server returns a 409 (IfMatchRequiredException) fault. If the header value does not match the server's 'ETag', the server returns a 412 (InvalidIfMatchException) fault. The delta information for the library folder containing the content asset is updated atomically: the information is written completely or not at all. If the content asset is locked, the server returns a 409 (ResourceLockedException) fault.
Header Parameter Removed Data

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

PUT /libraries/{library_id}/folder_assignments/{content_id}/{folder_id}

Element Change API 16.2 20.8
Path Parameter Changed Data

Name: library_id

Description: ID of the shared library or the site-id in case of a private library.

Name: library_id

Description: the ID of the shared library or the site-id in case of a private library
Path Parameter Changed Data

Name: content_id

Description: the ID of the content asset to retrieve.

Name: content_id

Description: the content id
Path Parameter Changed Data

Name: folder_id

Description: ID of a target folder.

Name: folder_id

Description: the folder id

PATCH /libraries/{library_id}/folders/{folder_id}

Element Change API 16.2 20.8
Header Parameter Removed Data

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

POST /order_search

Element Change API 16.2 20.8
Description Changed Shop Searches for orders performing full text search.

The search is configured by providing a search phrase and search fields (optional). If search fields are not provided, the default ones are used (order_no). The search retrieves orders having each one word of the search phrase in any of the search fields.

Additionally the retrieved orders could be limited by "query" and "query_args" parameters.

Note that full text order search always uses Search Service and the following limitations exist:
  • wildcards are not supported, they will be filtered from the query (*, %, +) and replaces by spaces
  • LIKE and ILIKE queries will be executed as fulltext queries (working on whole words), not as substring searches
  • LIKE queries will always be case insensitive
  • using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined
  • using logical operators may result in degraded performance, depending on how they are combined
  • the search will return only the first 1000 hits from the search result
The supported search fields are:
  • affiliate_partner_i_d
  • affiliate_partner_name
  • business_type
  • channel_type
  • confirmation_status
  • created_by
  • creation_date
  • currency_code
  • customer_email
  • customer_name
  • customer_no
  • export_after
  • export_status
  • external_order_no
  • external_order_status
  • last_modified
  • order_no
  • original_order_no
  • payment_status
  • replaced_order_no
  • replacement_order_no
  • shipping_status
  • status
  • total_gross_price
  • total_net_price
  • coupon_line_items.coupon_code
  • coupon_line_items.coupon_id
  • order.has_holds
  • holds.type
  • invoices.status
  • order_items.status
  • payment_instruments.credit_card_type
  • payment_instruments.payment_method_id
  • product_items.productid
  • return_cases.return_case_number
  • shipments.shipping_method_id
  • shipping_orders.shipping_order_number
The sort order of the retrieved orders could be specified by the "sort_fields" parameter. It is a list of objects presenting field name (mandatory) and sort direction ("asc" or "desc").

Custom attributes could be used as "search_fields" and as "sort_fields" too. A prefix "c_" has to be added to them.		 Searches for orders.

The query attribute specifies a complex query that can be used to narrow down the search.

Note that search fields are mandatory now and no default ones are supported.

As the old order search version, the new one always uses Search Service too and the for that reason Order Incremental Indexing should be enabled. Otherwise HTTP 500 response will occur.

The supported search fields are:
  • affiliate_partner_i_d
  • affiliate_partner_name
  • business_type
  • channel_type
  • confirmation_status (String)
  • created_by
  • creation_date
  • currency_code
  • customer_email
  • customer_name
  • customer_no
  • export_after
  • export_status (String)
  • external_order_no
  • external_order_status
  • global_party_id
  • last_modified
  • order_no
  • original_order_no
  • payment_status (String)
  • replaced_order_no
  • replacement_order_no
  • shipping_status (String)
  • status (String)
  • total_gross_price
  • total_net_price
  • order.has_holds
  • coupon_line_items.coupon_code
  • coupon_line_items.coupon_id
  • holds.type
  • invoices.status
  • order_items.status
  • payment_instruments.credit_card_type
  • payment_instruments.payment_method_id
  • product_items.product_id
  • return_cases.return_case_number
  • shipments.shipping_method_id
  • shipping_orders.shipping_order_number
The sort order of the retrieved orders could be specified by the "sorts" parameter. It is a list of objects presenting field name and sort direction ("asc" or "desc").

Custom attributes could be used as search fields and as sort fields too. A prefix "c_" has to be added to them.
Fault Removed Shop

OrderSearchIndexingDisabledException(400): Thrown when Incremental Indexing is not enabled for Order search schema.

 N/A

POST /orders

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: The ETag header value contained in the server response.

Constraints:

N/A

POST /orders/{order_no}/payment_instruments

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A
Query Parameter Added Shop N/A

Name: skip_authorization

Type: Boolean

Description:

Constraints:

DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A
Fault Added Shop N/A

PaymentInstrumentNotFoundException(404): Indicates that the payment instrument with the given payment instrument number is unknown.

paymentInstrumentId (String)

PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id}

Element Change API 16.2 20.8
Header Parameter Removed Shop

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A
Query Parameter Added Shop N/A

Name: skip_authorization

Type: Boolean

Description:

Constraints:

GET /product_lists

Element Change API 16.2 20.8
Secure Flag Changed Shop false true
Description Changed Shop Retrieves a list of all product lists as defined by the given search term (hence email, firstname, lastname). If no search term is given all owned product lists will be retrieved. Retrieves all public product lists as defined by the given search term (email, first name, last name).
Authentication Added Shop N/A None: No authentication.
Response Changed Shop ProductListResult PublicProductListResult
Query Parameter Changed Shop

Name: email

Description: email address of the customer, the product lists belong to

Name: email

Description: The email address of the customer, the product lists belong to.
Query Parameter Changed Shop

Name: firstname

Description: first name of the customer, the product lists belong to

Name: firstname

Description: The first name of the customer, the product lists belong to.
Query Parameter Changed Shop

Name: lastname

Description: last name of the customer, the product lists belong to

Name: lastname

Description: The last name of the customer, the product lists belong to.
Fault Removed Shop

CustomerNotAuthenticatedException(401): Indicates that the customer is not authenticated and must be logged in.

 N/A
Fault Changed Shop

ProductListSearchTermException(400): Indicates that the anonymous customer did not provide a proper search term.

ProductListSearchTermException(400): Indicates that the anonymous customer did not provide a proper search term.

GET /product_lists/{list_id}

Element Change API 16.2 20.8
Secure Flag Changed Shop false true
Description Changed Shop Retrieves a product list by id. Retrieves a public product list by id.
Authentication Added Shop N/A None: No authentication.
Response Changed Shop ProductList PublicProductList
Path Parameter Changed Shop

Name: list_id

Description: id of the list

Name: list_id

Description: The id of the list.
Query Parameter Added Shop N/A

Name: expand

Type: [String]

Description: The possible expansions - items, product, images, availability. The product information is included in the product list items that is why the product expansion has to be done together with items expansion. For images and availability both product and items have to be expanded as well.

Constraints:

Fault Removed Shop

CustomerNotAuthenticatedException(401): Indicates that the customer is not authenticated and must be logged in.

 N/A
Fault Removed Shop

CustomerNotAuthorizedException(403): Indicates that the authenticated customer is not the owner of the list

 N/A
Fault Changed Shop

ProductListNotFoundException(404): Indicates that this list doesn't exist

productListId (String)

ProductListNotFoundException(404): Indicates that this list doesn't exist.

productListId (String)

GET /product_lists/{list_id}/items

Element Change API 16.2 20.8
Secure Flag Changed Shop false true
Description Changed Shop Retrieves a product list's items. Retrieves the items of a public product list.
Authentication Added Shop N/A None: No authentication.
Response Changed Shop ProductListItemResult PublicProductListItemResult
Path Parameter Changed Shop

Name: list_id

Description: id of the list

Name: list_id

Description: The id of the list.
Query Parameter Added Shop N/A

Name: expand

Type: [String]

Description: The possible expansions - product, images, availability. For images and availability the product has to be expanded as well.

Constraints:

Fault Removed Shop

CustomerNotAuthenticatedException(401): Indicates that the customer is not authenticated and must be logged in.

 N/A
Fault Removed Shop

CustomerNotAuthorizedException(403): Indicates that the authenticated customer is not the owner of the list

 N/A
Fault Changed Shop

ProductListNotFoundException(404): Indicates that this list doesn't exist

productListId (String)

ProductListNotFoundException(404): Indicates that this list doesn't exist.

productListId (String)

GET /product_search

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
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.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /product_search/images

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /product_search/prices

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /product_search/variations

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

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

Element Change API 16.2 20.8
Description Changed Shop Allows to access multiple products by a single request. This convenience resource should be used instead making separated requests. This saves bandwidth and CPU time on the server. The URI is the same like requesting a single Product by id, but multiple ids wrapped by parentheses and separated can be provided. If a parenthesis or the separator is part of the identifier itself it has to be URL encoded. Instead of a single Product document a result object of Product documents is returned. Note: Only products that are online and assigned to site catalog are returned. The maximum number of ids is 50. Allows to access multiple products by a single request. This convenience resource should be used instead making separated requests. This saves bandwidth and CPU time on the server. The URI is the same like requesting a single Product by id, but multiple ids wrapped by parentheses and separated can be provided. If a parenthesis or the separator is part of the identifier itself it has to be URL encoded. Instead of a single Product document a result object of Product documents is returned. Note: Only products that are online and assigned to site catalog are returned. The maximum number of ids is 24. If none of the products requested are found, the cache-control header will be defaulted to 60 seconds.
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
Path Parameter Changed Shop

Name: ids

Constraints: maxItems=50, maxLength=100

Name: ids

Constraints: maxItems=24, maxLength=100
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.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
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.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/bundled_products

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/images

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/links

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/options

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/prices

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/promotions

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/recommendations

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/set_products

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/variations

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /promotions

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

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

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /promotions/{id}

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /search_suggestion

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /site

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

PATCH /sites/{site_id}/custom_objects/{object_type}/{key}

Element Change API 16.2 20.8
Header Parameter Removed Data

Name: If-Match

Type: String

Description: the ETag header value contained in the server response

Constraints:

N/A

PATCH /sites/{site_id}/slots/{slot_id}/slot_configurations/{configuration_id}

Element Change API 16.2 20.8
Header Parameter Removed Data

Name: If-Match

Type: String

Description: The ETag header value contained in the server response.

Constraints:

N/A

PATCH /sites/{site_id}/stores/{id}

Element Change API 16.2 20.8
Header Parameter Removed Data

Name: If-Match

Type: String

Description:

Constraints:

N/A

GET /stores

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

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

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /stores/{id}

Element Change API 16.2 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

Details about modified documents

The following documents have been modified since 16.2.

Basket

Element Change API 16.2 20.8
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: channel_type

Type: Enum {storefront, callcenter, marketplace, dss, store, pinterest, twitter, facebookads, subscriptions, onlinereservation, customerservicecenter, instagramcommerce}

Description: The sales channel for the order.

This is a read-only attribute that can't be modified by an OCAPI call. For OCAPI, the sales channel is determined based on the client ID and token used for the OCAPI call. Usually, a customer-based authentication sets the channel to Storefront, and an agent-based authentication sets it to CallCenter. Using applications that use other client IDs for OCAPI calls, like Customer Service Center, will set different channel types. To modify the channel type in OCAPI, use a hook. *

Constraints:

Property Added Shop N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Shop N/A

Name: inventory_reservation_expiry

Type: Date

Description:

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:

Campaign

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

Category

Element Change API 16.2 20.8
Property Added Shop N/A

Name: parent_category_tree

Type: [PathRecord]

Description: List of parent categories

Constraints:

ContentAsset

Element Change API 16.2 20.8
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.2 20.8
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:

ContentFolderAssignment

Element Change API 16.2 20.8
Property Added Data N/A

Name: position

Type: Decimal

Description: The position of the content asset in the folder.

Constraints: minNumberValue=0.0

Coupon

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

CustomObject

Element Change API 16.2 20.8
Description Changed Data Document representing a custom object that contains all defined custom attributes for its object type. Document representing a custom object that contains all defined custom attributes for its object type.Document representing a custom object that contains all defined custom attributes for its object type.
Property Changed Data

Name: key_value_integer

Type: Integer

Description: The id of the custom object when the type of the key is Integer. This is ignored in input documents.

Name: key_property

Type: String

Description: The name of the key property for the custom object. This is ignored in input documents.
Property Changed Data

Name: key_value_string

Type: String

Description: The id of the custom object when the type of the key is String. This is ignored in input documents.

Name: key_value_integer

Type: Integer

Description: The id of the custom object when the type of the key is Integer. This is ignored in input documents.
Property Changed Data

Name: object_type

Type: String

Description: The id of the object type. This is ignored in input documents.

Name: key_value_integer

Type: Integer

Description: The id of the custom object when the type of the key is Integer. This is ignored in input documents.

Customer

Element Change API 16.2 20.8
Property Added Data N/A

Name: global_party_id

Type: String

Description: The Global Party ID is set by Customer 360 and identifies a person across multiple systems.

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: 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.2 20.8
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.2 20.8
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.2 20.8
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:

CustomerPaymentCardRequest

Element Change API 16.2 20.8
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.2 20.8
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:

CustomerSearchHit

Element Change API 16.2 20.8
Property Added Data N/A

Name: primary_address

Type: CustomerAddress

Description: The primary address for the customer.

Constraints:

CustomerSearchRequest

Element Change API 16.2 20.8
Property Added Data N/A

Name: expand

Type: [String]

Description: The list of expands set for the search request. Expands are optional.

Constraints:

CustomerSearchResult

Element Change API 16.2 20.8
Property Added Data N/A

Name: expand

Type: [String]

Description: The list of expands set. Can be empty.

Constraints:

GiftCertificate

Element Change API 16.2 20.8
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.2 20.8
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:

Master

Element Change API 16.2 20.8
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The minimum sales price per unit of the related variants.

Constraints:

Property Added Shop N/A

Name: price_per_unit_max

Type: Decimal

Description: The maximum sales price per unit of the related variants.

Constraints:

Note

Element Change API 16.2 20.8
Property Added Shop N/A

Name: id

Type: String

Description: The ID of the note.

Constraints:

OptionItem

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

Property Added Shop N/A

Name: product_list_item

Type: ProductListItemReference

Description:

Constraints:

Order

Element Change API 16.2 20.8
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: customer_name

Type: String

Description: The name of the customer associated with this order.

Constraints:

Property Added Shop N/A

Name: global_party_id

Type: String

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

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

Type: String

Description: The site where the order resides.

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.2 20.8
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.2 20.8
Property Added Shop N/A

Name: authorization_status

Type: Status

Description: The authorization status of the payment transaction.

Constraints:

Property Removed Shop

Name: etag

Type: String

Description: The etag to show the last update status.

Constraints:

N/A

OrderSearchHit

Element Change API 16.2 20.8
Property Changed Shop

Name: relevance

Type: double

Name: relevance

Type: Double

OrderSearchRequest

Element Change API 16.2 20.8
Description Changed Shop Document representing an order full text search request. Document representing an order search request.
Property Added Shop N/A

Name: db_start_record_

Type: Integer

Description: The zero-based index of the record that we want to start with, used to optimize special handling

Constraints: minIntegerValue=0
Property Added Shop N/A

Name: expand

Type: [String]

Description: List of expansions to be applied to each search results. Expands are optional

Constraints:

Property Added Shop N/A

Name: sorts

Type: [Sort]

Description: The list of sort clauses configured for the search request. Sort clauses are optional.

Constraints:

Property Removed Shop

Name: query_args

Type: [String]

Description: The query arguments.

Constraints:

N/A
Property Removed Shop

Name: search_fields

Type: [String]

Description: The search fields to be used in case of full text search. If the list is null or empty the default search fields will be used.

Constraints:

N/A
Property Removed Shop

Name: search_phrase

Type: String

Description: The search phrase.

Constraints:

N/A
Property Removed Shop

Name: sort_fields

Type: [SortField]

Description: The sort fields list.

Constraints:

N/A
Property Changed Shop

Name: count

Description: The requested count parameter value.

Name: count

Description: The number of returned documents
Property Changed Shop

Name: query

Type: String

Description: The requested query string which limits the results in addition to the search phrase.

Constraints:

Name: query

Type: Query {BoolQuery, FilteredQuery, MatchAllQuery, NestedQuery, TermQuery, TextQuery}

Description: The query to apply

Constraints: mandatory=true, nullable=false
Property Changed Shop

Name: select

Description: The select parameter used to configure the search result document. See "API Usage > Property selection" for more information how to define a property selector.

Name: select

Description: The field to be selected.
Property Changed Shop

Name: start

Description: The requested start parameter value.

Name: start

Description: The zero-based index of the first search hit to include in the result.

OrderSearchResult

Element Change API 16.2 20.8
Property Added Shop N/A

Name: db_start_record_

Type: Integer

Description: The zero-based index of the record that we want to start with, used to optimize special handling

Constraints: minIntegerValue=0
Property Added Shop N/A

Name: expand

Type: [String]

Description: List of expansions to be applied to each search results. Expands are optional

Constraints:

Property Added Shop N/A

Name: sorts

Type: [Sort]

Description: The list of sort clauses configured for the search request. Sort clauses are optional.

Constraints:

Property Removed Shop

Name: query_args

Type: [String]

Description: The query arguments.

Constraints:

N/A
Property Removed Shop

Name: sort_string

Type: String

Description: The sort string.

Constraints:

N/A
Property Changed