Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > What's new in OCAPI 23.2?

OCAPI 23.2 changes since 18.8

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

Resources added, modified, or removed since 18.8

Resource Name	Change	Http Method	URL Template	API	Details
AbTests	Changed	DELETE	/sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id}	Data	More
AbTests	Changed	PUT	/sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id}	Data	More
Alerts	Added	GET	/alerts/descriptors	Data	N/A
Alerts	Added	GET	/alerts/descriptors/{application_id}	Data	N/A
Alerts	Added	GET	/alerts/descriptors/{application_id}/{application_context_path}/{message_id}	Data	N/A
Alerts	Added	PATCH	/alerts/descriptors/{application_id}/{application_context_path}/{message_id}/revalidate	Data	N/A
Alerts	Added	GET	/alerts/items	Data	N/A
Alerts	Added	GET	/alerts/items/{application_id}	Data	N/A
Alerts	Added	DELETE	/alerts/items/{application_id}/{application_context_path}/{message_id}/{context_object_id}	Data	N/A
Alerts	Added	GET	/alerts/items/{application_id}/{application_context_path}/{message_id}/{context_object_id}	Data	N/A
Alerts	Added	GET	/alerts/usersettings	Data	N/A
Alerts	Added	PATCH	/alerts/usersettings	Data	N/A
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
Campaigns	Changed	DELETE	/sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id}	Data	More
Campaigns	Changed	PUT	/sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id}	Data	More
Customers	Added	POST	/customers/auth/trustedsystem	Shop	N/A
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
OcapiConfigs	Added	DELETE	/ocapi_configs/{clientId}	Data	N/A
OcapiConfigs	Added	GET	/ocapi_configs/{clientId}	Data	N/A
OcapiConfigs	Added	POST	/ocapi_configs/{clientId}	Data	N/A
OcapiConfigs	Added	PUT	/ocapi_configs/{clientId}	Data	N/A
Orders	Changed	DELETE	/orders/{order_no}/payment_instruments/{payment_instrument_id}	Shop	More
Products	Changed	GET	/products/({id},...,{id})	Shop	More
Products	Changed	GET	/products/{id}	Shop	More
RoleSearch	Changed	POST	/role_search	Data	More
Roles	Changed	DELETE	/roles/{id}	Data	More
Roles	Changed	PUT	/roles/{id}/users/{login}	Data	More
Sites	Added	PATCH	/sites/{site_id}/orders/{order_no}	Data	N/A
Sites	Added	PUT	/sites/{site_id}/orders/{order_no}/confirmation_status	Data	N/A
Sites	Added	PUT	/sites/{site_id}/orders/{order_no}/export_status	Data	N/A
Sites	Added	PUT	/sites/{site_id}/orders/{order_no}/external_status	Data	N/A
Sites	Added	PATCH	/sites/{site_id}/orders/{order_no}/payment_instruments/{payment_instrument_id}	Data	N/A
Sites	Added	PATCH	/sites/{site_id}/orders/{order_no}/payment_instruments/{payment_instrument_id}/transaction	Data	N/A
Sites	Added	PUT	/sites/{site_id}/orders/{order_no}/payment_status	Data	N/A
Sites	Added	PUT	/sites/{site_id}/orders/{order_no}/shipments/{shipment_id}/shipping_address	Data	N/A
Sites	Added	PUT	/sites/{site_id}/orders/{order_no}/shipping_status	Data	N/A
Sites	Added	PUT	/sites/{site_id}/orders/{order_no}/status	Data	N/A
SortingRuleSearch	Added	POST	/sites/{site_id}/sorting_rule_search	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 18.8

