OCAPI 21.3 changes since 20.4

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

Resources added, modified, or removed since 20.4

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

Documents added, modified, or removed since 20.4

Document Name Change API Details
Category Changed Shop 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
Master Changed Data API More
Master Changed Shop API More
PathRecord Added Shop API N/A
Product Changed Data API More
Product Changed Shop API More
ProductSearchHit Changed Shop API More
PromotionCampaignAssignment Changed Data API More
Variant Changed Data API More
Variant Changed Shop API More
VariationGroup Changed Data API More
VariationGroup Changed Shop API More

Details about modified resources

The following requests have been modified since 20.4.

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

Element Change API 20.4 21.3
Body Changed Data None PromotionCampaignAssignment

PUT /customers/{customer_id}/password

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

GET /customers/{customer_id}/product_lists

Element Change API 20.4 21.3
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.4.

Category

Element Change API 20.4 21.3
Property Added Shop N/A

Name: parent_category_tree

Type: [PathRecord]

Description: List of parent categories

Constraints:

Customer

Element Change API 20.4 21.3
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.4 21.3
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: retry_information

Type: JobExecutionRetryInformation

Description: The retry information of this execution if available.

Constraints:

Master

Element Change API 20.4 21.3
Property Added Data N/A

Name: price_per_unit

Type: Decimal

Description: The minimum sales price per unit of the related variants.

Constraints:

Property Added Data N/A

Name: price_per_unit_max

Type: Decimal

Description: The maximum sales price per unit of the related variants.

Constraints:

Master

Element Change API 20.4 21.3
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The minimum sales price per unit of the related variants.

Constraints:

Property Added Shop N/A

Name: price_per_unit_max

Type: Decimal

Description: The maximum sales price per unit of the related variants.

Constraints:

Product

Element Change API 20.4 21.3
Property Added Data N/A

Name: price_per_unit

Type: Decimal

Description: The price per unit of the product

Constraints:

Property Added Data N/A

Name: unit_measure

Type: String

Description: The unitMeasure of the product.

Constraints:

Property Added Data N/A

Name: unit_quantity

Type: Decimal

Description: The unitQuantity of the product.

Constraints:

Product

Element Change API 20.4 21.3
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price per unit of the product. In case of complex products like master or set this is the minimum price per unit of related child products.

Constraints:

Property Added Shop N/A

Name: price_per_unit_max

Type: Decimal

Description: The maximum sales price per unit of related child products in case of complex products like master or set.

Constraints:

Property Added Shop N/A

Name: unit_measure

Type: String

Description: The unitMeasure of the product.

Constraints:

Property Added Shop N/A

Name: unit_quantity

Type: Decimal

Description:

Constraints:

ProductSearchHit

Element Change API 20.4 21.3
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price per unit of the product. In case of complex products like master or set this is the minimum price per unit of related child products.

Constraints:

Property Added Shop N/A

Name: price_per_unit_max

Type: Decimal

Description: The maximum sales price per unit of related child products in case of complex products like master or set.

Constraints:

PromotionCampaignAssignment

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

Variant

Element Change API 20.4 21.3
Property Added Data N/A

Name: price_per_unit

Type: Decimal

Description: The sales price of the variant.

Constraints:

Variant

Element Change API 20.4 21.3
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price of the variant.

Constraints:

VariationGroup

Element Change API 20.4 21.3
Property Added Data N/A

Name: price_per_unit

Type: Decimal

Description: The sales price per unit of the variation group.

Constraints:

VariationGroup

Element Change API 20.4 21.3
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price per unit of the variation group.

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.