OCAPI 20.10 changes since 16.6

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

Resources added, modified, or removed since 16.6

Resource Name Change Http Method URL Template API Details
AbTests Added DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/promotions/{promotion_id} Data N/A
AbTests Added PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/promotions/{promotion_id} Data N/A
AbTests Added DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/slot_configurations/{slot_id}/{slot_config_id} Data N/A
AbTests Added PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/slot_configurations/{slot_id}/{slot_config_id} Data N/A
AbTests Added DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id} Data N/A
AbTests Added PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id} Data N/A
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 PATCH /baskets/{basket_id}/price_adjustments/{price_adjustment_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 POST /baskets/{basket_id}/items Shop More
Baskets Changed DELETE /baskets/{basket_id}/items/{item_id} Shop More
Baskets Changed DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id} 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 PATCH /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_id} Data N/A
Campaigns Added DELETE /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id} Data N/A
Campaigns Added PUT /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id} Data N/A
Campaigns Changed PUT /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_id} Data More
Catalogs Added PATCH /catalogs/{catalog_id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_product_options Data N/A
Catalogs Added DELETE /catalogs/{catalog_id}/shared_product_options/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_product_options/{id} Data N/A
Catalogs Added PATCH /catalogs/{catalog_id}/shared_product_options/{id} Data N/A
Catalogs Added PUT /catalogs/{catalog_id}/shared_product_options/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_product_options/{option_id}/values Data N/A
Catalogs Added DELETE /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Data N/A
Catalogs Added PATCH /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Data N/A
Catalogs Added PUT /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_variation_attributes Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values Data N/A
Catalogs Added DELETE /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Data N/A
Catalogs Added PATCH /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Data N/A
Catalogs Added PUT /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Data N/A
Catalogs Added DELETE /catalogs/{catalog_id}/shared_variation_attributes/{id} Data N/A
Catalogs Added GET /catalogs/{catalog_id}/shared_variation_attributes/{id} Data N/A
Catalogs Added PATCH /catalogs/{catalog_id}/shared_variation_attributes/{id} Data N/A
Catalogs Added PUT /catalogs/{catalog_id}/shared_variation_attributes/{id} Data N/A
Categories Added GET /catalogs/{catalog_id}/categories Data N/A
Categories Changed GET /categories/({id},...,{id}) Shop More
Categories Changed GET /categories/{id} Shop More
Content Changed GET /content/({id},...,{id}) Shop More
Content Changed GET /content/{id} Shop More
ContentSearch Changed GET /content_search Shop More
Coupons Added GET /sites/{site_id}/coupons Data N/A
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}/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 Changed GET /custom_objects/{object_type}/{key} Shop More
CustomerGroups Added GET /sites/{site_id}/customer_groups/{id}/members Data N/A
CustomerLists Added POST /customer_lists/{customer_list_id}/customer_search Data N/A
CustomerSearch Removed POST /customer_search Data N/A
Customers Added POST /customers/auth/trustedsystem Shop N/A
Customers Added POST /customers/ext_profile 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 GET /customers/{customer_id}/orders Shop More
Customers Changed GET /customers/{customer_id}/payment_instruments/{payment_instrument_id} Shop More
Customers Changed GET /customers/{customer_id}/product_lists 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
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
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
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 PUT /orders/{order_no} Shop N/A
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
ProductLists Changed GET /product_lists Shop More
ProductLists Changed GET /product_lists/{list_id} Shop More
ProductLists Changed GET /product_lists/{list_id}/items Shop More
ProductLists Changed GET /product_lists/{list_id}/items/{item_id} Shop More
ProductSearch Added GET /product_search/represented_products Shop N/A
ProductSearch Changed GET /product_search Shop More
ProductSearch Changed GET /product_search/availability Shop More
ProductSearch Changed GET /product_search/images Shop More
ProductSearch Changed GET /product_search/prices Shop More
ProductSearch Changed GET /product_search/variations Shop More
Products Added DELETE /products/{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 Changed GET /products/{id} Data More
Products Changed GET /products/({id},...,{id}) Shop More
Products Changed GET /products/{id} Shop More
Products Changed GET /products/{id}/availability Shop More
Products Changed GET /products/{id}/bundled_products Shop More
Products Changed GET /products/{id}/images Shop More
Products Changed GET /products/{id}/links Shop More
Products Changed GET /products/{id}/options Shop More
Products Changed GET /products/{id}/prices Shop More
Products Changed GET /products/{id}/promotions Shop More
Products Changed GET /products/{id}/recommendations Shop More
Products Changed GET /products/{id}/set_products Shop More
Products Changed GET /products/{id}/variations Shop More
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
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
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 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
SlotSearch Added POST /sites/{site_id}/slot_search Data N/A
Slots Added GET /sites/{site_id}/slots Data N/A
SortingRuleSearch Added POST /sites/{site_id}/sorting_rule_search Data N/A
Stores Added GET /sites/{site_id}/stores Data N/A
Stores Changed GET /stores Shop More
Stores Changed GET /stores/({id},...,{id}) Shop More
Stores Changed GET /stores/{id} Shop More
SystemObjectDefinitionSearch Added POST /system_object_definition_search Data N/A
SystemObjectDefinitions Added GET /system_object_definitions Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type} Data N/A
SystemObjectDefinitions Added POST /system_object_definitions/{object_type}/attribute_definition_search Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_definitions Data N/A
SystemObjectDefinitions Added DELETE /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added PATCH /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added PUT /system_object_definitions/{object_type}/attribute_definitions/{id} Data N/A
SystemObjectDefinitions Added POST /system_object_definitions/{object_type}/attribute_group_search Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_groups Data N/A
SystemObjectDefinitions Added DELETE /system_object_definitions/{object_type}/attribute_groups/{group_id}/attribute_definitions/{def_id} Data N/A
SystemObjectDefinitions Added PUT /system_object_definitions/{object_type}/attribute_groups/{group_id}/attribute_definitions/{def_id} Data N/A
SystemObjectDefinitions Added DELETE /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
SystemObjectDefinitions Added GET /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
SystemObjectDefinitions Added PATCH /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
SystemObjectDefinitions Added PUT /system_object_definitions/{object_type}/attribute_groups/{id} Data N/A
UserSearch Added POST /user_search Data N/A
Users Added GET /users Data N/A
Users Added GET /users/this Data N/A
Users Added PATCH /users/this/password Data N/A
Users Added DELETE /users/{login} Data N/A
Users Added GET /users/{login} Data N/A
Users Added PATCH /users/{login} Data N/A
Users Added PUT /users/{login} Data N/A
VariantSearch Added POST /products/{id}/variant_search Data N/A

