OCAPI 21.3 changes since 20.10

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

Resources added, modified, or removed since 20.10

Resource Name Change Http Method URL Template API Details
Campaigns Added PATCH /sites/{site_id}/campaigns/{campaign_id}/promotions/{promotion_id} Data N/A
Campaigns Changed PUT /sites/{site_id}/campaigns/{campaign_id}/promotions/{promotion_id} Data More
Customers Added GET /customers/ext_profile Shop N/A
Customers Changed PUT /customers/{customer_id}/password Shop More

Documents added, modified, or removed since 20.10

Document Name Change API Details
CustomersExtProfile Changed Shop API More
PromotionCampaignAssignment Changed Data API More

Details about modified resources

The following requests have been modified since 20.10.

PUT /sites/{site_id}/campaigns/{campaign_id}/promotions/{promotion_id}

Element Change API 20.10 21.3
Body Changed Data None PromotionCampaignAssignment

PUT /customers/{customer_id}/password

Element Change API 20.10 21.3
Description Changed Shop Updates a customer's password. The update is made by the default afterPUT hook, not the PUT call. Thus, if you customize the afterPUT hook, your custom code must update the password. Updates a customer's password. The default implementation to update password update is now in resource itself. Thus, if you customize the afterPUT_v2 hook, your custom code must update the password. This endpoint can now be used by Mercury API to address the gap caused by disabling hooks.
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)

Details about modified documents

The following documents have been modified since 20.10.

CustomersExtProfile

Element Change API 20.10 21.3
Property Added Shop N/A

Name: first_name

Type: String

Description:

Constraints: maxLength=256

Property Added Shop N/A

Name: last_name

Type: String

Description:

Constraints: maxLength=256

PromotionCampaignAssignment

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

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.
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.