Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > What's new in OCAPI 23.2?

OCAPI 23.2 changes since 17.2

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

Resources added, modified, or removed since 17.2

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 DELETE /baskets/{basket_id}/items/{item_id} Shop More
Baskets Changed DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id} Shop More
Campaigns Added PATCH /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 Changed PUT /sites/{site_id}/campaigns/{campaign_id}/promotions/{promotion_id} Data More
Campaigns Changed PUT /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_id} Data More
Campaigns Changed DELETE /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id} Data More
Campaigns Changed PUT /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_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 Changed GET /categories/({id},...,{id}) Shop More
Categories Changed GET /categories/{id} Shop More
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 GET /customers/ext_profile 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}/baskets Shop More
Customers Changed GET /customers/{customer_id}/orders Shop More
Customers Changed PUT /customers/{customer_id}/password Shop More
Customers Changed POST /customers/{customer_id}/password_reset Shop More
Customers Changed GET /customers/{customer_id}/product_lists Shop More
Jobs Removed GET /jobs/{job_id}/executions Data N/A
Jobs Changed POST /jobs/{job_id}/executions Data More
LogRequests Added POST /log_requests/ecdn Data N/A
LogRequests Added GET /log_requests/ecdn/{id} Data N/A
Metrics Added GET /metrics/{apitype} 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
Orders Added PUT /orders/{order_no} Shop N/A
Orders Changed DELETE /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
ProductSearch Added GET /product_search/represented_products Shop N/A
ProductSearch Changed GET /product_search Shop More
Products Added DELETE /products/{master_product_id}/variation_groups/{id} Data N/A
Products Added GET /products/{master_product_id}/variation_groups/{id} Data N/A
Products Added PATCH /products/{master_product_id}/variation_groups/{id} Data N/A
Products Added PUT /products/{master_product_id}/variation_groups/{id} Data N/A
Products Added DELETE /products/{master_product_id}/variations/{id} Data N/A
Products Added GET /products/{master_product_id}/variations/{id} Data N/A
Products Added PATCH /products/{master_product_id}/variations/{id} Data N/A
Products Added PUT /products/{master_product_id}/variations/{id} Data N/A
Products Added GET /products/{product_id}/product_options Data N/A
Products Added DELETE /products/{product_id}/product_options/{id} Data N/A
Products Added GET /products/{product_id}/product_options/{id} Data N/A
Products Added PATCH /products/{product_id}/product_options/{id} Data N/A
Products Added PUT /products/{product_id}/product_options/{id} Data N/A
Products Added GET /products/{product_id}/product_options/{option_id}/values Data N/A
Products Added DELETE /products/{product_id}/product_options/{option_id}/values/{id} Data N/A
Products Added GET /products/{product_id}/product_options/{option_id}/values/{id} Data N/A
Products Added PATCH /products/{product_id}/product_options/{option_id}/values/{id} Data N/A
Products Added PUT /products/{product_id}/product_options/{option_id}/values/{id} Data N/A
Products Added GET /products/{product_id}/variation_attributes/{attribute_id}/values Data N/A
Products Added DELETE /products/{product_id}/variation_attributes/{attribute_id}/values/{id} Data N/A
Products Added GET /products/{product_id}/variation_attributes/{attribute_id}/values/{id} Data N/A
Products Added PATCH /products/{product_id}/variation_attributes/{attribute_id}/values/{id} Data N/A
Products Added PUT /products/{product_id}/variation_attributes/{attribute_id}/values/{id} Data N/A
Products Added DELETE /products/{product_id}/variation_attributes/{id} Data N/A
Products Added GET /products/{product_id}/variation_attributes/{id} Data N/A
Products Added PATCH /products/{product_id}/variation_attributes/{id} Data N/A
Products Added PUT /products/{product_id}/variation_attributes/{id} Data N/A
Products Changed GET /products/{id} Data More
Products Changed GET /products/({id},...,{id}) Shop More
Products Changed GET /products/{id} Shop More
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
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
SortingRuleSearch Added POST /sites/{site_id}/sorting_rule_search 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
Users Added DELETE /users/{login}/access_key/{scope} Data N/A
Users Added GET /users/{login}/access_key/{scope} Data N/A
Users Added PATCH /users/{login}/access_key/{scope} Data N/A
Users Added PUT /users/{login}/access_key/{scope} Data N/A

Documents added, modified, or removed since 17.2