Documents added, modified, or removed since 16.6

Document Name Change API Details
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
CartridgePathAddRequest Added Data API N/A
CartridgePathApiResponse Added Data API N/A
CartridgePathCreateRequest Added Data API N/A
Catalog Changed Data API More
CatalogCategoryId Added Data API N/A
Categories Added Data API N/A
Category Changed Data API More
Category Changed Shop API More
CodeVersion Changed Data API More
ContentAsset Changed Data API More
ContentFolder Changed Data API More
Coupon Changed Data API More
Coupons Added Data API N/A
Customer Changed Data API More
Customer Changed Shop API More
CustomerAddress Changed Data API More
CustomerAddress Changed Shop API More
CustomerGroup Changed Data API More
CustomerGroupMember Changed Data API More
CustomerGroupMembers Added Data API N/A
CustomerPaymentCardRequest Changed Shop API More
CustomerPaymentInstrument Changed Shop API More
CustomerProductList Changed Shop API More
CustomerProductListItemPurchase Added Shop API N/A
CustomerProductListItemPurchaseResult Added Shop API N/A
CustomerSearchHit Added Data API N/A
CustomerSearchHit Changed Data API More
CustomerSearchRequest Changed Data API More
CustomerSearchResult Changed Data API More
CustomerSearchResult Added Data API N/A
CustomersExtProfile 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
FunctionalPermission Added Data API N/A
FunctionalPermissions Added Data API N/A
GiftCertificate Changed Data API More
GiftCertificates Added Data API N/A
Image Removed 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 Shop API N/A
LocalePermission Added Data API N/A
LocalePermissions Added Data API N/A
MarkupText Added Data API N/A
Master Changed Data API More
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
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 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 Changed Data API More
Product Changed Shop API More
ProductInventoryRecord Changed Data API More
ProductItem Changed Shop API More
ProductOption Added Data API N/A
ProductOptionValue Added Data API N/A
ProductOptionValues Added Data API N/A
ProductOptions Added Data API N/A
ProductRecommendationsResult Added Shop API N/A
ProductRef Added Shop API N/A
ProductSearchHit Changed Shop API More
ProductSearchResult Changed Shop API More
Promotion 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 Changed Shop API More
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
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
SlotConfiguration Changed Data API More
SlotConfigurations Added Data API N/A
SlotContent Changed Data API More
SlotSearchResult Added Data API N/A
Slots Added Data API N/A
SortingRule Changed Data API More
SortingRuleSearchResult Added Data API N/A
SourceCodeGroup Changed Data API More
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 Changed Data API More
Variant Changed Shop API More
VariantSearchResult Added Data API N/A
Variants Added Data API N/A
VariationAttribute Changed Data API More
VariationAttributeValue Changed Data API More
VariationAttributeValues Added Data API N/A
VariationAttributes Added Data API N/A
VariationGroup Changed Data API More
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.6.

