OCAPI 20.3 changes since 19.3

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

Resources added, modified, or removed since 19.3

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
Orders Changed DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id} Shop More
Products Changed GET /products/({id},...,{id}) Shop 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 Changed POST /sites/{site_id}/sorting_rule_search Data More

Documents added, modified, or removed since 19.3

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
CampaignSortingRuleExperience Changed Data API More
Customer Changed Data 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
PaymentInstrumentUpdateRequest Added Data API N/A
PaymentTransactionUpdateRequest Added Data API N/A
Promotion Changed Data API More
ShippingAddressUpdateRequest Added Data API N/A
TrustedSystemAuthRequest Added Shop API N/A

Details about modified resources

The following requests have been modified since 19.3.

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

Element Change API 19.3 20.3
Query Parameter Changed Data

Name: rule_context

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

Name: rule_context

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 19.3 20.3
Query Parameter Changed Data

Name: rule_context

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

Name: rule_context

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

DELETE /baskets/{basket_id}

Element Change API 19.3 20.3
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 19.3 20.3
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 19.3 20.3
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 19.3 20.3
Query Parameter Changed Data

Name: rule_context

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

Name: rule_context

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

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

Element Change API 19.3 20.3
Query Parameter Changed Data

Name: rule_context

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

Name: rule_context

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

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

Element Change API 19.3 20.3
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 19.3 20.3
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 /sites/{site_id}/sorting_rule_search

Element Change API 19.3 20.3
Query Parameter Changed Data

Name: rule_context

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

Name: rule_context

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

Details about modified documents

The following documents have been modified since 19.3.

CampaignSortingRuleExperience

Element Change API 19.3 20.3
Property Changed Data

Name: rule_context

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

Name: rule_context

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

Customer

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

Name: callout_msg

Type: [MarkupText]

Description: The localized callout message of the promotion.

Constraints:

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.