Document Name	Change	API	Details
AccessKeyDetails	Added	Data API	N/A
AccessKeyUpdateRequest	Added	Data API	N/A
AlertDescriptor	Added	Data API	N/A
AlertDescriptorSettings	Added	Data API	N/A
AlertDescriptors	Added	Data API	N/A
AlertDescriptorsRevalidationRequest	Added	Data API	N/A
AlertItem	Added	Data API	N/A
AlertItems	Added	Data API	N/A
AlertSettings	Added	Data API	N/A
AssignedExperiences	Added	Data API	N/A
AssignedQualifiers	Added	Data API	N/A
Assignment	Added	Data API	N/A
Basket	Changed	Shop API	More
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
ExportDataUnitsConfiguration	Added	Data API	N/A
ExportGlobalDataConfiguration	Added	Data API	N/A
ExportSitesConfiguration	Added	Data 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
OcapiConfigsApiRequest	Added	Data API	N/A
OcapiConfigsApiResponse	Added	Data API	N/A
Order	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
ProductInventoryRecordAllocation	Changed	Data API	More
ProductSearchHit	Changed	Shop API	More
Promotion	Changed	Data API	More
PromotionCampaignAssignment	Changed	Data API	More
ResourceInfo	Added	Data API	N/A
ResourceObject	Added	Data API	N/A
RoleSearchRequest	Added	Data API	N/A
SearchIndexUpdateConfiguration	Added	Data API	N/A
ShippingAddressUpdateRequest	Added	Data API	N/A
SiteArchiveExportConfiguration	Added	Data API	N/A
SiteResourceInfo	Added	Data API	N/A
SortingRule	Changed	Data API	More
SortingRuleSearchResult	Added	Data API	N/A
StatusMetadata	Added	Data API	N/A
TrustedSystemAuthRequest	Added	Shop API	N/A
Variant	Changed	Data API	More
Variant	Changed	Shop API	More
VariationGroup	Changed	Data API	More
VariationGroup	Changed	Shop API	More
VersionRangeObject	Added	Data API	N/A

Details about modified resources

The following requests have been modified since 18.8.

DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element	Change	API	18.8	23.2
Query Parameter	Added	Data	N/A	Name: rule_context Type: String Description: the optional context of the sorting rule, either "site" (default) or "global" Constraints: strings=["global", "site"]

Element

Change

API

18.8

23.2

Query Parameter

Added

Data

N/A

Name: rule_context

Type: String

Description: the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=["global", "site"]

PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element	Change	API	18.8	23.2
Query Parameter	Added	Data	N/A	Name: rule_context Type: String Description: the optional context of the sorting rule, either "site" (default) or "global" Constraints: strings=["global", "site"]

Element

Change

API

18.8

23.2

Query Parameter

Added

Data

N/A

Name: rule_context

Type: String

Description: the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=["global", "site"]

DELETE /baskets/{basket_id}

Element	Change	API	18.8	23.2
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.

Element

Change

API

18.8

23.2

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.

DELETE /baskets/{basket_id}/items/{item_id}

Element	Change	API	18.8	23.2
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)

Element

Change

API

18.8

23.2

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.

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	18.8	23.2
Fault	Added	Shop	N/A	PaymentInstrumentNotFoundException(404): Indicates that the payment instrument with the given payment instrument number is unknown. paymentInstrumentId (String)

Element

Change

API

18.8

23.2

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	18.8	23.2
Body	Changed	Data	None	PromotionCampaignAssignment

DELETE /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element	Change	API	18.8	23.2
Query Parameter	Added	Data	N/A	Name: rule_context Type: String Description: The context in which the rule lives, either "site" or "global"the optional context of the sorting rule, either "site" (default) or "global" Constraints: strings=["global", "site"]

Element

Change

API

18.8

23.2

Query Parameter

Added

Data

N/A

Name: rule_context

Type: String

Description: The context in which the rule lives, either "site" or "global"the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=["global", "site"]

PUT /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element	Change	API	18.8	23.2
Description	Changed	Data	Action to bind a single sorting rule to a given campaign. Lookup of the sorting rule is done in the site	Action to bind a single sorting rule to a given campaign.
Query Parameter	Added	Data	N/A	Name: rule_context Type: String Description: The context in which the rule lives, either "site" or "global"the optional context of the sorting rule, either "site" (default) or "global" Constraints: strings=["global", "site"]

Element

Change

API

18.8

23.2

Description

Changed

Data

Action to bind a single sorting rule to a given campaign. Lookup of the sorting rule is done in the site

Action to bind a single sorting rule to a given campaign.

Query Parameter

Added

Data

N/A

Name: rule_context

Type: String

Description: The context in which the rule lives, either "site" or "global"the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=["global", "site"]

PUT /customers/{customer_id}/password

Element	Change	API	18.8	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)

Element

Change

API

18.8

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.

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	18.8	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.

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

Element	Change	API	18.8	23.2
Fault	Added	Shop	N/A	PaymentInstrumentNotFoundException(404): Indicates that the payment instrument with the given payment instrument number is unknown. paymentInstrumentId (String)

Element

Change

API

18.8

23.2

Fault

Added

Shop

N/A

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

