OCAPI 20.8 changes since 14.8

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

Resources added, modified, or removed since 14.8

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
Account Removed POST /account/login Shop N/A
Account Removed POST /account/logout Shop N/A
Account Removed POST /account/register Shop N/A
Account Removed GET /account/{id} Shop N/A
Account Removed PATCH /account/{id} Shop N/A
Account Removed GET /account/{id}/addresses Shop N/A
Account Removed DELETE /account/{id}/addresses/{address_name} Shop N/A
Account Removed GET /account/{id}/addresses/{address_name} Shop N/A
Account Removed PATCH /account/{id}/addresses/{address_name} Shop N/A
Account Removed PUT /account/{id}/addresses/{address_name} Shop 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
Basket Removed GET /basket/{id} Shop N/A
Basket Removed PATCH /basket/{id} Shop N/A
Basket Removed POST /basket/{id}/add Shop N/A
Basket Removed GET /basket/{id}/checkout Shop N/A
Basket Removed POST /basket/{id}/checkout/payment_instruments Shop N/A
Basket Removed DELETE /basket/{id}/checkout/payment_instruments/{uuid} Shop N/A
Basket Removed PATCH /basket/{id}/checkout/payment_instruments/{uuid} Shop N/A
Basket Removed GET /basket/{id}/checkout/payment_methods Shop N/A
Basket Removed POST /basket/{id}/checkout/set_billing_address Shop N/A
Basket Removed POST /basket/{id}/checkout/set_customer_info Shop N/A
Basket Removed POST /basket/{id}/checkout/set_shipping_address Shop N/A
Basket Removed POST /basket/{id}/checkout/set_shipping_method Shop N/A
Basket Removed GET /basket/{id}/checkout/shipping_methods Shop N/A
Basket Removed POST /basket/{id}/checkout/submit Shop N/A
Baskets Added POST /baskets Shop N/A
Baskets Added POST /baskets/reference Shop N/A
Baskets Added DELETE /baskets/{basket_id} Shop N/A
Baskets Added GET /baskets/{basket_id} Shop N/A
Baskets Added PATCH /baskets/{basket_id} 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 PUT /baskets/{basket_id}/billing_address Shop N/A
Baskets Added POST /baskets/{basket_id}/coupons Shop N/A
Baskets Added DELETE /baskets/{basket_id}/coupons/{coupon_item_id} Shop N/A
Baskets Added PUT /baskets/{basket_id}/customer Shop N/A
Baskets Added POST /baskets/{basket_id}/gift_certificate_items 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 POST /baskets/{basket_id}/items Shop N/A
Baskets Added DELETE /baskets/{basket_id}/items/{item_id} Shop N/A
Baskets Added PATCH /baskets/{basket_id}/items/{item_id} Shop N/A
Baskets Added GET /baskets/{basket_id}/notes Shop N/A
Baskets Added POST /baskets/{basket_id}/notes Shop N/A
Baskets Added DELETE /baskets/{basket_id}/notes/{note_id} Shop N/A
Baskets Added POST /baskets/{basket_id}/payment_instruments Shop N/A
Baskets Added DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id} Shop N/A
Baskets Added PATCH /baskets/{basket_id}/payment_instruments/{payment_instrument_id} Shop N/A
Baskets Added GET /baskets/{basket_id}/payment_methods Shop N/A
Baskets Added POST /baskets/{basket_id}/price_adjustments Shop N/A
Baskets Added DELETE /baskets/{basket_id}/price_adjustments/{price_adjustment_id} Shop N/A
Baskets Added PATCH /baskets/{basket_id}/price_adjustments/{price_adjustment_id} Shop N/A
Baskets Added POST /baskets/{basket_id}/shipments Shop N/A
Baskets Added DELETE /baskets/{basket_id}/shipments/{shipment_id} Shop N/A
Baskets Added PATCH /baskets/{basket_id}/shipments/{shipment_id} Shop N/A
Baskets Added PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_address Shop N/A
Baskets Added PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_method Shop N/A
Baskets Added GET /baskets/{basket_id}/shipments/{shipment_id}/shipping_methods Shop N/A
Baskets Added PUT /baskets/{basket_id}/storefront Shop N/A
CampaignSearch Added POST /sites/{site_id}/campaign_search Data N/A
Campaigns Added DELETE /sites/{site_id}/campaigns/{campaign_id} Data N/A
Campaigns Added GET /sites/{site_id}/campaigns/{campaign_id} Data N/A
Campaigns Added PATCH /sites/{site_id}/campaigns/{campaign_id} Data N/A
Campaigns Added PUT /sites/{site_id}/campaigns/{campaign_id} Data N/A
Campaigns Added DELETE /sites/{site_id}/campaigns/{campaign_id}/coupons/{coupon_id} Data N/A
Campaigns Added PUT /sites/{site_id}/campaigns/{campaign_id}/coupons/{coupon_id} Data N/A
Campaigns Added DELETE /sites/{site_id}/campaigns/{campaign_id}/customer_groups/{customer_group_id} Data N/A
Campaigns Added PUT /sites/{site_id}/campaigns/{campaign_id}/customer_groups/{customer_group_id} Data N/A
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 Added DELETE /sites/{site_id}/campaigns/{campaign_id}/source_code_groups/{source_code_group_id} Data N/A
Campaigns Added PUT /sites/{site_id}/campaigns/{campaign_id}/source_code_groups/{source_code_group_id} Data N/A
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
CouponSearch Added POST /sites/{site_id}/coupon_search Data N/A
Coupons Added GET /sites/{site_id}/coupons Data N/A
Coupons Added DELETE /sites/{site_id}/coupons/{coupon_id} Data N/A
Coupons Added GET /sites/{site_id}/coupons/{coupon_id} Data N/A
Coupons Added PATCH /sites/{site_id}/coupons/{coupon_id} Data N/A
Coupons Added PUT /sites/{site_id}/coupons/{coupon_id} 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
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 Added DELETE /custom_objects/{object_type}/{key} Data N/A
CustomObjects Added GET /custom_objects/{object_type}/{key} Data N/A
CustomObjects Added PATCH /custom_objects/{object_type}/{key} Data N/A
CustomObjects Added PUT /custom_objects/{object_type}/{key} Data N/A
CustomObjects Added GET /custom_objects/{object_type}/{key} Shop N/A
CustomObjectsSearch Added POST /custom_objects_search/{object_type} Data N/A
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 GET /customer_lists/{list_id} Data N/A
CustomerLists Added POST /customer_lists/{list_id}/customers Data N/A
CustomerLists Added DELETE /customer_lists/{list_id}/customers/{customer_no} Data N/A
CustomerLists Added GET /customer_lists/{list_id}/customers/{customer_no} Data N/A
CustomerLists Added PATCH /customer_lists/{list_id}/customers/{customer_no} Data N/A
CustomerLists Added PUT /customer_lists/{list_id}/customers/{customer_no} Data N/A
CustomerLists Added GET /customer_lists/{list_id}/customers/{customer_no}/addresses Data N/A
CustomerLists Added POST /customer_lists/{list_id}/customers/{customer_no}/addresses Data N/A
CustomerLists Added DELETE /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id} Data N/A
CustomerLists Added GET /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id} Data N/A
CustomerLists Added PATCH /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id} Data N/A
CustomerSearch Removed POST /customer_search Data N/A
Customers Removed POST /customers Data N/A
Customers Removed DELETE /customers/{customer_no} Data N/A
Customers Removed GET /customers/{customer_no} Data N/A
Customers Removed PATCH /customers/{customer_no} Data N/A
Customers Removed GET /customers/{customer_no}/addresses Data N/A
Customers Removed POST /customers/{customer_no}/addresses Data N/A
Customers Removed DELETE /customers/{customer_no}/addresses/{address_id} Data N/A
Customers Removed GET /customers/{customer_no}/addresses/{address_id} Data N/A
Customers Removed PATCH /customers/{customer_no}/addresses/{address_id} Data N/A
Customers Added POST /customers Shop N/A
Customers Added DELETE /customers/auth Shop N/A
Customers Added POST /customers/auth Shop N/A
Customers Added POST /customers/auth/trustedsystem Shop N/A
Customers Added POST /customers/password_reset Shop N/A
Customers Added GET /customers/{customer_id} Shop N/A
Customers Added PATCH /customers/{customer_id} Shop N/A
Customers Added GET /customers/{customer_id}/addresses Shop N/A
Customers Added POST /customers/{customer_id}/addresses Shop N/A
Customers Added DELETE /customers/{customer_id}/addresses/{address_name} Shop N/A
Customers Added GET /customers/{customer_id}/addresses/{address_name} Shop N/A
Customers Added PATCH /customers/{customer_id}/addresses/{address_name} Shop N/A
Customers Added POST /customers/{customer_id}/auth Shop N/A
Customers Added GET /customers/{customer_id}/baskets Shop N/A
Customers Added GET /customers/{customer_id}/orders Shop N/A
Customers Added PUT /customers/{customer_id}/password Shop N/A
Customers Added POST /customers/{customer_id}/password_reset Shop N/A
Customers Added GET /customers/{customer_id}/payment_instruments Shop N/A
Customers Added POST /customers/{customer_id}/payment_instruments Shop N/A
Customers Added DELETE /customers/{customer_id}/payment_instruments/{payment_instrument_id} Shop N/A
Customers Added GET /customers/{customer_id}/payment_instruments/{payment_instrument_id} 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
Folders Changed GET /folders/({id},...,{id}) Shop More
Folders Changed GET /folders/{id} Shop More
GiftCertificate Added POST /gift_certificate Shop N/A
GiftCertificateSearch Added POST /sites/{site_id}/gift_certificate_search Data N/A
GiftCertificates Added GET /sites/{site_id}/gift_certificates Data N/A
GiftCertificates Added POST /sites/{site_id}/gift_certificates Data N/A
GiftCertificates Added DELETE /sites/{site_id}/gift_certificates/{merchant_id} Data N/A
GiftCertificates Added GET /sites/{site_id}/gift_certificates/{merchant_id} Data N/A
GiftCertificates Added PATCH /sites/{site_id}/gift_certificates/{merchant_id} Data N/A
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
InventoryListSearch Added POST /inventory_list_search Data N/A
InventoryLists Added GET /inventory_lists Data N/A
InventoryLists Added DELETE /inventory_lists/{id} Data N/A
InventoryLists Added GET /inventory_lists/{id} Data N/A
InventoryLists Added PATCH /inventory_lists/{id} Data N/A
InventoryLists Added PUT /inventory_lists/{id} Data N/A
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 Added POST /order_search Shop N/A
Orders Added POST /orders Shop N/A
Orders Added PATCH /orders/{order_no} Shop N/A
Orders Added PUT /orders/{order_no} Shop N/A
Orders Added GET /orders/{order_no}/notes Shop N/A
Orders Added POST /orders/{order_no}/notes Shop N/A
Orders Added DELETE /orders/{order_no}/notes/{note_id} Shop N/A
Orders Added POST /orders/{order_no}/payment_instruments Shop N/A
Orders Added DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id} Shop N/A
Orders Added PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id} Shop N/A
Orders Added GET /orders/{order_no}/payment_methods Shop N/A
Orders Removed GET /orders Shop N/A
Orders Removed POST /orders/{order_no}/payment_authorize Shop N/A
Orders Changed GET /orders/{order_no} 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 Shop N/A
ProductLists Added GET /product_lists/{list_id} Shop N/A
ProductLists Added GET /product_lists/{list_id}/items Shop N/A
ProductLists Added GET /product_lists/{list_id}/items/{item_id} Shop N/A
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}/recommendations Shop 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}/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 Added GET /search_suggestion Shop N/A
Sessions Added POST /sessions Shop N/A
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} 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 DELETE /sites/{site_id}/custom_objects/{object_type}/{key} Data N/A
Sites Added GET /sites/{site_id}/custom_objects/{object_type}/{key} Data N/A
Sites Added PATCH /sites/{site_id}/custom_objects/{object_type}/{key} Data N/A
Sites Added PUT /sites/{site_id}/custom_objects/{object_type}/{key} 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
SlotConfigurationCampaignAssignmentSearch Added POST /sites/{site_id}/slot_configuration_campaign_assignment_search Data N/A
SlotConfigurationSearch Added POST /sites/{site_id}/slot_configuration_search Data N/A
SlotConfigurations Added DELETE /sites/{site_id}/slots/{slot_id}/slot_configurations/{configuration_id} Data N/A
SlotConfigurations Added GET /sites/{site_id}/slots/{slot_id}/slot_configurations/{configuration_id} Data N/A
SlotConfigurations Added PATCH /sites/{site_id}/slots/{slot_id}/slot_configurations/{configuration_id} Data N/A
SlotConfigurations Added PUT /sites/{site_id}/slots/{slot_id}/slot_configurations/{configuration_id} Data N/A
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
StoreSearch Added POST /sites/{site_id}/store_search Data N/A
Stores Added GET /sites/{site_id}/stores Data N/A
Stores Added DELETE /sites/{site_id}/stores/{id} Data N/A
Stores Added GET /sites/{site_id}/stores/{id} Data N/A
Stores Added PATCH /sites/{site_id}/stores/{id} Data N/A
Stores Added PUT /sites/{site_id}/stores/{id} Data N/A
Stores Changed GET /stores Shop More
Stores Changed GET /stores/({id},...,{id}) Shop More
Stores Changed GET /stores/{id} Shop More
SystemObjectDefinitionSearch Added POST /system_object_definition_search Data N/A
SystemObjectDefinitions Added GET /system_object_definitions Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type} Data N/A
SystemObjectDefinitions Added POST /system_object_definitions/{object_type}/attribute_definition_search Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_definitions Data N/A
SystemObjectDefinitions Added DELETE /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added PATCH /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added PUT /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added POST /system_object_definitions/{object_type}/attribute_group_search Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_groups Data N/A
SystemObjectDefinitions Added DELETE /system_object_definitions/{object_type}/attribute_groups/{group_id}/attribute_definitions/{def_id} Data N/A
SystemObjectDefinitions Added PUT /system_object_definitions/{object_type}/attribute_groups/{group_id}/attribute_definitions/{def_id} Data N/A
SystemObjectDefinitions Added DELETE /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
SystemObjectDefinitions Added PATCH /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
SystemObjectDefinitions Added PUT /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
UserSearch Added POST /user_search Data N/A
Users Added GET /users Data N/A
Users Added GET /users/this Data N/A
Users Added PATCH /users/this/password Data N/A
Users Added DELETE /users/{login} Data N/A
Users Added GET /users/{login} Data N/A
Users Added PATCH /users/{login} Data N/A
Users Added PUT /users/{login} Data N/A
VariantSearch Added POST /products/{id}/variant_search Data N/A

