OCAPI 20.9 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

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
Customers Added POST /customers/ext_profile Shop N/A
Orders Changed DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id} Shop More

Documents added, modified, or removed since 20.2

Document Name Change API Details
Category Changed Shop API More
Customer Changed Data API More
CustomersExtProfile Added Shop API N/A
JobExecution Changed Data API More
JobStepExecution Changed Data API More
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
SearchIndexUpdateConfiguration 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 20.2.

DELETE /baskets/{basket_id}

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

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

paymentInstrumentId (String)

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

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

Category

Element Change API 20.2 20.9
Property Added Shop N/A

Name: parent_category_tree

Type: [PathRecord]

Description: List of parent categories

Constraints:

Customer

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

JobExecution

Element Change API 20.2 20.9
Property Added Data N/A

Name: effective_duration

Type: Long

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

Constraints:

JobStepExecution

Element Change API 20.2 20.9
Property Added Data N/A

Name: status_metadata

Type: StatusMetadata

Description: The metadata of the status.

Constraints:

Master

Element Change API 20.2 20.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 20.2 20.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 20.2 20.9
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.2 20.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 20.2 20.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:

Variant

Element Change API 20.2 20.9
Property Added Data N/A

Name: price_per_unit

Type: Decimal

Description: The sales price of the variant.

Constraints:

Variant

Element Change API 20.2 20.9
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

Description: The sales price of the variant.

Constraints:

VariationGroup

Element Change API 20.2 20.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 20.2 20.9
Property Added Shop N/A

Name: price_per_unit

Type: Decimal

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

Constraints:

OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 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.