Document Name Change API Details
AccessKeyDetails Added Data API N/A
AccessKeyUpdateRequest 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
AssignedExperiences Added Data API N/A
AssignedQualifiers Added Data API N/A
Assignment Added Data API N/A
BMPermissions Added Data API N/A
Basket Changed Shop API More
BasketReference Added Shop API N/A
CSCPermissions Added Data API N/A
CartridgePathAddRequest Added Data API N/A
CartridgePathApiResponse Added Data API N/A
CartridgePathCreateRequest Added Data API N/A
CatalogCategoryId Added Data API N/A
Category Changed Shop API More
Coupon Changed Data API More
Customer Changed Data API More
Customer Changed Shop API More
CustomerProductListItemPurchase Added Shop API N/A
CustomerProductListItemPurchaseResult Added Shop API N/A
CustomerSearchHit Added Data API N/A
CustomerSearchResult Added Data API N/A
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
GroupedTax Added Shop API N/A
Image Removed Data API N/A
ImageGroup Added Data API N/A
JobExecution Changed Data API More
JobExecutionContinueInformation Added Data API N/A
JobExecutionParameter Added Data API N/A
JobExecutionRequest Added Data API N/A
JobExecutionRetryInformation Added Data API N/A
JobStepExecution Changed Data API More
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
MetricResponse Added Data API N/A
ModulePermissions 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
OrderPaymentStatusUpdateRequest Added Data API N/A
OrderShippingStatusUpdateRequest Added Data API N/A
OrderStatusUpdateRequest Added Data API N/A
OrderUpdateRequest 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
Product Changed Data API More
Product Changed Shop API More
ProductInventoryRecordAllocation 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
Promotion Changed Data API More
PromotionCampaignAssignment Changed Data API More
PromotionLink Added Shop API N/A
Recommender Added Data API N/A
RecommendersResult Added Data API N/A
ResourceInfo Added Data API N/A
ResourceObject Added Data API N/A
Role Added Data API N/A
RoleFunctionalPermission Added Data API N/A
RoleFunctionalPermissions Added Data API N/A
RoleLocalePermission Added Data API N/A
RoleLocalePermissions Added Data API N/A
RoleModulePermission Added Data API N/A
RoleModulePermissions Added Data API N/A
RolePermissions Added Data API N/A
RoleSearchRequest Added Data API N/A
RoleSearchResult Added Data API N/A
RoleWebdavPermission Added Data API N/A
RoleWebdavPermissions Added Data API N/A
Roles Added Data API N/A
SearchIndexUpdateConfiguration Added Data API N/A
ShippingAddressUpdateRequest Added Data API N/A
Site Changed Data API More
SiteArchiveExportConfiguration Added Data API N/A
SiteArchiveImportConfiguration Added Data API N/A
SiteResourceInfo Added Data API N/A
SlotConfiguration Changed Data API More
SlotContent Changed Data API More
SortingRule Changed Data API More
SortingRuleSearchResult Added Data API N/A
StatusMetadata Added Data API N/A
Store Changed Data API More
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
VariationAttribute Changed Data API More
VariationAttributeValue Changed Data API More
VariationGroup Changed Data API More
VariationGroup Changed Shop API More
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 17.2.

DELETE /baskets/{basket_id}

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

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

Element Change API 17.2 23.2
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 17.2 23.2
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}/promotions/{promotion_id}

Element Change API 17.2 23.2
Body Changed Data None PromotionCampaignAssignment

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

Element Change API 17.2 23.2
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)

DELETE /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element Change API 17.2 23.2
Query Parameter Added Data N/A

Name: rule_context

Type: String

Description: The context in which the rule lives, either "site" or "global"the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=["global", "site"]

PUT /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element Change API 17.2 23.2
Description Changed Data Action to bind a single sorting rule to a given campaign. Lookup of the sorting rule is done in the site Action to bind a single sorting rule to a given campaign.
Query Parameter Added Data N/A

Name: rule_context

Type: String

Description: The context in which the rule lives, either "site" or "global"the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=["global", "site"]

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

Element Change API 17.2 23.2
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.
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 17.2 23.2
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.
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 /customers/{customer_id}/baskets

Element Change API 17.2 23.2
Title Changed Shop Get basket Get customer basket

GET /customers/{customer_id}/orders

Element Change API 17.2 23.2
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)

PUT /customers/{customer_id}/password