Documents added, modified, or removed since 14.8

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
AccountTransaction Added Data 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
AuthRequest Added Shop API N/A
BMPermissions Added Data API N/A
Basket Added Shop API N/A
Basket Removed Shop API N/A
BasketCreateRequest Added Shop API N/A
BasketPaymentInstrumentRequest Added Shop API N/A
BasketReference Added Shop API N/A
BasketsResult Added Shop API N/A
BonusDiscountLineItem Added Shop API N/A
BoolFilter Added Data API N/A
BoolQuery Added Data API N/A
BundledProductItem Added Shop API N/A
BundledProductItem Removed Shop API N/A
CSCPermissions Added Data API N/A
Campaign Added Data API N/A
CampaignPromotionExperience Added Data API N/A
CampaignSearchResult 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 Added Data API N/A
CouponCode Added Data API N/A
CouponCodes Added Data API N/A
CouponItem Changed Shop API More
CouponMultiCodesRequest Added Data API N/A
CouponRedemption Added Data API N/A
CouponRedemptionSearchResult Added Data API N/A
CouponSearchResult Added Data API N/A
CouponSystemCodeConfig Added Data API N/A
Coupons Added Data API N/A
Credentials Removed Shop API N/A
CustomLogSettings Added Data API N/A
CustomObject Added Data API N/A
CustomObject Added Data API N/A
CustomObject Added Shop API N/A
CustomObjectSearchResult Added Data API N/A
Customer Changed Data API More
Customer Added Shop API N/A
CustomerAddress Changed Data API More
CustomerAddress Changed Shop API More
CustomerAddressLink Added Shop API N/A
CustomerAddressResult Changed Shop API More
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
CustomerInfo Removed Shop API N/A
CustomerInfo Added Shop API N/A
CustomerList Added Data API N/A
CustomerListLink Added Data API N/A
CustomerOrderResult Added Shop API N/A
CustomerPaymentCardRequest Added Shop API N/A
CustomerPaymentInstrument Added Shop API N/A
CustomerPaymentInstrumentRequest Added Shop API N/A
CustomerPaymentInstrumentResult Added Shop API N/A
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
CustomerRegistration 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
Discount Added Shop API N/A
DiscountRequest Added Shop 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
Fault Changed Data API More
Fault Changed Shop API More
Filter Added Data API N/A
FilteredQuery Added Data API N/A
FunctionalPermission Added Data API N/A
FunctionalPermissions Added Data API N/A
GiftCertificate Added Data API N/A
GiftCertificate Added Shop API N/A
GiftCertificateItem Added Shop API N/A
GiftCertificateRequest Added Shop API N/A
GiftCertificateSearchResult Added Data API N/A
GiftCertificates Added Data API N/A
Image Changed Shop API More
ImageGroup Added Data API N/A
ImageGroup Changed Shop API More
InventoryList Added Data API N/A
InventoryListSearchResult Added Data API N/A
InventoryLists Added Data API N/A
ItemKey Added Shop 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
MatchAllQuery Added Data API N/A
MediaFile Added Data API N/A
MenuAction Added Data API N/A
MenuItem Added Data API N/A
ModulePermissions Added Data API N/A
Money Added Data API N/A
NestedQuery Added Data API N/A
Note Added Shop API N/A
NotesResult Added Shop API N/A
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 Added Shop API N/A
OptionItem Removed Shop API N/A
Order Removed Shop API N/A
Order Added Shop API N/A
OrderConfirmationStatusUpdateRequest Added Data API N/A
OrderExportStatusUpdateRequest Added Data API N/A
OrderExternalStatusUpdateRequest Added Data API N/A
OrderPaymentCardRequest Added Shop API N/A
OrderPaymentInstrument Removed Shop API N/A
OrderPaymentInstrument Added Shop API N/A
OrderPaymentInstrumentRequest Added Shop API N/A
OrderPaymentInstrumentRequest Removed Shop API N/A
OrderPaymentStatusUpdateRequest Added Data API N/A
OrderResult Removed Shop API N/A
OrderSearchHit Added Shop API N/A
OrderSearchRequest Added Shop API N/A
OrderSearchResult Added Shop API N/A
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
PasswordChangeRequest Added Shop API N/A
PasswordReset Added Shop API N/A
PathRecord Added Data API N/A
PathRecord Added Shop API N/A
PaymentBankAccount Removed Shop API N/A
PaymentBankAccount Added Shop API N/A
PaymentBankAccountRequest Added Shop API N/A
PaymentBankAccountRequest Removed Shop API N/A
PaymentCard Removed Shop API N/A
PaymentCard Added Shop API N/A
PaymentCardSpec Added Shop API N/A
PaymentInstrumentUpdateRequest Added Data API N/A
PaymentMethod Added Shop API N/A
PaymentMethod Removed Shop API N/A
PaymentMethodResult Added Shop API N/A
PaymentMethodResult Removed Shop API N/A
PaymentTransactionUpdateRequest Added Data API N/A
PreferenceValue Added Data API N/A
PreferenceValueSearchResult Added Data API N/A
PriceAdjustment Removed Shop API N/A
PriceAdjustment Added Shop API N/A
PriceAdjustmentLimit Added Shop API N/A
PriceAdjustmentLimits Added Shop API N/A
PriceAdjustmentRequest Added Shop API N/A
Product Added Data API N/A
Product Changed Shop API More
ProductDetailsLink Added Shop API N/A
ProductInventoryRecord Added Data API N/A
ProductInventoryRecordAllocation Added Data API N/A
ProductInventoryRecords Added Data API N/A
ProductItem Added Shop API N/A
ProductItem Removed Shop API N/A
ProductListEvent Added Shop API N/A
ProductListItem Added Shop API N/A
ProductListItemReference Added Shop API N/A
ProductListLink Added Shop API N/A
ProductListRegistrant Added 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
ProductType Changed Shop API More
Profile Removed Shop API N/A
Promotion Added Data API N/A
Promotion Changed Shop API More
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
Query Added Data API N/A
QueryFilter Added Data API N/A
Range2Filter Added Data API N/A
RangeFilter Added Data API N/A
Recommendation Added Shop API N/A
RecommendationType Added Shop API N/A
Recommender Added Data API N/A
RecommendersResult Added Data API N/A
Recurrence Added Data API N/A
RedemptionLimitPerPeriod Added Data API N/A
RedemptionLimits Added Data API N/A
Registration Removed Shop API N/A
ResourceInfo Added Data API N/A
ResourceObject Added Data API N/A
ResultPage 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
Schedule Added Data API N/A
SearchIndexUpdateConfiguration Added Data API N/A
SearchRequest Added Data API N/A
SearchRequest Added Data API N/A
SearchResult Added Data API N/A
SearchResult Added Data API N/A
Shipment Added Shop API N/A
Shipment Removed Shop API N/A
ShippingAddressUpdateRequest Added Data API N/A
ShippingItem Added Shop API N/A
ShippingItem Removed Shop API N/A
ShippingMethod Added Shop API N/A
ShippingMethod Removed Shop API N/A
ShippingMethodResult Added Shop API N/A
ShippingMethodResult Removed Shop API N/A
ShippingPromotion Removed Shop API N/A
ShippingPromotion Added Shop API N/A
SimpleLink Added Shop API N/A
Site Added Data API N/A
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 Added Data API N/A
SlotConfigurationABTestGroupAssignment Added Data API N/A
SlotConfigurationAssignmentInformation Added Data API N/A
SlotConfigurationCampaignAssignment Added Data API N/A
SlotConfigurationCampaignAssignmentSearchResult Added Data API N/A
SlotConfigurationSearchResult Added Data API N/A
SlotConfigurations Added Data API N/A
SlotContent Added Data API N/A
SlotSearchResult Added Data API N/A
Slots Added Data API N/A
Sort Added Data API N/A
SortField Added Shop 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 Added Data API N/A
Store Changed Shop API More
StoreSearchResult Added Data API N/A
Stores Added Data API N/A
SuggestedCategory Added Shop API N/A
SuggestedContent Added Shop API N/A
SuggestedPhrase Added Shop API N/A
SuggestedProduct Added Shop API N/A
SuggestedTerm Added Shop API N/A
SuggestedTerms Added Shop API N/A
Suggestion Added Shop API N/A
SuggestionResult Added Shop API N/A
Tag Added Data API N/A
TermFilter Added Data API N/A
TermQuery Added Data API N/A
TextQuery Added Data API N/A
TimeOfDay 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 Added Shop API N/A
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 14.8.

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

