OCAPI 23.2 changes since 21.2
The following sections describe all changes made to OCAPI since version 21.2.
Resources added, modified, or removed since 21.2
| 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 | Changed | PUT | /customers/{customer_id}/password | 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 21.2
| Document Name | Change | API | Details |
|---|---|---|---|
| AccessKeyDetails | Added | Data API | N/A |
| AccessKeyUpdateRequest | Added | Data API | N/A |
| Basket | Changed | Shop API | More |
| Coupon | Changed | Data API | More |
| GroupedTax | Added | Shop API | N/A |
| JobExecution | Changed | Data API | More |
| MetricResponse | Added | Data API | N/A |
| Order | Changed | Shop API | More |
| ProductInventoryRecordAllocation | Changed | Data API | More |
| PromotionCampaignAssignment | Changed | Data API | More |
Details about modified resources
The following requests have been modified since 21.2.
PUT /sites/{site_id}/campaigns/{campaign_id}/promotions/{promotion_id}
| Element | Change | API | 21.2 | 23.2 |
|---|---|---|---|---|
| Body | Changed | Data | None | PromotionCampaignAssignment |
PUT /customers/{customer_id}/password
| Element | Change | API | 21.2 | 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) |
Details about modified documents
The following documents have been modified since 21.2.
Basket
| Element | Change | API | 21.2 | 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: |
Coupon
| Element | Change | API | 21.2 | 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: |
JobExecution
| Element | Change | API | 21.2 | 23.2 |
|---|---|---|---|---|
| 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 | Removed | Data |
Name: log_file_name Type: String Description: Name of the log file, containing execution log. Constraints: |
N/A |
Order
| Element | Change | API | 21.2 | 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: |
ProductInventoryRecordAllocation
| Element | Change | API | 21.2 | 23.2 |
|---|---|---|---|---|
| Property | Changed | Data |
Name: amount Constraints: |
Name: amount Constraints: minNumberValue=0.0 |
PromotionCampaignAssignment
| Element | Change | API | 21.2 | 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: |