@salesforce/b2c-tooling-sdk 2.4.0 → 2.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/schemas/dw.schema.json +14 -0
- package/data/tooling/index.json +5 -5
- package/dist/esm/cli/base-command.js +4 -3
- package/dist/esm/cli/base-command.js.map +1 -1
- package/dist/esm/cli/cartridge-command.js +2 -1
- package/dist/esm/cli/cartridge-command.js.map +1 -1
- package/dist/esm/cli/config.js +3 -1
- package/dist/esm/cli/config.js.map +1 -1
- package/dist/esm/cli/hooks.d.ts +13 -0
- package/dist/esm/cli/hooks.js +11 -0
- package/dist/esm/cli/hooks.js.map +1 -1
- package/dist/esm/cli/instance-command.js +2 -1
- package/dist/esm/cli/instance-command.js.map +1 -1
- package/dist/esm/clients/scapi-backend-utils.d.ts +15 -0
- package/dist/esm/clients/scapi-backend-utils.js +28 -1
- package/dist/esm/clients/scapi-backend-utils.js.map +1 -1
- package/dist/esm/clients/scapi-fallback-backend.js +2 -2
- package/dist/esm/clients/scapi-fallback-backend.js.map +1 -1
- package/dist/esm/clients/scapi-schemas.generated.d.ts +2 -2
- package/dist/esm/compat/dispatcher.js +2 -2
- package/dist/esm/compat/dispatcher.js.map +1 -1
- package/dist/esm/config/config-origins.d.ts +19 -0
- package/dist/esm/config/config-origins.js +11 -0
- package/dist/esm/config/config-origins.js.map +1 -0
- package/dist/esm/config/config-write.d.ts +86 -0
- package/dist/esm/config/config-write.js +296 -0
- package/dist/esm/config/config-write.js.map +1 -0
- package/dist/esm/config/dw-json-schema.js +4 -0
- package/dist/esm/config/dw-json-schema.js.map +1 -1
- package/dist/esm/config/dw-json.d.ts +2 -0
- package/dist/esm/config/dw-json.js +10 -6
- package/dist/esm/config/dw-json.js.map +1 -1
- package/dist/esm/config/index.d.ts +8 -3
- package/dist/esm/config/index.js +5 -2
- package/dist/esm/config/index.js.map +1 -1
- package/dist/esm/config/instance-manager.d.ts +64 -28
- package/dist/esm/config/instance-manager.js +145 -63
- package/dist/esm/config/instance-manager.js.map +1 -1
- package/dist/esm/config/mapping.js +6 -0
- package/dist/esm/config/mapping.js.map +1 -1
- package/dist/esm/config/resolver.d.ts +22 -0
- package/dist/esm/config/resolver.js +54 -29
- package/dist/esm/config/resolver.js.map +1 -1
- package/dist/esm/config/sources/dw-json-source.d.ts +9 -1
- package/dist/esm/config/sources/dw-json-source.js +34 -20
- package/dist/esm/config/sources/dw-json-source.js.map +1 -1
- package/dist/esm/config/sources/env-source.d.ts +30 -3
- package/dist/esm/config/sources/env-source.js +126 -1
- package/dist/esm/config/sources/env-source.js.map +1 -1
- package/dist/esm/config/types.d.ts +46 -0
- package/dist/esm/operations/jobs/run-system-job.js +2 -2
- package/dist/esm/operations/jobs/run-system-job.js.map +1 -1
- package/dist/esm/plugins/discovery.js +2 -1
- package/dist/esm/plugins/discovery.js.map +1 -1
- package/dist/esm/scapi/index.d.ts +5 -2
- package/dist/esm/scapi/index.js +3 -2
- package/dist/esm/scapi/index.js.map +1 -1
- package/dist/esm/scapi/live.d.ts +12 -1
- package/dist/esm/scapi/live.js +30 -2
- package/dist/esm/scapi/live.js.map +1 -1
- package/dist/esm/scapi/local.d.ts +17 -0
- package/dist/esm/scapi/local.js +68 -16
- package/dist/esm/scapi/local.js.map +1 -1
- package/dist/esm/scapi/request.d.ts +2 -2
- package/dist/esm/scapi/request.js +2 -1
- package/dist/esm/scapi/request.js.map +1 -1
- package/dist/esm/scapi/runtime.d.ts +5 -0
- package/dist/esm/scapi/runtime.js.map +1 -1
- package/dist/esm/scapi/schema-source.d.ts +90 -0
- package/dist/esm/scapi/schema-source.js +146 -0
- package/dist/esm/scapi/schema-source.js.map +1 -0
- package/dist/esm/scapi/worker-source.js +30 -6
- package/dist/esm/scapi/worker-source.js.map +1 -1
- package/dist/esm/test-utils/config-isolation.js +9 -2
- package/dist/esm/test-utils/config-isolation.js.map +1 -1
- package/node_modules/@salesforce/b2c-api-schemas/manifest.json +83 -42
- package/node_modules/@salesforce/b2c-api-schemas/package.json +1 -1
- package/node_modules/@salesforce/b2c-api-schemas/scapi/cdn/zones/v1.json +6798 -238
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/orders/v1.json +2296 -205
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v1.json +5571 -666
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v2.json +6062 -371
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-orders/v1.json +3426 -360
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-payments/v1.json +351 -99
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json +172 -12
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/preferences/v1.json +1497 -111
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/shopper-configurations/v1.json +202 -36
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json +79 -10
- package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/custom-objects/v1.json +785 -49
- package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/shopper-custom-objects/v1.json +191 -40
- package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/customers/v1.json +1483 -107
- package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/shopper-customers/v1.json +4854 -787
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/custom-apis/v1.json +119 -15
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/object-definitions/v1.json +1699 -80
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scapi-schemas/v1.json +252 -18
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scripts/v1.json +329 -23
- package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/experiences/v1.json +4208 -234
- package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/shopper-experience/v1.json +1591 -247
- package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json +396 -8
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/availability/v1.json +1242 -69
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/impex/v1.json +2354 -248
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/reservation/v1.json +1550 -45
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/segmentation/v1.json +6615 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/roles/v1.json +1520 -59
- package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/users/v1.json +397 -17
- package/node_modules/@salesforce/b2c-api-schemas/scapi/observability/metrics/v1.json +1241 -27
- package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/jobs/v1.json +1069 -68
- package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/replications/v1.json +410 -23
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/assignments/v1.json +502 -102
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/campaigns/v1.json +1112 -94
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/coupons/v1.json +820 -93
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/gift-certificates/v1.json +845 -92
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/promotions/v1.json +2716 -674
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-gift-certificates/v1.json +130 -47
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-promotions/v1.json +233 -63
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/source-code-groups/v1.json +630 -70
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/catalogs/v1.json +2886 -348
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/inventory-lists/v1.json +520 -19
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/price-books/v1.json +3115 -293
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/products/v1.json +3313 -138
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-availability/v1.json +266 -52
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-delivery-estimates/v1.json +256 -48
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-products/v1.json +1744 -306
- package/node_modules/@salesforce/b2c-api-schemas/scapi/search/shopper-search/v1.json +1661 -120
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth/v1.json +2174 -118
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth-admin/v1.json +1373 -24
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json +531 -20
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-agents/v1.json +154 -6
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-consents/v1.json +596 -79
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-context/v1.json +456 -42
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json +101 -23
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json +184 -41
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/sites/v1.json +995 -47
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/shopper-stores/v1.json +370 -67
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/store-redirect-mappings/v1.json +319 -11
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/stores/v1.json +1109 -64
- package/node_modules/@salesforce/b2c-api-schemas/scapi/storefront/deployments/v1.json +1442 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/storefront/environments/v1.json +4293 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/storefront/storefronts/v1.json +1371 -0
- package/package.json +2 -2
- package/specs/scapi-schemas-v1.yaml +4 -1
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Object Definitions",
|
|
5
|
-
"
|
|
5
|
+
"description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/object-definitions/object-definitions-oas-v1-public.yaml)\n\n# API Overview\n\nUse the Object Definitions API to search for and manage attribute definitions\nfor object types in B2C Commerce. Discover and\ninspect the metadata structure of objects such as Product, Customer, and Order.\n\nUse this API to:\n- Search attribute definitions with complex queries\n- Filter by attribute properties (type, searchability, visibility, etc.)\n- Retrieve detailed metadata about attribute definitions\n- Discover available values for enum-type attributes\n\n## Authentication & Authorization\n\nThe Object Definitions API requires valid authentication and authorization to be accessed. It uses an Account Manager OAuth 2.0 bearer token for authentication. \n\nThe necessary scope for accessing the Object Definitions API is:\n\n* `sfcc.object-definitions.rw`: Provides read-write access.\n\nYou must include the relevant scope in the client ID used to generate the token. For details, see [Authorization Scopes Catalog](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html).\n\n## Response Details\n\n### Timeouts\n\nAdmin API requests must respond within 60 seconds. If a response exceeds this threshold, an HTTP 504 status code is returned. For details, see [Timeouts and Limits.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/timeouts-limits.html)\n\n### Error Handling\n\nError responses follow the [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail format. To trace errors, include a `correlation-id` header in your request — the response returns it as `x-correlation-id`. For details, see [HTTP Status Codes and Errors.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/error-response-codes.html)",
|
|
6
|
+
"version": "1.1.3",
|
|
6
7
|
"x-api-type": "Admin",
|
|
7
8
|
"x-api-family": "DX"
|
|
8
9
|
},
|
|
@@ -11,6 +12,7 @@
|
|
|
11
12
|
"url": "https://{shortCode}.api.commercecloud.salesforce.com/dx/object-definitions/v1",
|
|
12
13
|
"variables": {
|
|
13
14
|
"shortCode": {
|
|
15
|
+
"description": "An eight-character string assigned to a realm for routing purposes. See [Base URL and Request Formation.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html)",
|
|
14
16
|
"default": "shortCode"
|
|
15
17
|
}
|
|
16
18
|
}
|
|
@@ -19,17 +21,21 @@
|
|
|
19
21
|
"paths": {
|
|
20
22
|
"/organizations/{organizationId}/system/object-types": {
|
|
21
23
|
"get": {
|
|
24
|
+
"summary": "Get system object types",
|
|
25
|
+
"description": "Retrieves a paginated list of all system object type definitions.\n\nUse the `select` parameter to specify which properties to include in the response.\nUse `offset` and `limit` for pagination.\n",
|
|
22
26
|
"operationId": "getSystemObjectTypes",
|
|
23
27
|
"parameters": [
|
|
24
28
|
{
|
|
25
29
|
"name": "organizationId",
|
|
26
30
|
"in": "path",
|
|
31
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
27
32
|
"required": true,
|
|
28
33
|
"style": "simple",
|
|
29
34
|
"explode": false,
|
|
30
35
|
"schema": {
|
|
31
36
|
"$ref": "#/components/schemas/OrganizationId"
|
|
32
|
-
}
|
|
37
|
+
},
|
|
38
|
+
"example": "f_ecom_zzxy_prd"
|
|
33
39
|
},
|
|
34
40
|
{
|
|
35
41
|
"name": "select",
|
|
@@ -39,11 +45,17 @@
|
|
|
39
45
|
"explode": true,
|
|
40
46
|
"schema": {
|
|
41
47
|
"$ref": "#/components/schemas/Select"
|
|
48
|
+
},
|
|
49
|
+
"examples": {
|
|
50
|
+
"select": {
|
|
51
|
+
"value": "(**)"
|
|
52
|
+
}
|
|
42
53
|
}
|
|
43
54
|
},
|
|
44
55
|
{
|
|
45
56
|
"name": "limit",
|
|
46
57
|
"in": "query",
|
|
58
|
+
"description": "Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 25.",
|
|
47
59
|
"required": false,
|
|
48
60
|
"style": "form",
|
|
49
61
|
"explode": true,
|
|
@@ -58,6 +70,7 @@
|
|
|
58
70
|
{
|
|
59
71
|
"name": "offset",
|
|
60
72
|
"in": "query",
|
|
73
|
+
"description": "Used to retrieve the results based on a particular resource offset.",
|
|
61
74
|
"required": false,
|
|
62
75
|
"style": "form",
|
|
63
76
|
"explode": true,
|
|
@@ -76,6 +89,11 @@
|
|
|
76
89
|
"application/json": {
|
|
77
90
|
"schema": {
|
|
78
91
|
"$ref": "#/components/schemas/ObjectTypeDefinitionResult"
|
|
92
|
+
},
|
|
93
|
+
"examples": {
|
|
94
|
+
"SystemObjectTypeResultExample": {
|
|
95
|
+
"$ref": "#/components/examples/SystemObjectTypeResultExample"
|
|
96
|
+
}
|
|
79
97
|
}
|
|
80
98
|
}
|
|
81
99
|
}
|
|
@@ -92,6 +110,11 @@
|
|
|
92
110
|
"application/problem+json": {
|
|
93
111
|
"schema": {
|
|
94
112
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
113
|
+
},
|
|
114
|
+
"examples": {
|
|
115
|
+
"ObjectTypeNotFoundExample": {
|
|
116
|
+
"$ref": "#/components/examples/ObjectTypeNotFoundExample"
|
|
117
|
+
}
|
|
95
118
|
}
|
|
96
119
|
}
|
|
97
120
|
}
|
|
@@ -109,24 +132,34 @@
|
|
|
109
132
|
},
|
|
110
133
|
"/organizations/{organizationId}/system/object-types-search": {
|
|
111
134
|
"post": {
|
|
135
|
+
"summary": "Search system object types",
|
|
136
|
+
"description": "Searches system object type definitions based on the provided query criteria.\n\n**Searchable fields:**\n- objectType (String)\n- display_name* (Localized String)\n- description* (Localized String)\n- read_only (boolean)\n\n**Sortable fields:**\n- objectType\n- display_name\n- description\n- read_only\n\n*Note: Localized fields are searched across all locales.\n",
|
|
112
137
|
"operationId": "searchSystemObjectTypes",
|
|
113
138
|
"parameters": [
|
|
114
139
|
{
|
|
115
140
|
"name": "organizationId",
|
|
116
141
|
"in": "path",
|
|
142
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
117
143
|
"required": true,
|
|
118
144
|
"style": "simple",
|
|
119
145
|
"explode": false,
|
|
120
146
|
"schema": {
|
|
121
147
|
"$ref": "#/components/schemas/OrganizationId"
|
|
122
|
-
}
|
|
148
|
+
},
|
|
149
|
+
"example": "f_ecom_zzxy_prd"
|
|
123
150
|
}
|
|
124
151
|
],
|
|
125
152
|
"requestBody": {
|
|
153
|
+
"description": "The search request for system object types",
|
|
126
154
|
"content": {
|
|
127
155
|
"application/json": {
|
|
128
156
|
"schema": {
|
|
129
157
|
"$ref": "#/components/schemas/SearchRequest"
|
|
158
|
+
},
|
|
159
|
+
"examples": {
|
|
160
|
+
"SearchSystemObjectTypes": {
|
|
161
|
+
"$ref": "#/components/examples/SearchSystemObjectTypes"
|
|
162
|
+
}
|
|
130
163
|
}
|
|
131
164
|
}
|
|
132
165
|
},
|
|
@@ -139,6 +172,11 @@
|
|
|
139
172
|
"application/json": {
|
|
140
173
|
"schema": {
|
|
141
174
|
"$ref": "#/components/schemas/ObjectTypeDefinitionSearchResult"
|
|
175
|
+
},
|
|
176
|
+
"examples": {
|
|
177
|
+
"SystemObjectTypeSearchResultExample": {
|
|
178
|
+
"$ref": "#/components/examples/SystemObjectTypeSearchResultExample"
|
|
179
|
+
}
|
|
142
180
|
}
|
|
143
181
|
}
|
|
144
182
|
}
|
|
@@ -149,6 +187,11 @@
|
|
|
149
187
|
"application/problem+json": {
|
|
150
188
|
"schema": {
|
|
151
189
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
190
|
+
},
|
|
191
|
+
"examples": {
|
|
192
|
+
"FieldNotSortableExample": {
|
|
193
|
+
"$ref": "#/components/examples/FieldNotSortableExample"
|
|
194
|
+
}
|
|
152
195
|
}
|
|
153
196
|
}
|
|
154
197
|
}
|
|
@@ -172,26 +215,32 @@
|
|
|
172
215
|
},
|
|
173
216
|
"/organizations/{organizationId}/system/object-types/{objectType}": {
|
|
174
217
|
"get": {
|
|
218
|
+
"summary": "Get system object type",
|
|
219
|
+
"description": "Retrieves a single system object type definition by its identifier.\n\nUse the `select` parameter to specify which properties to include in the response.\nUse the `expand` parameter to include related resources.\n",
|
|
175
220
|
"operationId": "getSystemObjectType",
|
|
176
221
|
"parameters": [
|
|
177
222
|
{
|
|
178
223
|
"name": "organizationId",
|
|
179
224
|
"in": "path",
|
|
225
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
180
226
|
"required": true,
|
|
181
227
|
"style": "simple",
|
|
182
228
|
"explode": false,
|
|
183
229
|
"schema": {
|
|
184
230
|
"$ref": "#/components/schemas/OrganizationId"
|
|
185
|
-
}
|
|
231
|
+
},
|
|
232
|
+
"example": "f_ecom_zzxy_prd"
|
|
186
233
|
},
|
|
187
234
|
{
|
|
188
235
|
"name": "objectType",
|
|
189
236
|
"in": "path",
|
|
237
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
190
238
|
"required": true,
|
|
191
239
|
"style": "simple",
|
|
192
240
|
"explode": false,
|
|
193
241
|
"schema": {
|
|
194
242
|
"type": "string",
|
|
243
|
+
"example": "Product",
|
|
195
244
|
"maxLength": 256,
|
|
196
245
|
"minLength": 1
|
|
197
246
|
}
|
|
@@ -204,6 +253,11 @@
|
|
|
204
253
|
"application/json": {
|
|
205
254
|
"schema": {
|
|
206
255
|
"$ref": "#/components/schemas/ObjectTypeDefinition"
|
|
256
|
+
},
|
|
257
|
+
"examples": {
|
|
258
|
+
"SystemObjectTypeExample": {
|
|
259
|
+
"$ref": "#/components/examples/SystemObjectTypeExample"
|
|
260
|
+
}
|
|
207
261
|
}
|
|
208
262
|
}
|
|
209
263
|
}
|
|
@@ -220,6 +274,11 @@
|
|
|
220
274
|
"application/problem+json": {
|
|
221
275
|
"schema": {
|
|
222
276
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
277
|
+
},
|
|
278
|
+
"examples": {
|
|
279
|
+
"ObjectTypeNotFoundExample": {
|
|
280
|
+
"$ref": "#/components/examples/ObjectTypeNotFoundExample"
|
|
281
|
+
}
|
|
223
282
|
}
|
|
224
283
|
}
|
|
225
284
|
}
|
|
@@ -237,36 +296,51 @@
|
|
|
237
296
|
},
|
|
238
297
|
"/organizations/{organizationId}/system/object-types/{objectType}/attribute-definition-search": {
|
|
239
298
|
"post": {
|
|
299
|
+
"summary": "Search attribute definitions for system object",
|
|
300
|
+
"description": "Searches the attribute definitions of the specified system object type.\n\nThe query attribute specifies a complex query that can be used to narrow down the search. \nAttributes are grouped into different buckets:\n\n**Main bucket:**\n- id (String)\n- display_name* (Localized String)\n- description* (Localized String)\n- key (boolean)\n- mandatory (boolean)\n- searchable (boolean)\n- system (boolean)\n- visible (boolean)\n\n**Definition version bucket:**\n- localizable (boolean)\n- site_specific (boolean)\n- value_type (enum)\n\n**Group bucket:**\n- group (String)\n\n*Note: These attributes are not searchable or sortable for built-in system attributes. \nThey work normally for non-system attributes.\n\nOnly attributes in the same bucket can be joined using a disjunction (OR). \nFor instance, when joining localizable and description, only a conjunction is allowed (AND).\n",
|
|
240
301
|
"operationId": "searchAttributeDefinitionForSystemObject",
|
|
241
302
|
"parameters": [
|
|
242
303
|
{
|
|
243
304
|
"name": "organizationId",
|
|
244
305
|
"in": "path",
|
|
306
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
245
307
|
"required": true,
|
|
246
308
|
"style": "simple",
|
|
247
309
|
"explode": false,
|
|
248
310
|
"schema": {
|
|
249
311
|
"$ref": "#/components/schemas/OrganizationId"
|
|
250
|
-
}
|
|
312
|
+
},
|
|
313
|
+
"example": "f_ecom_zzxy_prd"
|
|
251
314
|
},
|
|
252
315
|
{
|
|
253
316
|
"name": "objectType",
|
|
254
317
|
"in": "path",
|
|
318
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
255
319
|
"required": true,
|
|
256
320
|
"style": "simple",
|
|
257
321
|
"explode": false,
|
|
258
322
|
"schema": {
|
|
259
323
|
"type": "string",
|
|
324
|
+
"example": "Product",
|
|
260
325
|
"maxLength": 256,
|
|
261
326
|
"minLength": 1
|
|
262
327
|
}
|
|
263
328
|
}
|
|
264
329
|
],
|
|
265
330
|
"requestBody": {
|
|
331
|
+
"description": "The search request for attribute definitions",
|
|
266
332
|
"content": {
|
|
267
333
|
"application/json": {
|
|
268
334
|
"schema": {
|
|
269
335
|
"$ref": "#/components/schemas/SearchRequest"
|
|
336
|
+
},
|
|
337
|
+
"examples": {
|
|
338
|
+
"SearchByValueType": {
|
|
339
|
+
"$ref": "#/components/examples/SearchByValueType"
|
|
340
|
+
},
|
|
341
|
+
"SearchWithSorting": {
|
|
342
|
+
"$ref": "#/components/examples/SearchWithSorting"
|
|
343
|
+
}
|
|
270
344
|
}
|
|
271
345
|
}
|
|
272
346
|
},
|
|
@@ -279,6 +353,11 @@
|
|
|
279
353
|
"application/json": {
|
|
280
354
|
"schema": {
|
|
281
355
|
"$ref": "#/components/schemas/ObjectAttributeDefinitionSearchResult"
|
|
356
|
+
},
|
|
357
|
+
"examples": {
|
|
358
|
+
"ObjectAttributeDefinitionSearchResultExample": {
|
|
359
|
+
"$ref": "#/components/examples/ObjectAttributeDefinitionSearchResultExample"
|
|
360
|
+
}
|
|
282
361
|
}
|
|
283
362
|
}
|
|
284
363
|
}
|
|
@@ -289,6 +368,11 @@
|
|
|
289
368
|
"application/problem+json": {
|
|
290
369
|
"schema": {
|
|
291
370
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
371
|
+
},
|
|
372
|
+
"examples": {
|
|
373
|
+
"FieldNotSortableExample": {
|
|
374
|
+
"$ref": "#/components/examples/FieldNotSortableExample"
|
|
375
|
+
}
|
|
292
376
|
}
|
|
293
377
|
}
|
|
294
378
|
}
|
|
@@ -305,6 +389,11 @@
|
|
|
305
389
|
"application/problem+json": {
|
|
306
390
|
"schema": {
|
|
307
391
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
392
|
+
},
|
|
393
|
+
"examples": {
|
|
394
|
+
"ObjectTypeNotFoundExample": {
|
|
395
|
+
"$ref": "#/components/examples/ObjectTypeNotFoundExample"
|
|
396
|
+
}
|
|
308
397
|
}
|
|
309
398
|
}
|
|
310
399
|
}
|
|
@@ -321,36 +410,51 @@
|
|
|
321
410
|
},
|
|
322
411
|
"/organizations/{organizationId}/system/object-types/{objectType}/attribute-group-search": {
|
|
323
412
|
"post": {
|
|
413
|
+
"summary": "Search attribute groups for system object",
|
|
414
|
+
"description": "Searches the attribute groups of the specified system object type.\n\n**Searchable fields:**\n- id (String)\n- display_name (Localized String)\n- description (Localized String)\n- internal (boolean)\n- position (number)\n\n**Sortable fields:**\n- id\n- display_name\n- description\n- internal\n- position\n",
|
|
324
415
|
"operationId": "searchAttributeGroupsForSystemObject",
|
|
325
416
|
"parameters": [
|
|
326
417
|
{
|
|
327
418
|
"name": "organizationId",
|
|
328
419
|
"in": "path",
|
|
420
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
329
421
|
"required": true,
|
|
330
422
|
"style": "simple",
|
|
331
423
|
"explode": false,
|
|
332
424
|
"schema": {
|
|
333
425
|
"$ref": "#/components/schemas/OrganizationId"
|
|
334
|
-
}
|
|
426
|
+
},
|
|
427
|
+
"example": "f_ecom_zzxy_prd"
|
|
335
428
|
},
|
|
336
429
|
{
|
|
337
430
|
"name": "objectType",
|
|
338
431
|
"in": "path",
|
|
432
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
339
433
|
"required": true,
|
|
340
434
|
"style": "simple",
|
|
341
435
|
"explode": false,
|
|
342
436
|
"schema": {
|
|
343
437
|
"type": "string",
|
|
438
|
+
"example": "Product",
|
|
344
439
|
"maxLength": 256,
|
|
345
440
|
"minLength": 1
|
|
346
441
|
}
|
|
347
442
|
}
|
|
348
443
|
],
|
|
349
444
|
"requestBody": {
|
|
445
|
+
"description": "The search request for attribute groups",
|
|
350
446
|
"content": {
|
|
351
447
|
"application/json": {
|
|
352
448
|
"schema": {
|
|
353
449
|
"$ref": "#/components/schemas/SearchRequest"
|
|
450
|
+
},
|
|
451
|
+
"examples": {
|
|
452
|
+
"SearchAttributeGroups": {
|
|
453
|
+
"$ref": "#/components/examples/SearchAttributeGroups"
|
|
454
|
+
},
|
|
455
|
+
"SearchAttributeGroupsByDisplayName": {
|
|
456
|
+
"$ref": "#/components/examples/SearchAttributeGroupsByDisplayName"
|
|
457
|
+
}
|
|
354
458
|
}
|
|
355
459
|
}
|
|
356
460
|
},
|
|
@@ -363,6 +467,11 @@
|
|
|
363
467
|
"application/json": {
|
|
364
468
|
"schema": {
|
|
365
469
|
"$ref": "#/components/schemas/ObjectAttributeGroupSearchResult"
|
|
470
|
+
},
|
|
471
|
+
"examples": {
|
|
472
|
+
"ObjectAttributeGroupSearchResultExample": {
|
|
473
|
+
"$ref": "#/components/examples/ObjectAttributeGroupSearchResultExample"
|
|
474
|
+
}
|
|
366
475
|
}
|
|
367
476
|
}
|
|
368
477
|
}
|
|
@@ -373,6 +482,11 @@
|
|
|
373
482
|
"application/problem+json": {
|
|
374
483
|
"schema": {
|
|
375
484
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
485
|
+
},
|
|
486
|
+
"examples": {
|
|
487
|
+
"MalformedSearchParameterExample": {
|
|
488
|
+
"$ref": "#/components/examples/FieldNotSortableExample"
|
|
489
|
+
}
|
|
376
490
|
}
|
|
377
491
|
}
|
|
378
492
|
}
|
|
@@ -389,6 +503,11 @@
|
|
|
389
503
|
"application/problem+json": {
|
|
390
504
|
"schema": {
|
|
391
505
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
506
|
+
},
|
|
507
|
+
"examples": {
|
|
508
|
+
"ObjectTypeNotFoundExample": {
|
|
509
|
+
"$ref": "#/components/examples/ObjectTypeNotFoundExample"
|
|
510
|
+
}
|
|
392
511
|
}
|
|
393
512
|
}
|
|
394
513
|
}
|
|
@@ -405,26 +524,32 @@
|
|
|
405
524
|
},
|
|
406
525
|
"/organizations/{organizationId}/system/object-types/{objectType}/attribute-groups": {
|
|
407
526
|
"get": {
|
|
527
|
+
"summary": "Get attribute groups",
|
|
528
|
+
"description": "Retrieves a paginated list of attribute groups for the specified system object type.\n\nUse the `select` parameter to specify which properties to include in the response.\nUse the `expand` parameter with value `definition` to include attribute definitions.\nUse `offset` and `limit` for pagination.\n",
|
|
408
529
|
"operationId": "getAttributeGroups",
|
|
409
530
|
"parameters": [
|
|
410
531
|
{
|
|
411
532
|
"name": "organizationId",
|
|
412
533
|
"in": "path",
|
|
534
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
413
535
|
"required": true,
|
|
414
536
|
"style": "simple",
|
|
415
537
|
"explode": false,
|
|
416
538
|
"schema": {
|
|
417
539
|
"$ref": "#/components/schemas/OrganizationId"
|
|
418
|
-
}
|
|
540
|
+
},
|
|
541
|
+
"example": "f_ecom_zzxy_prd"
|
|
419
542
|
},
|
|
420
543
|
{
|
|
421
544
|
"name": "objectType",
|
|
422
545
|
"in": "path",
|
|
546
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
423
547
|
"required": true,
|
|
424
548
|
"style": "simple",
|
|
425
549
|
"explode": false,
|
|
426
550
|
"schema": {
|
|
427
551
|
"type": "string",
|
|
552
|
+
"example": "Product",
|
|
428
553
|
"maxLength": 256,
|
|
429
554
|
"minLength": 1
|
|
430
555
|
}
|
|
@@ -437,22 +562,30 @@
|
|
|
437
562
|
"explode": true,
|
|
438
563
|
"schema": {
|
|
439
564
|
"$ref": "#/components/schemas/Select"
|
|
565
|
+
},
|
|
566
|
+
"examples": {
|
|
567
|
+
"select": {
|
|
568
|
+
"value": "(**)"
|
|
569
|
+
}
|
|
440
570
|
}
|
|
441
571
|
},
|
|
442
572
|
{
|
|
443
573
|
"name": "expand",
|
|
444
574
|
"in": "query",
|
|
575
|
+
"description": "Specifies which related resources to include in the response.\nFor attribute groups, use `definition` to include attribute definitions.\n",
|
|
445
576
|
"required": false,
|
|
446
577
|
"style": "form",
|
|
447
578
|
"explode": true,
|
|
448
579
|
"schema": {
|
|
449
580
|
"type": "string",
|
|
581
|
+
"example": "definition",
|
|
450
582
|
"maxLength": 256
|
|
451
583
|
}
|
|
452
584
|
},
|
|
453
585
|
{
|
|
454
586
|
"name": "limit",
|
|
455
587
|
"in": "query",
|
|
588
|
+
"description": "Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 25.",
|
|
456
589
|
"required": false,
|
|
457
590
|
"style": "form",
|
|
458
591
|
"explode": true,
|
|
@@ -467,6 +600,7 @@
|
|
|
467
600
|
{
|
|
468
601
|
"name": "offset",
|
|
469
602
|
"in": "query",
|
|
603
|
+
"description": "Used to retrieve the results based on a particular resource offset.",
|
|
470
604
|
"required": false,
|
|
471
605
|
"style": "form",
|
|
472
606
|
"explode": true,
|
|
@@ -485,6 +619,11 @@
|
|
|
485
619
|
"application/json": {
|
|
486
620
|
"schema": {
|
|
487
621
|
"$ref": "#/components/schemas/ObjectAttributeGroupResult"
|
|
622
|
+
},
|
|
623
|
+
"examples": {
|
|
624
|
+
"ObjectAttributeGroupResultExample": {
|
|
625
|
+
"$ref": "#/components/examples/ObjectAttributeGroupResultExample"
|
|
626
|
+
}
|
|
488
627
|
}
|
|
489
628
|
}
|
|
490
629
|
}
|
|
@@ -501,6 +640,11 @@
|
|
|
501
640
|
"application/problem+json": {
|
|
502
641
|
"schema": {
|
|
503
642
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
643
|
+
},
|
|
644
|
+
"examples": {
|
|
645
|
+
"ObjectTypeNotFoundExample": {
|
|
646
|
+
"$ref": "#/components/examples/ObjectTypeNotFoundExample"
|
|
647
|
+
}
|
|
504
648
|
}
|
|
505
649
|
}
|
|
506
650
|
}
|
|
@@ -518,26 +662,32 @@
|
|
|
518
662
|
},
|
|
519
663
|
"/organizations/{organizationId}/system/object-types/{objectType}/attribute-groups/{id}": {
|
|
520
664
|
"get": {
|
|
665
|
+
"summary": "Get attribute group",
|
|
666
|
+
"description": "Retrieves a single attribute group by its identifier.\n\nUse the `select` parameter to specify which properties to include in the response.\nUse the `expand` parameter with value `definition` to include attribute definitions.\n",
|
|
521
667
|
"operationId": "getAttributeGroup",
|
|
522
668
|
"parameters": [
|
|
523
669
|
{
|
|
524
670
|
"name": "organizationId",
|
|
525
671
|
"in": "path",
|
|
672
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
526
673
|
"required": true,
|
|
527
674
|
"style": "simple",
|
|
528
675
|
"explode": false,
|
|
529
676
|
"schema": {
|
|
530
677
|
"$ref": "#/components/schemas/OrganizationId"
|
|
531
|
-
}
|
|
678
|
+
},
|
|
679
|
+
"example": "f_ecom_zzxy_prd"
|
|
532
680
|
},
|
|
533
681
|
{
|
|
534
682
|
"name": "objectType",
|
|
535
683
|
"in": "path",
|
|
684
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
536
685
|
"required": true,
|
|
537
686
|
"style": "simple",
|
|
538
687
|
"explode": false,
|
|
539
688
|
"schema": {
|
|
540
689
|
"type": "string",
|
|
690
|
+
"example": "Product",
|
|
541
691
|
"maxLength": 256,
|
|
542
692
|
"minLength": 1
|
|
543
693
|
}
|
|
@@ -545,11 +695,13 @@
|
|
|
545
695
|
{
|
|
546
696
|
"name": "id",
|
|
547
697
|
"in": "path",
|
|
698
|
+
"description": "The unique identifier of the attribute group.",
|
|
548
699
|
"required": true,
|
|
549
700
|
"style": "simple",
|
|
550
701
|
"explode": false,
|
|
551
702
|
"schema": {
|
|
552
703
|
"type": "string",
|
|
704
|
+
"example": "custom-attributes",
|
|
553
705
|
"maxLength": 256,
|
|
554
706
|
"minLength": 1
|
|
555
707
|
}
|
|
@@ -562,16 +714,23 @@
|
|
|
562
714
|
"explode": true,
|
|
563
715
|
"schema": {
|
|
564
716
|
"$ref": "#/components/schemas/Select"
|
|
717
|
+
},
|
|
718
|
+
"examples": {
|
|
719
|
+
"select": {
|
|
720
|
+
"value": "(**)"
|
|
721
|
+
}
|
|
565
722
|
}
|
|
566
723
|
},
|
|
567
724
|
{
|
|
568
725
|
"name": "expand",
|
|
569
726
|
"in": "query",
|
|
727
|
+
"description": "Specifies which related resources to include in the response.\nFor attribute groups, use `definition` to include attribute definitions.\n",
|
|
570
728
|
"required": false,
|
|
571
729
|
"style": "form",
|
|
572
730
|
"explode": true,
|
|
573
731
|
"schema": {
|
|
574
732
|
"type": "string",
|
|
733
|
+
"example": "definition",
|
|
575
734
|
"maxLength": 256
|
|
576
735
|
}
|
|
577
736
|
}
|
|
@@ -583,6 +742,14 @@
|
|
|
583
742
|
"application/json": {
|
|
584
743
|
"schema": {
|
|
585
744
|
"$ref": "#/components/schemas/ObjectAttributeGroup"
|
|
745
|
+
},
|
|
746
|
+
"examples": {
|
|
747
|
+
"ObjectAttributeGroupExample": {
|
|
748
|
+
"$ref": "#/components/examples/ObjectAttributeGroupExample"
|
|
749
|
+
},
|
|
750
|
+
"ObjectAttributeGroupWithDefinitionsExample": {
|
|
751
|
+
"$ref": "#/components/examples/ObjectAttributeGroupWithDefinitionsExample"
|
|
752
|
+
}
|
|
586
753
|
}
|
|
587
754
|
}
|
|
588
755
|
}
|
|
@@ -599,6 +766,11 @@
|
|
|
599
766
|
"application/problem+json": {
|
|
600
767
|
"schema": {
|
|
601
768
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
769
|
+
},
|
|
770
|
+
"examples": {
|
|
771
|
+
"AttributeGroupNotFoundExample": {
|
|
772
|
+
"$ref": "#/components/examples/AttributeGroupNotFoundExample"
|
|
773
|
+
}
|
|
602
774
|
}
|
|
603
775
|
}
|
|
604
776
|
}
|
|
@@ -614,26 +786,32 @@
|
|
|
614
786
|
]
|
|
615
787
|
},
|
|
616
788
|
"put": {
|
|
789
|
+
"summary": "Create or replace attribute group",
|
|
790
|
+
"description": "Creates a new attribute group or replaces an existing one with the specified identifier.\n\nReturns 201 if a new attribute group was created, or 200 if an existing one was replaced.\n",
|
|
617
791
|
"operationId": "createOrReplaceAttributeGroup",
|
|
618
792
|
"parameters": [
|
|
619
793
|
{
|
|
620
794
|
"name": "organizationId",
|
|
621
795
|
"in": "path",
|
|
796
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
622
797
|
"required": true,
|
|
623
798
|
"style": "simple",
|
|
624
799
|
"explode": false,
|
|
625
800
|
"schema": {
|
|
626
801
|
"$ref": "#/components/schemas/OrganizationId"
|
|
627
|
-
}
|
|
802
|
+
},
|
|
803
|
+
"example": "f_ecom_zzxy_prd"
|
|
628
804
|
},
|
|
629
805
|
{
|
|
630
806
|
"name": "objectType",
|
|
631
807
|
"in": "path",
|
|
808
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
632
809
|
"required": true,
|
|
633
810
|
"style": "simple",
|
|
634
811
|
"explode": false,
|
|
635
812
|
"schema": {
|
|
636
813
|
"type": "string",
|
|
814
|
+
"example": "Product",
|
|
637
815
|
"maxLength": 256,
|
|
638
816
|
"minLength": 1
|
|
639
817
|
}
|
|
@@ -641,21 +819,32 @@
|
|
|
641
819
|
{
|
|
642
820
|
"name": "id",
|
|
643
821
|
"in": "path",
|
|
822
|
+
"description": "The unique identifier of the attribute group.",
|
|
644
823
|
"required": true,
|
|
645
824
|
"style": "simple",
|
|
646
825
|
"explode": false,
|
|
647
826
|
"schema": {
|
|
648
827
|
"type": "string",
|
|
828
|
+
"example": "custom-attributes",
|
|
649
829
|
"maxLength": 256,
|
|
650
830
|
"minLength": 1
|
|
651
831
|
}
|
|
652
832
|
}
|
|
653
833
|
],
|
|
654
834
|
"requestBody": {
|
|
835
|
+
"description": "The attribute group data",
|
|
655
836
|
"content": {
|
|
656
837
|
"application/json": {
|
|
657
838
|
"schema": {
|
|
658
839
|
"$ref": "#/components/schemas/ObjectAttributeGroup"
|
|
840
|
+
},
|
|
841
|
+
"examples": {
|
|
842
|
+
"CreateAttributeGroup": {
|
|
843
|
+
"$ref": "#/components/examples/CreateAttributeGroup"
|
|
844
|
+
},
|
|
845
|
+
"CreateAttributeGroupWithInternal": {
|
|
846
|
+
"$ref": "#/components/examples/CreateAttributeGroupWithInternal"
|
|
847
|
+
}
|
|
659
848
|
}
|
|
660
849
|
}
|
|
661
850
|
},
|
|
@@ -668,6 +857,11 @@
|
|
|
668
857
|
"application/json": {
|
|
669
858
|
"schema": {
|
|
670
859
|
"$ref": "#/components/schemas/ObjectAttributeGroup"
|
|
860
|
+
},
|
|
861
|
+
"examples": {
|
|
862
|
+
"ObjectAttributeGroupExample": {
|
|
863
|
+
"$ref": "#/components/examples/ObjectAttributeGroupExample"
|
|
864
|
+
}
|
|
671
865
|
}
|
|
672
866
|
}
|
|
673
867
|
}
|
|
@@ -678,6 +872,11 @@
|
|
|
678
872
|
"application/json": {
|
|
679
873
|
"schema": {
|
|
680
874
|
"$ref": "#/components/schemas/ObjectAttributeGroup"
|
|
875
|
+
},
|
|
876
|
+
"examples": {
|
|
877
|
+
"ObjectAttributeGroupCreatedExample": {
|
|
878
|
+
"$ref": "#/components/examples/ObjectAttributeGroupCreatedExample"
|
|
879
|
+
}
|
|
681
880
|
}
|
|
682
881
|
}
|
|
683
882
|
}
|
|
@@ -688,6 +887,11 @@
|
|
|
688
887
|
"application/problem+json": {
|
|
689
888
|
"schema": {
|
|
690
889
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
890
|
+
},
|
|
891
|
+
"examples": {
|
|
892
|
+
"IdConflictExample": {
|
|
893
|
+
"$ref": "#/components/examples/IdConflictExample"
|
|
894
|
+
}
|
|
691
895
|
}
|
|
692
896
|
}
|
|
693
897
|
}
|
|
@@ -704,6 +908,11 @@
|
|
|
704
908
|
"application/problem+json": {
|
|
705
909
|
"schema": {
|
|
706
910
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
911
|
+
},
|
|
912
|
+
"examples": {
|
|
913
|
+
"ObjectTypeNotFoundExample": {
|
|
914
|
+
"$ref": "#/components/examples/ObjectTypeNotFoundExample"
|
|
915
|
+
}
|
|
707
916
|
}
|
|
708
917
|
}
|
|
709
918
|
}
|
|
@@ -718,26 +927,32 @@
|
|
|
718
927
|
]
|
|
719
928
|
},
|
|
720
929
|
"delete": {
|
|
930
|
+
"summary": "Delete attribute group",
|
|
931
|
+
"description": "Deletes an attribute group by its identifier.\n\nThis operation cannot be undone. All attribute definitions will be unassigned from the group\nbut will not be deleted.\n",
|
|
721
932
|
"operationId": "deleteAttributeGroup",
|
|
722
933
|
"parameters": [
|
|
723
934
|
{
|
|
724
935
|
"name": "organizationId",
|
|
725
936
|
"in": "path",
|
|
937
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
726
938
|
"required": true,
|
|
727
939
|
"style": "simple",
|
|
728
940
|
"explode": false,
|
|
729
941
|
"schema": {
|
|
730
942
|
"$ref": "#/components/schemas/OrganizationId"
|
|
731
|
-
}
|
|
943
|
+
},
|
|
944
|
+
"example": "f_ecom_zzxy_prd"
|
|
732
945
|
},
|
|
733
946
|
{
|
|
734
947
|
"name": "objectType",
|
|
735
948
|
"in": "path",
|
|
949
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
736
950
|
"required": true,
|
|
737
951
|
"style": "simple",
|
|
738
952
|
"explode": false,
|
|
739
953
|
"schema": {
|
|
740
954
|
"type": "string",
|
|
955
|
+
"example": "Product",
|
|
741
956
|
"maxLength": 256,
|
|
742
957
|
"minLength": 1
|
|
743
958
|
}
|
|
@@ -745,11 +960,13 @@
|
|
|
745
960
|
{
|
|
746
961
|
"name": "id",
|
|
747
962
|
"in": "path",
|
|
963
|
+
"description": "The unique identifier of the attribute group.",
|
|
748
964
|
"required": true,
|
|
749
965
|
"style": "simple",
|
|
750
966
|
"explode": false,
|
|
751
967
|
"schema": {
|
|
752
968
|
"type": "string",
|
|
969
|
+
"example": "custom-attributes",
|
|
753
970
|
"maxLength": 256,
|
|
754
971
|
"minLength": 1
|
|
755
972
|
}
|
|
@@ -771,6 +988,11 @@
|
|
|
771
988
|
"application/problem+json": {
|
|
772
989
|
"schema": {
|
|
773
990
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
991
|
+
},
|
|
992
|
+
"examples": {
|
|
993
|
+
"AttributeGroupNotFoundExample": {
|
|
994
|
+
"$ref": "#/components/examples/AttributeGroupNotFoundExample"
|
|
995
|
+
}
|
|
774
996
|
}
|
|
775
997
|
}
|
|
776
998
|
}
|
|
@@ -785,26 +1007,32 @@
|
|
|
785
1007
|
]
|
|
786
1008
|
},
|
|
787
1009
|
"patch": {
|
|
1010
|
+
"summary": "Update attribute group",
|
|
1011
|
+
"description": "Partially updates an existing attribute group.\n\nOnly the properties provided in the request body will be updated.\n",
|
|
788
1012
|
"operationId": "updateAttributeGroup",
|
|
789
1013
|
"parameters": [
|
|
790
1014
|
{
|
|
791
1015
|
"name": "organizationId",
|
|
792
1016
|
"in": "path",
|
|
1017
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
793
1018
|
"required": true,
|
|
794
1019
|
"style": "simple",
|
|
795
1020
|
"explode": false,
|
|
796
1021
|
"schema": {
|
|
797
1022
|
"$ref": "#/components/schemas/OrganizationId"
|
|
798
|
-
}
|
|
1023
|
+
},
|
|
1024
|
+
"example": "f_ecom_zzxy_prd"
|
|
799
1025
|
},
|
|
800
1026
|
{
|
|
801
1027
|
"name": "objectType",
|
|
802
1028
|
"in": "path",
|
|
1029
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
803
1030
|
"required": true,
|
|
804
1031
|
"style": "simple",
|
|
805
1032
|
"explode": false,
|
|
806
1033
|
"schema": {
|
|
807
1034
|
"type": "string",
|
|
1035
|
+
"example": "Product",
|
|
808
1036
|
"maxLength": 256,
|
|
809
1037
|
"minLength": 1
|
|
810
1038
|
}
|
|
@@ -812,21 +1040,32 @@
|
|
|
812
1040
|
{
|
|
813
1041
|
"name": "id",
|
|
814
1042
|
"in": "path",
|
|
1043
|
+
"description": "The unique identifier of the attribute group.",
|
|
815
1044
|
"required": true,
|
|
816
1045
|
"style": "simple",
|
|
817
1046
|
"explode": false,
|
|
818
1047
|
"schema": {
|
|
819
1048
|
"type": "string",
|
|
1049
|
+
"example": "custom-attributes",
|
|
820
1050
|
"maxLength": 256,
|
|
821
1051
|
"minLength": 1
|
|
822
1052
|
}
|
|
823
1053
|
}
|
|
824
1054
|
],
|
|
825
1055
|
"requestBody": {
|
|
1056
|
+
"description": "The attribute group data to update",
|
|
826
1057
|
"content": {
|
|
827
1058
|
"application/json": {
|
|
828
1059
|
"schema": {
|
|
829
1060
|
"$ref": "#/components/schemas/ObjectAttributeGroup"
|
|
1061
|
+
},
|
|
1062
|
+
"examples": {
|
|
1063
|
+
"UpdateAttributeGroup": {
|
|
1064
|
+
"$ref": "#/components/examples/UpdateAttributeGroup"
|
|
1065
|
+
},
|
|
1066
|
+
"UpdateAttributeGroupPosition": {
|
|
1067
|
+
"$ref": "#/components/examples/UpdateAttributeGroupPosition"
|
|
1068
|
+
}
|
|
830
1069
|
}
|
|
831
1070
|
}
|
|
832
1071
|
},
|
|
@@ -839,6 +1078,11 @@
|
|
|
839
1078
|
"application/json": {
|
|
840
1079
|
"schema": {
|
|
841
1080
|
"$ref": "#/components/schemas/ObjectAttributeGroup"
|
|
1081
|
+
},
|
|
1082
|
+
"examples": {
|
|
1083
|
+
"ObjectAttributeGroupExample": {
|
|
1084
|
+
"$ref": "#/components/examples/ObjectAttributeGroupExample"
|
|
1085
|
+
}
|
|
842
1086
|
}
|
|
843
1087
|
}
|
|
844
1088
|
}
|
|
@@ -849,6 +1093,11 @@
|
|
|
849
1093
|
"application/problem+json": {
|
|
850
1094
|
"schema": {
|
|
851
1095
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1096
|
+
},
|
|
1097
|
+
"examples": {
|
|
1098
|
+
"MalformedRequestBodyExample": {
|
|
1099
|
+
"$ref": "#/components/examples/MalformedRequestBodyExample"
|
|
1100
|
+
}
|
|
852
1101
|
}
|
|
853
1102
|
}
|
|
854
1103
|
}
|
|
@@ -865,6 +1114,11 @@
|
|
|
865
1114
|
"application/problem+json": {
|
|
866
1115
|
"schema": {
|
|
867
1116
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1117
|
+
},
|
|
1118
|
+
"examples": {
|
|
1119
|
+
"AttributeGroupNotFoundExample": {
|
|
1120
|
+
"$ref": "#/components/examples/AttributeGroupNotFoundExample"
|
|
1121
|
+
}
|
|
868
1122
|
}
|
|
869
1123
|
}
|
|
870
1124
|
}
|
|
@@ -881,26 +1135,32 @@
|
|
|
881
1135
|
},
|
|
882
1136
|
"/organizations/{organizationId}/system/object-types/{objectType}/attribute-groups/{groupId}/attribute-definitions/{defId}": {
|
|
883
1137
|
"put": {
|
|
1138
|
+
"summary": "Assign attribute definition to group",
|
|
1139
|
+
"description": "Assigns an attribute definition to an attribute group.\n\nThe attribute definition must exist for the specified system object type.\nAn attribute definition can be assigned to multiple groups.\n",
|
|
884
1140
|
"operationId": "assignAttributeDefinitionToGroup",
|
|
885
1141
|
"parameters": [
|
|
886
1142
|
{
|
|
887
1143
|
"name": "organizationId",
|
|
888
1144
|
"in": "path",
|
|
1145
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
889
1146
|
"required": true,
|
|
890
1147
|
"style": "simple",
|
|
891
1148
|
"explode": false,
|
|
892
1149
|
"schema": {
|
|
893
1150
|
"$ref": "#/components/schemas/OrganizationId"
|
|
894
|
-
}
|
|
1151
|
+
},
|
|
1152
|
+
"example": "f_ecom_zzxy_prd"
|
|
895
1153
|
},
|
|
896
1154
|
{
|
|
897
1155
|
"name": "objectType",
|
|
898
1156
|
"in": "path",
|
|
1157
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
899
1158
|
"required": true,
|
|
900
1159
|
"style": "simple",
|
|
901
1160
|
"explode": false,
|
|
902
1161
|
"schema": {
|
|
903
1162
|
"type": "string",
|
|
1163
|
+
"example": "Product",
|
|
904
1164
|
"maxLength": 256,
|
|
905
1165
|
"minLength": 1
|
|
906
1166
|
}
|
|
@@ -908,11 +1168,13 @@
|
|
|
908
1168
|
{
|
|
909
1169
|
"name": "groupId",
|
|
910
1170
|
"in": "path",
|
|
1171
|
+
"description": "The unique identifier of the attribute group.",
|
|
911
1172
|
"required": true,
|
|
912
1173
|
"style": "simple",
|
|
913
1174
|
"explode": false,
|
|
914
1175
|
"schema": {
|
|
915
1176
|
"type": "string",
|
|
1177
|
+
"example": "custom-attributes",
|
|
916
1178
|
"maxLength": 256,
|
|
917
1179
|
"minLength": 1
|
|
918
1180
|
}
|
|
@@ -920,11 +1182,13 @@
|
|
|
920
1182
|
{
|
|
921
1183
|
"name": "defId",
|
|
922
1184
|
"in": "path",
|
|
1185
|
+
"description": "The unique identifier of the attribute definition to assign or unassign.",
|
|
923
1186
|
"required": true,
|
|
924
1187
|
"style": "simple",
|
|
925
1188
|
"explode": false,
|
|
926
1189
|
"schema": {
|
|
927
1190
|
"type": "string",
|
|
1191
|
+
"example": "color",
|
|
928
1192
|
"maxLength": 256,
|
|
929
1193
|
"minLength": 1
|
|
930
1194
|
}
|
|
@@ -946,6 +1210,17 @@
|
|
|
946
1210
|
"application/problem+json": {
|
|
947
1211
|
"schema": {
|
|
948
1212
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1213
|
+
},
|
|
1214
|
+
"examples": {
|
|
1215
|
+
"ObjectTypeNotFoundExample": {
|
|
1216
|
+
"$ref": "#/components/examples/ObjectTypeNotFoundExample"
|
|
1217
|
+
},
|
|
1218
|
+
"AttributeGroupNotFoundExample": {
|
|
1219
|
+
"$ref": "#/components/examples/AttributeGroupNotFoundExample"
|
|
1220
|
+
},
|
|
1221
|
+
"AttributeDefinitionNotFoundExample": {
|
|
1222
|
+
"$ref": "#/components/examples/AttributeDefinitionNotFoundExample"
|
|
1223
|
+
}
|
|
949
1224
|
}
|
|
950
1225
|
}
|
|
951
1226
|
}
|
|
@@ -960,26 +1235,32 @@
|
|
|
960
1235
|
]
|
|
961
1236
|
},
|
|
962
1237
|
"delete": {
|
|
1238
|
+
"summary": "Unassign attribute definition from group",
|
|
1239
|
+
"description": "Removes an attribute definition from an attribute group.\n\nThis operation only removes the assignment; the attribute definition itself is not deleted.\n",
|
|
963
1240
|
"operationId": "unassignAttributeDefinitionFromGroup",
|
|
964
1241
|
"parameters": [
|
|
965
1242
|
{
|
|
966
1243
|
"name": "organizationId",
|
|
967
1244
|
"in": "path",
|
|
1245
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
968
1246
|
"required": true,
|
|
969
1247
|
"style": "simple",
|
|
970
1248
|
"explode": false,
|
|
971
1249
|
"schema": {
|
|
972
1250
|
"$ref": "#/components/schemas/OrganizationId"
|
|
973
|
-
}
|
|
1251
|
+
},
|
|
1252
|
+
"example": "f_ecom_zzxy_prd"
|
|
974
1253
|
},
|
|
975
1254
|
{
|
|
976
1255
|
"name": "objectType",
|
|
977
1256
|
"in": "path",
|
|
1257
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
978
1258
|
"required": true,
|
|
979
1259
|
"style": "simple",
|
|
980
1260
|
"explode": false,
|
|
981
1261
|
"schema": {
|
|
982
1262
|
"type": "string",
|
|
1263
|
+
"example": "Product",
|
|
983
1264
|
"maxLength": 256,
|
|
984
1265
|
"minLength": 1
|
|
985
1266
|
}
|
|
@@ -987,11 +1268,13 @@
|
|
|
987
1268
|
{
|
|
988
1269
|
"name": "groupId",
|
|
989
1270
|
"in": "path",
|
|
1271
|
+
"description": "The unique identifier of the attribute group.",
|
|
990
1272
|
"required": true,
|
|
991
1273
|
"style": "simple",
|
|
992
1274
|
"explode": false,
|
|
993
1275
|
"schema": {
|
|
994
1276
|
"type": "string",
|
|
1277
|
+
"example": "custom-attributes",
|
|
995
1278
|
"maxLength": 256,
|
|
996
1279
|
"minLength": 1
|
|
997
1280
|
}
|
|
@@ -999,11 +1282,13 @@
|
|
|
999
1282
|
{
|
|
1000
1283
|
"name": "defId",
|
|
1001
1284
|
"in": "path",
|
|
1285
|
+
"description": "The unique identifier of the attribute definition to assign or unassign.",
|
|
1002
1286
|
"required": true,
|
|
1003
1287
|
"style": "simple",
|
|
1004
1288
|
"explode": false,
|
|
1005
1289
|
"schema": {
|
|
1006
1290
|
"type": "string",
|
|
1291
|
+
"example": "color",
|
|
1007
1292
|
"maxLength": 256,
|
|
1008
1293
|
"minLength": 1
|
|
1009
1294
|
}
|
|
@@ -1025,6 +1310,17 @@
|
|
|
1025
1310
|
"application/problem+json": {
|
|
1026
1311
|
"schema": {
|
|
1027
1312
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1313
|
+
},
|
|
1314
|
+
"examples": {
|
|
1315
|
+
"ObjectTypeNotFoundExample": {
|
|
1316
|
+
"$ref": "#/components/examples/ObjectTypeNotFoundExample"
|
|
1317
|
+
},
|
|
1318
|
+
"AttributeGroupNotFoundExample": {
|
|
1319
|
+
"$ref": "#/components/examples/AttributeGroupNotFoundExample"
|
|
1320
|
+
},
|
|
1321
|
+
"AttributeDefinitionNotFoundExample": {
|
|
1322
|
+
"$ref": "#/components/examples/AttributeDefinitionNotFoundExample"
|
|
1323
|
+
}
|
|
1028
1324
|
}
|
|
1029
1325
|
}
|
|
1030
1326
|
}
|
|
@@ -1041,26 +1337,32 @@
|
|
|
1041
1337
|
},
|
|
1042
1338
|
"/organizations/{organizationId}/system/object-types/{objectType}/attribute-definitions": {
|
|
1043
1339
|
"get": {
|
|
1340
|
+
"summary": "Get attribute definitions",
|
|
1341
|
+
"description": "Retrieves a paginated list of attribute definitions for the specified system object type.\n\nUse the `select` parameter to specify which properties to include in the response.\nUse `offset` and `limit` for pagination.\n",
|
|
1044
1342
|
"operationId": "getAttributeDefinitions",
|
|
1045
1343
|
"parameters": [
|
|
1046
1344
|
{
|
|
1047
1345
|
"name": "organizationId",
|
|
1048
1346
|
"in": "path",
|
|
1347
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
1049
1348
|
"required": true,
|
|
1050
1349
|
"style": "simple",
|
|
1051
1350
|
"explode": false,
|
|
1052
1351
|
"schema": {
|
|
1053
1352
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1054
|
-
}
|
|
1353
|
+
},
|
|
1354
|
+
"example": "f_ecom_zzxy_prd"
|
|
1055
1355
|
},
|
|
1056
1356
|
{
|
|
1057
1357
|
"name": "objectType",
|
|
1058
1358
|
"in": "path",
|
|
1359
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
1059
1360
|
"required": true,
|
|
1060
1361
|
"style": "simple",
|
|
1061
1362
|
"explode": false,
|
|
1062
1363
|
"schema": {
|
|
1063
1364
|
"type": "string",
|
|
1365
|
+
"example": "Product",
|
|
1064
1366
|
"maxLength": 256,
|
|
1065
1367
|
"minLength": 1
|
|
1066
1368
|
}
|
|
@@ -1073,11 +1375,17 @@
|
|
|
1073
1375
|
"explode": true,
|
|
1074
1376
|
"schema": {
|
|
1075
1377
|
"$ref": "#/components/schemas/Select"
|
|
1378
|
+
},
|
|
1379
|
+
"examples": {
|
|
1380
|
+
"select": {
|
|
1381
|
+
"value": "(**)"
|
|
1382
|
+
}
|
|
1076
1383
|
}
|
|
1077
1384
|
},
|
|
1078
1385
|
{
|
|
1079
1386
|
"name": "limit",
|
|
1080
1387
|
"in": "query",
|
|
1388
|
+
"description": "Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 25.",
|
|
1081
1389
|
"required": false,
|
|
1082
1390
|
"style": "form",
|
|
1083
1391
|
"explode": true,
|
|
@@ -1092,6 +1400,7 @@
|
|
|
1092
1400
|
{
|
|
1093
1401
|
"name": "offset",
|
|
1094
1402
|
"in": "query",
|
|
1403
|
+
"description": "Used to retrieve the results based on a particular resource offset.",
|
|
1095
1404
|
"required": false,
|
|
1096
1405
|
"style": "form",
|
|
1097
1406
|
"explode": true,
|
|
@@ -1110,6 +1419,11 @@
|
|
|
1110
1419
|
"application/json": {
|
|
1111
1420
|
"schema": {
|
|
1112
1421
|
"$ref": "#/components/schemas/ObjectAttributeDefinitionResult"
|
|
1422
|
+
},
|
|
1423
|
+
"examples": {
|
|
1424
|
+
"ObjectAttributeDefinitionResultExample": {
|
|
1425
|
+
"$ref": "#/components/examples/ObjectAttributeDefinitionResultExample"
|
|
1426
|
+
}
|
|
1113
1427
|
}
|
|
1114
1428
|
}
|
|
1115
1429
|
}
|
|
@@ -1126,6 +1440,11 @@
|
|
|
1126
1440
|
"application/problem+json": {
|
|
1127
1441
|
"schema": {
|
|
1128
1442
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1443
|
+
},
|
|
1444
|
+
"examples": {
|
|
1445
|
+
"ObjectTypeNotFoundExample": {
|
|
1446
|
+
"$ref": "#/components/examples/ObjectTypeNotFoundExample"
|
|
1447
|
+
}
|
|
1129
1448
|
}
|
|
1130
1449
|
}
|
|
1131
1450
|
}
|
|
@@ -1143,26 +1462,32 @@
|
|
|
1143
1462
|
},
|
|
1144
1463
|
"/organizations/{organizationId}/system/object-types/{objectType}/attribute-definitions/{id}": {
|
|
1145
1464
|
"get": {
|
|
1465
|
+
"summary": "Get attribute definition",
|
|
1466
|
+
"description": "Retrieves a single attribute definition by its identifier.\n\nUse the `select` parameter to specify which properties to include in the response.\nUse the `expand` parameter to include related resources.\n",
|
|
1146
1467
|
"operationId": "getAttributeDefinition",
|
|
1147
1468
|
"parameters": [
|
|
1148
1469
|
{
|
|
1149
1470
|
"name": "organizationId",
|
|
1150
1471
|
"in": "path",
|
|
1472
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
1151
1473
|
"required": true,
|
|
1152
1474
|
"style": "simple",
|
|
1153
1475
|
"explode": false,
|
|
1154
1476
|
"schema": {
|
|
1155
1477
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1156
|
-
}
|
|
1478
|
+
},
|
|
1479
|
+
"example": "f_ecom_zzxy_prd"
|
|
1157
1480
|
},
|
|
1158
1481
|
{
|
|
1159
1482
|
"name": "objectType",
|
|
1160
1483
|
"in": "path",
|
|
1484
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
1161
1485
|
"required": true,
|
|
1162
1486
|
"style": "simple",
|
|
1163
1487
|
"explode": false,
|
|
1164
1488
|
"schema": {
|
|
1165
1489
|
"type": "string",
|
|
1490
|
+
"example": "Product",
|
|
1166
1491
|
"maxLength": 256,
|
|
1167
1492
|
"minLength": 1
|
|
1168
1493
|
}
|
|
@@ -1170,11 +1495,13 @@
|
|
|
1170
1495
|
{
|
|
1171
1496
|
"name": "id",
|
|
1172
1497
|
"in": "path",
|
|
1498
|
+
"description": "The unique identifier of the attribute definition.",
|
|
1173
1499
|
"required": true,
|
|
1174
1500
|
"style": "simple",
|
|
1175
1501
|
"explode": false,
|
|
1176
1502
|
"schema": {
|
|
1177
1503
|
"type": "string",
|
|
1504
|
+
"example": "color",
|
|
1178
1505
|
"maxLength": 256,
|
|
1179
1506
|
"minLength": 1
|
|
1180
1507
|
}
|
|
@@ -1187,16 +1514,23 @@
|
|
|
1187
1514
|
"explode": true,
|
|
1188
1515
|
"schema": {
|
|
1189
1516
|
"$ref": "#/components/schemas/Select"
|
|
1517
|
+
},
|
|
1518
|
+
"examples": {
|
|
1519
|
+
"select": {
|
|
1520
|
+
"value": "(**)"
|
|
1521
|
+
}
|
|
1190
1522
|
}
|
|
1191
1523
|
},
|
|
1192
1524
|
{
|
|
1193
1525
|
"name": "expand",
|
|
1194
1526
|
"in": "query",
|
|
1527
|
+
"description": "Specifies which related resources to include in the response.\nFor attribute groups, use `definition` to include attribute definitions.\n",
|
|
1195
1528
|
"required": false,
|
|
1196
1529
|
"style": "form",
|
|
1197
1530
|
"explode": true,
|
|
1198
1531
|
"schema": {
|
|
1199
1532
|
"type": "string",
|
|
1533
|
+
"example": "definition",
|
|
1200
1534
|
"maxLength": 256
|
|
1201
1535
|
}
|
|
1202
1536
|
}
|
|
@@ -1208,6 +1542,11 @@
|
|
|
1208
1542
|
"application/json": {
|
|
1209
1543
|
"schema": {
|
|
1210
1544
|
"$ref": "#/components/schemas/ObjectAttributeDefinition"
|
|
1545
|
+
},
|
|
1546
|
+
"examples": {
|
|
1547
|
+
"ObjectAttributeDefinitionExample": {
|
|
1548
|
+
"$ref": "#/components/examples/ObjectAttributeDefinitionExample"
|
|
1549
|
+
}
|
|
1211
1550
|
}
|
|
1212
1551
|
}
|
|
1213
1552
|
}
|
|
@@ -1224,6 +1563,11 @@
|
|
|
1224
1563
|
"application/problem+json": {
|
|
1225
1564
|
"schema": {
|
|
1226
1565
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1566
|
+
},
|
|
1567
|
+
"examples": {
|
|
1568
|
+
"AttributeDefinitionNotFoundExample": {
|
|
1569
|
+
"$ref": "#/components/examples/AttributeDefinitionNotFoundExample"
|
|
1570
|
+
}
|
|
1227
1571
|
}
|
|
1228
1572
|
}
|
|
1229
1573
|
}
|
|
@@ -1239,26 +1583,32 @@
|
|
|
1239
1583
|
]
|
|
1240
1584
|
},
|
|
1241
1585
|
"put": {
|
|
1586
|
+
"summary": "Create or replace attribute definition",
|
|
1587
|
+
"description": "Creates a new attribute definition or replaces an existing one with the specified identifier.\n\nReturns 201 if a new attribute definition was created, or 200 if an existing one was replaced.\n\n**Important:** The `valueType` property is required when creating a new attribute definition\nand cannot be changed after creation.\n",
|
|
1242
1588
|
"operationId": "createOrReplaceAttributeDefinition",
|
|
1243
1589
|
"parameters": [
|
|
1244
1590
|
{
|
|
1245
1591
|
"name": "organizationId",
|
|
1246
1592
|
"in": "path",
|
|
1593
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
1247
1594
|
"required": true,
|
|
1248
1595
|
"style": "simple",
|
|
1249
1596
|
"explode": false,
|
|
1250
1597
|
"schema": {
|
|
1251
1598
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1252
|
-
}
|
|
1599
|
+
},
|
|
1600
|
+
"example": "f_ecom_zzxy_prd"
|
|
1253
1601
|
},
|
|
1254
1602
|
{
|
|
1255
1603
|
"name": "objectType",
|
|
1256
1604
|
"in": "path",
|
|
1605
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
1257
1606
|
"required": true,
|
|
1258
1607
|
"style": "simple",
|
|
1259
1608
|
"explode": false,
|
|
1260
1609
|
"schema": {
|
|
1261
1610
|
"type": "string",
|
|
1611
|
+
"example": "Product",
|
|
1262
1612
|
"maxLength": 256,
|
|
1263
1613
|
"minLength": 1
|
|
1264
1614
|
}
|
|
@@ -1266,21 +1616,38 @@
|
|
|
1266
1616
|
{
|
|
1267
1617
|
"name": "id",
|
|
1268
1618
|
"in": "path",
|
|
1619
|
+
"description": "The unique identifier of the attribute definition.",
|
|
1269
1620
|
"required": true,
|
|
1270
1621
|
"style": "simple",
|
|
1271
1622
|
"explode": false,
|
|
1272
1623
|
"schema": {
|
|
1273
1624
|
"type": "string",
|
|
1625
|
+
"example": "color",
|
|
1274
1626
|
"maxLength": 256,
|
|
1275
1627
|
"minLength": 1
|
|
1276
1628
|
}
|
|
1277
1629
|
}
|
|
1278
1630
|
],
|
|
1279
1631
|
"requestBody": {
|
|
1632
|
+
"description": "The attribute definition data",
|
|
1280
1633
|
"content": {
|
|
1281
1634
|
"application/json": {
|
|
1282
1635
|
"schema": {
|
|
1283
1636
|
"$ref": "#/components/schemas/ObjectAttributeDefinition"
|
|
1637
|
+
},
|
|
1638
|
+
"examples": {
|
|
1639
|
+
"CreateAttributeDefinitionString": {
|
|
1640
|
+
"$ref": "#/components/examples/CreateAttributeDefinitionString"
|
|
1641
|
+
},
|
|
1642
|
+
"CreateAttributeDefinitionEnum": {
|
|
1643
|
+
"$ref": "#/components/examples/CreateAttributeDefinitionEnum"
|
|
1644
|
+
},
|
|
1645
|
+
"CreateAttributeDefinitionNumber": {
|
|
1646
|
+
"$ref": "#/components/examples/CreateAttributeDefinitionNumber"
|
|
1647
|
+
},
|
|
1648
|
+
"CreateAttributeDefinitionImage": {
|
|
1649
|
+
"$ref": "#/components/examples/CreateAttributeDefinitionImage"
|
|
1650
|
+
}
|
|
1284
1651
|
}
|
|
1285
1652
|
}
|
|
1286
1653
|
},
|
|
@@ -1293,6 +1660,11 @@
|
|
|
1293
1660
|
"application/json": {
|
|
1294
1661
|
"schema": {
|
|
1295
1662
|
"$ref": "#/components/schemas/ObjectAttributeDefinition"
|
|
1663
|
+
},
|
|
1664
|
+
"examples": {
|
|
1665
|
+
"ObjectAttributeDefinitionExample": {
|
|
1666
|
+
"$ref": "#/components/examples/ObjectAttributeDefinitionExample"
|
|
1667
|
+
}
|
|
1296
1668
|
}
|
|
1297
1669
|
}
|
|
1298
1670
|
}
|
|
@@ -1303,6 +1675,11 @@
|
|
|
1303
1675
|
"application/json": {
|
|
1304
1676
|
"schema": {
|
|
1305
1677
|
"$ref": "#/components/schemas/ObjectAttributeDefinition"
|
|
1678
|
+
},
|
|
1679
|
+
"examples": {
|
|
1680
|
+
"ObjectAttributeDefinitionCreatedExample": {
|
|
1681
|
+
"$ref": "#/components/examples/ObjectAttributeDefinitionCreatedExample"
|
|
1682
|
+
}
|
|
1306
1683
|
}
|
|
1307
1684
|
}
|
|
1308
1685
|
}
|
|
@@ -1313,6 +1690,11 @@
|
|
|
1313
1690
|
"application/problem+json": {
|
|
1314
1691
|
"schema": {
|
|
1315
1692
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1693
|
+
},
|
|
1694
|
+
"examples": {
|
|
1695
|
+
"InvalidValueTypeExample": {
|
|
1696
|
+
"$ref": "#/components/examples/BadRequestExample"
|
|
1697
|
+
}
|
|
1316
1698
|
}
|
|
1317
1699
|
}
|
|
1318
1700
|
}
|
|
@@ -1329,6 +1711,11 @@
|
|
|
1329
1711
|
"application/problem+json": {
|
|
1330
1712
|
"schema": {
|
|
1331
1713
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1714
|
+
},
|
|
1715
|
+
"examples": {
|
|
1716
|
+
"ObjectTypeNotFoundExample": {
|
|
1717
|
+
"$ref": "#/components/examples/ObjectTypeNotFoundExample"
|
|
1718
|
+
}
|
|
1332
1719
|
}
|
|
1333
1720
|
}
|
|
1334
1721
|
}
|
|
@@ -1343,26 +1730,32 @@
|
|
|
1343
1730
|
]
|
|
1344
1731
|
},
|
|
1345
1732
|
"delete": {
|
|
1733
|
+
"summary": "Delete attribute definition",
|
|
1734
|
+
"description": "Deletes an attribute definition by its identifier.\n\nThis operation cannot be undone. The attribute definition will be removed from all\nattribute groups and all values for this attribute will be deleted.\n\n**Important:** System attributes cannot be deleted.\n",
|
|
1346
1735
|
"operationId": "deleteAttributeDefinition",
|
|
1347
1736
|
"parameters": [
|
|
1348
1737
|
{
|
|
1349
1738
|
"name": "organizationId",
|
|
1350
1739
|
"in": "path",
|
|
1740
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
1351
1741
|
"required": true,
|
|
1352
1742
|
"style": "simple",
|
|
1353
1743
|
"explode": false,
|
|
1354
1744
|
"schema": {
|
|
1355
1745
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1356
|
-
}
|
|
1746
|
+
},
|
|
1747
|
+
"example": "f_ecom_zzxy_prd"
|
|
1357
1748
|
},
|
|
1358
1749
|
{
|
|
1359
1750
|
"name": "objectType",
|
|
1360
1751
|
"in": "path",
|
|
1752
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
1361
1753
|
"required": true,
|
|
1362
1754
|
"style": "simple",
|
|
1363
1755
|
"explode": false,
|
|
1364
1756
|
"schema": {
|
|
1365
1757
|
"type": "string",
|
|
1758
|
+
"example": "Product",
|
|
1366
1759
|
"maxLength": 256,
|
|
1367
1760
|
"minLength": 1
|
|
1368
1761
|
}
|
|
@@ -1370,11 +1763,13 @@
|
|
|
1370
1763
|
{
|
|
1371
1764
|
"name": "id",
|
|
1372
1765
|
"in": "path",
|
|
1766
|
+
"description": "The unique identifier of the attribute definition.",
|
|
1373
1767
|
"required": true,
|
|
1374
1768
|
"style": "simple",
|
|
1375
1769
|
"explode": false,
|
|
1376
1770
|
"schema": {
|
|
1377
1771
|
"type": "string",
|
|
1772
|
+
"example": "color",
|
|
1378
1773
|
"maxLength": 256,
|
|
1379
1774
|
"minLength": 1
|
|
1380
1775
|
}
|
|
@@ -1396,6 +1791,11 @@
|
|
|
1396
1791
|
"application/problem+json": {
|
|
1397
1792
|
"schema": {
|
|
1398
1793
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1794
|
+
},
|
|
1795
|
+
"examples": {
|
|
1796
|
+
"AttributeDefinitionNotFoundExample": {
|
|
1797
|
+
"$ref": "#/components/examples/AttributeDefinitionNotFoundExample"
|
|
1798
|
+
}
|
|
1399
1799
|
}
|
|
1400
1800
|
}
|
|
1401
1801
|
}
|
|
@@ -1410,26 +1810,32 @@
|
|
|
1410
1810
|
]
|
|
1411
1811
|
},
|
|
1412
1812
|
"patch": {
|
|
1813
|
+
"summary": "Update attribute definition",
|
|
1814
|
+
"description": "Partially updates an existing attribute definition.\n\nOnly the properties provided in the request body will be updated.\n\n**Important:** The `valueType` property cannot be changed after creation.\nSystem attributes have limited modifiable properties.\n",
|
|
1413
1815
|
"operationId": "updateAttributeDefinition",
|
|
1414
1816
|
"parameters": [
|
|
1415
1817
|
{
|
|
1416
1818
|
"name": "organizationId",
|
|
1417
1819
|
"in": "path",
|
|
1820
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
1418
1821
|
"required": true,
|
|
1419
1822
|
"style": "simple",
|
|
1420
1823
|
"explode": false,
|
|
1421
1824
|
"schema": {
|
|
1422
1825
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1423
|
-
}
|
|
1826
|
+
},
|
|
1827
|
+
"example": "f_ecom_zzxy_prd"
|
|
1424
1828
|
},
|
|
1425
1829
|
{
|
|
1426
1830
|
"name": "objectType",
|
|
1427
1831
|
"in": "path",
|
|
1832
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
1428
1833
|
"required": true,
|
|
1429
1834
|
"style": "simple",
|
|
1430
1835
|
"explode": false,
|
|
1431
1836
|
"schema": {
|
|
1432
1837
|
"type": "string",
|
|
1838
|
+
"example": "Product",
|
|
1433
1839
|
"maxLength": 256,
|
|
1434
1840
|
"minLength": 1
|
|
1435
1841
|
}
|
|
@@ -1437,21 +1843,29 @@
|
|
|
1437
1843
|
{
|
|
1438
1844
|
"name": "id",
|
|
1439
1845
|
"in": "path",
|
|
1846
|
+
"description": "The unique identifier of the attribute definition.",
|
|
1440
1847
|
"required": true,
|
|
1441
1848
|
"style": "simple",
|
|
1442
1849
|
"explode": false,
|
|
1443
1850
|
"schema": {
|
|
1444
1851
|
"type": "string",
|
|
1852
|
+
"example": "color",
|
|
1445
1853
|
"maxLength": 256,
|
|
1446
1854
|
"minLength": 1
|
|
1447
1855
|
}
|
|
1448
1856
|
}
|
|
1449
1857
|
],
|
|
1450
1858
|
"requestBody": {
|
|
1859
|
+
"description": "The attribute definition data to update",
|
|
1451
1860
|
"content": {
|
|
1452
1861
|
"application/json": {
|
|
1453
1862
|
"schema": {
|
|
1454
1863
|
"$ref": "#/components/schemas/ObjectAttributeDefinition"
|
|
1864
|
+
},
|
|
1865
|
+
"examples": {
|
|
1866
|
+
"UpdateAttributeDefinition": {
|
|
1867
|
+
"$ref": "#/components/examples/UpdateAttributeDefinition"
|
|
1868
|
+
}
|
|
1455
1869
|
}
|
|
1456
1870
|
}
|
|
1457
1871
|
},
|
|
@@ -1464,6 +1878,11 @@
|
|
|
1464
1878
|
"application/json": {
|
|
1465
1879
|
"schema": {
|
|
1466
1880
|
"$ref": "#/components/schemas/ObjectAttributeDefinition"
|
|
1881
|
+
},
|
|
1882
|
+
"examples": {
|
|
1883
|
+
"ObjectAttributeDefinitionExample": {
|
|
1884
|
+
"$ref": "#/components/examples/ObjectAttributeDefinitionExample"
|
|
1885
|
+
}
|
|
1467
1886
|
}
|
|
1468
1887
|
}
|
|
1469
1888
|
}
|
|
@@ -1474,6 +1893,11 @@
|
|
|
1474
1893
|
"application/problem+json": {
|
|
1475
1894
|
"schema": {
|
|
1476
1895
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1896
|
+
},
|
|
1897
|
+
"examples": {
|
|
1898
|
+
"MalformedRequestBodyExample": {
|
|
1899
|
+
"$ref": "#/components/examples/MalformedRequestBodyExample"
|
|
1900
|
+
}
|
|
1477
1901
|
}
|
|
1478
1902
|
}
|
|
1479
1903
|
}
|
|
@@ -1490,6 +1914,11 @@
|
|
|
1490
1914
|
"application/problem+json": {
|
|
1491
1915
|
"schema": {
|
|
1492
1916
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1917
|
+
},
|
|
1918
|
+
"examples": {
|
|
1919
|
+
"AttributeDefinitionNotFoundExample": {
|
|
1920
|
+
"$ref": "#/components/examples/AttributeDefinitionNotFoundExample"
|
|
1921
|
+
}
|
|
1493
1922
|
}
|
|
1494
1923
|
}
|
|
1495
1924
|
}
|
|
@@ -1509,10 +1938,14 @@
|
|
|
1509
1938
|
"schemas": {
|
|
1510
1939
|
"OrganizationId": {
|
|
1511
1940
|
"type": "string",
|
|
1941
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
1942
|
+
"example": "f_ecom_zzxy_prd",
|
|
1512
1943
|
"pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
|
|
1513
1944
|
},
|
|
1514
1945
|
"Select": {
|
|
1515
1946
|
"type": "string",
|
|
1947
|
+
"description": "The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names or work with wildcards. You can also specify array operations and filter expressions. The actual selector value must be enclosed within parentheses. For more information, please read the documentation about property selectors [here](https://developer.salesforce.com/docs/commerce/commerce-api/guide/scapi-property-selection.html).",
|
|
1948
|
+
"example": "(name,id,variationAttributes.(**))",
|
|
1516
1949
|
"minLength": 1,
|
|
1517
1950
|
"pattern": "^[(].*[)]$"
|
|
1518
1951
|
},
|
|
@@ -1520,14 +1953,19 @@
|
|
|
1520
1953
|
"type": "integer",
|
|
1521
1954
|
"format": "int32",
|
|
1522
1955
|
"default": 0,
|
|
1956
|
+
"description": "The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.",
|
|
1957
|
+
"example": 10,
|
|
1523
1958
|
"minimum": 0
|
|
1524
1959
|
},
|
|
1525
1960
|
"ResultBase": {
|
|
1526
1961
|
"type": "object",
|
|
1962
|
+
"description": "Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema. \nAdditionally it needs to be defined what data is returned.",
|
|
1527
1963
|
"properties": {
|
|
1528
1964
|
"limit": {
|
|
1529
1965
|
"type": "integer",
|
|
1530
|
-
"format": "int32"
|
|
1966
|
+
"format": "int32",
|
|
1967
|
+
"description": "Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter `limit` of the endpoint returning this schema.",
|
|
1968
|
+
"example": 10
|
|
1531
1969
|
},
|
|
1532
1970
|
"total": {
|
|
1533
1971
|
"$ref": "#/components/schemas/Total"
|
|
@@ -1542,6 +1980,8 @@
|
|
|
1542
1980
|
"type": "integer",
|
|
1543
1981
|
"format": "int32",
|
|
1544
1982
|
"default": 0,
|
|
1983
|
+
"description": "The zero-based index of the first hit/data to include in the result.",
|
|
1984
|
+
"example": 0,
|
|
1545
1985
|
"minimum": 0
|
|
1546
1986
|
},
|
|
1547
1987
|
"PaginatedResultBase": {
|
|
@@ -1550,6 +1990,7 @@
|
|
|
1550
1990
|
"$ref": "#/components/schemas/ResultBase"
|
|
1551
1991
|
}
|
|
1552
1992
|
],
|
|
1993
|
+
"description": "Schema defining generic pageable result. Each response schema of a resource requiring pagination should extend this schema. \nIf you use this extend this schema directly, it needs to be defined what data is returned. Allowed names for the data field is `data`.",
|
|
1553
1994
|
"properties": {
|
|
1554
1995
|
"offset": {
|
|
1555
1996
|
"$ref": "#/components/schemas/Offset"
|
|
@@ -1563,46 +2004,79 @@
|
|
|
1563
2004
|
},
|
|
1564
2005
|
"ObjectTypeDefinition": {
|
|
1565
2006
|
"type": "object",
|
|
2007
|
+
"description": "Document representing a system object type definition",
|
|
1566
2008
|
"properties": {
|
|
1567
2009
|
"objectType": {
|
|
1568
2010
|
"type": "string",
|
|
2011
|
+
"description": "The unique identifier of the system object type",
|
|
2012
|
+
"example": "Product",
|
|
1569
2013
|
"maxLength": 256
|
|
1570
2014
|
},
|
|
1571
2015
|
"displayName": {
|
|
1572
2016
|
"type": "object",
|
|
1573
2017
|
"additionalProperties": {
|
|
1574
2018
|
"type": "string",
|
|
2019
|
+
"description": "Localized string",
|
|
2020
|
+
"example": "Localized value",
|
|
1575
2021
|
"maxLength": 4000
|
|
1576
|
-
}
|
|
2022
|
+
},
|
|
2023
|
+
"description": "B2C Commerce API - Localization doc: https://developer.salesforce.com/docs/commerce/commerce-api/guide/b2c-localization.html",
|
|
2024
|
+
"example": {
|
|
2025
|
+
"default": "Product",
|
|
2026
|
+
"de": "Produkt",
|
|
2027
|
+
"en": "Product"
|
|
2028
|
+
},
|
|
2029
|
+
"x-format": "localized"
|
|
1577
2030
|
},
|
|
1578
2031
|
"description": {
|
|
1579
2032
|
"type": "object",
|
|
1580
2033
|
"additionalProperties": {
|
|
1581
2034
|
"type": "string",
|
|
2035
|
+
"description": "Localized string",
|
|
2036
|
+
"example": "Localized value",
|
|
1582
2037
|
"maxLength": 4000
|
|
1583
|
-
}
|
|
2038
|
+
},
|
|
2039
|
+
"description": "B2C Commerce API - Localization doc: https://developer.salesforce.com/docs/commerce/commerce-api/guide/b2c-localization.html",
|
|
2040
|
+
"example": {
|
|
2041
|
+
"default": "Object type representing products.",
|
|
2042
|
+
"de": "Objekttyp, der Produkte repräsentiert.",
|
|
2043
|
+
"en": "Object type representing products."
|
|
2044
|
+
},
|
|
2045
|
+
"x-format": "localized"
|
|
1584
2046
|
},
|
|
1585
2047
|
"readOnly": {
|
|
1586
2048
|
"type": "boolean",
|
|
2049
|
+
"description": "Flag indicating if this object type is read-only",
|
|
2050
|
+
"example": false,
|
|
1587
2051
|
"readOnly": true
|
|
1588
2052
|
},
|
|
1589
2053
|
"queryable": {
|
|
1590
|
-
"type": "boolean"
|
|
2054
|
+
"type": "boolean",
|
|
2055
|
+
"description": "Flag indicating if this object type can be queried",
|
|
2056
|
+
"example": true
|
|
1591
2057
|
},
|
|
1592
2058
|
"searchable": {
|
|
1593
|
-
"type": "boolean"
|
|
2059
|
+
"type": "boolean",
|
|
2060
|
+
"description": "Flag indicating if this object type is searchable",
|
|
2061
|
+
"example": true
|
|
1594
2062
|
},
|
|
1595
2063
|
"contentObject": {
|
|
1596
|
-
"type": "boolean"
|
|
2064
|
+
"type": "boolean",
|
|
2065
|
+
"description": "Flag indicating if this is a content object",
|
|
2066
|
+
"example": true
|
|
1597
2067
|
},
|
|
1598
2068
|
"attributeDefinitionCount": {
|
|
1599
2069
|
"type": "integer",
|
|
1600
2070
|
"format": "int32",
|
|
2071
|
+
"description": "The number of attribute definitions for this object type",
|
|
2072
|
+
"example": 150,
|
|
1601
2073
|
"readOnly": true
|
|
1602
2074
|
},
|
|
1603
2075
|
"attributeGroupCount": {
|
|
1604
2076
|
"type": "integer",
|
|
1605
2077
|
"format": "int32",
|
|
2078
|
+
"description": "The number of attribute groups for this object type",
|
|
2079
|
+
"example": 8,
|
|
1606
2080
|
"readOnly": true
|
|
1607
2081
|
}
|
|
1608
2082
|
}
|
|
@@ -1613,9 +2087,11 @@
|
|
|
1613
2087
|
"$ref": "#/components/schemas/PaginatedResultBase"
|
|
1614
2088
|
}
|
|
1615
2089
|
],
|
|
2090
|
+
"description": "Document representing a paginated collection of object type definition",
|
|
1616
2091
|
"properties": {
|
|
1617
2092
|
"data": {
|
|
1618
2093
|
"type": "array",
|
|
2094
|
+
"description": "List of system object types",
|
|
1619
2095
|
"items": {
|
|
1620
2096
|
"$ref": "#/components/schemas/ObjectTypeDefinition"
|
|
1621
2097
|
}
|
|
@@ -1628,17 +2104,25 @@
|
|
|
1628
2104
|
"properties": {
|
|
1629
2105
|
"title": {
|
|
1630
2106
|
"type": "string",
|
|
2107
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the \nproblem, except for purposes of localization\n",
|
|
2108
|
+
"example": "You do not have enough credit",
|
|
1631
2109
|
"maxLength": 256
|
|
1632
2110
|
},
|
|
1633
2111
|
"type": {
|
|
1634
2112
|
"type": "string",
|
|
2113
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
2114
|
+
"example": "NotEnoughMoney",
|
|
1635
2115
|
"maxLength": 2048
|
|
1636
2116
|
},
|
|
1637
2117
|
"detail": {
|
|
1638
|
-
"type": "string"
|
|
2118
|
+
"type": "string",
|
|
2119
|
+
"description": "A human-readable explanation specific to this occurrence of the problem.",
|
|
2120
|
+
"example": "Your current balance is 30, but that costs 50"
|
|
1639
2121
|
},
|
|
1640
2122
|
"instance": {
|
|
1641
2123
|
"type": "string",
|
|
2124
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
2125
|
+
"example": "/account/12345/msgs/abc",
|
|
1642
2126
|
"maxLength": 2048
|
|
1643
2127
|
}
|
|
1644
2128
|
},
|
|
@@ -1651,6 +2135,28 @@
|
|
|
1651
2135
|
"Query": {
|
|
1652
2136
|
"type": "object",
|
|
1653
2137
|
"additionalProperties": false,
|
|
2138
|
+
"description": "A set of objects that define criteria used to select records. A query can contain one of the following:\n* `MatchAllQuery`\n - Matches all documents.\n* `TermQuery`\n - Matches one or more documents against one or more document fields.\n* `TextQuery`\n - Matches text against one or more fields.\n* `BoolQuery`\n - Allows construction of a logical expression of multiple queries.\n* `FilteredQuery`\n - Allows a filter to be applied to a query.\n* `NestedQuery`\n - Allows you to query on nested documents.\n - _Only supported by some Commerce APIs. For more details, see the endpoint descriptions in the API documentation._",
|
|
2139
|
+
"example": {
|
|
2140
|
+
"filteredQuery": {
|
|
2141
|
+
"query": {
|
|
2142
|
+
"textQuery": {
|
|
2143
|
+
"fields": [
|
|
2144
|
+
"couponId"
|
|
2145
|
+
],
|
|
2146
|
+
"searchPhrase": "disabled"
|
|
2147
|
+
}
|
|
2148
|
+
},
|
|
2149
|
+
"filter": {
|
|
2150
|
+
"termFilter": {
|
|
2151
|
+
"field": "enabled",
|
|
2152
|
+
"operator": "is",
|
|
2153
|
+
"values": [
|
|
2154
|
+
false
|
|
2155
|
+
]
|
|
2156
|
+
}
|
|
2157
|
+
}
|
|
2158
|
+
}
|
|
2159
|
+
},
|
|
1654
2160
|
"maxProperties": 1,
|
|
1655
2161
|
"minProperties": 1,
|
|
1656
2162
|
"properties": {
|
|
@@ -1677,21 +2183,58 @@
|
|
|
1677
2183
|
"BoolQuery": {
|
|
1678
2184
|
"type": "object",
|
|
1679
2185
|
"additionalProperties": false,
|
|
2186
|
+
"description": "A boolean query allows construction of full logical expression trees that are composed of other queries (usually term queries and text queries). A boolean query has three sets of clauses:\n \n - `must`, which combines as an `AND` operator.\n - `should`, which combines as an `OR` operator.\n - `must_not`, which combines as a `NOT` operator.\n \nIf `must`, `mustNot`, or `should` appear in the same boolean query, they are combined logically using the `AND` operator. For example:\n\n (must-1 AND must-1 AND ...)\n AND (should-1 OR should-2 OR ...)\n AND NOT (must_not-1 OR must_not-2 OR ...)\n",
|
|
2187
|
+
"example": {
|
|
2188
|
+
"must": [
|
|
2189
|
+
{
|
|
2190
|
+
"textQuery": {
|
|
2191
|
+
"fields": [
|
|
2192
|
+
"couponId"
|
|
2193
|
+
],
|
|
2194
|
+
"searchPhrase": "DEAL"
|
|
2195
|
+
}
|
|
2196
|
+
},
|
|
2197
|
+
{
|
|
2198
|
+
"textQuery": {
|
|
2199
|
+
"fields": [
|
|
2200
|
+
"description"
|
|
2201
|
+
],
|
|
2202
|
+
"searchPhrase": "Big bargain deal"
|
|
2203
|
+
}
|
|
2204
|
+
}
|
|
2205
|
+
],
|
|
2206
|
+
"mustNot": [
|
|
2207
|
+
{
|
|
2208
|
+
"termQuery": {
|
|
2209
|
+
"fields": [
|
|
2210
|
+
"enabled"
|
|
2211
|
+
],
|
|
2212
|
+
"operator": "is",
|
|
2213
|
+
"values": [
|
|
2214
|
+
false
|
|
2215
|
+
]
|
|
2216
|
+
}
|
|
2217
|
+
}
|
|
2218
|
+
]
|
|
2219
|
+
},
|
|
1680
2220
|
"properties": {
|
|
1681
2221
|
"must": {
|
|
1682
2222
|
"type": "array",
|
|
2223
|
+
"description": "List of queries to be evaluated as an `AND` operator.",
|
|
1683
2224
|
"items": {
|
|
1684
2225
|
"$ref": "#/components/schemas/Query"
|
|
1685
2226
|
}
|
|
1686
2227
|
},
|
|
1687
2228
|
"mustNot": {
|
|
1688
2229
|
"type": "array",
|
|
2230
|
+
"description": "List of queries to be evaluated as a `NOT` operator.",
|
|
1689
2231
|
"items": {
|
|
1690
2232
|
"$ref": "#/components/schemas/Query"
|
|
1691
2233
|
}
|
|
1692
2234
|
},
|
|
1693
2235
|
"should": {
|
|
1694
2236
|
"type": "array",
|
|
2237
|
+
"description": "List of queries to be evaluated as an `OR` operator.",
|
|
1695
2238
|
"items": {
|
|
1696
2239
|
"$ref": "#/components/schemas/Query"
|
|
1697
2240
|
}
|
|
@@ -1701,6 +2244,7 @@
|
|
|
1701
2244
|
"Filter": {
|
|
1702
2245
|
"type": "object",
|
|
1703
2246
|
"additionalProperties": false,
|
|
2247
|
+
"description": "Contains a set of objects that define criteria used to select records. A filter can contain one of the following:\n * `TermFilter`\n - Matches records where a field (or fields) exactly matches some simple value (including `null`).\n * `RangeFilter`\n - Matches records where a field value lies within a specified range.\n * `Range2Filter`\n - Matches records in a specified range across fields.\n * `QueryFilter`\n - Matches records based on a query.\n * `BoolFilter`\n - Provides filtering of records using a set of filters combined using a logical operator.",
|
|
1704
2248
|
"maxProperties": 1,
|
|
1705
2249
|
"minProperties": 1,
|
|
1706
2250
|
"properties": {
|
|
@@ -1724,20 +2268,47 @@
|
|
|
1724
2268
|
"BoolFilter": {
|
|
1725
2269
|
"type": "object",
|
|
1726
2270
|
"additionalProperties": false,
|
|
2271
|
+
"description": "Allows you to combine other filters into (possibly recursive) logical expression trees. A boolean filter is composed of a logical operator (`AND`, `OR`, `NOT`) and a list of filters that the operator relates to. Multiple filters can be negated with a single `NOT` operator, even when the filters are combined with the `AND` operator.",
|
|
2272
|
+
"example": {
|
|
2273
|
+
"operator": "and",
|
|
2274
|
+
"filters": [
|
|
2275
|
+
{
|
|
2276
|
+
"termFilter": {
|
|
2277
|
+
"field": "id",
|
|
2278
|
+
"operator": "is",
|
|
2279
|
+
"values": [
|
|
2280
|
+
"myId"
|
|
2281
|
+
]
|
|
2282
|
+
}
|
|
2283
|
+
},
|
|
2284
|
+
{
|
|
2285
|
+
"termFilter": {
|
|
2286
|
+
"field": "couponId",
|
|
2287
|
+
"operator": "is",
|
|
2288
|
+
"values": [
|
|
2289
|
+
"couponOne"
|
|
2290
|
+
]
|
|
2291
|
+
}
|
|
2292
|
+
}
|
|
2293
|
+
]
|
|
2294
|
+
},
|
|
1727
2295
|
"properties": {
|
|
1728
2296
|
"filters": {
|
|
1729
2297
|
"type": "array",
|
|
2298
|
+
"description": "A list of filters that are logically combined by an operator.",
|
|
1730
2299
|
"items": {
|
|
1731
2300
|
"$ref": "#/components/schemas/Filter"
|
|
1732
2301
|
}
|
|
1733
2302
|
},
|
|
1734
2303
|
"operator": {
|
|
1735
2304
|
"type": "string",
|
|
2305
|
+
"description": "The logical operator that is used to combine the filters.",
|
|
1736
2306
|
"enum": [
|
|
1737
2307
|
"and",
|
|
1738
2308
|
"or",
|
|
1739
2309
|
"not"
|
|
1740
|
-
]
|
|
2310
|
+
],
|
|
2311
|
+
"example": "and"
|
|
1741
2312
|
}
|
|
1742
2313
|
},
|
|
1743
2314
|
"required": [
|
|
@@ -1746,6 +2317,7 @@
|
|
|
1746
2317
|
},
|
|
1747
2318
|
"QueryFilter": {
|
|
1748
2319
|
"type": "object",
|
|
2320
|
+
"description": "Wraps any query and allows it to be used as a filter.",
|
|
1749
2321
|
"properties": {
|
|
1750
2322
|
"query": {
|
|
1751
2323
|
"$ref": "#/components/schemas/Query"
|
|
@@ -1757,45 +2329,71 @@
|
|
|
1757
2329
|
},
|
|
1758
2330
|
"Field": {
|
|
1759
2331
|
"type": "string",
|
|
2332
|
+
"description": "Name of the field. Might be a custom field name prefixed with c_.",
|
|
2333
|
+
"example": "couponId",
|
|
1760
2334
|
"maxLength": 260
|
|
1761
2335
|
},
|
|
1762
2336
|
"Range2Filter": {
|
|
1763
2337
|
"type": "object",
|
|
1764
2338
|
"additionalProperties": false,
|
|
2339
|
+
"description": "Allows you to restrict a search result to hits where a range defined by specified attributes has a certain relationship to a specified range.\n\nThe first range (R1) is defined by a pair of attributes (`fromField` and `toField`) that specify the extent of a range, such as attributes `validFrom` and `validTo`.\n\nThe second range (R2) is defined by `fromValue` and `toValue`.\n\nThe filter mode specifies the method used to compare the two ranges:\n\n* `overlap`: R1 overlaps fully or partially with R2.\n* `containing`: R1 contains R2.\n* `contained`: R1 is contained in R2.\n\nThe range filter supports several value types, and relies on the natural sorting of the value type for range interpretation. Value ranges can be open-ended, but only at one end of the range. You can configure whether the lower bounds and upper bounds are inclusive or exclusive.\n\nA range 2 filter is useful for general restrictions that can be shared between searches (like a static date range) because the filter result is cached in memory. Range filters are not appropriate if the range is expected to be different for every query (for example, if the user controls the date range down to the hour via a UI control). Range filters are inclusive by default.",
|
|
2340
|
+
"example": {
|
|
2341
|
+
"fromField": "validFrom",
|
|
2342
|
+
"toField": "validTo",
|
|
2343
|
+
"filterMode": "overlap",
|
|
2344
|
+
"fromValue": "2007-01-01T00:00:00.000Z",
|
|
2345
|
+
"toValue": "2017-01-01T00:00:00.000Z"
|
|
2346
|
+
},
|
|
1765
2347
|
"properties": {
|
|
1766
2348
|
"filterMode": {
|
|
1767
2349
|
"type": "string",
|
|
1768
2350
|
"default": "overlap",
|
|
2351
|
+
"description": "Compare mode: overlap, containing, or contained.",
|
|
1769
2352
|
"enum": [
|
|
1770
2353
|
"overlap",
|
|
1771
2354
|
"containing",
|
|
1772
2355
|
"contained"
|
|
1773
|
-
]
|
|
2356
|
+
],
|
|
2357
|
+
"example": "overlap"
|
|
1774
2358
|
},
|
|
1775
2359
|
"fromField": {
|
|
1776
2360
|
"allOf": [
|
|
1777
2361
|
{
|
|
1778
2362
|
"$ref": "#/components/schemas/Field"
|
|
1779
2363
|
}
|
|
1780
|
-
]
|
|
2364
|
+
],
|
|
2365
|
+
"description": "The field name of the field that starts the first range.",
|
|
2366
|
+
"example": "validFrom"
|
|
1781
2367
|
},
|
|
1782
2368
|
"fromInclusive": {
|
|
1783
2369
|
"type": "boolean",
|
|
1784
|
-
"default": true
|
|
2370
|
+
"default": true,
|
|
2371
|
+
"description": "A flag indicating if the lower bound of the second range is inclusive. To make the lower bound exclusive, set to `false`.",
|
|
2372
|
+
"example": true
|
|
2373
|
+
},
|
|
2374
|
+
"fromValue": {
|
|
2375
|
+
"description": "The lower bound of the second range. If not specified, the range is open-ended with respect to the lower bound. You can't leave both the lower and upper bounds open-ended.",
|
|
2376
|
+
"example": "2007-01-01T00:00:00.000Z"
|
|
1785
2377
|
},
|
|
1786
|
-
"fromValue": {},
|
|
1787
2378
|
"toField": {
|
|
1788
2379
|
"allOf": [
|
|
1789
2380
|
{
|
|
1790
2381
|
"$ref": "#/components/schemas/Field"
|
|
1791
2382
|
}
|
|
1792
|
-
]
|
|
2383
|
+
],
|
|
2384
|
+
"description": "The field name of the field that ends the first range.",
|
|
2385
|
+
"example": "validTo"
|
|
1793
2386
|
},
|
|
1794
2387
|
"toInclusive": {
|
|
1795
2388
|
"type": "boolean",
|
|
1796
|
-
"default": true
|
|
2389
|
+
"default": true,
|
|
2390
|
+
"description": "A flag indicating if the upper bound of the second range is inclusive. To make the lower bound exclusive, set to `false`.",
|
|
2391
|
+
"example": true
|
|
1797
2392
|
},
|
|
1798
|
-
"toValue": {
|
|
2393
|
+
"toValue": {
|
|
2394
|
+
"description": "The upper bound of the second range. If not specified, the range is open-ended with respect to the upper bound. You can't leave both the upper and lower bounds open-ended.",
|
|
2395
|
+
"example": "2017-01-01T00:00:00.000Z"
|
|
2396
|
+
}
|
|
1799
2397
|
},
|
|
1800
2398
|
"required": [
|
|
1801
2399
|
"fromField",
|
|
@@ -1804,49 +2402,64 @@
|
|
|
1804
2402
|
},
|
|
1805
2403
|
"RangeFilter": {
|
|
1806
2404
|
"type": "object",
|
|
2405
|
+
"description": "Allows you to restrict a search result to hits that have values for a given attribute that fall within a given value range. The range filter supports several value types and relies on the natural sorting of the value type for range interpretation. Value ranges can be open-ended, but only at one end of the range. You can configure whether the lower bounds and upper bounds are inclusive or exclusive.\n\nA range filter is useful for general restrictions that can be shared between searches (like a static date range) because the filter result is cached in memory. Range filters are not appropriate if the range is expected to be different for every query (for example, if the user controls the date range down to the hour via a UI control). Range filters are inclusive by default.",
|
|
1807
2406
|
"properties": {
|
|
1808
2407
|
"field": {
|
|
1809
2408
|
"allOf": [
|
|
1810
2409
|
{
|
|
1811
2410
|
"$ref": "#/components/schemas/Field"
|
|
1812
2411
|
}
|
|
1813
|
-
]
|
|
2412
|
+
],
|
|
2413
|
+
"description": "The search field.",
|
|
2414
|
+
"example": "validFrom"
|
|
1814
2415
|
},
|
|
1815
2416
|
"from": {
|
|
2417
|
+
"description": "The lower bound of the filter range. If not specified, the range is open-ended with respect to the lower bound. You can't leave both the lower and upper bounds open-ended.",
|
|
1816
2418
|
"oneOf": [
|
|
1817
2419
|
{
|
|
1818
2420
|
"type": "string",
|
|
1819
|
-
"format": "date-time"
|
|
2421
|
+
"format": "date-time",
|
|
2422
|
+
"example": "2007-01-01T00:00:00Z"
|
|
1820
2423
|
},
|
|
1821
2424
|
{
|
|
1822
|
-
"type": "integer"
|
|
2425
|
+
"type": "integer",
|
|
2426
|
+
"example": 1
|
|
1823
2427
|
},
|
|
1824
2428
|
{
|
|
1825
|
-
"type": "number"
|
|
2429
|
+
"type": "number",
|
|
2430
|
+
"example": 1
|
|
1826
2431
|
}
|
|
1827
2432
|
]
|
|
1828
2433
|
},
|
|
1829
2434
|
"fromInclusive": {
|
|
1830
2435
|
"type": "boolean",
|
|
1831
|
-
"default": true
|
|
2436
|
+
"default": true,
|
|
2437
|
+
"description": "A flag indicating if the lower bound of the range is inclusive. To make the lower bound exclusive, set to `false`.",
|
|
2438
|
+
"example": true
|
|
1832
2439
|
},
|
|
1833
2440
|
"to": {
|
|
2441
|
+
"description": "The upper bound of the filter range. If not specified, the range is open-ended with respect to the upper bound. You can't leave both the upper and lower bounds open-ended.",
|
|
1834
2442
|
"oneOf": [
|
|
1835
2443
|
{
|
|
1836
2444
|
"type": "string",
|
|
1837
|
-
"format": "date-time"
|
|
2445
|
+
"format": "date-time",
|
|
2446
|
+
"example": "2007-01-02T00:00:00Z"
|
|
1838
2447
|
},
|
|
1839
2448
|
{
|
|
1840
|
-
"type": "integer"
|
|
2449
|
+
"type": "integer",
|
|
2450
|
+
"example": 2
|
|
1841
2451
|
},
|
|
1842
2452
|
{
|
|
1843
|
-
"type": "number"
|
|
2453
|
+
"type": "number",
|
|
2454
|
+
"example": 2
|
|
1844
2455
|
}
|
|
1845
2456
|
]
|
|
1846
2457
|
},
|
|
1847
2458
|
"toInclusive": {
|
|
1848
2459
|
"type": "boolean",
|
|
1849
|
-
"default": true
|
|
2460
|
+
"default": true,
|
|
2461
|
+
"description": "A flag indicating if the upper bound of the range is inclusive. To make the upper bound exclusive, set to `false`.",
|
|
2462
|
+
"example": true
|
|
1850
2463
|
}
|
|
1851
2464
|
},
|
|
1852
2465
|
"required": [
|
|
@@ -1856,16 +2469,26 @@
|
|
|
1856
2469
|
"TermFilter": {
|
|
1857
2470
|
"type": "object",
|
|
1858
2471
|
"additionalProperties": false,
|
|
2472
|
+
"description": "Allows you to restrict a search result to hits that match exactly one of the values configured for the filter. A term filter is useful for general restrictions that can be shared between searches. Use term filters whenever the criteria you filter on is a shared property of multiple searches (for example, like filtering by an order status). Use term filters for fields that have a discrete and small set of values only.",
|
|
2473
|
+
"example": {
|
|
2474
|
+
"field": "id",
|
|
2475
|
+
"operator": "is",
|
|
2476
|
+
"values": [
|
|
2477
|
+
"myId"
|
|
2478
|
+
]
|
|
2479
|
+
},
|
|
1859
2480
|
"properties": {
|
|
1860
2481
|
"field": {
|
|
1861
2482
|
"allOf": [
|
|
1862
2483
|
{
|
|
1863
2484
|
"$ref": "#/components/schemas/Field"
|
|
1864
2485
|
}
|
|
1865
|
-
]
|
|
2486
|
+
],
|
|
2487
|
+
"description": "The filter field."
|
|
1866
2488
|
},
|
|
1867
2489
|
"operator": {
|
|
1868
2490
|
"type": "string",
|
|
2491
|
+
"description": "The operator used to compare the field's values with the given values.",
|
|
1869
2492
|
"enum": [
|
|
1870
2493
|
"is",
|
|
1871
2494
|
"one_of",
|
|
@@ -1875,12 +2498,15 @@
|
|
|
1875
2498
|
"greater",
|
|
1876
2499
|
"not_in",
|
|
1877
2500
|
"neq"
|
|
1878
|
-
]
|
|
2501
|
+
],
|
|
2502
|
+
"example": "is"
|
|
1879
2503
|
},
|
|
1880
2504
|
"values": {
|
|
1881
2505
|
"type": "array",
|
|
2506
|
+
"description": "The filter values.",
|
|
1882
2507
|
"items": {
|
|
1883
|
-
"type": "string"
|
|
2508
|
+
"type": "string",
|
|
2509
|
+
"example": "myId"
|
|
1884
2510
|
}
|
|
1885
2511
|
}
|
|
1886
2512
|
},
|
|
@@ -1892,6 +2518,26 @@
|
|
|
1892
2518
|
"FilteredQuery": {
|
|
1893
2519
|
"type": "object",
|
|
1894
2520
|
"additionalProperties": false,
|
|
2521
|
+
"description": "Allows to filter the result of a possibly complex query using a possibly complex filter.",
|
|
2522
|
+
"example": {
|
|
2523
|
+
"query": {
|
|
2524
|
+
"textQuery": {
|
|
2525
|
+
"fields": [
|
|
2526
|
+
"couponId"
|
|
2527
|
+
],
|
|
2528
|
+
"searchPhrase": "disabled"
|
|
2529
|
+
}
|
|
2530
|
+
},
|
|
2531
|
+
"filter": {
|
|
2532
|
+
"termFilter": {
|
|
2533
|
+
"field": "enabled",
|
|
2534
|
+
"operator": "is",
|
|
2535
|
+
"values": [
|
|
2536
|
+
false
|
|
2537
|
+
]
|
|
2538
|
+
}
|
|
2539
|
+
}
|
|
2540
|
+
},
|
|
1895
2541
|
"properties": {
|
|
1896
2542
|
"filter": {
|
|
1897
2543
|
"$ref": "#/components/schemas/Filter"
|
|
@@ -1906,14 +2552,62 @@
|
|
|
1906
2552
|
]
|
|
1907
2553
|
},
|
|
1908
2554
|
"MatchAllQuery": {
|
|
1909
|
-
"type": "object"
|
|
2555
|
+
"type": "object",
|
|
2556
|
+
"description": "Matches all documents (namespace and document type). This query comes in handy if you just want to filter a search result or really do not have any constraints."
|
|
1910
2557
|
},
|
|
1911
2558
|
"NestedQuery": {
|
|
1912
2559
|
"type": "object",
|
|
1913
2560
|
"additionalProperties": false,
|
|
2561
|
+
"description": "Allows you to query nested documents that are part of a larger document. Say, for example, that you have a main product with variations in one big document, and you want to constrain a search to main products that have variations that match multiple constraints. \n\nA `NestedQuery` is only supported by some Commerce APIs. For more details, see the endpoint descriptions in the API documentation.\n",
|
|
2562
|
+
"example": {
|
|
2563
|
+
"path": "order.shippingAddresses",
|
|
2564
|
+
"query": {
|
|
2565
|
+
"boolQuery": {
|
|
2566
|
+
"must": [
|
|
2567
|
+
{
|
|
2568
|
+
"boolQuery": {
|
|
2569
|
+
"must": [
|
|
2570
|
+
{
|
|
2571
|
+
"termQuery": {
|
|
2572
|
+
"fields": [
|
|
2573
|
+
"order.shippingAddresses.firstName"
|
|
2574
|
+
],
|
|
2575
|
+
"operator": "is",
|
|
2576
|
+
"values": [
|
|
2577
|
+
"John"
|
|
2578
|
+
]
|
|
2579
|
+
}
|
|
2580
|
+
}
|
|
2581
|
+
]
|
|
2582
|
+
}
|
|
2583
|
+
},
|
|
2584
|
+
{
|
|
2585
|
+
"boolQuery": {
|
|
2586
|
+
"must": [
|
|
2587
|
+
{
|
|
2588
|
+
"termQuery": {
|
|
2589
|
+
"fields": [
|
|
2590
|
+
"order.shippingAddresses.lastName"
|
|
2591
|
+
],
|
|
2592
|
+
"operator": "is",
|
|
2593
|
+
"values": [
|
|
2594
|
+
"Doe"
|
|
2595
|
+
]
|
|
2596
|
+
}
|
|
2597
|
+
}
|
|
2598
|
+
]
|
|
2599
|
+
}
|
|
2600
|
+
}
|
|
2601
|
+
]
|
|
2602
|
+
}
|
|
2603
|
+
},
|
|
2604
|
+
"scoreMode": "avg"
|
|
2605
|
+
},
|
|
1914
2606
|
"properties": {
|
|
1915
2607
|
"path": {
|
|
1916
2608
|
"type": "string",
|
|
2609
|
+
"description": "The path to the nested document.",
|
|
2610
|
+
"example": "order.shippingAddresses",
|
|
1917
2611
|
"maxLength": 2048
|
|
1918
2612
|
},
|
|
1919
2613
|
"query": {
|
|
@@ -1921,12 +2615,14 @@
|
|
|
1921
2615
|
},
|
|
1922
2616
|
"scoreMode": {
|
|
1923
2617
|
"type": "string",
|
|
2618
|
+
"description": "Indicates how scores for matching child objects affect the root parent document’s relevance score.",
|
|
1924
2619
|
"enum": [
|
|
1925
2620
|
"avg",
|
|
1926
2621
|
"total",
|
|
1927
2622
|
"max",
|
|
1928
2623
|
"none"
|
|
1929
|
-
]
|
|
2624
|
+
],
|
|
2625
|
+
"example": "avg"
|
|
1930
2626
|
}
|
|
1931
2627
|
},
|
|
1932
2628
|
"required": [
|
|
@@ -1936,9 +2632,11 @@
|
|
|
1936
2632
|
},
|
|
1937
2633
|
"TermQuery": {
|
|
1938
2634
|
"type": "object",
|
|
2635
|
+
"description": "A term query matches one or more values against one or more document fields. A document is considered a hit if one of the values matches exactly with at least one of the given fields. The operator `is` can only take one value, while `one_of` can take multiple values. If multiple fields are specified, they are combined using a logical `OR` operator.\n\n**Limitations:**\n\n* The `greater` and `less` operators are not supported under certain conditions. Both operators are permitted unless the API documentation states otherwise.\n* A subset of Commerce APIs handle queries with multiple fields differently. If the query has multiple fields, the query is internally handled as a logical `OR` of `DisjointMaxQueries` (with the dismax matching a value against all fields). The dismax makes sure that a document carrying a single term in multiple fields does not get higher scores than a document matching multiple terms in multiple fields.",
|
|
1939
2636
|
"properties": {
|
|
1940
2637
|
"fields": {
|
|
1941
2638
|
"type": "array",
|
|
2639
|
+
"description": "The document fields that the values are matched against, combined with the operator.",
|
|
1942
2640
|
"items": {
|
|
1943
2641
|
"$ref": "#/components/schemas/Field"
|
|
1944
2642
|
},
|
|
@@ -1946,6 +2644,7 @@
|
|
|
1946
2644
|
},
|
|
1947
2645
|
"operator": {
|
|
1948
2646
|
"type": "string",
|
|
2647
|
+
"description": "Returns the operator to use for the term query.",
|
|
1949
2648
|
"enum": [
|
|
1950
2649
|
"is",
|
|
1951
2650
|
"one_of",
|
|
@@ -1955,23 +2654,30 @@
|
|
|
1955
2654
|
"greater",
|
|
1956
2655
|
"not_in",
|
|
1957
2656
|
"neq"
|
|
1958
|
-
]
|
|
2657
|
+
],
|
|
2658
|
+
"example": "is"
|
|
1959
2659
|
},
|
|
1960
2660
|
"values": {
|
|
1961
2661
|
"type": "array",
|
|
2662
|
+
"description": "The values that the fields are compared against, combined with the operator.",
|
|
1962
2663
|
"items": {
|
|
2664
|
+
"example": "myCouponId",
|
|
1963
2665
|
"oneOf": [
|
|
1964
2666
|
{
|
|
1965
|
-
"type": "string"
|
|
2667
|
+
"type": "string",
|
|
2668
|
+
"example": "myCouponId"
|
|
1966
2669
|
},
|
|
1967
2670
|
{
|
|
1968
|
-
"type": "number"
|
|
2671
|
+
"type": "number",
|
|
2672
|
+
"example": 1
|
|
1969
2673
|
},
|
|
1970
2674
|
{
|
|
1971
|
-
"type": "boolean"
|
|
2675
|
+
"type": "boolean",
|
|
2676
|
+
"example": true
|
|
1972
2677
|
},
|
|
1973
2678
|
{
|
|
1974
|
-
"type": "integer"
|
|
2679
|
+
"type": "integer",
|
|
2680
|
+
"example": 1
|
|
1975
2681
|
}
|
|
1976
2682
|
]
|
|
1977
2683
|
}
|
|
@@ -1985,16 +2691,26 @@
|
|
|
1985
2691
|
"TextQuery": {
|
|
1986
2692
|
"type": "object",
|
|
1987
2693
|
"additionalProperties": false,
|
|
2694
|
+
"description": "A text query is used to match some text (for example, a search phrase possibly consisting of multiple terms) against one or more fields. When multiple fields are provided, the phrase conceptually forms a logical `OR` over the fields. In this case, the terms of the phrase basically have to match within the text, that would result in concatenating all given fields.",
|
|
2695
|
+
"example": {
|
|
2696
|
+
"fields": [
|
|
2697
|
+
"couponId"
|
|
2698
|
+
],
|
|
2699
|
+
"searchPhrase": "limit"
|
|
2700
|
+
},
|
|
1988
2701
|
"properties": {
|
|
1989
2702
|
"fields": {
|
|
1990
2703
|
"type": "array",
|
|
2704
|
+
"description": "The document fields that the search phrase matches against.",
|
|
1991
2705
|
"items": {
|
|
1992
2706
|
"$ref": "#/components/schemas/Field"
|
|
1993
2707
|
},
|
|
1994
2708
|
"minItems": 1
|
|
1995
2709
|
},
|
|
1996
2710
|
"searchPhrase": {
|
|
1997
|
-
"type": "string"
|
|
2711
|
+
"type": "string",
|
|
2712
|
+
"description": "A search phrase, which can include multiple terms separated by spaces.",
|
|
2713
|
+
"example": "campaign summer"
|
|
1998
2714
|
}
|
|
1999
2715
|
},
|
|
2000
2716
|
"required": [
|
|
@@ -2005,18 +2721,27 @@
|
|
|
2005
2721
|
"Sort": {
|
|
2006
2722
|
"type": "object",
|
|
2007
2723
|
"additionalProperties": false,
|
|
2724
|
+
"description": "Document representing a sort request. Each API has a different default sort configuration that can be modified in the request.",
|
|
2725
|
+
"example": {
|
|
2726
|
+
"field": "couponId",
|
|
2727
|
+
"sortOrder": "desc"
|
|
2728
|
+
},
|
|
2008
2729
|
"properties": {
|
|
2009
2730
|
"field": {
|
|
2010
2731
|
"type": "string",
|
|
2732
|
+
"description": "The name of the field to sort on.",
|
|
2733
|
+
"example": "couponId",
|
|
2011
2734
|
"maxLength": 256
|
|
2012
2735
|
},
|
|
2013
2736
|
"sortOrder": {
|
|
2014
2737
|
"type": "string",
|
|
2015
2738
|
"default": "asc",
|
|
2739
|
+
"description": "The sort order to be applied when sorting. When omitted, the default sort order (asc) is used.",
|
|
2016
2740
|
"enum": [
|
|
2017
2741
|
"asc",
|
|
2018
2742
|
"desc"
|
|
2019
|
-
]
|
|
2743
|
+
],
|
|
2744
|
+
"example": "asc"
|
|
2020
2745
|
}
|
|
2021
2746
|
},
|
|
2022
2747
|
"required": [
|
|
@@ -2025,10 +2750,13 @@
|
|
|
2025
2750
|
},
|
|
2026
2751
|
"SearchRequest": {
|
|
2027
2752
|
"type": "object",
|
|
2753
|
+
"description": "Document representing a search request for retrieving items within the Data API. The query is a potentially complex set of expressions. The fields and expands that each query supports are defined within the search resource.",
|
|
2028
2754
|
"properties": {
|
|
2029
2755
|
"limit": {
|
|
2030
2756
|
"type": "integer",
|
|
2031
2757
|
"format": "int32",
|
|
2758
|
+
"description": "Maximum records to retrieve per request, not to exceed 200.",
|
|
2759
|
+
"example": 10,
|
|
2032
2760
|
"maximum": 200,
|
|
2033
2761
|
"minimum": 1
|
|
2034
2762
|
},
|
|
@@ -2037,6 +2765,7 @@
|
|
|
2037
2765
|
},
|
|
2038
2766
|
"sorts": {
|
|
2039
2767
|
"type": "array",
|
|
2768
|
+
"description": "The list of sort clauses configured for the search request. Sort clauses are optional. See the description of the search endpoint for details on the default sorting behavior that is used when explicit sorts are not passed.",
|
|
2040
2769
|
"items": {
|
|
2041
2770
|
"$ref": "#/components/schemas/Sort"
|
|
2042
2771
|
}
|
|
@@ -2055,9 +2784,11 @@
|
|
|
2055
2784
|
"$ref": "#/components/schemas/PaginatedResultBase"
|
|
2056
2785
|
}
|
|
2057
2786
|
],
|
|
2787
|
+
"description": "Document representing a system object type search result",
|
|
2058
2788
|
"properties": {
|
|
2059
2789
|
"hits": {
|
|
2060
2790
|
"type": "array",
|
|
2791
|
+
"description": "List of system object types matching the search criteria",
|
|
2061
2792
|
"items": {
|
|
2062
2793
|
"$ref": "#/components/schemas/ObjectTypeDefinition"
|
|
2063
2794
|
}
|
|
@@ -2069,6 +2800,7 @@
|
|
|
2069
2800
|
},
|
|
2070
2801
|
"ValueType": {
|
|
2071
2802
|
"type": "string",
|
|
2803
|
+
"description": "The type of an attribute value",
|
|
2072
2804
|
"enum": [
|
|
2073
2805
|
"string",
|
|
2074
2806
|
"int",
|
|
@@ -2088,18 +2820,24 @@
|
|
|
2088
2820
|
"set_of_double",
|
|
2089
2821
|
"enum_of_string",
|
|
2090
2822
|
"enum_of_int"
|
|
2091
|
-
]
|
|
2823
|
+
],
|
|
2824
|
+
"example": "string"
|
|
2092
2825
|
},
|
|
2093
2826
|
"ObjectAttributeValueDefinition": {
|
|
2094
2827
|
"type": "object",
|
|
2828
|
+
"description": "An attribute definition value",
|
|
2095
2829
|
"properties": {
|
|
2096
2830
|
"id": {
|
|
2097
2831
|
"type": "string",
|
|
2832
|
+
"description": "The ID of the attribute value",
|
|
2833
|
+
"example": "value-1",
|
|
2098
2834
|
"maxLength": 256,
|
|
2099
2835
|
"readOnly": true
|
|
2100
2836
|
},
|
|
2101
2837
|
"value": {
|
|
2102
2838
|
"type": "string",
|
|
2839
|
+
"description": "The value of the attribute",
|
|
2840
|
+
"example": "1",
|
|
2103
2841
|
"maxLength": 4000,
|
|
2104
2842
|
"readOnly": true
|
|
2105
2843
|
},
|
|
@@ -2107,35 +2845,60 @@
|
|
|
2107
2845
|
"type": "object",
|
|
2108
2846
|
"additionalProperties": {
|
|
2109
2847
|
"type": "string",
|
|
2848
|
+
"description": "Localized string",
|
|
2849
|
+
"example": "Localized value",
|
|
2110
2850
|
"maxLength": 4000
|
|
2111
2851
|
},
|
|
2112
|
-
"
|
|
2852
|
+
"description": "B2C Commerce API - Localization doc: https://developer.salesforce.com/docs/commerce/commerce-api/guide/b2c-localization.html",
|
|
2853
|
+
"example": {
|
|
2854
|
+
"default": "One",
|
|
2855
|
+
"de": "Eins",
|
|
2856
|
+
"en": "One"
|
|
2857
|
+
},
|
|
2858
|
+
"readOnly": true,
|
|
2859
|
+
"x-format": "localized"
|
|
2113
2860
|
},
|
|
2114
2861
|
"description": {
|
|
2115
2862
|
"type": "object",
|
|
2116
2863
|
"additionalProperties": {
|
|
2117
2864
|
"type": "string",
|
|
2865
|
+
"description": "Localized string",
|
|
2866
|
+
"example": "Localized value",
|
|
2118
2867
|
"maxLength": 4000
|
|
2119
2868
|
},
|
|
2120
|
-
"
|
|
2869
|
+
"description": "B2C Commerce API - Localization doc: https://developer.salesforce.com/docs/commerce/commerce-api/guide/b2c-localization.html",
|
|
2870
|
+
"example": {
|
|
2871
|
+
"default": "Object type representing products.",
|
|
2872
|
+
"de": "Objekttyp, der Produkte repräsentiert.",
|
|
2873
|
+
"en": "Object type representing products."
|
|
2874
|
+
},
|
|
2875
|
+
"readOnly": true,
|
|
2876
|
+
"x-format": "localized"
|
|
2121
2877
|
},
|
|
2122
2878
|
"position": {
|
|
2123
2879
|
"type": "number",
|
|
2124
2880
|
"format": "double",
|
|
2881
|
+
"description": "The position of the attribute value within the set of attribute values",
|
|
2882
|
+
"example": 1,
|
|
2125
2883
|
"readOnly": true
|
|
2126
2884
|
}
|
|
2127
2885
|
}
|
|
2128
2886
|
},
|
|
2129
2887
|
"ObjectAttributeDefinition": {
|
|
2130
2888
|
"type": "object",
|
|
2889
|
+
"description": "Document representing an attribute definition",
|
|
2131
2890
|
"properties": {
|
|
2132
2891
|
"id": {
|
|
2133
2892
|
"type": "string",
|
|
2893
|
+
"description": "The user supplied ID of the attribute",
|
|
2894
|
+
"example": "color",
|
|
2134
2895
|
"maxLength": 256,
|
|
2135
2896
|
"minLength": 1
|
|
2136
2897
|
},
|
|
2137
2898
|
"effectiveId": {
|
|
2138
2899
|
"type": "string",
|
|
2900
|
+
"description": "The effective ID, which is c_id if the attribute is custom, and just the id otherwise",
|
|
2901
|
+
"example": "c_color",
|
|
2139
2902
|
"maxLength": 256,
|
|
2140
2903
|
"readOnly": true
|
|
2141
2904
|
},
|
|
@@ -2143,108 +2906,179 @@
|
|
|
2143
2906
|
"type": "object",
|
|
2144
2907
|
"additionalProperties": {
|
|
2145
2908
|
"type": "string",
|
|
2909
|
+
"description": "Localized string",
|
|
2910
|
+
"example": "Localized value",
|
|
2146
2911
|
"maxLength": 4000
|
|
2147
|
-
}
|
|
2912
|
+
},
|
|
2913
|
+
"description": "B2C Commerce API - Localization doc: https://developer.salesforce.com/docs/commerce/commerce-api/guide/b2c-localization.html",
|
|
2914
|
+
"example": {
|
|
2915
|
+
"default": "Product",
|
|
2916
|
+
"de": "Produkt",
|
|
2917
|
+
"en": "Product"
|
|
2918
|
+
},
|
|
2919
|
+
"x-format": "localized"
|
|
2148
2920
|
},
|
|
2149
2921
|
"description": {
|
|
2150
2922
|
"type": "object",
|
|
2151
2923
|
"additionalProperties": {
|
|
2152
2924
|
"type": "string",
|
|
2925
|
+
"description": "Localized string",
|
|
2926
|
+
"example": "Localized value",
|
|
2153
2927
|
"maxLength": 4000
|
|
2154
|
-
}
|
|
2928
|
+
},
|
|
2929
|
+
"description": "B2C Commerce API - Localization doc: https://developer.salesforce.com/docs/commerce/commerce-api/guide/b2c-localization.html",
|
|
2930
|
+
"example": {
|
|
2931
|
+
"default": "Object type representing products.",
|
|
2932
|
+
"de": "Objekttyp, der Produkte repräsentiert.",
|
|
2933
|
+
"en": "Object type representing products."
|
|
2934
|
+
},
|
|
2935
|
+
"x-format": "localized"
|
|
2155
2936
|
},
|
|
2156
2937
|
"key": {
|
|
2157
|
-
"type": "boolean"
|
|
2938
|
+
"type": "boolean",
|
|
2939
|
+
"description": "Flag indicating if this is a key attribute",
|
|
2940
|
+
"example": false
|
|
2158
2941
|
},
|
|
2159
2942
|
"mandatory": {
|
|
2160
|
-
"type": "boolean"
|
|
2943
|
+
"type": "boolean",
|
|
2944
|
+
"description": "Flag indicating if a value is mandatory for the attribute",
|
|
2945
|
+
"example": false
|
|
2161
2946
|
},
|
|
2162
2947
|
"localizable": {
|
|
2163
|
-
"type": "boolean"
|
|
2948
|
+
"type": "boolean",
|
|
2949
|
+
"description": "Flag indicating if this attribute can be localized",
|
|
2950
|
+
"example": false
|
|
2164
2951
|
},
|
|
2165
2952
|
"siteSpecific": {
|
|
2166
|
-
"type": "boolean"
|
|
2953
|
+
"type": "boolean",
|
|
2954
|
+
"description": "Flag indicating if this attribute is site-specific",
|
|
2955
|
+
"example": false
|
|
2167
2956
|
},
|
|
2168
2957
|
"searchable": {
|
|
2169
|
-
"type": "boolean"
|
|
2958
|
+
"type": "boolean",
|
|
2959
|
+
"description": "Flag indicating if this attribute is searchable",
|
|
2960
|
+
"example": true
|
|
2170
2961
|
},
|
|
2171
2962
|
"queryable": {
|
|
2172
2963
|
"type": "boolean",
|
|
2964
|
+
"description": "Returns true if the attribute definition is explicitly marked queryable or if the attribute value type belongs to a queryable type. Computed and read-only.",
|
|
2965
|
+
"example": true,
|
|
2173
2966
|
"readOnly": true
|
|
2174
2967
|
},
|
|
2175
2968
|
"valueType": {
|
|
2176
2969
|
"$ref": "#/components/schemas/ValueType"
|
|
2177
2970
|
},
|
|
2178
2971
|
"visible": {
|
|
2179
|
-
"type": "boolean"
|
|
2972
|
+
"type": "boolean",
|
|
2973
|
+
"description": "Flag indicating if this attribute is visible",
|
|
2974
|
+
"example": true
|
|
2180
2975
|
},
|
|
2181
2976
|
"system": {
|
|
2182
|
-
"type": "boolean"
|
|
2977
|
+
"type": "boolean",
|
|
2978
|
+
"description": "Flag indicating if this attribute is a system attribute",
|
|
2979
|
+
"example": false
|
|
2183
2980
|
},
|
|
2184
2981
|
"unit": {
|
|
2185
2982
|
"type": "object",
|
|
2186
2983
|
"additionalProperties": {
|
|
2187
2984
|
"type": "string",
|
|
2985
|
+
"description": "Localized string",
|
|
2986
|
+
"example": "Localized value",
|
|
2188
2987
|
"maxLength": 4000
|
|
2189
|
-
}
|
|
2988
|
+
},
|
|
2989
|
+
"description": "B2C Commerce API - Localization doc: https://developer.salesforce.com/docs/commerce/commerce-api/guide/b2c-localization.html",
|
|
2990
|
+
"example": {
|
|
2991
|
+
"default": "General unit",
|
|
2992
|
+
"de": "Allgemeine Einheit",
|
|
2993
|
+
"en": "General unit"
|
|
2994
|
+
},
|
|
2995
|
+
"x-format": "localized"
|
|
2190
2996
|
},
|
|
2191
2997
|
"requiresEncoding": {
|
|
2192
2998
|
"type": "boolean",
|
|
2999
|
+
"description": "Flag indicating if this attribute can be encoded using the encoding='off' flag in ISML templates",
|
|
3000
|
+
"example": false,
|
|
2193
3001
|
"readOnly": true
|
|
2194
3002
|
},
|
|
2195
3003
|
"multiValueType": {
|
|
2196
|
-
"type": "boolean"
|
|
3004
|
+
"type": "boolean",
|
|
3005
|
+
"description": "True if the attribute can have multiple values. Applicable to set_of_* and enum_of_* types.",
|
|
3006
|
+
"example": false
|
|
2197
3007
|
},
|
|
2198
3008
|
"setValueType": {
|
|
2199
3009
|
"type": "boolean",
|
|
3010
|
+
"description": "Flag indicating if this attribute is of type 'Set of'",
|
|
3011
|
+
"example": false,
|
|
2200
3012
|
"readOnly": true
|
|
2201
3013
|
},
|
|
2202
3014
|
"externallyManaged": {
|
|
2203
|
-
"type": "boolean"
|
|
3015
|
+
"type": "boolean",
|
|
3016
|
+
"description": "Flag indicating if this attribute is externally managed",
|
|
3017
|
+
"example": false
|
|
2204
3018
|
},
|
|
2205
3019
|
"externallyDefined": {
|
|
2206
|
-
"type": "boolean"
|
|
3020
|
+
"type": "boolean",
|
|
3021
|
+
"description": "Flag indicating if this attribute is externally defined",
|
|
3022
|
+
"example": false
|
|
2207
3023
|
},
|
|
2208
3024
|
"orderRequired": {
|
|
2209
|
-
"type": "boolean"
|
|
3025
|
+
"type": "boolean",
|
|
3026
|
+
"description": "Flag indicating if this attribute is required for order of the attribute model's product",
|
|
3027
|
+
"example": false
|
|
2210
3028
|
},
|
|
2211
3029
|
"regularExpression": {
|
|
2212
3030
|
"type": "string",
|
|
3031
|
+
"description": "A regular expression that defines the legal values for this attribute",
|
|
3032
|
+
"example": "^[a-zA-Z]+$",
|
|
2213
3033
|
"maxLength": 4000,
|
|
2214
3034
|
"readOnly": true
|
|
2215
3035
|
},
|
|
2216
3036
|
"fieldLength": {
|
|
2217
3037
|
"type": "integer",
|
|
2218
3038
|
"format": "int32",
|
|
3039
|
+
"description": "The length of the field for this attribute in the editor",
|
|
3040
|
+
"example": 50,
|
|
2219
3041
|
"readOnly": true
|
|
2220
3042
|
},
|
|
2221
3043
|
"fieldHeight": {
|
|
2222
3044
|
"type": "integer",
|
|
2223
3045
|
"format": "int32",
|
|
3046
|
+
"description": "The height of the field for this attribute in the editor",
|
|
3047
|
+
"example": 1,
|
|
2224
3048
|
"readOnly": true
|
|
2225
3049
|
},
|
|
2226
3050
|
"minLength": {
|
|
2227
3051
|
"type": "integer",
|
|
2228
3052
|
"format": "int32",
|
|
3053
|
+
"description": "The minimum length of the field for this attribute",
|
|
3054
|
+
"example": 1,
|
|
2229
3055
|
"readOnly": true
|
|
2230
3056
|
},
|
|
2231
3057
|
"readOnly": {
|
|
2232
3058
|
"type": "boolean",
|
|
3059
|
+
"description": "Flag indicating if this attribute is read-only",
|
|
3060
|
+
"example": false,
|
|
2233
3061
|
"readOnly": true
|
|
2234
3062
|
},
|
|
2235
3063
|
"minValue": {
|
|
2236
3064
|
"type": "number",
|
|
2237
3065
|
"format": "double",
|
|
3066
|
+
"description": "The minimum possible value for this attribute",
|
|
3067
|
+
"example": 0,
|
|
2238
3068
|
"readOnly": true
|
|
2239
3069
|
},
|
|
2240
3070
|
"maxValue": {
|
|
2241
3071
|
"type": "number",
|
|
2242
3072
|
"format": "double",
|
|
3073
|
+
"description": "The maximum possible value for this attribute",
|
|
3074
|
+
"example": 100,
|
|
2243
3075
|
"readOnly": true
|
|
2244
3076
|
},
|
|
2245
3077
|
"scale": {
|
|
2246
3078
|
"type": "integer",
|
|
2247
3079
|
"format": "int32",
|
|
3080
|
+
"description": "The minimum number of fraction digits for a value of this attribute",
|
|
3081
|
+
"example": 2,
|
|
2248
3082
|
"readOnly": true
|
|
2249
3083
|
},
|
|
2250
3084
|
"defaultValue": {
|
|
@@ -2252,10 +3086,12 @@
|
|
|
2252
3086
|
{
|
|
2253
3087
|
"$ref": "#/components/schemas/ObjectAttributeValueDefinition"
|
|
2254
3088
|
}
|
|
2255
|
-
]
|
|
3089
|
+
],
|
|
3090
|
+
"description": "The default value of this attribute. It can be updated, but not created."
|
|
2256
3091
|
},
|
|
2257
3092
|
"valueDefinitions": {
|
|
2258
3093
|
"type": "array",
|
|
3094
|
+
"description": "A set of values that are possible for this attribute",
|
|
2259
3095
|
"items": {
|
|
2260
3096
|
"$ref": "#/components/schemas/ObjectAttributeValueDefinition"
|
|
2261
3097
|
},
|
|
@@ -2264,11 +3100,15 @@
|
|
|
2264
3100
|
"creationDate": {
|
|
2265
3101
|
"type": "string",
|
|
2266
3102
|
"format": "date-time",
|
|
3103
|
+
"description": "The date/time when the attribute definition was created",
|
|
3104
|
+
"example": "2024-01-15T10:30:00Z",
|
|
2267
3105
|
"readOnly": true
|
|
2268
3106
|
},
|
|
2269
3107
|
"lastModified": {
|
|
2270
3108
|
"type": "string",
|
|
2271
3109
|
"format": "date-time",
|
|
3110
|
+
"description": "The date/time when the attribute definition was last modified",
|
|
3111
|
+
"example": "2024-01-15T11:00:00Z",
|
|
2272
3112
|
"readOnly": true
|
|
2273
3113
|
}
|
|
2274
3114
|
},
|
|
@@ -2282,9 +3122,11 @@
|
|
|
2282
3122
|
"$ref": "#/components/schemas/PaginatedResultBase"
|
|
2283
3123
|
}
|
|
2284
3124
|
],
|
|
3125
|
+
"description": "Document representing an attribute definition search result",
|
|
2285
3126
|
"properties": {
|
|
2286
3127
|
"hits": {
|
|
2287
3128
|
"type": "array",
|
|
3129
|
+
"description": "List of object attribute definitions",
|
|
2288
3130
|
"items": {
|
|
2289
3131
|
"$ref": "#/components/schemas/ObjectAttributeDefinition"
|
|
2290
3132
|
}
|
|
@@ -2296,9 +3138,12 @@
|
|
|
2296
3138
|
},
|
|
2297
3139
|
"ObjectAttributeGroup": {
|
|
2298
3140
|
"type": "object",
|
|
3141
|
+
"description": "Document representing an attribute group",
|
|
2299
3142
|
"properties": {
|
|
2300
3143
|
"id": {
|
|
2301
3144
|
"type": "string",
|
|
3145
|
+
"description": "The unique identifier of the attribute group",
|
|
3146
|
+
"example": "custom-attributes",
|
|
2302
3147
|
"maxLength": 256,
|
|
2303
3148
|
"minLength": 1
|
|
2304
3149
|
},
|
|
@@ -2306,31 +3151,56 @@
|
|
|
2306
3151
|
"type": "object",
|
|
2307
3152
|
"additionalProperties": {
|
|
2308
3153
|
"type": "string",
|
|
3154
|
+
"description": "Localized string",
|
|
3155
|
+
"example": "Localized value",
|
|
2309
3156
|
"maxLength": 4000
|
|
2310
|
-
}
|
|
3157
|
+
},
|
|
3158
|
+
"description": "B2C Commerce API - Localization doc: https://developer.salesforce.com/docs/commerce/commerce-api/guide/b2c-localization.html",
|
|
3159
|
+
"example": {
|
|
3160
|
+
"default": "Product",
|
|
3161
|
+
"de": "Produkt",
|
|
3162
|
+
"en": "Product"
|
|
3163
|
+
},
|
|
3164
|
+
"x-format": "localized"
|
|
2311
3165
|
},
|
|
2312
3166
|
"description": {
|
|
2313
3167
|
"type": "object",
|
|
2314
3168
|
"additionalProperties": {
|
|
2315
3169
|
"type": "string",
|
|
3170
|
+
"description": "Localized string",
|
|
3171
|
+
"example": "Localized value",
|
|
2316
3172
|
"maxLength": 4000
|
|
2317
|
-
}
|
|
3173
|
+
},
|
|
3174
|
+
"description": "B2C Commerce API - Localization doc: https://developer.salesforce.com/docs/commerce/commerce-api/guide/b2c-localization.html",
|
|
3175
|
+
"example": {
|
|
3176
|
+
"default": "Object type representing products.",
|
|
3177
|
+
"de": "Objekttyp, der Produkte repräsentiert.",
|
|
3178
|
+
"en": "Object type representing products."
|
|
3179
|
+
},
|
|
3180
|
+
"x-format": "localized"
|
|
2318
3181
|
},
|
|
2319
3182
|
"position": {
|
|
2320
3183
|
"type": "number",
|
|
2321
|
-
"format": "double"
|
|
3184
|
+
"format": "double",
|
|
3185
|
+
"description": "The position of the attribute group",
|
|
3186
|
+
"example": 1
|
|
2322
3187
|
},
|
|
2323
3188
|
"internal": {
|
|
2324
3189
|
"type": "boolean",
|
|
3190
|
+
"description": "Flag indicating if this is an internal attribute group",
|
|
3191
|
+
"example": false,
|
|
2325
3192
|
"readOnly": true
|
|
2326
3193
|
},
|
|
2327
3194
|
"attributeDefinitionsCount": {
|
|
2328
3195
|
"type": "integer",
|
|
2329
3196
|
"format": "int32",
|
|
3197
|
+
"description": "The number of attribute definitions in this group",
|
|
3198
|
+
"example": 5,
|
|
2330
3199
|
"readOnly": true
|
|
2331
3200
|
},
|
|
2332
3201
|
"attributeDefinitions": {
|
|
2333
3202
|
"type": "array",
|
|
3203
|
+
"description": "The attribute definitions in this group. Only populated when expand=definition is specified.",
|
|
2334
3204
|
"items": {
|
|
2335
3205
|
"$ref": "#/components/schemas/ObjectAttributeDefinition"
|
|
2336
3206
|
}
|
|
@@ -2338,11 +3208,15 @@
|
|
|
2338
3208
|
"creationDate": {
|
|
2339
3209
|
"type": "string",
|
|
2340
3210
|
"format": "date-time",
|
|
3211
|
+
"description": "The date/time when the attribute definition was created",
|
|
3212
|
+
"example": "2024-01-15T10:30:00Z",
|
|
2341
3213
|
"readOnly": true
|
|
2342
3214
|
},
|
|
2343
3215
|
"lastModified": {
|
|
2344
3216
|
"type": "string",
|
|
2345
3217
|
"format": "date-time",
|
|
3218
|
+
"description": "The date/time when the attribute definition was last modified",
|
|
3219
|
+
"example": "2024-01-15T11:00:00Z",
|
|
2346
3220
|
"readOnly": true
|
|
2347
3221
|
}
|
|
2348
3222
|
}
|
|
@@ -2353,9 +3227,11 @@
|
|
|
2353
3227
|
"$ref": "#/components/schemas/PaginatedResultBase"
|
|
2354
3228
|
}
|
|
2355
3229
|
],
|
|
3230
|
+
"description": "Document representing an attribute group search result",
|
|
2356
3231
|
"properties": {
|
|
2357
3232
|
"hits": {
|
|
2358
3233
|
"type": "array",
|
|
3234
|
+
"description": "List of object attribute groups",
|
|
2359
3235
|
"items": {
|
|
2360
3236
|
"$ref": "#/components/schemas/ObjectAttributeGroup"
|
|
2361
3237
|
}
|
|
@@ -2371,9 +3247,11 @@
|
|
|
2371
3247
|
"$ref": "#/components/schemas/PaginatedResultBase"
|
|
2372
3248
|
}
|
|
2373
3249
|
],
|
|
3250
|
+
"description": "Document representing a paginated collection of attribute groups",
|
|
2374
3251
|
"properties": {
|
|
2375
3252
|
"data": {
|
|
2376
3253
|
"type": "array",
|
|
3254
|
+
"description": "List of object attribute groups",
|
|
2377
3255
|
"items": {
|
|
2378
3256
|
"$ref": "#/components/schemas/ObjectAttributeGroup"
|
|
2379
3257
|
}
|
|
@@ -2386,9 +3264,11 @@
|
|
|
2386
3264
|
"$ref": "#/components/schemas/PaginatedResultBase"
|
|
2387
3265
|
}
|
|
2388
3266
|
],
|
|
3267
|
+
"description": "Document representing a paginated collection of attribute definitions",
|
|
2389
3268
|
"properties": {
|
|
2390
3269
|
"data": {
|
|
2391
3270
|
"type": "array",
|
|
3271
|
+
"description": "List of object attribute definitions",
|
|
2392
3272
|
"items": {
|
|
2393
3273
|
"$ref": "#/components/schemas/ObjectAttributeDefinition"
|
|
2394
3274
|
}
|
|
@@ -2403,6 +3283,11 @@
|
|
|
2403
3283
|
"application/problem+json": {
|
|
2404
3284
|
"schema": {
|
|
2405
3285
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
3286
|
+
},
|
|
3287
|
+
"examples": {
|
|
3288
|
+
"UnauthorizedExample": {
|
|
3289
|
+
"$ref": "#/components/examples/UnauthorizedExample"
|
|
3290
|
+
}
|
|
2406
3291
|
}
|
|
2407
3292
|
}
|
|
2408
3293
|
}
|
|
@@ -2413,6 +3298,11 @@
|
|
|
2413
3298
|
"application/problem+json": {
|
|
2414
3299
|
"schema": {
|
|
2415
3300
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
3301
|
+
},
|
|
3302
|
+
"examples": {
|
|
3303
|
+
"ForbiddenExample": {
|
|
3304
|
+
"$ref": "#/components/examples/ForbiddenExample"
|
|
3305
|
+
}
|
|
2416
3306
|
}
|
|
2417
3307
|
}
|
|
2418
3308
|
}
|
|
@@ -2422,12 +3312,14 @@
|
|
|
2422
3312
|
"organizationId": {
|
|
2423
3313
|
"name": "organizationId",
|
|
2424
3314
|
"in": "path",
|
|
3315
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
2425
3316
|
"required": true,
|
|
2426
3317
|
"style": "simple",
|
|
2427
3318
|
"explode": false,
|
|
2428
3319
|
"schema": {
|
|
2429
3320
|
"$ref": "#/components/schemas/OrganizationId"
|
|
2430
|
-
}
|
|
3321
|
+
},
|
|
3322
|
+
"example": "f_ecom_zzxy_prd"
|
|
2431
3323
|
},
|
|
2432
3324
|
"select": {
|
|
2433
3325
|
"name": "select",
|
|
@@ -2437,16 +3329,23 @@
|
|
|
2437
3329
|
"explode": true,
|
|
2438
3330
|
"schema": {
|
|
2439
3331
|
"$ref": "#/components/schemas/Select"
|
|
3332
|
+
},
|
|
3333
|
+
"examples": {
|
|
3334
|
+
"select": {
|
|
3335
|
+
"value": "(**)"
|
|
3336
|
+
}
|
|
2440
3337
|
}
|
|
2441
3338
|
},
|
|
2442
3339
|
"objectType": {
|
|
2443
3340
|
"name": "objectType",
|
|
2444
3341
|
"in": "path",
|
|
3342
|
+
"description": "The system object type identifier (e.g., Product, Order, Customer)",
|
|
2445
3343
|
"required": true,
|
|
2446
3344
|
"style": "simple",
|
|
2447
3345
|
"explode": false,
|
|
2448
3346
|
"schema": {
|
|
2449
3347
|
"type": "string",
|
|
3348
|
+
"example": "Product",
|
|
2450
3349
|
"maxLength": 256,
|
|
2451
3350
|
"minLength": 1
|
|
2452
3351
|
}
|
|
@@ -2454,22 +3353,26 @@
|
|
|
2454
3353
|
"expand": {
|
|
2455
3354
|
"name": "expand",
|
|
2456
3355
|
"in": "query",
|
|
3356
|
+
"description": "Specifies which related resources to include in the response.\nFor attribute groups, use `definition` to include attribute definitions.\n",
|
|
2457
3357
|
"required": false,
|
|
2458
3358
|
"style": "form",
|
|
2459
3359
|
"explode": true,
|
|
2460
3360
|
"schema": {
|
|
2461
3361
|
"type": "string",
|
|
3362
|
+
"example": "definition",
|
|
2462
3363
|
"maxLength": 256
|
|
2463
3364
|
}
|
|
2464
3365
|
},
|
|
2465
3366
|
"attributeGroupId": {
|
|
2466
3367
|
"name": "id",
|
|
2467
3368
|
"in": "path",
|
|
3369
|
+
"description": "The unique identifier of the attribute group.",
|
|
2468
3370
|
"required": true,
|
|
2469
3371
|
"style": "simple",
|
|
2470
3372
|
"explode": false,
|
|
2471
3373
|
"schema": {
|
|
2472
3374
|
"type": "string",
|
|
3375
|
+
"example": "custom-attributes",
|
|
2473
3376
|
"maxLength": 256,
|
|
2474
3377
|
"minLength": 1
|
|
2475
3378
|
}
|
|
@@ -2477,11 +3380,13 @@
|
|
|
2477
3380
|
"groupId": {
|
|
2478
3381
|
"name": "groupId",
|
|
2479
3382
|
"in": "path",
|
|
3383
|
+
"description": "The unique identifier of the attribute group.",
|
|
2480
3384
|
"required": true,
|
|
2481
3385
|
"style": "simple",
|
|
2482
3386
|
"explode": false,
|
|
2483
3387
|
"schema": {
|
|
2484
3388
|
"type": "string",
|
|
3389
|
+
"example": "custom-attributes",
|
|
2485
3390
|
"maxLength": 256,
|
|
2486
3391
|
"minLength": 1
|
|
2487
3392
|
}
|
|
@@ -2489,11 +3394,13 @@
|
|
|
2489
3394
|
"defId": {
|
|
2490
3395
|
"name": "defId",
|
|
2491
3396
|
"in": "path",
|
|
3397
|
+
"description": "The unique identifier of the attribute definition to assign or unassign.",
|
|
2492
3398
|
"required": true,
|
|
2493
3399
|
"style": "simple",
|
|
2494
3400
|
"explode": false,
|
|
2495
3401
|
"schema": {
|
|
2496
3402
|
"type": "string",
|
|
3403
|
+
"example": "color",
|
|
2497
3404
|
"maxLength": 256,
|
|
2498
3405
|
"minLength": 1
|
|
2499
3406
|
}
|
|
@@ -2501,19 +3408,733 @@
|
|
|
2501
3408
|
"attributeDefinitionId": {
|
|
2502
3409
|
"name": "id",
|
|
2503
3410
|
"in": "path",
|
|
3411
|
+
"description": "The unique identifier of the attribute definition.",
|
|
2504
3412
|
"required": true,
|
|
2505
3413
|
"style": "simple",
|
|
2506
3414
|
"explode": false,
|
|
2507
3415
|
"schema": {
|
|
2508
3416
|
"type": "string",
|
|
3417
|
+
"example": "color",
|
|
2509
3418
|
"maxLength": 256,
|
|
2510
3419
|
"minLength": 1
|
|
2511
3420
|
}
|
|
2512
3421
|
}
|
|
2513
3422
|
},
|
|
3423
|
+
"examples": {
|
|
3424
|
+
"SystemObjectTypeResultExample": {
|
|
3425
|
+
"summary": "List of system object types",
|
|
3426
|
+
"value": {
|
|
3427
|
+
"limit": 3,
|
|
3428
|
+
"offset": 0,
|
|
3429
|
+
"total": 85,
|
|
3430
|
+
"data": [
|
|
3431
|
+
{
|
|
3432
|
+
"objectType": "Product",
|
|
3433
|
+
"displayName": {
|
|
3434
|
+
"default": "Product"
|
|
3435
|
+
},
|
|
3436
|
+
"description": {
|
|
3437
|
+
"default": "Object type representing products."
|
|
3438
|
+
},
|
|
3439
|
+
"readOnly": false,
|
|
3440
|
+
"queryable": false,
|
|
3441
|
+
"contentObject": true,
|
|
3442
|
+
"attributeDefinitionCount": 166,
|
|
3443
|
+
"attributeGroupCount": 8
|
|
3444
|
+
},
|
|
3445
|
+
{
|
|
3446
|
+
"objectType": "Order",
|
|
3447
|
+
"displayName": {
|
|
3448
|
+
"default": "Order"
|
|
3449
|
+
},
|
|
3450
|
+
"description": {
|
|
3451
|
+
"default": "Object type representing orders."
|
|
3452
|
+
},
|
|
3453
|
+
"readOnly": false,
|
|
3454
|
+
"queryable": true,
|
|
3455
|
+
"contentObject": false,
|
|
3456
|
+
"attributeDefinitionCount": 120,
|
|
3457
|
+
"attributeGroupCount": 5
|
|
3458
|
+
},
|
|
3459
|
+
{
|
|
3460
|
+
"objectType": "Customer",
|
|
3461
|
+
"displayName": {
|
|
3462
|
+
"default": "Customer"
|
|
3463
|
+
},
|
|
3464
|
+
"description": {
|
|
3465
|
+
"default": "Object type representing customers."
|
|
3466
|
+
},
|
|
3467
|
+
"readOnly": false,
|
|
3468
|
+
"queryable": true,
|
|
3469
|
+
"contentObject": false,
|
|
3470
|
+
"attributeDefinitionCount": 45,
|
|
3471
|
+
"attributeGroupCount": 3
|
|
3472
|
+
}
|
|
3473
|
+
]
|
|
3474
|
+
}
|
|
3475
|
+
},
|
|
3476
|
+
"UnauthorizedExample": {
|
|
3477
|
+
"value": {
|
|
3478
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unauthorized",
|
|
3479
|
+
"title": "Unauthorized",
|
|
3480
|
+
"detail": "Unauthorized request"
|
|
3481
|
+
}
|
|
3482
|
+
},
|
|
3483
|
+
"ForbiddenExample": {
|
|
3484
|
+
"value": {
|
|
3485
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden",
|
|
3486
|
+
"title": "Forbidden",
|
|
3487
|
+
"detail": "Access to requested resource forbidden"
|
|
3488
|
+
}
|
|
3489
|
+
},
|
|
3490
|
+
"ObjectTypeNotFoundExample": {
|
|
3491
|
+
"value": {
|
|
3492
|
+
"title": "Object Type Not Found",
|
|
3493
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/object-type-not-found",
|
|
3494
|
+
"detail": "No object type with ID 'InvalidObjectType' could be found.",
|
|
3495
|
+
"objectType": "InvalidObjectType"
|
|
3496
|
+
}
|
|
3497
|
+
},
|
|
3498
|
+
"SearchSystemObjectTypes": {
|
|
3499
|
+
"summary": "Search system object types by object type",
|
|
3500
|
+
"value": {
|
|
3501
|
+
"query": {
|
|
3502
|
+
"textQuery": {
|
|
3503
|
+
"fields": [
|
|
3504
|
+
"objectType"
|
|
3505
|
+
],
|
|
3506
|
+
"searchPhrase": "Customer"
|
|
3507
|
+
}
|
|
3508
|
+
}
|
|
3509
|
+
}
|
|
3510
|
+
},
|
|
3511
|
+
"SystemObjectTypeSearchResultExample": {
|
|
3512
|
+
"summary": "System object type search result",
|
|
3513
|
+
"value": {
|
|
3514
|
+
"limit": 1,
|
|
3515
|
+
"offset": 0,
|
|
3516
|
+
"total": 1,
|
|
3517
|
+
"hits": [
|
|
3518
|
+
{
|
|
3519
|
+
"objectType": "Customer",
|
|
3520
|
+
"displayName": {
|
|
3521
|
+
"default": "Customer"
|
|
3522
|
+
},
|
|
3523
|
+
"description": {
|
|
3524
|
+
"default": "Object type representing customers."
|
|
3525
|
+
},
|
|
3526
|
+
"readOnly": false,
|
|
3527
|
+
"queryable": true,
|
|
3528
|
+
"contentObject": false,
|
|
3529
|
+
"attributeDefinitionCount": 45,
|
|
3530
|
+
"attributeGroupCount": 3
|
|
3531
|
+
}
|
|
3532
|
+
]
|
|
3533
|
+
}
|
|
3534
|
+
},
|
|
3535
|
+
"FieldNotSortableExample": {
|
|
3536
|
+
"value": {
|
|
3537
|
+
"title": "Field Not Sortable",
|
|
3538
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/field-not-sortable",
|
|
3539
|
+
"detail": "The field 'link' can't be used to sort the results."
|
|
3540
|
+
}
|
|
3541
|
+
},
|
|
3542
|
+
"SystemObjectTypeExample": {
|
|
3543
|
+
"summary": "Single system object type",
|
|
3544
|
+
"value": {
|
|
3545
|
+
"objectType": "Product",
|
|
3546
|
+
"displayName": {
|
|
3547
|
+
"default": "Product"
|
|
3548
|
+
},
|
|
3549
|
+
"description": {
|
|
3550
|
+
"default": "Object type representing products."
|
|
3551
|
+
},
|
|
3552
|
+
"readOnly": false,
|
|
3553
|
+
"queryable": false,
|
|
3554
|
+
"searchable": true,
|
|
3555
|
+
"contentObject": true,
|
|
3556
|
+
"attributeDefinitionCount": 166,
|
|
3557
|
+
"attributeGroupCount": 8
|
|
3558
|
+
}
|
|
3559
|
+
},
|
|
3560
|
+
"SearchByValueType": {
|
|
3561
|
+
"summary": "Search by value type using term query",
|
|
3562
|
+
"value": {
|
|
3563
|
+
"query": {
|
|
3564
|
+
"termQuery": {
|
|
3565
|
+
"fields": [
|
|
3566
|
+
"value_type"
|
|
3567
|
+
],
|
|
3568
|
+
"operator": "is",
|
|
3569
|
+
"values": [
|
|
3570
|
+
"string"
|
|
3571
|
+
]
|
|
3572
|
+
}
|
|
3573
|
+
},
|
|
3574
|
+
"limit": 25,
|
|
3575
|
+
"offset": 0
|
|
3576
|
+
}
|
|
3577
|
+
},
|
|
3578
|
+
"SearchWithSorting": {
|
|
3579
|
+
"summary": "Search all with sorting by ID",
|
|
3580
|
+
"value": {
|
|
3581
|
+
"query": {
|
|
3582
|
+
"matchAllQuery": {}
|
|
3583
|
+
},
|
|
3584
|
+
"limit": 100,
|
|
3585
|
+
"offset": 0,
|
|
3586
|
+
"sorts": [
|
|
3587
|
+
{
|
|
3588
|
+
"field": "id",
|
|
3589
|
+
"sortOrder": "asc"
|
|
3590
|
+
}
|
|
3591
|
+
]
|
|
3592
|
+
}
|
|
3593
|
+
},
|
|
3594
|
+
"ObjectAttributeDefinitionSearchResultExample": {
|
|
3595
|
+
"summary": "Successful attribute definition search result",
|
|
3596
|
+
"value": {
|
|
3597
|
+
"limit": 2,
|
|
3598
|
+
"hits": [
|
|
3599
|
+
{
|
|
3600
|
+
"id": "color",
|
|
3601
|
+
"effectiveId": "c_color",
|
|
3602
|
+
"displayName": {
|
|
3603
|
+
"default": "Color"
|
|
3604
|
+
},
|
|
3605
|
+
"description": {
|
|
3606
|
+
"default": "The color of the product"
|
|
3607
|
+
},
|
|
3608
|
+
"key": false,
|
|
3609
|
+
"mandatory": false,
|
|
3610
|
+
"localizable": false,
|
|
3611
|
+
"siteSpecific": false,
|
|
3612
|
+
"searchable": true,
|
|
3613
|
+
"queryable": true,
|
|
3614
|
+
"valueType": "enum_of_string",
|
|
3615
|
+
"visible": true,
|
|
3616
|
+
"system": false,
|
|
3617
|
+
"multiValueType": false,
|
|
3618
|
+
"setValueType": false,
|
|
3619
|
+
"externallyManaged": false,
|
|
3620
|
+
"externallyDefined": false,
|
|
3621
|
+
"orderRequired": false,
|
|
3622
|
+
"requiresEncoding": false,
|
|
3623
|
+
"readOnly": false,
|
|
3624
|
+
"valueDefinitions": [
|
|
3625
|
+
{
|
|
3626
|
+
"id": "red",
|
|
3627
|
+
"value": "red",
|
|
3628
|
+
"displayValue": {
|
|
3629
|
+
"default": "Red"
|
|
3630
|
+
},
|
|
3631
|
+
"position": 1
|
|
3632
|
+
},
|
|
3633
|
+
{
|
|
3634
|
+
"id": "blue",
|
|
3635
|
+
"value": "blue",
|
|
3636
|
+
"displayValue": {
|
|
3637
|
+
"default": "Blue"
|
|
3638
|
+
},
|
|
3639
|
+
"position": 2
|
|
3640
|
+
}
|
|
3641
|
+
]
|
|
3642
|
+
},
|
|
3643
|
+
{
|
|
3644
|
+
"id": "size",
|
|
3645
|
+
"effectiveId": "c_size",
|
|
3646
|
+
"displayName": {
|
|
3647
|
+
"default": "Size"
|
|
3648
|
+
},
|
|
3649
|
+
"description": {
|
|
3650
|
+
"default": "The size of the product"
|
|
3651
|
+
},
|
|
3652
|
+
"key": false,
|
|
3653
|
+
"mandatory": true,
|
|
3654
|
+
"localizable": false,
|
|
3655
|
+
"siteSpecific": false,
|
|
3656
|
+
"searchable": true,
|
|
3657
|
+
"queryable": true,
|
|
3658
|
+
"valueType": "string",
|
|
3659
|
+
"visible": true,
|
|
3660
|
+
"system": false,
|
|
3661
|
+
"multiValueType": false,
|
|
3662
|
+
"setValueType": false,
|
|
3663
|
+
"externallyManaged": false,
|
|
3664
|
+
"externallyDefined": false,
|
|
3665
|
+
"orderRequired": false,
|
|
3666
|
+
"requiresEncoding": false,
|
|
3667
|
+
"readOnly": false
|
|
3668
|
+
}
|
|
3669
|
+
],
|
|
3670
|
+
"offset": 0,
|
|
3671
|
+
"total": 2
|
|
3672
|
+
}
|
|
3673
|
+
},
|
|
3674
|
+
"SearchAttributeGroups": {
|
|
3675
|
+
"summary": "Search attribute groups",
|
|
3676
|
+
"value": {
|
|
3677
|
+
"query": {
|
|
3678
|
+
"matchAllQuery": {}
|
|
3679
|
+
},
|
|
3680
|
+
"limit": 25,
|
|
3681
|
+
"offset": 0
|
|
3682
|
+
}
|
|
3683
|
+
},
|
|
3684
|
+
"SearchAttributeGroupsByDisplayName": {
|
|
3685
|
+
"summary": "Search attribute groups by display name",
|
|
3686
|
+
"value": {
|
|
3687
|
+
"query": {
|
|
3688
|
+
"textQuery": {
|
|
3689
|
+
"fields": [
|
|
3690
|
+
"display_name"
|
|
3691
|
+
],
|
|
3692
|
+
"searchPhrase": "custom"
|
|
3693
|
+
}
|
|
3694
|
+
},
|
|
3695
|
+
"limit": 25,
|
|
3696
|
+
"offset": 0
|
|
3697
|
+
}
|
|
3698
|
+
},
|
|
3699
|
+
"ObjectAttributeGroupSearchResultExample": {
|
|
3700
|
+
"summary": "Attribute group search result",
|
|
3701
|
+
"value": {
|
|
3702
|
+
"limit": 1,
|
|
3703
|
+
"offset": 0,
|
|
3704
|
+
"total": 1,
|
|
3705
|
+
"hits": [
|
|
3706
|
+
{
|
|
3707
|
+
"id": "SiteMap",
|
|
3708
|
+
"displayName": {
|
|
3709
|
+
"default": "Site Map"
|
|
3710
|
+
},
|
|
3711
|
+
"description": {
|
|
3712
|
+
"default": "Site map attributes"
|
|
3713
|
+
},
|
|
3714
|
+
"position": 3,
|
|
3715
|
+
"internal": false,
|
|
3716
|
+
"attributeDefinitionsCount": 3
|
|
3717
|
+
}
|
|
3718
|
+
]
|
|
3719
|
+
}
|
|
3720
|
+
},
|
|
3721
|
+
"ObjectAttributeGroupResultExample": {
|
|
3722
|
+
"summary": "List of attribute groups",
|
|
3723
|
+
"value": {
|
|
3724
|
+
"limit": 3,
|
|
3725
|
+
"offset": 0,
|
|
3726
|
+
"total": 8,
|
|
3727
|
+
"data": [
|
|
3728
|
+
{
|
|
3729
|
+
"id": "custom-attributes",
|
|
3730
|
+
"displayName": {
|
|
3731
|
+
"default": "Custom Attributes"
|
|
3732
|
+
},
|
|
3733
|
+
"description": {
|
|
3734
|
+
"default": "Custom attributes for the object"
|
|
3735
|
+
},
|
|
3736
|
+
"position": 1,
|
|
3737
|
+
"internal": false,
|
|
3738
|
+
"attributeDefinitionsCount": 5
|
|
3739
|
+
},
|
|
3740
|
+
{
|
|
3741
|
+
"id": "marketing",
|
|
3742
|
+
"displayName": {
|
|
3743
|
+
"default": "Marketing"
|
|
3744
|
+
},
|
|
3745
|
+
"description": {
|
|
3746
|
+
"default": "Marketing related attributes"
|
|
3747
|
+
},
|
|
3748
|
+
"position": 2,
|
|
3749
|
+
"internal": false,
|
|
3750
|
+
"attributeDefinitionsCount": 10
|
|
3751
|
+
},
|
|
3752
|
+
{
|
|
3753
|
+
"id": "SiteMap",
|
|
3754
|
+
"displayName": {
|
|
3755
|
+
"default": "Site Map"
|
|
3756
|
+
},
|
|
3757
|
+
"description": {
|
|
3758
|
+
"default": "Site map attributes"
|
|
3759
|
+
},
|
|
3760
|
+
"position": 3,
|
|
3761
|
+
"internal": false,
|
|
3762
|
+
"attributeDefinitionsCount": 3
|
|
3763
|
+
}
|
|
3764
|
+
]
|
|
3765
|
+
}
|
|
3766
|
+
},
|
|
3767
|
+
"ObjectAttributeGroupExample": {
|
|
3768
|
+
"summary": "Single attribute group",
|
|
3769
|
+
"value": {
|
|
3770
|
+
"id": "custom-attributes",
|
|
3771
|
+
"displayName": {
|
|
3772
|
+
"default": "Custom Attributes",
|
|
3773
|
+
"en": "Custom Attributes",
|
|
3774
|
+
"de": "Benutzerdefinierte Attribute"
|
|
3775
|
+
},
|
|
3776
|
+
"description": {
|
|
3777
|
+
"default": "Custom attributes for the object"
|
|
3778
|
+
},
|
|
3779
|
+
"position": 1,
|
|
3780
|
+
"internal": false,
|
|
3781
|
+
"attributeDefinitionsCount": 5
|
|
3782
|
+
}
|
|
3783
|
+
},
|
|
3784
|
+
"ObjectAttributeGroupWithDefinitionsExample": {
|
|
3785
|
+
"summary": "Attribute group with expanded attribute definitions",
|
|
3786
|
+
"value": {
|
|
3787
|
+
"id": "custom-attributes",
|
|
3788
|
+
"displayName": {
|
|
3789
|
+
"default": "Custom Attributes"
|
|
3790
|
+
},
|
|
3791
|
+
"description": {
|
|
3792
|
+
"default": "Custom attributes for the object"
|
|
3793
|
+
},
|
|
3794
|
+
"position": 1,
|
|
3795
|
+
"internal": false,
|
|
3796
|
+
"attributeDefinitionsCount": 2,
|
|
3797
|
+
"attributeDefinitions": [
|
|
3798
|
+
{
|
|
3799
|
+
"id": "color",
|
|
3800
|
+
"displayName": {
|
|
3801
|
+
"default": "Color"
|
|
3802
|
+
},
|
|
3803
|
+
"valueType": "enum_of_string",
|
|
3804
|
+
"visible": true,
|
|
3805
|
+
"system": false
|
|
3806
|
+
},
|
|
3807
|
+
{
|
|
3808
|
+
"id": "size",
|
|
3809
|
+
"displayName": {
|
|
3810
|
+
"default": "Size"
|
|
3811
|
+
},
|
|
3812
|
+
"valueType": "string",
|
|
3813
|
+
"visible": true,
|
|
3814
|
+
"system": false
|
|
3815
|
+
}
|
|
3816
|
+
]
|
|
3817
|
+
}
|
|
3818
|
+
},
|
|
3819
|
+
"AttributeGroupNotFoundExample": {
|
|
3820
|
+
"value": {
|
|
3821
|
+
"title": "Attribute Group Not Found",
|
|
3822
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/attribute-group-not-found",
|
|
3823
|
+
"detail": "No attribute group with ID 'invalid_group' could be found."
|
|
3824
|
+
}
|
|
3825
|
+
},
|
|
3826
|
+
"CreateAttributeGroup": {
|
|
3827
|
+
"summary": "Create an attribute group",
|
|
3828
|
+
"value": {
|
|
3829
|
+
"displayName": {
|
|
3830
|
+
"default": "New Attribute Group",
|
|
3831
|
+
"en": "New Attribute Group",
|
|
3832
|
+
"de": "Neue Attributgruppe"
|
|
3833
|
+
},
|
|
3834
|
+
"description": {
|
|
3835
|
+
"default": "A new group for custom attributes"
|
|
3836
|
+
},
|
|
3837
|
+
"position": 5
|
|
3838
|
+
}
|
|
3839
|
+
},
|
|
3840
|
+
"CreateAttributeGroupWithInternal": {
|
|
3841
|
+
"summary": "Create an internal attribute group",
|
|
3842
|
+
"value": {
|
|
3843
|
+
"displayName": {
|
|
3844
|
+
"default": "Internal Group"
|
|
3845
|
+
},
|
|
3846
|
+
"description": {
|
|
3847
|
+
"default": "An internal attribute group"
|
|
3848
|
+
},
|
|
3849
|
+
"position": 10
|
|
3850
|
+
}
|
|
3851
|
+
},
|
|
3852
|
+
"ObjectAttributeGroupCreatedExample": {
|
|
3853
|
+
"summary": "Attribute group created successfully",
|
|
3854
|
+
"value": {
|
|
3855
|
+
"id": "new-group",
|
|
3856
|
+
"displayName": {
|
|
3857
|
+
"default": "New Group",
|
|
3858
|
+
"en": "New Group"
|
|
3859
|
+
},
|
|
3860
|
+
"description": {
|
|
3861
|
+
"default": "A new attribute group"
|
|
3862
|
+
},
|
|
3863
|
+
"position": 6,
|
|
3864
|
+
"internal": false,
|
|
3865
|
+
"attributeDefinitionsCount": 0
|
|
3866
|
+
}
|
|
3867
|
+
},
|
|
3868
|
+
"IdConflictExample": {
|
|
3869
|
+
"value": {
|
|
3870
|
+
"title": "Id Conflict",
|
|
3871
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/id-conflict",
|
|
3872
|
+
"detail": "The ID in the request body ('attributegroupId') doesn't match the ID in the URL ('differentId')."
|
|
3873
|
+
}
|
|
3874
|
+
},
|
|
3875
|
+
"UpdateAttributeGroup": {
|
|
3876
|
+
"summary": "Update an attribute group",
|
|
3877
|
+
"value": {
|
|
3878
|
+
"displayName": {
|
|
3879
|
+
"default": "Updated Group Name"
|
|
3880
|
+
},
|
|
3881
|
+
"description": {
|
|
3882
|
+
"default": "Updated description"
|
|
3883
|
+
},
|
|
3884
|
+
"position": 3
|
|
3885
|
+
}
|
|
3886
|
+
},
|
|
3887
|
+
"UpdateAttributeGroupPosition": {
|
|
3888
|
+
"summary": "Update attribute group position",
|
|
3889
|
+
"value": {
|
|
3890
|
+
"position": 1
|
|
3891
|
+
}
|
|
3892
|
+
},
|
|
3893
|
+
"MalformedRequestBodyExample": {
|
|
3894
|
+
"value": {
|
|
3895
|
+
"title": "Bad Request",
|
|
3896
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
3897
|
+
"detail": "An error occurred while decoding the request, the body was '{ invalid json }'."
|
|
3898
|
+
}
|
|
3899
|
+
},
|
|
3900
|
+
"AttributeDefinitionNotFoundExample": {
|
|
3901
|
+
"value": {
|
|
3902
|
+
"title": "Attribute Definition Not Found",
|
|
3903
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/attribute-definition-not-found",
|
|
3904
|
+
"detail": "No attribute definition with ID 'invalid_attribute' for object 'Product' could be found.",
|
|
3905
|
+
"attributeDefinitionId": "invalid_attribute",
|
|
3906
|
+
"objectType": "Product"
|
|
3907
|
+
}
|
|
3908
|
+
},
|
|
3909
|
+
"ObjectAttributeDefinitionResultExample": {
|
|
3910
|
+
"summary": "List of attribute definitions",
|
|
3911
|
+
"value": {
|
|
3912
|
+
"limit": 2,
|
|
3913
|
+
"offset": 0,
|
|
3914
|
+
"total": 50,
|
|
3915
|
+
"data": [
|
|
3916
|
+
{
|
|
3917
|
+
"id": "color",
|
|
3918
|
+
"effectiveId": "c_color",
|
|
3919
|
+
"displayName": {
|
|
3920
|
+
"default": "Color"
|
|
3921
|
+
},
|
|
3922
|
+
"description": {
|
|
3923
|
+
"default": "The color of the product"
|
|
3924
|
+
},
|
|
3925
|
+
"key": false,
|
|
3926
|
+
"mandatory": false,
|
|
3927
|
+
"localizable": false,
|
|
3928
|
+
"siteSpecific": false,
|
|
3929
|
+
"searchable": true,
|
|
3930
|
+
"queryable": true,
|
|
3931
|
+
"valueType": "enum_of_string",
|
|
3932
|
+
"visible": true,
|
|
3933
|
+
"system": false
|
|
3934
|
+
},
|
|
3935
|
+
{
|
|
3936
|
+
"id": "size",
|
|
3937
|
+
"effectiveId": "c_size",
|
|
3938
|
+
"displayName": {
|
|
3939
|
+
"default": "Size"
|
|
3940
|
+
},
|
|
3941
|
+
"description": {
|
|
3942
|
+
"default": "The size of the product"
|
|
3943
|
+
},
|
|
3944
|
+
"key": false,
|
|
3945
|
+
"mandatory": true,
|
|
3946
|
+
"localizable": false,
|
|
3947
|
+
"siteSpecific": false,
|
|
3948
|
+
"searchable": true,
|
|
3949
|
+
"queryable": true,
|
|
3950
|
+
"valueType": "string",
|
|
3951
|
+
"visible": true,
|
|
3952
|
+
"system": false
|
|
3953
|
+
}
|
|
3954
|
+
]
|
|
3955
|
+
}
|
|
3956
|
+
},
|
|
3957
|
+
"ObjectAttributeDefinitionExample": {
|
|
3958
|
+
"summary": "Single attribute definition",
|
|
3959
|
+
"value": {
|
|
3960
|
+
"id": "color",
|
|
3961
|
+
"effectiveId": "c_color",
|
|
3962
|
+
"displayName": {
|
|
3963
|
+
"default": "Color",
|
|
3964
|
+
"en": "Color"
|
|
3965
|
+
},
|
|
3966
|
+
"description": {
|
|
3967
|
+
"default": "The color of the product",
|
|
3968
|
+
"en": "The color of the product"
|
|
3969
|
+
},
|
|
3970
|
+
"key": false,
|
|
3971
|
+
"mandatory": false,
|
|
3972
|
+
"localizable": true,
|
|
3973
|
+
"siteSpecific": false,
|
|
3974
|
+
"searchable": true,
|
|
3975
|
+
"queryable": true,
|
|
3976
|
+
"valueType": "enum_of_string",
|
|
3977
|
+
"visible": true,
|
|
3978
|
+
"system": false,
|
|
3979
|
+
"multiValueType": false,
|
|
3980
|
+
"setValueType": false,
|
|
3981
|
+
"externallyManaged": false,
|
|
3982
|
+
"externallyDefined": false,
|
|
3983
|
+
"orderRequired": false,
|
|
3984
|
+
"requiresEncoding": false,
|
|
3985
|
+
"readOnly": false,
|
|
3986
|
+
"valueDefinitions": [
|
|
3987
|
+
{
|
|
3988
|
+
"id": "red",
|
|
3989
|
+
"value": "red",
|
|
3990
|
+
"displayValue": {
|
|
3991
|
+
"default": "Red"
|
|
3992
|
+
},
|
|
3993
|
+
"position": 1
|
|
3994
|
+
},
|
|
3995
|
+
{
|
|
3996
|
+
"id": "blue",
|
|
3997
|
+
"value": "blue",
|
|
3998
|
+
"displayValue": {
|
|
3999
|
+
"default": "Blue"
|
|
4000
|
+
},
|
|
4001
|
+
"position": 2
|
|
4002
|
+
}
|
|
4003
|
+
],
|
|
4004
|
+
"creationDate": "2024-01-15T10:30:00Z",
|
|
4005
|
+
"lastModified": "2024-01-15T10:30:00Z"
|
|
4006
|
+
}
|
|
4007
|
+
},
|
|
4008
|
+
"CreateAttributeDefinitionString": {
|
|
4009
|
+
"summary": "Create a string attribute definition",
|
|
4010
|
+
"value": {
|
|
4011
|
+
"id": "c_customString",
|
|
4012
|
+
"displayName": {
|
|
4013
|
+
"default": "Custom String Attribute",
|
|
4014
|
+
"en": "Custom String Attribute"
|
|
4015
|
+
},
|
|
4016
|
+
"description": {
|
|
4017
|
+
"default": "A custom string attribute"
|
|
4018
|
+
},
|
|
4019
|
+
"localizable": true,
|
|
4020
|
+
"siteSpecific": false,
|
|
4021
|
+
"searchable": true,
|
|
4022
|
+
"visible": true,
|
|
4023
|
+
"valueType": "string"
|
|
4024
|
+
}
|
|
4025
|
+
},
|
|
4026
|
+
"CreateAttributeDefinitionEnum": {
|
|
4027
|
+
"summary": "Create an enum attribute definition",
|
|
4028
|
+
"value": {
|
|
4029
|
+
"id": "c_productStatus",
|
|
4030
|
+
"displayName": {
|
|
4031
|
+
"default": "Product Status",
|
|
4032
|
+
"en": "Product Status"
|
|
4033
|
+
},
|
|
4034
|
+
"description": {
|
|
4035
|
+
"default": "The status of the product"
|
|
4036
|
+
},
|
|
4037
|
+
"localizable": false,
|
|
4038
|
+
"siteSpecific": false,
|
|
4039
|
+
"searchable": true,
|
|
4040
|
+
"visible": true,
|
|
4041
|
+
"valueType": "enum_of_string"
|
|
4042
|
+
}
|
|
4043
|
+
},
|
|
4044
|
+
"CreateAttributeDefinitionNumber": {
|
|
4045
|
+
"summary": "Create a numeric attribute definition",
|
|
4046
|
+
"value": {
|
|
4047
|
+
"id": "c_weight",
|
|
4048
|
+
"displayName": {
|
|
4049
|
+
"default": "Weight"
|
|
4050
|
+
},
|
|
4051
|
+
"description": {
|
|
4052
|
+
"default": "The weight of the product"
|
|
4053
|
+
},
|
|
4054
|
+
"localizable": false,
|
|
4055
|
+
"siteSpecific": false,
|
|
4056
|
+
"searchable": true,
|
|
4057
|
+
"visible": true,
|
|
4058
|
+
"valueType": "double",
|
|
4059
|
+
"unit": {
|
|
4060
|
+
"default": "kg"
|
|
4061
|
+
}
|
|
4062
|
+
}
|
|
4063
|
+
},
|
|
4064
|
+
"CreateAttributeDefinitionImage": {
|
|
4065
|
+
"summary": "Create an image attribute definition",
|
|
4066
|
+
"value": {
|
|
4067
|
+
"id": "c_customImage",
|
|
4068
|
+
"displayName": {
|
|
4069
|
+
"default": "Custom Image",
|
|
4070
|
+
"en": "Custom Image"
|
|
4071
|
+
},
|
|
4072
|
+
"description": {
|
|
4073
|
+
"default": "A custom image attribute"
|
|
4074
|
+
},
|
|
4075
|
+
"localizable": true,
|
|
4076
|
+
"siteSpecific": false,
|
|
4077
|
+
"visible": true,
|
|
4078
|
+
"valueType": "image"
|
|
4079
|
+
}
|
|
4080
|
+
},
|
|
4081
|
+
"ObjectAttributeDefinitionCreatedExample": {
|
|
4082
|
+
"summary": "Attribute definition created successfully",
|
|
4083
|
+
"value": {
|
|
4084
|
+
"id": "custom-attribute",
|
|
4085
|
+
"effectiveId": "c_custom-attribute",
|
|
4086
|
+
"displayName": {
|
|
4087
|
+
"default": "Custom Attribute"
|
|
4088
|
+
},
|
|
4089
|
+
"description": {
|
|
4090
|
+
"default": "A custom attribute for the product"
|
|
4091
|
+
},
|
|
4092
|
+
"key": false,
|
|
4093
|
+
"mandatory": false,
|
|
4094
|
+
"localizable": true,
|
|
4095
|
+
"siteSpecific": false,
|
|
4096
|
+
"searchable": true,
|
|
4097
|
+
"queryable": true,
|
|
4098
|
+
"valueType": "string",
|
|
4099
|
+
"visible": true,
|
|
4100
|
+
"system": false,
|
|
4101
|
+
"multiValueType": false,
|
|
4102
|
+
"setValueType": false,
|
|
4103
|
+
"externallyManaged": false,
|
|
4104
|
+
"externallyDefined": false,
|
|
4105
|
+
"orderRequired": false,
|
|
4106
|
+
"requiresEncoding": false,
|
|
4107
|
+
"readOnly": false,
|
|
4108
|
+
"creationDate": "2024-01-15T10:30:00Z",
|
|
4109
|
+
"lastModified": "2024-01-15T10:30:00Z"
|
|
4110
|
+
}
|
|
4111
|
+
},
|
|
4112
|
+
"BadRequestExample": {
|
|
4113
|
+
"value": {
|
|
4114
|
+
"title": "Bad Request",
|
|
4115
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
4116
|
+
"detail": "An error occurred while decoding the request. There's an unknown property 'internal' in document 'ObjectAttributeDefinition'."
|
|
4117
|
+
}
|
|
4118
|
+
},
|
|
4119
|
+
"UpdateAttributeDefinition": {
|
|
4120
|
+
"summary": "Update an attribute definition",
|
|
4121
|
+
"value": {
|
|
4122
|
+
"id": "c_customString",
|
|
4123
|
+
"displayName": {
|
|
4124
|
+
"default": "Updated Display Name"
|
|
4125
|
+
},
|
|
4126
|
+
"description": {
|
|
4127
|
+
"default": "Updated description"
|
|
4128
|
+
},
|
|
4129
|
+
"searchable": false,
|
|
4130
|
+
"visible": false
|
|
4131
|
+
}
|
|
4132
|
+
}
|
|
4133
|
+
},
|
|
2514
4134
|
"securitySchemes": {
|
|
2515
4135
|
"AmOAuth2": {
|
|
2516
4136
|
"type": "oauth2",
|
|
4137
|
+
"description": "Account Manager OAuth 2.0 bearer token Authentication.",
|
|
2517
4138
|
"flows": {
|
|
2518
4139
|
"clientCredentials": {
|
|
2519
4140
|
"tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|
|
@@ -2525,10 +4146,8 @@
|
|
|
2525
4146
|
"authorizationCode": {
|
|
2526
4147
|
"authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
|
|
2527
4148
|
"tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|
|
2528
|
-
"
|
|
2529
|
-
|
|
2530
|
-
"sfcc.object-definitions.rw": "System Object Definitions Read and Write SCOPE"
|
|
2531
|
-
}
|
|
4149
|
+
"refreshUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|
|
4150
|
+
"scopes": {}
|
|
2532
4151
|
}
|
|
2533
4152
|
}
|
|
2534
4153
|
}
|