paymentInstrumentId (String)

GET /products/({id},...,{id})

Element	Change	API	18.8	23.2
Description	Changed	Shop	Allows to access multiple products by a single request. This convenience resource should be used instead making separated requests. This saves bandwidth and CPU time on the server. The URI is the same like requesting a single Product by id, but multiple ids wrapped by parentheses and separated can be provided. If a parenthesis or the separator is part of the identifier itself it has to be URL encoded. Instead of a single Product document a result object of Product documents is returned. Note: Only products that are online and assigned to site catalog are returned. The maximum number of ids is 50. If none of the products requested are found, the cache-control header will be defaulted to 60 seconds.	Allows to access multiple products by a single request. This convenience resource should be used instead making separated requests. This saves bandwidth and CPU time on the server. The URI is the same like requesting a single Product by id, but multiple ids wrapped by parentheses and separated can be provided. If a parenthesis or the separator is part of the identifier itself it has to be URL encoded. Instead of a single Product document a result object of Product documents is returned. Note: Only products that are online and assigned to site catalog are returned. The maximum number of ids is 24. If none of the products requested are found, the cache-control header will be defaulted to 60 seconds.
Path Parameter	Changed	Shop	Name: ids Constraints: maxItems=50, maxLength=100	Name: ids Constraints: maxItems=24, maxLength=100
Query Parameter	Changed	Shop	Name: expand Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products)	Name: expand Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations)

Element

Change

API

18.8

23.2

Description

Changed

Shop

Allows to access multiple products by a single request. This convenience resource should be used instead making separated requests. This saves bandwidth and CPU time on the server. The URI is the same like requesting a single Product by id, but multiple ids wrapped by parentheses and separated can be provided. If a parenthesis or the separator is part of the identifier itself it has to be URL encoded. Instead of a single Product document a result object of Product documents is returned. Note: Only products that are online and assigned to site catalog are returned. The maximum number of ids is 50. If none of the products requested are found, the cache-control header will be defaulted to 60 seconds.

Allows to access multiple products by a single request. This convenience resource should be used instead making separated requests. This saves bandwidth and CPU time on the server. The URI is the same like requesting a single Product by id, but multiple ids wrapped by parentheses and separated can be provided. If a parenthesis or the separator is part of the identifier itself it has to be URL encoded. Instead of a single Product document a result object of Product documents is returned. Note: Only products that are online and assigned to site catalog are returned. The maximum number of ids is 24. If none of the products requested are found, the cache-control header will be defaulted to 60 seconds.

Path Parameter

Changed

Shop

Name: ids

Constraints: maxItems=50, maxLength=100

Name: ids

Constraints: maxItems=24, maxLength=100

Query Parameter

Changed

Shop

Name: expand

Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products)

Name: expand

Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations)

GET /products/{id}

Element	Change	API	18.8	23.2
Query Parameter	Changed	Shop	Name: expand Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products)	Name: expand Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations)

Element

Change

API

18.8

23.2

Query Parameter

Changed

Shop

Name: expand

Description: The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products)

Name: expand

POST /role_search

Element	Change	API	18.8	23.2
Description	Changed	Data	Searches for access roles. The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes: id - String description - String The output of the query can also be sorted. These are the list of sortable attributes: id - String description - String	Searches for access roles. The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes: id - String description - String Optionally, a user ID (the user login) can be specified. When it is supplied, the search for roles is limited to the roles assigned to this user. When expanding the permissions for the roles, all effective permissions for this user can be retrieved. Optionally, a (single) permission can be specified. When it is supplied, the search for roles is limited to the roles having this permission. When expanding the users for the roles, all users having this permission can be retrieved. The output of the query can also be sorted. These are the list of sortable attributes: id - String description - String
Body	Changed	Data	SearchRequest	RoleSearchRequest
Fault	Added	Data	N/A	InvalidSearchQueryException(400): Throws when one of the search request restrictions is violated fault (String)

Element

Change

API

18.8

23.2

Description

Changed

Data

Searches for access roles.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

id - String
description - String

The output of the query can also be sorted. These are the list of sortable attributes:

id - String
description - String

Searches for access roles.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

id - String
description - String

Optionally, a user ID (the user login) can be specified. When it is supplied, the search for roles is limited to the roles assigned to this user. When expanding the permissions for the roles, all effective permissions for this user can be retrieved.