DELETE /baskets/{basket_id}

Element Change API 16.6 20.10
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.6 20.10
Description Changed Shop Updates a basket. Only the currency of the basket and the custom properties of the basket and of the shipping items will be considered. Updates a basket. Only the currency of the basket, source code, and the custom properties of the basket and of the shipping items will be considered.
Fault Added Shop N/A

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

sourceCode (String)
Fault Added Shop N/A

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

sourceCode (String)

POST /baskets/{basket_id}/items

Element Change API 16.6 20.10
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.
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.6 20.10
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)

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

Element Change API 16.6 20.10
Fault Added Shop N/A

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

paymentInstrumentId (String)

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

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

Name: campaign_id

Description: The id of the campaign

Name: campaign_id

Description: The ID of the campaign.
Path Parameter Changed Data

Name: site_id

Description: The id of the site

Name: site_id

Description: The ID of the site.
Path Parameter Changed Data

Name: slot_id

Description: The of the slot

Name: slot_id

Description: The ID of the slot.
Path Parameter Changed Data

Name: slot_config_id

Description: The id of the slot configuration

Name: slot_config_id

Description: The ID of the slot configuration.
Fault Added Data N/A

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

bodyID (String)

urlID (String)

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

Element Change API 16.6 20.10
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.6 20.10
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.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /content/{id}

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /content_search

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /custom_objects/{object_type}/{key}

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /customers/{customer_id}/orders

Element Change API 16.6 20.10
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.6 20.10
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 /customers/{customer_id}/product_lists

Element Change API 16.6 20.10
Description Changed Shop Returns all customer product lists. Returns all customer product lists in a paginated manner.
Path Parameter Changed Shop

Name: customer_id

Description: The customer id.

Name: customer_id

Description: - The customer id.
Query Parameter Added Shop N/A

Name: start

Type: Integer

Description: - The start of the product List

Constraints: minIntegerValue=0
Query Parameter Added Shop N/A

Name: count

Type: Integer

Description: - The count returned per page

Constraints: maxIntegerValue=200, minIntegerValue=1
Query Parameter Changed Shop

Name: expand

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

Name: expand

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

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

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /folders/{id}

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

POST /order_search

Element Change API 16.6 20.10
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/{order_no}/payment_instruments

Element Change API 16.6 20.10
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.6 20.10
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.6 20.10
Query Parameter Added Shop N/A

Name: skip_authorization

Type: Boolean

Description:

Constraints:

GET /product_lists

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /product_lists/{list_id}

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /product_lists/{list_id}/items

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

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

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /product_search

Element Change API 16.6 20.10
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.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /product_search/images

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /product_search/prices

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /product_search/variations

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}

Element Change API 16.6 20.10
Query Parameter Changed Data

Name: expand

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

Name: expand

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

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

Element Change API 16.6 20.10
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.6 20.10
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.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/bundled_products

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/images

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/links

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/options

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/prices

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/promotions

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/recommendations

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/set_products

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /products/{id}/variations

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /promotions

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

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

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /promotions/{id}

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /search_suggestion

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /site

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /stores

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

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

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

GET /stores/{id}

Element Change API 16.6 20.10
Authentication Added Shop N/A JWT: Authentication via Customer JWT.