Element Change API 14.8 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 14.8 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.
Fault Added Shop N/A

CategoryNotFoundException(404): Thrown if the server could not find an online category with the specified id.

categoryId (String)

siteId (String)
Fault Removed Shop

NotFoundException(404): Thrown if the server could not find an online category with the specified id.

 N/A

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

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

GET /content/{id}

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

GET /content_search

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

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

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

GET /folders/{id}

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

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

Element Change API 14.8 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 14.8 20.8
Body Changed Data None ContentFolderAssignment
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 14.8 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 /orders/{order_no}

Element Change API 14.8 20.8
Title Changed Shop Get order by ID Get order
Description Changed Shop Get a customer order identified by the specified order number. Gets information for an order.
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
Authentication Added Shop N/A OAuth: Authentication via OAuth token. A valid user is required.
Authentication Removed Shop None: No authentication. N/A
Response Changed Shop Order Order
Path Parameter Changed Shop

Name: order_no

Description: The order number to get the order for.

Name: order_no

Description: the order number
Fault Added Shop N/A

OrderNotFoundException(404): Indicates that the order with the given order number is unknown.

orderNumber (String)
Fault Removed Shop

NotFoundException(404): Thrown in case the order could not be found or didn't belong to the current customer.

 N/A

GET /product_search