Element Change API 17.2 23.2
Title Changed Shop Updates a customer's password. Update a customer's password.
Description Changed Shop Updates the customer's password. Updates a customer's password. The default implementation updates the password in the resource. Versions prior to 21.3 updated the password in the afterPUT hook, which was incompatible with the Mercury API. Starting in version 21.3, the afterPUT_v2 hook replaces the afterPUT hook.
Fault Changed Shop

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

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

CustomerNotFoundException(404): Indicates that the customer with the given customer id is unknown.

customerId (String)

CustomerNotFoundException(404): Indicates that the customer with the given customer id is unknown.

customerId (String)

POST /customers/{customer_id}/password_reset

Element Change API 17.2 23.2
Title Changed Shop Starts a password reset process Starts a password reset process for given customer

GET /customers/{customer_id}/product_lists

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

POST /jobs/{job_id}/executions

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

See Global Jobs for information on available system jobs.

Body Changed Data None String

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

Element Change API 17.2 23.2
Fault Added Shop N/A

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

paymentInstrumentId (String)

GET /product_search

Element Change API 17.2 23.2
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).
  • htype: 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 /products/{id}

Element Change API 17.2 23.2
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
  • 'categories' will retrieve the following properties:
    • assigned_categories
    • primary_category
    • classification_category
  • '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.

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
    • primary_category
    • classification_category
  • '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 17.2 23.2
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.
Path Parameter Changed Shop

Name: ids

Constraints: maxItems=50, maxLength=100

Name: ids

Constraints: maxItems=24, maxLength=100
Query Parameter Changed Shop

Name: expand

Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products)

Name: expand

Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations)

GET /products/{id}

Element Change API 17.2 23.2
Query Parameter Changed Shop

Name: expand

Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products)

Name: expand

Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations)

GET /search_suggestion

Element Change API 17.2 23.2
Title Changed Shop Search Products Get search suggestions

Details about modified documents

The following documents have been modified since 17.2.

Basket

Element Change API 17.2 23.2
Property Added Shop N/A

Name: grouped_tax_items

Type: [GroupedTax]

Description: Tax values that are summed and grouped based on the tax rate. The tax totals of the line items with the same tax rate will be grouped together and summed up. This will not affect calculation in any way.

Constraints:

Property Added Shop N/A

Name: inventory_reservation_expiry

Type: Date

Description:

Constraints:

Property Added Shop N/A

Name: tax_rounded_at_group

Type: boolean

Description: If the tax is rounded at group level then this is set to true, false if the tax is rounded at item or unit level

Constraints:

Category

Element Change API 17.2 23.2
Property Added Shop N/A

Name: parent_category_tree

Type: [PathRecord]

Description: List of parent categories

Constraints:

Coupon

Element Change API 17.2 23.2
Property Added Data N/A

Name: case_insensitive

Type: Boolean

Description: True if a coupon is case insensitive; false otherwise. This attribute on the coupon can not be modified after the coupon has been created. If an attempt was made to modify this the system would return CouponUpdateForbiddenException

Constraints:

Property Added Data N/A

Name: multiple_codes_per_basket

Type: boolean

Description: True if a coupon with multiple codes can have different codes used on the same basket or order. If the coupon type does not support this configuration, this will return false.

Constraints:

Customer

Element Change API 17.2 23.2
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: primary_address

Type: CustomerAddress

Description: The customers primary or default address.

Constraints:

Customer

Element Change API 17.2 23.2
Property Added Shop N/A

Name: hashed_login

Type: String

Description: The customer's hashed LoginId which is used for activity tracking for logged in customers in conjunction with visitId. This field is READ-ONLY

Constraints:

Property Added Shop N/A

Name: visit_id

Type: String

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

Constraints:

JobExecution

Element Change API 17.2 23.2
Property Added Data N/A

Name: continue_information

Type: JobExecutionContinueInformation

Description: The continuation information of this execution if available.

Constraints:

Property Added Data N/A

Name: effective_duration

Type: Long

Description: Time in milliseconds, the job has done work. Paused times are evicted.

Constraints:

Property Added Data N/A

Name: executed_server_id

Type: String

Description: The ID of the server that executed the job.

Constraints:

Property Added Data N/A

Name: log_file_path

Type: String

Description: Full WebDAV path of the log file, containing execution log.

Constraints:

Property Added Data N/A

Name: parameters

Type: [JobExecutionParameter]

Description: List of all job execution parameters.