Details about modified documents

The following documents have been modified since 16.6.

Basket

Element Change API 16.6 20.10
Property Added Shop N/A

Name: bonus_discount_line_items

Type: [BonusDiscountLineItem]

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

Constraints:

Property Added Shop N/A

Name: inventory_reservation_expiry

Type: Date

Description:

Constraints:

Property Added Shop N/A

Name: source_code

Type: String

Description: Gets the source code assigned to this basket.

Constraints:

Property Changed Shop

Name: creation_date

Description: Gets the creation date of this basket.

Name: creation_date

Description: Returns the value of attribute 'creationDate'.
Property Changed Shop

Name: last_modified

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

Name: last_modified

Description: Returns the value of attribute 'lastModified'.

Campaign

Element Change API 16.6 20.10
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Catalog

Element Change API 16.6 20.10
Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Data

Name: creation_date

Type: DateTime

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

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Category

Element Change API 16.6 20.10
Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Data

Name: creation_date

Type: DateTime

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

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Category

Element Change API 16.6 20.10
Property Added Shop N/A

Name: parent_category_tree

Type: [PathRecord]

Description: List of parent categories

Constraints:

CodeVersion

Element Change API 16.6 20.10
Property Removed Data

Name: creation_time

Type: DateTime

Description: The code version creation time.

Constraints:

N/A

ContentAsset

Element Change API 16.6 20.10
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.6 20.10
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Coupon

Element Change API 16.6 20.10
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Customer

Element Change API 16.6 20.10
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.6 20.10
Property Added Shop N/A

Name: hashed_login

Type: String

Description: The customer's hashed LoginId. This field is READ-ONLY

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

Type: String

Description: The customer's note.

Constraints:

Property Added Shop N/A

Name: visit_id

Type: String

Description: The customer's visitId. This field is READ-ONLY

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.6 20.10
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.6 20.10
Property Added Shop N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Shop N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

CustomerGroup

Element Change API 16.6 20.10
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

CustomerGroupMember

Element Change API 16.6 20.10
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

CustomerPaymentCardRequest

Element Change API 16.6 20.10
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.6 20.10
Property Added Shop N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Shop N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

CustomerProductList

Element Change API 16.6 20.10
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.6 20.10
Property Added Data N/A

Name: primary_address

Type: CustomerAddress

Description: The primary address for the customer.

Constraints:

CustomerSearchRequest

Element Change API 16.6 20.10
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.6 20.10
Property Added Data N/A

Name: expand

Type: [String]

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

Constraints:

GiftCertificate

Element Change API 16.6 20.10
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.6 20.10
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.6 20.10
Property Added Data N/A

Name: price_per_unit

Type: Decimal

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

Constraints:

Property Added Data N/A

Name: price_per_unit_max

Type: Decimal

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

Constraints:

Master

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

OptionItem

Element Change API 16.6 20.10
Property Added Shop N/A

Name: bonus_discount_line_item_id

Type: String

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

Constraints:

Property Added Shop N/A

Name: gift

Type: boolean

Description: Returns true if the item is a gift.

Constraints:

Property Added Shop N/A

Name: gift_message

Type: String

Description: The gift message.

Constraints:

Order

Element Change API 16.6 20.10
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: 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: 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.6 20.10
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.6 20.10
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.6 20.10
Property Changed Shop

Name: relevance

Type: double

Name: relevance

Type: Double

OrderSearchRequest

Element Change API 16.6 20.10
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.6 20.10
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 Shop

Name: query

Type: String

Description: The requested query string.

Name: query

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

Description: The query passed into the search

PaymentMethod

Element Change API 16.6 20.10
Property Added Shop N/A

Name: payment_processor_id

Type: String

Description: The payment processor ID.

Constraints:

PriceAdjustment

Element Change API 16.6 20.10
Property Added Shop N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Shop

Name: creation_date

Description: The creation date

Name: creation_date

Description: Returns the value of attribute 'creationDate'.

Product

Element Change API 16.6 20.10
Property Added Data N/A

Name: assigned_categories

Type: [CatalogCategoryId]

Description: The catalog categories that the product is assigned to

Constraints:

Property Added Data N/A

Name: bundled_products

Type: [Product]

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

Constraints:

Property Added Data N/A

Name: classification_category