Element Change API 14.8 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
Query Parameter Added Shop N/A

Name: currency

Type: String

Description: The currency mnemonic specified for price. This parameter is effective only if specified expand parameter value contains prices.

Constraints:

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)
Fault Removed Shop

ConstraintViolationException(400): Thrown if any request parameter value constraint is violated.

mp (MethodParameter)

o (Object)

reason (String)

 N/A

GET /product_search/availability

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

GET /product_search/images

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

GET /product_search/prices

Element Change API 14.8 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
Query Parameter Added Shop N/A

Name: currency

Type: String

Description: The currency mnemonic specified for price.

Constraints:

GET /product_search/variations

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

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

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

Type: String

Description: The currency mnemonic specified for price.

Constraints:

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 14.8 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
Query Parameter Added Shop N/A

Name: currency

Type: String

Description: The currency mnemonic specified for price.

Constraints:

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 14.8 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/bundled_products

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

GET /products/{id}/images

Element Change API 14.8 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
Query Parameter Added Shop N/A

Name: all_images

Type: Boolean

Description: If set to true, all images according to the requested product, view type and attribute value filter are returned. If set to false (or omitted), the best matching image for the requested product is returned. The attribute value filter is ignored in such case.

Constraints:

Query Parameter Added Shop N/A

Name: variation_attribute

