@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": "Customers",
|
|
5
|
-
"
|
|
5
|
+
"description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/customers/customers-oas-v1-public.yaml)\n\n# API Overview\n\nUse the Customers API to search for and manage customer information within a customer list. It also enables you to search for customer groups.\n\nOnce you find information for a customer, you can also use the API to manage customer addresses.\n\nThe `customerNo` is created when you create a shopper record. You can create a shopper record using the Customers API or Business Manager. For details, see [registerCustomer](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=registerCustomer) and [Create and Manage Customer Records](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-customer-records.html?q=create%20customer).\n\n\n\n## Authentication & Authorization\n\nFor resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request.\n\nYou must include the relevant scope(s) in the client ID used to generate the token. For a full list of permissions, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)\n\nFor detailed setup instructions, see the [Authorization for Admin APIs guide.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.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)\n\n## Related APIs\n\n- [Shopper Customers](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=Summary) — Shopper-facing registration, login, and profile management.",
|
|
6
|
+
"version": "1.1.4",
|
|
6
7
|
"x-api-type": "Admin",
|
|
7
8
|
"x-api-family": "Customer"
|
|
8
9
|
},
|
|
@@ -11,6 +12,7 @@
|
|
|
11
12
|
"url": "https://{shortCode}.api.commercecloud.salesforce.com/customer/customers/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,16 +21,20 @@
|
|
|
19
21
|
"paths": {
|
|
20
22
|
"/organizations/{organizationId}/customer-lists/{customerListId}/customer-search": {
|
|
21
23
|
"post": {
|
|
24
|
+
"summary": "Search for customers in a customer list.",
|
|
25
|
+
"description": "Search for customers in a customer list.\nThe query attribute specifies a complex query that can be used to narrow down the search. The following list\nprovides searchable attributes:\n\n| Attribute | Type |\n|-----------|--------|\n| customerNo| String |\n| firstName | String |\n| secondName | String |\n| lastName | String |\n| suffix | String |\n| salutation | String |\n| title | String |\n| fax| String |\n| phoneHome | String |\n| phoneBusiness | String |\n| phoneMobile | String |\n| email | String |\n| gender | Integer |\n| companyName | String | \n| credentials.login | String | \n| credentials.enabled | Boolean |",
|
|
22
26
|
"operationId": "searchCustomerInCustomerList",
|
|
23
27
|
"parameters": [
|
|
24
28
|
{
|
|
25
29
|
"name": "customerListId",
|
|
26
30
|
"in": "path",
|
|
31
|
+
"description": "The customer list ID.",
|
|
27
32
|
"required": true,
|
|
28
33
|
"style": "simple",
|
|
29
34
|
"explode": false,
|
|
30
35
|
"schema": {
|
|
31
36
|
"type": "string",
|
|
37
|
+
"example": "Site1CustomerList",
|
|
32
38
|
"maxLength": 256,
|
|
33
39
|
"minLength": 1
|
|
34
40
|
}
|
|
@@ -36,12 +42,14 @@
|
|
|
36
42
|
{
|
|
37
43
|
"name": "organizationId",
|
|
38
44
|
"in": "path",
|
|
45
|
+
"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).",
|
|
39
46
|
"required": true,
|
|
40
47
|
"style": "simple",
|
|
41
48
|
"explode": false,
|
|
42
49
|
"schema": {
|
|
43
50
|
"$ref": "#/components/schemas/OrganizationId"
|
|
44
|
-
}
|
|
51
|
+
},
|
|
52
|
+
"example": "f_ecom_zzxy_prd"
|
|
45
53
|
}
|
|
46
54
|
],
|
|
47
55
|
"requestBody": {
|
|
@@ -49,6 +57,11 @@
|
|
|
49
57
|
"application/json": {
|
|
50
58
|
"schema": {
|
|
51
59
|
"$ref": "#/components/schemas/SearchRequest"
|
|
60
|
+
},
|
|
61
|
+
"examples": {
|
|
62
|
+
"CustomerSearchBody": {
|
|
63
|
+
"$ref": "#/components/examples/CustomerSearchBody"
|
|
64
|
+
}
|
|
52
65
|
}
|
|
53
66
|
}
|
|
54
67
|
},
|
|
@@ -61,16 +74,26 @@
|
|
|
61
74
|
"application/json": {
|
|
62
75
|
"schema": {
|
|
63
76
|
"$ref": "#/components/schemas/CustomerSearchResult"
|
|
77
|
+
},
|
|
78
|
+
"examples": {
|
|
79
|
+
"CustomerSearchResult": {
|
|
80
|
+
"$ref": "#/components/examples/CustomerSearchResult"
|
|
81
|
+
}
|
|
64
82
|
}
|
|
65
83
|
}
|
|
66
84
|
}
|
|
67
85
|
},
|
|
68
86
|
"400": {
|
|
69
|
-
"description": "Bad Request.
|
|
87
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
70
88
|
"content": {
|
|
71
89
|
"application/problem+json": {
|
|
72
90
|
"schema": {
|
|
73
91
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
92
|
+
},
|
|
93
|
+
"examples": {
|
|
94
|
+
"searchCustomerInCustomerList400": {
|
|
95
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
96
|
+
}
|
|
74
97
|
}
|
|
75
98
|
}
|
|
76
99
|
}
|
|
@@ -81,6 +104,11 @@
|
|
|
81
104
|
"application/problem+json": {
|
|
82
105
|
"schema": {
|
|
83
106
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
107
|
+
},
|
|
108
|
+
"examples": {
|
|
109
|
+
"searchCustomerInCustomerList401": {
|
|
110
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
111
|
+
}
|
|
84
112
|
}
|
|
85
113
|
}
|
|
86
114
|
}
|
|
@@ -91,6 +119,11 @@
|
|
|
91
119
|
"application/problem+json": {
|
|
92
120
|
"schema": {
|
|
93
121
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
122
|
+
},
|
|
123
|
+
"examples": {
|
|
124
|
+
"searchCustomerInCustomerList404": {
|
|
125
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
126
|
+
}
|
|
94
127
|
}
|
|
95
128
|
}
|
|
96
129
|
}
|
|
@@ -108,16 +141,20 @@
|
|
|
108
141
|
},
|
|
109
142
|
"/organizations/{organizationId}/customer-lists/{customerListId}/customers": {
|
|
110
143
|
"post": {
|
|
144
|
+
"summary": "Create a new customer in a customer list.",
|
|
145
|
+
"description": "Create a new customer. The customer is created using the specified credentials and customer\ninformation. This action verifies:\n\n - Login acceptance criteria and uniqueness.\n - Mandatory customer properties.\n\nIf the action fails to create the customer, it returns a 400 fault with an appropriate message.\n",
|
|
111
146
|
"operationId": "createCustomerList",
|
|
112
147
|
"parameters": [
|
|
113
148
|
{
|
|
114
149
|
"name": "customerListId",
|
|
115
150
|
"in": "path",
|
|
151
|
+
"description": "The customer list ID.",
|
|
116
152
|
"required": true,
|
|
117
153
|
"style": "simple",
|
|
118
154
|
"explode": false,
|
|
119
155
|
"schema": {
|
|
120
156
|
"type": "string",
|
|
157
|
+
"example": "Site1CustomerList",
|
|
121
158
|
"maxLength": 256,
|
|
122
159
|
"minLength": 1
|
|
123
160
|
}
|
|
@@ -125,12 +162,14 @@
|
|
|
125
162
|
{
|
|
126
163
|
"name": "organizationId",
|
|
127
164
|
"in": "path",
|
|
165
|
+
"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).",
|
|
128
166
|
"required": true,
|
|
129
167
|
"style": "simple",
|
|
130
168
|
"explode": false,
|
|
131
169
|
"schema": {
|
|
132
170
|
"$ref": "#/components/schemas/OrganizationId"
|
|
133
|
-
}
|
|
171
|
+
},
|
|
172
|
+
"example": "f_ecom_zzxy_prd"
|
|
134
173
|
}
|
|
135
174
|
],
|
|
136
175
|
"requestBody": {
|
|
@@ -138,6 +177,11 @@
|
|
|
138
177
|
"application/json": {
|
|
139
178
|
"schema": {
|
|
140
179
|
"$ref": "#/components/schemas/Customer"
|
|
180
|
+
},
|
|
181
|
+
"examples": {
|
|
182
|
+
"PostCustomerBody": {
|
|
183
|
+
"$ref": "#/components/examples/PostCustomerBody"
|
|
184
|
+
}
|
|
141
185
|
}
|
|
142
186
|
}
|
|
143
187
|
},
|
|
@@ -150,16 +194,26 @@
|
|
|
150
194
|
"application/json": {
|
|
151
195
|
"schema": {
|
|
152
196
|
"$ref": "#/components/schemas/Customer"
|
|
197
|
+
},
|
|
198
|
+
"examples": {
|
|
199
|
+
"postCustomers": {
|
|
200
|
+
"$ref": "#/components/examples/postCustomers"
|
|
201
|
+
}
|
|
153
202
|
}
|
|
154
203
|
}
|
|
155
204
|
}
|
|
156
205
|
},
|
|
157
206
|
"400": {
|
|
158
|
-
"description": "Bad Request.
|
|
207
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
159
208
|
"content": {
|
|
160
209
|
"application/problem+json": {
|
|
161
210
|
"schema": {
|
|
162
211
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
212
|
+
},
|
|
213
|
+
"examples": {
|
|
214
|
+
"searchCustomerInCustomerList400": {
|
|
215
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
216
|
+
}
|
|
163
217
|
}
|
|
164
218
|
}
|
|
165
219
|
}
|
|
@@ -170,6 +224,11 @@
|
|
|
170
224
|
"application/problem+json": {
|
|
171
225
|
"schema": {
|
|
172
226
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
227
|
+
},
|
|
228
|
+
"examples": {
|
|
229
|
+
"searchCustomerInCustomerList401": {
|
|
230
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
231
|
+
}
|
|
173
232
|
}
|
|
174
233
|
}
|
|
175
234
|
}
|
|
@@ -180,6 +239,11 @@
|
|
|
180
239
|
"application/problem+json": {
|
|
181
240
|
"schema": {
|
|
182
241
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
242
|
+
},
|
|
243
|
+
"examples": {
|
|
244
|
+
"searchCustomerInCustomerList404": {
|
|
245
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
246
|
+
}
|
|
183
247
|
}
|
|
184
248
|
}
|
|
185
249
|
}
|
|
@@ -196,16 +260,20 @@
|
|
|
196
260
|
},
|
|
197
261
|
"/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}": {
|
|
198
262
|
"get": {
|
|
263
|
+
"summary": "Get customer information.",
|
|
264
|
+
"description": "Action to get customer information.",
|
|
199
265
|
"operationId": "getCustomerFromCustomerList",
|
|
200
266
|
"parameters": [
|
|
201
267
|
{
|
|
202
268
|
"name": "customerNo",
|
|
203
269
|
"in": "path",
|
|
270
|
+
"description": "The customer number.",
|
|
204
271
|
"required": true,
|
|
205
272
|
"style": "simple",
|
|
206
273
|
"explode": false,
|
|
207
274
|
"schema": {
|
|
208
275
|
"type": "string",
|
|
276
|
+
"example": "1",
|
|
209
277
|
"maxLength": 100,
|
|
210
278
|
"minLength": 1
|
|
211
279
|
}
|
|
@@ -213,11 +281,13 @@
|
|
|
213
281
|
{
|
|
214
282
|
"name": "customerListId",
|
|
215
283
|
"in": "path",
|
|
284
|
+
"description": "The customer list ID.",
|
|
216
285
|
"required": true,
|
|
217
286
|
"style": "simple",
|
|
218
287
|
"explode": false,
|
|
219
288
|
"schema": {
|
|
220
289
|
"type": "string",
|
|
290
|
+
"example": "Site1CustomerList",
|
|
221
291
|
"maxLength": 256,
|
|
222
292
|
"minLength": 1
|
|
223
293
|
}
|
|
@@ -225,12 +295,14 @@
|
|
|
225
295
|
{
|
|
226
296
|
"name": "organizationId",
|
|
227
297
|
"in": "path",
|
|
298
|
+
"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).",
|
|
228
299
|
"required": true,
|
|
229
300
|
"style": "simple",
|
|
230
301
|
"explode": false,
|
|
231
302
|
"schema": {
|
|
232
303
|
"$ref": "#/components/schemas/OrganizationId"
|
|
233
|
-
}
|
|
304
|
+
},
|
|
305
|
+
"example": "f_ecom_zzxy_prd"
|
|
234
306
|
}
|
|
235
307
|
],
|
|
236
308
|
"responses": {
|
|
@@ -240,16 +312,26 @@
|
|
|
240
312
|
"application/json": {
|
|
241
313
|
"schema": {
|
|
242
314
|
"$ref": "#/components/schemas/Customer"
|
|
315
|
+
},
|
|
316
|
+
"examples": {
|
|
317
|
+
"postCustomers": {
|
|
318
|
+
"$ref": "#/components/examples/postCustomers"
|
|
319
|
+
}
|
|
243
320
|
}
|
|
244
321
|
}
|
|
245
322
|
}
|
|
246
323
|
},
|
|
247
324
|
"400": {
|
|
248
|
-
"description": "Bad Request.
|
|
325
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
249
326
|
"content": {
|
|
250
327
|
"application/problem+json": {
|
|
251
328
|
"schema": {
|
|
252
329
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
330
|
+
},
|
|
331
|
+
"examples": {
|
|
332
|
+
"searchCustomerInCustomerList400": {
|
|
333
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
334
|
+
}
|
|
253
335
|
}
|
|
254
336
|
}
|
|
255
337
|
}
|
|
@@ -260,6 +342,11 @@
|
|
|
260
342
|
"application/problem+json": {
|
|
261
343
|
"schema": {
|
|
262
344
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
345
|
+
},
|
|
346
|
+
"examples": {
|
|
347
|
+
"searchCustomerInCustomerList401": {
|
|
348
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
349
|
+
}
|
|
263
350
|
}
|
|
264
351
|
}
|
|
265
352
|
}
|
|
@@ -270,6 +357,11 @@
|
|
|
270
357
|
"application/problem+json": {
|
|
271
358
|
"schema": {
|
|
272
359
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
360
|
+
},
|
|
361
|
+
"examples": {
|
|
362
|
+
"searchCustomerInCustomerList404": {
|
|
363
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
364
|
+
}
|
|
273
365
|
}
|
|
274
366
|
}
|
|
275
367
|
}
|
|
@@ -285,16 +377,20 @@
|
|
|
285
377
|
]
|
|
286
378
|
},
|
|
287
379
|
"put": {
|
|
380
|
+
"summary": "Create a new customer in a customer list.",
|
|
381
|
+
"description": "Create a new customer. The customer is created using the specified customer number, credentials, and\ncustomer information. This action verifies:\n\n- Login acceptance criteria and uniqueness.\n- Mandatory customer properties.\n\nIf the action fails to create the customer, it returns a 400 fault with an appropriate message.\n",
|
|
288
382
|
"operationId": "createCustomerInCustomerList",
|
|
289
383
|
"parameters": [
|
|
290
384
|
{
|
|
291
385
|
"name": "customerNo",
|
|
292
386
|
"in": "path",
|
|
387
|
+
"description": "The customer number.",
|
|
293
388
|
"required": true,
|
|
294
389
|
"style": "simple",
|
|
295
390
|
"explode": false,
|
|
296
391
|
"schema": {
|
|
297
392
|
"type": "string",
|
|
393
|
+
"example": "1",
|
|
298
394
|
"maxLength": 100,
|
|
299
395
|
"minLength": 1
|
|
300
396
|
}
|
|
@@ -302,11 +398,13 @@
|
|
|
302
398
|
{
|
|
303
399
|
"name": "customerListId",
|
|
304
400
|
"in": "path",
|
|
401
|
+
"description": "The customer list ID.",
|
|
305
402
|
"required": true,
|
|
306
403
|
"style": "simple",
|
|
307
404
|
"explode": false,
|
|
308
405
|
"schema": {
|
|
309
406
|
"type": "string",
|
|
407
|
+
"example": "Site1CustomerList",
|
|
310
408
|
"maxLength": 256,
|
|
311
409
|
"minLength": 1
|
|
312
410
|
}
|
|
@@ -314,12 +412,14 @@
|
|
|
314
412
|
{
|
|
315
413
|
"name": "organizationId",
|
|
316
414
|
"in": "path",
|
|
415
|
+
"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).",
|
|
317
416
|
"required": true,
|
|
318
417
|
"style": "simple",
|
|
319
418
|
"explode": false,
|
|
320
419
|
"schema": {
|
|
321
420
|
"$ref": "#/components/schemas/OrganizationId"
|
|
322
|
-
}
|
|
421
|
+
},
|
|
422
|
+
"example": "f_ecom_zzxy_prd"
|
|
323
423
|
}
|
|
324
424
|
],
|
|
325
425
|
"requestBody": {
|
|
@@ -327,6 +427,11 @@
|
|
|
327
427
|
"application/json": {
|
|
328
428
|
"schema": {
|
|
329
429
|
"$ref": "#/components/schemas/Customer"
|
|
430
|
+
},
|
|
431
|
+
"examples": {
|
|
432
|
+
"PostCustomerBody": {
|
|
433
|
+
"$ref": "#/components/examples/PostCustomerBody"
|
|
434
|
+
}
|
|
330
435
|
}
|
|
331
436
|
}
|
|
332
437
|
},
|
|
@@ -339,6 +444,11 @@
|
|
|
339
444
|
"application/json": {
|
|
340
445
|
"schema": {
|
|
341
446
|
"$ref": "#/components/schemas/Customer"
|
|
447
|
+
},
|
|
448
|
+
"examples": {
|
|
449
|
+
"postCustomers": {
|
|
450
|
+
"$ref": "#/components/examples/postCustomers"
|
|
451
|
+
}
|
|
342
452
|
}
|
|
343
453
|
}
|
|
344
454
|
}
|
|
@@ -349,16 +459,26 @@
|
|
|
349
459
|
"application/json": {
|
|
350
460
|
"schema": {
|
|
351
461
|
"$ref": "#/components/schemas/Customer"
|
|
462
|
+
},
|
|
463
|
+
"examples": {
|
|
464
|
+
"postCustomers": {
|
|
465
|
+
"$ref": "#/components/examples/postCustomers"
|
|
466
|
+
}
|
|
352
467
|
}
|
|
353
468
|
}
|
|
354
469
|
}
|
|
355
470
|
},
|
|
356
471
|
"400": {
|
|
357
|
-
"description": "Bad Request.
|
|
472
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
358
473
|
"content": {
|
|
359
474
|
"application/problem+json": {
|
|
360
475
|
"schema": {
|
|
361
476
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
477
|
+
},
|
|
478
|
+
"examples": {
|
|
479
|
+
"searchCustomerInCustomerList400": {
|
|
480
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
481
|
+
}
|
|
362
482
|
}
|
|
363
483
|
}
|
|
364
484
|
}
|
|
@@ -369,6 +489,11 @@
|
|
|
369
489
|
"application/problem+json": {
|
|
370
490
|
"schema": {
|
|
371
491
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
492
|
+
},
|
|
493
|
+
"examples": {
|
|
494
|
+
"searchCustomerInCustomerList401": {
|
|
495
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
496
|
+
}
|
|
372
497
|
}
|
|
373
498
|
}
|
|
374
499
|
}
|
|
@@ -379,6 +504,11 @@
|
|
|
379
504
|
"application/problem+json": {
|
|
380
505
|
"schema": {
|
|
381
506
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
507
|
+
},
|
|
508
|
+
"examples": {
|
|
509
|
+
"searchCustomerInCustomerList404": {
|
|
510
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
511
|
+
}
|
|
382
512
|
}
|
|
383
513
|
}
|
|
384
514
|
}
|
|
@@ -393,16 +523,20 @@
|
|
|
393
523
|
]
|
|
394
524
|
},
|
|
395
525
|
"delete": {
|
|
526
|
+
"summary": "Delete a customer from a customer list.",
|
|
527
|
+
"description": "Deletes the customer, including all related information like the customer addresses.",
|
|
396
528
|
"operationId": "deleteCustomerFromCustomerList",
|
|
397
529
|
"parameters": [
|
|
398
530
|
{
|
|
399
531
|
"name": "customerNo",
|
|
400
532
|
"in": "path",
|
|
533
|
+
"description": "The customer number.",
|
|
401
534
|
"required": true,
|
|
402
535
|
"style": "simple",
|
|
403
536
|
"explode": false,
|
|
404
537
|
"schema": {
|
|
405
538
|
"type": "string",
|
|
539
|
+
"example": "1",
|
|
406
540
|
"maxLength": 100,
|
|
407
541
|
"minLength": 1
|
|
408
542
|
}
|
|
@@ -410,11 +544,13 @@
|
|
|
410
544
|
{
|
|
411
545
|
"name": "customerListId",
|
|
412
546
|
"in": "path",
|
|
547
|
+
"description": "The customer list ID.",
|
|
413
548
|
"required": true,
|
|
414
549
|
"style": "simple",
|
|
415
550
|
"explode": false,
|
|
416
551
|
"schema": {
|
|
417
552
|
"type": "string",
|
|
553
|
+
"example": "Site1CustomerList",
|
|
418
554
|
"maxLength": 256,
|
|
419
555
|
"minLength": 1
|
|
420
556
|
}
|
|
@@ -422,12 +558,14 @@
|
|
|
422
558
|
{
|
|
423
559
|
"name": "organizationId",
|
|
424
560
|
"in": "path",
|
|
561
|
+
"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).",
|
|
425
562
|
"required": true,
|
|
426
563
|
"style": "simple",
|
|
427
564
|
"explode": false,
|
|
428
565
|
"schema": {
|
|
429
566
|
"$ref": "#/components/schemas/OrganizationId"
|
|
430
|
-
}
|
|
567
|
+
},
|
|
568
|
+
"example": "f_ecom_zzxy_prd"
|
|
431
569
|
}
|
|
432
570
|
],
|
|
433
571
|
"responses": {
|
|
@@ -435,11 +573,16 @@
|
|
|
435
573
|
"description": "No Content"
|
|
436
574
|
},
|
|
437
575
|
"400": {
|
|
438
|
-
"description": "Bad Request.
|
|
576
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
439
577
|
"content": {
|
|
440
578
|
"application/problem+json": {
|
|
441
579
|
"schema": {
|
|
442
580
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
581
|
+
},
|
|
582
|
+
"examples": {
|
|
583
|
+
"searchCustomerInCustomerList400": {
|
|
584
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
585
|
+
}
|
|
443
586
|
}
|
|
444
587
|
}
|
|
445
588
|
}
|
|
@@ -450,6 +593,11 @@
|
|
|
450
593
|
"application/problem+json": {
|
|
451
594
|
"schema": {
|
|
452
595
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
596
|
+
},
|
|
597
|
+
"examples": {
|
|
598
|
+
"searchCustomerInCustomerList401": {
|
|
599
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
600
|
+
}
|
|
453
601
|
}
|
|
454
602
|
}
|
|
455
603
|
}
|
|
@@ -460,6 +608,11 @@
|
|
|
460
608
|
"application/problem+json": {
|
|
461
609
|
"schema": {
|
|
462
610
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
611
|
+
},
|
|
612
|
+
"examples": {
|
|
613
|
+
"searchCustomerInCustomerList404": {
|
|
614
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
615
|
+
}
|
|
463
616
|
}
|
|
464
617
|
}
|
|
465
618
|
}
|
|
@@ -474,16 +627,20 @@
|
|
|
474
627
|
]
|
|
475
628
|
},
|
|
476
629
|
"patch": {
|
|
630
|
+
"summary": "Update a customer in a customer list.",
|
|
631
|
+
"description": "Updates the customer with the specified information. The customer number can be updated, but results in a\nCustomerNumberAlreadyInUseException if there is another customer with the same customer number.",
|
|
477
632
|
"operationId": "updateCustomerInCustomerList",
|
|
478
633
|
"parameters": [
|
|
479
634
|
{
|
|
480
635
|
"name": "customerNo",
|
|
481
636
|
"in": "path",
|
|
637
|
+
"description": "The customer number.",
|
|
482
638
|
"required": true,
|
|
483
639
|
"style": "simple",
|
|
484
640
|
"explode": false,
|
|
485
641
|
"schema": {
|
|
486
642
|
"type": "string",
|
|
643
|
+
"example": "1",
|
|
487
644
|
"maxLength": 100,
|
|
488
645
|
"minLength": 1
|
|
489
646
|
}
|
|
@@ -491,11 +648,13 @@
|
|
|
491
648
|
{
|
|
492
649
|
"name": "customerListId",
|
|
493
650
|
"in": "path",
|
|
651
|
+
"description": "The customer list ID.",
|
|
494
652
|
"required": true,
|
|
495
653
|
"style": "simple",
|
|
496
654
|
"explode": false,
|
|
497
655
|
"schema": {
|
|
498
656
|
"type": "string",
|
|
657
|
+
"example": "Site1CustomerList",
|
|
499
658
|
"maxLength": 256,
|
|
500
659
|
"minLength": 1
|
|
501
660
|
}
|
|
@@ -503,12 +662,14 @@
|
|
|
503
662
|
{
|
|
504
663
|
"name": "organizationId",
|
|
505
664
|
"in": "path",
|
|
665
|
+
"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).",
|
|
506
666
|
"required": true,
|
|
507
667
|
"style": "simple",
|
|
508
668
|
"explode": false,
|
|
509
669
|
"schema": {
|
|
510
670
|
"$ref": "#/components/schemas/OrganizationId"
|
|
511
|
-
}
|
|
671
|
+
},
|
|
672
|
+
"example": "f_ecom_zzxy_prd"
|
|
512
673
|
}
|
|
513
674
|
],
|
|
514
675
|
"requestBody": {
|
|
@@ -516,6 +677,11 @@
|
|
|
516
677
|
"application/json": {
|
|
517
678
|
"schema": {
|
|
518
679
|
"$ref": "#/components/schemas/Customer"
|
|
680
|
+
},
|
|
681
|
+
"examples": {
|
|
682
|
+
"PostCustomerBody": {
|
|
683
|
+
"$ref": "#/components/examples/PostCustomerBody"
|
|
684
|
+
}
|
|
519
685
|
}
|
|
520
686
|
}
|
|
521
687
|
},
|
|
@@ -528,16 +694,26 @@
|
|
|
528
694
|
"application/json": {
|
|
529
695
|
"schema": {
|
|
530
696
|
"$ref": "#/components/schemas/Customer"
|
|
697
|
+
},
|
|
698
|
+
"examples": {
|
|
699
|
+
"postCustomers": {
|
|
700
|
+
"$ref": "#/components/examples/postCustomers"
|
|
701
|
+
}
|
|
531
702
|
}
|
|
532
703
|
}
|
|
533
704
|
}
|
|
534
705
|
},
|
|
535
706
|
"400": {
|
|
536
|
-
"description": "Bad Request.
|
|
707
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
537
708
|
"content": {
|
|
538
709
|
"application/problem+json": {
|
|
539
710
|
"schema": {
|
|
540
711
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
712
|
+
},
|
|
713
|
+
"examples": {
|
|
714
|
+
"searchCustomerInCustomerList400": {
|
|
715
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
716
|
+
}
|
|
541
717
|
}
|
|
542
718
|
}
|
|
543
719
|
}
|
|
@@ -548,6 +724,11 @@
|
|
|
548
724
|
"application/problem+json": {
|
|
549
725
|
"schema": {
|
|
550
726
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
727
|
+
},
|
|
728
|
+
"examples": {
|
|
729
|
+
"searchCustomerInCustomerList401": {
|
|
730
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
731
|
+
}
|
|
551
732
|
}
|
|
552
733
|
}
|
|
553
734
|
}
|
|
@@ -558,6 +739,11 @@
|
|
|
558
739
|
"application/problem+json": {
|
|
559
740
|
"schema": {
|
|
560
741
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
742
|
+
},
|
|
743
|
+
"examples": {
|
|
744
|
+
"searchCustomerInCustomerList404": {
|
|
745
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
746
|
+
}
|
|
561
747
|
}
|
|
562
748
|
}
|
|
563
749
|
}
|
|
@@ -574,16 +760,20 @@
|
|
|
574
760
|
},
|
|
575
761
|
"/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}/addresses": {
|
|
576
762
|
"get": {
|
|
763
|
+
"summary": "Get a list of customer addresses.",
|
|
764
|
+
"description": "Returns a list of all customer addresses in pages. The\ndefault page size is 10 customer addresses.",
|
|
577
765
|
"operationId": "getAddressesForCustomerFromCustomerList",
|
|
578
766
|
"parameters": [
|
|
579
767
|
{
|
|
580
768
|
"name": "customerNo",
|
|
581
769
|
"in": "path",
|
|
770
|
+
"description": "The customer number.",
|
|
582
771
|
"required": true,
|
|
583
772
|
"style": "simple",
|
|
584
773
|
"explode": false,
|
|
585
774
|
"schema": {
|
|
586
775
|
"type": "string",
|
|
776
|
+
"example": "1",
|
|
587
777
|
"maxLength": 100,
|
|
588
778
|
"minLength": 1
|
|
589
779
|
}
|
|
@@ -591,11 +781,13 @@
|
|
|
591
781
|
{
|
|
592
782
|
"name": "customerListId",
|
|
593
783
|
"in": "path",
|
|
784
|
+
"description": "The customer list ID.",
|
|
594
785
|
"required": true,
|
|
595
786
|
"style": "simple",
|
|
596
787
|
"explode": false,
|
|
597
788
|
"schema": {
|
|
598
789
|
"type": "string",
|
|
790
|
+
"example": "Site1CustomerList",
|
|
599
791
|
"maxLength": 256,
|
|
600
792
|
"minLength": 1
|
|
601
793
|
}
|
|
@@ -603,16 +795,19 @@
|
|
|
603
795
|
{
|
|
604
796
|
"name": "organizationId",
|
|
605
797
|
"in": "path",
|
|
798
|
+
"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).",
|
|
606
799
|
"required": true,
|
|
607
800
|
"style": "simple",
|
|
608
801
|
"explode": false,
|
|
609
802
|
"schema": {
|
|
610
803
|
"$ref": "#/components/schemas/OrganizationId"
|
|
611
|
-
}
|
|
804
|
+
},
|
|
805
|
+
"example": "f_ecom_zzxy_prd"
|
|
612
806
|
},
|
|
613
807
|
{
|
|
614
808
|
"name": "limit",
|
|
615
809
|
"in": "query",
|
|
810
|
+
"description": "Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 25.",
|
|
616
811
|
"required": false,
|
|
617
812
|
"style": "form",
|
|
618
813
|
"explode": true,
|
|
@@ -620,12 +815,14 @@
|
|
|
620
815
|
"type": "integer",
|
|
621
816
|
"format": "int32",
|
|
622
817
|
"default": 25,
|
|
623
|
-
"maximum": 50
|
|
818
|
+
"maximum": 50,
|
|
819
|
+
"minimum": 1
|
|
624
820
|
}
|
|
625
821
|
},
|
|
626
822
|
{
|
|
627
823
|
"name": "offset",
|
|
628
824
|
"in": "query",
|
|
825
|
+
"description": "Used to retrieve the results based on a particular resource offset.",
|
|
629
826
|
"required": false,
|
|
630
827
|
"style": "form",
|
|
631
828
|
"explode": true,
|
|
@@ -644,16 +841,26 @@
|
|
|
644
841
|
"application/json": {
|
|
645
842
|
"schema": {
|
|
646
843
|
"$ref": "#/components/schemas/CustomerAddressResult"
|
|
844
|
+
},
|
|
845
|
+
"examples": {
|
|
846
|
+
"addressesGet": {
|
|
847
|
+
"$ref": "#/components/examples/addressesGet"
|
|
848
|
+
}
|
|
647
849
|
}
|
|
648
850
|
}
|
|
649
851
|
}
|
|
650
852
|
},
|
|
651
853
|
"400": {
|
|
652
|
-
"description": "Bad Request.
|
|
854
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
653
855
|
"content": {
|
|
654
856
|
"application/problem+json": {
|
|
655
857
|
"schema": {
|
|
656
858
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
859
|
+
},
|
|
860
|
+
"examples": {
|
|
861
|
+
"searchCustomerInCustomerList400": {
|
|
862
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
863
|
+
}
|
|
657
864
|
}
|
|
658
865
|
}
|
|
659
866
|
}
|
|
@@ -664,6 +871,11 @@
|
|
|
664
871
|
"application/problem+json": {
|
|
665
872
|
"schema": {
|
|
666
873
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
874
|
+
},
|
|
875
|
+
"examples": {
|
|
876
|
+
"searchCustomerInCustomerList401": {
|
|
877
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
878
|
+
}
|
|
667
879
|
}
|
|
668
880
|
}
|
|
669
881
|
}
|
|
@@ -674,6 +886,11 @@
|
|
|
674
886
|
"application/problem+json": {
|
|
675
887
|
"schema": {
|
|
676
888
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
889
|
+
},
|
|
890
|
+
"examples": {
|
|
891
|
+
"searchCustomerInCustomerList404": {
|
|
892
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
893
|
+
}
|
|
677
894
|
}
|
|
678
895
|
}
|
|
679
896
|
}
|
|
@@ -689,16 +906,20 @@
|
|
|
689
906
|
]
|
|
690
907
|
},
|
|
691
908
|
"post": {
|
|
909
|
+
"summary": "Add a new customer address.",
|
|
910
|
+
"description": "Creates a new customer address with the given address\ninformation.",
|
|
692
911
|
"operationId": "createAddressForCustomerInCustomerList",
|
|
693
912
|
"parameters": [
|
|
694
913
|
{
|
|
695
914
|
"name": "customerNo",
|
|
696
915
|
"in": "path",
|
|
916
|
+
"description": "The customer number.",
|
|
697
917
|
"required": true,
|
|
698
918
|
"style": "simple",
|
|
699
919
|
"explode": false,
|
|
700
920
|
"schema": {
|
|
701
921
|
"type": "string",
|
|
922
|
+
"example": "1",
|
|
702
923
|
"maxLength": 100,
|
|
703
924
|
"minLength": 1
|
|
704
925
|
}
|
|
@@ -706,11 +927,13 @@
|
|
|
706
927
|
{
|
|
707
928
|
"name": "customerListId",
|
|
708
929
|
"in": "path",
|
|
930
|
+
"description": "The customer list ID.",
|
|
709
931
|
"required": true,
|
|
710
932
|
"style": "simple",
|
|
711
933
|
"explode": false,
|
|
712
934
|
"schema": {
|
|
713
935
|
"type": "string",
|
|
936
|
+
"example": "Site1CustomerList",
|
|
714
937
|
"maxLength": 256,
|
|
715
938
|
"minLength": 1
|
|
716
939
|
}
|
|
@@ -718,12 +941,14 @@
|
|
|
718
941
|
{
|
|
719
942
|
"name": "organizationId",
|
|
720
943
|
"in": "path",
|
|
944
|
+
"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).",
|
|
721
945
|
"required": true,
|
|
722
946
|
"style": "simple",
|
|
723
947
|
"explode": false,
|
|
724
948
|
"schema": {
|
|
725
949
|
"$ref": "#/components/schemas/OrganizationId"
|
|
726
|
-
}
|
|
950
|
+
},
|
|
951
|
+
"example": "f_ecom_zzxy_prd"
|
|
727
952
|
}
|
|
728
953
|
],
|
|
729
954
|
"requestBody": {
|
|
@@ -731,6 +956,11 @@
|
|
|
731
956
|
"application/json": {
|
|
732
957
|
"schema": {
|
|
733
958
|
"$ref": "#/components/schemas/CustomerAddress"
|
|
959
|
+
},
|
|
960
|
+
"examples": {
|
|
961
|
+
"AddressesBody": {
|
|
962
|
+
"$ref": "#/components/examples/AddressesBody"
|
|
963
|
+
}
|
|
734
964
|
}
|
|
735
965
|
}
|
|
736
966
|
},
|
|
@@ -743,16 +973,26 @@
|
|
|
743
973
|
"application/json": {
|
|
744
974
|
"schema": {
|
|
745
975
|
"$ref": "#/components/schemas/CustomerAddress"
|
|
976
|
+
},
|
|
977
|
+
"examples": {
|
|
978
|
+
"addressesPost": {
|
|
979
|
+
"$ref": "#/components/examples/addressesPost"
|
|
980
|
+
}
|
|
746
981
|
}
|
|
747
982
|
}
|
|
748
983
|
}
|
|
749
984
|
},
|
|
750
985
|
"400": {
|
|
751
|
-
"description": "Bad Request.
|
|
986
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
752
987
|
"content": {
|
|
753
988
|
"application/problem+json": {
|
|
754
989
|
"schema": {
|
|
755
990
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
991
|
+
},
|
|
992
|
+
"examples": {
|
|
993
|
+
"searchCustomerInCustomerList400": {
|
|
994
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
995
|
+
}
|
|
756
996
|
}
|
|
757
997
|
}
|
|
758
998
|
}
|
|
@@ -763,6 +1003,11 @@
|
|
|
763
1003
|
"application/problem+json": {
|
|
764
1004
|
"schema": {
|
|
765
1005
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1006
|
+
},
|
|
1007
|
+
"examples": {
|
|
1008
|
+
"searchCustomerInCustomerList401": {
|
|
1009
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
1010
|
+
}
|
|
766
1011
|
}
|
|
767
1012
|
}
|
|
768
1013
|
}
|
|
@@ -773,6 +1018,11 @@
|
|
|
773
1018
|
"application/problem+json": {
|
|
774
1019
|
"schema": {
|
|
775
1020
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1021
|
+
},
|
|
1022
|
+
"examples": {
|
|
1023
|
+
"searchCustomerInCustomerList404": {
|
|
1024
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
1025
|
+
}
|
|
776
1026
|
}
|
|
777
1027
|
}
|
|
778
1028
|
}
|
|
@@ -789,16 +1039,20 @@
|
|
|
789
1039
|
},
|
|
790
1040
|
"/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}/addresses/{addressId}": {
|
|
791
1041
|
"get": {
|
|
1042
|
+
"summary": "Get a customer address.",
|
|
1043
|
+
"description": "Action that returns a single customer address from a customer list.",
|
|
792
1044
|
"operationId": "getAddressForCustomerFromCustomerList",
|
|
793
1045
|
"parameters": [
|
|
794
1046
|
{
|
|
795
1047
|
"name": "addressId",
|
|
796
1048
|
"in": "path",
|
|
1049
|
+
"description": "The address ID.",
|
|
797
1050
|
"required": true,
|
|
798
1051
|
"style": "simple",
|
|
799
1052
|
"explode": false,
|
|
800
1053
|
"schema": {
|
|
801
1054
|
"type": "string",
|
|
1055
|
+
"example": "Home",
|
|
802
1056
|
"maxLength": 256,
|
|
803
1057
|
"minLength": 1
|
|
804
1058
|
}
|
|
@@ -806,11 +1060,13 @@
|
|
|
806
1060
|
{
|
|
807
1061
|
"name": "customerNo",
|
|
808
1062
|
"in": "path",
|
|
1063
|
+
"description": "The customer number.",
|
|
809
1064
|
"required": true,
|
|
810
1065
|
"style": "simple",
|
|
811
1066
|
"explode": false,
|
|
812
1067
|
"schema": {
|
|
813
1068
|
"type": "string",
|
|
1069
|
+
"example": "1",
|
|
814
1070
|
"maxLength": 100,
|
|
815
1071
|
"minLength": 1
|
|
816
1072
|
}
|
|
@@ -818,11 +1074,13 @@
|
|
|
818
1074
|
{
|
|
819
1075
|
"name": "customerListId",
|
|
820
1076
|
"in": "path",
|
|
1077
|
+
"description": "The customer list ID.",
|
|
821
1078
|
"required": true,
|
|
822
1079
|
"style": "simple",
|
|
823
1080
|
"explode": false,
|
|
824
1081
|
"schema": {
|
|
825
1082
|
"type": "string",
|
|
1083
|
+
"example": "Site1CustomerList",
|
|
826
1084
|
"maxLength": 256,
|
|
827
1085
|
"minLength": 1
|
|
828
1086
|
}
|
|
@@ -830,12 +1088,14 @@
|
|
|
830
1088
|
{
|
|
831
1089
|
"name": "organizationId",
|
|
832
1090
|
"in": "path",
|
|
1091
|
+
"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).",
|
|
833
1092
|
"required": true,
|
|
834
1093
|
"style": "simple",
|
|
835
1094
|
"explode": false,
|
|
836
1095
|
"schema": {
|
|
837
1096
|
"$ref": "#/components/schemas/OrganizationId"
|
|
838
|
-
}
|
|
1097
|
+
},
|
|
1098
|
+
"example": "f_ecom_zzxy_prd"
|
|
839
1099
|
}
|
|
840
1100
|
],
|
|
841
1101
|
"responses": {
|
|
@@ -845,16 +1105,26 @@
|
|
|
845
1105
|
"application/json": {
|
|
846
1106
|
"schema": {
|
|
847
1107
|
"$ref": "#/components/schemas/CustomerAddress"
|
|
1108
|
+
},
|
|
1109
|
+
"examples": {
|
|
1110
|
+
"AddressGet": {
|
|
1111
|
+
"$ref": "#/components/examples/AddressGet"
|
|
1112
|
+
}
|
|
848
1113
|
}
|
|
849
1114
|
}
|
|
850
1115
|
}
|
|
851
1116
|
},
|
|
852
1117
|
"400": {
|
|
853
|
-
"description": "Bad Request.
|
|
1118
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
854
1119
|
"content": {
|
|
855
1120
|
"application/problem+json": {
|
|
856
1121
|
"schema": {
|
|
857
1122
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1123
|
+
},
|
|
1124
|
+
"examples": {
|
|
1125
|
+
"searchCustomerInCustomerList400": {
|
|
1126
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
1127
|
+
}
|
|
858
1128
|
}
|
|
859
1129
|
}
|
|
860
1130
|
}
|
|
@@ -865,6 +1135,11 @@
|
|
|
865
1135
|
"application/problem+json": {
|
|
866
1136
|
"schema": {
|
|
867
1137
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1138
|
+
},
|
|
1139
|
+
"examples": {
|
|
1140
|
+
"searchCustomerInCustomerList401": {
|
|
1141
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
1142
|
+
}
|
|
868
1143
|
}
|
|
869
1144
|
}
|
|
870
1145
|
}
|
|
@@ -875,6 +1150,11 @@
|
|
|
875
1150
|
"application/problem+json": {
|
|
876
1151
|
"schema": {
|
|
877
1152
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1153
|
+
},
|
|
1154
|
+
"examples": {
|
|
1155
|
+
"searchCustomerInCustomerList404": {
|
|
1156
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
1157
|
+
}
|
|
878
1158
|
}
|
|
879
1159
|
}
|
|
880
1160
|
}
|
|
@@ -890,16 +1170,20 @@
|
|
|
890
1170
|
]
|
|
891
1171
|
},
|
|
892
1172
|
"delete": {
|
|
1173
|
+
"summary": "Delete a customer address.",
|
|
1174
|
+
"description": "Deletes a customer address.",
|
|
893
1175
|
"operationId": "removeAddressForCustomerInCustomerList",
|
|
894
1176
|
"parameters": [
|
|
895
1177
|
{
|
|
896
1178
|
"name": "addressId",
|
|
897
1179
|
"in": "path",
|
|
1180
|
+
"description": "The address ID.",
|
|
898
1181
|
"required": true,
|
|
899
1182
|
"style": "simple",
|
|
900
1183
|
"explode": false,
|
|
901
1184
|
"schema": {
|
|
902
1185
|
"type": "string",
|
|
1186
|
+
"example": "Home",
|
|
903
1187
|
"maxLength": 256,
|
|
904
1188
|
"minLength": 1
|
|
905
1189
|
}
|
|
@@ -907,11 +1191,13 @@
|
|
|
907
1191
|
{
|
|
908
1192
|
"name": "customerNo",
|
|
909
1193
|
"in": "path",
|
|
1194
|
+
"description": "The customer number.",
|
|
910
1195
|
"required": true,
|
|
911
1196
|
"style": "simple",
|
|
912
1197
|
"explode": false,
|
|
913
1198
|
"schema": {
|
|
914
1199
|
"type": "string",
|
|
1200
|
+
"example": "1",
|
|
915
1201
|
"maxLength": 100,
|
|
916
1202
|
"minLength": 1
|
|
917
1203
|
}
|
|
@@ -919,11 +1205,13 @@
|
|
|
919
1205
|
{
|
|
920
1206
|
"name": "customerListId",
|
|
921
1207
|
"in": "path",
|
|
1208
|
+
"description": "The customer list ID.",
|
|
922
1209
|
"required": true,
|
|
923
1210
|
"style": "simple",
|
|
924
1211
|
"explode": false,
|
|
925
1212
|
"schema": {
|
|
926
1213
|
"type": "string",
|
|
1214
|
+
"example": "Site1CustomerList",
|
|
927
1215
|
"maxLength": 256,
|
|
928
1216
|
"minLength": 1
|
|
929
1217
|
}
|
|
@@ -931,12 +1219,14 @@
|
|
|
931
1219
|
{
|
|
932
1220
|
"name": "organizationId",
|
|
933
1221
|
"in": "path",
|
|
1222
|
+
"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).",
|
|
934
1223
|
"required": true,
|
|
935
1224
|
"style": "simple",
|
|
936
1225
|
"explode": false,
|
|
937
1226
|
"schema": {
|
|
938
1227
|
"$ref": "#/components/schemas/OrganizationId"
|
|
939
|
-
}
|
|
1228
|
+
},
|
|
1229
|
+
"example": "f_ecom_zzxy_prd"
|
|
940
1230
|
}
|
|
941
1231
|
],
|
|
942
1232
|
"responses": {
|
|
@@ -944,11 +1234,16 @@
|
|
|
944
1234
|
"description": "No Content"
|
|
945
1235
|
},
|
|
946
1236
|
"400": {
|
|
947
|
-
"description": "Bad Request.
|
|
1237
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
948
1238
|
"content": {
|
|
949
1239
|
"application/problem+json": {
|
|
950
1240
|
"schema": {
|
|
951
1241
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1242
|
+
},
|
|
1243
|
+
"examples": {
|
|
1244
|
+
"searchCustomerInCustomerList400": {
|
|
1245
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
1246
|
+
}
|
|
952
1247
|
}
|
|
953
1248
|
}
|
|
954
1249
|
}
|
|
@@ -959,6 +1254,11 @@
|
|
|
959
1254
|
"application/problem+json": {
|
|
960
1255
|
"schema": {
|
|
961
1256
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1257
|
+
},
|
|
1258
|
+
"examples": {
|
|
1259
|
+
"searchCustomerInCustomerList401": {
|
|
1260
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
1261
|
+
}
|
|
962
1262
|
}
|
|
963
1263
|
}
|
|
964
1264
|
}
|
|
@@ -969,6 +1269,11 @@
|
|
|
969
1269
|
"application/problem+json": {
|
|
970
1270
|
"schema": {
|
|
971
1271
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1272
|
+
},
|
|
1273
|
+
"examples": {
|
|
1274
|
+
"searchCustomerInCustomerList404": {
|
|
1275
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
1276
|
+
}
|
|
972
1277
|
}
|
|
973
1278
|
}
|
|
974
1279
|
}
|
|
@@ -983,16 +1288,20 @@
|
|
|
983
1288
|
]
|
|
984
1289
|
},
|
|
985
1290
|
"patch": {
|
|
1291
|
+
"summary": "Update a customer address.",
|
|
1292
|
+
"description": "Updates an address of a customer with the given address information.",
|
|
986
1293
|
"operationId": "updateAddressForCustomerInCustomerList",
|
|
987
1294
|
"parameters": [
|
|
988
1295
|
{
|
|
989
1296
|
"name": "addressId",
|
|
990
1297
|
"in": "path",
|
|
1298
|
+
"description": "The address ID.",
|
|
991
1299
|
"required": true,
|
|
992
1300
|
"style": "simple",
|
|
993
1301
|
"explode": false,
|
|
994
1302
|
"schema": {
|
|
995
1303
|
"type": "string",
|
|
1304
|
+
"example": "Home",
|
|
996
1305
|
"maxLength": 256,
|
|
997
1306
|
"minLength": 1
|
|
998
1307
|
}
|
|
@@ -1000,11 +1309,13 @@
|
|
|
1000
1309
|
{
|
|
1001
1310
|
"name": "customerNo",
|
|
1002
1311
|
"in": "path",
|
|
1312
|
+
"description": "The customer number.",
|
|
1003
1313
|
"required": true,
|
|
1004
1314
|
"style": "simple",
|
|
1005
1315
|
"explode": false,
|
|
1006
1316
|
"schema": {
|
|
1007
1317
|
"type": "string",
|
|
1318
|
+
"example": "1",
|
|
1008
1319
|
"maxLength": 100,
|
|
1009
1320
|
"minLength": 1
|
|
1010
1321
|
}
|
|
@@ -1012,11 +1323,13 @@
|
|
|
1012
1323
|
{
|
|
1013
1324
|
"name": "customerListId",
|
|
1014
1325
|
"in": "path",
|
|
1326
|
+
"description": "The customer list ID.",
|
|
1015
1327
|
"required": true,
|
|
1016
1328
|
"style": "simple",
|
|
1017
1329
|
"explode": false,
|
|
1018
1330
|
"schema": {
|
|
1019
1331
|
"type": "string",
|
|
1332
|
+
"example": "Site1CustomerList",
|
|
1020
1333
|
"maxLength": 256,
|
|
1021
1334
|
"minLength": 1
|
|
1022
1335
|
}
|
|
@@ -1024,12 +1337,14 @@
|
|
|
1024
1337
|
{
|
|
1025
1338
|
"name": "organizationId",
|
|
1026
1339
|
"in": "path",
|
|
1340
|
+
"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).",
|
|
1027
1341
|
"required": true,
|
|
1028
1342
|
"style": "simple",
|
|
1029
1343
|
"explode": false,
|
|
1030
1344
|
"schema": {
|
|
1031
1345
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1032
|
-
}
|
|
1346
|
+
},
|
|
1347
|
+
"example": "f_ecom_zzxy_prd"
|
|
1033
1348
|
}
|
|
1034
1349
|
],
|
|
1035
1350
|
"requestBody": {
|
|
@@ -1037,6 +1352,11 @@
|
|
|
1037
1352
|
"application/json": {
|
|
1038
1353
|
"schema": {
|
|
1039
1354
|
"$ref": "#/components/schemas/CustomerAddress"
|
|
1355
|
+
},
|
|
1356
|
+
"examples": {
|
|
1357
|
+
"AddressesBody": {
|
|
1358
|
+
"$ref": "#/components/examples/AddressesBody"
|
|
1359
|
+
}
|
|
1040
1360
|
}
|
|
1041
1361
|
}
|
|
1042
1362
|
},
|
|
@@ -1049,16 +1369,26 @@
|
|
|
1049
1369
|
"application/json": {
|
|
1050
1370
|
"schema": {
|
|
1051
1371
|
"$ref": "#/components/schemas/CustomerAddress"
|
|
1372
|
+
},
|
|
1373
|
+
"examples": {
|
|
1374
|
+
"addressesPost": {
|
|
1375
|
+
"$ref": "#/components/examples/addressesPost"
|
|
1376
|
+
}
|
|
1052
1377
|
}
|
|
1053
1378
|
}
|
|
1054
1379
|
}
|
|
1055
1380
|
},
|
|
1056
1381
|
"400": {
|
|
1057
|
-
"description": "Bad Request.
|
|
1382
|
+
"description": "Bad Request. Returned when a specified parameter value is unknown.\n",
|
|
1058
1383
|
"content": {
|
|
1059
1384
|
"application/problem+json": {
|
|
1060
1385
|
"schema": {
|
|
1061
1386
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1387
|
+
},
|
|
1388
|
+
"examples": {
|
|
1389
|
+
"searchCustomerInCustomerList400": {
|
|
1390
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList400"
|
|
1391
|
+
}
|
|
1062
1392
|
}
|
|
1063
1393
|
}
|
|
1064
1394
|
}
|
|
@@ -1069,6 +1399,11 @@
|
|
|
1069
1399
|
"application/problem+json": {
|
|
1070
1400
|
"schema": {
|
|
1071
1401
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1402
|
+
},
|
|
1403
|
+
"examples": {
|
|
1404
|
+
"searchCustomerInCustomerList401": {
|
|
1405
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
1406
|
+
}
|
|
1072
1407
|
}
|
|
1073
1408
|
}
|
|
1074
1409
|
}
|
|
@@ -1079,6 +1414,11 @@
|
|
|
1079
1414
|
"application/problem+json": {
|
|
1080
1415
|
"schema": {
|
|
1081
1416
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1417
|
+
},
|
|
1418
|
+
"examples": {
|
|
1419
|
+
"searchCustomerInCustomerList404": {
|
|
1420
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList404"
|
|
1421
|
+
}
|
|
1082
1422
|
}
|
|
1083
1423
|
}
|
|
1084
1424
|
}
|
|
@@ -1095,26 +1435,36 @@
|
|
|
1095
1435
|
},
|
|
1096
1436
|
"/organizations/{organizationId}/customer-group-search": {
|
|
1097
1437
|
"post": {
|
|
1438
|
+
"summary": "Search for customer groups.",
|
|
1439
|
+
"description": "Search for customer groups in a given site ID.\nThe query attribute specifies a complex query that can be used to narrow down the search. The following list\nprovides searchable attributes:\n\n| Attribute | Type |\n|-----------|--------|\n| id| String |\n| description | String |\n| type | String |\n\nNote: This endpoint is available with B2C Commerce version 24.2.",
|
|
1098
1440
|
"operationId": "searchCustomerGroup",
|
|
1099
1441
|
"parameters": [
|
|
1100
1442
|
{
|
|
1101
1443
|
"name": "organizationId",
|
|
1102
1444
|
"in": "path",
|
|
1445
|
+
"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).",
|
|
1103
1446
|
"required": true,
|
|
1104
1447
|
"style": "simple",
|
|
1105
1448
|
"explode": false,
|
|
1106
1449
|
"schema": {
|
|
1107
1450
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1108
|
-
}
|
|
1451
|
+
},
|
|
1452
|
+
"example": "f_ecom_zzxy_prd"
|
|
1109
1453
|
},
|
|
1110
1454
|
{
|
|
1111
1455
|
"name": "siteId",
|
|
1112
1456
|
"in": "query",
|
|
1457
|
+
"description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.",
|
|
1113
1458
|
"required": true,
|
|
1114
1459
|
"style": "form",
|
|
1115
1460
|
"explode": true,
|
|
1116
1461
|
"schema": {
|
|
1117
1462
|
"$ref": "#/components/schemas/SiteId"
|
|
1463
|
+
},
|
|
1464
|
+
"examples": {
|
|
1465
|
+
"SiteId": {
|
|
1466
|
+
"value": "RefArch"
|
|
1467
|
+
}
|
|
1118
1468
|
}
|
|
1119
1469
|
}
|
|
1120
1470
|
],
|
|
@@ -1123,6 +1473,11 @@
|
|
|
1123
1473
|
"application/json": {
|
|
1124
1474
|
"schema": {
|
|
1125
1475
|
"$ref": "#/components/schemas/SearchRequest"
|
|
1476
|
+
},
|
|
1477
|
+
"examples": {
|
|
1478
|
+
"CustomerSearchBody": {
|
|
1479
|
+
"$ref": "#/components/examples/CustomerSearchBody"
|
|
1480
|
+
}
|
|
1126
1481
|
}
|
|
1127
1482
|
}
|
|
1128
1483
|
},
|
|
@@ -1135,16 +1490,26 @@
|
|
|
1135
1490
|
"application/json": {
|
|
1136
1491
|
"schema": {
|
|
1137
1492
|
"$ref": "#/components/schemas/CustomerGroupSearchResult"
|
|
1493
|
+
},
|
|
1494
|
+
"examples": {
|
|
1495
|
+
"CustomerGroupSearchResult": {
|
|
1496
|
+
"$ref": "#/components/examples/CustomerGroupSearchResult"
|
|
1497
|
+
}
|
|
1138
1498
|
}
|
|
1139
1499
|
}
|
|
1140
1500
|
}
|
|
1141
1501
|
},
|
|
1142
1502
|
"400": {
|
|
1143
|
-
"description": "Bad Request.
|
|
1503
|
+
"description": "Bad Request. Returned if the search term in term query does not match any of the customer group or if the query is ill-formed.\n",
|
|
1144
1504
|
"content": {
|
|
1145
1505
|
"application/problem+json": {
|
|
1146
1506
|
"schema": {
|
|
1147
1507
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1508
|
+
},
|
|
1509
|
+
"examples": {
|
|
1510
|
+
"searchCustomerGroup400": {
|
|
1511
|
+
"$ref": "#/components/examples/searchCustomerGroup400"
|
|
1512
|
+
}
|
|
1148
1513
|
}
|
|
1149
1514
|
}
|
|
1150
1515
|
}
|
|
@@ -1155,6 +1520,11 @@
|
|
|
1155
1520
|
"application/problem+json": {
|
|
1156
1521
|
"schema": {
|
|
1157
1522
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1523
|
+
},
|
|
1524
|
+
"examples": {
|
|
1525
|
+
"searchCustomerInCustomerList401": {
|
|
1526
|
+
"$ref": "#/components/examples/searchCustomerInCustomerList401"
|
|
1527
|
+
}
|
|
1158
1528
|
}
|
|
1159
1529
|
}
|
|
1160
1530
|
}
|
|
@@ -1172,26 +1542,36 @@
|
|
|
1172
1542
|
},
|
|
1173
1543
|
"/organizations/{organizationId}/customer-groups": {
|
|
1174
1544
|
"get": {
|
|
1545
|
+
"summary": "Get a list of customer groups.",
|
|
1546
|
+
"description": "Returns a list of all customer groups for a given site in pages.\nThe default page size is 25 customer groups.",
|
|
1175
1547
|
"operationId": "getCustomerGroups",
|
|
1176
1548
|
"parameters": [
|
|
1177
1549
|
{
|
|
1178
1550
|
"name": "organizationId",
|
|
1179
1551
|
"in": "path",
|
|
1552
|
+
"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).",
|
|
1180
1553
|
"required": true,
|
|
1181
1554
|
"style": "simple",
|
|
1182
1555
|
"explode": false,
|
|
1183
1556
|
"schema": {
|
|
1184
1557
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1185
|
-
}
|
|
1558
|
+
},
|
|
1559
|
+
"example": "f_ecom_zzxy_prd"
|
|
1186
1560
|
},
|
|
1187
1561
|
{
|
|
1188
1562
|
"name": "siteId",
|
|
1189
1563
|
"in": "query",
|
|
1564
|
+
"description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.",
|
|
1190
1565
|
"required": true,
|
|
1191
1566
|
"style": "form",
|
|
1192
1567
|
"explode": true,
|
|
1193
1568
|
"schema": {
|
|
1194
1569
|
"$ref": "#/components/schemas/SiteId"
|
|
1570
|
+
},
|
|
1571
|
+
"examples": {
|
|
1572
|
+
"SiteId": {
|
|
1573
|
+
"value": "RefArch"
|
|
1574
|
+
}
|
|
1195
1575
|
}
|
|
1196
1576
|
},
|
|
1197
1577
|
{
|
|
@@ -1202,11 +1582,17 @@
|
|
|
1202
1582
|
"explode": true,
|
|
1203
1583
|
"schema": {
|
|
1204
1584
|
"$ref": "#/components/schemas/Select"
|
|
1585
|
+
},
|
|
1586
|
+
"examples": {
|
|
1587
|
+
"select": {
|
|
1588
|
+
"value": "(**)"
|
|
1589
|
+
}
|
|
1205
1590
|
}
|
|
1206
1591
|
},
|
|
1207
1592
|
{
|
|
1208
1593
|
"name": "limit",
|
|
1209
1594
|
"in": "query",
|
|
1595
|
+
"description": "Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 25.",
|
|
1210
1596
|
"required": false,
|
|
1211
1597
|
"style": "form",
|
|
1212
1598
|
"explode": true,
|
|
@@ -1214,12 +1600,14 @@
|
|
|
1214
1600
|
"type": "integer",
|
|
1215
1601
|
"format": "int32",
|
|
1216
1602
|
"default": 25,
|
|
1217
|
-
"maximum": 50
|
|
1603
|
+
"maximum": 50,
|
|
1604
|
+
"minimum": 1
|
|
1218
1605
|
}
|
|
1219
1606
|
},
|
|
1220
1607
|
{
|
|
1221
1608
|
"name": "offset",
|
|
1222
1609
|
"in": "query",
|
|
1610
|
+
"description": "Used to retrieve the results based on a particular resource offset.",
|
|
1223
1611
|
"required": false,
|
|
1224
1612
|
"style": "form",
|
|
1225
1613
|
"explode": true,
|
|
@@ -1238,16 +1626,26 @@
|
|
|
1238
1626
|
"application/json": {
|
|
1239
1627
|
"schema": {
|
|
1240
1628
|
"$ref": "#/components/schemas/CustomerGroupResult"
|
|
1629
|
+
},
|
|
1630
|
+
"examples": {
|
|
1631
|
+
"CustomerGroupResult": {
|
|
1632
|
+
"$ref": "#/components/examples/CustomerGroupResult"
|
|
1633
|
+
}
|
|
1241
1634
|
}
|
|
1242
1635
|
}
|
|
1243
1636
|
}
|
|
1244
1637
|
},
|
|
1245
1638
|
"400": {
|
|
1246
|
-
"description": "Bad Request.
|
|
1639
|
+
"description": "Bad Request. Returned when a specified parameter value is invalid.\n",
|
|
1247
1640
|
"content": {
|
|
1248
1641
|
"application/problem+json": {
|
|
1249
1642
|
"schema": {
|
|
1250
1643
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1644
|
+
},
|
|
1645
|
+
"examples": {
|
|
1646
|
+
"malformedSelector400": {
|
|
1647
|
+
"$ref": "#/components/examples/malformedSelector400"
|
|
1648
|
+
}
|
|
1251
1649
|
}
|
|
1252
1650
|
}
|
|
1253
1651
|
}
|
|
@@ -1265,31 +1663,42 @@
|
|
|
1265
1663
|
},
|
|
1266
1664
|
"/organizations/{organizationId}/customer-groups/{customerGroupId}/members": {
|
|
1267
1665
|
"put": {
|
|
1666
|
+
"summary": "Assign multiple customers to a customer group.",
|
|
1667
|
+
"description": "Add multiple customers to a (static) customer group. \nThis endpoint assigns the specified customers to the customer group identified by the given ID.\nOnly static customer groups support this operation.\n",
|
|
1268
1668
|
"operationId": "assignCustomerGroupMembers",
|
|
1269
1669
|
"parameters": [
|
|
1270
1670
|
{
|
|
1271
1671
|
"name": "organizationId",
|
|
1272
1672
|
"in": "path",
|
|
1673
|
+
"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).",
|
|
1273
1674
|
"required": true,
|
|
1274
1675
|
"style": "simple",
|
|
1275
1676
|
"explode": false,
|
|
1276
1677
|
"schema": {
|
|
1277
1678
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1278
|
-
}
|
|
1679
|
+
},
|
|
1680
|
+
"example": "f_ecom_zzxy_prd"
|
|
1279
1681
|
},
|
|
1280
1682
|
{
|
|
1281
1683
|
"name": "siteId",
|
|
1282
1684
|
"in": "query",
|
|
1685
|
+
"description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.",
|
|
1283
1686
|
"required": true,
|
|
1284
1687
|
"style": "form",
|
|
1285
1688
|
"explode": true,
|
|
1286
1689
|
"schema": {
|
|
1287
1690
|
"$ref": "#/components/schemas/SiteId"
|
|
1691
|
+
},
|
|
1692
|
+
"examples": {
|
|
1693
|
+
"SiteId": {
|
|
1694
|
+
"value": "RefArch"
|
|
1695
|
+
}
|
|
1288
1696
|
}
|
|
1289
1697
|
},
|
|
1290
1698
|
{
|
|
1291
1699
|
"name": "customerGroupId",
|
|
1292
1700
|
"in": "path",
|
|
1701
|
+
"description": "The customer group identifier.",
|
|
1293
1702
|
"required": true,
|
|
1294
1703
|
"style": "simple",
|
|
1295
1704
|
"explode": false,
|
|
@@ -1300,6 +1709,7 @@
|
|
|
1300
1709
|
{
|
|
1301
1710
|
"name": "customerNos",
|
|
1302
1711
|
"in": "query",
|
|
1712
|
+
"description": "List of customer numbers to assign or unassign from the customer group.",
|
|
1303
1713
|
"required": true,
|
|
1304
1714
|
"style": "form",
|
|
1305
1715
|
"explode": false,
|
|
@@ -1310,7 +1720,12 @@
|
|
|
1310
1720
|
},
|
|
1311
1721
|
"maxItems": 50,
|
|
1312
1722
|
"minItems": 1
|
|
1313
|
-
}
|
|
1723
|
+
},
|
|
1724
|
+
"example": [
|
|
1725
|
+
"00001234",
|
|
1726
|
+
"00005678",
|
|
1727
|
+
"00009012"
|
|
1728
|
+
]
|
|
1314
1729
|
}
|
|
1315
1730
|
],
|
|
1316
1731
|
"responses": {
|
|
@@ -1320,6 +1735,11 @@
|
|
|
1320
1735
|
"application/json": {
|
|
1321
1736
|
"schema": {
|
|
1322
1737
|
"$ref": "#/components/schemas/CustomerGroupMemberResult"
|
|
1738
|
+
},
|
|
1739
|
+
"examples": {
|
|
1740
|
+
"AssignMembersSuccess": {
|
|
1741
|
+
"$ref": "#/components/examples/AssignMembersSuccess"
|
|
1742
|
+
}
|
|
1323
1743
|
}
|
|
1324
1744
|
}
|
|
1325
1745
|
}
|
|
@@ -1330,6 +1750,11 @@
|
|
|
1330
1750
|
"application/problem+json": {
|
|
1331
1751
|
"schema": {
|
|
1332
1752
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1753
|
+
},
|
|
1754
|
+
"examples": {
|
|
1755
|
+
"customerGroupUnsupportedAssignment403": {
|
|
1756
|
+
"$ref": "#/components/examples/customerGroupUnsupportedAssignment403"
|
|
1757
|
+
}
|
|
1333
1758
|
}
|
|
1334
1759
|
}
|
|
1335
1760
|
}
|
|
@@ -1340,6 +1765,14 @@
|
|
|
1340
1765
|
"application/problem+json": {
|
|
1341
1766
|
"schema": {
|
|
1342
1767
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1768
|
+
},
|
|
1769
|
+
"examples": {
|
|
1770
|
+
"customerGroupNotFound404": {
|
|
1771
|
+
"$ref": "#/components/examples/customerGroupNotFound404"
|
|
1772
|
+
},
|
|
1773
|
+
"customerNotFound404": {
|
|
1774
|
+
"$ref": "#/components/examples/customerNotFound404"
|
|
1775
|
+
}
|
|
1343
1776
|
}
|
|
1344
1777
|
}
|
|
1345
1778
|
}
|
|
@@ -1350,6 +1783,11 @@
|
|
|
1350
1783
|
"application/problem+json": {
|
|
1351
1784
|
"schema": {
|
|
1352
1785
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1786
|
+
},
|
|
1787
|
+
"examples": {
|
|
1788
|
+
"objectInDeletionConflict409": {
|
|
1789
|
+
"$ref": "#/components/examples/objectInDeletionConflict409"
|
|
1790
|
+
}
|
|
1353
1791
|
}
|
|
1354
1792
|
}
|
|
1355
1793
|
}
|
|
@@ -1365,31 +1803,42 @@
|
|
|
1365
1803
|
]
|
|
1366
1804
|
},
|
|
1367
1805
|
"delete": {
|
|
1806
|
+
"summary": "Unassign multiple customers from a customer group.",
|
|
1807
|
+
"description": "Remove multiple customers from a (static) customer group.\nThis endpoint unassigns the specified customers from the customer group identified by the given ID.\nOnly static customer groups support this operation.\n",
|
|
1368
1808
|
"operationId": "unassignCustomerGroupMembers",
|
|
1369
1809
|
"parameters": [
|
|
1370
1810
|
{
|
|
1371
1811
|
"name": "organizationId",
|
|
1372
1812
|
"in": "path",
|
|
1813
|
+
"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).",
|
|
1373
1814
|
"required": true,
|
|
1374
1815
|
"style": "simple",
|
|
1375
1816
|
"explode": false,
|
|
1376
1817
|
"schema": {
|
|
1377
1818
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1378
|
-
}
|
|
1819
|
+
},
|
|
1820
|
+
"example": "f_ecom_zzxy_prd"
|
|
1379
1821
|
},
|
|
1380
1822
|
{
|
|
1381
1823
|
"name": "siteId",
|
|
1382
1824
|
"in": "query",
|
|
1825
|
+
"description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.",
|
|
1383
1826
|
"required": true,
|
|
1384
1827
|
"style": "form",
|
|
1385
1828
|
"explode": true,
|
|
1386
1829
|
"schema": {
|
|
1387
1830
|
"$ref": "#/components/schemas/SiteId"
|
|
1831
|
+
},
|
|
1832
|
+
"examples": {
|
|
1833
|
+
"SiteId": {
|
|
1834
|
+
"value": "RefArch"
|
|
1835
|
+
}
|
|
1388
1836
|
}
|
|
1389
1837
|
},
|
|
1390
1838
|
{
|
|
1391
1839
|
"name": "customerGroupId",
|
|
1392
1840
|
"in": "path",
|
|
1841
|
+
"description": "The customer group identifier.",
|
|
1393
1842
|
"required": true,
|
|
1394
1843
|
"style": "simple",
|
|
1395
1844
|
"explode": false,
|
|
@@ -1400,6 +1849,7 @@
|
|
|
1400
1849
|
{
|
|
1401
1850
|
"name": "customerNos",
|
|
1402
1851
|
"in": "query",
|
|
1852
|
+
"description": "List of customer numbers to assign or unassign from the customer group.",
|
|
1403
1853
|
"required": true,
|
|
1404
1854
|
"style": "form",
|
|
1405
1855
|
"explode": false,
|
|
@@ -1410,7 +1860,12 @@
|
|
|
1410
1860
|
},
|
|
1411
1861
|
"maxItems": 50,
|
|
1412
1862
|
"minItems": 1
|
|
1413
|
-
}
|
|
1863
|
+
},
|
|
1864
|
+
"example": [
|
|
1865
|
+
"00001234",
|
|
1866
|
+
"00005678",
|
|
1867
|
+
"00009012"
|
|
1868
|
+
]
|
|
1414
1869
|
}
|
|
1415
1870
|
],
|
|
1416
1871
|
"responses": {
|
|
@@ -1423,6 +1878,14 @@
|
|
|
1423
1878
|
"application/problem+json": {
|
|
1424
1879
|
"schema": {
|
|
1425
1880
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1881
|
+
},
|
|
1882
|
+
"examples": {
|
|
1883
|
+
"customerGroupNotFound404": {
|
|
1884
|
+
"$ref": "#/components/examples/customerGroupNotFound404"
|
|
1885
|
+
},
|
|
1886
|
+
"customerNotFound404": {
|
|
1887
|
+
"$ref": "#/components/examples/customerNotFound404"
|
|
1888
|
+
}
|
|
1426
1889
|
}
|
|
1427
1890
|
}
|
|
1428
1891
|
}
|
|
@@ -1433,6 +1896,11 @@
|
|
|
1433
1896
|
"application/problem+json": {
|
|
1434
1897
|
"schema": {
|
|
1435
1898
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1899
|
+
},
|
|
1900
|
+
"examples": {
|
|
1901
|
+
"objectInDeletionConflict409": {
|
|
1902
|
+
"$ref": "#/components/examples/objectInDeletionConflict409"
|
|
1903
|
+
}
|
|
1436
1904
|
}
|
|
1437
1905
|
}
|
|
1438
1906
|
}
|
|
@@ -1453,12 +1921,35 @@
|
|
|
1453
1921
|
"schemas": {
|
|
1454
1922
|
"OrganizationId": {
|
|
1455
1923
|
"type": "string",
|
|
1456
|
-
"
|
|
1457
|
-
"
|
|
1924
|
+
"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).",
|
|
1925
|
+
"example": "f_ecom_zzxy_prd",
|
|
1926
|
+
"pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
|
|
1458
1927
|
},
|
|
1459
1928
|
"Query": {
|
|
1460
1929
|
"type": "object",
|
|
1461
1930
|
"additionalProperties": false,
|
|
1931
|
+
"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._",
|
|
1932
|
+
"example": {
|
|
1933
|
+
"filteredQuery": {
|
|
1934
|
+
"query": {
|
|
1935
|
+
"textQuery": {
|
|
1936
|
+
"fields": [
|
|
1937
|
+
"couponId"
|
|
1938
|
+
],
|
|
1939
|
+
"searchPhrase": "disabled"
|
|
1940
|
+
}
|
|
1941
|
+
},
|
|
1942
|
+
"filter": {
|
|
1943
|
+
"termFilter": {
|
|
1944
|
+
"field": "enabled",
|
|
1945
|
+
"operator": "is",
|
|
1946
|
+
"values": [
|
|
1947
|
+
false
|
|
1948
|
+
]
|
|
1949
|
+
}
|
|
1950
|
+
}
|
|
1951
|
+
}
|
|
1952
|
+
},
|
|
1462
1953
|
"maxProperties": 1,
|
|
1463
1954
|
"minProperties": 1,
|
|
1464
1955
|
"properties": {
|
|
@@ -1485,21 +1976,58 @@
|
|
|
1485
1976
|
"BoolQuery": {
|
|
1486
1977
|
"type": "object",
|
|
1487
1978
|
"additionalProperties": false,
|
|
1979
|
+
"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",
|
|
1980
|
+
"example": {
|
|
1981
|
+
"must": [
|
|
1982
|
+
{
|
|
1983
|
+
"textQuery": {
|
|
1984
|
+
"fields": [
|
|
1985
|
+
"couponId"
|
|
1986
|
+
],
|
|
1987
|
+
"searchPhrase": "DEAL"
|
|
1988
|
+
}
|
|
1989
|
+
},
|
|
1990
|
+
{
|
|
1991
|
+
"textQuery": {
|
|
1992
|
+
"fields": [
|
|
1993
|
+
"description"
|
|
1994
|
+
],
|
|
1995
|
+
"searchPhrase": "Big bargain deal"
|
|
1996
|
+
}
|
|
1997
|
+
}
|
|
1998
|
+
],
|
|
1999
|
+
"mustNot": [
|
|
2000
|
+
{
|
|
2001
|
+
"termQuery": {
|
|
2002
|
+
"fields": [
|
|
2003
|
+
"enabled"
|
|
2004
|
+
],
|
|
2005
|
+
"operator": "is",
|
|
2006
|
+
"values": [
|
|
2007
|
+
false
|
|
2008
|
+
]
|
|
2009
|
+
}
|
|
2010
|
+
}
|
|
2011
|
+
]
|
|
2012
|
+
},
|
|
1488
2013
|
"properties": {
|
|
1489
2014
|
"must": {
|
|
1490
2015
|
"type": "array",
|
|
2016
|
+
"description": "List of queries to be evaluated as an `AND` operator.",
|
|
1491
2017
|
"items": {
|
|
1492
2018
|
"$ref": "#/components/schemas/Query"
|
|
1493
2019
|
}
|
|
1494
2020
|
},
|
|
1495
2021
|
"mustNot": {
|
|
1496
2022
|
"type": "array",
|
|
2023
|
+
"description": "List of queries to be evaluated as a `NOT` operator.",
|
|
1497
2024
|
"items": {
|
|
1498
2025
|
"$ref": "#/components/schemas/Query"
|
|
1499
2026
|
}
|
|
1500
2027
|
},
|
|
1501
2028
|
"should": {
|
|
1502
2029
|
"type": "array",
|
|
2030
|
+
"description": "List of queries to be evaluated as an `OR` operator.",
|
|
1503
2031
|
"items": {
|
|
1504
2032
|
"$ref": "#/components/schemas/Query"
|
|
1505
2033
|
}
|
|
@@ -1509,6 +2037,7 @@
|
|
|
1509
2037
|
"Filter": {
|
|
1510
2038
|
"type": "object",
|
|
1511
2039
|
"additionalProperties": false,
|
|
2040
|
+
"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.",
|
|
1512
2041
|
"maxProperties": 1,
|
|
1513
2042
|
"minProperties": 1,
|
|
1514
2043
|
"properties": {
|
|
@@ -1532,20 +2061,47 @@
|
|
|
1532
2061
|
"BoolFilter": {
|
|
1533
2062
|
"type": "object",
|
|
1534
2063
|
"additionalProperties": false,
|
|
2064
|
+
"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.",
|
|
2065
|
+
"example": {
|
|
2066
|
+
"operator": "and",
|
|
2067
|
+
"filters": [
|
|
2068
|
+
{
|
|
2069
|
+
"termFilter": {
|
|
2070
|
+
"field": "id",
|
|
2071
|
+
"operator": "is",
|
|
2072
|
+
"values": [
|
|
2073
|
+
"myId"
|
|
2074
|
+
]
|
|
2075
|
+
}
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
"termFilter": {
|
|
2079
|
+
"field": "couponId",
|
|
2080
|
+
"operator": "is",
|
|
2081
|
+
"values": [
|
|
2082
|
+
"couponOne"
|
|
2083
|
+
]
|
|
2084
|
+
}
|
|
2085
|
+
}
|
|
2086
|
+
]
|
|
2087
|
+
},
|
|
1535
2088
|
"properties": {
|
|
1536
2089
|
"filters": {
|
|
1537
2090
|
"type": "array",
|
|
2091
|
+
"description": "A list of filters that are logically combined by an operator.",
|
|
1538
2092
|
"items": {
|
|
1539
2093
|
"$ref": "#/components/schemas/Filter"
|
|
1540
2094
|
}
|
|
1541
2095
|
},
|
|
1542
2096
|
"operator": {
|
|
1543
2097
|
"type": "string",
|
|
2098
|
+
"description": "The logical operator that is used to combine the filters.",
|
|
1544
2099
|
"enum": [
|
|
1545
2100
|
"and",
|
|
1546
2101
|
"or",
|
|
1547
2102
|
"not"
|
|
1548
|
-
]
|
|
2103
|
+
],
|
|
2104
|
+
"example": "and"
|
|
1549
2105
|
}
|
|
1550
2106
|
},
|
|
1551
2107
|
"required": [
|
|
@@ -1554,6 +2110,7 @@
|
|
|
1554
2110
|
},
|
|
1555
2111
|
"QueryFilter": {
|
|
1556
2112
|
"type": "object",
|
|
2113
|
+
"description": "Wraps any query and allows it to be used as a filter.",
|
|
1557
2114
|
"properties": {
|
|
1558
2115
|
"query": {
|
|
1559
2116
|
"$ref": "#/components/schemas/Query"
|
|
@@ -1565,45 +2122,71 @@
|
|
|
1565
2122
|
},
|
|
1566
2123
|
"Field": {
|
|
1567
2124
|
"type": "string",
|
|
2125
|
+
"description": "Name of the field. Might be a custom field name prefixed with c_.",
|
|
2126
|
+
"example": "couponId",
|
|
1568
2127
|
"maxLength": 260
|
|
1569
2128
|
},
|
|
1570
2129
|
"Range2Filter": {
|
|
1571
2130
|
"type": "object",
|
|
1572
2131
|
"additionalProperties": false,
|
|
2132
|
+
"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.",
|
|
2133
|
+
"example": {
|
|
2134
|
+
"fromField": "validFrom",
|
|
2135
|
+
"toField": "validTo",
|
|
2136
|
+
"filterMode": "overlap",
|
|
2137
|
+
"fromValue": "2007-01-01T00:00:00.000Z",
|
|
2138
|
+
"toValue": "2017-01-01T00:00:00.000Z"
|
|
2139
|
+
},
|
|
1573
2140
|
"properties": {
|
|
1574
2141
|
"filterMode": {
|
|
1575
2142
|
"type": "string",
|
|
1576
2143
|
"default": "overlap",
|
|
2144
|
+
"description": "Compare mode: overlap, containing, or contained.",
|
|
1577
2145
|
"enum": [
|
|
1578
2146
|
"overlap",
|
|
1579
2147
|
"containing",
|
|
1580
2148
|
"contained"
|
|
1581
|
-
]
|
|
2149
|
+
],
|
|
2150
|
+
"example": "overlap"
|
|
1582
2151
|
},
|
|
1583
2152
|
"fromField": {
|
|
1584
2153
|
"allOf": [
|
|
1585
2154
|
{
|
|
1586
2155
|
"$ref": "#/components/schemas/Field"
|
|
1587
2156
|
}
|
|
1588
|
-
]
|
|
2157
|
+
],
|
|
2158
|
+
"description": "The field name of the field that starts the first range.",
|
|
2159
|
+
"example": "validFrom"
|
|
1589
2160
|
},
|
|
1590
2161
|
"fromInclusive": {
|
|
1591
2162
|
"type": "boolean",
|
|
1592
|
-
"default": true
|
|
2163
|
+
"default": true,
|
|
2164
|
+
"description": "A flag indicating if the lower bound of the second range is inclusive. To make the lower bound exclusive, set to `false`.",
|
|
2165
|
+
"example": true
|
|
2166
|
+
},
|
|
2167
|
+
"fromValue": {
|
|
2168
|
+
"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.",
|
|
2169
|
+
"example": "2007-01-01T00:00:00.000Z"
|
|
1593
2170
|
},
|
|
1594
|
-
"fromValue": {},
|
|
1595
2171
|
"toField": {
|
|
1596
2172
|
"allOf": [
|
|
1597
2173
|
{
|
|
1598
2174
|
"$ref": "#/components/schemas/Field"
|
|
1599
2175
|
}
|
|
1600
|
-
]
|
|
2176
|
+
],
|
|
2177
|
+
"description": "The field name of the field that ends the first range.",
|
|
2178
|
+
"example": "validTo"
|
|
1601
2179
|
},
|
|
1602
2180
|
"toInclusive": {
|
|
1603
2181
|
"type": "boolean",
|
|
1604
|
-
"default": true
|
|
2182
|
+
"default": true,
|
|
2183
|
+
"description": "A flag indicating if the upper bound of the second range is inclusive. To make the lower bound exclusive, set to `false`.",
|
|
2184
|
+
"example": true
|
|
1605
2185
|
},
|
|
1606
|
-
"toValue": {
|
|
2186
|
+
"toValue": {
|
|
2187
|
+
"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.",
|
|
2188
|
+
"example": "2017-01-01T00:00:00.000Z"
|
|
2189
|
+
}
|
|
1607
2190
|
},
|
|
1608
2191
|
"required": [
|
|
1609
2192
|
"fromField",
|
|
@@ -1612,49 +2195,64 @@
|
|
|
1612
2195
|
},
|
|
1613
2196
|
"RangeFilter": {
|
|
1614
2197
|
"type": "object",
|
|
2198
|
+
"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.",
|
|
1615
2199
|
"properties": {
|
|
1616
2200
|
"field": {
|
|
1617
2201
|
"allOf": [
|
|
1618
2202
|
{
|
|
1619
2203
|
"$ref": "#/components/schemas/Field"
|
|
1620
2204
|
}
|
|
1621
|
-
]
|
|
2205
|
+
],
|
|
2206
|
+
"description": "The search field.",
|
|
2207
|
+
"example": "validFrom"
|
|
1622
2208
|
},
|
|
1623
2209
|
"from": {
|
|
2210
|
+
"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.",
|
|
1624
2211
|
"oneOf": [
|
|
1625
2212
|
{
|
|
1626
2213
|
"type": "string",
|
|
1627
|
-
"format": "date-time"
|
|
2214
|
+
"format": "date-time",
|
|
2215
|
+
"example": "2007-01-01T00:00:00Z"
|
|
1628
2216
|
},
|
|
1629
2217
|
{
|
|
1630
|
-
"type": "integer"
|
|
2218
|
+
"type": "integer",
|
|
2219
|
+
"example": 1
|
|
1631
2220
|
},
|
|
1632
2221
|
{
|
|
1633
|
-
"type": "number"
|
|
2222
|
+
"type": "number",
|
|
2223
|
+
"example": 1
|
|
1634
2224
|
}
|
|
1635
2225
|
]
|
|
1636
2226
|
},
|
|
1637
2227
|
"fromInclusive": {
|
|
1638
2228
|
"type": "boolean",
|
|
1639
|
-
"default": true
|
|
2229
|
+
"default": true,
|
|
2230
|
+
"description": "A flag indicating if the lower bound of the range is inclusive. To make the lower bound exclusive, set to `false`.",
|
|
2231
|
+
"example": true
|
|
1640
2232
|
},
|
|
1641
2233
|
"to": {
|
|
2234
|
+
"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.",
|
|
1642
2235
|
"oneOf": [
|
|
1643
2236
|
{
|
|
1644
2237
|
"type": "string",
|
|
1645
|
-
"format": "date-time"
|
|
2238
|
+
"format": "date-time",
|
|
2239
|
+
"example": "2007-01-02T00:00:00Z"
|
|
1646
2240
|
},
|
|
1647
2241
|
{
|
|
1648
|
-
"type": "integer"
|
|
2242
|
+
"type": "integer",
|
|
2243
|
+
"example": 2
|
|
1649
2244
|
},
|
|
1650
2245
|
{
|
|
1651
|
-
"type": "number"
|
|
2246
|
+
"type": "number",
|
|
2247
|
+
"example": 2
|
|
1652
2248
|
}
|
|
1653
2249
|
]
|
|
1654
2250
|
},
|
|
1655
2251
|
"toInclusive": {
|
|
1656
2252
|
"type": "boolean",
|
|
1657
|
-
"default": true
|
|
2253
|
+
"default": true,
|
|
2254
|
+
"description": "A flag indicating if the upper bound of the range is inclusive. To make the upper bound exclusive, set to `false`.",
|
|
2255
|
+
"example": true
|
|
1658
2256
|
}
|
|
1659
2257
|
},
|
|
1660
2258
|
"required": [
|
|
@@ -1664,16 +2262,26 @@
|
|
|
1664
2262
|
"TermFilter": {
|
|
1665
2263
|
"type": "object",
|
|
1666
2264
|
"additionalProperties": false,
|
|
2265
|
+
"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.",
|
|
2266
|
+
"example": {
|
|
2267
|
+
"field": "id",
|
|
2268
|
+
"operator": "is",
|
|
2269
|
+
"values": [
|
|
2270
|
+
"myId"
|
|
2271
|
+
]
|
|
2272
|
+
},
|
|
1667
2273
|
"properties": {
|
|
1668
2274
|
"field": {
|
|
1669
2275
|
"allOf": [
|
|
1670
2276
|
{
|
|
1671
2277
|
"$ref": "#/components/schemas/Field"
|
|
1672
2278
|
}
|
|
1673
|
-
]
|
|
2279
|
+
],
|
|
2280
|
+
"description": "The filter field."
|
|
1674
2281
|
},
|
|
1675
2282
|
"operator": {
|
|
1676
2283
|
"type": "string",
|
|
2284
|
+
"description": "The operator used to compare the field's values with the given values.",
|
|
1677
2285
|
"enum": [
|
|
1678
2286
|
"is",
|
|
1679
2287
|
"one_of",
|
|
@@ -1683,12 +2291,15 @@
|
|
|
1683
2291
|
"greater",
|
|
1684
2292
|
"not_in",
|
|
1685
2293
|
"neq"
|
|
1686
|
-
]
|
|
2294
|
+
],
|
|
2295
|
+
"example": "is"
|
|
1687
2296
|
},
|
|
1688
2297
|
"values": {
|
|
1689
2298
|
"type": "array",
|
|
2299
|
+
"description": "The filter values.",
|
|
1690
2300
|
"items": {
|
|
1691
|
-
"type": "string"
|
|
2301
|
+
"type": "string",
|
|
2302
|
+
"example": "myId"
|
|
1692
2303
|
}
|
|
1693
2304
|
}
|
|
1694
2305
|
},
|
|
@@ -1700,6 +2311,26 @@
|
|
|
1700
2311
|
"FilteredQuery": {
|
|
1701
2312
|
"type": "object",
|
|
1702
2313
|
"additionalProperties": false,
|
|
2314
|
+
"description": "Allows to filter the result of a possibly complex query using a possibly complex filter.",
|
|
2315
|
+
"example": {
|
|
2316
|
+
"query": {
|
|
2317
|
+
"textQuery": {
|
|
2318
|
+
"fields": [
|
|
2319
|
+
"couponId"
|
|
2320
|
+
],
|
|
2321
|
+
"searchPhrase": "disabled"
|
|
2322
|
+
}
|
|
2323
|
+
},
|
|
2324
|
+
"filter": {
|
|
2325
|
+
"termFilter": {
|
|
2326
|
+
"field": "enabled",
|
|
2327
|
+
"operator": "is",
|
|
2328
|
+
"values": [
|
|
2329
|
+
false
|
|
2330
|
+
]
|
|
2331
|
+
}
|
|
2332
|
+
}
|
|
2333
|
+
},
|
|
1703
2334
|
"properties": {
|
|
1704
2335
|
"filter": {
|
|
1705
2336
|
"$ref": "#/components/schemas/Filter"
|
|
@@ -1714,14 +2345,62 @@
|
|
|
1714
2345
|
]
|
|
1715
2346
|
},
|
|
1716
2347
|
"MatchAllQuery": {
|
|
1717
|
-
"type": "object"
|
|
2348
|
+
"type": "object",
|
|
2349
|
+
"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."
|
|
1718
2350
|
},
|
|
1719
2351
|
"NestedQuery": {
|
|
1720
2352
|
"type": "object",
|
|
1721
2353
|
"additionalProperties": false,
|
|
2354
|
+
"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",
|
|
2355
|
+
"example": {
|
|
2356
|
+
"path": "order.shippingAddresses",
|
|
2357
|
+
"query": {
|
|
2358
|
+
"boolQuery": {
|
|
2359
|
+
"must": [
|
|
2360
|
+
{
|
|
2361
|
+
"boolQuery": {
|
|
2362
|
+
"must": [
|
|
2363
|
+
{
|
|
2364
|
+
"termQuery": {
|
|
2365
|
+
"fields": [
|
|
2366
|
+
"order.shippingAddresses.firstName"
|
|
2367
|
+
],
|
|
2368
|
+
"operator": "is",
|
|
2369
|
+
"values": [
|
|
2370
|
+
"John"
|
|
2371
|
+
]
|
|
2372
|
+
}
|
|
2373
|
+
}
|
|
2374
|
+
]
|
|
2375
|
+
}
|
|
2376
|
+
},
|
|
2377
|
+
{
|
|
2378
|
+
"boolQuery": {
|
|
2379
|
+
"must": [
|
|
2380
|
+
{
|
|
2381
|
+
"termQuery": {
|
|
2382
|
+
"fields": [
|
|
2383
|
+
"order.shippingAddresses.lastName"
|
|
2384
|
+
],
|
|
2385
|
+
"operator": "is",
|
|
2386
|
+
"values": [
|
|
2387
|
+
"Doe"
|
|
2388
|
+
]
|
|
2389
|
+
}
|
|
2390
|
+
}
|
|
2391
|
+
]
|
|
2392
|
+
}
|
|
2393
|
+
}
|
|
2394
|
+
]
|
|
2395
|
+
}
|
|
2396
|
+
},
|
|
2397
|
+
"scoreMode": "avg"
|
|
2398
|
+
},
|
|
1722
2399
|
"properties": {
|
|
1723
2400
|
"path": {
|
|
1724
2401
|
"type": "string",
|
|
2402
|
+
"description": "The path to the nested document.",
|
|
2403
|
+
"example": "order.shippingAddresses",
|
|
1725
2404
|
"maxLength": 2048
|
|
1726
2405
|
},
|
|
1727
2406
|
"query": {
|
|
@@ -1729,12 +2408,14 @@
|
|
|
1729
2408
|
},
|
|
1730
2409
|
"scoreMode": {
|
|
1731
2410
|
"type": "string",
|
|
2411
|
+
"description": "Indicates how scores for matching child objects affect the root parent document’s relevance score.",
|
|
1732
2412
|
"enum": [
|
|
1733
2413
|
"avg",
|
|
1734
2414
|
"total",
|
|
1735
2415
|
"max",
|
|
1736
2416
|
"none"
|
|
1737
|
-
]
|
|
2417
|
+
],
|
|
2418
|
+
"example": "avg"
|
|
1738
2419
|
}
|
|
1739
2420
|
},
|
|
1740
2421
|
"required": [
|
|
@@ -1744,9 +2425,11 @@
|
|
|
1744
2425
|
},
|
|
1745
2426
|
"TermQuery": {
|
|
1746
2427
|
"type": "object",
|
|
2428
|
+
"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.",
|
|
1747
2429
|
"properties": {
|
|
1748
2430
|
"fields": {
|
|
1749
2431
|
"type": "array",
|
|
2432
|
+
"description": "The document fields that the values are matched against, combined with the operator.",
|
|
1750
2433
|
"items": {
|
|
1751
2434
|
"$ref": "#/components/schemas/Field"
|
|
1752
2435
|
},
|
|
@@ -1754,6 +2437,7 @@
|
|
|
1754
2437
|
},
|
|
1755
2438
|
"operator": {
|
|
1756
2439
|
"type": "string",
|
|
2440
|
+
"description": "Returns the operator to use for the term query.",
|
|
1757
2441
|
"enum": [
|
|
1758
2442
|
"is",
|
|
1759
2443
|
"one_of",
|
|
@@ -1763,23 +2447,30 @@
|
|
|
1763
2447
|
"greater",
|
|
1764
2448
|
"not_in",
|
|
1765
2449
|
"neq"
|
|
1766
|
-
]
|
|
2450
|
+
],
|
|
2451
|
+
"example": "is"
|
|
1767
2452
|
},
|
|
1768
2453
|
"values": {
|
|
1769
2454
|
"type": "array",
|
|
2455
|
+
"description": "The values that the fields are compared against, combined with the operator.",
|
|
1770
2456
|
"items": {
|
|
2457
|
+
"example": "myCouponId",
|
|
1771
2458
|
"oneOf": [
|
|
1772
2459
|
{
|
|
1773
|
-
"type": "string"
|
|
2460
|
+
"type": "string",
|
|
2461
|
+
"example": "myCouponId"
|
|
1774
2462
|
},
|
|
1775
2463
|
{
|
|
1776
|
-
"type": "number"
|
|
2464
|
+
"type": "number",
|
|
2465
|
+
"example": 1
|
|
1777
2466
|
},
|
|
1778
2467
|
{
|
|
1779
|
-
"type": "boolean"
|
|
2468
|
+
"type": "boolean",
|
|
2469
|
+
"example": true
|
|
1780
2470
|
},
|
|
1781
2471
|
{
|
|
1782
|
-
"type": "integer"
|
|
2472
|
+
"type": "integer",
|
|
2473
|
+
"example": 1
|
|
1783
2474
|
}
|
|
1784
2475
|
]
|
|
1785
2476
|
}
|
|
@@ -1793,16 +2484,26 @@
|
|
|
1793
2484
|
"TextQuery": {
|
|
1794
2485
|
"type": "object",
|
|
1795
2486
|
"additionalProperties": false,
|
|
2487
|
+
"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.",
|
|
2488
|
+
"example": {
|
|
2489
|
+
"fields": [
|
|
2490
|
+
"couponId"
|
|
2491
|
+
],
|
|
2492
|
+
"searchPhrase": "limit"
|
|
2493
|
+
},
|
|
1796
2494
|
"properties": {
|
|
1797
2495
|
"fields": {
|
|
1798
2496
|
"type": "array",
|
|
2497
|
+
"description": "The document fields that the search phrase matches against.",
|
|
1799
2498
|
"items": {
|
|
1800
2499
|
"$ref": "#/components/schemas/Field"
|
|
1801
2500
|
},
|
|
1802
2501
|
"minItems": 1
|
|
1803
2502
|
},
|
|
1804
2503
|
"searchPhrase": {
|
|
1805
|
-
"type": "string"
|
|
2504
|
+
"type": "string",
|
|
2505
|
+
"description": "A search phrase, which can include multiple terms separated by spaces.",
|
|
2506
|
+
"example": "campaign summer"
|
|
1806
2507
|
}
|
|
1807
2508
|
},
|
|
1808
2509
|
"required": [
|
|
@@ -1810,28 +2511,30 @@
|
|
|
1810
2511
|
"searchPhrase"
|
|
1811
2512
|
]
|
|
1812
2513
|
},
|
|
1813
|
-
"String256": {
|
|
1814
|
-
"type": "string",
|
|
1815
|
-
"maxLength": 256
|
|
1816
|
-
},
|
|
1817
2514
|
"Sort": {
|
|
1818
2515
|
"type": "object",
|
|
1819
2516
|
"additionalProperties": false,
|
|
2517
|
+
"description": "Document representing a sort request. Each API has a different default sort configuration that can be modified in the request.",
|
|
2518
|
+
"example": {
|
|
2519
|
+
"field": "couponId",
|
|
2520
|
+
"sortOrder": "desc"
|
|
2521
|
+
},
|
|
1820
2522
|
"properties": {
|
|
1821
2523
|
"field": {
|
|
1822
|
-
"
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
]
|
|
2524
|
+
"type": "string",
|
|
2525
|
+
"description": "The name of the field to sort on.",
|
|
2526
|
+
"example": "couponId",
|
|
2527
|
+
"maxLength": 256
|
|
1827
2528
|
},
|
|
1828
2529
|
"sortOrder": {
|
|
1829
2530
|
"type": "string",
|
|
1830
2531
|
"default": "asc",
|
|
2532
|
+
"description": "The sort order to be applied when sorting. When omitted, the default sort order (asc) is used.",
|
|
1831
2533
|
"enum": [
|
|
1832
2534
|
"asc",
|
|
1833
2535
|
"desc"
|
|
1834
|
-
]
|
|
2536
|
+
],
|
|
2537
|
+
"example": "asc"
|
|
1835
2538
|
}
|
|
1836
2539
|
},
|
|
1837
2540
|
"required": [
|
|
@@ -1842,14 +2545,19 @@
|
|
|
1842
2545
|
"type": "integer",
|
|
1843
2546
|
"format": "int32",
|
|
1844
2547
|
"default": 0,
|
|
2548
|
+
"description": "The zero-based index of the first hit/data to include in the result.",
|
|
2549
|
+
"example": 0,
|
|
1845
2550
|
"minimum": 0
|
|
1846
2551
|
},
|
|
1847
2552
|
"SearchRequest": {
|
|
1848
2553
|
"type": "object",
|
|
2554
|
+
"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.",
|
|
1849
2555
|
"properties": {
|
|
1850
2556
|
"limit": {
|
|
1851
2557
|
"type": "integer",
|
|
1852
2558
|
"format": "int32",
|
|
2559
|
+
"description": "Maximum records to retrieve per request, not to exceed 200.",
|
|
2560
|
+
"example": 10,
|
|
1853
2561
|
"maximum": 200,
|
|
1854
2562
|
"minimum": 1
|
|
1855
2563
|
},
|
|
@@ -1858,6 +2566,7 @@
|
|
|
1858
2566
|
},
|
|
1859
2567
|
"sorts": {
|
|
1860
2568
|
"type": "array",
|
|
2569
|
+
"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.",
|
|
1861
2570
|
"items": {
|
|
1862
2571
|
"$ref": "#/components/schemas/Sort"
|
|
1863
2572
|
}
|
|
@@ -1874,14 +2583,19 @@
|
|
|
1874
2583
|
"type": "integer",
|
|
1875
2584
|
"format": "int32",
|
|
1876
2585
|
"default": 0,
|
|
2586
|
+
"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.",
|
|
2587
|
+
"example": 10,
|
|
1877
2588
|
"minimum": 0
|
|
1878
2589
|
},
|
|
1879
2590
|
"ResultBase": {
|
|
1880
2591
|
"type": "object",
|
|
2592
|
+
"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.",
|
|
1881
2593
|
"properties": {
|
|
1882
2594
|
"limit": {
|
|
1883
2595
|
"type": "integer",
|
|
1884
|
-
"format": "int32"
|
|
2596
|
+
"format": "int32",
|
|
2597
|
+
"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.",
|
|
2598
|
+
"example": 10
|
|
1885
2599
|
},
|
|
1886
2600
|
"total": {
|
|
1887
2601
|
"$ref": "#/components/schemas/Total"
|
|
@@ -1898,6 +2612,7 @@
|
|
|
1898
2612
|
"$ref": "#/components/schemas/ResultBase"
|
|
1899
2613
|
}
|
|
1900
2614
|
],
|
|
2615
|
+
"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`.",
|
|
1901
2616
|
"properties": {
|
|
1902
2617
|
"offset": {
|
|
1903
2618
|
"$ref": "#/components/schemas/Offset"
|
|
@@ -1916,18 +2631,67 @@
|
|
|
1916
2631
|
"$ref": "#/components/schemas/PaginatedResultBase"
|
|
1917
2632
|
}
|
|
1918
2633
|
],
|
|
2634
|
+
"description": "Document representing a generic search result. Each search resource should extend this to define what is returned in the `hits`.",
|
|
2635
|
+
"example": {
|
|
2636
|
+
"limit": 1,
|
|
2637
|
+
"hits": [
|
|
2638
|
+
{
|
|
2639
|
+
"couponId": "coupon1",
|
|
2640
|
+
"creationDate": "2019-10-20T12:00:00Z",
|
|
2641
|
+
"description": "This coupon is used to give 10% off stuff.",
|
|
2642
|
+
"enabled": false,
|
|
2643
|
+
"exportedCodeCount": 0,
|
|
2644
|
+
"lastModified": "2019-10-30T04:23:59Z",
|
|
2645
|
+
"redemptionCount": 3,
|
|
2646
|
+
"redemptionLimits": {
|
|
2647
|
+
"limitPerCode": 1,
|
|
2648
|
+
"limitPerCustomer": 1,
|
|
2649
|
+
"limitPerTimeFrame": {
|
|
2650
|
+
"limit": 2,
|
|
2651
|
+
"redemptionTimeFrame": 24
|
|
2652
|
+
}
|
|
2653
|
+
},
|
|
2654
|
+
"singleCode": "MyCode",
|
|
2655
|
+
"systemCodesConfig": {
|
|
2656
|
+
"codePrefix": "SG",
|
|
2657
|
+
"numberOfCodes": 500000
|
|
2658
|
+
},
|
|
2659
|
+
"totalCodesCount": 50,
|
|
2660
|
+
"type": "single_code"
|
|
2661
|
+
}
|
|
2662
|
+
],
|
|
2663
|
+
"query": {
|
|
2664
|
+
"textQuery": {
|
|
2665
|
+
"fields": [
|
|
2666
|
+
"id",
|
|
2667
|
+
"description"
|
|
2668
|
+
],
|
|
2669
|
+
"searchPhrase": "stuff"
|
|
2670
|
+
}
|
|
2671
|
+
},
|
|
2672
|
+
"sorts": [
|
|
2673
|
+
{
|
|
2674
|
+
"field": "couponId",
|
|
2675
|
+
"sortOrder": "desc"
|
|
2676
|
+
}
|
|
2677
|
+
],
|
|
2678
|
+
"offset": 2,
|
|
2679
|
+
"total": 8
|
|
2680
|
+
},
|
|
1919
2681
|
"properties": {
|
|
1920
2682
|
"query": {
|
|
1921
2683
|
"$ref": "#/components/schemas/Query"
|
|
1922
2684
|
},
|
|
1923
2685
|
"sorts": {
|
|
1924
2686
|
"type": "array",
|
|
2687
|
+
"description": "The sorting that was applied to the result.",
|
|
1925
2688
|
"items": {
|
|
1926
2689
|
"$ref": "#/components/schemas/Sort"
|
|
1927
2690
|
}
|
|
1928
2691
|
},
|
|
1929
2692
|
"hits": {
|
|
1930
2693
|
"type": "array",
|
|
2694
|
+
"description": "The sorted array of search hits. Can be empty.",
|
|
1931
2695
|
"items": {
|
|
1932
2696
|
"type": "object"
|
|
1933
2697
|
}
|
|
@@ -1939,19 +2703,28 @@
|
|
|
1939
2703
|
},
|
|
1940
2704
|
"Credentials": {
|
|
1941
2705
|
"type": "object",
|
|
2706
|
+
"description": "Document representing the credentials of a customer.",
|
|
1942
2707
|
"properties": {
|
|
1943
2708
|
"enabled": {
|
|
1944
|
-
"type": "boolean"
|
|
2709
|
+
"type": "boolean",
|
|
2710
|
+
"description": "A flag indicating whether the customer is enabled and can log in.",
|
|
2711
|
+
"example": true
|
|
1945
2712
|
},
|
|
1946
2713
|
"locked": {
|
|
1947
|
-
"type": "boolean"
|
|
2714
|
+
"type": "boolean",
|
|
2715
|
+
"description": "A flag indicating whether the customer account is locked.",
|
|
2716
|
+
"example": false
|
|
1948
2717
|
},
|
|
1949
2718
|
"login": {
|
|
1950
2719
|
"type": "string",
|
|
2720
|
+
"description": "The login of the customer.",
|
|
2721
|
+
"example": "wleung",
|
|
1951
2722
|
"maxLength": 256
|
|
1952
2723
|
},
|
|
1953
2724
|
"passwordQuestion": {
|
|
1954
2725
|
"type": "string",
|
|
2726
|
+
"description": "The password question.",
|
|
2727
|
+
"example": "Pet Name?",
|
|
1955
2728
|
"maxLength": 256
|
|
1956
2729
|
}
|
|
1957
2730
|
},
|
|
@@ -1961,93 +2734,142 @@
|
|
|
1961
2734
|
},
|
|
1962
2735
|
"CustomerAddress": {
|
|
1963
2736
|
"type": "object",
|
|
1964
|
-
"additionalProperties": {
|
|
2737
|
+
"additionalProperties": {
|
|
2738
|
+
"description": "This type supports additional properties passed along with the defined properties of this API.\nTo indicate that the properties were defined and expected to be handled as additional properties, they are expected to be prefixed with a `c_`.\nThe type will reject any property that does not fit this pattern, only allowing additional properties beginning with the known prefix.",
|
|
2739
|
+
"example": "c_trackingId",
|
|
2740
|
+
"title": "Additional Property Support"
|
|
2741
|
+
},
|
|
2742
|
+
"description": "Any address that is associated with a customer (billing, shipping, mailing, and so on).",
|
|
1965
2743
|
"properties": {
|
|
1966
2744
|
"address1": {
|
|
1967
2745
|
"type": "string",
|
|
2746
|
+
"description": "The customer's first address.",
|
|
2747
|
+
"example": "123 Trailblazer Ave.",
|
|
1968
2748
|
"maxLength": 256
|
|
1969
2749
|
},
|
|
1970
2750
|
"address2": {
|
|
1971
2751
|
"type": "string",
|
|
2752
|
+
"description": "The customer's second address value.",
|
|
2753
|
+
"example": "",
|
|
1972
2754
|
"maxLength": 256
|
|
1973
2755
|
},
|
|
1974
2756
|
"addressId": {
|
|
1975
2757
|
"type": "string",
|
|
2758
|
+
"description": "The customer address ID.",
|
|
2759
|
+
"example": "Home",
|
|
1976
2760
|
"maxLength": 256
|
|
1977
2761
|
},
|
|
1978
2762
|
"city": {
|
|
1979
2763
|
"type": "string",
|
|
2764
|
+
"description": "The customer's city.",
|
|
2765
|
+
"example": "San Francisco",
|
|
1980
2766
|
"maxLength": 256
|
|
1981
2767
|
},
|
|
1982
2768
|
"companyName": {
|
|
1983
2769
|
"type": "string",
|
|
2770
|
+
"description": "The customer's company name.",
|
|
2771
|
+
"example": "Ursa Major Solar",
|
|
1984
2772
|
"maxLength": 256
|
|
1985
2773
|
},
|
|
1986
2774
|
"countryCode": {
|
|
1987
2775
|
"type": "string",
|
|
2776
|
+
"description": "The customer's two-character country code per ISO 3166-1 alpha-2.",
|
|
2777
|
+
"example": "US",
|
|
1988
2778
|
"maxLength": 2
|
|
1989
2779
|
},
|
|
1990
2780
|
"creationDate": {
|
|
1991
2781
|
"type": "string",
|
|
1992
|
-
"format": "date-time"
|
|
2782
|
+
"format": "date-time",
|
|
2783
|
+
"description": "Returns the value of attribute 'creationDate'.",
|
|
2784
|
+
"example": "9999-12-31T00:00:00Z"
|
|
1993
2785
|
},
|
|
1994
2786
|
"etag": {
|
|
1995
|
-
"type": "string"
|
|
2787
|
+
"type": "string",
|
|
2788
|
+
"description": "The generated eTag representing the state of the customer address.",
|
|
2789
|
+
"example": "0267dee58b0ddd9a13f27309470b84f5b2b7e00fa53dfcf400c1f7a5661f319d"
|
|
1996
2790
|
},
|
|
1997
2791
|
"firstName": {
|
|
1998
2792
|
"type": "string",
|
|
2793
|
+
"description": "The customer's first name.",
|
|
2794
|
+
"example": "Wei",
|
|
1999
2795
|
"maxLength": 256
|
|
2000
2796
|
},
|
|
2001
2797
|
"fullName": {
|
|
2002
2798
|
"type": "string",
|
|
2799
|
+
"description": "The concatenation of the customer's first, middle, last names, and suffix.",
|
|
2800
|
+
"example": "Wei Leung",
|
|
2003
2801
|
"maxLength": 1027
|
|
2004
2802
|
},
|
|
2005
2803
|
"jobTitle": {
|
|
2006
2804
|
"type": "string",
|
|
2805
|
+
"description": "The customer's job title.",
|
|
2806
|
+
"example": "",
|
|
2007
2807
|
"maxLength": 256
|
|
2008
2808
|
},
|
|
2009
2809
|
"lastModified": {
|
|
2010
2810
|
"type": "string",
|
|
2011
|
-
"format": "date-time"
|
|
2811
|
+
"format": "date-time",
|
|
2812
|
+
"description": "Returns the value of attribute 'lastModified'.",
|
|
2813
|
+
"example": "9999-12-31T00:00:00Z"
|
|
2012
2814
|
},
|
|
2013
2815
|
"lastName": {
|
|
2014
2816
|
"type": "string",
|
|
2817
|
+
"description": "The customer's last name.",
|
|
2818
|
+
"example": "Leung",
|
|
2015
2819
|
"maxLength": 256
|
|
2016
2820
|
},
|
|
2017
2821
|
"phone": {
|
|
2018
2822
|
"type": "string",
|
|
2823
|
+
"description": "The customer's phone number.",
|
|
2824
|
+
"example": "415-555-1212",
|
|
2019
2825
|
"maxLength": 32
|
|
2020
2826
|
},
|
|
2021
2827
|
"postBox": {
|
|
2022
2828
|
"type": "string",
|
|
2829
|
+
"description": "The customer's post box.",
|
|
2830
|
+
"example": "",
|
|
2023
2831
|
"maxLength": 256
|
|
2024
2832
|
},
|
|
2025
2833
|
"postalCode": {
|
|
2026
2834
|
"type": "string",
|
|
2835
|
+
"description": "The customer's postal code.",
|
|
2836
|
+
"example": "94105",
|
|
2027
2837
|
"maxLength": 256
|
|
2028
2838
|
},
|
|
2029
2839
|
"salutation": {
|
|
2030
2840
|
"type": "string",
|
|
2841
|
+
"description": "The customer's salutation.",
|
|
2842
|
+
"example": "Ms.",
|
|
2031
2843
|
"maxLength": 256
|
|
2032
2844
|
},
|
|
2033
2845
|
"secondName": {
|
|
2034
2846
|
"type": "string",
|
|
2847
|
+
"description": "The customer's second name.",
|
|
2848
|
+
"example": "Leung",
|
|
2035
2849
|
"maxLength": 256
|
|
2036
2850
|
},
|
|
2037
2851
|
"stateCode": {
|
|
2038
2852
|
"type": "string",
|
|
2853
|
+
"description": "The customer's state.",
|
|
2854
|
+
"example": "CA",
|
|
2039
2855
|
"maxLength": 256
|
|
2040
2856
|
},
|
|
2041
2857
|
"suffix": {
|
|
2042
2858
|
"type": "string",
|
|
2859
|
+
"description": "The customer's suffix.",
|
|
2860
|
+
"example": "",
|
|
2043
2861
|
"maxLength": 256
|
|
2044
2862
|
},
|
|
2045
2863
|
"suite": {
|
|
2046
2864
|
"type": "string",
|
|
2865
|
+
"description": "The customer's suite.",
|
|
2866
|
+
"example": "",
|
|
2047
2867
|
"maxLength": 32
|
|
2048
2868
|
},
|
|
2049
2869
|
"title": {
|
|
2050
2870
|
"type": "string",
|
|
2871
|
+
"description": "The customer's title.",
|
|
2872
|
+
"example": "",
|
|
2051
2873
|
"maxLength": 256
|
|
2052
2874
|
}
|
|
2053
2875
|
},
|
|
@@ -2059,108 +2881,161 @@
|
|
|
2059
2881
|
},
|
|
2060
2882
|
"Customer": {
|
|
2061
2883
|
"type": "object",
|
|
2062
|
-
"additionalProperties": {
|
|
2884
|
+
"additionalProperties": {
|
|
2885
|
+
"description": "This type supports additional properties passed along with the defined properties of this API.\nTo indicate that the properties were defined and expected to be handled as additional properties, they are expected to be prefixed with a `c_`.\nThe type will reject any property that does not fit this pattern, only allowing additional properties beginning with the known prefix.",
|
|
2886
|
+
"example": "c_trackingId",
|
|
2887
|
+
"title": "Additional Property Support"
|
|
2888
|
+
},
|
|
2889
|
+
"description": "Person or entity who shops on Commerce Cloud storefronts by creating a shopper account in Commerce Cloud.",
|
|
2063
2890
|
"properties": {
|
|
2064
2891
|
"birthday": {
|
|
2065
2892
|
"type": "string",
|
|
2066
|
-
"format": "date"
|
|
2893
|
+
"format": "date",
|
|
2894
|
+
"description": "The customer's birthday.",
|
|
2895
|
+
"example": "1999-12-31"
|
|
2067
2896
|
},
|
|
2068
2897
|
"companyName": {
|
|
2069
2898
|
"type": "string",
|
|
2899
|
+
"description": "The customer's company name.",
|
|
2900
|
+
"example": "Ursa Major Solar",
|
|
2070
2901
|
"maxLength": 256
|
|
2071
2902
|
},
|
|
2072
2903
|
"creationDate": {
|
|
2073
2904
|
"type": "string",
|
|
2074
|
-
"format": "date-time"
|
|
2905
|
+
"format": "date-time",
|
|
2906
|
+
"description": "Returns the value of attribute 'creationDate'.",
|
|
2907
|
+
"example": "9999-12-31T00:00:00Z"
|
|
2075
2908
|
},
|
|
2076
2909
|
"credentials": {
|
|
2077
2910
|
"$ref": "#/components/schemas/Credentials"
|
|
2078
2911
|
},
|
|
2079
2912
|
"customerId": {
|
|
2080
2913
|
"type": "string",
|
|
2914
|
+
"description": "The customer's ID. Both registered and guest customers have a\n customer ID.",
|
|
2915
|
+
"example": "wleung",
|
|
2081
2916
|
"maxLength": 28
|
|
2082
2917
|
},
|
|
2083
2918
|
"customerNo": {
|
|
2084
2919
|
"type": "string",
|
|
2920
|
+
"description": "The customer's number.",
|
|
2921
|
+
"example": "D100201",
|
|
2085
2922
|
"maxLength": 100
|
|
2086
2923
|
},
|
|
2087
2924
|
"email": {
|
|
2088
2925
|
"type": "string",
|
|
2926
|
+
"description": "The customer's email address.",
|
|
2927
|
+
"example": "wleung@example.com",
|
|
2089
2928
|
"maxLength": 256
|
|
2090
2929
|
},
|
|
2091
2930
|
"fax": {
|
|
2092
2931
|
"type": "string",
|
|
2932
|
+
"description": "The customer's fax number.\n The length is restricted to 32 characters.",
|
|
2933
|
+
"example": "415-555-1213",
|
|
2093
2934
|
"maxLength": 32
|
|
2094
2935
|
},
|
|
2095
2936
|
"firstName": {
|
|
2096
2937
|
"type": "string",
|
|
2938
|
+
"description": "The customer's first name.",
|
|
2939
|
+
"example": "Wei",
|
|
2097
2940
|
"maxLength": 256
|
|
2098
2941
|
},
|
|
2099
2942
|
"gender": {
|
|
2100
2943
|
"type": "integer",
|
|
2101
|
-
"format": "int32"
|
|
2944
|
+
"format": "int32",
|
|
2945
|
+
"description": "The customer's gender.",
|
|
2946
|
+
"example": 2
|
|
2102
2947
|
},
|
|
2103
2948
|
"jobTitle": {
|
|
2104
2949
|
"type": "string",
|
|
2950
|
+
"description": "The customer's job title.",
|
|
2951
|
+
"example": "",
|
|
2105
2952
|
"maxLength": 256
|
|
2106
2953
|
},
|
|
2107
2954
|
"lastLoginTime": {
|
|
2108
2955
|
"type": "string",
|
|
2109
|
-
"format": "date-time"
|
|
2956
|
+
"format": "date-time",
|
|
2957
|
+
"description": "The last login time of the customer.",
|
|
2958
|
+
"example": "9999-12-31T00:00:00Z"
|
|
2110
2959
|
},
|
|
2111
2960
|
"lastModified": {
|
|
2112
2961
|
"type": "string",
|
|
2113
|
-
"format": "date-time"
|
|
2962
|
+
"format": "date-time",
|
|
2963
|
+
"description": "Returns the value of attribute 'lastModified'.",
|
|
2964
|
+
"example": "9999-12-31T00:00:00Z"
|
|
2114
2965
|
},
|
|
2115
2966
|
"lastName": {
|
|
2116
2967
|
"type": "string",
|
|
2968
|
+
"description": "The customer's last name.",
|
|
2969
|
+
"example": "Leung",
|
|
2117
2970
|
"maxLength": 256
|
|
2118
2971
|
},
|
|
2119
2972
|
"lastVisitTime": {
|
|
2120
2973
|
"type": "string",
|
|
2121
|
-
"format": "date-time"
|
|
2974
|
+
"format": "date-time",
|
|
2975
|
+
"description": "The last visit time of the customer.",
|
|
2976
|
+
"example": "9999-12-31T00:00:00Z"
|
|
2122
2977
|
},
|
|
2123
2978
|
"phoneBusiness": {
|
|
2124
2979
|
"type": "string",
|
|
2980
|
+
"description": "The customer's business phone number.",
|
|
2981
|
+
"example": "333-333-3333",
|
|
2125
2982
|
"maxLength": 32
|
|
2126
2983
|
},
|
|
2127
2984
|
"phoneHome": {
|
|
2128
2985
|
"type": "string",
|
|
2986
|
+
"description": "The customer's home phone number.",
|
|
2987
|
+
"example": "415-555-1211",
|
|
2129
2988
|
"maxLength": 32
|
|
2130
2989
|
},
|
|
2131
2990
|
"phoneMobile": {
|
|
2132
2991
|
"type": "string",
|
|
2992
|
+
"description": "The customer's mobile phone number.",
|
|
2993
|
+
"example": "415-555-1212",
|
|
2133
2994
|
"maxLength": 32
|
|
2134
2995
|
},
|
|
2135
2996
|
"preferredLocale": {
|
|
2136
2997
|
"type": "string",
|
|
2998
|
+
"description": "The customer's preferred locale.",
|
|
2999
|
+
"example": "en_US",
|
|
2137
3000
|
"maxLength": 5
|
|
2138
3001
|
},
|
|
2139
3002
|
"previousLoginTime": {
|
|
2140
3003
|
"type": "string",
|
|
2141
|
-
"format": "date-time"
|
|
3004
|
+
"format": "date-time",
|
|
3005
|
+
"description": "The time when the customer previously logged in.",
|
|
3006
|
+
"example": "9999-12-31T00:00:00Z"
|
|
2142
3007
|
},
|
|
2143
3008
|
"previousVisitTime": {
|
|
2144
3009
|
"type": "string",
|
|
2145
|
-
"format": "date-time"
|
|
3010
|
+
"format": "date-time",
|
|
3011
|
+
"description": "The time when the customer previously visited the store.",
|
|
3012
|
+
"example": "9999-12-31T00:00:00Z"
|
|
2146
3013
|
},
|
|
2147
3014
|
"primaryAddress": {
|
|
2148
3015
|
"$ref": "#/components/schemas/CustomerAddress"
|
|
2149
3016
|
},
|
|
2150
3017
|
"salutation": {
|
|
2151
3018
|
"type": "string",
|
|
3019
|
+
"description": "The customer's salutation.",
|
|
3020
|
+
"example": "Ms.",
|
|
2152
3021
|
"maxLength": 256
|
|
2153
3022
|
},
|
|
2154
3023
|
"secondName": {
|
|
2155
3024
|
"type": "string",
|
|
3025
|
+
"description": "The customer's second name.",
|
|
3026
|
+
"example": "Leung",
|
|
2156
3027
|
"maxLength": 256
|
|
2157
3028
|
},
|
|
2158
3029
|
"suffix": {
|
|
2159
3030
|
"type": "string",
|
|
3031
|
+
"description": "The customer's suffix (for example, \"Jr.\" or \"Sr.\").",
|
|
3032
|
+
"example": "",
|
|
2160
3033
|
"maxLength": 256
|
|
2161
3034
|
},
|
|
2162
3035
|
"title": {
|
|
2163
3036
|
"type": "string",
|
|
3037
|
+
"description": "The customer's title (for example, \"Mrs\" or \"Mr\").",
|
|
3038
|
+
"example": "",
|
|
2164
3039
|
"maxLength": 256
|
|
2165
3040
|
}
|
|
2166
3041
|
},
|
|
@@ -2171,17 +3046,21 @@
|
|
|
2171
3046
|
},
|
|
2172
3047
|
"CustomerSearchHit": {
|
|
2173
3048
|
"type": "object",
|
|
3049
|
+
"description": "Document representing a customer search hit.",
|
|
2174
3050
|
"properties": {
|
|
2175
3051
|
"data": {
|
|
2176
3052
|
"allOf": [
|
|
2177
3053
|
{
|
|
2178
3054
|
"$ref": "#/components/schemas/Customer"
|
|
2179
3055
|
}
|
|
2180
|
-
]
|
|
3056
|
+
],
|
|
3057
|
+
"description": "List of found customers."
|
|
2181
3058
|
},
|
|
2182
3059
|
"relevance": {
|
|
2183
3060
|
"type": "number",
|
|
2184
|
-
"format": "double"
|
|
3061
|
+
"format": "double",
|
|
3062
|
+
"description": "The hit's relevance score.",
|
|
3063
|
+
"example": 1
|
|
2185
3064
|
}
|
|
2186
3065
|
},
|
|
2187
3066
|
"required": [
|
|
@@ -2196,9 +3075,63 @@
|
|
|
2196
3075
|
"$ref": "#/components/schemas/PaginatedSearchResult"
|
|
2197
3076
|
}
|
|
2198
3077
|
],
|
|
3078
|
+
"description": "Document representing a customer search result.",
|
|
3079
|
+
"example": {
|
|
3080
|
+
"value": {
|
|
3081
|
+
"hits": [
|
|
3082
|
+
{
|
|
3083
|
+
"data": {
|
|
3084
|
+
"birthday": "1999-12-31",
|
|
3085
|
+
"companyName": "Salesforce",
|
|
3086
|
+
"creationDate": "2023-07-21T07:29:39.505Z",
|
|
3087
|
+
"credentials": {
|
|
3088
|
+
"enabled": true,
|
|
3089
|
+
"locked": false,
|
|
3090
|
+
"login": "af4ab358-3187-4ec5-82a6-918e0fe8a21f"
|
|
3091
|
+
},
|
|
3092
|
+
"customerId": "absAzIVSkman3GPpSYluYBbLrB",
|
|
3093
|
+
"customerNo": "00000012",
|
|
3094
|
+
"email": "w.leung@gmail.com",
|
|
3095
|
+
"fax": "123-123-1234",
|
|
3096
|
+
"firstName": "Wei",
|
|
3097
|
+
"gender": 1,
|
|
3098
|
+
"lastModified": "2023-07-21T07:29:39.506Z",
|
|
3099
|
+
"lastName": "Leung",
|
|
3100
|
+
"phoneBusiness": "123-123-1234",
|
|
3101
|
+
"phoneHome": "123-123-1234",
|
|
3102
|
+
"phoneMobile": "123-123-1234",
|
|
3103
|
+
"preferredLocale": "en-US",
|
|
3104
|
+
"salutation": "Dr.",
|
|
3105
|
+
"secondName": "J",
|
|
3106
|
+
"suffix": "Jr.",
|
|
3107
|
+
"title": "Mr."
|
|
3108
|
+
},
|
|
3109
|
+
"relevance": 4.258296012878418
|
|
3110
|
+
}
|
|
3111
|
+
],
|
|
3112
|
+
"limit": 1,
|
|
3113
|
+
"offset": 0,
|
|
3114
|
+
"query": {
|
|
3115
|
+
"textQuery": {
|
|
3116
|
+
"fields": [
|
|
3117
|
+
"email"
|
|
3118
|
+
],
|
|
3119
|
+
"searchPhrase": "w.leung@gmail.com"
|
|
3120
|
+
}
|
|
3121
|
+
},
|
|
3122
|
+
"total": 1
|
|
3123
|
+
}
|
|
3124
|
+
},
|
|
2199
3125
|
"properties": {
|
|
2200
3126
|
"hits": {
|
|
2201
3127
|
"type": "array",
|
|
3128
|
+
"description": "The sorted array of search hits. Can be empty.",
|
|
3129
|
+
"example": [
|
|
3130
|
+
{
|
|
3131
|
+
"customerNo": "D100201",
|
|
3132
|
+
"lastName": "Leung"
|
|
3133
|
+
}
|
|
3134
|
+
],
|
|
2202
3135
|
"items": {
|
|
2203
3136
|
"$ref": "#/components/schemas/CustomerSearchHit"
|
|
2204
3137
|
}
|
|
@@ -2214,17 +3147,25 @@
|
|
|
2214
3147
|
"properties": {
|
|
2215
3148
|
"title": {
|
|
2216
3149
|
"type": "string",
|
|
3150
|
+
"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",
|
|
3151
|
+
"example": "You do not have enough credit",
|
|
2217
3152
|
"maxLength": 256
|
|
2218
3153
|
},
|
|
2219
3154
|
"type": {
|
|
2220
3155
|
"type": "string",
|
|
3156
|
+
"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",
|
|
3157
|
+
"example": "NotEnoughMoney",
|
|
2221
3158
|
"maxLength": 2048
|
|
2222
3159
|
},
|
|
2223
3160
|
"detail": {
|
|
2224
|
-
"type": "string"
|
|
3161
|
+
"type": "string",
|
|
3162
|
+
"description": "A human-readable explanation specific to this occurrence of the problem.",
|
|
3163
|
+
"example": "Your current balance is 30, but that costs 50"
|
|
2225
3164
|
},
|
|
2226
3165
|
"instance": {
|
|
2227
3166
|
"type": "string",
|
|
3167
|
+
"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",
|
|
3168
|
+
"example": "/account/12345/msgs/abc",
|
|
2228
3169
|
"maxLength": 2048
|
|
2229
3170
|
}
|
|
2230
3171
|
},
|
|
@@ -2240,9 +3181,11 @@
|
|
|
2240
3181
|
"$ref": "#/components/schemas/PaginatedResultBase"
|
|
2241
3182
|
}
|
|
2242
3183
|
],
|
|
3184
|
+
"description": "Result document containing an array of customer addresses.",
|
|
2243
3185
|
"properties": {
|
|
2244
3186
|
"data": {
|
|
2245
3187
|
"type": "array",
|
|
3188
|
+
"description": "The array of customer address documents.",
|
|
2246
3189
|
"items": {
|
|
2247
3190
|
"$ref": "#/components/schemas/CustomerAddress"
|
|
2248
3191
|
}
|
|
@@ -2251,14 +3194,19 @@
|
|
|
2251
3194
|
},
|
|
2252
3195
|
"SiteId": {
|
|
2253
3196
|
"type": "string",
|
|
3197
|
+
"description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites",
|
|
3198
|
+
"example": "RefArch",
|
|
2254
3199
|
"maxLength": 32,
|
|
2255
3200
|
"minLength": 1
|
|
2256
3201
|
},
|
|
2257
3202
|
"CustomerGroupRule": {
|
|
2258
3203
|
"type": "object",
|
|
3204
|
+
"description": "Customer Group Rule",
|
|
2259
3205
|
"properties": {
|
|
2260
3206
|
"description": {
|
|
2261
|
-
"type": "string"
|
|
3207
|
+
"type": "string",
|
|
3208
|
+
"description": "Customer Group Rule description. Describing its conditions in natural language.",
|
|
3209
|
+
"example": "Customers who spend more than $1000 in the last month"
|
|
2262
3210
|
}
|
|
2263
3211
|
},
|
|
2264
3212
|
"required": [
|
|
@@ -2267,42 +3215,61 @@
|
|
|
2267
3215
|
},
|
|
2268
3216
|
"CustomerGroup": {
|
|
2269
3217
|
"type": "object",
|
|
2270
|
-
"additionalProperties": {
|
|
3218
|
+
"additionalProperties": {
|
|
3219
|
+
"description": "This type supports additional properties passed along with the defined properties of this API.\nTo indicate that the properties were defined and expected to be handled as additional properties, they are expected to be prefixed with a `c_`.\nThe type will reject any property that does not fit this pattern, only allowing additional properties beginning with the known prefix.",
|
|
3220
|
+
"example": "c_trackingId",
|
|
3221
|
+
"title": "Additional Property Support"
|
|
3222
|
+
},
|
|
3223
|
+
"description": "Document representing a customer group.",
|
|
2271
3224
|
"properties": {
|
|
2272
3225
|
"creationDate": {
|
|
2273
3226
|
"type": "string",
|
|
2274
|
-
"format": "date-time"
|
|
3227
|
+
"format": "date-time",
|
|
3228
|
+
"description": "The date the customer group was created.",
|
|
3229
|
+
"example": "9999-12-31T00:00:00Z"
|
|
2275
3230
|
},
|
|
2276
3231
|
"description": {
|
|
2277
3232
|
"type": "string",
|
|
3233
|
+
"description": "Customer Group description.",
|
|
3234
|
+
"example": "Customers who spent more than $1000 in last month",
|
|
2278
3235
|
"maxLength": 4000
|
|
2279
3236
|
},
|
|
2280
3237
|
"id": {
|
|
2281
3238
|
"type": "string",
|
|
3239
|
+
"description": "Customer Group id.",
|
|
3240
|
+
"example": "Big Spenders",
|
|
2282
3241
|
"maxLength": 256,
|
|
2283
3242
|
"minLength": 1
|
|
2284
3243
|
},
|
|
2285
3244
|
"inDeletion": {
|
|
2286
|
-
"type": "boolean"
|
|
3245
|
+
"type": "boolean",
|
|
3246
|
+
"description": "Boolean to indicate if the customer group is marked for deletion.",
|
|
3247
|
+
"example": false
|
|
2287
3248
|
},
|
|
2288
3249
|
"lastModified": {
|
|
2289
3250
|
"type": "string",
|
|
2290
|
-
"format": "date-time"
|
|
3251
|
+
"format": "date-time",
|
|
3252
|
+
"description": "The date the customer group was last modified.",
|
|
3253
|
+
"example": "9999-12-31T00:00:00Z"
|
|
2291
3254
|
},
|
|
2292
3255
|
"memberCount": {
|
|
2293
3256
|
"type": "integer",
|
|
2294
|
-
"format": "int32"
|
|
3257
|
+
"format": "int32",
|
|
3258
|
+
"description": "Number of members in the customer group",
|
|
3259
|
+
"example": 109
|
|
2295
3260
|
},
|
|
2296
3261
|
"rule": {
|
|
2297
3262
|
"$ref": "#/components/schemas/CustomerGroupRule"
|
|
2298
3263
|
},
|
|
2299
3264
|
"type": {
|
|
2300
3265
|
"type": "string",
|
|
3266
|
+
"description": "Customer Group Type.",
|
|
2301
3267
|
"enum": [
|
|
2302
3268
|
"system",
|
|
2303
3269
|
"dynamic",
|
|
2304
3270
|
"static"
|
|
2305
|
-
]
|
|
3271
|
+
],
|
|
3272
|
+
"example": "static"
|
|
2306
3273
|
}
|
|
2307
3274
|
},
|
|
2308
3275
|
"required": [
|
|
@@ -2316,9 +3283,40 @@
|
|
|
2316
3283
|
"$ref": "#/components/schemas/PaginatedSearchResult"
|
|
2317
3284
|
}
|
|
2318
3285
|
],
|
|
3286
|
+
"description": "Document representing a customer group search result.",
|
|
3287
|
+
"example": {
|
|
3288
|
+
"value": {
|
|
3289
|
+
"limit": 1,
|
|
3290
|
+
"hits": [
|
|
3291
|
+
{
|
|
3292
|
+
"creationDate": "2020-01-09T16:50:32.000Z",
|
|
3293
|
+
"description": "Big Spenders",
|
|
3294
|
+
"id": "Big Spenders",
|
|
3295
|
+
"inDeletion": false,
|
|
3296
|
+
"lastModified": "2020-01-09T16:50:32.000Z",
|
|
3297
|
+
"memberCount": 109,
|
|
3298
|
+
"rule": {
|
|
3299
|
+
"description": "Customers who spend more than $1000 in the last month"
|
|
3300
|
+
},
|
|
3301
|
+
"type": "dynamic"
|
|
3302
|
+
}
|
|
3303
|
+
],
|
|
3304
|
+
"query": {
|
|
3305
|
+
"textQuery": {
|
|
3306
|
+
"fields": [
|
|
3307
|
+
"id"
|
|
3308
|
+
],
|
|
3309
|
+
"searchPhrase": "Big"
|
|
3310
|
+
}
|
|
3311
|
+
},
|
|
3312
|
+
"offset": 0,
|
|
3313
|
+
"total": 1
|
|
3314
|
+
}
|
|
3315
|
+
},
|
|
2319
3316
|
"properties": {
|
|
2320
3317
|
"hits": {
|
|
2321
3318
|
"type": "array",
|
|
3319
|
+
"description": "The sorted array of search hits. Can be empty.",
|
|
2322
3320
|
"items": {
|
|
2323
3321
|
"$ref": "#/components/schemas/CustomerGroup"
|
|
2324
3322
|
}
|
|
@@ -2330,6 +3328,8 @@
|
|
|
2330
3328
|
},
|
|
2331
3329
|
"Select": {
|
|
2332
3330
|
"type": "string",
|
|
3331
|
+
"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).",
|
|
3332
|
+
"example": "(name,id,variationAttributes.(**))",
|
|
2333
3333
|
"minLength": 1,
|
|
2334
3334
|
"pattern": "^[(].*[)]$"
|
|
2335
3335
|
},
|
|
@@ -2339,9 +3339,11 @@
|
|
|
2339
3339
|
"$ref": "#/components/schemas/PaginatedResultBase"
|
|
2340
3340
|
}
|
|
2341
3341
|
],
|
|
3342
|
+
"description": "Document representing an unfiltered list of customer groups.",
|
|
2342
3343
|
"properties": {
|
|
2343
3344
|
"data": {
|
|
2344
3345
|
"type": "array",
|
|
3346
|
+
"description": "The list of customer groups.",
|
|
2345
3347
|
"items": {
|
|
2346
3348
|
"$ref": "#/components/schemas/CustomerGroup"
|
|
2347
3349
|
}
|
|
@@ -2353,11 +3355,13 @@
|
|
|
2353
3355
|
},
|
|
2354
3356
|
"CustomerGroupId": {
|
|
2355
3357
|
"type": "string",
|
|
3358
|
+
"example": "preferred-customers",
|
|
2356
3359
|
"maxLength": 256,
|
|
2357
3360
|
"minLength": 1
|
|
2358
3361
|
},
|
|
2359
3362
|
"CustomerNo": {
|
|
2360
3363
|
"type": "string",
|
|
3364
|
+
"example": "00001234",
|
|
2361
3365
|
"maxLength": 100,
|
|
2362
3366
|
"minLength": 1
|
|
2363
3367
|
},
|
|
@@ -2366,23 +3370,33 @@
|
|
|
2366
3370
|
"properties": {
|
|
2367
3371
|
"customerNo": {
|
|
2368
3372
|
"type": "string",
|
|
3373
|
+
"description": "Customer number of the customer group member",
|
|
3374
|
+
"example": "00001234",
|
|
2369
3375
|
"maxLength": 100,
|
|
2370
3376
|
"minLength": 1
|
|
2371
3377
|
},
|
|
2372
3378
|
"login": {
|
|
2373
3379
|
"type": "string",
|
|
3380
|
+
"description": "Customer login",
|
|
3381
|
+
"example": "johndoe",
|
|
2374
3382
|
"maxLength": 256
|
|
2375
3383
|
},
|
|
2376
3384
|
"firstName": {
|
|
2377
3385
|
"type": "string",
|
|
3386
|
+
"description": "Customer's first name",
|
|
3387
|
+
"example": "John",
|
|
2378
3388
|
"maxLength": 256
|
|
2379
3389
|
},
|
|
2380
3390
|
"lastName": {
|
|
2381
3391
|
"type": "string",
|
|
3392
|
+
"description": "Customer's last name",
|
|
3393
|
+
"example": "Doe",
|
|
2382
3394
|
"maxLength": 256
|
|
2383
3395
|
},
|
|
2384
3396
|
"active": {
|
|
2385
|
-
"type": "boolean"
|
|
3397
|
+
"type": "boolean",
|
|
3398
|
+
"description": "Flag indicating whether the customer is active",
|
|
3399
|
+
"example": true
|
|
2386
3400
|
}
|
|
2387
3401
|
},
|
|
2388
3402
|
"required": [
|
|
@@ -2395,9 +3409,11 @@
|
|
|
2395
3409
|
"$ref": "#/components/schemas/ResultBase"
|
|
2396
3410
|
}
|
|
2397
3411
|
],
|
|
3412
|
+
"description": "Results containing a list of customer group members",
|
|
2398
3413
|
"properties": {
|
|
2399
3414
|
"data": {
|
|
2400
3415
|
"type": "array",
|
|
3416
|
+
"description": "List of customer group members.",
|
|
2401
3417
|
"items": {
|
|
2402
3418
|
"$ref": "#/components/schemas/CustomerGroupMember"
|
|
2403
3419
|
}
|
|
@@ -2412,11 +3428,13 @@
|
|
|
2412
3428
|
"customerListId": {
|
|
2413
3429
|
"name": "customerListId",
|
|
2414
3430
|
"in": "path",
|
|
3431
|
+
"description": "The customer list ID.",
|
|
2415
3432
|
"required": true,
|
|
2416
3433
|
"style": "simple",
|
|
2417
3434
|
"explode": false,
|
|
2418
3435
|
"schema": {
|
|
2419
3436
|
"type": "string",
|
|
3437
|
+
"example": "Site1CustomerList",
|
|
2420
3438
|
"maxLength": 256,
|
|
2421
3439
|
"minLength": 1
|
|
2422
3440
|
}
|
|
@@ -2424,21 +3442,25 @@
|
|
|
2424
3442
|
"organizationId": {
|
|
2425
3443
|
"name": "organizationId",
|
|
2426
3444
|
"in": "path",
|
|
3445
|
+
"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).",
|
|
2427
3446
|
"required": true,
|
|
2428
3447
|
"style": "simple",
|
|
2429
3448
|
"explode": false,
|
|
2430
3449
|
"schema": {
|
|
2431
3450
|
"$ref": "#/components/schemas/OrganizationId"
|
|
2432
|
-
}
|
|
3451
|
+
},
|
|
3452
|
+
"example": "f_ecom_zzxy_prd"
|
|
2433
3453
|
},
|
|
2434
3454
|
"customerNo": {
|
|
2435
3455
|
"name": "customerNo",
|
|
2436
3456
|
"in": "path",
|
|
3457
|
+
"description": "The customer number.",
|
|
2437
3458
|
"required": true,
|
|
2438
3459
|
"style": "simple",
|
|
2439
3460
|
"explode": false,
|
|
2440
3461
|
"schema": {
|
|
2441
3462
|
"type": "string",
|
|
3463
|
+
"example": "1",
|
|
2442
3464
|
"maxLength": 100,
|
|
2443
3465
|
"minLength": 1
|
|
2444
3466
|
}
|
|
@@ -2446,11 +3468,13 @@
|
|
|
2446
3468
|
"addressId": {
|
|
2447
3469
|
"name": "addressId",
|
|
2448
3470
|
"in": "path",
|
|
3471
|
+
"description": "The address ID.",
|
|
2449
3472
|
"required": true,
|
|
2450
3473
|
"style": "simple",
|
|
2451
3474
|
"explode": false,
|
|
2452
3475
|
"schema": {
|
|
2453
3476
|
"type": "string",
|
|
3477
|
+
"example": "Home",
|
|
2454
3478
|
"maxLength": 256,
|
|
2455
3479
|
"minLength": 1
|
|
2456
3480
|
}
|
|
@@ -2458,11 +3482,17 @@
|
|
|
2458
3482
|
"siteId": {
|
|
2459
3483
|
"name": "siteId",
|
|
2460
3484
|
"in": "query",
|
|
3485
|
+
"description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.",
|
|
2461
3486
|
"required": true,
|
|
2462
3487
|
"style": "form",
|
|
2463
3488
|
"explode": true,
|
|
2464
3489
|
"schema": {
|
|
2465
3490
|
"$ref": "#/components/schemas/SiteId"
|
|
3491
|
+
},
|
|
3492
|
+
"examples": {
|
|
3493
|
+
"SiteId": {
|
|
3494
|
+
"value": "RefArch"
|
|
3495
|
+
}
|
|
2466
3496
|
}
|
|
2467
3497
|
},
|
|
2468
3498
|
"select": {
|
|
@@ -2473,11 +3503,17 @@
|
|
|
2473
3503
|
"explode": true,
|
|
2474
3504
|
"schema": {
|
|
2475
3505
|
"$ref": "#/components/schemas/Select"
|
|
3506
|
+
},
|
|
3507
|
+
"examples": {
|
|
3508
|
+
"select": {
|
|
3509
|
+
"value": "(**)"
|
|
3510
|
+
}
|
|
2476
3511
|
}
|
|
2477
3512
|
},
|
|
2478
3513
|
"customerGroupId": {
|
|
2479
3514
|
"name": "customerGroupId",
|
|
2480
3515
|
"in": "path",
|
|
3516
|
+
"description": "The customer group identifier.",
|
|
2481
3517
|
"required": true,
|
|
2482
3518
|
"style": "simple",
|
|
2483
3519
|
"explode": false,
|
|
@@ -2488,6 +3524,7 @@
|
|
|
2488
3524
|
"customerNos": {
|
|
2489
3525
|
"name": "customerNos",
|
|
2490
3526
|
"in": "query",
|
|
3527
|
+
"description": "List of customer numbers to assign or unassign from the customer group.",
|
|
2491
3528
|
"required": true,
|
|
2492
3529
|
"style": "form",
|
|
2493
3530
|
"explode": false,
|
|
@@ -2498,12 +3535,355 @@
|
|
|
2498
3535
|
},
|
|
2499
3536
|
"maxItems": 50,
|
|
2500
3537
|
"minItems": 1
|
|
3538
|
+
},
|
|
3539
|
+
"example": [
|
|
3540
|
+
"00001234",
|
|
3541
|
+
"00005678",
|
|
3542
|
+
"00009012"
|
|
3543
|
+
]
|
|
3544
|
+
}
|
|
3545
|
+
},
|
|
3546
|
+
"examples": {
|
|
3547
|
+
"CustomerSearchBody": {
|
|
3548
|
+
"value": {
|
|
3549
|
+
"limit": 2,
|
|
3550
|
+
"offset": 50,
|
|
3551
|
+
"query": {
|
|
3552
|
+
"textQuery": {
|
|
3553
|
+
"fields": [
|
|
3554
|
+
"email"
|
|
3555
|
+
],
|
|
3556
|
+
"searchPhrase": "wleung"
|
|
3557
|
+
}
|
|
3558
|
+
}
|
|
3559
|
+
}
|
|
3560
|
+
},
|
|
3561
|
+
"CustomerSearchResult": {
|
|
3562
|
+
"value": {
|
|
3563
|
+
"hits": [
|
|
3564
|
+
{
|
|
3565
|
+
"data": {
|
|
3566
|
+
"birthday": "1999-12-31",
|
|
3567
|
+
"companyName": "Salesforce",
|
|
3568
|
+
"creationDate": "2023-07-21T07:29:39.505Z",
|
|
3569
|
+
"credentials": {
|
|
3570
|
+
"enabled": true,
|
|
3571
|
+
"locked": false,
|
|
3572
|
+
"login": "af4ab358-3187-4ec5-82a6-918e0fe8a21f"
|
|
3573
|
+
},
|
|
3574
|
+
"customerId": "absAzIVSkman3GPpSYluYBbLrB",
|
|
3575
|
+
"customerNo": "00000012",
|
|
3576
|
+
"email": "w.leung@gmail.com",
|
|
3577
|
+
"fax": "123-123-1234",
|
|
3578
|
+
"firstName": "Wei",
|
|
3579
|
+
"gender": 1,
|
|
3580
|
+
"lastModified": "2023-07-21T07:29:39.506Z",
|
|
3581
|
+
"lastName": "Leung",
|
|
3582
|
+
"phoneBusiness": "123-123-1234",
|
|
3583
|
+
"phoneHome": "123-123-1234",
|
|
3584
|
+
"phoneMobile": "123-123-1234",
|
|
3585
|
+
"preferredLocale": "en-US",
|
|
3586
|
+
"salutation": "Dr.",
|
|
3587
|
+
"secondName": "J",
|
|
3588
|
+
"suffix": "Jr.",
|
|
3589
|
+
"title": "Mr."
|
|
3590
|
+
},
|
|
3591
|
+
"relevance": 4.258296012878418
|
|
3592
|
+
}
|
|
3593
|
+
],
|
|
3594
|
+
"limit": 1,
|
|
3595
|
+
"offset": 0,
|
|
3596
|
+
"query": {
|
|
3597
|
+
"textQuery": {
|
|
3598
|
+
"fields": [
|
|
3599
|
+
"email"
|
|
3600
|
+
],
|
|
3601
|
+
"searchPhrase": "w.leung@gmail.com"
|
|
3602
|
+
}
|
|
3603
|
+
},
|
|
3604
|
+
"total": 1
|
|
3605
|
+
}
|
|
3606
|
+
},
|
|
3607
|
+
"searchCustomerInCustomerList400": {
|
|
3608
|
+
"value": {
|
|
3609
|
+
"title": "Bad Request",
|
|
3610
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-query-parameter",
|
|
3611
|
+
"detail": "offset-BAD-REQUEST parameters are not defined in RAML."
|
|
3612
|
+
}
|
|
3613
|
+
},
|
|
3614
|
+
"searchCustomerInCustomerList401": {
|
|
3615
|
+
"value": {
|
|
3616
|
+
"title": "Invalid Access Token",
|
|
3617
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-access-token",
|
|
3618
|
+
"detail": "The request is unauthorized, the access token is invalid.",
|
|
3619
|
+
"accessToken": "hbGciOiJIUzI1NiIsInR5cCI6Ikp"
|
|
3620
|
+
}
|
|
3621
|
+
},
|
|
3622
|
+
"searchCustomerInCustomerList404": {
|
|
3623
|
+
"value": {
|
|
3624
|
+
"title": "Customer List Not Found",
|
|
3625
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/customer-list-not-found",
|
|
3626
|
+
"detail": "No customer list with ID 'SiteGenesis-NOT-FOUND' could be found.",
|
|
3627
|
+
"listId": "SiteGenesis-NOT-FOUND"
|
|
3628
|
+
}
|
|
3629
|
+
},
|
|
3630
|
+
"PostCustomerBody": {
|
|
3631
|
+
"value": {
|
|
3632
|
+
"credentials": {
|
|
3633
|
+
"enabled": true,
|
|
3634
|
+
"locked": false,
|
|
3635
|
+
"login": "wleung",
|
|
3636
|
+
"passwordQuestion": ""
|
|
3637
|
+
},
|
|
3638
|
+
"lastName": "Leung",
|
|
3639
|
+
"customerNo": "00005002"
|
|
3640
|
+
}
|
|
3641
|
+
},
|
|
3642
|
+
"postCustomers": {
|
|
3643
|
+
"value": {
|
|
3644
|
+
"creationDate": "2019-09-23T19:46:07.412Z",
|
|
3645
|
+
"credentials": {
|
|
3646
|
+
"enabled": true,
|
|
3647
|
+
"locked": false,
|
|
3648
|
+
"login": "wleung"
|
|
3649
|
+
},
|
|
3650
|
+
"customerId": "adg2p1zObo8JDt3iXZCNIZBcai",
|
|
3651
|
+
"customerNo": "00005001",
|
|
3652
|
+
"lastModified": "2019-09-23T19:46:07.417Z",
|
|
3653
|
+
"lastName": "Leung"
|
|
3654
|
+
}
|
|
3655
|
+
},
|
|
3656
|
+
"addressesGet": {
|
|
3657
|
+
"value": {
|
|
3658
|
+
"data": [
|
|
3659
|
+
{
|
|
3660
|
+
"addressId": "1",
|
|
3661
|
+
"city": "San Francisco",
|
|
3662
|
+
"companyName": "Ursa Major Solar",
|
|
3663
|
+
"countryCode": "US",
|
|
3664
|
+
"creationDate": "2019-09-23T16:14:07.000Z",
|
|
3665
|
+
"etag": "d288bfd83f75b23640b4bbab2b0d3f65a5c5e934dab818f2246b7c1aed5672f8",
|
|
3666
|
+
"firstName": "Wei",
|
|
3667
|
+
"fullName": "Leung",
|
|
3668
|
+
"jobTitle": "",
|
|
3669
|
+
"lastModified": "2019-09-23T16:23:19.000Z",
|
|
3670
|
+
"lastName": "Leung",
|
|
3671
|
+
"phone": "415-555-1212",
|
|
3672
|
+
"postalCode": "94105",
|
|
3673
|
+
"salutation": "Ms",
|
|
3674
|
+
"secondName": "",
|
|
3675
|
+
"stateCode": "CA"
|
|
3676
|
+
}
|
|
3677
|
+
],
|
|
3678
|
+
"limit": 1,
|
|
3679
|
+
"offset": 0,
|
|
3680
|
+
"total": 1
|
|
3681
|
+
}
|
|
3682
|
+
},
|
|
3683
|
+
"AddressesBody": {
|
|
3684
|
+
"value": {
|
|
3685
|
+
"addressId": "2",
|
|
3686
|
+
"address1": "123 Trailblazer Ave.",
|
|
3687
|
+
"postalCode": "94105",
|
|
3688
|
+
"lastName": "Leung",
|
|
3689
|
+
"title": "",
|
|
3690
|
+
"salutation": "Ms",
|
|
3691
|
+
"companyName": "Ursa Major Solar",
|
|
3692
|
+
"secondName": "",
|
|
3693
|
+
"phone": "415-555-1212",
|
|
3694
|
+
"countryCode": "US",
|
|
3695
|
+
"city": "San Francisco",
|
|
3696
|
+
"address2": "",
|
|
3697
|
+
"firstName": "Wei",
|
|
3698
|
+
"jobTitle": "",
|
|
3699
|
+
"stateCode": "CA"
|
|
3700
|
+
}
|
|
3701
|
+
},
|
|
3702
|
+
"addressesPost": {
|
|
3703
|
+
"value": {
|
|
3704
|
+
"addressId": "3",
|
|
3705
|
+
"city": "San Francisco",
|
|
3706
|
+
"companyName": "Ursa Major Solar",
|
|
3707
|
+
"countryCode": "US",
|
|
3708
|
+
"creationDate": "2019-09-23T20:49:38.370Z",
|
|
3709
|
+
"etag": "8772fd1c59fed8313a6c1ad260544c116dc0af4bc13941957173244edba47d31",
|
|
3710
|
+
"firstName": "Wei",
|
|
3711
|
+
"fullName": "Wei Leung",
|
|
3712
|
+
"jobTitle": "",
|
|
3713
|
+
"lastModified": "2019-09-23T20:49:38.372Z",
|
|
3714
|
+
"lastName": "Leung",
|
|
3715
|
+
"phone": "415-555-1212",
|
|
3716
|
+
"postalCode": "94105",
|
|
3717
|
+
"salutation": "Ms",
|
|
3718
|
+
"secondName": "",
|
|
3719
|
+
"stateCode": "CA"
|
|
3720
|
+
}
|
|
3721
|
+
},
|
|
3722
|
+
"AddressGet": {
|
|
3723
|
+
"value": {
|
|
3724
|
+
"address1": "123 Trailblazer Ave.",
|
|
3725
|
+
"address2": "",
|
|
3726
|
+
"addressId": "HomeAddress",
|
|
3727
|
+
"city": "San Francisco",
|
|
3728
|
+
"companyName": "",
|
|
3729
|
+
"countryCode": "US",
|
|
3730
|
+
"firstName": "Wei",
|
|
3731
|
+
"fullName": "Wei Leung",
|
|
3732
|
+
"jobTitle": "",
|
|
3733
|
+
"lastName": "Leung",
|
|
3734
|
+
"phone": "",
|
|
3735
|
+
"postalCode": "",
|
|
3736
|
+
"postBox": "",
|
|
3737
|
+
"salutation": "Ms.",
|
|
3738
|
+
"secondName": "",
|
|
3739
|
+
"stateCode": "CA",
|
|
3740
|
+
"suffix": "",
|
|
3741
|
+
"suite": "",
|
|
3742
|
+
"title": ""
|
|
3743
|
+
}
|
|
3744
|
+
},
|
|
3745
|
+
"CustomerGroupSearchResult": {
|
|
3746
|
+
"value": {
|
|
3747
|
+
"limit": 1,
|
|
3748
|
+
"hits": [
|
|
3749
|
+
{
|
|
3750
|
+
"creationDate": "2020-01-09T16:50:32.000Z",
|
|
3751
|
+
"description": "Big Spenders",
|
|
3752
|
+
"id": "Big Spenders",
|
|
3753
|
+
"inDeletion": false,
|
|
3754
|
+
"lastModified": "2020-01-09T16:50:32.000Z",
|
|
3755
|
+
"memberCount": 109,
|
|
3756
|
+
"rule": {
|
|
3757
|
+
"description": "Customers who spend more than $1000 in the last month"
|
|
3758
|
+
},
|
|
3759
|
+
"type": "dynamic"
|
|
3760
|
+
}
|
|
3761
|
+
],
|
|
3762
|
+
"query": {
|
|
3763
|
+
"textQuery": {
|
|
3764
|
+
"fields": [
|
|
3765
|
+
"id"
|
|
3766
|
+
],
|
|
3767
|
+
"searchPhrase": "Big"
|
|
3768
|
+
}
|
|
3769
|
+
},
|
|
3770
|
+
"offset": 0,
|
|
3771
|
+
"total": 1
|
|
3772
|
+
}
|
|
3773
|
+
},
|
|
3774
|
+
"searchCustomerGroup400": {
|
|
3775
|
+
"value": {
|
|
3776
|
+
"title": "Customer Group Type Invalid",
|
|
3777
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-query-parameter",
|
|
3778
|
+
"detail": "The customer group type 'stat' is invalid."
|
|
3779
|
+
}
|
|
3780
|
+
},
|
|
3781
|
+
"CustomerGroupResult": {
|
|
3782
|
+
"value": {
|
|
3783
|
+
"limit": 3,
|
|
3784
|
+
"offset": 0,
|
|
3785
|
+
"total": 50,
|
|
3786
|
+
"data": [
|
|
3787
|
+
{
|
|
3788
|
+
"creationDate": "2020-01-09T16:50:32.000Z",
|
|
3789
|
+
"description": "Big Spenders",
|
|
3790
|
+
"id": "Big Spenders",
|
|
3791
|
+
"lastModified": "2020-01-09T16:50:32.000Z",
|
|
3792
|
+
"rule": {
|
|
3793
|
+
"description": "Customers who spent more than $1000 in the last month"
|
|
3794
|
+
},
|
|
3795
|
+
"type": "dynamic"
|
|
3796
|
+
},
|
|
3797
|
+
{
|
|
3798
|
+
"creationDate": "2019-05-15T10:30:00.000Z",
|
|
3799
|
+
"description": "VIP Customers",
|
|
3800
|
+
"id": "VIP",
|
|
3801
|
+
"lastModified": "2020-03-20T14:15:30.000Z",
|
|
3802
|
+
"type": "static"
|
|
3803
|
+
},
|
|
3804
|
+
{
|
|
3805
|
+
"creationDate": "2018-01-01T00:00:00.000Z",
|
|
3806
|
+
"description": "Everyone",
|
|
3807
|
+
"id": "Everyone",
|
|
3808
|
+
"lastModified": "2018-01-01T00:00:00.000Z",
|
|
3809
|
+
"type": "system"
|
|
3810
|
+
}
|
|
3811
|
+
]
|
|
3812
|
+
}
|
|
3813
|
+
},
|
|
3814
|
+
"malformedSelector400": {
|
|
3815
|
+
"value": {
|
|
3816
|
+
"title": "Malformed Selector",
|
|
3817
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/malformed-selector",
|
|
3818
|
+
"detail": "The property selector '(invalid' is malformed.",
|
|
3819
|
+
"selector": "(invalid"
|
|
3820
|
+
}
|
|
3821
|
+
},
|
|
3822
|
+
"AssignMembersSuccess": {
|
|
3823
|
+
"summary": "Successful assignment of customers to a customer group",
|
|
3824
|
+
"description": "Example response after successfully assigning multiple customers to a customer group",
|
|
3825
|
+
"value": {
|
|
3826
|
+
"limit": 3,
|
|
3827
|
+
"total": 5,
|
|
3828
|
+
"data": [
|
|
3829
|
+
{
|
|
3830
|
+
"customerNo": "00001234",
|
|
3831
|
+
"login": "johndoe",
|
|
3832
|
+
"firstName": "John",
|
|
3833
|
+
"lastName": "Doe",
|
|
3834
|
+
"active": true
|
|
3835
|
+
},
|
|
3836
|
+
{
|
|
3837
|
+
"customerNo": "00005678",
|
|
3838
|
+
"login": "janesmith",
|
|
3839
|
+
"firstName": "Jane",
|
|
3840
|
+
"lastName": "Smith",
|
|
3841
|
+
"active": true
|
|
3842
|
+
},
|
|
3843
|
+
{
|
|
3844
|
+
"customerNo": "00009012",
|
|
3845
|
+
"login": "bobjones",
|
|
3846
|
+
"firstName": "Bob",
|
|
3847
|
+
"lastName": "Jones",
|
|
3848
|
+
"active": true
|
|
3849
|
+
}
|
|
3850
|
+
]
|
|
3851
|
+
}
|
|
3852
|
+
},
|
|
3853
|
+
"customerGroupUnsupportedAssignment403": {
|
|
3854
|
+
"value": {
|
|
3855
|
+
"title": "Customer Group Unsupported Assignment",
|
|
3856
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/customer-group-unsupported-assignment",
|
|
3857
|
+
"detail": "No customer can be assigned to the non-static group 'Unregistered' for site 'RefArch'."
|
|
3858
|
+
}
|
|
3859
|
+
},
|
|
3860
|
+
"customerGroupNotFound404": {
|
|
3861
|
+
"value": {
|
|
3862
|
+
"title": "Customer Group Not Found",
|
|
3863
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/customer-group-not-found",
|
|
3864
|
+
"detail": "No customer group with ID 'invalidId' for site 'RefArch' could be found."
|
|
3865
|
+
}
|
|
3866
|
+
},
|
|
3867
|
+
"customerNotFound404": {
|
|
3868
|
+
"value": {
|
|
3869
|
+
"title": "Customer Not Found",
|
|
3870
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/customer-not-found",
|
|
3871
|
+
"detail": "No customer with number '[\"invalidCustomerNo\"]' for site 'RefArch' could be found."
|
|
3872
|
+
}
|
|
3873
|
+
},
|
|
3874
|
+
"objectInDeletionConflict409": {
|
|
3875
|
+
"value": {
|
|
3876
|
+
"title": "Object In Deletion Conflict",
|
|
3877
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/object-in-deletion-conflict",
|
|
3878
|
+
"detail": "The request on object '{1}' can't be executed since it's already in the process of being deleted.",
|
|
3879
|
+
"objectId": "CustomerGroupInDeletion"
|
|
2501
3880
|
}
|
|
2502
3881
|
}
|
|
2503
3882
|
},
|
|
2504
3883
|
"securitySchemes": {
|
|
2505
3884
|
"AmOAuth2": {
|
|
2506
3885
|
"type": "oauth2",
|
|
3886
|
+
"description": "AccountManager OAuth 2.0 bearer token Authentication.",
|
|
2507
3887
|
"flows": {
|
|
2508
3888
|
"clientCredentials": {
|
|
2509
3889
|
"tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|
|
@@ -2517,12 +3897,8 @@
|
|
|
2517
3897
|
"authorizationCode": {
|
|
2518
3898
|
"authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
|
|
2519
3899
|
"tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|
|
2520
|
-
"
|
|
2521
|
-
|
|
2522
|
-
"sfcc.customerlists.rw": "Customer Lists scope",
|
|
2523
|
-
"sfcc.customergroups": "Customer Groups scope READONLY",
|
|
2524
|
-
"sfcc.customergroups.rw": "Customer Groups scope"
|
|
2525
|
-
}
|
|
3900
|
+
"refreshUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|
|
3901
|
+
"scopes": {}
|
|
2526
3902
|
}
|
|
2527
3903
|
}
|
|
2528
3904
|
}
|