Type: CatalogCategoryId

Description: The classification category (default category) of the product

Constraints:

Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: image_groups

Type: [ImageGroup]

Description: The array of product image groups.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Added Data N/A

Name: localized_tax_class_id

Type: [String]

Description:

Constraints:

Property Added Data N/A

Name: price_per_unit

Type: Decimal

Description: The price per unit of the product

Constraints:

Property Added Data N/A

Name: primary_categories

Type: [CatalogCategoryId]

Description: The catalog categories that are primary for the product

Constraints:

Property Added Data N/A

Name: product_bundles

Type: [Product]

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

Constraints:

Property Added Data N/A

Name: product_options

Type: [ProductOption]

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

Constraints:

Property Added Data N/A

Name: product_sets

Type: [Product]

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

Constraints:

Property Added Data N/A

Name: set_products

Type: [Product]

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

Constraints:

Property Added Data N/A

Name: tax_class_id

Type: String

Description: The catalog categories that the product is assigned to

Constraints:

Property Added Data N/A

Name: unit_measure

Type: String

Description: The unitMeasure of the product.

Constraints:

Property Added Data N/A

Name: unit_quantity

Type: Decimal

Description: The unitQuantity of the product.

Constraints:

Property Added Data N/A

Name: valid_from

Type: [DateTime]

Description: The time when product is valid from.

Constraints:

Property Added Data N/A

Name: valid_to

Type: [DateTime]

Description: The time when product is valid to.

Constraints:

Property Changed Data

Name: image

Type: Image

Name: image

Type: MediaFile
Property Changed Data

Name: long_description

Type: [String]

Description: The localized product long description.

Name: long_description

Type: [MarkupText]

Description: The localized long description of the product.
Property Changed Data

Name: short_description

Type: [String]

Description: The localized product short description.

Name: short_description

Type: [MarkupText]

Description: The localized short description of the product.

Product

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

ProductInventoryRecord

Element Change API 16.6 20.10
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

ProductItem

Element Change API 16.6 20.10
Property Added Shop N/A

Name: bonus_discount_line_item_id

Type: String

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

Constraints:

Property Added Shop N/A

Name: gift

Type: boolean

Description: Returns true if the item is a gift.

Constraints:

Property Added Shop N/A

Name: gift_message

Type: String

Description: The gift message.

Constraints:

ProductSearchHit

Element Change API 16.6 20.10
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: represented_product

Type: ProductRef

Description: The first represented product.

Constraints:

Property Added Shop N/A

Name: represented_products

Type: [ProductRef]

Description: All the represented products.

Constraints:

ProductSearchResult

Element Change API 16.6 20.10
Property Added Shop N/A

Name: search_phrase_suggestions

Type: Suggestion

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

Constraints:

Property Removed Shop

Name: suggested_search_phrase

Type: String

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

Constraints:

N/A

PublicProductList

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

ShippingMethod

Element Change API 16.6 20.10
Property Added Shop N/A

Name: external_shipping_method

Type: String

Description: The external shipping method.

Constraints:

Site

Element Change API 16.6 20.10
Property Added Data N/A

Name: cartridges

Type: String

Description: The cartridge Path of the site

Constraints:

Site

Element Change API 16.6 20.10
Property Added Shop N/A

Name: default_currency

Type: String

Description: The currency mnemonic of the site.

Constraints:

Property Removed Shop

Name: currency

Type: String

Description: The currency mnemonic of the site.

Constraints:

N/A
Property Changed Shop

Name: allowed_locales

Type: [String]

Name: allowed_locales

Type: [Locale]

SlotConfiguration

Element Change API 16.6 20.10
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Data

Name: callout_msg

Type: [String]

Name: callout_msg

Type: [MarkupText]

SlotContent

Element Change API 16.6 20.10
Property Changed Data

Name: body

Type: [String]

Name: body

Type: [MarkupText]

SortingRule

Element Change API 16.6 20.10
Property Added Data N/A

Name: rule_context

Type: String

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

Constraints:

SourceCodeGroup

Element Change API 16.6 20.10
Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Changed Data

Name: creation_date

Type: DateTime

Description: The creation date, read only

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Store

Element Change API 16.6 20.10
Property Added Data N/A

Name: creation_date

Type: Date

Description: Returns the value of attribute 'creationDate'.