Type: [String, String]

Description: the variation values context

Constraints: maxLength=256
Query Parameter Removed Shop

Name: variation_value

Type: String

Description: The variation value context.

Constraints: maxLength=256

 N/A
Query Parameter Changed Shop

Name: view_type

Type: String

Description: The view type.

Name: view_type

Type: [String]

Description: The view types.

GET /products/{id}/links

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

MalformedLinkTypeCodeParameterException(400): 400 indicates unknown product link type code

linkType (String)
Fault Added Shop N/A

MalformedLinkDirectionParameterException(400): 400 indicates unknown link direction

linkDirection (String)
Fault Added Shop N/A

ProductNotFoundException(404): 404 No product with given id found

productId (String)

siteId (String)
Fault Removed Shop

NotFoundException(404): 404 product with id not found

 N/A

GET /products/{id}/options

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

GET /products/{id}/prices

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

GET /products/{id}/promotions

Element Change API 14.8 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
Query Parameter Added Shop N/A

Name: currency

Type: String

Description: The currency mnemonic specified for price

Constraints:

Query Parameter Changed Shop

Name: locale

Description: The locale context.

Name: locale

Description: The locale context.The locale context.

GET /products/{id}/set_products

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

GET /products/{id}/variations

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

GET /promotions

Element Change API 14.8 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
Query Parameter Added Shop N/A

