OCAPI 20.4 changes since 18.8

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

Resources added, modified, or removed since 18.8

Resource Name Change Http Method URL Template API Details
AbTests Changed DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id} Data More
AbTests Changed PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id} Data More
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 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 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
Customers Added POST /customers/auth/trustedsystem Shop N/A
Customers Added POST /customers/password/actions/create_reset_token Shop N/A
Customers Added POST /customers/password/actions/reset Shop 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 Changed DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id} Shop More
Products Changed GET /products/({id},...,{id}) Shop More
RoleSearch Changed POST /role_search Data More
Roles Changed DELETE /roles/{id} Data More
Roles Changed PUT /roles/{id}/users/{login} Data More
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

Documents added, modified, or removed since 18.8

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
Customer Changed Data API More
ExportDataUnitsConfiguration Added Data API N/A
ExportGlobalDataConfiguration Added Data API N/A
ExportSitesConfiguration Added Data API N/A
OcapiConfigsApiRequest Added Data API N/A
OcapiConfigsApiResponse Added Data API N/A
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
PaymentInstrumentUpdateRequest Added Data API N/A
PaymentTransactionUpdateRequest Added Data API N/A
Promotion Changed Data API More
ResetPasswordRequest Added Shop API N/A
ResetPasswordTokenRequest Added Shop API N/A
ResetPasswordTokenResult Added Shop API N/A
ResourceInfo Added Data API N/A
ResourceObject Added Data API N/A
RoleSearchRequest Added Data API N/A
SearchIndexUpdateConfiguration Added Data API N/A
ShippingAddressUpdateRequest Added Data API N/A
SiteArchiveExportConfiguration Added Data API N/A
SiteResourceInfo Added Data API N/A
SortingRule Changed Data API More
SortingRuleSearchResult Added Data API N/A
TrustedSystemAuthRequest Added Shop API N/A
VersionRangeObject Added Data API N/A

Details about modified resources

The following requests have been modified since 18.8.

DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element Change API 18.8 20.4
Query Parameter Added Data N/A

Name: rule_context

Type: String

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

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

PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element Change API 18.8 20.4
Query Parameter Added Data N/A

Name: rule_context

Type: String

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

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

DELETE /baskets/{basket_id}

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

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

paymentInstrumentId (String)

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

Element Change API 18.8 20.4
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 18.8 20.4
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"]

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

Element Change API 18.8 20.4
Fault Added Shop N/A

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

paymentInstrumentId (String)

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

Element Change API 18.8 20.4
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. If none of the products requested are found, the cache-control header will be defaulted to 60 seconds. 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

POST /role_search

Element Change API 18.8 20.4
Description Changed Data Searches for access roles.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

  • id - String
  • description - String

The output of the query can also be sorted. These are the list of sortable attributes:

  • id - String
  • description - String
Searches for access roles.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

  • id - String
  • description - String

Optionally, a user ID (the user login) can be specified. When it is supplied, the search for roles is limited to the roles assigned to this user. When expanding the permissions for the roles, all effective permissions for this user can be retrieved.

Optionally, a (single) permission can be specified. When it is supplied, the search for roles is limited to the roles having this permission. When expanding the users for the roles, all users having this permission can be retrieved.

The output of the query can also be sorted. These are the list of sortable attributes:

  • id - String
  • description - String
Body Changed Data SearchRequest RoleSearchRequest
Fault Added Data N/A

InvalidSearchQueryException(400): Throws when one of the search request restrictions is violated

fault (String)

DELETE /roles/{id}

Element Change API 18.8 20.4
Fault Added Data N/A

RoleNotFoundException(404): Thrown if the given role does not exist

id (String)

PUT /roles/{id}/users/{login}

Element Change API 18.8 20.4
Fault Added Data N/A

InvalidRoleException(400): Thrown if the access role with the given id does not exist.

roleId (String)

Fault Added Data N/A

InvalidUserLoginException(400): Thrown if a user with the given login does not exist.

login (String)

Fault Removed Data

RoleNotFoundException(404): Thrown if the access role with the given id does not exist.

id (String)

N/A
Fault Removed Data

UserNotFoundException(404): Thrown if a user with the given login does not exist.

login (String)

N/A

Details about modified documents

The following documents have been modified since 18.8.

Customer

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

Order

Element Change API 18.8 20.4
Property Added Shop N/A

Name: global_party_id

Type: String

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

Constraints:

Promotion

Element Change API 18.8 20.4
Property Added Data N/A

Name: callout_msg

Type: [MarkupText]

Description: The localized callout message of the promotion.

Constraints:

SortingRule

Element Change API 18.8 20.4
Property Added Data N/A

Name: rule_context

Type: String

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

Constraints:

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.