Constraints:

Property Added Data N/A

Name: last_modified

Type: Date

Description: Returns the value of attribute 'lastModified'.

Constraints:

Property Added Data N/A

Name: pos_enabled

Type: Boolean

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

Constraints:

Property Removed Data

Name: demandware_pos_enabled

Type: Boolean

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

Constraints:

N/A
Property Changed Data

Name: image

Type: String

Constraints: maxLength=256

Name: image

Type: MediaFile

Constraints:

Property Changed Data

Name: store_events

Type: [String]

Name: store_events

Type: [MarkupText]
Property Changed Data

Name: store_hours

Type: [String]

Name: store_hours

Type: [MarkupText]

Store

Element Change API 16.6 20.10
Property Added Shop N/A

Name: pos_enabled

Type: Boolean

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

Constraints:

Property Removed Shop

Name: demandware_pos_enabled

Type: Boolean

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

Constraints:

N/A

Suggestion

Element Change API 16.6 20.10
Property Added Shop N/A

Name: suggested_phrases

Type: [SuggestedPhrase]

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

Constraints:

Property Added Shop N/A

Name: suggested_terms

Type: [SuggestedTerms]

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

Constraints:

SuggestionResult

Element Change API 16.6 20.10
Property Added Shop N/A

Name: brand_suggestions

Type: Suggestion

Description: Returns the suggested brands.

Constraints:

Property Added Shop N/A

Name: category_suggestions

Type: Suggestion

Description: Returns the suggested categories.

Constraints:

Property Added Shop N/A

Name: content_suggestions

Type: Suggestion

Description: Returns the suggested content.

Constraints:

Property Added Shop N/A

Name: custom_suggestions

Type: Suggestion

Description: Returns the suggested custom suggestions.

Constraints:

Property Added Shop N/A

Name: product_suggestions

Type: Suggestion

Description: Returns the suggested products.

Constraints:

Property Removed Shop

Name: suggested_phrases

Type: [String]

Description: The suggested phrases.

Constraints:

N/A
Property Removed Shop

Name: suggestions

Type: [Suggestion]

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

Constraints:

N/A

Variant

Element Change API 16.6 20.10
Property Added Data N/A

Name: price_per_unit

Type: Decimal

Description: The sales price of the variant.

Constraints:

Property Added Data N/A

Name: variation_attributes

Type: [VariationAttribute]

Description: variation attributes

Constraints:

Property Changed Data

Name: image

Type: Image

Name: image

Type: MediaFile

Variant

Element Change API 16.6 20.10
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price of the variant.

Constraints:

VariationAttribute

Element Change API 16.6 20.10
Property Added Data N/A

Name: attribute_definition_id

Type: String

Description: The id of the requested attribute definition.

Constraints: mandatory=true, nullable=false
Property Added Data N/A

Name: attribute_definition_name

Type: [String]

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

Constraints:

Property Added Data N/A

Name: default_value

Type: String

Description: default variation attribute value

Constraints:

Property Added Data N/A

Name: link

Type: String

Description: URL that is used to get this instance

Constraints:

Property Added Data N/A

Name: shared

Type: boolean

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

Constraints:

Property Added Data N/A

Name: slicing

Type: boolean

Description: Returns the value of attribute 'slicing'.

Constraints:

Property Added Data N/A

Name: variation_attribute_type

Type: Enum {string, int, unknown}

Description: variation attribute type

Constraints:

VariationAttributeValue

Element Change API 16.6 20.10
Property Added Data N/A

Name: link

Type: String

Description:

Constraints:

Property Added Data N/A

Name: position

Type: Double

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

Constraints:

Property Changed Data

Name: image

Type: Image

Name: image

Type: MediaFile
Property Changed Data

Name: image_swatch

Type: Image

Name: image_swatch

Type: MediaFile

VariationGroup

Element Change API 16.6 20.10
Property Added Data N/A

Name: price_per_unit

Type: Decimal

Description: The sales price per unit of the variation group.

Constraints:

VariationGroup

Element Change API 16.6 20.10
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price per unit of the variation group.

Constraints:

© Copyright 2000-2020, salesforce.com inc. All rights reserved. Various trademarks held by their respective owners.

 Show URL Submit FeedbackPrivacy Policy
X OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.