Name: currency

Type: String

Description: The currency mnemonic specified for price

Constraints:

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

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

GET /promotions/{id}

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

PromotionNotFoundException(404): Thrown when there is no promotion found with the given ID for the requested site

promotionId (String)

siteId (String)
Fault Removed Shop

NotFoundException(404): Thrown when there is no promotion existing with the given ID for the requested site

 N/A

GET /site

Element Change API 14.8 20.8
Authentication Added Shop N/A JWT: Authentication via Customer JWT.
Fault Removed Shop

NotFoundException(404): Thrown if the server could not find a site with the specified id.

 N/A

GET /stores

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

MissingCountryCodeException(400): Thrown if no coordinates (latitude and longitude) are provided and in addition no country code is given.
Fault Added Shop N/A

MissingPostalCodeException(400): Thrown if no coordinates (latitude and longitude) are provided and in addition no postal code is given..
Fault Added Shop N/A

MissingCoordinatesException(400): Thrown if only one of latitude or longitude are provided.
Fault Added Shop N/A

MalformedDistanceUnitException(400): Invalid distance_unit given.
Fault Removed Shop

ConstraintViolationException(400): Thrown if any request parameter value constraint is violated.

mp (MethodParameter)

o (Object)

reason (String)

 N/A

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

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

GET /stores/{id}

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

