OCAPI 23.2 changes since 20.3
The following sections describe all changes made to OCAPI since version 20.3.
Resources added, modified, or removed since 20.3
| 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 |
| Users | Added | DELETE | /users/{login}/access_key/{scope} | Data | N/A |
| Users | Added | GET | /users/{login}/access_key/{scope} | Data | N/A |
| Users | Added | PATCH | /users/{login}/access_key/{scope} | Data | N/A |
| Users | Added | PUT | /users/{login}/access_key/{scope} | Data | N/A |
Documents added, modified, or removed since 20.3
| Document Name | Change | API | Details |
|---|---|---|---|
| AccessKeyDetails | Added | Data API | N/A |
| AccessKeyUpdateRequest | Added | Data API | N/A |
| Basket | Changed | Shop API | More |
| Category | Changed | Shop API | More |
| Coupon | Changed | Data API | More |
| Customer | Changed | Shop API | More |
| CustomersExtProfile | Added | Shop API | N/A |
| GroupedTax | 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 |
| Order | Changed | Shop API | More |
| PathRecord | Added | Shop API | N/A |
| Product | Changed | Data API | More |
| Product | Changed | Shop API | More |
| ProductInventoryRecordAllocation | Changed | Data API | More |
| ProductSearchHit | Changed | Shop API | More |
| PromotionCampaignAssignment | Changed | Data 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.3.
PUT /sites/{site_id}/campaigns/{campaign_id}/promotions/{promotion_id}
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| Body | Changed | Data | None | PromotionCampaignAssignment |
PUT /customers/{customer_id}/password
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| 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.3 | 23.2 |
|---|---|---|---|---|
| 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.3.
Basket
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| Property | Added | Shop | N/A |
Name: grouped_tax_items Type: [GroupedTax] Description: Tax values that are summed and grouped based on the tax rate. The tax totals of the line items with the same tax rate will be grouped together and summed up. This will not affect calculation in any way. Constraints: |
| Property | Added | Shop | N/A |
Name: tax_rounded_at_group Type: boolean Description: If the tax is rounded at group level then this is set to true, false if the tax is rounded at item or unit level Constraints: |
Category
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| Property | Added | Shop | N/A |
Name: parent_category_tree Type: [PathRecord] Description: List of parent categories Constraints: |
Coupon
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| Property | Added | Data | N/A |
Name: case_insensitive Type: Boolean Description: Constraints: |
| Property | Added | Data | N/A |
Name: multiple_codes_per_basket Type: boolean Description: Constraints: |
Customer
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| 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.3 | 23.2 |
|---|---|---|---|---|
| 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: 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 | Added | Data | N/A |
Name: status_metadata Type: StatusMetadata Description: The metadata of the status. Constraints: |
| Property | Removed | Data |
Name: log_file_name Type: String Description: Name of the log file, containing execution log. Constraints: |
N/A |
JobStepExecution
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| Property | Added | Data | N/A |
Name: status_metadata Type: StatusMetadata Description: The metadata of the status. Constraints: |
Master
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| 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.3 | 23.2 |
|---|---|---|---|---|
| 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: |
Order
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| Property | Added | Shop | N/A |
Name: grouped_tax_items Type: [GroupedTax] Description: Tax values that are summed and grouped based on the tax rate. The tax totals of the line items with the same tax rate will be grouped together and summed up. This will not affect calculation in any way. Constraints: |
| Property | Added | Shop | N/A |
Name: guest Type: boolean Description: The registration status of the customer. Constraints: |
| Property | Added | Shop | N/A |
Name: tax_rounded_at_group Type: boolean Description: If the tax is rounded at group level then this is set to true, false if the tax is rounded at item or unit level Constraints: |
Product
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| 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.3 | 23.2 |
|---|---|---|---|---|
| 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: |
ProductInventoryRecordAllocation
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| Property | Changed | Data |
Name: amount Constraints: |
Name: amount Constraints: minNumberValue=0.0 |
ProductSearchHit
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| 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.3 | 23.2 |
|---|---|---|---|---|
| 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 | 20.3 | 23.2 |
|---|---|---|---|---|
| Property | Added | Data | N/A |
Name: price_per_unit Type: Decimal Description: The sales price of the variant. Constraints: |
Variant
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| Property | Added | Shop | N/A |
Name: price_per_unit Type: Decimal Description: The sales price of the variant. Constraints: |
VariationGroup
| Element | Change | API | 20.3 | 23.2 |
|---|---|---|---|---|
| Property | Added | Data | N/A |
Name: price_per_unit Type: Decimal Description: The sales price per unit of the variation group. Constraints: |
VariationGroup
