OCAPI 20.3 changes since 20.2

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

Resources added, modified, or removed since 20.2

Documents added, modified, or removed since 20.2

Document Name Change API Details
CampaignSortingRuleExperience Changed Data API More
Customer Changed Data API More

Details about modified resources

The following requests have been modified since 20.2.

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

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

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

paymentInstrumentId (String)

POST /sites/{site_id}/sorting_rule_search

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

CampaignSortingRuleExperience

Element Change API 20.2 20.3
Property Changed Data

Name: rule_context

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

Name: rule_context

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

Customer

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

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.