Constraints:

Property Added Data N/A

Name: retry_information

Type: JobExecutionRetryInformation

Description: The retry information of this execution if available.

Constraints:

Property Added Data N/A

Name: status_metadata

Type: StatusMetadata

Description: The metadata of the status.

Constraints:

Property Removed Data

Name: log_file_name

Type: String

Description: Name of the log file, containing execution log.

Constraints:

N/A

JobStepExecution

Element Change API 17.2 23.2
Property Added Data N/A

Name: chunk_size

Type: Integer

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

Constraints:

Property Added Data N/A

Name: is_chunk_oriented

Type: boolean

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

Constraints:

Property Added Data N/A

Name: item_filter_count

Type: Integer

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

Constraints:

Property Added Data N/A

Name: item_write_count

Type: Integer

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

Constraints:

Property Added Data N/A

Name: status_metadata

Type: StatusMetadata

Description: The metadata of the status.

Constraints:

Property Added Data N/A

Name: total_item_count

Type: Long

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

Constraints:

Master

Element Change API 17.2 23.2
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 17.2 23.2
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 17.2 23.2
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 17.2 23.2
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: grouped_tax_items

Type: [GroupedTax]

Description: Tax values that are summed and grouped based on the tax rate. The tax totals of the line items with the same tax rate will be grouped together and summed up. This will not affect calculation in any way.

Constraints:

Property Added Shop N/A

Name: guest

Type: boolean

Description: The registration status of the customer.

Constraints:

Property Added Shop N/A

Name: source_code

Type: String

Description: Gets the source code assigned to this basket.

Constraints:

Property Added Shop N/A

Name: tax_rounded_at_group

Type: boolean

Description: If the tax is rounded at group level then this is set to true, false if the tax is rounded at item or unit level

Constraints:

PaymentMethod

Element Change API 17.2 23.2
Property Added Shop N/A

Name: payment_processor_id

Type: String

Description: The payment processor ID.

Constraints:

Product

Element Change API 17.2 23.2
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: image_groups

Type: [ImageGroup]

Description: The array of product image groups.

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 17.2 23.2
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:

ProductInventoryRecordAllocation

Element Change API 17.2 23.2
Property Changed Data

Name: amount

Constraints:

Name: amount

Constraints: minNumberValue=0.0

ProductItem

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

Promotion

Element Change API 17.2 23.2
Property Added Data N/A

Name: callout_msg

Type: [MarkupText]

Description: The localized callout message of the promotion.

Constraints:

PromotionCampaignAssignment

Element Change API 17.2 23.2
Property Added Data N/A

Name: coupons_based

Type: Boolean

Description: True if the assigned promotion is coupon based. When set to false, Coupons in the campaign and on the PromotionCampaignAssignment are ignored. The default value is true.

Constraints:

Property Added Data N/A

Name: customer_groups_based

Type: Boolean

Description: True if the assigned promotion is customer group based. When set to false, Customer Groups in the campaign and on the PromotionCampaignAssignment are ignored. The default value is true.

Constraints:

Property Added Data N/A

Name: required_qualifier

Type: Enum {any, all}

Description: A constant indicating that one or all qualifier conditions must be met in order for the promotion to apply for a given customer. Valid values are "any" and "all".

Constraints:

Property Added Data N/A

Name: source_code_based

Type: Boolean

Description: True if the assigned promotion is source code group based. When set to false, Source Code Groups in the campaign and on the PromotionCampaignAssignment are ignored. The default value is true.

Constraints:

Site

Element Change API 17.2 23.2
Property Added Data N/A

Name: cartridges

Type: String

Description: The cartridge Path of the site

Constraints:

SlotConfiguration

Element Change API 17.2 23.2
Property Changed Data

Name: callout_msg

Type: [String]

Name: callout_msg

Type: [MarkupText]

SlotContent

Element Change API 17.2 23.2
Property Changed Data

Name: body

Type: [String]

Name: body

Type: [MarkupText]

SortingRule

Element Change API 17.2 23.2
Property Added Data N/A

Name: rule_context

Type: String

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

Constraints:

Store

Element Change API 17.2 23.2
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]

Variant

Element Change API 17.2 23.2
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 17.2 23.2
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price of the variant.

Constraints:

VariationAttribute

Element Change API 17.2 23.2
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 17.2 23.2
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 17.2 23.2
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 17.2 23.2
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

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

Constraints:

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.