OCAPI 23.1 changes since 21.6

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

Resources added, modified, or removed since 21.6

Resource Name Change Http Method URL Template API Details
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.6

Document Name Change API Details
AccessKeyDetails Added Data API N/A
AccessKeyUpdateRequest Added Data API N/A
Coupon Changed Data API More
JobExecution Changed Data API More
MetricResponse Added Data API N/A
Order Changed Shop API More
ProductInventoryRecordAllocation Changed Data API More

Details about modified resources

The following requests have been modified since 21.6.

Details about modified documents

The following documents have been modified since 21.6.

Coupon

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

JobExecution

Element Change API 21.6 23.1
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.6 23.1
Property Added Shop N/A

Name: guest

Type: boolean

Description: The registration status of the customer.

Constraints:

ProductInventoryRecordAllocation

Element Change API 21.6 23.1
Property Changed Data

Name: amount

Constraints:

Name: amount

Constraints: minNumberValue=0.0

© Copyright 2000-2023, Salesforce, Inc. All rights reserved. Various trademarks held by their respective owners.

 Show URL Submit FeedbackPrivacy Policy
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.
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.