StoreNotFoundException(404): Thrown if the requested store was not found

storeId (String)

siteId (String)
Fault Removed Shop

NotFoundException(404): Thrown if the requested store was not found

 N/A

Details about modified documents

The following documents have been modified since 14.8.

Category

Element Change API 14.8 20.8
Property Added Shop N/A

Name: parent_category_tree

Type: [PathRecord]

Description: List of parent categories

Constraints:

ContentAsset

Element Change API 14.8 20.8
Property Added Data N/A

Name: classification_folder_id

Type: String

Description: The ID of the classification folder. It is only part of the response, if the assignment from this content asset to the folder is marked as 'default'. The property is read-only. To set the classification folder just create/update an assignment between this content asset and a folder and mark it as 'default'. See details in /libraries/{library_id}/folder_assignments/{content_id}/{folder_id} resource.

Constraints:

Property Added Data N/A

Name: classification_folder_link

Type: String

Description: The link to the classification folder. It is only part of the response, if the assignment from this content asset to the folder is marked as 'default'. The property is read-only. To set the classification folder just create/update an assignment between this content asset and a folder and mark it as 'default'. See details in /libraries/{library_id}/folder_assignments/{content_id}/{folder_id} resource.

Constraints:

Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

ContentFolder

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

Name: default

Type: Boolean

Description: A flag indicating whether the assignment is the default one.

Constraints:

Property Added Data N/A

Name: position

Type: Decimal

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

Constraints: minNumberValue=0.0

CouponItem

Element Change API 14.8 20.8
Property Added Shop N/A

Name: coupon_item_id

Type: String

Description: The coupon item id.

Constraints:

Customer

Element Change API 14.8 20.8
Property Added Data N/A

Name: customer_id

Type: String

Description: The customer's id. Both registered and guest customers have a customer id.

Constraints: maxLength=28
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'.

CustomerAddress

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

Property Removed Shop

Name: address_name

Type: String

Description: The name of the address as specified by account owner.

Constraints: maxLength=256

 N/A

CustomerAddressResult

Element Change API 14.8 20.8
Property Added Shop N/A

