Skip to content

Commit b969f91

Browse files
Apply suggestions from code review
Co-authored-by: rahinisrinivas <[email protected]>
1 parent d9b9872 commit b969f91

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

Diff for: changelog/2024/2024-09-18-changelog.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ tags: ['Commerce Extensions']
55
hide_blog_post_date: false
66
---
77

8-
**MINOR** We have introduced the ability to configure if a Custom Field is `immutable`, to allow you to better align your Custom API with your business needs. When set to true, the value of this field can be specified only during POST requests and cannot be modified during PUT requests. For more information, see [Custom Fields](/docs/api/commerce-extensions/custom-fields#immutable).
8+
**MINOR** We have introduced the ability to configure a Custom Field as `immutable`, allowing you to better align your Custom API with your business needs. When set to true, the value of this field can be specified only during POST requests and cannot be modified during PUT requests. For more information, see [Custom Fields](/docs/api/commerce-extensions/custom-fields#immutable).

Diff for: guides/How-To/commerce-extensions/create-a-multilocation-inventories-resource.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ curl -X POST "https://useast.api.elasticpath.com/v2/settings/extensions/custom-a
4141
}
4242
```
4343

44-
Make sure to take note of the Custom API ID [returned](/docs/api/commerce-extensions/create-a-custom-api#responses), you must replace `:customApiId` in the following step with the Custom API ID. In addition, notice that `data.allow_upserts` is set to `true`, this allows to perform [upserts](/guides/How-To/commerce-extensions/create-a-multilocation-inventories-resource#update-custom-api-entries) of Custom API Entries.
44+
Make sure to take note of the Custom API ID [returned](/docs/api/commerce-extensions/create-a-custom-api#responses), you must replace `:customApiId` in the following step with the Custom API ID. Additionally, ensure that `data.allow_upserts` is set to `true`, this allows to perform [upserts](/guides/How-To/commerce-extensions/create-a-multilocation-inventories-resource#update-custom-api-entries) for Custom API Entries.
4545

4646
## Create Custom Fields
4747

@@ -190,7 +190,7 @@ Notice that the resource identifier in the request above is one that should be w
190190

191191
## Upsert Custom API Entries
192192

193-
To further simplify and optimize your data import and synchronization processes you can upsert Custom API Entries. Instead of first having to check whether a record exists and then deciding to create or update a Custom API Entries, you can upsert a record, if it exists it is updated, and if it doesn't, then it is inserted or created. This is made possible by your setting of `allow_upserts` when you [created this Custom API](/guides/How-To/commerce-extensions/create-a-multilocation-inventories-resource#create-a-new-custom-api---location-inventories).
193+
To further simplify and optimize your data import and synchronization processes, you can upsert Custom API Entries. Instead of first checking whether a record exists before deciding to create or update a Custom API Entries, you can upsert a record. If the record exists, it is updated; if it doesn't, it is inserted or created. This is enabled by setting `allow_upserts` when you [created this Custom API](/guides/How-To/commerce-extensions/create-a-multilocation-inventories-resource#create-a-new-custom-api---location-inventories).
194194

195195
```sh
196196
curl -X PUT "https://useast.api.elasticpath.com/v2/extensions/location-inventories/FURN-SOFA-3S-LTH-BLK-0021" \

Diff for: openapispecs/commerceextensions/OpenAPISpec.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ tags:
157157
158158
### Immutable
159159
160-
When [creating](/docs/api/commerce-extensions/create-a-custom-field#request) a Custom Field it can be configured to be `immutable`. When set to true, the value of this field can be specified only during POST requests and cannot be modified during PUT requests. By default, this is `false`.
160+
When [creating](/docs/api/commerce-extensions/create-a-custom-field#request) a Custom Field, it can be configured to be `immutable`. When set to true, the value of this field can be specified only during POST requests and cannot be modified during PUT requests. By default, this is `false`.
161161
162162
sample validation object :
163163
@@ -173,7 +173,7 @@ tags:
173173
174174
## Presentation
175175
176-
When [creating](/docs/api/commerce-extensions/create-a-custom-field#request) or [updating](/docs/api/commerce-extensions/update-a-custom-field#request) a Custom Field, `presentation` can be used to influence the layout of fields within a Custom API in User Interface. It does not order or affect the JSON response, and has no semantics on the back end.
176+
When [creating](/docs/api/commerce-extensions/create-a-custom-field#request) or [updating](/docs/api/commerce-extensions/update-a-custom-field#request) a Custom Field, `presentation` can be used to influence the layout of fields within a Custom API in User Interface. It does not order or affect the JSON response, and has no semantics on the backend.
177177
178178
## Reserved Slugs
179179

0 commit comments

Comments
 (0)