OCAPI 21.9 changes since 19.10

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

Resources added, modified, or removed since 19.10

Resource Name Change Http Method URL Template API Details
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 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
Orders Changed DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id} Shop More

Documents added, modified, or removed since 19.10

Document Name Change API Details
AssignedExperiences Added Data API N/A
AssignedQualifiers Added Data API N/A
Assignment Added Data API N/A
Category Changed Shop API More
Coupon Changed Data API More
Customer 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
JobStepExecution Changed Data API More
Master Changed Data API More
Master Changed Shop API More
MetricResponse Added Data API N/A
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
PathRecord Added Shop API N/A
PaymentInstrumentUpdateRequest Added Data API N/A
PaymentTransactionUpdateRequest Added Data API N/A
Product Changed Data API More
Product Changed Shop API More
ProductSearchHit Changed Shop API More
PromotionCampaignAssignment Changed Data API More
SearchIndexUpdateConfiguration Added Data API N/A
ShippingAddressUpdateRequest Added Data API N/A
StatusMetadata Added Data API N/A
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 19.10.

DELETE /baskets/{basket_id}

Element Change API 19.10 21.9
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.10 21.9
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.10 21.9
Fault Added Shop N/A

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

paymentInstrumentId (String)

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

Element Change API 19.10 21.9
Body Changed Data None PromotionCampaignAssignment

PUT /customers/{customer_id}/password

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

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

Element Change API 19.10 21.9
Fault Added Shop N/A

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

paymentInstrumentId (String)

Details about modified documents

The following documents have been modified since 19.10.

Category

Element Change API 19.10 21.9
Property Added Shop N/A

Name: parent_category_tree

Type: [PathRecord]

Description: List of parent categories

Constraints:

Coupon

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

Customer

Element Change API 19.10 21.9
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 19.10 21.9
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: effective_duration

Type: Long

Description: Time in milliseconds, the job has done work. Paused times are evicted.

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: retry_information

Type: JobExecutionRetryInformation

Description: The retry information of this execution if available.

Constraints:

JobStepExecution

Element Change API 19.10 21.9
Property Added Data N/A

Name: status_metadata

Type: StatusMetadata

Description: The metadata of the status.

Constraints:

Master

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

Name: classification_category

Type: CatalogCategoryId

Description: The classification category (default category) of the product

Constraints:

Property Added Data N/A

Name: localized_tax_class_id

Type: [String]

Description:

Constraints:

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: primary_categories

Type: [CatalogCategoryId]

Description: The catalog categories that are primary for the product

Constraints:

Property Added Data N/A

Name: tax_class_id

Type: String

Description: The catalog categories that the product is assigned to

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:

Property Added Data N/A

Name: valid_from

Type: [DateTime]

Description: The time when product is valid from.

Constraints:

Property Added Data N/A

Name: valid_to

Type: [DateTime]

Description: The time when product is valid to.

Constraints:

Product

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

Variant

Element Change API 19.10 21.9
Property Added Data N/A

Name: price_per_unit

Type: Decimal

Description: The sales price of the variant.

Constraints:

Variant

Element Change API 19.10 21.9
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price of the variant.

Constraints:

VariationGroup

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