OCAPI 21.10 changes since 20.8

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

Resources added, modified, or removed since 20.8

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 Added POST /customers/ext_profile Shop N/A
Customers Changed PUT /customers/{customer_id}/password Shop More
Customers Changed GET /customers/{customer_id}/product_lists Shop More
Metrics Added GET /metrics/{apitype} Data N/A

Documents added, modified, or removed since 20.8

Document Name Change API Details
Coupon Changed Data API More
Customer Changed Shop API More
CustomersExtProfile Added Shop API N/A
JobExecution Changed Data API More
JobExecutionContinueInformation Added Data API N/A
JobExecutionRetryInformation Added Data API N/A
MetricResponse Added Data API N/A
PromotionCampaignAssignment Changed Data API More

Details about modified resources

The following requests have been modified since 20.8.

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

Element Change API 20.8 21.10
Body Changed Data None PromotionCampaignAssignment

PUT /customers/{customer_id}/password

Element Change API 20.8 21.10
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 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)

GET /customers/{customer_id}/product_lists

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

Details about modified documents

The following documents have been modified since 20.8.

Coupon

Element Change API 20.8 21.10
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 20.8 21.10
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 20.8 21.10
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: 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: retry_information

Type: JobExecutionRetryInformation

Description: The retry information of this execution if available.

Constraints:

Property Removed Data

Name: log_file_name

Type: String

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

Constraints:

N/A

PromotionCampaignAssignment

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

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.