The following sections describe all changes made to OCAPI since version 19.10.
Document Name | Change | API | Details |
---|---|---|---|
Category | Changed | Shop API | More |
Customer | Changed | Data API | More |
Customer | Changed | Shop 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 |
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 |
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 |
The following requests have been modified since 19.10.
DELETE /baskets/{basket_id}
Element | Change | API | 19.10 | 20.10 |
---|---|---|---|---|
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 | 20.10 |
---|---|---|---|---|
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 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | PaymentInstrumentNotFoundException(404): Indicates that the payment instrument with the given payment instrument number is unknown. paymentInstrumentId (String) |
GET /customers/{customer_id}/product_lists
Element | Change | API | 19.10 | 20.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. |
DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id}
The following documents have been modified since 19.10.
Category
Element | Change | API | 19.10 | 20.10 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: parent_category_tree Type: [PathRecord] Description: List of parent categories Constraints: |
Customer
Element | Change | API | 19.10 | 20.10 |
---|---|---|---|---|
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 | 20.10 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: hashed_login Type: String Description: The customer's hashed LoginId. 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 | 20.10 |
---|---|---|---|---|
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 | 19.10 | 20.10 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: status_metadata Type: StatusMetadata Description: The metadata of the status. Constraints: |
Master
Element | Change | API | 19.10 | 20.10 |
---|---|---|---|---|
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 | 20.10 |
---|---|---|---|---|
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 | 20.10 |
---|---|---|---|---|
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 | 20.10 |
---|---|---|---|---|
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 | 20.10 |
---|---|---|---|---|
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 | 19.10 | 20.10 |
---|---|---|---|---|
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 | 20.10 |
---|---|---|---|---|
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 | 20.10 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: price_per_unit Type: Decimal Description: The sales price per unit of the variation group. Constraints: |
VariationGroup