Optionally, a (single) permission can be specified. When it is supplied, the search for roles is limited to the roles having this permission. When expanding the users for the roles, all users having this permission can be retrieved.

The output of the query can also be sorted. These are the list of sortable attributes:

id - String
description - String

Body

Changed

Data

SearchRequest

RoleSearchRequest

Fault

Added

Data

N/A

InvalidSearchQueryException(400): Throws when one of the search request restrictions is violated

fault (String)

DELETE /roles/{id}

Element	Change	API	18.8	23.2
Fault	Added	Data	N/A	RoleNotFoundException(404): Thrown if the given role does not exist id (String)

Element

Change

API

18.8

23.2

Fault

Added

Data

N/A

RoleNotFoundException(404): Thrown if the given role does not exist

id (String)

PUT /roles/{id}/users/{login}

Element	Change	API	18.8	23.2
Fault	Added	Data	N/A	InvalidRoleException(400): Thrown if the access role with the given id does not exist. roleId (String)
Fault	Added	Data	N/A	InvalidUserLoginException(400): Thrown if a user with the given login does not exist. login (String)
Fault	Removed	Data	RoleNotFoundException(404): Thrown if the access role with the given id does not exist. id (String)	N/A
Fault	Removed	Data	UserNotFoundException(404): Thrown if a user with the given login does not exist. login (String)	N/A

Details about modified documents

The following documents have been modified since 18.8.

Basket

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

Element

Change

API

18.8

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	18.8	23.2
Property	Added	Shop	N/A	Name: parent_category_tree Type: [PathRecord] Description: List of parent categories Constraints:

Element

Change

API

18.8

23.2

Property

Added

Shop

N/A

Name: parent_category_tree

Type: [PathRecord]

Description: List of parent categories

Constraints:

Coupon

Element Change API 18.8 23.2

Property

Added

Data

N/A

Element	Change	API	18.8	23.2
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:

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	18.8	23.2
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:

Element

Change

API

18.8

23.2

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

Element

Change

API

18.8

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	18.8	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	18.8	23.2
Property	Added	Data	N/A	Name: status_metadata Type: StatusMetadata Description: The metadata of the status. Constraints:

Element

Change

API

18.8

23.2

Property

Added

Data

N/A

Name: status_metadata

Type: StatusMetadata

Description: The metadata of the status.

Constraints:

Master

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

Element

Change

API

18.8

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

Element

Change

API

18.8

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	18.8	23.2
Property	Added	Shop	N/A	Name: global_party_id Type: String Description: globalPartyId is managed by Customer 360. Its value can be changed. Constraints:
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	18.8	23.2
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	18.8	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	18.8	23.2
Property	Changed	Data	Name: amount Constraints:	Name: amount Constraints: minNumberValue=0.0

Element

Change

API

18.8

23.2

Property

Changed

Data

Name: amount

Constraints:

Name: amount

Constraints: minNumberValue=0.0

ProductSearchHit

Element

Change

API

18.8

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:

Promotion

Element	Change	API	18.8	23.2
Property	Added	Data	N/A	Name: callout_msg Type: [MarkupText] Description: The localized callout message of the promotion. Constraints:

Element

Change

API

18.8

23.2

Property

Added

Data

N/A

Name: callout_msg

Type: [MarkupText]

Description: The localized callout message of the promotion.

Constraints:

PromotionCampaignAssignment

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

SortingRule

Element	Change	API	18.8	23.2
Property	Added	Data	N/A	Name: rule_context Type: String Description: The context of the rule, either site or global Constraints:

Element

Change

API

18.8

23.2

Property

Added

Data

N/A

Name: rule_context

Type: String

Description: The context of the rule, either site or global

Constraints:

Variant

Element	Change	API	18.8	23.2
Property	Added	Data	N/A	Name: price_per_unit Type: Decimal Description: The sales price of the variant. Constraints:

Element

Change

API

18.8

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	18.8	23.2
Property	Added	Shop	N/A	Name: price_per_unit Type: Decimal Description: The sales price of the variant. Constraints:

Element

Change

API

18.8

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	18.8	23.2
Property	Added	Data	N/A	Name: price_per_unit Type: Decimal Description: The sales price per unit of the variation group. Constraints:

Element

Change

API

18.8

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

Element	Change	API	18.8	23.2
Property	Added	Shop	N/A	Name: price_per_unit Type: Decimal Description: The sales price per unit of the variation group. Constraints:

Element

Change

API

18.8

23.2

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.