Name: next

Type: String

Description: The URL of the next result page.

Constraints:

Property Added Shop N/A

Name: previous

Type: String

Description: The URL of the previous result page.

Constraints:

Property Added Shop N/A

Name: select

Type: String

Description:

Constraints:

Property Added Shop N/A

Name: start

Type: Integer

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

Constraints: minIntegerValue=0

CustomerSearchHit

Element Change API 14.8 20.8
Property Added Data N/A

Name: customer_id

Type: String

Description: Gets the customer's id.

Constraints: maxLength=28
Property Added Data N/A

Name: primary_address

Type: CustomerAddress

Description: The primary address for the customer.

Constraints:

CustomerSearchRequest

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

Name: expand

Type: [String]

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

Constraints:

Fault

Element Change API 14.8 20.8
Property Added Data N/A

Name: arguments

Type: [String, Object]

Description: A map that provides fault arguments. Data can be used to provide error messages on the client side.

Constraints:

Property Removed Data

Name: details

Type: [String, Object]

Description: A map that provides detailed information in key/value pairs.

Constraints:

N/A

Fault

Element Change API 14.8 20.8
Property Added Shop N/A

Name: arguments

Type: [String, Object]

Description: A map that provides fault arguments. Data can be used to provide error messages on the client side.

Constraints:

Property Removed Shop

Name: details

Type: [String, Object]

Description: A map that provides detailed information in key/value pairs.

Constraints:

N/A

Image

Element Change API 14.8 20.8
Property Added Shop N/A

Name: dis_base_link

Type: String

Description: Base URL for dynamic image service address. This is only shown, if the image is stored on the server and DIS is enabled.

Constraints:

ImageGroup

Element Change API 14.8 20.8
Property Added Shop N/A

Name: variation_attributes

Type: [VariationAttribute]

Description: Returns a list of variation attributes applying to this image group.

Constraints:

Property Removed Shop

Name: variation_value

Type: String

Description: The image variation value.

Constraints:

N/A

Master

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

Product

Element Change API 14.8 20.8
Property Added Shop N/A

Name: min_order_quantity

Type: Decimal

Description: The minimum order quantity for this product.

Constraints:

Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price per unit of the product. In case of complex products like master or set this is the minimum price per unit of related child products.

Constraints:

Property Added Shop N/A

Name: price_per_unit_max

Type: Decimal

Description: The maximum sales price per unit of related child products in case of complex products like master or set.

Constraints:

Property Added Shop N/A

Name: recommendations

Type: [Recommendation]

Description: Returns a list of recommendations.

Constraints:

Property Added Shop N/A

Name: step_quantity

Type: Decimal

Description: The steps in which the order amount of the product can be increased.

Constraints:

Property Added Shop N/A

Name: unit_measure

Type: String

Description: The unitMeasure of the product.

Constraints:

Property Added Shop N/A

Name: unit_quantity

Type: Decimal

Description:

Constraints:

Property Added Shop N/A

Name: valid_from

Type: [DateTime]

Description: The time when product is valid from.

Constraints:

Property Added Shop N/A

Name: valid_to

Type: [DateTime]

Description: The time when product is valid to.

Constraints:

Property Added Shop N/A

Name: variation_groups

Type: [VariationGroup]

Description: The array of actual variation groups. This array can be empty. Only for types master, variation group and variant.

Constraints:

ProductSearchHit

Element Change API 14.8 20.8
Property Added Shop N/A

Name: hit_type

Type: String

Description: The type information for the search hit.

Constraints:

Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price per unit of the product. In case of complex products like master or set this is the minimum price per unit of related child products.

Constraints:

Property Added Shop N/A

Name: price_per_unit_max

Type: Decimal

Description: The maximum sales price per unit of related child products in case of complex products like master or set.

Constraints:

Property Added Shop N/A

Name: prices

Type: [String, Decimal]

Description: The prices map with price book ids and their values.

Constraints:

Property Added Shop N/A

Name: product_type

Type: ProductType

Description: The type information for the product.

Constraints:

Property Added Shop N/A

Name: represented_product

Type: ProductRef

Description: The first represented product.

Constraints:

Property Added Shop N/A

Name: represented_products

Type: [ProductRef]

Description: All the represented products.

Constraints:

ProductSearchResult

Element Change API 14.8 20.8
Property Added Shop N/A

Name: search_phrase_suggestions

Type: Suggestion

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

Constraints:

ProductType