@epcc-sdk/sdks-shopper 0.4.0 → 0.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/dist/client/@tanstack/react-query.gen.cjs.map +1 -1
- package/dist/client/@tanstack/react-query.gen.d.cts +6 -3
- package/dist/client/@tanstack/react-query.gen.d.ts +6 -3
- package/dist/client/@tanstack/react-query.gen.mjs.map +1 -1
- package/dist/client/index.d.cts +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/sdk.gen.cjs +9 -3
- package/dist/client/sdk.gen.cjs.map +1 -1
- package/dist/client/sdk.gen.d.cts +10 -5
- package/dist/client/sdk.gen.d.ts +10 -5
- package/dist/client/sdk.gen.mjs +9 -3
- package/dist/client/sdk.gen.mjs.map +1 -1
- package/dist/client/transformers.gen.cjs +55 -9
- package/dist/client/transformers.gen.cjs.map +1 -1
- package/dist/client/transformers.gen.d.cts +3 -2
- package/dist/client/transformers.gen.d.ts +3 -2
- package/dist/client/transformers.gen.mjs +54 -9
- package/dist/client/transformers.gen.mjs.map +1 -1
- package/dist/client/types.gen.cjs.map +1 -1
- package/dist/client/types.gen.d.cts +2050 -461
- package/dist/client/types.gen.d.ts +2050 -461
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/package.json +1 -1
|
@@ -8121,648 +8121,2097 @@ type AccountManagementError = {
|
|
|
8121
8121
|
type AccountManagementErrorResponse = {
|
|
8122
8122
|
errors: Array<AccountManagementError>;
|
|
8123
8123
|
};
|
|
8124
|
+
/**
|
|
8125
|
+
* The values permitted for this parameter are, `allowed` or `api_only`. In Single Sign On (SSO) each user in the Identity Provider (IdP) has a unique identifier, but different IdPs might differ in whether distinct users can share the same email address. For the `allowed` setting, when a user with a new unique identifier signs in through SSO for the first time, the system creates a new user. However, for the `api_only` setting, the system assigns the new unique identifier to the existing user in the system, in this case both the old and new unique identifier from the IdP points to the same user in Commerce. The `api_only` setting is recommended only when all configured identity providers treat e-mail address as a unique identifier for the user, otherwise a user might get access to another user’s account and data. Thus the `api_only` value can simplify administration of users.
|
|
8126
|
+
*/
|
|
8127
|
+
type DuplicateEmailPolicy = "allowed" | "disallowed" | "api_only";
|
|
8124
8128
|
type AuthenticationRealm = {
|
|
8125
|
-
|
|
8129
|
+
/**
|
|
8130
|
+
* Specifies the type of object. Set this value to `authentication-realm`.
|
|
8131
|
+
*/
|
|
8132
|
+
type: "authentication-realm";
|
|
8133
|
+
/**
|
|
8134
|
+
* Specifies the name of the authentication realm.
|
|
8135
|
+
*/
|
|
8126
8136
|
name: string;
|
|
8127
|
-
|
|
8128
|
-
|
|
8129
|
-
|
|
8130
|
-
|
|
8131
|
-
|
|
8132
|
-
|
|
8133
|
-
|
|
8134
|
-
|
|
8135
|
-
|
|
8136
|
-
|
|
8137
|
+
/**
|
|
8138
|
+
* The values permitted for this parameter are, `allowed` or `api_only`. In Single Sign On (SSO) each user in the Identity Provider (IdP) has a unique identifier, but different IdPs might differ in whether distinct users can share the same email address. For the `allowed` setting, when a user with a new unique identifier signs in through SSO for the first time, the system creates a new user. However, for the `api_only` setting, the system assigns the new unique identifier to the existing user in the system, in this case both the old and new unique identifier from the IdP points to the same user in Commerce. The `api_only` setting is recommended only when all configured identity providers treat e-mail address as a unique identifier for the user, otherwise a user might get access to another user’s account and data. Thus the `api_only` value can simplify administration of users.
|
|
8139
|
+
*/
|
|
8140
|
+
duplicate_email_policy?: "allowed" | "disallowed" | "api_only";
|
|
8141
|
+
/**
|
|
8142
|
+
* An array of Storefront URIs that can start Single Sign On authentication. These URIs must follow the rules for [redirection endpoints in OAuth 2.0.](https://tools.ietf.org/html/rfc6749#section-3.1.2) All URIs must start with https:// except for http://localhost.
|
|
8143
|
+
*/
|
|
8144
|
+
redirect_uris?: Array<string>;
|
|
8145
|
+
/**
|
|
8146
|
+
* Specifies the relationships for this authentication realm.
|
|
8147
|
+
*/
|
|
8148
|
+
relationships?: {
|
|
8149
|
+
origin?: {
|
|
8150
|
+
data?: {
|
|
8151
|
+
/**
|
|
8152
|
+
* The ID of the origin entity.
|
|
8153
|
+
*/
|
|
8154
|
+
id?: string;
|
|
8155
|
+
/**
|
|
8156
|
+
* The type of the origin entity.
|
|
8157
|
+
*/
|
|
8158
|
+
type?: "customer-authentication-settings" | "merchant-realm-mappings" | "account_authentication_settings";
|
|
8159
|
+
};
|
|
8160
|
+
};
|
|
8137
8161
|
};
|
|
8138
8162
|
};
|
|
8139
|
-
type
|
|
8140
|
-
|
|
8163
|
+
type AuthenticationRealmResponse = AuthenticationRealm & {
|
|
8164
|
+
/**
|
|
8165
|
+
* The unique identifier for an Authentication Realm.
|
|
8166
|
+
*/
|
|
8167
|
+
id?: AuthenticationRealmsUuid;
|
|
8168
|
+
/**
|
|
8169
|
+
* Additional information for this realm.
|
|
8170
|
+
*/
|
|
8171
|
+
meta?: AuthenticationRealmsMetaTimestamps;
|
|
8141
8172
|
links?: {
|
|
8173
|
+
/**
|
|
8174
|
+
* A URL to the specific resource.
|
|
8175
|
+
*/
|
|
8142
8176
|
self?: string;
|
|
8143
8177
|
};
|
|
8144
8178
|
};
|
|
8145
|
-
type AuthenticationRealmUpdateRequest = {
|
|
8146
|
-
data: {
|
|
8147
|
-
name: string;
|
|
8148
|
-
};
|
|
8149
|
-
};
|
|
8150
8179
|
type OidcProfile = {
|
|
8151
|
-
|
|
8152
|
-
|
|
8153
|
-
|
|
8180
|
+
/**
|
|
8181
|
+
* Specifies the type of object. Set this value to `oidc-profile`.
|
|
8182
|
+
*/
|
|
8183
|
+
type: "oidc-profile";
|
|
8184
|
+
/**
|
|
8185
|
+
* Specifies the name of the OIDC profile.
|
|
8186
|
+
*/
|
|
8187
|
+
name: string;
|
|
8188
|
+
/**
|
|
8189
|
+
* The OIDC discovery URL.
|
|
8190
|
+
*/
|
|
8191
|
+
discovery_url?: string;
|
|
8192
|
+
/**
|
|
8193
|
+
* The client ID for the OpenID Provider.
|
|
8194
|
+
*/
|
|
8195
|
+
client_id?: string;
|
|
8196
|
+
/**
|
|
8197
|
+
* The client secret for the OpenID Provider.
|
|
8198
|
+
*/
|
|
8154
8199
|
client_secret?: string;
|
|
8155
|
-
|
|
8156
|
-
|
|
8200
|
+
};
|
|
8201
|
+
type OidcProfileResponse = OidcProfile & {
|
|
8202
|
+
/**
|
|
8203
|
+
* The unique identifier for an OIDC Profile.
|
|
8204
|
+
*/
|
|
8205
|
+
id?: AuthenticationRealmsUuid;
|
|
8206
|
+
meta?: {
|
|
8207
|
+
/**
|
|
8208
|
+
* The date the resource is created.
|
|
8209
|
+
*/
|
|
8157
8210
|
created_at?: Date;
|
|
8211
|
+
/**
|
|
8212
|
+
* The date the resource is updated.
|
|
8213
|
+
*/
|
|
8158
8214
|
updated_at?: Date;
|
|
8215
|
+
/**
|
|
8216
|
+
* The OIDC issuer URL.
|
|
8217
|
+
*/
|
|
8218
|
+
issuer?: string;
|
|
8159
8219
|
};
|
|
8160
|
-
};
|
|
8161
|
-
type OidcProfileResponse = {
|
|
8162
|
-
data: OidcProfile;
|
|
8163
|
-
links?: {
|
|
8164
|
-
self?: string;
|
|
8165
|
-
};
|
|
8166
|
-
};
|
|
8167
|
-
type OidcProfileListResponse = {
|
|
8168
|
-
data: Array<OidcProfile>;
|
|
8169
8220
|
links?: {
|
|
8221
|
+
/**
|
|
8222
|
+
* A URL to the specific resource.
|
|
8223
|
+
*/
|
|
8170
8224
|
self?: string;
|
|
8225
|
+
/**
|
|
8226
|
+
* The authorization endpoint URL.
|
|
8227
|
+
*/
|
|
8228
|
+
"authorization-endpoint"?: string;
|
|
8229
|
+
/**
|
|
8230
|
+
* The callback endpoint URL.
|
|
8231
|
+
*/
|
|
8232
|
+
"callback-endpoint"?: string;
|
|
8233
|
+
/**
|
|
8234
|
+
* The client discovery URL.
|
|
8235
|
+
*/
|
|
8236
|
+
"client-discovery-url"?: string;
|
|
8171
8237
|
};
|
|
8172
8238
|
};
|
|
8173
|
-
type
|
|
8174
|
-
|
|
8175
|
-
|
|
8176
|
-
|
|
8177
|
-
|
|
8178
|
-
|
|
8179
|
-
|
|
8180
|
-
|
|
8181
|
-
|
|
8182
|
-
|
|
8183
|
-
|
|
8184
|
-
|
|
8185
|
-
|
|
8186
|
-
client_secret?: string;
|
|
8187
|
-
redirect_uris: Array<string>;
|
|
8188
|
-
};
|
|
8239
|
+
type OidcProfileLinks = AuthenticationRealmsSelfLink & {
|
|
8240
|
+
/**
|
|
8241
|
+
* The link that front-end applications should use to authenticate the OpenID Connect profile. The front-end application is responsible for appending all of the [required parameters](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest) to the request. The endpoint also forwards some optional parameters, `display`, `prompt` and `ui_locales` to the configured Identity Provider. These parameters allow you to control the behavior of the authentication process on the Identity Provider. Additionally the query parameter `ep_report_callback_replay_error` can be set to `true` in which case if the user revisits the `callback-endpoint` multiple times (e.g., if they hit their Back button), we will redirect the user back to the front end with an [Authentication error response](https://openid.net/specs/openid-connect-core-1_0.html#AuthError) of `callback_replay`.
|
|
8242
|
+
*/
|
|
8243
|
+
"authorization-endpoint"?: string;
|
|
8244
|
+
/**
|
|
8245
|
+
* The link that should be supplied as the callback URL to the upstream authentication provider.
|
|
8246
|
+
*/
|
|
8247
|
+
"callback-endpoint"?: string;
|
|
8248
|
+
/**
|
|
8249
|
+
* The link to the [OpenID Connect Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) document for this provider, see [here](/docs/api/single-sign-on/get-oidc-idp-stores-store-id-authentication-realms-realm-id-well-known-openid-configuration).
|
|
8250
|
+
*/
|
|
8251
|
+
"client-discovery-url"?: string;
|
|
8189
8252
|
};
|
|
8253
|
+
/**
|
|
8254
|
+
* The format the `username` field must be in when creating or updating a [User Authentication Password Profile Info](/docs/api/single-sign-on/post-v-2-authentication-realms-realm-id-user-authentication-info-user-auth-info-id-user-authentication-password-profile-info). You can change the `username_format` setting, however, the changes apply only to the users created or updated after changing this setting. The new setting does not change the `username_format` for existing users.
|
|
8255
|
+
*/
|
|
8256
|
+
type UsernameFormat = "email" | "any";
|
|
8190
8257
|
type PasswordProfile = {
|
|
8191
|
-
|
|
8258
|
+
/**
|
|
8259
|
+
* Specifies the type of object. Set this value to `password_profile`.
|
|
8260
|
+
*/
|
|
8192
8261
|
type: "password_profile";
|
|
8262
|
+
/**
|
|
8263
|
+
* Specifies the name of the password profile.
|
|
8264
|
+
*/
|
|
8193
8265
|
name: string;
|
|
8194
|
-
|
|
8195
|
-
|
|
8196
|
-
|
|
8197
|
-
|
|
8198
|
-
|
|
8199
|
-
|
|
8200
|
-
|
|
8201
|
-
|
|
8202
|
-
links?: {
|
|
8203
|
-
self?: string;
|
|
8204
|
-
};
|
|
8266
|
+
/**
|
|
8267
|
+
* The format the `username` field must be in when creating or updating a [User Authentication Password Profile Info](/docs/api/single-sign-on/post-v-2-authentication-realms-realm-id-user-authentication-info-user-auth-info-id-user-authentication-password-profile-info). You can change the `username_format` setting, however, the changes apply only to the users created or updated after changing this setting. The new setting does not change the `username_format` for existing users.
|
|
8268
|
+
*/
|
|
8269
|
+
username_format?: "email" | "any";
|
|
8270
|
+
/**
|
|
8271
|
+
* This enables one time password token requests and events for authentication. This feature is disabled by default.
|
|
8272
|
+
*/
|
|
8273
|
+
enable_one_time_password_token?: boolean;
|
|
8205
8274
|
};
|
|
8206
|
-
type
|
|
8207
|
-
|
|
8275
|
+
type PasswordProfileResponse = PasswordProfile & {
|
|
8276
|
+
/**
|
|
8277
|
+
* The unique identifier for a Password Profile.
|
|
8278
|
+
*/
|
|
8279
|
+
id?: AuthenticationRealmsUuid;
|
|
8280
|
+
/**
|
|
8281
|
+
* Additional information for this password profile.
|
|
8282
|
+
*/
|
|
8283
|
+
meta?: AuthenticationRealmsMetaTimestamps;
|
|
8208
8284
|
links?: {
|
|
8285
|
+
/**
|
|
8286
|
+
* A URL to the specific resource.
|
|
8287
|
+
*/
|
|
8209
8288
|
self?: string;
|
|
8210
8289
|
};
|
|
8211
8290
|
};
|
|
8212
|
-
|
|
8213
|
-
|
|
8214
|
-
|
|
8215
|
-
name: string;
|
|
8216
|
-
description?: string;
|
|
8217
|
-
};
|
|
8218
|
-
};
|
|
8219
|
-
type PasswordProfileUpdateRequestWrapper = {
|
|
8220
|
-
data: {
|
|
8221
|
-
id: string;
|
|
8222
|
-
type: "password_profile";
|
|
8223
|
-
name: string;
|
|
8224
|
-
description?: string;
|
|
8225
|
-
};
|
|
8226
|
-
};
|
|
8291
|
+
/**
|
|
8292
|
+
* An information field indicating why the user submitted this request. Your [integration](/docs/api/integrations/integrations-introduction) can inspect this field and can change subsequent processing.
|
|
8293
|
+
*/
|
|
8227
8294
|
type Purpose = "reset_password" | "passwordless_authentication";
|
|
8228
|
-
type
|
|
8295
|
+
type OneTimePasswordTokenRequestInput = {
|
|
8229
8296
|
type: "one_time_password_token_request";
|
|
8230
|
-
|
|
8297
|
+
/**
|
|
8298
|
+
* An information field indicating why the user submitted this request. Your [integration](/docs/api/integrations/integrations-introduction) can inspect this field and can change subsequent processing.
|
|
8299
|
+
*/
|
|
8231
8300
|
purpose: "reset_password" | "passwordless_authentication";
|
|
8301
|
+
/**
|
|
8302
|
+
* The username for the token request.
|
|
8303
|
+
*/
|
|
8304
|
+
username: string;
|
|
8305
|
+
};
|
|
8306
|
+
type OneTimePasswordTokenRequestResponse = OneTimePasswordTokenRequestInput & {
|
|
8307
|
+
/**
|
|
8308
|
+
* The unique identifier for the one-time password token request.
|
|
8309
|
+
*/
|
|
8310
|
+
id?: string;
|
|
8311
|
+
/**
|
|
8312
|
+
* The generated one-time password token.
|
|
8313
|
+
*/
|
|
8314
|
+
token?: string;
|
|
8315
|
+
/**
|
|
8316
|
+
* The expiration time of the token.
|
|
8317
|
+
*/
|
|
8318
|
+
expires_at?: Date;
|
|
8319
|
+
meta?: AuthenticationRealmsMetaTimestamps;
|
|
8232
8320
|
};
|
|
8233
|
-
/**
|
|
8234
|
-
* IN_PROGRESS covers a user caught mid sign-in; such a record may be rolled back by the system.
|
|
8235
|
-
*/
|
|
8236
|
-
type CreationStatus = "COMPLETE" | "IN_PROGRESS";
|
|
8237
8321
|
type UserAuthenticationInfo = {
|
|
8238
|
-
id: string;
|
|
8239
|
-
type: "user_authentication_info";
|
|
8240
8322
|
/**
|
|
8241
|
-
*
|
|
8323
|
+
* Specifies the type of object. Set this value to `user_authentication_info`.
|
|
8242
8324
|
*/
|
|
8243
|
-
|
|
8325
|
+
type: "user_authentication_info";
|
|
8244
8326
|
/**
|
|
8245
|
-
*
|
|
8327
|
+
* Specifies the name of the user.
|
|
8246
8328
|
*/
|
|
8247
|
-
|
|
8329
|
+
name: string;
|
|
8248
8330
|
/**
|
|
8249
|
-
*
|
|
8331
|
+
* Specifies the given name of the user.
|
|
8250
8332
|
*/
|
|
8251
8333
|
given_name?: string | null;
|
|
8252
8334
|
/**
|
|
8253
|
-
*
|
|
8335
|
+
* Specifies the family name of the user.
|
|
8254
8336
|
*/
|
|
8255
8337
|
family_name?: string | null;
|
|
8256
8338
|
/**
|
|
8257
|
-
*
|
|
8339
|
+
* Specifies the given name of the user.
|
|
8258
8340
|
*/
|
|
8259
8341
|
middle_name?: string | null;
|
|
8342
|
+
/**
|
|
8343
|
+
* Specifies the email address of the user.
|
|
8344
|
+
*/
|
|
8345
|
+
email: string;
|
|
8346
|
+
};
|
|
8347
|
+
/**
|
|
8348
|
+
* The creation status of the user authentication info.
|
|
8349
|
+
*/
|
|
8350
|
+
type CreationStatus = "COMPLETE" | "IN_PROGRESS";
|
|
8351
|
+
type UserAuthenticationInfoResponse = UserAuthenticationInfo & {
|
|
8352
|
+
/**
|
|
8353
|
+
* The unique identifier for User Authentication Info.
|
|
8354
|
+
*/
|
|
8355
|
+
id?: AuthenticationRealmsUuid;
|
|
8260
8356
|
meta?: {
|
|
8357
|
+
/**
|
|
8358
|
+
* The date the resource is created.
|
|
8359
|
+
*/
|
|
8261
8360
|
created_at?: Date;
|
|
8361
|
+
/**
|
|
8362
|
+
* The last updated date of this `user-authentication-info` object. This value also changes if subresources such as the `user-authentication-oidc-profile-info`, or `user-authentication-password-profile-info` change.The last updated date of this `user-authentication-info` object. This value also changes if subresources such as the `user-authentication-oidc-profile-info`, or `user-authentication-password-profile-info` change.
|
|
8363
|
+
*/
|
|
8262
8364
|
updated_at?: Date;
|
|
8263
8365
|
/**
|
|
8264
|
-
*
|
|
8366
|
+
* The creation status of the user authentication info.
|
|
8265
8367
|
*/
|
|
8266
8368
|
creation_status?: "COMPLETE" | "IN_PROGRESS";
|
|
8267
8369
|
};
|
|
8268
|
-
};
|
|
8269
|
-
type UserAuthenticationInfoResponse = {
|
|
8270
|
-
data: UserAuthenticationInfo;
|
|
8271
8370
|
links?: {
|
|
8371
|
+
/**
|
|
8372
|
+
* A URL to the specific resource.
|
|
8373
|
+
*/
|
|
8272
8374
|
self?: string;
|
|
8273
8375
|
};
|
|
8274
8376
|
};
|
|
8275
|
-
type
|
|
8276
|
-
|
|
8277
|
-
|
|
8278
|
-
|
|
8279
|
-
|
|
8280
|
-
|
|
8281
|
-
|
|
8282
|
-
|
|
8283
|
-
|
|
8284
|
-
|
|
8285
|
-
|
|
8286
|
-
|
|
8287
|
-
|
|
8288
|
-
links?: {
|
|
8289
|
-
current?: string;
|
|
8290
|
-
first?: string;
|
|
8291
|
-
last?: string | null;
|
|
8292
|
-
next?: string | null;
|
|
8293
|
-
prev?: string | null;
|
|
8294
|
-
};
|
|
8377
|
+
type UserAuthenticationPasswordProfileInfo = {
|
|
8378
|
+
/**
|
|
8379
|
+
* Specifies the type of object. Set this value to `user_authentication_password_profile_info`.
|
|
8380
|
+
*/
|
|
8381
|
+
type: "user_authentication_password_profile_info";
|
|
8382
|
+
/**
|
|
8383
|
+
* The username used to authenticate.
|
|
8384
|
+
*/
|
|
8385
|
+
username: string;
|
|
8386
|
+
/**
|
|
8387
|
+
* The ID of the associated password profile.
|
|
8388
|
+
*/
|
|
8389
|
+
password_profile_id: string;
|
|
8295
8390
|
};
|
|
8296
|
-
type
|
|
8297
|
-
|
|
8298
|
-
|
|
8299
|
-
|
|
8300
|
-
|
|
8301
|
-
|
|
8302
|
-
|
|
8303
|
-
|
|
8391
|
+
type UserAuthenticationPasswordProfileInfoResponse = UserAuthenticationPasswordProfileInfo & {
|
|
8392
|
+
/**
|
|
8393
|
+
* The unique identifier for User Authentication Password Profile Info.
|
|
8394
|
+
*/
|
|
8395
|
+
id?: AuthenticationRealmsUuid;
|
|
8396
|
+
/**
|
|
8397
|
+
* Additional information for this resource.
|
|
8398
|
+
*/
|
|
8399
|
+
meta?: AuthenticationRealmsMetaTimestamps;
|
|
8400
|
+
links?: {
|
|
8401
|
+
/**
|
|
8402
|
+
* A URL to the specific resource.
|
|
8403
|
+
*/
|
|
8404
|
+
self?: string;
|
|
8304
8405
|
};
|
|
8305
8406
|
};
|
|
8306
|
-
|
|
8307
|
-
|
|
8308
|
-
|
|
8309
|
-
|
|
8310
|
-
|
|
8311
|
-
type: "user_authentication_info";
|
|
8312
|
-
name?: string;
|
|
8313
|
-
email?: string;
|
|
8314
|
-
given_name?: string | null;
|
|
8315
|
-
family_name?: string | null;
|
|
8316
|
-
middle_name?: string | null;
|
|
8317
|
-
};
|
|
8407
|
+
type UserAuthenticationPasswordProfileInfoInput = UserAuthenticationPasswordProfileInfo & {
|
|
8408
|
+
/**
|
|
8409
|
+
* The password used to authenticate.
|
|
8410
|
+
*/
|
|
8411
|
+
password: string;
|
|
8318
8412
|
};
|
|
8319
8413
|
type UserAuthenticationOidcProfileInfo = {
|
|
8320
|
-
|
|
8414
|
+
/**
|
|
8415
|
+
* Specifies the type of object. Set this value to `user_authentication_oidc_profile_info`.
|
|
8416
|
+
*/
|
|
8321
8417
|
type: "user_authentication_oidc_profile_info";
|
|
8322
|
-
|
|
8323
|
-
|
|
8324
|
-
|
|
8325
|
-
|
|
8326
|
-
|
|
8418
|
+
/**
|
|
8419
|
+
* The ID of the associated [OIDC profile](/docs/authentication/single-sign-on/openid-connect-profiles-api/openid-connect-profiles-api-overview).
|
|
8420
|
+
*/
|
|
8421
|
+
oidc_profile_id: string;
|
|
8422
|
+
/**
|
|
8423
|
+
* The identifier within the issuer for the `user-authentication-info` object. For more information, see the [OpenID Connect specification](https://openid.net/specs/openid-connect-core-1_0.html#IDToken) section.
|
|
8424
|
+
*/
|
|
8425
|
+
subject?: string;
|
|
8426
|
+
/**
|
|
8427
|
+
* The identifier for the issuer of the ID Token. For more information, see the [OpenID Connect specification](https://openid.net/specs/openid-connect-core-1_0.html#IDToken) section.
|
|
8428
|
+
*/
|
|
8429
|
+
issuer?: string;
|
|
8327
8430
|
};
|
|
8328
|
-
type UserAuthenticationOidcProfileInfoResponse = {
|
|
8329
|
-
|
|
8431
|
+
type UserAuthenticationOidcProfileInfoResponse = UserAuthenticationOidcProfileInfo & {
|
|
8432
|
+
/**
|
|
8433
|
+
* The unique identifier for User Authentication OIDC Profile Info.
|
|
8434
|
+
*/
|
|
8435
|
+
id?: AuthenticationRealmsUuid;
|
|
8436
|
+
/**
|
|
8437
|
+
* Additional information for this resource.
|
|
8438
|
+
*/
|
|
8439
|
+
meta?: AuthenticationRealmsMetaTimestamps;
|
|
8330
8440
|
links?: {
|
|
8441
|
+
/**
|
|
8442
|
+
* A URL to the specific resource.
|
|
8443
|
+
*/
|
|
8331
8444
|
self?: string;
|
|
8332
8445
|
};
|
|
8333
8446
|
};
|
|
8334
|
-
|
|
8335
|
-
|
|
8336
|
-
|
|
8337
|
-
|
|
8338
|
-
|
|
8447
|
+
/**
|
|
8448
|
+
* The unique identifier.
|
|
8449
|
+
*/
|
|
8450
|
+
type AuthenticationRealmsUuid = string;
|
|
8451
|
+
type AuthenticationRealmsMetaTimestamps = {
|
|
8452
|
+
/**
|
|
8453
|
+
* The date the resource is created.
|
|
8454
|
+
*/
|
|
8455
|
+
created_at?: Date;
|
|
8456
|
+
/**
|
|
8457
|
+
* The date the resource is updated.
|
|
8458
|
+
*/
|
|
8459
|
+
updated_at?: Date;
|
|
8339
8460
|
};
|
|
8340
|
-
type
|
|
8461
|
+
type AuthenticationRealmsError = {
|
|
8462
|
+
/**
|
|
8463
|
+
* A brief summary of the error.
|
|
8464
|
+
*/
|
|
8465
|
+
title: string;
|
|
8466
|
+
/**
|
|
8467
|
+
* The HTTP response code of the error.
|
|
8468
|
+
*/
|
|
8469
|
+
status: string;
|
|
8470
|
+
/**
|
|
8471
|
+
* Optional additional detail about the error.
|
|
8472
|
+
*/
|
|
8473
|
+
detail?: string;
|
|
8474
|
+
};
|
|
8475
|
+
type AuthenticationRealmsSelfLink = {
|
|
8476
|
+
/**
|
|
8477
|
+
* A URL to the specific resource.
|
|
8478
|
+
*/
|
|
8479
|
+
self?: string;
|
|
8480
|
+
};
|
|
8481
|
+
type AuthenticationRealmsErrorResponse = {
|
|
8482
|
+
errors: Array<AuthenticationRealmsError>;
|
|
8483
|
+
links?: AuthenticationRealmsSelfLink;
|
|
8484
|
+
};
|
|
8485
|
+
type AuthenticationRealmsPaginationLinks = {
|
|
8486
|
+
/**
|
|
8487
|
+
* The current page of data.
|
|
8488
|
+
*/
|
|
8489
|
+
current?: string;
|
|
8490
|
+
/**
|
|
8491
|
+
* The first page of data.
|
|
8492
|
+
*/
|
|
8493
|
+
first?: string | null;
|
|
8494
|
+
/**
|
|
8495
|
+
* The last page of data.
|
|
8496
|
+
*/
|
|
8497
|
+
last?: string | null;
|
|
8498
|
+
/**
|
|
8499
|
+
* The next page of data.
|
|
8500
|
+
*/
|
|
8501
|
+
next?: string | null;
|
|
8502
|
+
/**
|
|
8503
|
+
* The previous page of data.
|
|
8504
|
+
*/
|
|
8505
|
+
prev?: string | null;
|
|
8506
|
+
/**
|
|
8507
|
+
* The current resource URL.
|
|
8508
|
+
*/
|
|
8509
|
+
self?: string;
|
|
8510
|
+
};
|
|
8511
|
+
type AuthenticationRealmsPaginationMeta = {
|
|
8512
|
+
page?: {
|
|
8513
|
+
/**
|
|
8514
|
+
* The current page number.
|
|
8515
|
+
*/
|
|
8516
|
+
current?: number;
|
|
8517
|
+
/**
|
|
8518
|
+
* The number of items per page.
|
|
8519
|
+
*/
|
|
8520
|
+
limit?: number;
|
|
8521
|
+
/**
|
|
8522
|
+
* The number of items to offset by.
|
|
8523
|
+
*/
|
|
8524
|
+
offset?: number;
|
|
8525
|
+
/**
|
|
8526
|
+
* The total number of pages.
|
|
8527
|
+
*/
|
|
8528
|
+
total?: number;
|
|
8529
|
+
};
|
|
8530
|
+
results?: {
|
|
8531
|
+
/**
|
|
8532
|
+
* The total number of results after applying filters, if any, or all results.
|
|
8533
|
+
*/
|
|
8534
|
+
total?: number;
|
|
8535
|
+
};
|
|
8536
|
+
};
|
|
8537
|
+
type UserAuthenticationPasswordProfileInfoUpdateInput = {
|
|
8538
|
+
/**
|
|
8539
|
+
* The unique identifier for User Authentication Password Profile Info. Must match the id in the path.
|
|
8540
|
+
*/
|
|
8541
|
+
id: string;
|
|
8542
|
+
/**
|
|
8543
|
+
* Specifies the type of object. Set this value to `user_authentication_password_profile_info`.
|
|
8544
|
+
*/
|
|
8545
|
+
type: "user_authentication_password_profile_info";
|
|
8546
|
+
/**
|
|
8547
|
+
* The username used to authenticate.
|
|
8548
|
+
*/
|
|
8549
|
+
username?: string;
|
|
8550
|
+
/**
|
|
8551
|
+
* The password used to authenticate.
|
|
8552
|
+
*/
|
|
8553
|
+
password?: string;
|
|
8554
|
+
};
|
|
8555
|
+
type SelfLink2 = {
|
|
8556
|
+
/**
|
|
8557
|
+
* Specifies the URL of this currency.
|
|
8558
|
+
*/
|
|
8559
|
+
self?: string;
|
|
8560
|
+
};
|
|
8561
|
+
type Timestamps = {
|
|
8562
|
+
/**
|
|
8563
|
+
* Indicates the creation date of this currency.
|
|
8564
|
+
*/
|
|
8565
|
+
created_at?: string;
|
|
8566
|
+
/**
|
|
8567
|
+
* Indicates the updated date of this currency.
|
|
8568
|
+
*/
|
|
8569
|
+
updated_at?: unknown;
|
|
8570
|
+
};
|
|
8571
|
+
type ResponseMetaCurrency = {
|
|
8572
|
+
timestamps?: Timestamps;
|
|
8573
|
+
/**
|
|
8574
|
+
* Indicates whether the owner is store or org.
|
|
8575
|
+
*/
|
|
8576
|
+
owner?: string;
|
|
8577
|
+
};
|
|
8578
|
+
type ResponseCurrency = {
|
|
8579
|
+
/**
|
|
8580
|
+
* The unique identifier for this currency.
|
|
8581
|
+
*/
|
|
8582
|
+
id?: string;
|
|
8583
|
+
/**
|
|
8584
|
+
* Represents the type represents the object being returned.
|
|
8585
|
+
*/
|
|
8586
|
+
type?: string;
|
|
8587
|
+
/**
|
|
8588
|
+
* Specifies the currency code. For example, YEN.
|
|
8589
|
+
*/
|
|
8590
|
+
code?: string;
|
|
8591
|
+
/**
|
|
8592
|
+
* Specifies the exchange rate from the default currency.
|
|
8593
|
+
*/
|
|
8594
|
+
exchange_rate?: number;
|
|
8595
|
+
/**
|
|
8596
|
+
* Specifies how the price currency is displayed. For example, "£{price}".
|
|
8597
|
+
*/
|
|
8598
|
+
format?: string;
|
|
8599
|
+
/**
|
|
8600
|
+
* Indicates the decimal point character.
|
|
8601
|
+
*/
|
|
8602
|
+
decimal_point?: string;
|
|
8603
|
+
/**
|
|
8604
|
+
* Indicates the thousand separator character.
|
|
8605
|
+
*/
|
|
8606
|
+
thousand_separator?: string;
|
|
8607
|
+
/**
|
|
8608
|
+
* Indicates how many decimal places the currency is formatted to.
|
|
8609
|
+
*/
|
|
8610
|
+
decimal_places?: number;
|
|
8611
|
+
/**
|
|
8612
|
+
* Specifies whether this is the default currency or not. Either `true` or `false`.
|
|
8613
|
+
*/
|
|
8614
|
+
default?: boolean;
|
|
8615
|
+
/**
|
|
8616
|
+
* Specifies if this currency is available for products. Either `true` or `false`.
|
|
8617
|
+
*/
|
|
8618
|
+
enabled?: boolean;
|
|
8619
|
+
links?: SelfLink2;
|
|
8620
|
+
meta?: ResponseMetaCurrency;
|
|
8621
|
+
};
|
|
8622
|
+
type ResponseError = {
|
|
8623
|
+
errors?: Array<{
|
|
8624
|
+
/**
|
|
8625
|
+
* An application-specific error code.
|
|
8626
|
+
*/
|
|
8627
|
+
code?: string;
|
|
8628
|
+
detail?: string;
|
|
8629
|
+
status?: number;
|
|
8630
|
+
title?: string;
|
|
8631
|
+
}>;
|
|
8632
|
+
};
|
|
8633
|
+
type DataCreateCurrencies = {
|
|
8634
|
+
/**
|
|
8635
|
+
* Specifies the currency code. Example YEN.
|
|
8636
|
+
*/
|
|
8637
|
+
code: string;
|
|
8638
|
+
/**
|
|
8639
|
+
* Indicates how many decimal places the currency is formatted to.
|
|
8640
|
+
*/
|
|
8641
|
+
decimal_places: number;
|
|
8642
|
+
/**
|
|
8643
|
+
* Indicates the decimal point character.
|
|
8644
|
+
*/
|
|
8645
|
+
decimal_point: string;
|
|
8646
|
+
/**
|
|
8647
|
+
* Specifies whether this is the default currency or not. Either `true` or `false`.
|
|
8648
|
+
*/
|
|
8649
|
+
default: boolean;
|
|
8650
|
+
/**
|
|
8651
|
+
* Specifies if this currency is available for products. Either `true` or `false`.
|
|
8652
|
+
*/
|
|
8653
|
+
enabled: boolean;
|
|
8654
|
+
/**
|
|
8655
|
+
* Specifies the exchange rate from the default currency.
|
|
8656
|
+
*/
|
|
8657
|
+
exchange_rate: number;
|
|
8658
|
+
/**
|
|
8659
|
+
* Specifies how the price currency is displayed. For example, "¥{price}".
|
|
8660
|
+
*/
|
|
8661
|
+
format: string;
|
|
8662
|
+
/**
|
|
8663
|
+
* Indicates the thousand separator character.
|
|
8664
|
+
*/
|
|
8665
|
+
thousand_separator: string;
|
|
8666
|
+
/**
|
|
8667
|
+
* Represents the type represents the object being returned.
|
|
8668
|
+
*/
|
|
8669
|
+
type: string;
|
|
8670
|
+
};
|
|
8671
|
+
type RequestCreateCurrencies = {
|
|
8672
|
+
data?: DataCreateCurrencies;
|
|
8673
|
+
};
|
|
8674
|
+
type DataUpdateCurrencies = {
|
|
8675
|
+
/**
|
|
8676
|
+
* Specifies whether this is the default currency or not. Either `true` or `false`.
|
|
8677
|
+
*/
|
|
8678
|
+
default?: boolean;
|
|
8679
|
+
};
|
|
8680
|
+
type RequestUpdateCurrencies = {
|
|
8681
|
+
data?: DataUpdateCurrencies;
|
|
8682
|
+
};
|
|
8683
|
+
type File = {
|
|
8684
|
+
/**
|
|
8685
|
+
* The unique identifier for this file.
|
|
8686
|
+
*/
|
|
8687
|
+
id?: FilesUuid;
|
|
8688
|
+
/**
|
|
8689
|
+
* The type represents the object being returned.
|
|
8690
|
+
*/
|
|
8691
|
+
type?: string;
|
|
8692
|
+
/**
|
|
8693
|
+
* The name of the file.
|
|
8694
|
+
*/
|
|
8695
|
+
file_name?: string;
|
|
8696
|
+
/**
|
|
8697
|
+
* The mime type of the file.
|
|
8698
|
+
*/
|
|
8699
|
+
mime_type?: string;
|
|
8700
|
+
/**
|
|
8701
|
+
* The size of the file. Required when uploading files.
|
|
8702
|
+
*/
|
|
8703
|
+
file_size?: number;
|
|
8704
|
+
/**
|
|
8705
|
+
* DEPRECATED Whether the file public or not. Required when uploading files.
|
|
8706
|
+
*/
|
|
8707
|
+
public?: boolean;
|
|
8708
|
+
meta?: FileMeta;
|
|
8709
|
+
links?: FilesLinks;
|
|
8710
|
+
link?: FileLink;
|
|
8711
|
+
};
|
|
8712
|
+
type FileMeta = {
|
|
8713
|
+
/**
|
|
8714
|
+
* The date and time the file was created.
|
|
8715
|
+
*/
|
|
8716
|
+
timestamps?: {
|
|
8717
|
+
/**
|
|
8718
|
+
* The date and time the file was created.
|
|
8719
|
+
*/
|
|
8720
|
+
created_at?: string;
|
|
8721
|
+
};
|
|
8722
|
+
/**
|
|
8723
|
+
* The file dimensions.
|
|
8724
|
+
*/
|
|
8725
|
+
dimensions?: {
|
|
8726
|
+
/**
|
|
8727
|
+
* The width of the file.
|
|
8728
|
+
*/
|
|
8729
|
+
width?: number;
|
|
8730
|
+
/**
|
|
8731
|
+
* The height of the file.
|
|
8732
|
+
*/
|
|
8733
|
+
height?: number;
|
|
8734
|
+
};
|
|
8735
|
+
};
|
|
8736
|
+
type ResultsMeta = {
|
|
8737
|
+
/**
|
|
8738
|
+
* Contains the results for the entire collection.
|
|
8739
|
+
*/
|
|
8740
|
+
page?: {
|
|
8741
|
+
/**
|
|
8742
|
+
* The maximum number of records for all pages.
|
|
8743
|
+
*/
|
|
8744
|
+
limit?: number;
|
|
8745
|
+
/**
|
|
8746
|
+
* The current offset by number of pages.
|
|
8747
|
+
*/
|
|
8748
|
+
offset?: number;
|
|
8749
|
+
/**
|
|
8750
|
+
* The current number of pages.
|
|
8751
|
+
*/
|
|
8752
|
+
current?: number;
|
|
8753
|
+
/**
|
|
8754
|
+
* The total number of records for the entire collection.
|
|
8755
|
+
*/
|
|
8756
|
+
total?: number;
|
|
8757
|
+
};
|
|
8758
|
+
/**
|
|
8759
|
+
* Contains the results for the entire collection.
|
|
8760
|
+
*/
|
|
8761
|
+
results?: {
|
|
8762
|
+
/**
|
|
8763
|
+
* The total number of records for the entire collection.
|
|
8764
|
+
*/
|
|
8765
|
+
total?: number;
|
|
8766
|
+
};
|
|
8767
|
+
};
|
|
8768
|
+
/**
|
|
8769
|
+
* Links are used to allow you to move between requests.
|
|
8770
|
+
*/
|
|
8771
|
+
type ResultsLinks = {
|
|
8772
|
+
/**
|
|
8773
|
+
* Single entities use a self parameter with a link to that specific resource.
|
|
8774
|
+
*/
|
|
8775
|
+
self?: string | null;
|
|
8776
|
+
/**
|
|
8777
|
+
* The current page.
|
|
8778
|
+
*/
|
|
8779
|
+
current?: string | null;
|
|
8780
|
+
/**
|
|
8781
|
+
* Always the first page.
|
|
8782
|
+
*/
|
|
8783
|
+
first?: string | null;
|
|
8784
|
+
/**
|
|
8785
|
+
* This is `null` if there is only one page.
|
|
8786
|
+
*/
|
|
8787
|
+
last?: string | null;
|
|
8788
|
+
/**
|
|
8789
|
+
* The previous page. This is `null` if on the first page.
|
|
8790
|
+
*/
|
|
8791
|
+
prev?: string | null;
|
|
8792
|
+
/**
|
|
8793
|
+
* The next page. This is `null` if there is no next page.
|
|
8794
|
+
*/
|
|
8795
|
+
next?: string | null;
|
|
8796
|
+
};
|
|
8797
|
+
/**
|
|
8798
|
+
* The publicly available URL for this file.
|
|
8799
|
+
*/
|
|
8800
|
+
type FileLink = {
|
|
8801
|
+
/**
|
|
8802
|
+
* The publicly available URL for this file.
|
|
8803
|
+
*/
|
|
8804
|
+
href?: string;
|
|
8805
|
+
};
|
|
8806
|
+
type FilesErrorResponse = {
|
|
8807
|
+
errors: Array<FilesError>;
|
|
8808
|
+
};
|
|
8809
|
+
/**
|
|
8810
|
+
* Links are used to allow you to move between requests.
|
|
8811
|
+
*/
|
|
8812
|
+
type FilesLinks = {
|
|
8813
|
+
/**
|
|
8814
|
+
* Single entities use a self parameter with a link to that specific resource.
|
|
8815
|
+
*/
|
|
8816
|
+
self?: string;
|
|
8817
|
+
};
|
|
8818
|
+
type FilesUuid = string;
|
|
8819
|
+
type FilesError = {
|
|
8820
|
+
/**
|
|
8821
|
+
* The HTTP response code of the error.
|
|
8822
|
+
*/
|
|
8823
|
+
status: number;
|
|
8824
|
+
/**
|
|
8825
|
+
* A brief summary of the error.
|
|
8826
|
+
*/
|
|
8827
|
+
title: string;
|
|
8828
|
+
/**
|
|
8829
|
+
* Optional additional detail about the error.
|
|
8830
|
+
*/
|
|
8831
|
+
detail?: string;
|
|
8832
|
+
/**
|
|
8833
|
+
* Internal request ID.
|
|
8834
|
+
*/
|
|
8835
|
+
request_id?: string;
|
|
8836
|
+
/**
|
|
8837
|
+
* Additional supporting meta data for the error.
|
|
8838
|
+
*/
|
|
8839
|
+
meta?: {
|
|
8840
|
+
[key: string]: unknown;
|
|
8841
|
+
};
|
|
8842
|
+
};
|
|
8843
|
+
type Placement = "before" | "after" | "first" | "last";
|
|
8844
|
+
type MoveSearchRuleRequest = {
|
|
8845
|
+
data: {
|
|
8846
|
+
type: "catalog_search_rule";
|
|
8847
|
+
attributes: {
|
|
8848
|
+
placement: "before" | "after" | "first" | "last";
|
|
8849
|
+
target_rule_id?: string;
|
|
8850
|
+
};
|
|
8851
|
+
};
|
|
8852
|
+
};
|
|
8853
|
+
type ReindexTenantReleasesJobRequest = {
|
|
8854
|
+
/**
|
|
8855
|
+
* The primary data for the request.
|
|
8856
|
+
*/
|
|
8857
|
+
data?: {
|
|
8858
|
+
/**
|
|
8859
|
+
* Reindex all releases for tenant whether the release index is out of sync or not.
|
|
8860
|
+
*/
|
|
8861
|
+
force_reindex?: boolean;
|
|
8862
|
+
};
|
|
8863
|
+
};
|
|
8864
|
+
/**
|
|
8865
|
+
* Result of the job
|
|
8866
|
+
*/
|
|
8867
|
+
type JobMetaResult = {
|
|
8868
|
+
[key: string]: unknown;
|
|
8869
|
+
};
|
|
8870
|
+
type JobMetaError = {
|
|
8871
|
+
/**
|
|
8872
|
+
* A string describing the error.
|
|
8873
|
+
*/
|
|
8874
|
+
detail: string;
|
|
8875
|
+
/**
|
|
8876
|
+
* Any additional context of the error.
|
|
8877
|
+
*/
|
|
8878
|
+
context?: {
|
|
8879
|
+
[key: string]: unknown;
|
|
8880
|
+
};
|
|
8881
|
+
};
|
|
8882
|
+
/**
|
|
8883
|
+
* An autocomplete suggestion with query frequency information.
|
|
8884
|
+
*/
|
|
8885
|
+
type AutocompleteResponse = {
|
|
8886
|
+
/**
|
|
8887
|
+
* A unique identifier for the autocomplete suggestion.
|
|
8888
|
+
*/
|
|
8889
|
+
id?: string;
|
|
8890
|
+
/**
|
|
8891
|
+
* The query text for the autocomplete suggestion.
|
|
8892
|
+
*/
|
|
8893
|
+
q?: string;
|
|
8894
|
+
/**
|
|
8895
|
+
* The frequency count of this query.
|
|
8896
|
+
*/
|
|
8897
|
+
count?: number;
|
|
8898
|
+
};
|
|
8899
|
+
type MultiSearchRequest = {
|
|
8900
|
+
searches: Array<SearchQuery>;
|
|
8901
|
+
};
|
|
8902
|
+
type SearchQuery = {
|
|
8903
|
+
/**
|
|
8904
|
+
* Type of search operation to perform
|
|
8905
|
+
*/
|
|
8906
|
+
type?: "search" | "autocomplete";
|
|
8907
|
+
highlight_full_fields?: string;
|
|
8908
|
+
q?: string;
|
|
8909
|
+
facet_by?: FacetByField;
|
|
8910
|
+
filter_by?: FilterByField;
|
|
8911
|
+
sort_by?: SortByField;
|
|
8912
|
+
max_facet_values?: number;
|
|
8913
|
+
page?: number;
|
|
8914
|
+
per_page?: number;
|
|
8915
|
+
};
|
|
8916
|
+
type MultiSearchResponse = {
|
|
8917
|
+
results?: Array<SearchResult>;
|
|
8918
|
+
included?: IncludedResponse2;
|
|
8919
|
+
};
|
|
8920
|
+
type SearchResponse = SearchResult & {
|
|
8921
|
+
included?: IncludedResponse2;
|
|
8922
|
+
};
|
|
8923
|
+
type SearchResult = {
|
|
8924
|
+
type?: SearchResultType;
|
|
8925
|
+
facet_counts?: Array<FacetCount>;
|
|
8926
|
+
found?: number;
|
|
8927
|
+
hits?: Array<Hit>;
|
|
8928
|
+
out_of?: number;
|
|
8929
|
+
page?: number;
|
|
8930
|
+
request_params?: {
|
|
8931
|
+
[key: string]: unknown;
|
|
8932
|
+
};
|
|
8933
|
+
search_cutoff?: boolean;
|
|
8934
|
+
search_time_ms?: number;
|
|
8935
|
+
/**
|
|
8936
|
+
* References to the unique search rules that matched this search result.
|
|
8937
|
+
*/
|
|
8938
|
+
matched_rules?: Array<MatchedRuleReference>;
|
|
8939
|
+
};
|
|
8940
|
+
type MatchedRuleReference = {
|
|
8941
|
+
/**
|
|
8942
|
+
* The unique ID of the matching search rule.
|
|
8943
|
+
*/
|
|
8944
|
+
id: string;
|
|
8945
|
+
/**
|
|
8946
|
+
* The unique ID of the search rule group that owns the matching rule.
|
|
8947
|
+
*/
|
|
8948
|
+
rule_group_id: string;
|
|
8949
|
+
};
|
|
8950
|
+
type FacetCount = {
|
|
8951
|
+
counts?: Array<FacetValue>;
|
|
8952
|
+
field_name?: string;
|
|
8953
|
+
sampled?: boolean;
|
|
8954
|
+
stats?: {
|
|
8955
|
+
[key: string]: unknown;
|
|
8956
|
+
};
|
|
8957
|
+
};
|
|
8958
|
+
type FacetValue = {
|
|
8959
|
+
count?: number;
|
|
8960
|
+
highlighted?: string;
|
|
8961
|
+
value?: string;
|
|
8962
|
+
};
|
|
8963
|
+
/**
|
|
8964
|
+
* Breakdown of how the text relevance score for this hit was derived. Values are copied unchanged from the underlying search engine response.
|
|
8965
|
+
*
|
|
8966
|
+
* These are **internal ranking signals** for debugging relevance and tuning Search Profiles — not user-facing match percentages. Scores are not normalized to a 0–100 scale. Higher `score` values indicate greater relevance **within the same search result set**; scores are not comparable across different queries.
|
|
8967
|
+
*
|
|
8968
|
+
* The overall relevance integer is available as `score` (string). Catalog Search does not expose the search engine's separate top-level `text_match` field.
|
|
8969
|
+
*
|
|
8970
|
+
* **Good uses:** debugging why one product ranks above another; building custom relative metrics (e.g. `tokens_matched` vs query length); merchandising and relevance tuning.
|
|
8971
|
+
*
|
|
8972
|
+
* **Poor uses:** displaying "match %" to shoppers; filtering by absolute thresholds without per-query calibration; comparing scores across unrelated searches.
|
|
8973
|
+
*
|
|
8974
|
+
* How the final `score` is aggregated depends on the active Search Profile's `text_match_type`:
|
|
8975
|
+
* - `max_score` (default): best field score wins; weights break ties
|
|
8976
|
+
* - `max_weight`: highest-weighted matching field drives the score
|
|
8977
|
+
* - `sum_score`: weighted field scores are summed
|
|
8978
|
+
*
|
|
8979
|
+
*/
|
|
8980
|
+
type TextMatchInfo = {
|
|
8981
|
+
/**
|
|
8982
|
+
* Raw text match score of the single best-performing field in the Search Profile's `query_by` list.
|
|
8983
|
+
* A large opaque integer — field-level, not normalized. In `max_score` mode (default), this is the strongest per-field signal driving the document score.
|
|
8984
|
+
*
|
|
8985
|
+
*/
|
|
8986
|
+
best_field_score?: string;
|
|
8987
|
+
/**
|
|
8988
|
+
* The `query_by_weights` value of the best-matching field (0–127). For example, `15` indicates the winning match came from a high-priority profile field such as `meta.search.nodes.name`.
|
|
8989
|
+
* Under `max_score`, weight is mainly a tie-breaker when two documents share the same field score. Under `max_weight`, it determines which field's score represents the document.
|
|
8990
|
+
*
|
|
8991
|
+
*/
|
|
8992
|
+
best_field_weight?: number;
|
|
8993
|
+
/**
|
|
8994
|
+
* Number of `query_by` fields that contained at least one query token. May differ from the number of highlighted fields — highlighting scans all queried fields for display, while scoring weights fields differently.
|
|
8995
|
+
*
|
|
8996
|
+
*/
|
|
8997
|
+
fields_matched?: number;
|
|
8998
|
+
/**
|
|
8999
|
+
* Number of query tokens not matched in this document (`max(0, total_query_tokens − tokens_matched)`). `0` means full query coverage; `1` means one token was missing (e.g. searching "Blue Vase Ceramic" but the document only matches "Blue Vase").
|
|
9000
|
+
* Reports token coverage for this specific hit, not the global `drop_tokens_threshold` query-relaxation behaviour.
|
|
9001
|
+
*
|
|
9002
|
+
*/
|
|
9003
|
+
num_tokens_dropped?: BigInt;
|
|
9004
|
+
/**
|
|
9005
|
+
* String form of the packed 64-bit text relevance score used to rank this hit. Equivalent to the search engine's `text_match` integer — use this field for the overall relevance value. Higher means more relevant within the current result set.
|
|
9006
|
+
*
|
|
9007
|
+
*/
|
|
9008
|
+
score?: string;
|
|
9009
|
+
/**
|
|
9010
|
+
* Number of distinct query words found in the document. Each query token is counted at most once per document, even if it appears multiple times in the text. Highlighting may show repeated occurrences; this count will not.
|
|
9011
|
+
*
|
|
9012
|
+
*/
|
|
9013
|
+
tokens_matched?: number;
|
|
9014
|
+
/**
|
|
9015
|
+
* Diagnostic signal indicating how much prefix matching or typo correction contributed to the match. `0` typically indicates an exact token match with no fuzzy or prefix-based relaxation; higher values may appear when `num_typos` or `prefix` matching was involved. Not a directly configurable parameter — treat as a tuning/debugging signal, not a display metric.
|
|
9016
|
+
*
|
|
9017
|
+
*/
|
|
9018
|
+
typo_prefix_score?: number;
|
|
9019
|
+
};
|
|
9020
|
+
type Hit = {
|
|
9021
|
+
/**
|
|
9022
|
+
* Document object - either a Product or AutocompleteResponse
|
|
9023
|
+
*/
|
|
9024
|
+
document?: CatalogSearchProduct | AutocompleteResponse;
|
|
9025
|
+
highlight?: {
|
|
9026
|
+
[key: string]: unknown;
|
|
9027
|
+
};
|
|
9028
|
+
highlights?: Array<{
|
|
9029
|
+
[key: string]: unknown;
|
|
9030
|
+
}>;
|
|
9031
|
+
/**
|
|
9032
|
+
* Relevance metadata for this hit, included when the search engine returns it. Omitted when relevance metadata is unavailable (e.g. some autocomplete results).
|
|
9033
|
+
* Hit order in the response reflects ranking driven by these scores.
|
|
9034
|
+
*
|
|
9035
|
+
*/
|
|
9036
|
+
text_match_info?: TextMatchInfo;
|
|
9037
|
+
};
|
|
9038
|
+
/**
|
|
9039
|
+
* Type of search operation to performed
|
|
9040
|
+
*/
|
|
9041
|
+
type SearchResultType = "search" | "autocomplete";
|
|
9042
|
+
/**
|
|
9043
|
+
* Included is an array of resources that are included in the response.
|
|
9044
|
+
*/
|
|
9045
|
+
type IncludedResponse2 = {
|
|
9046
|
+
[key: string]: Array<{
|
|
9047
|
+
[key: string]: unknown;
|
|
9048
|
+
}>;
|
|
9049
|
+
};
|
|
9050
|
+
type IndexableFieldsCreateRequest = {
|
|
9051
|
+
data: {
|
|
9052
|
+
type: IndexableFieldsType;
|
|
9053
|
+
attributes: IndexableFieldsRequestAttributes;
|
|
9054
|
+
};
|
|
9055
|
+
};
|
|
9056
|
+
type IndexableFieldsUpdateRequest = {
|
|
9057
|
+
data: IndexableFieldsUpdateRequestData;
|
|
9058
|
+
};
|
|
9059
|
+
type IndexableFieldsUpdateRequestData = {
|
|
9060
|
+
/**
|
|
9061
|
+
* The unique identifier of the indexable fields. Must match the ID specified in the request path.
|
|
9062
|
+
*/
|
|
9063
|
+
id: string;
|
|
9064
|
+
type: IndexableFieldsType;
|
|
9065
|
+
attributes: IndexableFieldsRequestAttributes;
|
|
9066
|
+
};
|
|
9067
|
+
type ListIndexableFieldsResponse = {
|
|
9068
|
+
data: Array<IndexableFields>;
|
|
9069
|
+
};
|
|
9070
|
+
type IndexableFieldsResponse = {
|
|
9071
|
+
data: IndexableFields;
|
|
9072
|
+
};
|
|
9073
|
+
type IndexableFields = {
|
|
9074
|
+
/**
|
|
9075
|
+
* A unique identifier of the indexable fields.
|
|
9076
|
+
*/
|
|
9077
|
+
id: string;
|
|
9078
|
+
type: IndexableFieldsType;
|
|
9079
|
+
attributes: IndexableFieldsAttributes;
|
|
9080
|
+
meta: IndexableFieldsMeta;
|
|
9081
|
+
};
|
|
9082
|
+
type IndexableFieldsRequestAttributes = {
|
|
9083
|
+
/**
|
|
9084
|
+
* A collection of indexable fields
|
|
9085
|
+
*/
|
|
9086
|
+
fields?: Array<IndexableFieldRequest>;
|
|
9087
|
+
/**
|
|
9088
|
+
* Per-field configuration for core product fields (e.g. name, description).
|
|
9089
|
+
*/
|
|
9090
|
+
core_field_overrides?: Array<CoreFieldOverride>;
|
|
9091
|
+
/**
|
|
9092
|
+
* Characters to use as token separators across all the index fields, in addition to spaces and newlines. Each element must be a single character. Defaults to none set.
|
|
9093
|
+
* For example, take text `non-tech`. By default, it will be tokenized to `nontech`. So, search for `non tech` will not match the product. Set `token_separators: ["-"]`. Then it will be tokenized to `non` and `tech`. Now, search for both `non-tech` and `non tech` will match this product.
|
|
9094
|
+
*
|
|
9095
|
+
*/
|
|
9096
|
+
token_separators?: Array<string>;
|
|
9097
|
+
/**
|
|
9098
|
+
* By default, special characters are removed from fields when indexing and searching for them. Provide list of special characters that should be indexed as part of the tokens across the all index fields. Each element must be a single character. Defaults to none set.
|
|
9099
|
+
*
|
|
9100
|
+
*/
|
|
9101
|
+
symbols_to_index?: Array<string>;
|
|
9102
|
+
/**
|
|
9103
|
+
* Enables word stemming across every text field in the index, using the [Snowball stemmer](https://snowballstem.org/). Stemming reduces words to their root form when indexing and when searching, so a search for `running` also matches products containing `run`, `runs`, or `runner`.
|
|
9104
|
+
* Defaults to `true`, so stemming applies to all text fields unless you turn it off here. Set `stem: false` to disable stemming for the whole index.
|
|
9105
|
+
* This is the recommended way to configure stemming. A `stem` value set on an individual field or core field override takes precedence over this setting for that field.
|
|
9106
|
+
*
|
|
9107
|
+
*/
|
|
9108
|
+
stem?: boolean;
|
|
9109
|
+
};
|
|
9110
|
+
type IndexableFieldsAttributes = {
|
|
9111
|
+
/**
|
|
9112
|
+
* A collection of indexable fields
|
|
9113
|
+
*/
|
|
9114
|
+
fields?: Array<IndexableField>;
|
|
9115
|
+
/**
|
|
9116
|
+
* Per-field configuration for core product fields (e.g. name, description).
|
|
9117
|
+
*/
|
|
9118
|
+
core_field_overrides?: Array<CoreFieldOverride>;
|
|
9119
|
+
/**
|
|
9120
|
+
* Characters used as token separators across the entire collection.
|
|
9121
|
+
*
|
|
9122
|
+
*/
|
|
9123
|
+
token_separators?: Array<string>;
|
|
9124
|
+
/**
|
|
9125
|
+
* Characters indexed as part of tokens across the entire collection.
|
|
9126
|
+
*
|
|
9127
|
+
*/
|
|
9128
|
+
symbols_to_index?: Array<string>;
|
|
9129
|
+
/**
|
|
9130
|
+
* Whether word stemming is enabled across every text field in the index. Omitted when it has never been set, in which case the default of `true` applies. A `stem` value on an individual field or core field override takes precedence over this setting for that field.
|
|
9131
|
+
*
|
|
9132
|
+
*/
|
|
9133
|
+
stem?: boolean;
|
|
9134
|
+
};
|
|
9135
|
+
type IndexableFieldsMeta = {
|
|
9136
|
+
owner: ResourceOwner;
|
|
9137
|
+
};
|
|
9138
|
+
type IndexableFieldRequest = {
|
|
9139
|
+
/**
|
|
9140
|
+
* The name of the field to index. Two formats are supported:
|
|
9141
|
+
*
|
|
9142
|
+
* - **Extension fields**: `extensions.products(<template_slug>).<field_name>` — indexes a field from a product extension template. The field must exist and be enabled in the flows service.
|
|
9143
|
+
* - **Shopper attribute fields**: `shopper_attributes.<attribute_name>` — indexes a merchant-defined shopper attribute. Always typed as `string`. The attribute name must be no longer than **64 characters** and can only contain alphanumeric characters, underscores (`_`), and hyphens (`-`).
|
|
9144
|
+
* - **Admin attribute fields**: `admin_attributes.<attribute_name>` — indexes a merchant-defined admin attribute. Always typed as `string`. The attribute name must be no longer than **64 characters** and can only contain alphanumeric characters, underscores (`_`), and hyphens (`-`).
|
|
9145
|
+
*
|
|
9146
|
+
*/
|
|
9147
|
+
name: string;
|
|
9148
|
+
/**
|
|
9149
|
+
* Enables faceting on the field.
|
|
9150
|
+
*/
|
|
9151
|
+
facetable?: boolean;
|
|
9152
|
+
/**
|
|
9153
|
+
* When set to true, the field will be sortable. Default: true for numbers, false otherwise.
|
|
9154
|
+
*/
|
|
9155
|
+
sortable?: boolean;
|
|
9156
|
+
/**
|
|
9157
|
+
* Language of the field's text, as an [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) — for example ja for Japanese. Defaults to en, which also broadly supports most European languages. Omitting it is identical to setting en, including for synonym matching. Codes that are not ISO 639-1, such as en-US, are rejected with a 400.
|
|
9158
|
+
*/
|
|
9159
|
+
locale?: string;
|
|
9160
|
+
stem?: Stem;
|
|
9161
|
+
/**
|
|
9162
|
+
* Deprecated. Prefer the index-wide `token_separators`. Per-field token separators for this field, overriding the index-wide value. An empty array defers to the index-wide setting. Each element must be a single character. Mixing tokenization settings across the query fields of one search profile changes how queries are matched — see the Indexable Fields guide.
|
|
9163
|
+
* For example, take text `non-tech`. By default, it will be tokenized to `nontech`. So, search for `non tech` will not match the product. Set `token_separators: ["-"]`. Then it will be tokenized to `non` and `tech`. Now, search for both `non-tech` and `non tech` will match this product.
|
|
9164
|
+
*
|
|
9165
|
+
* @deprecated
|
|
9166
|
+
*/
|
|
9167
|
+
token_separators?: Array<string>;
|
|
9168
|
+
/**
|
|
9169
|
+
* Deprecated. Prefer the index-wide `symbols_to_index`. Per-field special characters to index for this field, overriding the index-wide value. An empty array defers to the index-wide setting. Each element must be a single character. Mixing tokenization settings across the query fields of one search profile changes how queries are matched — see the Indexable Fields guide.
|
|
9170
|
+
*
|
|
9171
|
+
* @deprecated
|
|
9172
|
+
*/
|
|
9173
|
+
symbols_to_index?: Array<string>;
|
|
9174
|
+
};
|
|
9175
|
+
type IndexableField = {
|
|
9176
|
+
/**
|
|
9177
|
+
* The name of the field.
|
|
9178
|
+
*/
|
|
9179
|
+
name: string;
|
|
9180
|
+
type: FieldType;
|
|
9181
|
+
/**
|
|
9182
|
+
* Enables faceting on the field.
|
|
9183
|
+
*/
|
|
9184
|
+
facetable?: boolean;
|
|
9185
|
+
/**
|
|
9186
|
+
* When set to true, the field will be sortable. Default: true for numbers, false otherwise.
|
|
9187
|
+
*/
|
|
9188
|
+
sortable?: boolean;
|
|
9189
|
+
/**
|
|
9190
|
+
* Language of the field's text, as an [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). Omitted when none was configured, in which case the field is indexed as en — omitting it and setting en are identical.
|
|
9191
|
+
*/
|
|
9192
|
+
locale?: string;
|
|
9193
|
+
stem?: Stem;
|
|
9194
|
+
/**
|
|
9195
|
+
* Deprecated. Prefer the index-wide `token_separators`. Per-field token separators for this field, overriding the index-wide value. An empty array defers to the index-wide setting.
|
|
9196
|
+
*
|
|
9197
|
+
* @deprecated
|
|
9198
|
+
*/
|
|
9199
|
+
token_separators?: Array<string>;
|
|
9200
|
+
/**
|
|
9201
|
+
* Deprecated. Prefer the index-wide `symbols_to_index`. Per-field special characters to index for this field, overriding the index-wide value. An empty array defers to the index-wide setting.
|
|
9202
|
+
*
|
|
9203
|
+
* @deprecated
|
|
9204
|
+
*/
|
|
9205
|
+
symbols_to_index?: Array<string>;
|
|
9206
|
+
};
|
|
9207
|
+
type CoreFieldOverride = {
|
|
9208
|
+
/**
|
|
9209
|
+
* Name of the core field to configure. Must be one of the supported core fields.
|
|
9210
|
+
*
|
|
9211
|
+
*/
|
|
9212
|
+
name: string;
|
|
9213
|
+
stem?: Stem;
|
|
9214
|
+
/**
|
|
9215
|
+
* Deprecated. Prefer the index-wide `token_separators`. Per-field token separators for this core field, overriding the index-wide value. An empty array defers to the index-wide setting. Each element must be a single character. Mixing tokenization settings across the query fields of one search profile changes how queries are matched — see the Indexable Fields guide.
|
|
9216
|
+
*
|
|
9217
|
+
* @deprecated
|
|
9218
|
+
*/
|
|
9219
|
+
token_separators?: Array<string>;
|
|
9220
|
+
/**
|
|
9221
|
+
* Deprecated. Prefer the index-wide `symbols_to_index`. Per-field special characters to index for this core field, overriding the index-wide value. An empty array defers to the index-wide setting. Each element must be a single character. Mixing tokenization settings across the query fields of one search profile changes how queries are matched — see the Indexable Fields guide.
|
|
9222
|
+
*
|
|
9223
|
+
* @deprecated
|
|
9224
|
+
*/
|
|
9225
|
+
symbols_to_index?: Array<string>;
|
|
9226
|
+
/**
|
|
9227
|
+
* When set to true, enables sorting on this core field. Only supported for specific core fields.
|
|
9228
|
+
*
|
|
9229
|
+
*/
|
|
9230
|
+
sortable?: boolean;
|
|
9231
|
+
/**
|
|
9232
|
+
* When set to true, enables faceting on this core field. A re-index is required for the change to take effect.
|
|
9233
|
+
*
|
|
9234
|
+
*/
|
|
9235
|
+
facetable?: boolean;
|
|
9236
|
+
};
|
|
9237
|
+
/**
|
|
9238
|
+
* Deprecated. Prefer the index-wide `stem` on the indexable fields resource, which applies to every text field. A per-field value still overrides it, but mixing tokenization settings across the query fields of one search profile changes how queries are matched — see the Indexable Fields guide.
|
|
9239
|
+
* When true, enables word stemming on this field using [Snowball stemmer](https://snowballstem.org/). Stemming reduces words to their root form at index and query time, so a search for "running" will also match products containing "run", "runs", or "runner". This improves search recall for descriptive text fields where shoppers may use different word forms than those used in product data. Only valid for string-typed fields.
|
|
9240
|
+
* Text fields stem by default. Set `false` to turn stemming off for this field, overriding the index-wide `stem` setting.
|
|
9241
|
+
*
|
|
9242
|
+
* @deprecated
|
|
9243
|
+
*/
|
|
9244
|
+
type Stem = boolean;
|
|
9245
|
+
/**
|
|
9246
|
+
* Represents the type of object being returned. Always `catalog_search_indexable_fields`.
|
|
9247
|
+
*/
|
|
9248
|
+
type IndexableFieldsType = "catalog_search_indexable_fields";
|
|
9249
|
+
type SearchableFieldsResponse = {
|
|
9250
|
+
/**
|
|
9251
|
+
* A collection of searchable fields.
|
|
9252
|
+
*/
|
|
9253
|
+
data: Array<SearchableField>;
|
|
9254
|
+
meta: ListResponseMeta;
|
|
9255
|
+
};
|
|
9256
|
+
type SearchableField = {
|
|
9257
|
+
/**
|
|
9258
|
+
* A unique identifier of the field.
|
|
9259
|
+
*/
|
|
9260
|
+
id: string;
|
|
9261
|
+
type: SearchableFieldType;
|
|
9262
|
+
attributes: SearchableFieldAttributes;
|
|
9263
|
+
meta: SearchableFieldMeta;
|
|
9264
|
+
};
|
|
9265
|
+
type SearchableFieldAttributes = {
|
|
9266
|
+
/**
|
|
9267
|
+
* The name of the field.
|
|
9268
|
+
*/
|
|
9269
|
+
name: string;
|
|
9270
|
+
type: FieldType;
|
|
9271
|
+
/**
|
|
9272
|
+
* Enables faceting on the field.
|
|
9273
|
+
*/
|
|
9274
|
+
facetable?: boolean;
|
|
9275
|
+
/**
|
|
9276
|
+
* When set to true, the field will be sortable. Default: true for numbers, false otherwise.
|
|
9277
|
+
*/
|
|
9278
|
+
sortable?: boolean;
|
|
9279
|
+
/**
|
|
9280
|
+
* Language the field's text is indexed with, as an [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). Text fields always report a locale — en unless another was configured — and this is the locale a synonym must match to expand when the field is the highest-weighted search field. Fields that are not text report no locale.
|
|
9281
|
+
*/
|
|
9282
|
+
locale?: string;
|
|
9283
|
+
};
|
|
9284
|
+
type SearchableFieldMeta = {
|
|
9285
|
+
owner: ResourceOwner;
|
|
9286
|
+
};
|
|
9287
|
+
/**
|
|
9288
|
+
* Represents the type of object being returned. Always `catalog_searchable_field`.
|
|
9289
|
+
*/
|
|
9290
|
+
type SearchableFieldType = "catalog_searchable_field";
|
|
9291
|
+
type IndexedFieldsResponse = {
|
|
9292
|
+
/**
|
|
9293
|
+
* A collection of indexed fields.
|
|
9294
|
+
*/
|
|
9295
|
+
data: Array<IndexedField>;
|
|
9296
|
+
meta: ListResponseMeta;
|
|
9297
|
+
};
|
|
9298
|
+
type IndexedField = {
|
|
9299
|
+
/**
|
|
9300
|
+
* A unique identifier of the field.
|
|
9301
|
+
*/
|
|
9302
|
+
id: string;
|
|
9303
|
+
type: IndexedFieldType;
|
|
9304
|
+
attributes: IndexedFieldAttributes;
|
|
9305
|
+
meta: IndexedFieldMeta;
|
|
9306
|
+
};
|
|
9307
|
+
type IndexedFieldAttributes = {
|
|
9308
|
+
/**
|
|
9309
|
+
* The name of the field.
|
|
9310
|
+
*/
|
|
9311
|
+
name: string;
|
|
9312
|
+
type: FieldType;
|
|
9313
|
+
/**
|
|
9314
|
+
* Whether the field can be used for full-text search as a query field in a search profile. Only text fields are searchable.
|
|
9315
|
+
*/
|
|
9316
|
+
searchable: boolean;
|
|
9317
|
+
/**
|
|
9318
|
+
* Whether the field can be used in filter expressions.
|
|
9319
|
+
*/
|
|
9320
|
+
filterable: boolean;
|
|
9321
|
+
/**
|
|
9322
|
+
* Enables faceting on the field.
|
|
9323
|
+
*/
|
|
9324
|
+
facetable?: boolean;
|
|
9325
|
+
/**
|
|
9326
|
+
* When set to true, the field will be sortable. Default: true for numbers, false otherwise.
|
|
9327
|
+
*/
|
|
9328
|
+
sortable?: boolean;
|
|
9329
|
+
/**
|
|
9330
|
+
* Language the field's text is indexed with, as an [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). Text fields always report a locale — en unless another was configured — and this is the locale a synonym must match to expand when the field is the highest-weighted search field. Fields that are not text report no locale.
|
|
9331
|
+
*/
|
|
9332
|
+
locale?: string;
|
|
9333
|
+
};
|
|
9334
|
+
type IndexedFieldMeta = {
|
|
9335
|
+
owner: ResourceOwner;
|
|
9336
|
+
};
|
|
9337
|
+
/**
|
|
9338
|
+
* Represents the type of object being returned. Always `catalog_search_indexed_field`.
|
|
9339
|
+
*/
|
|
9340
|
+
type IndexedFieldType = "catalog_search_indexed_field";
|
|
9341
|
+
/**
|
|
9342
|
+
* The type of the field.
|
|
9343
|
+
*/
|
|
9344
|
+
type FieldType = "string" | "int32" | "int64" | "bool" | "float" | "date";
|
|
9345
|
+
type SearchProfileCreateRequest = {
|
|
9346
|
+
data: SearchProfileCreateRequestData;
|
|
9347
|
+
};
|
|
9348
|
+
type SearchProfileCreateRequestData = {
|
|
9349
|
+
type: SearchProfileType;
|
|
9350
|
+
attributes: SearchProfileAttributes;
|
|
9351
|
+
};
|
|
9352
|
+
type SearchProfileUpdateRequest = {
|
|
9353
|
+
data: SearchProfileUpdateRequestData;
|
|
9354
|
+
};
|
|
9355
|
+
type SearchProfileUpdateRequestData = {
|
|
9356
|
+
/**
|
|
9357
|
+
* The unique identifier of the search profile. Must match the ID specified in the request path.
|
|
9358
|
+
*/
|
|
9359
|
+
id: string;
|
|
9360
|
+
type: SearchProfileType;
|
|
9361
|
+
attributes: SearchProfileUpdateAttributes;
|
|
9362
|
+
};
|
|
9363
|
+
type SearchProfileUpdateAttributes = {
|
|
9364
|
+
/**
|
|
9365
|
+
* The unique slug of the search profile. A slug can contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. The sentinel `SYSTEMS_DEFAULT_PROFILE` is reserved for the built-in default and cannot be used as a tenant profile slug.
|
|
9366
|
+
*/
|
|
9367
|
+
slug?: string;
|
|
9368
|
+
/**
|
|
9369
|
+
* The description of the search profile.
|
|
9370
|
+
*/
|
|
9371
|
+
description?: string;
|
|
9372
|
+
/**
|
|
9373
|
+
* A collection of search fields
|
|
9374
|
+
*/
|
|
9375
|
+
fields?: Array<SearchField>;
|
|
9376
|
+
text_match_type?: TextMatchType;
|
|
9377
|
+
/**
|
|
9378
|
+
* Optional list of filter expressions to apply to search results. Multiple filters in the array are combined using OR logic (records matching filter1 || filter2 || ... filterN).
|
|
9379
|
+
* To combine conditions with AND logic, include multiple conditions within a single filter string (e.g., "meta.search.categories.lvl1:=`All Products > Mens Shoes` && meta.display_price.without_tax.float_price:>100").
|
|
9380
|
+
* These profile-level filters are ANDed with any filters provided in the search request via the filter_by parameter, resulting in: (profile_filter1 || profile_filter2 || ... profile_filterN) && request_filters.
|
|
9381
|
+
*
|
|
9382
|
+
*/
|
|
9383
|
+
filters?: Array<string>;
|
|
9384
|
+
/**
|
|
9385
|
+
* A collection of exclusion expressions to apply to search results. Multiple exclusions in the array are combined using OR logic (records matching exclusion1 || exclusion2 || ... exclusionN).
|
|
9386
|
+
*/
|
|
9387
|
+
exclusions?: Array<string>;
|
|
9388
|
+
boosts?: Array<SearchBoostRule>;
|
|
9389
|
+
/**
|
|
9390
|
+
* Profile-level default for prefix (partial match) behavior on the last query token. When true, the last word in the query is treated as a prefix for all fields that do not have an explicit per-field prefix value. For example, a search request for "red app" matches "red apple". When false, the last word must match exactly. If omitted, default of true applies. Per-field prefix values override this setting.
|
|
9391
|
+
* The primary use case is to show results as the user is typing in the search box.
|
|
9392
|
+
*
|
|
9393
|
+
*/
|
|
9394
|
+
prefix?: boolean | null;
|
|
9395
|
+
typo_tolerance?: TypoTolerance;
|
|
9396
|
+
synonym_settings?: SynonymSettings;
|
|
9397
|
+
/**
|
|
9398
|
+
* Optional list of synonym set IDs to apply at search time. Each synonym set must exist and must have been synced to the search engine at least once. Organization-level search profiles may only reference organization-level synonym sets. Store-level search profiles may reference organization-level and same-store synonym sets. Set to an empty array to remove all synonym sets from the search profile.
|
|
9399
|
+
*
|
|
9400
|
+
*/
|
|
9401
|
+
synonym_sets?: Array<string>;
|
|
9402
|
+
/**
|
|
9403
|
+
* Optional search rule group IDs. When non-empty, the query-time rules engine runs on every search for this profile; rule actions apply only when a trigger matches. Set to `[]` to disable rules and use profile-only behaviour.
|
|
9404
|
+
*
|
|
9405
|
+
*/
|
|
9406
|
+
rule_groups?: Array<string>;
|
|
9407
|
+
/**
|
|
9408
|
+
* When set to true, the default price is used for faceting and sorting for segmented catalogs even if the catalog rule has a supported price book.
|
|
9409
|
+
*/
|
|
9410
|
+
force_use_default_price_for_faceting_and_sorting?: boolean;
|
|
9411
|
+
};
|
|
9412
|
+
type SearchRuleGroupType = "catalog_search_rule_group";
|
|
9413
|
+
type SearchRuleType = "catalog_search_rule";
|
|
9414
|
+
/**
|
|
9415
|
+
* Attributes of a search rule group. Groups are attached to search profiles via `rule_groups` to activate query-time merchandising.
|
|
9416
|
+
*/
|
|
9417
|
+
type SearchRuleGroupAttributes = {
|
|
9418
|
+
/**
|
|
9419
|
+
* Unique identifier for the group within the tenant. Used in tooling and logs.
|
|
9420
|
+
*/
|
|
9421
|
+
slug: string;
|
|
9422
|
+
/**
|
|
9423
|
+
* Human-readable summary of the group's merchandising intent.
|
|
9424
|
+
*/
|
|
9425
|
+
description?: string;
|
|
9426
|
+
};
|
|
9427
|
+
type SearchRuleGroupMeta = {
|
|
9428
|
+
created_at: Date;
|
|
9429
|
+
updated_at: Date;
|
|
9430
|
+
owner: ResourceOwner;
|
|
9431
|
+
};
|
|
9432
|
+
/**
|
|
9433
|
+
* A named container for search merchandising rules evaluated at query time.
|
|
9434
|
+
*/
|
|
9435
|
+
type SearchRuleGroup = {
|
|
9436
|
+
id: string;
|
|
9437
|
+
type: SearchRuleGroupType;
|
|
9438
|
+
attributes: SearchRuleGroupAttributes;
|
|
9439
|
+
meta: SearchRuleGroupMeta;
|
|
9440
|
+
};
|
|
9441
|
+
type SearchRuleGroupResponse = {
|
|
9442
|
+
data: SearchRuleGroup;
|
|
9443
|
+
};
|
|
9444
|
+
type ListSearchRuleGroupsResponse = {
|
|
9445
|
+
data: Array<SearchRuleGroup>;
|
|
9446
|
+
meta: ListResponseMeta;
|
|
9447
|
+
};
|
|
9448
|
+
/**
|
|
9449
|
+
* Request body for creating a search rule group.
|
|
9450
|
+
*/
|
|
9451
|
+
type CreateSearchRuleGroupRequest = {
|
|
9452
|
+
data: {
|
|
9453
|
+
type: SearchRuleGroupType;
|
|
9454
|
+
attributes: SearchRuleGroupAttributes;
|
|
9455
|
+
};
|
|
9456
|
+
};
|
|
9457
|
+
/**
|
|
9458
|
+
* Sparse updatable labels for a search rule group. Runtime rule fields are not accepted.
|
|
9459
|
+
*/
|
|
9460
|
+
type SearchRuleGroupPatchAttributes = {
|
|
9461
|
+
/**
|
|
9462
|
+
* Unique identifier for the group within the tenant.
|
|
9463
|
+
*/
|
|
9464
|
+
slug?: string;
|
|
9465
|
+
/**
|
|
9466
|
+
* Human-readable summary of the group's merchandising intent.
|
|
9467
|
+
*/
|
|
9468
|
+
description?: string;
|
|
9469
|
+
};
|
|
9470
|
+
/**
|
|
9471
|
+
* Request body for updating a search rule group.
|
|
9472
|
+
*/
|
|
9473
|
+
type UpdateSearchRuleGroupRequest = {
|
|
9474
|
+
data: {
|
|
9475
|
+
type: SearchRuleGroupType;
|
|
9476
|
+
attributes: SearchRuleGroupPatchAttributes;
|
|
9477
|
+
};
|
|
9478
|
+
};
|
|
9479
|
+
/**
|
|
9480
|
+
* `exact` — normalized query must equal `query`.
|
|
9481
|
+
* `contains` — `query` must appear as a substring in the normalized query.
|
|
9482
|
+
* `browse` — matches a non-autocomplete wildcard query (`q=*`); omit `query`.
|
|
9483
|
+
*
|
|
9484
|
+
*/
|
|
9485
|
+
type Match = "exact" | "contains" | "browse";
|
|
9486
|
+
/**
|
|
9487
|
+
* Defines when a search rule matches a shopper query.
|
|
9488
|
+
*/
|
|
9489
|
+
type SearchRuleTrigger = {
|
|
9490
|
+
/**
|
|
9491
|
+
* Trigger text compared against the normalized shopper query. Omit for a browse trigger.
|
|
9492
|
+
*/
|
|
9493
|
+
query?: string;
|
|
9494
|
+
/**
|
|
9495
|
+
* `exact` — normalized query must equal `query`.
|
|
9496
|
+
* `contains` — `query` must appear as a substring in the normalized query.
|
|
9497
|
+
* `browse` — matches a non-autocomplete wildcard query (`q=*`); omit `query`.
|
|
9498
|
+
*
|
|
9499
|
+
*/
|
|
9500
|
+
match?: "exact" | "contains" | "browse";
|
|
9501
|
+
};
|
|
9502
|
+
/**
|
|
9503
|
+
* Actions applied when a rule matches. Provide at least one boost/bury condition, product pin, product hide, query replacement, or result filter.
|
|
9504
|
+
*/
|
|
9505
|
+
type SearchRuleActions = {
|
|
9506
|
+
/**
|
|
9507
|
+
* One or more boost/bury conditions using standard `filter_by` syntax. Weights affect product ranking when the rule matches.
|
|
9508
|
+
*/
|
|
9509
|
+
boosts?: Array<SearchBoostRule>;
|
|
9510
|
+
/**
|
|
9511
|
+
* Products to fix at one-based global result positions when the rule matches. Pinned products still respect active filters.
|
|
9512
|
+
*/
|
|
9513
|
+
pins?: Array<SearchPinRule>;
|
|
9514
|
+
/**
|
|
9515
|
+
* Products to exclude from results when the rule matches.
|
|
9516
|
+
*/
|
|
9517
|
+
hides?: Array<SearchHideRule>;
|
|
9518
|
+
/**
|
|
9519
|
+
* Query text to use for the search after this rule matches.
|
|
9520
|
+
*/
|
|
9521
|
+
replace_query?: string;
|
|
9522
|
+
/**
|
|
9523
|
+
* Filter expression to apply to search results when the rule matches.
|
|
9524
|
+
*/
|
|
9525
|
+
filter_by?: string;
|
|
9526
|
+
};
|
|
9527
|
+
/**
|
|
9528
|
+
* Attributes of a search rule within a group.
|
|
9529
|
+
*/
|
|
9530
|
+
type SearchRuleAttributes = {
|
|
9531
|
+
/**
|
|
9532
|
+
* Optional human-readable identifier for the rule within the group.
|
|
9533
|
+
*/
|
|
9534
|
+
slug?: string;
|
|
9535
|
+
/**
|
|
9536
|
+
* Optional summary of what the rule does for merchandisers.
|
|
9537
|
+
*/
|
|
9538
|
+
description?: string;
|
|
9539
|
+
/**
|
|
9540
|
+
* Lower values run first within the group and win conflicts over later rules. Must be unique per group.
|
|
9541
|
+
*/
|
|
9542
|
+
execution_order: number;
|
|
9543
|
+
trigger: SearchRuleTrigger;
|
|
9544
|
+
actions: SearchRuleActions;
|
|
9545
|
+
/**
|
|
9546
|
+
* When `true` and this rule matches, rules with a higher `execution_order` are not evaluated — including rules in other attached groups on the profile.
|
|
9547
|
+
*/
|
|
9548
|
+
stop_after_match?: boolean;
|
|
9549
|
+
};
|
|
9550
|
+
type SearchRuleMeta = {
|
|
9551
|
+
created_at: Date;
|
|
9552
|
+
updated_at: Date;
|
|
9553
|
+
owner: ResourceOwner;
|
|
9554
|
+
};
|
|
9555
|
+
/**
|
|
9556
|
+
* A single merchandising rule with a query trigger and boost/bury actions.
|
|
9557
|
+
*/
|
|
9558
|
+
type SearchRule = {
|
|
9559
|
+
id: string;
|
|
9560
|
+
type: SearchRuleType;
|
|
9561
|
+
attributes: SearchRuleAttributes;
|
|
9562
|
+
meta: SearchRuleMeta;
|
|
9563
|
+
};
|
|
9564
|
+
type SearchRuleResponse = {
|
|
9565
|
+
data: SearchRule;
|
|
9566
|
+
};
|
|
9567
|
+
type ListSearchRulesResponse = {
|
|
9568
|
+
data: Array<SearchRule>;
|
|
9569
|
+
meta: ListResponseMeta;
|
|
9570
|
+
};
|
|
9571
|
+
/**
|
|
9572
|
+
* Request body for creating a search rule in a rule group.
|
|
9573
|
+
*/
|
|
9574
|
+
type CreateSearchRuleRequest = {
|
|
9575
|
+
data: {
|
|
9576
|
+
type: SearchRuleType;
|
|
9577
|
+
attributes: SearchRuleAttributes;
|
|
9578
|
+
};
|
|
9579
|
+
};
|
|
9580
|
+
/**
|
|
9581
|
+
* Sparse updatable attributes of a search rule. A rule always remains in its current group.
|
|
9582
|
+
*/
|
|
9583
|
+
type SearchRulePatchAttributes = {
|
|
9584
|
+
/**
|
|
9585
|
+
* Optional human-readable identifier for the rule within the group.
|
|
9586
|
+
*/
|
|
9587
|
+
slug?: string;
|
|
9588
|
+
/**
|
|
9589
|
+
* Optional summary of what the rule does for merchandisers.
|
|
9590
|
+
*/
|
|
9591
|
+
description?: string;
|
|
9592
|
+
/**
|
|
9593
|
+
* Lower values run first within the group and must remain unique within that group.
|
|
9594
|
+
*/
|
|
9595
|
+
execution_order?: number;
|
|
9596
|
+
trigger?: SearchRuleTrigger;
|
|
9597
|
+
actions?: SearchRuleActions;
|
|
9598
|
+
/**
|
|
9599
|
+
* Whether matching this rule stops evaluation of later attached rules.
|
|
9600
|
+
*/
|
|
9601
|
+
stop_after_match?: boolean;
|
|
9602
|
+
};
|
|
9603
|
+
/**
|
|
9604
|
+
* Request body for updating a search rule.
|
|
9605
|
+
*/
|
|
9606
|
+
type UpdateSearchRuleRequest = {
|
|
8341
9607
|
data: {
|
|
8342
|
-
type:
|
|
8343
|
-
|
|
9608
|
+
type: SearchRuleType;
|
|
9609
|
+
attributes: SearchRulePatchAttributes;
|
|
8344
9610
|
};
|
|
8345
9611
|
};
|
|
8346
|
-
type
|
|
8347
|
-
data:
|
|
8348
|
-
|
|
8349
|
-
|
|
8350
|
-
|
|
8351
|
-
|
|
9612
|
+
type StopwordSetResponse = {
|
|
9613
|
+
data: StopwordSet;
|
|
9614
|
+
};
|
|
9615
|
+
type ListStopwordSetsResponse = {
|
|
9616
|
+
data: Array<StopwordSet>;
|
|
9617
|
+
meta: ListResponseMeta;
|
|
8352
9618
|
};
|
|
8353
|
-
type
|
|
9619
|
+
type StopwordSet = {
|
|
8354
9620
|
/**
|
|
8355
|
-
*
|
|
9621
|
+
* The unique identifier for the stopword set.
|
|
8356
9622
|
*/
|
|
8357
9623
|
id: string;
|
|
8358
|
-
|
|
9624
|
+
type: StopwordSetType;
|
|
9625
|
+
attributes: StopwordSetAttributes;
|
|
9626
|
+
meta: StopwordSetMeta;
|
|
9627
|
+
};
|
|
9628
|
+
/**
|
|
9629
|
+
* Represents the type of object being returned. Always `catalog_search_stopword_set`.
|
|
9630
|
+
*/
|
|
9631
|
+
type StopwordSetType = "catalog_search_stopword_set";
|
|
9632
|
+
type StopwordSetAttributes = {
|
|
8359
9633
|
/**
|
|
8360
|
-
*
|
|
9634
|
+
* [ISO 639 language codes](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) for the stopwords set. Omit or pass null for the default set. At most one stopwords set per locale is allowed.
|
|
9635
|
+
*
|
|
8361
9636
|
*/
|
|
8362
|
-
|
|
8363
|
-
created_at?: Date;
|
|
8364
|
-
updated_at?: Date;
|
|
8365
|
-
};
|
|
8366
|
-
type: "user_authentication_password_profile_info";
|
|
9637
|
+
locale?: string;
|
|
8367
9638
|
/**
|
|
8368
|
-
*
|
|
9639
|
+
* The list of stopwords.
|
|
8369
9640
|
*/
|
|
8370
|
-
|
|
9641
|
+
stopwords: Array<string>;
|
|
8371
9642
|
};
|
|
8372
|
-
|
|
8373
|
-
|
|
8374
|
-
|
|
8375
|
-
|
|
8376
|
-
|
|
9643
|
+
/**
|
|
9644
|
+
* The sync status of the stopword set.
|
|
9645
|
+
*/
|
|
9646
|
+
type SyncStatus = "pending_sync" | "synced" | "sync_failed" | "pending_delete";
|
|
9647
|
+
type StopwordSetMeta = {
|
|
9648
|
+
/**
|
|
9649
|
+
* The date and time the stopword set was created.
|
|
9650
|
+
*/
|
|
9651
|
+
created_at: Date;
|
|
9652
|
+
/**
|
|
9653
|
+
* The date and time the stopword set was last updated.
|
|
9654
|
+
*/
|
|
9655
|
+
updated_at: Date;
|
|
9656
|
+
owner: ResourceOwner;
|
|
9657
|
+
/**
|
|
9658
|
+
* The sync status of the stopword set.
|
|
9659
|
+
*/
|
|
9660
|
+
sync_status: "pending_sync" | "synced" | "sync_failed" | "pending_delete";
|
|
9661
|
+
/**
|
|
9662
|
+
* The date and time the stopword set was last successfully synced.
|
|
9663
|
+
*/
|
|
9664
|
+
last_synced_at?: Date;
|
|
8377
9665
|
};
|
|
8378
|
-
type
|
|
8379
|
-
data:
|
|
8380
|
-
|
|
8381
|
-
|
|
9666
|
+
type CreateStopwordSetRequest = {
|
|
9667
|
+
data: {
|
|
9668
|
+
type: StopwordSetType;
|
|
9669
|
+
attributes: StopwordSetAttributes;
|
|
8382
9670
|
};
|
|
8383
9671
|
};
|
|
8384
|
-
type
|
|
8385
|
-
data:
|
|
9672
|
+
type UpdateStopwordSetRequest = {
|
|
9673
|
+
data: {
|
|
9674
|
+
id: string;
|
|
9675
|
+
type: StopwordSetType;
|
|
9676
|
+
attributes: UpdateStopwordSetAttributes;
|
|
9677
|
+
};
|
|
8386
9678
|
};
|
|
8387
|
-
type
|
|
8388
|
-
|
|
8389
|
-
|
|
8390
|
-
|
|
8391
|
-
|
|
9679
|
+
type UpdateStopwordSetAttributes = {
|
|
9680
|
+
/**
|
|
9681
|
+
* The replacement list of stopwords. Must contain at least one entry.
|
|
9682
|
+
*/
|
|
9683
|
+
stopwords: Array<string>;
|
|
8392
9684
|
};
|
|
8393
|
-
type
|
|
8394
|
-
data:
|
|
9685
|
+
type SynonymSetResponse = {
|
|
9686
|
+
data: SynonymSet;
|
|
8395
9687
|
};
|
|
8396
|
-
type
|
|
8397
|
-
|
|
8398
|
-
|
|
8399
|
-
username: string;
|
|
8400
|
-
password: string;
|
|
9688
|
+
type ListSynonymSetsResponse = {
|
|
9689
|
+
data: Array<SynonymSet>;
|
|
9690
|
+
meta: ListResponseMeta;
|
|
8401
9691
|
};
|
|
8402
|
-
type
|
|
9692
|
+
type SynonymSet = {
|
|
8403
9693
|
/**
|
|
8404
|
-
*
|
|
9694
|
+
* The unique identifier for the synonym set.
|
|
8405
9695
|
*/
|
|
8406
|
-
|
|
9696
|
+
id: string;
|
|
9697
|
+
type: SynonymSetType;
|
|
9698
|
+
attributes: SynonymSetAttributes;
|
|
9699
|
+
meta: SynonymSetMeta;
|
|
8407
9700
|
};
|
|
8408
|
-
|
|
9701
|
+
/**
|
|
9702
|
+
* Represents the type of object being returned. Always `catalog_search_synonym_set`.
|
|
9703
|
+
*/
|
|
9704
|
+
type SynonymSetType = "catalog_search_synonym_set";
|
|
9705
|
+
type SynonymSetAttributes = {
|
|
8409
9706
|
/**
|
|
8410
|
-
*
|
|
9707
|
+
* Human-readable name for the synonym set.
|
|
8411
9708
|
*/
|
|
8412
|
-
|
|
9709
|
+
name: string;
|
|
8413
9710
|
/**
|
|
8414
|
-
*
|
|
9711
|
+
* The synonym items in this set.
|
|
8415
9712
|
*/
|
|
8416
|
-
|
|
9713
|
+
items: Array<SynonymSetItem>;
|
|
8417
9714
|
};
|
|
8418
|
-
type
|
|
8419
|
-
timestamps?: Timestamps;
|
|
9715
|
+
type SynonymSetItem = {
|
|
8420
9716
|
/**
|
|
8421
|
-
*
|
|
9717
|
+
* Unique identifier for the synonym item within the set. Alphanumeric, hyphen, and underscore only.
|
|
8422
9718
|
*/
|
|
8423
|
-
|
|
8424
|
-
};
|
|
8425
|
-
type ResponseCurrency = {
|
|
9719
|
+
id: string;
|
|
8426
9720
|
/**
|
|
8427
|
-
*
|
|
9721
|
+
* List of synonym terms.
|
|
8428
9722
|
*/
|
|
8429
|
-
|
|
9723
|
+
synonyms: Array<string>;
|
|
8430
9724
|
/**
|
|
8431
|
-
*
|
|
9725
|
+
* Makes this a one-way synonym. Searches for root also match synonyms, but not vice versa.
|
|
8432
9726
|
*/
|
|
8433
|
-
|
|
9727
|
+
root?: string;
|
|
8434
9728
|
/**
|
|
8435
|
-
*
|
|
9729
|
+
* [ISO 639 language code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) for this synonym item.
|
|
9730
|
+
*
|
|
8436
9731
|
*/
|
|
8437
|
-
|
|
9732
|
+
locale?: string;
|
|
8438
9733
|
/**
|
|
8439
|
-
*
|
|
9734
|
+
* Symbols to index for this synonym item. Each element must be exactly one character.
|
|
8440
9735
|
*/
|
|
8441
|
-
|
|
9736
|
+
symbols_to_index?: Array<string>;
|
|
9737
|
+
};
|
|
9738
|
+
type SynonymSetMeta = {
|
|
8442
9739
|
/**
|
|
8443
|
-
*
|
|
9740
|
+
* The date and time the synonym set was created.
|
|
8444
9741
|
*/
|
|
8445
|
-
|
|
9742
|
+
created_at: Date;
|
|
8446
9743
|
/**
|
|
8447
|
-
*
|
|
9744
|
+
* The date and time the synonym set was last updated.
|
|
8448
9745
|
*/
|
|
8449
|
-
|
|
9746
|
+
updated_at: Date;
|
|
9747
|
+
owner: ResourceOwner;
|
|
8450
9748
|
/**
|
|
8451
|
-
*
|
|
9749
|
+
* The sync status of the synonym set.
|
|
8452
9750
|
*/
|
|
8453
|
-
|
|
9751
|
+
sync_status: "pending_sync" | "synced" | "sync_failed" | "pending_delete";
|
|
8454
9752
|
/**
|
|
8455
|
-
*
|
|
9753
|
+
* The date and time the synonym set was last successfully synced.
|
|
8456
9754
|
*/
|
|
8457
|
-
|
|
9755
|
+
last_synced_at?: Date;
|
|
9756
|
+
};
|
|
9757
|
+
type CreateSynonymSetRequest = {
|
|
9758
|
+
data: {
|
|
9759
|
+
type: SynonymSetType;
|
|
9760
|
+
attributes: SynonymSetAttributes;
|
|
9761
|
+
};
|
|
9762
|
+
};
|
|
9763
|
+
type UpdateSynonymSetRequest = {
|
|
9764
|
+
data: {
|
|
9765
|
+
id: string;
|
|
9766
|
+
type: SynonymSetType;
|
|
9767
|
+
attributes: UpdateSynonymSetAttributes;
|
|
9768
|
+
};
|
|
9769
|
+
};
|
|
9770
|
+
type UpdateSynonymSetAttributes = {
|
|
8458
9771
|
/**
|
|
8459
|
-
*
|
|
9772
|
+
* Human-readable name for the synonym set.
|
|
8460
9773
|
*/
|
|
8461
|
-
|
|
9774
|
+
name?: string;
|
|
8462
9775
|
/**
|
|
8463
|
-
*
|
|
9776
|
+
* The synonym items in this set.
|
|
8464
9777
|
*/
|
|
8465
|
-
|
|
8466
|
-
links?: SelfLink2;
|
|
8467
|
-
meta?: ResponseMetaCurrency;
|
|
9778
|
+
items?: Array<SynonymSetItem>;
|
|
8468
9779
|
};
|
|
8469
|
-
type
|
|
8470
|
-
|
|
8471
|
-
/**
|
|
8472
|
-
* An application-specific error code.
|
|
8473
|
-
*/
|
|
8474
|
-
code?: string;
|
|
8475
|
-
detail?: string;
|
|
8476
|
-
status?: number;
|
|
8477
|
-
title?: string;
|
|
8478
|
-
}>;
|
|
9780
|
+
type SearchProfileResponse = {
|
|
9781
|
+
data: SearchProfile;
|
|
8479
9782
|
};
|
|
8480
|
-
type
|
|
9783
|
+
type ListSearchProfilesResponse = {
|
|
9784
|
+
data: Array<SearchProfile>;
|
|
9785
|
+
meta: ListResponseMeta;
|
|
9786
|
+
};
|
|
9787
|
+
type SearchProfile = {
|
|
8481
9788
|
/**
|
|
8482
|
-
*
|
|
9789
|
+
* The unique identifier for the search profile.
|
|
8483
9790
|
*/
|
|
8484
|
-
|
|
9791
|
+
id: string;
|
|
9792
|
+
type: SearchProfileType;
|
|
9793
|
+
attributes: SearchProfileAttributes;
|
|
9794
|
+
meta: SearchProfileMeta;
|
|
9795
|
+
};
|
|
9796
|
+
type SearchProfileAttributes = {
|
|
8485
9797
|
/**
|
|
8486
|
-
*
|
|
9798
|
+
* The unique slug of the search profile. A slug can contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. The sentinel `SYSTEMS_DEFAULT_PROFILE` is reserved for the built-in default and cannot be used as a tenant profile slug.
|
|
8487
9799
|
*/
|
|
8488
|
-
|
|
9800
|
+
slug: string;
|
|
8489
9801
|
/**
|
|
8490
|
-
*
|
|
9802
|
+
* The description of the search profile.
|
|
8491
9803
|
*/
|
|
8492
|
-
|
|
9804
|
+
description: string;
|
|
8493
9805
|
/**
|
|
8494
|
-
*
|
|
9806
|
+
* A collection of search fields
|
|
8495
9807
|
*/
|
|
8496
|
-
|
|
9808
|
+
fields: Array<SearchField>;
|
|
9809
|
+
text_match_type?: TextMatchType;
|
|
8497
9810
|
/**
|
|
8498
|
-
*
|
|
9811
|
+
* Optional list of filter expressions to apply to search results. Multiple filters in the array are combined using OR logic (records matching filter1 || filter2 || ... filterN).
|
|
9812
|
+
* To combine conditions with AND logic, include multiple conditions within a single filter string (e.g., "meta.search.categories.lvl1:=`All Products > Mens Shoes` && meta.display_price.without_tax.float_price:>100").
|
|
9813
|
+
* These profile-level filters are ANDed with any filters provided in the search request via the filter_by parameter, resulting in: (profile_filter1 || profile_filter2 || ... profile_filterN) && request_filters.
|
|
9814
|
+
*
|
|
8499
9815
|
*/
|
|
8500
|
-
|
|
9816
|
+
filters?: Array<string>;
|
|
8501
9817
|
/**
|
|
8502
|
-
*
|
|
9818
|
+
* A collection of exclusion expressions to apply to search results. Multiple exclusions in the array are combined using OR logic (records matching exclusion1 || exclusion2 || ... exclusionN).
|
|
8503
9819
|
*/
|
|
8504
|
-
|
|
9820
|
+
exclusions?: Array<string>;
|
|
9821
|
+
boosts?: Array<SearchBoostRule>;
|
|
8505
9822
|
/**
|
|
8506
|
-
*
|
|
9823
|
+
* Profile-level default for prefix (partial match) behavior on the last query token. When true, the last word in the query is treated as a prefix for all fields that do not have an explicit per-field prefix value. For example, a search request for "red app" matches "red apple". When false, the last word must match exactly. If omitted, default of true applies. Per-field prefix values override this setting.
|
|
9824
|
+
* The primary use case is to show results as the user is typing in the search box.
|
|
9825
|
+
*
|
|
8507
9826
|
*/
|
|
8508
|
-
|
|
9827
|
+
prefix?: boolean;
|
|
9828
|
+
typo_tolerance?: TypoTolerance;
|
|
9829
|
+
synonym_settings?: SynonymSettings;
|
|
8509
9830
|
/**
|
|
8510
|
-
*
|
|
9831
|
+
* Optional list of synonym set IDs to apply at search time. Each synonym set must exist and must have been synced to the search engine at least once. Organization-level search profiles may only reference organization-level synonym sets. Store-level search profiles may reference organization-level and same-store synonym sets.
|
|
9832
|
+
*
|
|
8511
9833
|
*/
|
|
8512
|
-
|
|
9834
|
+
synonym_sets?: Array<string>;
|
|
8513
9835
|
/**
|
|
8514
|
-
*
|
|
9836
|
+
* Optional search rule group IDs. When non-empty, the query-time rules engine runs on every search for this profile; rule actions apply only when a trigger matches. Each group must exist in tenant scope. Earlier IDs run before later IDs when matching rules from multiple groups conflict.
|
|
9837
|
+
*
|
|
8515
9838
|
*/
|
|
8516
|
-
|
|
8517
|
-
};
|
|
8518
|
-
type RequestCreateCurrencies = {
|
|
8519
|
-
data?: DataCreateCurrencies;
|
|
8520
|
-
};
|
|
8521
|
-
type DataUpdateCurrencies = {
|
|
9839
|
+
rule_groups?: Array<string>;
|
|
8522
9840
|
/**
|
|
8523
|
-
*
|
|
9841
|
+
* When set to true, the default price is used for faceting and sorting for segmented catalogs even if the catalog rule has a supported price book.
|
|
8524
9842
|
*/
|
|
8525
|
-
|
|
9843
|
+
force_use_default_price_for_faceting_and_sorting: boolean;
|
|
8526
9844
|
};
|
|
8527
|
-
type
|
|
8528
|
-
|
|
9845
|
+
type SearchProfileMeta = {
|
|
9846
|
+
/**
|
|
9847
|
+
* Whether this is the default search profile.
|
|
9848
|
+
*/
|
|
9849
|
+
default: boolean;
|
|
9850
|
+
owner: ResourceOwner;
|
|
8529
9851
|
};
|
|
8530
|
-
type
|
|
9852
|
+
type SearchField = {
|
|
8531
9853
|
/**
|
|
8532
|
-
* The
|
|
9854
|
+
* The name of the search field.
|
|
8533
9855
|
*/
|
|
8534
|
-
|
|
9856
|
+
name: string;
|
|
8535
9857
|
/**
|
|
8536
|
-
* The
|
|
9858
|
+
* The relative weight to give each field when ranking results. This can be used to boost fields in priority, when looking for matches.
|
|
9859
|
+
* If no explicit weights are provided for all fields, fields earlier in the fields list will be considered to have greater weight.
|
|
9860
|
+
* If no explicit weights are provided for some fields, the default weight of zero (0) will be used for the fields with no explicit weight.
|
|
9861
|
+
*
|
|
8537
9862
|
*/
|
|
8538
|
-
|
|
9863
|
+
weight?: number;
|
|
8539
9864
|
/**
|
|
8540
|
-
*
|
|
9865
|
+
* Per-field override for the maximum number of typographical errors [Damerau-Levenshtein distance](https://en.wikipedia.org/wiki/Damerau%E2%80%93Levenshtein_distance) allowed
|
|
9866
|
+
* when matching this field. Accepted values: 0 (exact match only), 1, or 2.
|
|
9867
|
+
* Overrides `typo_tolerance.num_typos` for this field. Falls back to `typo_tolerance.num_typos`
|
|
9868
|
+
* if set, otherwise default of 2.
|
|
9869
|
+
*
|
|
9870
|
+
* For example, a search request for "red appla" matches "red apple" with a `num_typos` of 1.
|
|
9871
|
+
*
|
|
9872
|
+
* **`num_typos` is an upper bound, not a guarantee.** The number of corrections actually
|
|
9873
|
+
* applied to a query token is also capped by its length via
|
|
9874
|
+
* `typo_tolerance.min_len_to_allow_single_character_correction` (default 4) and
|
|
9875
|
+
* `typo_tolerance.min_len_to_allow_two_character_correction` (default 7):
|
|
9876
|
+
* - A token shorter than the single-character threshold gets **no** typo correction, even with `num_typos` 1 or 2.
|
|
9877
|
+
* - A token at least as long as the single-character threshold but shorter than the two-character threshold is corrected by **at most one** character, even with `num_typos` of 2.
|
|
9878
|
+
* - Only tokens at least as long as the two-character threshold can use the full two corrections.
|
|
9879
|
+
*
|
|
9880
|
+
* For example, with the defaults, "appla" → "apple" (length 5, one correction) is allowed,
|
|
9881
|
+
* but a 5-character query with two mistakes is not corrected even with `num_typos` of 2, because two-character correction requires a token of at least 7 characters.
|
|
9882
|
+
*
|
|
8541
9883
|
*/
|
|
8542
|
-
|
|
9884
|
+
num_typos?: number;
|
|
8543
9885
|
/**
|
|
8544
|
-
*
|
|
9886
|
+
* Per-field override for prefix (partial match) behavior on the last query token.
|
|
9887
|
+
* When true, the last word is treated as a prefix; when false, it must match exactly.
|
|
9888
|
+
* For example, when true, a search request for "red app" matches "red apple".
|
|
9889
|
+
* Overrides the profile-level `prefix` for this field. Falls back to the profile-level
|
|
9890
|
+
* `prefix` if set, otherwise default of true.
|
|
9891
|
+
*
|
|
9892
|
+
* The primary use case is to show results as the user is typing in the search box.
|
|
9893
|
+
*
|
|
8545
9894
|
*/
|
|
8546
|
-
|
|
9895
|
+
prefix?: boolean;
|
|
9896
|
+
};
|
|
9897
|
+
/**
|
|
9898
|
+
* When a search profile has multiple fields defined, this parameter determines how the representative text match score of a product is calculated.
|
|
9899
|
+
*
|
|
9900
|
+
* - `max_score (Default)`: In this mode, the products's representative score is simply the highest score from any single matching field. The field weights are used only as a tie-breaker if two products have the exact same highest score. This mode prioritizes the quality of the match in the single best-matching field.
|
|
9901
|
+
* - `max_weight`: This mode uses the score from the matching field that has the highest weight. This means a partial, lower-quality match on a heavily weighted field (e.g., name) can be prioritized over a perfect match on a lower-weighted field (e.g., description). This mode prioritizes matches in the most important fields, regardless of match quality.
|
|
9902
|
+
* - `sum_score`: This mode calculates a holistic score by summing the weighted scores from all matching fields. Its advantage is that it rewards products that match a query across multiple attributes. However, it carries the risk that a product with many weak, partial matches across several low-weighted fields could outrank a product with a single strong, perfect match in a high-weighted field.
|
|
9903
|
+
*
|
|
9904
|
+
*/
|
|
9905
|
+
type TextMatchType = "max_score" | "max_weight" | "sum_score";
|
|
9906
|
+
/**
|
|
9907
|
+
* Defines a boosting rule that assigns a score to products matching a specific field value.
|
|
9908
|
+
*/
|
|
9909
|
+
type SearchBoostRule = {
|
|
8547
9910
|
/**
|
|
8548
|
-
*
|
|
9911
|
+
* A filter expression used to identify a subset of products for boosting. This follows the standard filter_by syntax.
|
|
9912
|
+
*
|
|
9913
|
+
* It can be a simple condition like `meta.search.nodes.name:=\`Electronics\`` or complex like `meta.search.nodes.name:=\`Electronics\` && extensions.products(Details).brand:=Nike`.
|
|
9914
|
+
*
|
|
8549
9915
|
*/
|
|
8550
|
-
|
|
9916
|
+
condition: string;
|
|
8551
9917
|
/**
|
|
8552
|
-
*
|
|
9918
|
+
* A numerical value representing the boost intensity. Products matching the criteria are assigned this value. Higher weights will cause products to appear earlier in the results.
|
|
9919
|
+
*
|
|
9920
|
+
* **Impact of Weights:**
|
|
9921
|
+
* * **Boost (Positive):** Pushes products to the top.
|
|
9922
|
+
* * **Neutral (Zero):** No merchandising nudge — same result as products that match no clause. Useful with multiple clauses: add a narrower zero-weight condition to exempt a subset from a broader bury. Example: bury `brand:=Nike` at `-100`, exempt `brand:=Nike && is_featured:=true` at `0`.
|
|
9923
|
+
* * **Bury (Negative):** Pushes products to the bottom.
|
|
9924
|
+
*
|
|
9925
|
+
* **Rule Evaluation:** Within a rule, higher-weight matching clauses take precedence. Unmatched products use an implicit weight of `0`.
|
|
9926
|
+
*
|
|
8553
9927
|
*/
|
|
8554
|
-
|
|
8555
|
-
meta?: FileMeta;
|
|
8556
|
-
links?: FilesLinks;
|
|
8557
|
-
link?: FileLink;
|
|
9928
|
+
weight: number;
|
|
8558
9929
|
};
|
|
8559
|
-
|
|
9930
|
+
/**
|
|
9931
|
+
* Fixes a product at a one-based global search result position.
|
|
9932
|
+
*/
|
|
9933
|
+
type SearchPinRule = {
|
|
8560
9934
|
/**
|
|
8561
|
-
*
|
|
9935
|
+
* Product identifier to pin.
|
|
8562
9936
|
*/
|
|
8563
|
-
|
|
8564
|
-
/**
|
|
8565
|
-
* The date and time the file was created.
|
|
8566
|
-
*/
|
|
8567
|
-
created_at?: string;
|
|
8568
|
-
};
|
|
9937
|
+
product_id: string;
|
|
8569
9938
|
/**
|
|
8570
|
-
*
|
|
9939
|
+
* One-based global result position for the pinned product.
|
|
8571
9940
|
*/
|
|
8572
|
-
|
|
8573
|
-
/**
|
|
8574
|
-
* The width of the file.
|
|
8575
|
-
*/
|
|
8576
|
-
width?: number;
|
|
8577
|
-
/**
|
|
8578
|
-
* The height of the file.
|
|
8579
|
-
*/
|
|
8580
|
-
height?: number;
|
|
8581
|
-
};
|
|
9941
|
+
position: number;
|
|
8582
9942
|
};
|
|
8583
|
-
|
|
9943
|
+
/**
|
|
9944
|
+
* Excludes a product from matching search results.
|
|
9945
|
+
*/
|
|
9946
|
+
type SearchHideRule = {
|
|
8584
9947
|
/**
|
|
8585
|
-
*
|
|
9948
|
+
* Product identifier to hide.
|
|
8586
9949
|
*/
|
|
8587
|
-
|
|
8588
|
-
|
|
8589
|
-
|
|
8590
|
-
|
|
8591
|
-
|
|
8592
|
-
|
|
8593
|
-
|
|
8594
|
-
|
|
8595
|
-
|
|
8596
|
-
|
|
8597
|
-
* The current number of pages.
|
|
8598
|
-
*/
|
|
8599
|
-
current?: number;
|
|
8600
|
-
/**
|
|
8601
|
-
* The total number of records for the entire collection.
|
|
8602
|
-
*/
|
|
8603
|
-
total?: number;
|
|
8604
|
-
};
|
|
9950
|
+
product_id: string;
|
|
9951
|
+
};
|
|
9952
|
+
/**
|
|
9953
|
+
* Optional synonym tuning applied at search time. These settings control how synonym
|
|
9954
|
+
* matches are ranked and how query tokens are resolved against the synonym sets attached
|
|
9955
|
+
* to the search profile. All fields are optional; defaults are noted on each field.
|
|
9956
|
+
* They only have an observable effect when synonym sets are attached to the resolved profile.
|
|
9957
|
+
*
|
|
9958
|
+
*/
|
|
9959
|
+
type SynonymSettings = {
|
|
8605
9960
|
/**
|
|
8606
|
-
*
|
|
9961
|
+
* When true, results matched via a synonym are ranked below direct (non-synonym) matches. When false, synonym matches and direct matches are ranked equally.
|
|
9962
|
+
* Default: false
|
|
9963
|
+
*
|
|
8607
9964
|
*/
|
|
8608
|
-
|
|
8609
|
-
|
|
8610
|
-
|
|
8611
|
-
|
|
8612
|
-
|
|
8613
|
-
|
|
8614
|
-
|
|
9965
|
+
demote_synonym_match?: boolean;
|
|
9966
|
+
/**
|
|
9967
|
+
* When true, an incomplete (prefix) query token can resolve to a synonym, i.e. synonym
|
|
9968
|
+
* expansion is attempted on prefix tokens.
|
|
9969
|
+
*
|
|
9970
|
+
* **This is not the same as the `prefix` setting.** The `prefix` setting treats only the
|
|
9971
|
+
* **last** word of the query as a prefix; `synonym_resolution_allowed_on_prefix` applies
|
|
9972
|
+
* prefix matching at **every** token position when looking words up in the synonym sets —
|
|
9973
|
+
* there is no last-token special-casing.
|
|
9974
|
+
*
|
|
9975
|
+
* **Exact matches always win.** A query token that exactly equals a synonym key resolves
|
|
9976
|
+
* regardless of this flag; the prefix behavior only affects the fuzzy fallback for tokens
|
|
9977
|
+
* with no exact synonym-key match. It composes with
|
|
9978
|
+
* `number_of_typos_allowed_when_resolving_synonyms`, which governs typo tolerance during
|
|
9979
|
+
* the prefix/fuzzy lookup.
|
|
9980
|
+
*
|
|
9981
|
+
* Worked example (synonym keys `red`, `apple`, `apparel`):
|
|
9982
|
+
* - `red app`: `red` matches exactly; `app` prefix-matches both `apple` and `apparel` — both expand.
|
|
9983
|
+
* - `re app`: `re` prefix-matches `red` **and** `app` prefix-matches `apple`/`apparel` — both expand.
|
|
9984
|
+
* The regular `prefix` setting would only treat the last word (`app`) as a prefix; here every
|
|
9985
|
+
* position is prefix-matched.
|
|
9986
|
+
*
|
|
9987
|
+
* Default: false
|
|
9988
|
+
*
|
|
9989
|
+
*/
|
|
9990
|
+
synonym_resolution_allowed_on_prefix?: boolean;
|
|
9991
|
+
/**
|
|
9992
|
+
* Number of typos allowed when resolving synonyms. Enables fuzzy synonym matching
|
|
9993
|
+
* so that a misspelled query term can still trigger a synonym expansion for the
|
|
9994
|
+
* synonym sets attached to the search profile.
|
|
9995
|
+
* Accepted values: 0 (exact synonym match only, default), 1, or 2.
|
|
9996
|
+
*
|
|
9997
|
+
*/
|
|
9998
|
+
number_of_typos_allowed_when_resolving_synonyms?: number;
|
|
9999
|
+
} | null;
|
|
8615
10000
|
/**
|
|
8616
|
-
*
|
|
10001
|
+
* Controls whether compound words and multi-word phrases are treated as equivalent during search.
|
|
10002
|
+
* For example, a query for "nonstick" may also match "non stick", and vice versa.
|
|
10003
|
+
* - `fallback` (default): tries the original query form first; falls back to split/joined variants if results are insufficient.
|
|
10004
|
+
* - `always`: always generates both split and joined token variants alongside the original query.
|
|
10005
|
+
* - `off`: disables split/join token handling.
|
|
10006
|
+
*
|
|
8617
10007
|
*/
|
|
8618
|
-
type
|
|
10008
|
+
type SplitJoinTokens = "fallback" | "always" | "off";
|
|
10009
|
+
/**
|
|
10010
|
+
* Optional typo tolerance configuration applied at search time.
|
|
10011
|
+
* All fields are optional; defaults are noted on each field.
|
|
10012
|
+
*
|
|
10013
|
+
*/
|
|
10014
|
+
type TypoTolerance = {
|
|
10015
|
+
/**
|
|
10016
|
+
* Profile-level default for the maximum number of typographical errors
|
|
10017
|
+
* [Damerau-Levenshtein distance](https://en.wikipedia.org/wiki/Damerau%E2%80%93Levenshtein_distance) allowed when matching any field.
|
|
10018
|
+
* Accepted values: 0 (exact match only), 1, or 2.
|
|
10019
|
+
* Per-field `num_typos` values override this setting. If omitted, default of 2 applies.
|
|
10020
|
+
*
|
|
10021
|
+
* For example, a search request for "red appla" matches "red apple" with a `num_typos` of 1.
|
|
10022
|
+
*
|
|
10023
|
+
* **`num_typos` is an upper bound, not a guarantee.** The number of corrections actually
|
|
10024
|
+
* applied to a query token is also capped by its length via
|
|
10025
|
+
* `min_len_to_allow_single_character_correction` (default 4) and
|
|
10026
|
+
* `min_len_to_allow_two_character_correction` (default 7): a token shorter than the
|
|
10027
|
+
* single-character threshold gets no correction at all, and a token shorter than the
|
|
10028
|
+
* two-character threshold is corrected by at most one character — even when `num_typos` is 2.
|
|
10029
|
+
* See those two fields for details.
|
|
10030
|
+
*
|
|
10031
|
+
*/
|
|
10032
|
+
num_typos?: number;
|
|
8619
10033
|
/**
|
|
8620
|
-
*
|
|
10034
|
+
* Minimum query-token length required before a single-character typo correction is attempted. This works together with `num_typos`: a token shorter than this length receives no typo correction at all, regardless of `num_typos`. For example, when set to 4, a search for "appla" will match "apple", but a search for "apa" will not match "app" because the length of "apa" is 3.
|
|
10035
|
+
* Default: 4.
|
|
10036
|
+
*
|
|
8621
10037
|
*/
|
|
8622
|
-
|
|
10038
|
+
min_len_to_allow_single_character_correction?: number;
|
|
8623
10039
|
/**
|
|
8624
|
-
*
|
|
10040
|
+
* Minimum query-token length required before a two-character typo correction is attempted. This works together with `num_typos`: even when `num_typos` is 2, a token shorter than this length is corrected by at most one character (and a token shorter than `min_len_to_allow_single_character_correction` is not corrected at all). For example, with the default of 7, the 7-character query "monetar" can be corrected to "monitor" (two corrections), but a 6-character query with two mistakes cannot.
|
|
10041
|
+
* Default: 7
|
|
10042
|
+
*
|
|
8625
10043
|
*/
|
|
8626
|
-
|
|
10044
|
+
min_len_to_allow_two_character_correction?: number;
|
|
8627
10045
|
/**
|
|
8628
|
-
*
|
|
10046
|
+
* Typo-corrected query variations are only generated if the number of exact results
|
|
10047
|
+
* found is fewer than this value. Set to 0 to disable typo tolerance entirely.
|
|
10048
|
+
* For example, when set to 5 and the search result only has 3 results, the search engine will apply typo correction to try to return 5 or more results.
|
|
10049
|
+
*
|
|
10050
|
+
* Default: 1
|
|
10051
|
+
*
|
|
8629
10052
|
*/
|
|
8630
|
-
|
|
10053
|
+
typo_tokens_threshold?: number;
|
|
8631
10054
|
/**
|
|
8632
|
-
*
|
|
10055
|
+
* For multi-word queries, tokens are progressively dropped if the number of results
|
|
10056
|
+
* is fewer than this value. Set to 0 to disable token dropping.
|
|
10057
|
+
*
|
|
10058
|
+
* For example, when set to 5 and the search result only has 3 results for "red apple" search,
|
|
10059
|
+
* the search engine will drop the last token "apple" and find more results with just by searching for "red".
|
|
10060
|
+
*
|
|
10061
|
+
* Default: 1
|
|
10062
|
+
*
|
|
8633
10063
|
*/
|
|
8634
|
-
|
|
10064
|
+
drop_tokens_threshold?: number;
|
|
8635
10065
|
/**
|
|
8636
|
-
*
|
|
10066
|
+
* Controls the direction in which tokens are dropped from a multi-word query when
|
|
10067
|
+
* results fall below drop_tokens_threshold.
|
|
10068
|
+
* - `right_to_left` (default): drops tokens from the right end of the query first.
|
|
10069
|
+
* - `left_to_right`: drops tokens from the left end first.
|
|
10070
|
+
* - `both_sides:N`: drops from both ends, limited to queries of N tokens or fewer
|
|
10071
|
+
* (e.g. `both_sides:3` applies only to queries with 3 or fewer tokens).
|
|
10072
|
+
*
|
|
8637
10073
|
*/
|
|
8638
|
-
|
|
10074
|
+
drop_tokens_mode?: string;
|
|
8639
10075
|
/**
|
|
8640
|
-
*
|
|
10076
|
+
* When false, typo tolerance is disabled for query tokens that are purely numeric (every character is a digit, e.g. "98765"). Such a token must then match exactly.
|
|
10077
|
+
* Default: true
|
|
10078
|
+
*
|
|
8641
10079
|
*/
|
|
8642
|
-
|
|
8643
|
-
};
|
|
8644
|
-
/**
|
|
8645
|
-
* The publicly available URL for this file.
|
|
8646
|
-
*/
|
|
8647
|
-
type FileLink = {
|
|
10080
|
+
enable_typos_for_numerical_tokens?: boolean;
|
|
8648
10081
|
/**
|
|
8649
|
-
*
|
|
10082
|
+
* When false, typo tolerance is disabled for query tokens that contain at least one non-alphanumeric character
|
|
10083
|
+
* (any character outside `a-z`, `A-Z`, `0-9`), forcing such tokens to match exactly.
|
|
10084
|
+
* Useful for keeping product codes / SKUs precise.
|
|
10085
|
+
*
|
|
10086
|
+
* Tokens like `abc-123`, `abc-def`, `123-456`, and `v1.2.0` are affected;
|
|
10087
|
+
* a plain alphanumeric token like `abc123` is not.
|
|
10088
|
+
*
|
|
10089
|
+
* Note: the special character must be indexed on the field (via `symbols_to_index`);
|
|
10090
|
+
* otherwise the search engine removes the special characters from tokens
|
|
10091
|
+
* (e.g. a token like v1.2.0 becomes v120) and it no longer qualifies.
|
|
10092
|
+
*
|
|
10093
|
+
* Default: true
|
|
10094
|
+
*
|
|
8650
10095
|
*/
|
|
8651
|
-
|
|
8652
|
-
|
|
8653
|
-
|
|
8654
|
-
|
|
8655
|
-
|
|
10096
|
+
enable_typos_for_special_char_tokens?: boolean;
|
|
10097
|
+
/**
|
|
10098
|
+
* Controls whether compound words and multi-word phrases are treated as equivalent during search.
|
|
10099
|
+
* For example, a query for "nonstick" may also match "non stick", and vice versa.
|
|
10100
|
+
* - `fallback` (default): tries the original query form first; falls back to split/joined variants if results are insufficient.
|
|
10101
|
+
* - `always`: always generates both split and joined token variants alongside the original query.
|
|
10102
|
+
* - `off`: disables split/join token handling.
|
|
10103
|
+
*
|
|
10104
|
+
*/
|
|
10105
|
+
split_join_tokens?: "fallback" | "always" | "off";
|
|
10106
|
+
} | null;
|
|
8656
10107
|
/**
|
|
8657
|
-
*
|
|
10108
|
+
* Represents the type of object being returned. Always `catalog_search_profile`.
|
|
8658
10109
|
*/
|
|
8659
|
-
type
|
|
10110
|
+
type SearchProfileType = "catalog_search_profile";
|
|
10111
|
+
type ListSearchIndexesResponse = {
|
|
10112
|
+
data: Array<SearchIndex>;
|
|
10113
|
+
meta: ListResponseMeta;
|
|
10114
|
+
};
|
|
10115
|
+
type SearchIndex = {
|
|
8660
10116
|
/**
|
|
8661
|
-
*
|
|
10117
|
+
* The unique identifier for the search index.
|
|
8662
10118
|
*/
|
|
8663
|
-
|
|
10119
|
+
id: string;
|
|
10120
|
+
type: SearchIndexType;
|
|
10121
|
+
meta: SearchIndexMeta;
|
|
8664
10122
|
};
|
|
8665
|
-
type
|
|
8666
|
-
type FilesError = {
|
|
10123
|
+
type SearchIndexMeta = {
|
|
8667
10124
|
/**
|
|
8668
|
-
* The
|
|
10125
|
+
* The ID of the catalog.
|
|
8669
10126
|
*/
|
|
8670
|
-
|
|
10127
|
+
catalog_id: string;
|
|
8671
10128
|
/**
|
|
8672
|
-
*
|
|
10129
|
+
* The ID of the catalog release.
|
|
8673
10130
|
*/
|
|
8674
|
-
|
|
10131
|
+
release_id: string;
|
|
8675
10132
|
/**
|
|
8676
|
-
*
|
|
10133
|
+
* Whether the search index is out of sync and needs to re-indexed.
|
|
8677
10134
|
*/
|
|
8678
|
-
|
|
10135
|
+
out_of_sync: boolean;
|
|
10136
|
+
owner: ResourceOwner;
|
|
10137
|
+
};
|
|
10138
|
+
/**
|
|
10139
|
+
* Represents the type of object being returned. Always `catalog_search_index`.
|
|
10140
|
+
*/
|
|
10141
|
+
type SearchIndexType = "catalog_search_index";
|
|
10142
|
+
/**
|
|
10143
|
+
* Specifies which fields to use for generating facets in search results. See [faceting](/guides/How-To/Catalogs/Search/faceting) for more details.
|
|
10144
|
+
*/
|
|
10145
|
+
type FacetByField = string;
|
|
10146
|
+
/**
|
|
10147
|
+
* Applies conditions to narrow down search results based on specific field values. See [filtering](/guides/How-To/Catalogs/Search/filtering) for more details.
|
|
10148
|
+
*/
|
|
10149
|
+
type FilterByField = string;
|
|
10150
|
+
/**
|
|
10151
|
+
* Orders search results by specified fields. See [sorting](/guides/How-To/Catalogs/Search/sorting) for more details.
|
|
10152
|
+
*/
|
|
10153
|
+
type SortByField = string;
|
|
10154
|
+
/**
|
|
10155
|
+
* The resource owner, either `organization` or `store`.
|
|
10156
|
+
*/
|
|
10157
|
+
type ResourceOwner = "organization" | "store";
|
|
10158
|
+
type ListResponseMeta = {
|
|
10159
|
+
results: ListResponseMetaResults;
|
|
10160
|
+
};
|
|
10161
|
+
/**
|
|
10162
|
+
* Contains the results for the entire collection.
|
|
10163
|
+
*/
|
|
10164
|
+
type ListResponseMetaResults = {
|
|
8679
10165
|
/**
|
|
8680
|
-
*
|
|
10166
|
+
* Total number of results for the entire collection.
|
|
8681
10167
|
*/
|
|
8682
|
-
|
|
10168
|
+
total: number;
|
|
10169
|
+
};
|
|
10170
|
+
type CatalogSearchJob = {
|
|
8683
10171
|
/**
|
|
8684
|
-
*
|
|
10172
|
+
* The unique identifier for the job.
|
|
8685
10173
|
*/
|
|
8686
|
-
|
|
8687
|
-
|
|
8688
|
-
|
|
10174
|
+
id: string;
|
|
10175
|
+
/**
|
|
10176
|
+
* The type of the resource object.
|
|
10177
|
+
*/
|
|
10178
|
+
type: "job";
|
|
10179
|
+
/**
|
|
10180
|
+
* The attributes of the job.
|
|
10181
|
+
*/
|
|
10182
|
+
attributes: CatalogSearchJobAttributes;
|
|
10183
|
+
meta?: CatalogSearchJobMeta;
|
|
8689
10184
|
};
|
|
8690
|
-
|
|
8691
|
-
* An autocomplete suggestion with query frequency information.
|
|
8692
|
-
*/
|
|
8693
|
-
type AutocompleteResponse = {
|
|
10185
|
+
type CatalogSearchJobAttributes = {
|
|
8694
10186
|
/**
|
|
8695
|
-
*
|
|
10187
|
+
* The status of the job.
|
|
8696
10188
|
*/
|
|
8697
|
-
|
|
10189
|
+
status: "pending" | "processing" | "complete" | "failed";
|
|
8698
10190
|
/**
|
|
8699
|
-
* The
|
|
10191
|
+
* The ID of the catalog.
|
|
8700
10192
|
*/
|
|
8701
|
-
|
|
10193
|
+
catalog_id?: string;
|
|
8702
10194
|
/**
|
|
8703
|
-
* The
|
|
10195
|
+
* The ID of the catalog release.
|
|
8704
10196
|
*/
|
|
8705
|
-
|
|
8706
|
-
};
|
|
8707
|
-
type MultiSearchRequest = {
|
|
8708
|
-
searches: Array<SearchQuery>;
|
|
8709
|
-
};
|
|
8710
|
-
type SearchQuery = {
|
|
10197
|
+
catalog_release_id?: string;
|
|
8711
10198
|
/**
|
|
8712
|
-
*
|
|
10199
|
+
* The type of the job.
|
|
8713
10200
|
*/
|
|
8714
|
-
type
|
|
8715
|
-
highlight_full_fields?: string;
|
|
8716
|
-
q?: string;
|
|
8717
|
-
facet_by?: string;
|
|
8718
|
-
filter_by?: string;
|
|
8719
|
-
max_facet_values?: number;
|
|
8720
|
-
page?: number;
|
|
8721
|
-
per_page?: number;
|
|
8722
|
-
};
|
|
8723
|
-
type MultiSearchResponse = {
|
|
8724
|
-
results?: Array<SearchResult>;
|
|
10201
|
+
type: "index-release" | "delete-release" | "reindex-tenant-releases";
|
|
8725
10202
|
};
|
|
8726
|
-
|
|
10203
|
+
/**
|
|
10204
|
+
* Meta information of the job
|
|
10205
|
+
*/
|
|
10206
|
+
type CatalogSearchJobMeta = {
|
|
8727
10207
|
/**
|
|
8728
|
-
*
|
|
10208
|
+
* Results of the job
|
|
8729
10209
|
*/
|
|
8730
|
-
|
|
8731
|
-
facet_counts?: Array<FacetCount>;
|
|
8732
|
-
found?: number;
|
|
8733
|
-
hits?: Array<Hit>;
|
|
8734
|
-
out_of?: number;
|
|
8735
|
-
page?: number;
|
|
8736
|
-
request_params?: {
|
|
8737
|
-
[key: string]: unknown;
|
|
8738
|
-
};
|
|
8739
|
-
search_cutoff?: boolean;
|
|
8740
|
-
search_time_ms?: number;
|
|
8741
|
-
};
|
|
8742
|
-
type FacetCount = {
|
|
8743
|
-
counts?: Array<FacetValue>;
|
|
8744
|
-
field_name?: string;
|
|
8745
|
-
sampled?: boolean;
|
|
8746
|
-
stats?: {
|
|
8747
|
-
[key: string]: unknown;
|
|
8748
|
-
};
|
|
8749
|
-
};
|
|
8750
|
-
type FacetValue = {
|
|
8751
|
-
count?: number;
|
|
8752
|
-
highlighted?: string;
|
|
8753
|
-
value?: string;
|
|
8754
|
-
};
|
|
8755
|
-
type Hit = {
|
|
10210
|
+
results?: Array<JobMetaResult>;
|
|
8756
10211
|
/**
|
|
8757
|
-
*
|
|
10212
|
+
* Errors occurred during the job
|
|
8758
10213
|
*/
|
|
8759
|
-
|
|
8760
|
-
highlight?: {
|
|
8761
|
-
[key: string]: unknown;
|
|
8762
|
-
};
|
|
8763
|
-
highlights?: Array<{
|
|
8764
|
-
[key: string]: unknown;
|
|
8765
|
-
}>;
|
|
10214
|
+
errors?: Array<JobMetaError>;
|
|
8766
10215
|
};
|
|
8767
10216
|
/**
|
|
8768
10217
|
* A product in a catalog with the following attributes.
|
|
@@ -8959,6 +10408,18 @@ type IncludeAccount = string;
|
|
|
8959
10408
|
* The ID of the Account Tag.
|
|
8960
10409
|
*/
|
|
8961
10410
|
type AccountTagId = string;
|
|
10411
|
+
/**
|
|
10412
|
+
* The number of records per page.
|
|
10413
|
+
*/
|
|
10414
|
+
type AuthenticationRealmspageLimit = BigInt;
|
|
10415
|
+
/**
|
|
10416
|
+
* The number of records to offset the results by.
|
|
10417
|
+
*/
|
|
10418
|
+
type AuthenticationRealmspageOffset = BigInt;
|
|
10419
|
+
/**
|
|
10420
|
+
* Specifies the filter attributes.
|
|
10421
|
+
*/
|
|
10422
|
+
type AuthenticationRealmsfilter = string;
|
|
8962
10423
|
/**
|
|
8963
10424
|
*
|
|
8964
10425
|
* Filtering is available for this endpoint. See [Filtering](/docs/api/pxm/files/get-all-files#filtering).
|
|
@@ -8973,6 +10434,71 @@ type FilespageOffset = string;
|
|
|
8973
10434
|
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8974
10435
|
*/
|
|
8975
10436
|
type FilespageLimit = string;
|
|
10437
|
+
/**
|
|
10438
|
+
* The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).
|
|
10439
|
+
*/
|
|
10440
|
+
type CatalogSearchacceptLanguage = string;
|
|
10441
|
+
/**
|
|
10442
|
+
* Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.
|
|
10443
|
+
*/
|
|
10444
|
+
type CatalogSearchpricebookIdsForPriceSegmentationPreview = Array<string>;
|
|
10445
|
+
/**
|
|
10446
|
+
* Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.
|
|
10447
|
+
*/
|
|
10448
|
+
type CatalogSearchpricebookIdsOfAvailablePricesToShow = Array<string>;
|
|
10449
|
+
/**
|
|
10450
|
+
* The currency used to resolve product price. If not supplied, the organization/store default currency is used.
|
|
10451
|
+
*/
|
|
10452
|
+
type Currency = string;
|
|
10453
|
+
/**
|
|
10454
|
+
* Using the include parameter, you can retrieve top-level resources.
|
|
10455
|
+
*
|
|
10456
|
+
* - Files or main image. For example, `include=files,main_image`.
|
|
10457
|
+
* - Component product data. For example, `include=component_products`.
|
|
10458
|
+
* - Key attribute data, such as SKU or slug.
|
|
10459
|
+
*
|
|
10460
|
+
*/
|
|
10461
|
+
type ProductsInclude = Array<"files" | "main_image" | "component_products">;
|
|
10462
|
+
/**
|
|
10463
|
+
* The slug of the search profile to use for this search.
|
|
10464
|
+
*
|
|
10465
|
+
* On shopper search (`/pcm/catalog/search`, `/pcm/catalog/multi-search`): used only when the matched catalog rule has no valid `search_profile_slug`. When the catalog rule carries a non-blank slug that resolves to a profile, that rule profile is used and this query parameter is silently ignored. Blank or whitespace-only values are treated as omitted. An invalid non-blank slug returns 400 with detail `Search profile '{slug}' not found`.
|
|
10466
|
+
*
|
|
10467
|
+
* On admin search (`/pcm/catalogs/{catalog_id}/releases/{release_id}/…`): catalog rule profiles are not applied. Resolution is this query parameter, then the tenant default profile, then the built-in default.
|
|
10468
|
+
*
|
|
10469
|
+
* Omit this parameter to use the tenant default profile (or the built-in default when no tenant default exists). The applied slug is returned in the `EP-Search-Profile` response header.
|
|
10470
|
+
*
|
|
10471
|
+
*/
|
|
10472
|
+
type SearchProfile2 = string;
|
|
10473
|
+
/**
|
|
10474
|
+
* Specifies which fields to use for generating facets in search results. See [faceting](/guides/How-To/Catalogs/Search/faceting) for more details.
|
|
10475
|
+
*/
|
|
10476
|
+
type SearchQueryParamFacetBy = string;
|
|
10477
|
+
/**
|
|
10478
|
+
* Applies conditions to narrow down search results based on specific field values. See [filtering](/guides/How-To/Catalogs/Search/filtering) for more details.
|
|
10479
|
+
*/
|
|
10480
|
+
type SearchQueryParamFilterBy = string;
|
|
10481
|
+
/**
|
|
10482
|
+
* Comma-separated list of fields to highlight
|
|
10483
|
+
*/
|
|
10484
|
+
type SearchQueryParamHighlightFullFields = string;
|
|
10485
|
+
/**
|
|
10486
|
+
* Maximum number of facet values to return
|
|
10487
|
+
*/
|
|
10488
|
+
type SearchQueryParamMaxFacetValues = number;
|
|
10489
|
+
/**
|
|
10490
|
+
* Search query
|
|
10491
|
+
*/
|
|
10492
|
+
type SearchQueryParamQ = string;
|
|
10493
|
+
/**
|
|
10494
|
+
* Orders search results by specified fields. See [sorting](/guides/How-To/Catalogs/Search/sorting) for more details.
|
|
10495
|
+
*/
|
|
10496
|
+
type SearchQueryParamSortBy = string;
|
|
10497
|
+
/**
|
|
10498
|
+
* Type of search operation to perform
|
|
10499
|
+
*/
|
|
10500
|
+
type SearchQueryParamType = "search" | "autocomplete";
|
|
10501
|
+
type SimulatedShopperDate = string;
|
|
8976
10502
|
/**
|
|
8977
10503
|
* The bundle configuration.
|
|
8978
10504
|
*/
|
|
@@ -14383,47 +15909,102 @@ type PostV2AccountMembersTokensResponses = {
|
|
|
14383
15909
|
};
|
|
14384
15910
|
type PostV2AccountMembersTokensResponse = PostV2AccountMembersTokensResponses[keyof PostV2AccountMembersTokensResponses];
|
|
14385
15911
|
type CreateOneTimePasswordTokenRequestData = {
|
|
14386
|
-
|
|
14387
|
-
|
|
14388
|
-
|
|
14389
|
-
body: OneTimePasswordTokenRequest;
|
|
15912
|
+
body: {
|
|
15913
|
+
data: OneTimePasswordTokenRequestInput;
|
|
15914
|
+
};
|
|
14390
15915
|
path: {
|
|
15916
|
+
/**
|
|
15917
|
+
* The ID of the authentication realm.
|
|
15918
|
+
*/
|
|
14391
15919
|
realmId: string;
|
|
14392
|
-
|
|
15920
|
+
/**
|
|
15921
|
+
* The ID of the password profile.
|
|
15922
|
+
*/
|
|
15923
|
+
profileId: string;
|
|
14393
15924
|
};
|
|
14394
15925
|
query?: never;
|
|
14395
|
-
url: "/v2/authentication-realms/{realmId}/password-profiles/{
|
|
15926
|
+
url: "/v2/authentication-realms/{realmId}/password-profiles/{profileId}/one-time-password-token-request";
|
|
15927
|
+
};
|
|
15928
|
+
type CreateOneTimePasswordTokenRequestErrors = {
|
|
15929
|
+
/**
|
|
15930
|
+
* Bad Request
|
|
15931
|
+
*/
|
|
15932
|
+
400: AuthenticationRealmsErrorResponse;
|
|
15933
|
+
/**
|
|
15934
|
+
* Not Found
|
|
15935
|
+
*/
|
|
15936
|
+
404: AuthenticationRealmsErrorResponse;
|
|
15937
|
+
/**
|
|
15938
|
+
* Unprocessable Entity
|
|
15939
|
+
*/
|
|
15940
|
+
422: AuthenticationRealmsErrorResponse;
|
|
15941
|
+
/**
|
|
15942
|
+
* Internal server error.
|
|
15943
|
+
*/
|
|
15944
|
+
500: AuthenticationRealmsErrorResponse;
|
|
14396
15945
|
};
|
|
15946
|
+
type CreateOneTimePasswordTokenRequestError = CreateOneTimePasswordTokenRequestErrors[keyof CreateOneTimePasswordTokenRequestErrors];
|
|
14397
15947
|
type CreateOneTimePasswordTokenRequestResponses = {
|
|
14398
15948
|
/**
|
|
14399
|
-
*
|
|
15949
|
+
* Created
|
|
15950
|
+
*/
|
|
15951
|
+
201: {
|
|
15952
|
+
data?: OneTimePasswordTokenRequestResponse;
|
|
15953
|
+
};
|
|
15954
|
+
/**
|
|
15955
|
+
* Accepted
|
|
14400
15956
|
*/
|
|
14401
15957
|
202: unknown;
|
|
14402
15958
|
};
|
|
15959
|
+
type CreateOneTimePasswordTokenRequestResponse = CreateOneTimePasswordTokenRequestResponses[keyof CreateOneTimePasswordTokenRequestResponses];
|
|
14403
15960
|
type UpdatePasswordProfileInfoData = {
|
|
14404
|
-
|
|
14405
|
-
|
|
14406
|
-
|
|
14407
|
-
body: PasswordProfileInfoUpdateRequestWrapper;
|
|
15961
|
+
body: {
|
|
15962
|
+
data: UserAuthenticationPasswordProfileInfoUpdateInput;
|
|
15963
|
+
};
|
|
14408
15964
|
path: {
|
|
15965
|
+
/**
|
|
15966
|
+
* The ID of the authentication realm.
|
|
15967
|
+
*/
|
|
14409
15968
|
realmId: string;
|
|
14410
|
-
|
|
14411
|
-
|
|
15969
|
+
/**
|
|
15970
|
+
* The ID of the user authentication info.
|
|
15971
|
+
*/
|
|
15972
|
+
userAuthInfoId: string;
|
|
15973
|
+
/**
|
|
15974
|
+
* The ID of the password profile info.
|
|
15975
|
+
*/
|
|
15976
|
+
passwordProfileInfoId: string;
|
|
14412
15977
|
};
|
|
14413
15978
|
query?: never;
|
|
14414
|
-
url: "/v2/authentication-realms/{realmId}/user-authentication-info/{
|
|
15979
|
+
url: "/v2/authentication-realms/{realmId}/user-authentication-info/{userAuthInfoId}/user-authentication-password-profile-info/{passwordProfileInfoId}";
|
|
14415
15980
|
};
|
|
14416
15981
|
type UpdatePasswordProfileInfoErrors = {
|
|
14417
15982
|
/**
|
|
14418
|
-
*
|
|
15983
|
+
* Bad Request
|
|
15984
|
+
*/
|
|
15985
|
+
400: AuthenticationRealmsErrorResponse;
|
|
15986
|
+
/**
|
|
15987
|
+
* Not Found
|
|
15988
|
+
*/
|
|
15989
|
+
404: AuthenticationRealmsErrorResponse;
|
|
15990
|
+
/**
|
|
15991
|
+
* Unprocessable Entity
|
|
15992
|
+
*/
|
|
15993
|
+
422: AuthenticationRealmsErrorResponse;
|
|
15994
|
+
/**
|
|
15995
|
+
* Internal server error.
|
|
14419
15996
|
*/
|
|
14420
|
-
|
|
15997
|
+
500: AuthenticationRealmsErrorResponse;
|
|
14421
15998
|
};
|
|
15999
|
+
type UpdatePasswordProfileInfoError = UpdatePasswordProfileInfoErrors[keyof UpdatePasswordProfileInfoErrors];
|
|
14422
16000
|
type UpdatePasswordProfileInfoResponses = {
|
|
14423
16001
|
/**
|
|
14424
|
-
*
|
|
16002
|
+
* OK
|
|
14425
16003
|
*/
|
|
14426
|
-
200:
|
|
16004
|
+
200: {
|
|
16005
|
+
data?: UserAuthenticationPasswordProfileInfoResponse;
|
|
16006
|
+
links?: AuthenticationRealmsSelfLink;
|
|
16007
|
+
};
|
|
14427
16008
|
};
|
|
14428
16009
|
type UpdatePasswordProfileInfoResponse = UpdatePasswordProfileInfoResponses[keyof UpdatePasswordProfileInfoResponses];
|
|
14429
16010
|
type GetAllCurrenciesData = {
|
|
@@ -14582,6 +16163,11 @@ type PostMultiSearchData = {
|
|
|
14582
16163
|
* Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
|
|
14583
16164
|
*/
|
|
14584
16165
|
"EP-Context-Tag"?: string;
|
|
16166
|
+
/**
|
|
16167
|
+
* The currency used to resolve product price. If not supplied, the organization/store default currency is used.
|
|
16168
|
+
*/
|
|
16169
|
+
"x-moltin-currency"?: string;
|
|
16170
|
+
"EP-Simulated-Shopper-Date"?: string;
|
|
14585
16171
|
};
|
|
14586
16172
|
path?: never;
|
|
14587
16173
|
query?: {
|
|
@@ -14595,15 +16181,18 @@ type PostMultiSearchData = {
|
|
|
14595
16181
|
*/
|
|
14596
16182
|
include?: Array<"files" | "main_image" | "component_products">;
|
|
14597
16183
|
/**
|
|
14598
|
-
* The
|
|
14599
|
-
|
|
14600
|
-
|
|
14601
|
-
|
|
14602
|
-
*
|
|
16184
|
+
* The slug of the search profile to use for this search.
|
|
16185
|
+
*
|
|
16186
|
+
* On shopper search (`/pcm/catalog/search`, `/pcm/catalog/multi-search`): used only when the matched catalog rule has no valid `search_profile_slug`. When the catalog rule carries a non-blank slug that resolves to a profile, that rule profile is used and this query parameter is silently ignored. Blank or whitespace-only values are treated as omitted. An invalid non-blank slug returns 400 with detail `Search profile '{slug}' not found`.
|
|
16187
|
+
*
|
|
16188
|
+
* On admin search (`/pcm/catalogs/{catalog_id}/releases/{release_id}/…`): catalog rule profiles are not applied. Resolution is this query parameter, then the tenant default profile, then the built-in default.
|
|
16189
|
+
*
|
|
16190
|
+
* Omit this parameter to use the tenant default profile (or the built-in default when no tenant default exists). The applied slug is returned in the `EP-Search-Profile` response header.
|
|
16191
|
+
*
|
|
14603
16192
|
*/
|
|
14604
|
-
|
|
16193
|
+
search_profile?: string;
|
|
14605
16194
|
};
|
|
14606
|
-
url: "/catalog/multi-search";
|
|
16195
|
+
url: "/pcm/catalog/multi-search";
|
|
14607
16196
|
};
|
|
14608
16197
|
type PostMultiSearchErrors = {
|
|
14609
16198
|
/**
|
|
@@ -14624,4 +16213,4 @@ type PostMultiSearchResponses = {
|
|
|
14624
16213
|
};
|
|
14625
16214
|
type PostMultiSearchResponse = PostMultiSearchResponses[keyof PostMultiSearchResponses];
|
|
14626
16215
|
|
|
14627
|
-
export type { AcceptLanguage, AccessTokenRequest, AccessTokenResponse, Account, AccountAddressResponse, AccountAddressesError, AccountAddressesErrorResponse, AccountAddressesMetaTimestamps, AccountAuthenticationSettings, AccountAuthenticationSettingsResponse, AccountCheckout, AccountManagementAuthenticationToken, AccountManagementAuthenticationTokenResponse, AccountManagementError, AccountManagementErrorResponse, AccountManagementMetaTimestamps, AccountMember, AccountMemberResponse, AccountMemberSelfManagement, AccountMembership, AccountMembershipResponse, AccountMembershipResponseUsingAccountMemberId, AccountMembershipSettings, AccountResponse, AccountTag, AccountTagId, AccountTagResponse, AccountTagsRelationshipIdentifier, AccountTagsRelationshipResponse, Action, ActivePlan, ActivePricingOption, AddAccountTagsOnAccount, AddAllOrNothingOptionsObject, AddCustomDiscountToCartItemData, AddCustomDiscountToCartItemError, AddCustomDiscountToCartItemErrors, AddCustomDiscountToCartItemResponse, AddCustomDiscountToCartItemResponses, AddTaxItemToCartData, AddTaxItemToCartError, AddTaxItemToCartErrors, AddTaxItemToCartItemComponentData, AddTaxItemToCartItemComponentError, AddTaxItemToCartItemComponentErrors, AddTaxItemToCartItemComponentResponse, AddTaxItemToCartItemComponentResponses, AddTaxItemToCartResponse, AddTaxItemToCartResponses, Address, AddressCommon, AddressResponse, AddressWithCounty, AddressWithRegion, AlternativePrices, Amount, AnonymizeOrdersData, AnonymizeOrdersError, AnonymizeOrdersErrors, AnonymizeOrdersResponse, AnonymizeOrdersResponses, AuthenticationRealm, AuthenticationRealmListResponse, AuthenticationRealmResponse, AuthenticationRealmUpdateRequest, AutocompleteResponse, AvailablePrices, BaseCartResponse, BaseItemObjectData, BillingAddress, BillingIntervalType, BillingRunJobAttributes, BillingRunReport, BuildOffering, BuildSubscription, BuildSubscriptionOrder, BulkAddCustomDiscountsToCartData, BulkAddCustomDiscountsToCartError, BulkAddCustomDiscountsToCartErrors, BulkAddCustomDiscountsToCartResponse, BulkAddCustomDiscountsToCartResponses, BulkAddItemsRequest, BulkAddTaxItemsToCartData, BulkAddTaxItemsToCartError, BulkAddTaxItemsToCartErrors, BulkAddTaxItemsToCartResponse, BulkAddTaxItemsToCartResponses, BulkDeleteCustomDiscountsFromCartData, BulkDeleteCustomDiscountsFromCartResponse, BulkDeleteCustomDiscountsFromCartResponses, BulkDeleteTaxItemsFromCartData, BulkDeleteTaxItemsFromCartError, BulkDeleteTaxItemsFromCartErrors, BulkDeleteTaxItemsFromCartResponse, BulkDeleteTaxItemsFromCartResponses, BulkUpdateCartsItems, BulkUpdateCartsItemsCommon, BulkUpdateCartsItemsWithCustomInputs, BulkUpdateCartsItemsWithQuantity, BulkUpdateCartsItemsWithShippingGroup, BulkUpdateItemsInCartData, BulkUpdateItemsInCartError, BulkUpdateItemsInCartErrors, BulkUpdateItemsInCartResponse, BulkUpdateItemsInCartResponses, BundleConfiguration, BundleConfigurationData, BundleConfigurationData2, CancelATransactionData, CancelATransactionError, CancelATransactionErrors, CancelATransactionResponse, CancelATransactionResponses, CaptureATransactionData, CaptureATransactionError, CaptureATransactionErrors, CaptureATransactionResponse, CaptureATransactionResponses, CaptureMechanism, CartCheckoutFilter, CartCheckoutLimit, CartCheckoutOffset, CartCheckoutTimestamps, CartCollectionResponse, CartContact, CartEntityResponse, CartInclude, CartIncluded, CartIncludedPromotion, CartItemBulkCustomDiscountObject, CartItemCollectionResponse, CartItemFormattedPriceData, CartItemObject, CartItemObjectData, CartItemObjectRequest, CartItemRelationship, CartItemResponse, CartItemTaxesEntityResponse, CartItemsResponse, CartMergeObject, CartMergeObjectRequest, CartPaymentUpdate, CartResponse, CartTimestamps, CartsBulkCustomDiscounts, CartsBulkCustomDiscountsCollectionResponse, CartsBulkCustomDiscountsResponse, CartsBulkTaxes, CartsCustomDiscountsCollectionResponse, CartsCustomDiscountsEntityRequest, CartsCustomDiscountsEntityResponse, CartsCustomDiscountsObject, CartsCustomDiscountsResponseObject, CartsItemsTaxesCommon, CartsItemsTaxesObject, CartsItemsTaxesWithAmount, CartsItemsTaxesWithRate, CartsRelationshipsAccountsData, CartsRelationshipsCustomersData, CartsRequest, CartsResponse, Catalog, CatalogCreateData, CatalogData, CatalogListData, CatalogReleaseCreateData, CatalogRuleValidatorRequest, CatalogSearchError, CatalogSearchErrorResponse, CatalogSearchProduct, CatalogUpdateData, ChangeState, Channel, CheckoutApiData, CheckoutApiError, CheckoutApiErrors, CheckoutApiResponse, CheckoutApiResponses, ComponentProduct, ComponentProductOption, ComponentProductsRelationship, Components, CondensedPromotionResponse, ConfigureByContextProductData, ConfigureByContextProductError, ConfigureByContextProductErrors, ConfigureByContextProductResponse, ConfigureByContextProductResponses, ConfirmOrderData, ConfirmOrderError, ConfirmOrderErrors, ConfirmOrderResponse, ConfirmOrderResponses, ConfirmPaymentData, ConfirmPaymentError, ConfirmPaymentErrors, ConfirmPaymentResponse, ConfirmPaymentResponses, Contact, CreateACartData, CreateACartError, CreateACartErrors, CreateACartResponse, CreateACartResponses, CreateAccountCartAssociationData, CreateAccountCartAssociationError, CreateAccountCartAssociationErrors, CreateAccountCartAssociationResponse, CreateAccountCartAssociationResponses, CreateAnAccessTokenData, CreateAnAccessTokenError, CreateAnAccessTokenErrors, CreateAnAccessTokenResponse, CreateAnAccessTokenResponses, CreateCartPaymentIntentData, CreateCartPaymentIntentResponse, CreateCartPaymentIntentResponses, CreateCatalogData, CreateCatalogError, CreateCatalogErrors, CreateCatalogResponse, CreateCatalogResponses, CreateCustomerCartAssociationData, CreateCustomerCartAssociationError, CreateCustomerCartAssociationErrors, CreateCustomerCartAssociationResponse, CreateCustomerCartAssociationResponses, CreateInvoicePaymentRefund, CreateOneTimePasswordTokenRequestData, CreateOneTimePasswordTokenRequestResponses, CreateOrderShippingGroupData, CreateOrderShippingGroupError, CreateOrderShippingGroupErrors, CreateOrderShippingGroupResponse, CreateOrderShippingGroupResponses, CreatePaymentAuthority, CreatePaymentAuthorityAuthorizeNet, CreatePaymentAuthorityEpPayments, CreatePaymentAuthorityStripe, CreateRuleData, CreateRuleError, CreateRuleErrors, CreateRuleResponse, CreateRuleResponses, CreateShippingGroupData, CreateShippingGroupError, CreateShippingGroupErrors, CreateShippingGroupRequest, CreateShippingGroupResponse, CreateShippingGroupResponses, CreateSubscriptionStateData, CreateSubscriptionStateError, CreateSubscriptionStateErrors, CreateSubscriptionStateResponse, CreateSubscriptionStateResponses, CreationStatus, Currencies, CurrencyIdentifier, CustomAttributes, CustomDiscountRelationshipsCartItemRequest, CustomDiscountResponse, CustomInput, CustomInputValidationRule, CustomInputValidationRuleOptions, CustomInputs, CustomItemCartObject, CustomItemObject, CustomItemObjectData, CustomRelationship, CustomRelationshipLinks, Customer, CustomerCheckout, DataAdyenPayment, DataAuthorizeNetPayment, DataBasePayments, DataBraintreePayment, DataCardConnectPayment, DataCreateCurrencies, DataCyberSourcePayment, DataManualPayment, DataPayPalExpressCheckoutPayment, DataPaymentObject, DataStripeConnectPayment, DataStripePayment, DataStripePaymentIntentsPayment, DataUpdateCurrencies, DeleteACartData, DeleteACartError, DeleteACartErrors, DeleteACartItemData, DeleteACartItemResponse, DeleteACartItemResponses, DeleteACartResponse, DeleteACartResponses, DeleteAPromotionViaPromotionCodeData, DeleteAPromotionViaPromotionCodeResponse, DeleteAPromotionViaPromotionCodeResponses, DeleteATaxItemData, DeleteATaxItemResponse, DeleteATaxItemResponses, DeleteAccountCartAssociationData, DeleteAccountCartAssociationError, DeleteAccountCartAssociationErrors, DeleteAccountCartAssociationResponse, DeleteAccountCartAssociationResponses, DeleteAllCartItemsData, DeleteAllCartItemsError, DeleteAllCartItemsErrors, DeleteAllCartItemsResponse, DeleteAllCartItemsResponses, DeleteCartShippingGroupData, DeleteCartShippingGroupError, DeleteCartShippingGroupErrors, DeleteCartShippingGroupResponse, DeleteCartShippingGroupResponses, DeleteCatalogByIdData, DeleteCatalogByIdError, DeleteCatalogByIdErrors, DeleteCatalogByIdResponse, DeleteCatalogByIdResponses, DeleteCustomDiscountFromCartData, DeleteCustomDiscountFromCartItemData, DeleteCustomDiscountFromCartItemResponse, DeleteCustomDiscountFromCartItemResponses, DeleteCustomDiscountFromCartResponse, DeleteCustomDiscountFromCartResponses, DeleteCustomerCartAssociationData, DeleteCustomerCartAssociationError, DeleteCustomerCartAssociationErrors, DeleteCustomerCartAssociationResponse, DeleteCustomerCartAssociationResponses, DeleteReleaseByIdData, DeleteReleaseByIdError, DeleteReleaseByIdErrors, DeleteReleaseByIdResponse, DeleteReleaseByIdResponses, DeleteReleasesData, DeleteReleasesError, DeleteReleasesErrors, DeleteReleasesResponse, DeleteReleasesResponses, DeleteRuleByIdData, DeleteRuleByIdError, DeleteRuleByIdErrors, DeleteRuleByIdResponse, DeleteRuleByIdResponses, DeleteTaxItemFromCartItemComponentData, DeleteTaxItemFromCartItemComponentError, DeleteTaxItemFromCartItemComponentErrors, DeleteTaxItemFromCartItemComponentResponse, DeleteTaxItemFromCartItemComponentResponses, DeleteV2AccountAddressData, DeleteV2AccountAddressError, DeleteV2AccountAddressErrors, DeleteV2AccountAddressResponse, DeleteV2AccountAddressResponses, DeliveryEstimate, DiffListData, Discount, DiscountData, DiscountFormattedPriceData, DiscountSettings, Discounts, DisplayPrice, DisplayPrice2, DunningRule, DunningRuleAttributes, DunningRuleCreate, DunningRuleMeta, DunningRuleUpdate, DunningRuleUpdateAttributes, ElasticPathFile, ElasticPathPaymentsPoweredByStripePayment, EmbeddedOfferingPlanExtraAttributes, EndBehavior, EpGeolocation, Error2, ErrorResponse, ErrorResponse2, Extension, Extensions, ExternalRef, ExternalRefUpdate, FacetCount, FacetValue, FailureDetails, Feature, FeatureAccessAttributes, FeatureAttributes, FeatureConfigAccessAttributes, FeatureConfigPromotionAttributes, FeatureConfigUsageAttributes, FeatureConfiguration, FeatureCreate, FeatureMeta, FeaturePlanConfiguration, FeaturePlanConfigurationUpdate, FeaturePromotion, FeaturePromotionAttributes, FeatureResponseAttributes, FeatureTag, FeatureUpdate, FeatureUpdateAttributes, FeatureUsageAttributes, File, FileLink, FileMeta, FileReference, FilesError, FilesErrorResponse, FilesLinks, FilesRelationship, FilesUuid, Filesfilter, FilespageLimit, FilespageOffset, Filter, FilterCatalog, FilterHierarchy, FilterNode, FilterProduct, FilterRule, FormattedPrice, FormattedPriceData, Gateway, GeolocationDetails, GetACartData, GetACartError, GetACartErrors, GetACartResponse, GetACartResponses, GetACurrencyData, GetACurrencyError, GetACurrencyErrors, GetACurrencyResponse, GetACurrencyResponses, GetAFileData, GetAFileError, GetAFileErrors, GetAFileResponse, GetAFileResponses, GetATransactionData, GetATransactionResponse, GetATransactionResponses, GetAllCurrenciesData, GetAllCurrenciesError, GetAllCurrenciesErrors, GetAllCurrenciesResponse, GetAllCurrenciesResponses, GetAllFilesData, GetAllFilesError, GetAllFilesErrors, GetAllFilesResponse, GetAllFilesResponses, GetAllHierarchiesData, GetAllHierarchiesError, GetAllHierarchiesErrors, GetAllHierarchiesResponse, GetAllHierarchiesResponses, GetAllNodesData, GetAllNodesError, GetAllNodesErrors, GetAllNodesResponse, GetAllNodesResponses, GetAllProductsData, GetAllProductsError, GetAllProductsErrors, GetAllProductsResponse, GetAllProductsResponses, GetAllRelatedProductsData, GetAllRelatedProductsError, GetAllRelatedProductsErrors, GetAllRelatedProductsResponse, GetAllRelatedProductsResponses, GetAnOrderData, GetAnOrderError, GetAnOrderErrors, GetAnOrderResponse, GetAnOrderResponses, GetByContextAllHierarchiesData, GetByContextAllHierarchiesError, GetByContextAllHierarchiesErrors, GetByContextAllHierarchiesResponse, GetByContextAllHierarchiesResponses, GetByContextAllNodesData, GetByContextAllNodesError, GetByContextAllNodesErrors, GetByContextAllNodesResponse, GetByContextAllNodesResponses, GetByContextAllProductsData, GetByContextAllProductsError, GetByContextAllProductsErrors, GetByContextAllProductsResponse, GetByContextAllProductsResponses, GetByContextAllRelatedProductsData, GetByContextAllRelatedProductsError, GetByContextAllRelatedProductsErrors, GetByContextAllRelatedProductsResponse, GetByContextAllRelatedProductsResponses, GetByContextChildNodesData, GetByContextChildNodesError, GetByContextChildNodesErrors, GetByContextChildNodesResponse, GetByContextChildNodesResponses, GetByContextChildProductsData, GetByContextChildProductsError, GetByContextChildProductsErrors, GetByContextChildProductsResponse, GetByContextChildProductsResponses, GetByContextComponentProductIdsData, GetByContextComponentProductIdsError, GetByContextComponentProductIdsErrors, GetByContextComponentProductIdsResponse, GetByContextComponentProductIdsResponses, GetByContextHierarchyChildNodesData, GetByContextHierarchyChildNodesError, GetByContextHierarchyChildNodesErrors, GetByContextHierarchyChildNodesResponse, GetByContextHierarchyChildNodesResponses, GetByContextHierarchyData, GetByContextHierarchyError, GetByContextHierarchyErrors, GetByContextHierarchyNodesData, GetByContextHierarchyNodesError, GetByContextHierarchyNodesErrors, GetByContextHierarchyNodesResponse, GetByContextHierarchyNodesResponses, GetByContextHierarchyResponse, GetByContextHierarchyResponses, GetByContextNodeData, GetByContextNodeError, GetByContextNodeErrors, GetByContextNodeResponse, GetByContextNodeResponses, GetByContextProductData, GetByContextProductError, GetByContextProductErrors, GetByContextProductResponse, GetByContextProductResponses, GetByContextProductsForHierarchyData, GetByContextProductsForHierarchyError, GetByContextProductsForHierarchyErrors, GetByContextProductsForHierarchyResponse, GetByContextProductsForHierarchyResponses, GetByContextProductsForNodeData, GetByContextProductsForNodeError, GetByContextProductsForNodeErrors, GetByContextProductsForNodeResponse, GetByContextProductsForNodeResponses, GetByContextReleaseData, GetByContextReleaseError, GetByContextReleaseErrors, GetByContextReleaseResponse, GetByContextReleaseResponses, GetCartItemsData, GetCartItemsResponse, GetCartItemsResponses, GetCartsData, GetCartsError, GetCartsErrors, GetCartsResponse, GetCartsResponses, GetCatalogByIdData, GetCatalogByIdError, GetCatalogByIdErrors, GetCatalogByIdResponse, GetCatalogByIdResponses, GetCatalogsData, GetCatalogsError, GetCatalogsErrors, GetCatalogsResponse, GetCatalogsResponses, GetChildNodesData, GetChildNodesError, GetChildNodesErrors, GetChildNodesResponse, GetChildNodesResponses, GetChildProductsData, GetChildProductsError, GetChildProductsErrors, GetChildProductsResponse, GetChildProductsResponses, GetComponentProductIdsData, GetComponentProductIdsError, GetComponentProductIdsErrors, GetComponentProductIdsResponse, GetComponentProductIdsResponses, GetCustomerOrdersData, GetCustomerOrdersResponse, GetCustomerOrdersResponses, GetFeatureData, GetFeatureError, GetFeatureErrors, GetFeatureResponse, GetFeatureResponses, GetHierarchyChildNodesData, GetHierarchyChildNodesError, GetHierarchyChildNodesErrors, GetHierarchyChildNodesResponse, GetHierarchyChildNodesResponses, GetHierarchyData, GetHierarchyError, GetHierarchyErrors, GetHierarchyNodesData, GetHierarchyNodesError, GetHierarchyNodesErrors, GetHierarchyNodesResponse, GetHierarchyNodesResponses, GetHierarchyResponse, GetHierarchyResponses, GetInvoiceData, GetInvoiceError, GetInvoiceErrors, GetInvoiceResponse, GetInvoiceResponses, GetNodeData, GetNodeError, GetNodeErrors, GetNodeResponse, GetNodeResponses, GetOfferingData, GetOfferingError, GetOfferingErrors, GetOfferingResponse, GetOfferingResponses, GetOrderItemsData, GetOrderItemsResponse, GetOrderItemsResponses, GetOrderShippingGroupsData, GetOrderShippingGroupsError, GetOrderShippingGroupsErrors, GetOrderShippingGroupsResponse, GetOrderShippingGroupsResponses, GetOrderTransactionsData, GetOrderTransactionsError, GetOrderTransactionsErrors, GetOrderTransactionsResponse, GetOrderTransactionsResponses, GetProductData, GetProductError, GetProductErrors, GetProductResponse, GetProductResponses, GetProductsForHierarchyData, GetProductsForHierarchyError, GetProductsForHierarchyErrors, GetProductsForHierarchyResponse, GetProductsForHierarchyResponses, GetProductsForNodeData, GetProductsForNodeError, GetProductsForNodeErrors, GetProductsForNodeResponse, GetProductsForNodeResponses, GetReleaseByIdData, GetReleaseByIdError, GetReleaseByIdErrors, GetReleaseByIdResponse, GetReleaseByIdResponses, GetReleasesData, GetReleasesError, GetReleasesErrors, GetReleasesResponse, GetReleasesResponses, GetRuleByIdData, GetRuleByIdError, GetRuleByIdErrors, GetRuleByIdResponse, GetRuleByIdResponses, GetRulesData, GetRulesError, GetRulesErrors, GetRulesResponse, GetRulesResponses, GetShippingGroupByIdData, GetShippingGroupByIdError, GetShippingGroupByIdErrors, GetShippingGroupByIdResponse, GetShippingGroupByIdResponses, GetShippingGroupsByIdData, GetShippingGroupsByIdError, GetShippingGroupsByIdErrors, GetShippingGroupsByIdResponse, GetShippingGroupsByIdResponses, GetShippingGroupsData, GetShippingGroupsError, GetShippingGroupsErrors, GetShippingGroupsResponse, GetShippingGroupsResponses, GetStockData, GetStockError, GetStockErrors, GetStockResponse, GetStockResponses, GetSubscriptionData, GetSubscriptionError, GetSubscriptionErrors, GetSubscriptionInvoiceData, GetSubscriptionInvoiceError, GetSubscriptionInvoiceErrors, GetSubscriptionInvoicePaymentData, GetSubscriptionInvoicePaymentError, GetSubscriptionInvoicePaymentErrors, GetSubscriptionInvoicePaymentResponse, GetSubscriptionInvoicePaymentResponses, GetSubscriptionInvoiceResponse, GetSubscriptionInvoiceResponses, GetSubscriptionResponse, GetSubscriptionResponses, GetSubscriptionStateData, GetSubscriptionStateError, GetSubscriptionStateErrors, GetSubscriptionStateResponse, GetSubscriptionStateResponses, GetV2AccountAddressData, GetV2AccountAddressError, GetV2AccountAddressErrors, GetV2AccountAddressResponse, GetV2AccountAddressResponses, GetV2AccountAddressesData, GetV2AccountAddressesError, GetV2AccountAddressesErrors, GetV2AccountAddressesResponse, GetV2AccountAddressesResponses, GetV2AccountMembersAccountMemberIdData, GetV2AccountMembersAccountMemberIdError, GetV2AccountMembersAccountMemberIdErrors, GetV2AccountMembersAccountMemberIdResponse, GetV2AccountMembersAccountMemberIdResponses, GetV2AccountMembersData, GetV2AccountMembersError, GetV2AccountMembersErrors, GetV2AccountMembersResponse, GetV2AccountMembersResponses, GetV2AccountsAccountIdAccountMembershipsData, GetV2AccountsAccountIdAccountMembershipsError, GetV2AccountsAccountIdAccountMembershipsErrors, GetV2AccountsAccountIdAccountMembershipsResponse, GetV2AccountsAccountIdAccountMembershipsResponses, GetV2AccountsAccountIdData, GetV2AccountsAccountIdError, GetV2AccountsAccountIdErrors, GetV2AccountsAccountIdResponse, GetV2AccountsAccountIdResponses, GetV2AccountsData, GetV2AccountsError, GetV2AccountsErrors, GetV2AccountsResponse, GetV2AccountsResponses, GetV2SettingsCartData, GetV2SettingsCartError, GetV2SettingsCartErrors, GetV2SettingsCartResponse, GetV2SettingsCartResponses, GetV2SettingsCartStoreIdData, GetV2SettingsCartStoreIdError, GetV2SettingsCartStoreIdErrors, GetV2SettingsCartStoreIdResponse, GetV2SettingsCartStoreIdResponses, Hierarchy, HierarchyAttributes, HierarchyData, HierarchyListData, HierarchyMeta, HierarchyRelationships, Hit, Import, ImportAttributes, ImportJobAttributes, ImportMeta, ImportRecords, Include, IncludeAccount, IncludeAccountMember, IncludedResponse, InventoriesError, InventoriesErrorResponse, InventoriesFilter, InventoriesImport, InventoriesImportAttributes, InventoriesImportError, InventoriesImportErrorMeta, InventoriesImportErrorType, InventoriesImportMeta, InventoriesImportRecords, InventoriesImportType, InventoriesJobTimestamps, InventoriesPageLimit, InventoriesPageOffset, InventoriesTimestamps, InventoriesTransactionResponse, InventoriesUuid, InventoryLocationType, InventorySettings, InvoiceNotification, InvoicePaymentTimestamps, InvoiceTaxItems, InvoiceTimestamps, ItemPriceData, ItemSettings, Job, JobAttributes, JobCreate, JobCreateAttributes, JobMeta, JobReport, JobResponseAttributes, JobTimestamps, JobType, LeadTime, Limit, Link, LinkObject, LinkUri, Links, Links2, ListInvoicesData, ListInvoicesError, ListInvoicesErrors, ListInvoicesResponse, ListInvoicesResponses, ListLocationsData, ListLocationsError, ListLocationsErrors, ListLocationsResponse, ListLocationsResponses, ListOfferingFeaturesData, ListOfferingFeaturesError, ListOfferingFeaturesErrors, ListOfferingFeaturesResponse, ListOfferingFeaturesResponses, ListOfferingPlanPricingOptionsData, ListOfferingPlanPricingOptionsError, ListOfferingPlanPricingOptionsErrors, ListOfferingPlanPricingOptionsResponse, ListOfferingPlanPricingOptionsResponses, ListOfferingPlansData, ListOfferingPlansError, ListOfferingPlansErrors, ListOfferingPlansResponse, ListOfferingPlansResponses, ListOfferingPricingOptionsData, ListOfferingPricingOptionsError, ListOfferingPricingOptionsErrors, ListOfferingPricingOptionsResponse, ListOfferingPricingOptionsResponses, ListOfferingsData, ListOfferingsError, ListOfferingsErrors, ListOfferingsResponse, ListOfferingsResponses, ListSubscriptionInvoicePaymentsData, ListSubscriptionInvoicePaymentsResponse, ListSubscriptionInvoicePaymentsResponses, ListSubscriptionInvoicesData, ListSubscriptionInvoicesError, ListSubscriptionInvoicesErrors, ListSubscriptionInvoicesResponse, ListSubscriptionInvoicesResponses, ListSubscriptionPlansData, ListSubscriptionPlansError, ListSubscriptionPlansErrors, ListSubscriptionPlansResponse, ListSubscriptionPlansResponses, ListSubscriptionPricingOptionsData, ListSubscriptionPricingOptionsError, ListSubscriptionPricingOptionsErrors, ListSubscriptionPricingOptionsResponse, ListSubscriptionPricingOptionsResponses, ListSubscriptionStatesData, ListSubscriptionStatesError, ListSubscriptionStatesErrors, ListSubscriptionStatesResponse, ListSubscriptionStatesResponses, ListSubscriptionsData, ListSubscriptionsError, ListSubscriptionsErrors, ListSubscriptionsResponse, ListSubscriptionsResponses, Location, LocationAttributes, LocationRequest, LocationUpdateAttributes, LocationUpdateRequest, MainImageRelationship, ManageCartsData, ManageCartsError, ManageCartsErrors, ManageCartsResponse, ManageCartsResponses, ManageSubscriptionPlans, ManualPayments, ManyRelationship, MatchType, Meta, MetaAccountMemberId, MetaList, MetaListPage, MetaListResults, Method, Money, MultiSearchRequest, MultiSearchResponse, MultipleProducts, Node, NodeAttributes, NodeCreateData, NodeData, NodeListData, NodeMeta, NodeReference, NodeRelationships, NodeRelationshipsData, NonNegativeFormattedPriceData, NotificationRunJobAttributes, NotificationRunReport, NotificationSchedule, NullableLeadTime, NullableLocation, NullableLocations, NullablePaymentAuthority, NullablePrice, NullablePriceUnits, Offering, OfferingAttributes, OfferingBuildConfiguredFeatures, OfferingBuildPlanFeatures, OfferingBuildPlanPricingOptions, OfferingBuildPricingOptionAssociations, OfferingCreate, OfferingFeature, OfferingFeatureAttach, OfferingFeatureCreate, OfferingFeatureUpdate, OfferingInclude, OfferingIncludes, OfferingMeta, OfferingPlan, OfferingPlanAttributes, OfferingPlanCreate, OfferingPlanExternalRefMeta, OfferingPlanExtraAttributes, OfferingPlanPriceForPricingOption, OfferingPlanPrices, OfferingPlanResponseAttributes, OfferingPlanResponseExtraAttributes, OfferingPlanUpdate, OfferingPlanUpdateAttributes, OfferingPlanUpdateExtraAttributes, OfferingPricingOption, OfferingPricingOptionCreate, OfferingPricingOptionMeta, OfferingPricingOptionPriceForPlan, OfferingPricingOptionPrices, OfferingPricingOptionUpdate, OfferingRelationships, OfferingResponseAttributes, OfferingUpdate, OfferingUpdateAttributes, OfferingUpdateRelationships, Offset, OidcProfile, OidcProfileCreateRequestWrapper, OidcProfileListResponse, OidcProfileResponse, OidcProfileUpdateRequestWrapper, OneTimePasswordTokenRequest, OpenIdConnectRequest, OrderCollectionResponse, OrderEntityResponse, OrderInclude, OrderIncluded, OrderItemCollectionResponse, OrderItemFormattedUnitPriceData, OrderItemResponse, OrderMeta, OrderPriceData, OrderPriceWrapperMeta, OrderResponse, OrderTimestamps, OrdersAddressData, OrdersAnonymizeData, OrdersAnonymizeRequest, OrdersCancelData, OrdersFulfilledData, OrdersInclude, OrdersIncluded, OrdersListResponse, OrdersTransactionsCancelRequest, OrdersTransactionsCaptureRequest, OrdersTransactionsConfirmRequest, OrdersTransactionsRefundRequest, OrdersUpdateRequest, Owner, OwnerMeta, PageLimit, PageMeta, PageOffset, PageTotalMethod, PaginationLinks, PaginationMeta, PaginationPage, PaginationResults, PasswordProfile, PasswordProfileCreateRequestWrapper, PasswordProfileInfo, PasswordProfileInfoCreateRequest, PasswordProfileInfoCreateRequestWrapper, PasswordProfileInfoListResponse, PasswordProfileInfoResponse, PasswordProfileInfoUpdateRequest, PasswordProfileInfoUpdateRequestWrapper, PasswordProfileListResponse, PasswordProfileResponse, PasswordProfileUpdateRequestWrapper, PasswordRequest, PasswordlessRequest, Payment, PaymentAuthority, PaymentAuthorityAuthorizeNet, PaymentAuthorityEpPayments, PaymentAuthorityStripe, PaymentFailureDetail, PaymentRetryType, PaymentRetryUnit, PaymentRunJobAttributes, PaymentRunReport, PaymentSetupData, PaymentSetupError, PaymentSetupErrors, PaymentSetupResponse, PaymentSetupResponses, PaymentsRequest, PlanAttributes, PlanAttributesAndSelectedMeta, PlanCustomAttributes, PlanMeta, PlanResponseAttributes, PlanUpdateAttributes, PostMultiSearchData, PostMultiSearchError, PostMultiSearchErrors, PostMultiSearchResponse, PostMultiSearchResponses, PostV2AccountAddressData, PostV2AccountAddressError, PostV2AccountAddressErrors, PostV2AccountAddressResponse, PostV2AccountAddressResponses, PostV2AccountMembersTokensData, PostV2AccountMembersTokensError, PostV2AccountMembersTokensErrors, PostV2AccountMembersTokensResponse, PostV2AccountMembersTokensResponses, PostV2AccountsData, PostV2AccountsError, PostV2AccountsErrors, PostV2AccountsResponse, PostV2AccountsResponses, Price, PriceFormatting, PriceUnits, Pricebook, PricebookCreateData, PricebookData, PricebookIdsForPriceSegmentationPreview, PricebookIdsOfAvailablePricesToShow, PricebookPrice, PricebookPriceCreateData, PricebookPriceData, PricingOptionAttributes, PricingOptionAttributesAndSelectedMeta, PricingOptionPrice, PricingOptionResponseAttributes, PricingOptionUpdateAttributes, PrioritizedPricebooks, Product, ProductAttributes, ProductCreateData, ProductData, ProductDiff, ProductListData, ProductMeta, ProductReference, ProductReferenceListData, ProductReferences, ProductRelationships, ProductRelationshipsData, ProductsForCart, ProductsForCartConfiguration, ProductsForCartConfiguration2, PromotionItemCartObject, PromotionItemObject, PromotionItemObjectData, PromotionSource, ProrationEvent, ProrationPolicy, ProrationPolicyAttributes, ProrationPolicyCreate, ProrationPolicyMeta, ProrationPolicyRelationshipAttributes, ProrationPolicyResponseAttributes, ProrationPolicyType, ProrationPolicyUpdate, ProrationPolicyUpdateAttributes, ProrationPolicyUpdateRelationshipAttributes, ProrationPreview, ProrationPreviewAttributes, ProrationPreviewRequest, ProrationPreviewRequestAttributes, ProrationPreviewRequestType, ProrationPreviewTriggerType, ProrationPreviewType, PublishReleaseData, PublishReleaseError, PublishReleaseErrors, PublishReleaseResponse, PublishReleaseResponses, Purpose, PutShippingGroupByIdData, PutShippingGroupByIdError, PutShippingGroupByIdErrors, PutShippingGroupByIdResponse, PutShippingGroupByIdResponses, PutV2AccountAddressData, PutV2AccountAddressError, PutV2AccountAddressErrors, PutV2AccountAddressResponse, PutV2AccountAddressResponses, PutV2AccountsAccountIdData, PutV2AccountsAccountIdError, PutV2AccountsAccountIdErrors, PutV2AccountsAccountIdResponse, PutV2AccountsAccountIdResponses, PutV2SettingsCartData, PutV2SettingsCartError, PutV2SettingsCartErrors, PutV2SettingsCartResponse, PutV2SettingsCartResponses, PutV2SettingsCartStoreIdData, PutV2SettingsCartStoreIdError, PutV2SettingsCartStoreIdErrors, PutV2SettingsCartStoreIdResponse, PutV2SettingsCartStoreIdResponses, ReOrderObject, ReOrderObjectRequest, ReadOnlyParentId, RefundATransactionData, RefundATransactionError, RefundATransactionErrors, RefundATransactionResponse, RefundATransactionResponses, RefundMechanism, RejectionReason, RelatedLink, Relationship, RelationshipArray, RelationshipData, RelationshipItem, RelationshipLinks, Relationships, RelationshipsRequest, Release, ReleaseData, ReleaseIndexingCompleteData, ReleaseListData, ReleaseMeta, ReleaseRelationships, ReleaseStatus, RemoveAccountTagsOnAccount, RequestCreateCurrencies, RequestUpdateCurrencies, ResponseCurrency, ResponseData, ResponseError, ResponseErrorItem, ResponseErrorResponse, ResponseMetaCarts, ResponseMetaCurrency, ResponseMetaOrders, ResponsePageLinks, ResponsePaginationPage, ResponsePaginationResults, ResultsLinks, ResultsMeta, Rounding, Rule, RuleCreateData, RuleData, RuleListData, RuleMeta, RuleSchedule, RuleUpdateData, Sale, Sales, Schedule, Schedule2, ScheduleAttributes, ScheduleCreate, ScheduleJob, ScheduleJobType, ScheduleMeta, ScheduleResponseAttributes, ScheduleUpdate, ScheduleUpdateAttributes, SearchQuery, SearchResult, SelectedMeta, SelectedMetaAttributes, SelfLink, SelfLink2, SelfSignupRequest, SettingsCart, Shipping, ShippingAddress, ShippingGroupEntityResponse, ShippingGroupMeta, ShippingGroupResponse, ShippingPriceRequest, ShippingPriceResponse, ShopperAttributes, SingleCurrencyPrice, SingleRelationship, Sort, StateMeta, Status, Status2, StockCreate, StockCreateAttributes, StockLocations, StockMeta, StockResponse, StockResponseAttributes, StockTransactionType, StockType, StockUpdateAttributes, StockUpdateRequest, Subscriber, SubscriberAttributes, SubscriberCreate, SubscriberMeta, SubscriberResponseAttributes, SubscriberUpdate, SubscriberUpdateAttributes, Subscription, SubscriptionAttributes, SubscriptionDunningRuleType, SubscriptionFeatureType, SubscriptionImportError, SubscriptionImportErrorMeta, SubscriptionImportErrorType, SubscriptionImportType, SubscriptionInclude, SubscriptionIncludes, SubscriptionInvoice, SubscriptionInvoiceAttributes, SubscriptionInvoiceItem, SubscriptionInvoiceMeta, SubscriptionInvoicePayment, SubscriptionInvoicePaymentAttributes, SubscriptionInvoicePaymentMeta, SubscriptionInvoicePaymentRefund, SubscriptionInvoicePaymentRefundAttributes, SubscriptionInvoicePaymentRefundType, SubscriptionInvoicePaymentType, SubscriptionInvoiceType, SubscriptionItemCartObject, SubscriptionItemObject, SubscriptionItemObjectData, SubscriptionJobType, SubscriptionMeta, SubscriptionOfferingFeatureType, SubscriptionOfferingPlanType, SubscriptionOfferingPricingOptionType, SubscriptionOfferingType, SubscriptionPriceChanges, SubscriptionPriceUpdateHistoryEntry, SubscriptionScheduleType, SubscriptionState, SubscriptionStateAction, SubscriptionStateAttributes, SubscriptionStateType, SubscriptionSubscriberType, SubscriptionTimestamps, SubscriptionType, SubscriptionUpdate, SubscriptionUpdateAttributes, SubscriptionUpdateReport, SubscriptionUpdateRunJobAttributes, SubscriptionsError, SubscriptionsErrorResponse, SubscriptionsFilter, SubscriptionsPageLimit, SubscriptionsPageOffset, SubscriptionsSingleRelationship, SubscriptionsTimestamps, SubscriptionsUuid, SwitchingAccountRequest, Tag, TaxItem, TaxItemResponse, TaxRunJobAttributes, TaxRunReport, Tier, TieredAmount, TieredCurrencies, Tiers, TimePeriod, Timestamps, TotalMethod, TransactionCreate, TransactionCreateAttributes, TransactionEntityResponse, TransactionListResponse, TransactionResponse, TransactionResponseAttributes, TransactionType, Type, Unit, UpdateACartData, UpdateACartError, UpdateACartErrors, UpdateACartItemData, UpdateACartItemError, UpdateACartItemErrors, UpdateACartItemResponse, UpdateACartItemResponses, UpdateACartResponse, UpdateACartResponses, UpdateATaxItemData, UpdateATaxItemResponse, UpdateATaxItemResponses, UpdateAllOrNothingOptionsObject, UpdateAnOrderData, UpdateAnOrderError, UpdateAnOrderErrors, UpdateAnOrderResponse, UpdateAnOrderResponses, UpdateCartPaymentIntentData, UpdateCartPaymentIntentResponse, UpdateCartPaymentIntentResponses, UpdateCartShippingGroupRequest, UpdateCartsItems, UpdateCatalogData, UpdateCatalogError, UpdateCatalogErrors, UpdateCatalogResponse, UpdateCatalogResponses, UpdateCustomDiscountForCartData, UpdateCustomDiscountForCartItemData, UpdateCustomDiscountForCartItemResponse, UpdateCustomDiscountForCartItemResponses, UpdateCustomDiscountForCartResponse, UpdateCustomDiscountForCartResponses, UpdateInvoicePayment, UpdateInvoicePaymentAttributes, UpdateOrderShippingGroupRequest, UpdatePasswordProfileInfoData, UpdatePasswordProfileInfoErrors, UpdatePasswordProfileInfoResponse, UpdatePasswordProfileInfoResponses, UpdateRuleData, UpdateRuleError, UpdateRuleErrors, UpdateRuleResponse, UpdateRuleResponses, UpdateShippingGroupData, UpdateShippingGroupError, UpdateShippingGroupErrors, UpdateShippingGroupResponse, UpdateShippingGroupResponses, UpdateTaxItemFromCartItemComponentData, UpdateTaxItemFromCartItemComponentResponse, UpdateTaxItemFromCartItemComponentResponses, UserAuthenticationInfo, UserAuthenticationInfoCreateRequestWrapper, UserAuthenticationInfoListResponse, UserAuthenticationInfoResponse, UserAuthenticationInfoUpdateRequestWrapper, UserAuthenticationOidcProfileInfo, UserAuthenticationOidcProfileInfoCreateRequestWrapper, UserAuthenticationOidcProfileInfoListResponse, UserAuthenticationOidcProfileInfoResponse, UserAuthenticationOidcProfileInfoUpdateRequestWrapper, Uuid, ValidateCatalogRulesData, ValidateCatalogRulesError, ValidateCatalogRulesErrors, ValidateCatalogRulesResponse, ValidateCatalogRulesResponses, Variation, VariationOption, WritableParentId, _Error };
|
|
16216
|
+
export type { AcceptLanguage, AccessTokenRequest, AccessTokenResponse, Account, AccountAddressResponse, AccountAddressesError, AccountAddressesErrorResponse, AccountAddressesMetaTimestamps, AccountAuthenticationSettings, AccountAuthenticationSettingsResponse, AccountCheckout, AccountManagementAuthenticationToken, AccountManagementAuthenticationTokenResponse, AccountManagementError, AccountManagementErrorResponse, AccountManagementMetaTimestamps, AccountMember, AccountMemberResponse, AccountMemberSelfManagement, AccountMembership, AccountMembershipResponse, AccountMembershipResponseUsingAccountMemberId, AccountMembershipSettings, AccountResponse, AccountTag, AccountTagId, AccountTagResponse, AccountTagsRelationshipIdentifier, AccountTagsRelationshipResponse, Action, ActivePlan, ActivePricingOption, AddAccountTagsOnAccount, AddAllOrNothingOptionsObject, AddCustomDiscountToCartItemData, AddCustomDiscountToCartItemError, AddCustomDiscountToCartItemErrors, AddCustomDiscountToCartItemResponse, AddCustomDiscountToCartItemResponses, AddTaxItemToCartData, AddTaxItemToCartError, AddTaxItemToCartErrors, AddTaxItemToCartItemComponentData, AddTaxItemToCartItemComponentError, AddTaxItemToCartItemComponentErrors, AddTaxItemToCartItemComponentResponse, AddTaxItemToCartItemComponentResponses, AddTaxItemToCartResponse, AddTaxItemToCartResponses, Address, AddressCommon, AddressResponse, AddressWithCounty, AddressWithRegion, AlternativePrices, Amount, AnonymizeOrdersData, AnonymizeOrdersError, AnonymizeOrdersErrors, AnonymizeOrdersResponse, AnonymizeOrdersResponses, AuthenticationRealm, AuthenticationRealmResponse, AuthenticationRealmsError, AuthenticationRealmsErrorResponse, AuthenticationRealmsMetaTimestamps, AuthenticationRealmsPaginationLinks, AuthenticationRealmsPaginationMeta, AuthenticationRealmsSelfLink, AuthenticationRealmsUuid, AuthenticationRealmsfilter, AuthenticationRealmspageLimit, AuthenticationRealmspageOffset, AutocompleteResponse, AvailablePrices, BaseCartResponse, BaseItemObjectData, BillingAddress, BillingIntervalType, BillingRunJobAttributes, BillingRunReport, BuildOffering, BuildSubscription, BuildSubscriptionOrder, BulkAddCustomDiscountsToCartData, BulkAddCustomDiscountsToCartError, BulkAddCustomDiscountsToCartErrors, BulkAddCustomDiscountsToCartResponse, BulkAddCustomDiscountsToCartResponses, BulkAddItemsRequest, BulkAddTaxItemsToCartData, BulkAddTaxItemsToCartError, BulkAddTaxItemsToCartErrors, BulkAddTaxItemsToCartResponse, BulkAddTaxItemsToCartResponses, BulkDeleteCustomDiscountsFromCartData, BulkDeleteCustomDiscountsFromCartResponse, BulkDeleteCustomDiscountsFromCartResponses, BulkDeleteTaxItemsFromCartData, BulkDeleteTaxItemsFromCartError, BulkDeleteTaxItemsFromCartErrors, BulkDeleteTaxItemsFromCartResponse, BulkDeleteTaxItemsFromCartResponses, BulkUpdateCartsItems, BulkUpdateCartsItemsCommon, BulkUpdateCartsItemsWithCustomInputs, BulkUpdateCartsItemsWithQuantity, BulkUpdateCartsItemsWithShippingGroup, BulkUpdateItemsInCartData, BulkUpdateItemsInCartError, BulkUpdateItemsInCartErrors, BulkUpdateItemsInCartResponse, BulkUpdateItemsInCartResponses, BundleConfiguration, BundleConfigurationData, BundleConfigurationData2, CancelATransactionData, CancelATransactionError, CancelATransactionErrors, CancelATransactionResponse, CancelATransactionResponses, CaptureATransactionData, CaptureATransactionError, CaptureATransactionErrors, CaptureATransactionResponse, CaptureATransactionResponses, CaptureMechanism, CartCheckoutFilter, CartCheckoutLimit, CartCheckoutOffset, CartCheckoutTimestamps, CartCollectionResponse, CartContact, CartEntityResponse, CartInclude, CartIncluded, CartIncludedPromotion, CartItemBulkCustomDiscountObject, CartItemCollectionResponse, CartItemFormattedPriceData, CartItemObject, CartItemObjectData, CartItemObjectRequest, CartItemRelationship, CartItemResponse, CartItemTaxesEntityResponse, CartItemsResponse, CartMergeObject, CartMergeObjectRequest, CartPaymentUpdate, CartResponse, CartTimestamps, CartsBulkCustomDiscounts, CartsBulkCustomDiscountsCollectionResponse, CartsBulkCustomDiscountsResponse, CartsBulkTaxes, CartsCustomDiscountsCollectionResponse, CartsCustomDiscountsEntityRequest, CartsCustomDiscountsEntityResponse, CartsCustomDiscountsObject, CartsCustomDiscountsResponseObject, CartsItemsTaxesCommon, CartsItemsTaxesObject, CartsItemsTaxesWithAmount, CartsItemsTaxesWithRate, CartsRelationshipsAccountsData, CartsRelationshipsCustomersData, CartsRequest, CartsResponse, Catalog, CatalogCreateData, CatalogData, CatalogListData, CatalogReleaseCreateData, CatalogRuleValidatorRequest, CatalogSearchError, CatalogSearchErrorResponse, CatalogSearchJob, CatalogSearchJobAttributes, CatalogSearchJobMeta, CatalogSearchProduct, CatalogSearchacceptLanguage, CatalogSearchpricebookIdsForPriceSegmentationPreview, CatalogSearchpricebookIdsOfAvailablePricesToShow, CatalogUpdateData, ChangeState, Channel, CheckoutApiData, CheckoutApiError, CheckoutApiErrors, CheckoutApiResponse, CheckoutApiResponses, ComponentProduct, ComponentProductOption, ComponentProductsRelationship, Components, CondensedPromotionResponse, ConfigureByContextProductData, ConfigureByContextProductError, ConfigureByContextProductErrors, ConfigureByContextProductResponse, ConfigureByContextProductResponses, ConfirmOrderData, ConfirmOrderError, ConfirmOrderErrors, ConfirmOrderResponse, ConfirmOrderResponses, ConfirmPaymentData, ConfirmPaymentError, ConfirmPaymentErrors, ConfirmPaymentResponse, ConfirmPaymentResponses, Contact, CoreFieldOverride, CreateACartData, CreateACartError, CreateACartErrors, CreateACartResponse, CreateACartResponses, CreateAccountCartAssociationData, CreateAccountCartAssociationError, CreateAccountCartAssociationErrors, CreateAccountCartAssociationResponse, CreateAccountCartAssociationResponses, CreateAnAccessTokenData, CreateAnAccessTokenError, CreateAnAccessTokenErrors, CreateAnAccessTokenResponse, CreateAnAccessTokenResponses, CreateCartPaymentIntentData, CreateCartPaymentIntentResponse, CreateCartPaymentIntentResponses, CreateCatalogData, CreateCatalogError, CreateCatalogErrors, CreateCatalogResponse, CreateCatalogResponses, CreateCustomerCartAssociationData, CreateCustomerCartAssociationError, CreateCustomerCartAssociationErrors, CreateCustomerCartAssociationResponse, CreateCustomerCartAssociationResponses, CreateInvoicePaymentRefund, CreateOneTimePasswordTokenRequestData, CreateOneTimePasswordTokenRequestError, CreateOneTimePasswordTokenRequestErrors, CreateOneTimePasswordTokenRequestResponse, CreateOneTimePasswordTokenRequestResponses, CreateOrderShippingGroupData, CreateOrderShippingGroupError, CreateOrderShippingGroupErrors, CreateOrderShippingGroupResponse, CreateOrderShippingGroupResponses, CreatePaymentAuthority, CreatePaymentAuthorityAuthorizeNet, CreatePaymentAuthorityEpPayments, CreatePaymentAuthorityStripe, CreateRuleData, CreateRuleError, CreateRuleErrors, CreateRuleResponse, CreateRuleResponses, CreateSearchRuleGroupRequest, CreateSearchRuleRequest, CreateShippingGroupData, CreateShippingGroupError, CreateShippingGroupErrors, CreateShippingGroupRequest, CreateShippingGroupResponse, CreateShippingGroupResponses, CreateStopwordSetRequest, CreateSubscriptionStateData, CreateSubscriptionStateError, CreateSubscriptionStateErrors, CreateSubscriptionStateResponse, CreateSubscriptionStateResponses, CreateSynonymSetRequest, CreationStatus, Currencies, Currency, CurrencyIdentifier, CustomAttributes, CustomDiscountRelationshipsCartItemRequest, CustomDiscountResponse, CustomInput, CustomInputValidationRule, CustomInputValidationRuleOptions, CustomInputs, CustomItemCartObject, CustomItemObject, CustomItemObjectData, CustomRelationship, CustomRelationshipLinks, Customer, CustomerCheckout, DataAdyenPayment, DataAuthorizeNetPayment, DataBasePayments, DataBraintreePayment, DataCardConnectPayment, DataCreateCurrencies, DataCyberSourcePayment, DataManualPayment, DataPayPalExpressCheckoutPayment, DataPaymentObject, DataStripeConnectPayment, DataStripePayment, DataStripePaymentIntentsPayment, DataUpdateCurrencies, DeleteACartData, DeleteACartError, DeleteACartErrors, DeleteACartItemData, DeleteACartItemResponse, DeleteACartItemResponses, DeleteACartResponse, DeleteACartResponses, DeleteAPromotionViaPromotionCodeData, DeleteAPromotionViaPromotionCodeResponse, DeleteAPromotionViaPromotionCodeResponses, DeleteATaxItemData, DeleteATaxItemResponse, DeleteATaxItemResponses, DeleteAccountCartAssociationData, DeleteAccountCartAssociationError, DeleteAccountCartAssociationErrors, DeleteAccountCartAssociationResponse, DeleteAccountCartAssociationResponses, DeleteAllCartItemsData, DeleteAllCartItemsError, DeleteAllCartItemsErrors, DeleteAllCartItemsResponse, DeleteAllCartItemsResponses, DeleteCartShippingGroupData, DeleteCartShippingGroupError, DeleteCartShippingGroupErrors, DeleteCartShippingGroupResponse, DeleteCartShippingGroupResponses, DeleteCatalogByIdData, DeleteCatalogByIdError, DeleteCatalogByIdErrors, DeleteCatalogByIdResponse, DeleteCatalogByIdResponses, DeleteCustomDiscountFromCartData, DeleteCustomDiscountFromCartItemData, DeleteCustomDiscountFromCartItemResponse, DeleteCustomDiscountFromCartItemResponses, DeleteCustomDiscountFromCartResponse, DeleteCustomDiscountFromCartResponses, DeleteCustomerCartAssociationData, DeleteCustomerCartAssociationError, DeleteCustomerCartAssociationErrors, DeleteCustomerCartAssociationResponse, DeleteCustomerCartAssociationResponses, DeleteReleaseByIdData, DeleteReleaseByIdError, DeleteReleaseByIdErrors, DeleteReleaseByIdResponse, DeleteReleaseByIdResponses, DeleteReleasesData, DeleteReleasesError, DeleteReleasesErrors, DeleteReleasesResponse, DeleteReleasesResponses, DeleteRuleByIdData, DeleteRuleByIdError, DeleteRuleByIdErrors, DeleteRuleByIdResponse, DeleteRuleByIdResponses, DeleteTaxItemFromCartItemComponentData, DeleteTaxItemFromCartItemComponentError, DeleteTaxItemFromCartItemComponentErrors, DeleteTaxItemFromCartItemComponentResponse, DeleteTaxItemFromCartItemComponentResponses, DeleteV2AccountAddressData, DeleteV2AccountAddressError, DeleteV2AccountAddressErrors, DeleteV2AccountAddressResponse, DeleteV2AccountAddressResponses, DeliveryEstimate, DiffListData, Discount, DiscountData, DiscountFormattedPriceData, DiscountSettings, Discounts, DisplayPrice, DisplayPrice2, DunningRule, DunningRuleAttributes, DunningRuleCreate, DunningRuleMeta, DunningRuleUpdate, DunningRuleUpdateAttributes, DuplicateEmailPolicy, ElasticPathFile, ElasticPathPaymentsPoweredByStripePayment, EmbeddedOfferingPlanExtraAttributes, EndBehavior, EpGeolocation, Error2, ErrorResponse, ErrorResponse2, Extension, Extensions, ExternalRef, ExternalRefUpdate, FacetByField, FacetCount, FacetValue, FailureDetails, Feature, FeatureAccessAttributes, FeatureAttributes, FeatureConfigAccessAttributes, FeatureConfigPromotionAttributes, FeatureConfigUsageAttributes, FeatureConfiguration, FeatureCreate, FeatureMeta, FeaturePlanConfiguration, FeaturePlanConfigurationUpdate, FeaturePromotion, FeaturePromotionAttributes, FeatureResponseAttributes, FeatureTag, FeatureUpdate, FeatureUpdateAttributes, FeatureUsageAttributes, FieldType, File, FileLink, FileMeta, FileReference, FilesError, FilesErrorResponse, FilesLinks, FilesRelationship, FilesUuid, Filesfilter, FilespageLimit, FilespageOffset, Filter, FilterByField, FilterCatalog, FilterHierarchy, FilterNode, FilterProduct, FilterRule, FormattedPrice, FormattedPriceData, Gateway, GeolocationDetails, GetACartData, GetACartError, GetACartErrors, GetACartResponse, GetACartResponses, GetACurrencyData, GetACurrencyError, GetACurrencyErrors, GetACurrencyResponse, GetACurrencyResponses, GetAFileData, GetAFileError, GetAFileErrors, GetAFileResponse, GetAFileResponses, GetATransactionData, GetATransactionResponse, GetATransactionResponses, GetAllCurrenciesData, GetAllCurrenciesError, GetAllCurrenciesErrors, GetAllCurrenciesResponse, GetAllCurrenciesResponses, GetAllFilesData, GetAllFilesError, GetAllFilesErrors, GetAllFilesResponse, GetAllFilesResponses, GetAllHierarchiesData, GetAllHierarchiesError, GetAllHierarchiesErrors, GetAllHierarchiesResponse, GetAllHierarchiesResponses, GetAllNodesData, GetAllNodesError, GetAllNodesErrors, GetAllNodesResponse, GetAllNodesResponses, GetAllProductsData, GetAllProductsError, GetAllProductsErrors, GetAllProductsResponse, GetAllProductsResponses, GetAllRelatedProductsData, GetAllRelatedProductsError, GetAllRelatedProductsErrors, GetAllRelatedProductsResponse, GetAllRelatedProductsResponses, GetAnOrderData, GetAnOrderError, GetAnOrderErrors, GetAnOrderResponse, GetAnOrderResponses, GetByContextAllHierarchiesData, GetByContextAllHierarchiesError, GetByContextAllHierarchiesErrors, GetByContextAllHierarchiesResponse, GetByContextAllHierarchiesResponses, GetByContextAllNodesData, GetByContextAllNodesError, GetByContextAllNodesErrors, GetByContextAllNodesResponse, GetByContextAllNodesResponses, GetByContextAllProductsData, GetByContextAllProductsError, GetByContextAllProductsErrors, GetByContextAllProductsResponse, GetByContextAllProductsResponses, GetByContextAllRelatedProductsData, GetByContextAllRelatedProductsError, GetByContextAllRelatedProductsErrors, GetByContextAllRelatedProductsResponse, GetByContextAllRelatedProductsResponses, GetByContextChildNodesData, GetByContextChildNodesError, GetByContextChildNodesErrors, GetByContextChildNodesResponse, GetByContextChildNodesResponses, GetByContextChildProductsData, GetByContextChildProductsError, GetByContextChildProductsErrors, GetByContextChildProductsResponse, GetByContextChildProductsResponses, GetByContextComponentProductIdsData, GetByContextComponentProductIdsError, GetByContextComponentProductIdsErrors, GetByContextComponentProductIdsResponse, GetByContextComponentProductIdsResponses, GetByContextHierarchyChildNodesData, GetByContextHierarchyChildNodesError, GetByContextHierarchyChildNodesErrors, GetByContextHierarchyChildNodesResponse, GetByContextHierarchyChildNodesResponses, GetByContextHierarchyData, GetByContextHierarchyError, GetByContextHierarchyErrors, GetByContextHierarchyNodesData, GetByContextHierarchyNodesError, GetByContextHierarchyNodesErrors, GetByContextHierarchyNodesResponse, GetByContextHierarchyNodesResponses, GetByContextHierarchyResponse, GetByContextHierarchyResponses, GetByContextNodeData, GetByContextNodeError, GetByContextNodeErrors, GetByContextNodeResponse, GetByContextNodeResponses, GetByContextProductData, GetByContextProductError, GetByContextProductErrors, GetByContextProductResponse, GetByContextProductResponses, GetByContextProductsForHierarchyData, GetByContextProductsForHierarchyError, GetByContextProductsForHierarchyErrors, GetByContextProductsForHierarchyResponse, GetByContextProductsForHierarchyResponses, GetByContextProductsForNodeData, GetByContextProductsForNodeError, GetByContextProductsForNodeErrors, GetByContextProductsForNodeResponse, GetByContextProductsForNodeResponses, GetByContextReleaseData, GetByContextReleaseError, GetByContextReleaseErrors, GetByContextReleaseResponse, GetByContextReleaseResponses, GetCartItemsData, GetCartItemsResponse, GetCartItemsResponses, GetCartsData, GetCartsError, GetCartsErrors, GetCartsResponse, GetCartsResponses, GetCatalogByIdData, GetCatalogByIdError, GetCatalogByIdErrors, GetCatalogByIdResponse, GetCatalogByIdResponses, GetCatalogsData, GetCatalogsError, GetCatalogsErrors, GetCatalogsResponse, GetCatalogsResponses, GetChildNodesData, GetChildNodesError, GetChildNodesErrors, GetChildNodesResponse, GetChildNodesResponses, GetChildProductsData, GetChildProductsError, GetChildProductsErrors, GetChildProductsResponse, GetChildProductsResponses, GetComponentProductIdsData, GetComponentProductIdsError, GetComponentProductIdsErrors, GetComponentProductIdsResponse, GetComponentProductIdsResponses, GetCustomerOrdersData, GetCustomerOrdersResponse, GetCustomerOrdersResponses, GetFeatureData, GetFeatureError, GetFeatureErrors, GetFeatureResponse, GetFeatureResponses, GetHierarchyChildNodesData, GetHierarchyChildNodesError, GetHierarchyChildNodesErrors, GetHierarchyChildNodesResponse, GetHierarchyChildNodesResponses, GetHierarchyData, GetHierarchyError, GetHierarchyErrors, GetHierarchyNodesData, GetHierarchyNodesError, GetHierarchyNodesErrors, GetHierarchyNodesResponse, GetHierarchyNodesResponses, GetHierarchyResponse, GetHierarchyResponses, GetInvoiceData, GetInvoiceError, GetInvoiceErrors, GetInvoiceResponse, GetInvoiceResponses, GetNodeData, GetNodeError, GetNodeErrors, GetNodeResponse, GetNodeResponses, GetOfferingData, GetOfferingError, GetOfferingErrors, GetOfferingResponse, GetOfferingResponses, GetOrderItemsData, GetOrderItemsResponse, GetOrderItemsResponses, GetOrderShippingGroupsData, GetOrderShippingGroupsError, GetOrderShippingGroupsErrors, GetOrderShippingGroupsResponse, GetOrderShippingGroupsResponses, GetOrderTransactionsData, GetOrderTransactionsError, GetOrderTransactionsErrors, GetOrderTransactionsResponse, GetOrderTransactionsResponses, GetProductData, GetProductError, GetProductErrors, GetProductResponse, GetProductResponses, GetProductsForHierarchyData, GetProductsForHierarchyError, GetProductsForHierarchyErrors, GetProductsForHierarchyResponse, GetProductsForHierarchyResponses, GetProductsForNodeData, GetProductsForNodeError, GetProductsForNodeErrors, GetProductsForNodeResponse, GetProductsForNodeResponses, GetReleaseByIdData, GetReleaseByIdError, GetReleaseByIdErrors, GetReleaseByIdResponse, GetReleaseByIdResponses, GetReleasesData, GetReleasesError, GetReleasesErrors, GetReleasesResponse, GetReleasesResponses, GetRuleByIdData, GetRuleByIdError, GetRuleByIdErrors, GetRuleByIdResponse, GetRuleByIdResponses, GetRulesData, GetRulesError, GetRulesErrors, GetRulesResponse, GetRulesResponses, GetShippingGroupByIdData, GetShippingGroupByIdError, GetShippingGroupByIdErrors, GetShippingGroupByIdResponse, GetShippingGroupByIdResponses, GetShippingGroupsByIdData, GetShippingGroupsByIdError, GetShippingGroupsByIdErrors, GetShippingGroupsByIdResponse, GetShippingGroupsByIdResponses, GetShippingGroupsData, GetShippingGroupsError, GetShippingGroupsErrors, GetShippingGroupsResponse, GetShippingGroupsResponses, GetStockData, GetStockError, GetStockErrors, GetStockResponse, GetStockResponses, GetSubscriptionData, GetSubscriptionError, GetSubscriptionErrors, GetSubscriptionInvoiceData, GetSubscriptionInvoiceError, GetSubscriptionInvoiceErrors, GetSubscriptionInvoicePaymentData, GetSubscriptionInvoicePaymentError, GetSubscriptionInvoicePaymentErrors, GetSubscriptionInvoicePaymentResponse, GetSubscriptionInvoicePaymentResponses, GetSubscriptionInvoiceResponse, GetSubscriptionInvoiceResponses, GetSubscriptionResponse, GetSubscriptionResponses, GetSubscriptionStateData, GetSubscriptionStateError, GetSubscriptionStateErrors, GetSubscriptionStateResponse, GetSubscriptionStateResponses, GetV2AccountAddressData, GetV2AccountAddressError, GetV2AccountAddressErrors, GetV2AccountAddressResponse, GetV2AccountAddressResponses, GetV2AccountAddressesData, GetV2AccountAddressesError, GetV2AccountAddressesErrors, GetV2AccountAddressesResponse, GetV2AccountAddressesResponses, GetV2AccountMembersAccountMemberIdData, GetV2AccountMembersAccountMemberIdError, GetV2AccountMembersAccountMemberIdErrors, GetV2AccountMembersAccountMemberIdResponse, GetV2AccountMembersAccountMemberIdResponses, GetV2AccountMembersData, GetV2AccountMembersError, GetV2AccountMembersErrors, GetV2AccountMembersResponse, GetV2AccountMembersResponses, GetV2AccountsAccountIdAccountMembershipsData, GetV2AccountsAccountIdAccountMembershipsError, GetV2AccountsAccountIdAccountMembershipsErrors, GetV2AccountsAccountIdAccountMembershipsResponse, GetV2AccountsAccountIdAccountMembershipsResponses, GetV2AccountsAccountIdData, GetV2AccountsAccountIdError, GetV2AccountsAccountIdErrors, GetV2AccountsAccountIdResponse, GetV2AccountsAccountIdResponses, GetV2AccountsData, GetV2AccountsError, GetV2AccountsErrors, GetV2AccountsResponse, GetV2AccountsResponses, GetV2SettingsCartData, GetV2SettingsCartError, GetV2SettingsCartErrors, GetV2SettingsCartResponse, GetV2SettingsCartResponses, GetV2SettingsCartStoreIdData, GetV2SettingsCartStoreIdError, GetV2SettingsCartStoreIdErrors, GetV2SettingsCartStoreIdResponse, GetV2SettingsCartStoreIdResponses, Hierarchy, HierarchyAttributes, HierarchyData, HierarchyListData, HierarchyMeta, HierarchyRelationships, Hit, Import, ImportAttributes, ImportJobAttributes, ImportMeta, ImportRecords, Include, IncludeAccount, IncludeAccountMember, IncludedResponse, IncludedResponse2, IndexableField, IndexableFieldRequest, IndexableFields, IndexableFieldsAttributes, IndexableFieldsCreateRequest, IndexableFieldsMeta, IndexableFieldsRequestAttributes, IndexableFieldsResponse, IndexableFieldsType, IndexableFieldsUpdateRequest, IndexableFieldsUpdateRequestData, IndexedField, IndexedFieldAttributes, IndexedFieldMeta, IndexedFieldType, IndexedFieldsResponse, InventoriesError, InventoriesErrorResponse, InventoriesFilter, InventoriesImport, InventoriesImportAttributes, InventoriesImportError, InventoriesImportErrorMeta, InventoriesImportErrorType, InventoriesImportMeta, InventoriesImportRecords, InventoriesImportType, InventoriesJobTimestamps, InventoriesPageLimit, InventoriesPageOffset, InventoriesTimestamps, InventoriesTransactionResponse, InventoriesUuid, InventoryLocationType, InventorySettings, InvoiceNotification, InvoicePaymentTimestamps, InvoiceTaxItems, InvoiceTimestamps, ItemPriceData, ItemSettings, Job, JobAttributes, JobCreate, JobCreateAttributes, JobMeta, JobMetaError, JobMetaResult, JobReport, JobResponseAttributes, JobTimestamps, JobType, LeadTime, Limit, Link, LinkObject, LinkUri, Links, Links2, ListIndexableFieldsResponse, ListInvoicesData, ListInvoicesError, ListInvoicesErrors, ListInvoicesResponse, ListInvoicesResponses, ListLocationsData, ListLocationsError, ListLocationsErrors, ListLocationsResponse, ListLocationsResponses, ListOfferingFeaturesData, ListOfferingFeaturesError, ListOfferingFeaturesErrors, ListOfferingFeaturesResponse, ListOfferingFeaturesResponses, ListOfferingPlanPricingOptionsData, ListOfferingPlanPricingOptionsError, ListOfferingPlanPricingOptionsErrors, ListOfferingPlanPricingOptionsResponse, ListOfferingPlanPricingOptionsResponses, ListOfferingPlansData, ListOfferingPlansError, ListOfferingPlansErrors, ListOfferingPlansResponse, ListOfferingPlansResponses, ListOfferingPricingOptionsData, ListOfferingPricingOptionsError, ListOfferingPricingOptionsErrors, ListOfferingPricingOptionsResponse, ListOfferingPricingOptionsResponses, ListOfferingsData, ListOfferingsError, ListOfferingsErrors, ListOfferingsResponse, ListOfferingsResponses, ListResponseMeta, ListResponseMetaResults, ListSearchIndexesResponse, ListSearchProfilesResponse, ListSearchRuleGroupsResponse, ListSearchRulesResponse, ListStopwordSetsResponse, ListSubscriptionInvoicePaymentsData, ListSubscriptionInvoicePaymentsResponse, ListSubscriptionInvoicePaymentsResponses, ListSubscriptionInvoicesData, ListSubscriptionInvoicesError, ListSubscriptionInvoicesErrors, ListSubscriptionInvoicesResponse, ListSubscriptionInvoicesResponses, ListSubscriptionPlansData, ListSubscriptionPlansError, ListSubscriptionPlansErrors, ListSubscriptionPlansResponse, ListSubscriptionPlansResponses, ListSubscriptionPricingOptionsData, ListSubscriptionPricingOptionsError, ListSubscriptionPricingOptionsErrors, ListSubscriptionPricingOptionsResponse, ListSubscriptionPricingOptionsResponses, ListSubscriptionStatesData, ListSubscriptionStatesError, ListSubscriptionStatesErrors, ListSubscriptionStatesResponse, ListSubscriptionStatesResponses, ListSubscriptionsData, ListSubscriptionsError, ListSubscriptionsErrors, ListSubscriptionsResponse, ListSubscriptionsResponses, ListSynonymSetsResponse, Location, LocationAttributes, LocationRequest, LocationUpdateAttributes, LocationUpdateRequest, MainImageRelationship, ManageCartsData, ManageCartsError, ManageCartsErrors, ManageCartsResponse, ManageCartsResponses, ManageSubscriptionPlans, ManualPayments, ManyRelationship, Match, MatchType, MatchedRuleReference, Meta, MetaAccountMemberId, MetaList, MetaListPage, MetaListResults, Method, Money, MoveSearchRuleRequest, MultiSearchRequest, MultiSearchResponse, MultipleProducts, Node, NodeAttributes, NodeCreateData, NodeData, NodeListData, NodeMeta, NodeReference, NodeRelationships, NodeRelationshipsData, NonNegativeFormattedPriceData, NotificationRunJobAttributes, NotificationRunReport, NotificationSchedule, NullableLeadTime, NullableLocation, NullableLocations, NullablePaymentAuthority, NullablePrice, NullablePriceUnits, Offering, OfferingAttributes, OfferingBuildConfiguredFeatures, OfferingBuildPlanFeatures, OfferingBuildPlanPricingOptions, OfferingBuildPricingOptionAssociations, OfferingCreate, OfferingFeature, OfferingFeatureAttach, OfferingFeatureCreate, OfferingFeatureUpdate, OfferingInclude, OfferingIncludes, OfferingMeta, OfferingPlan, OfferingPlanAttributes, OfferingPlanCreate, OfferingPlanExternalRefMeta, OfferingPlanExtraAttributes, OfferingPlanPriceForPricingOption, OfferingPlanPrices, OfferingPlanResponseAttributes, OfferingPlanResponseExtraAttributes, OfferingPlanUpdate, OfferingPlanUpdateAttributes, OfferingPlanUpdateExtraAttributes, OfferingPricingOption, OfferingPricingOptionCreate, OfferingPricingOptionMeta, OfferingPricingOptionPriceForPlan, OfferingPricingOptionPrices, OfferingPricingOptionUpdate, OfferingRelationships, OfferingResponseAttributes, OfferingUpdate, OfferingUpdateAttributes, OfferingUpdateRelationships, Offset, OidcProfile, OidcProfileLinks, OidcProfileResponse, OneTimePasswordTokenRequestInput, OneTimePasswordTokenRequestResponse, OpenIdConnectRequest, OrderCollectionResponse, OrderEntityResponse, OrderInclude, OrderIncluded, OrderItemCollectionResponse, OrderItemFormattedUnitPriceData, OrderItemResponse, OrderMeta, OrderPriceData, OrderPriceWrapperMeta, OrderResponse, OrderTimestamps, OrdersAddressData, OrdersAnonymizeData, OrdersAnonymizeRequest, OrdersCancelData, OrdersFulfilledData, OrdersInclude, OrdersIncluded, OrdersListResponse, OrdersTransactionsCancelRequest, OrdersTransactionsCaptureRequest, OrdersTransactionsConfirmRequest, OrdersTransactionsRefundRequest, OrdersUpdateRequest, Owner, OwnerMeta, PageLimit, PageMeta, PageOffset, PageTotalMethod, PaginationLinks, PaginationMeta, PaginationPage, PaginationResults, PasswordProfile, PasswordProfileResponse, PasswordRequest, PasswordlessRequest, Payment, PaymentAuthority, PaymentAuthorityAuthorizeNet, PaymentAuthorityEpPayments, PaymentAuthorityStripe, PaymentFailureDetail, PaymentRetryType, PaymentRetryUnit, PaymentRunJobAttributes, PaymentRunReport, PaymentSetupData, PaymentSetupError, PaymentSetupErrors, PaymentSetupResponse, PaymentSetupResponses, PaymentsRequest, Placement, PlanAttributes, PlanAttributesAndSelectedMeta, PlanCustomAttributes, PlanMeta, PlanResponseAttributes, PlanUpdateAttributes, PostMultiSearchData, PostMultiSearchError, PostMultiSearchErrors, PostMultiSearchResponse, PostMultiSearchResponses, PostV2AccountAddressData, PostV2AccountAddressError, PostV2AccountAddressErrors, PostV2AccountAddressResponse, PostV2AccountAddressResponses, PostV2AccountMembersTokensData, PostV2AccountMembersTokensError, PostV2AccountMembersTokensErrors, PostV2AccountMembersTokensResponse, PostV2AccountMembersTokensResponses, PostV2AccountsData, PostV2AccountsError, PostV2AccountsErrors, PostV2AccountsResponse, PostV2AccountsResponses, Price, PriceFormatting, PriceUnits, Pricebook, PricebookCreateData, PricebookData, PricebookIdsForPriceSegmentationPreview, PricebookIdsOfAvailablePricesToShow, PricebookPrice, PricebookPriceCreateData, PricebookPriceData, PricingOptionAttributes, PricingOptionAttributesAndSelectedMeta, PricingOptionPrice, PricingOptionResponseAttributes, PricingOptionUpdateAttributes, PrioritizedPricebooks, Product, ProductAttributes, ProductCreateData, ProductData, ProductDiff, ProductListData, ProductMeta, ProductReference, ProductReferenceListData, ProductReferences, ProductRelationships, ProductRelationshipsData, ProductsForCart, ProductsForCartConfiguration, ProductsForCartConfiguration2, ProductsInclude, PromotionItemCartObject, PromotionItemObject, PromotionItemObjectData, PromotionSource, ProrationEvent, ProrationPolicy, ProrationPolicyAttributes, ProrationPolicyCreate, ProrationPolicyMeta, ProrationPolicyRelationshipAttributes, ProrationPolicyResponseAttributes, ProrationPolicyType, ProrationPolicyUpdate, ProrationPolicyUpdateAttributes, ProrationPolicyUpdateRelationshipAttributes, ProrationPreview, ProrationPreviewAttributes, ProrationPreviewRequest, ProrationPreviewRequestAttributes, ProrationPreviewRequestType, ProrationPreviewTriggerType, ProrationPreviewType, PublishReleaseData, PublishReleaseError, PublishReleaseErrors, PublishReleaseResponse, PublishReleaseResponses, Purpose, PutShippingGroupByIdData, PutShippingGroupByIdError, PutShippingGroupByIdErrors, PutShippingGroupByIdResponse, PutShippingGroupByIdResponses, PutV2AccountAddressData, PutV2AccountAddressError, PutV2AccountAddressErrors, PutV2AccountAddressResponse, PutV2AccountAddressResponses, PutV2AccountsAccountIdData, PutV2AccountsAccountIdError, PutV2AccountsAccountIdErrors, PutV2AccountsAccountIdResponse, PutV2AccountsAccountIdResponses, PutV2SettingsCartData, PutV2SettingsCartError, PutV2SettingsCartErrors, PutV2SettingsCartResponse, PutV2SettingsCartResponses, PutV2SettingsCartStoreIdData, PutV2SettingsCartStoreIdError, PutV2SettingsCartStoreIdErrors, PutV2SettingsCartStoreIdResponse, PutV2SettingsCartStoreIdResponses, ReOrderObject, ReOrderObjectRequest, ReadOnlyParentId, RefundATransactionData, RefundATransactionError, RefundATransactionErrors, RefundATransactionResponse, RefundATransactionResponses, RefundMechanism, ReindexTenantReleasesJobRequest, RejectionReason, RelatedLink, Relationship, RelationshipArray, RelationshipData, RelationshipItem, RelationshipLinks, Relationships, RelationshipsRequest, Release, ReleaseData, ReleaseIndexingCompleteData, ReleaseListData, ReleaseMeta, ReleaseRelationships, ReleaseStatus, RemoveAccountTagsOnAccount, RequestCreateCurrencies, RequestUpdateCurrencies, ResourceOwner, ResponseCurrency, ResponseData, ResponseError, ResponseErrorItem, ResponseErrorResponse, ResponseMetaCarts, ResponseMetaCurrency, ResponseMetaOrders, ResponsePageLinks, ResponsePaginationPage, ResponsePaginationResults, ResultsLinks, ResultsMeta, Rounding, Rule, RuleCreateData, RuleData, RuleListData, RuleMeta, RuleSchedule, RuleUpdateData, Sale, Sales, Schedule, Schedule2, ScheduleAttributes, ScheduleCreate, ScheduleJob, ScheduleJobType, ScheduleMeta, ScheduleResponseAttributes, ScheduleUpdate, ScheduleUpdateAttributes, SearchBoostRule, SearchField, SearchHideRule, SearchIndex, SearchIndexMeta, SearchIndexType, SearchPinRule, SearchProfile, SearchProfile2, SearchProfileAttributes, SearchProfileCreateRequest, SearchProfileCreateRequestData, SearchProfileMeta, SearchProfileResponse, SearchProfileType, SearchProfileUpdateAttributes, SearchProfileUpdateRequest, SearchProfileUpdateRequestData, SearchQuery, SearchQueryParamFacetBy, SearchQueryParamFilterBy, SearchQueryParamHighlightFullFields, SearchQueryParamMaxFacetValues, SearchQueryParamQ, SearchQueryParamSortBy, SearchQueryParamType, SearchResponse, SearchResult, SearchResultType, SearchRule, SearchRuleActions, SearchRuleAttributes, SearchRuleGroup, SearchRuleGroupAttributes, SearchRuleGroupMeta, SearchRuleGroupPatchAttributes, SearchRuleGroupResponse, SearchRuleGroupType, SearchRuleMeta, SearchRulePatchAttributes, SearchRuleResponse, SearchRuleTrigger, SearchRuleType, SearchableField, SearchableFieldAttributes, SearchableFieldMeta, SearchableFieldType, SearchableFieldsResponse, SelectedMeta, SelectedMetaAttributes, SelfLink, SelfLink2, SelfSignupRequest, SettingsCart, Shipping, ShippingAddress, ShippingGroupEntityResponse, ShippingGroupMeta, ShippingGroupResponse, ShippingPriceRequest, ShippingPriceResponse, ShopperAttributes, SimulatedShopperDate, SingleCurrencyPrice, SingleRelationship, Sort, SortByField, SplitJoinTokens, StateMeta, Status, Status2, Stem, StockCreate, StockCreateAttributes, StockLocations, StockMeta, StockResponse, StockResponseAttributes, StockTransactionType, StockType, StockUpdateAttributes, StockUpdateRequest, StopwordSet, StopwordSetAttributes, StopwordSetMeta, StopwordSetResponse, StopwordSetType, Subscriber, SubscriberAttributes, SubscriberCreate, SubscriberMeta, SubscriberResponseAttributes, SubscriberUpdate, SubscriberUpdateAttributes, Subscription, SubscriptionAttributes, SubscriptionDunningRuleType, SubscriptionFeatureType, SubscriptionImportError, SubscriptionImportErrorMeta, SubscriptionImportErrorType, SubscriptionImportType, SubscriptionInclude, SubscriptionIncludes, SubscriptionInvoice, SubscriptionInvoiceAttributes, SubscriptionInvoiceItem, SubscriptionInvoiceMeta, SubscriptionInvoicePayment, SubscriptionInvoicePaymentAttributes, SubscriptionInvoicePaymentMeta, SubscriptionInvoicePaymentRefund, SubscriptionInvoicePaymentRefundAttributes, SubscriptionInvoicePaymentRefundType, SubscriptionInvoicePaymentType, SubscriptionInvoiceType, SubscriptionItemCartObject, SubscriptionItemObject, SubscriptionItemObjectData, SubscriptionJobType, SubscriptionMeta, SubscriptionOfferingFeatureType, SubscriptionOfferingPlanType, SubscriptionOfferingPricingOptionType, SubscriptionOfferingType, SubscriptionPriceChanges, SubscriptionPriceUpdateHistoryEntry, SubscriptionScheduleType, SubscriptionState, SubscriptionStateAction, SubscriptionStateAttributes, SubscriptionStateType, SubscriptionSubscriberType, SubscriptionTimestamps, SubscriptionType, SubscriptionUpdate, SubscriptionUpdateAttributes, SubscriptionUpdateReport, SubscriptionUpdateRunJobAttributes, SubscriptionsError, SubscriptionsErrorResponse, SubscriptionsFilter, SubscriptionsPageLimit, SubscriptionsPageOffset, SubscriptionsSingleRelationship, SubscriptionsTimestamps, SubscriptionsUuid, SwitchingAccountRequest, SyncStatus, SynonymSet, SynonymSetAttributes, SynonymSetItem, SynonymSetMeta, SynonymSetResponse, SynonymSetType, SynonymSettings, Tag, TaxItem, TaxItemResponse, TaxRunJobAttributes, TaxRunReport, TextMatchInfo, TextMatchType, Tier, TieredAmount, TieredCurrencies, Tiers, TimePeriod, Timestamps, TotalMethod, TransactionCreate, TransactionCreateAttributes, TransactionEntityResponse, TransactionListResponse, TransactionResponse, TransactionResponseAttributes, TransactionType, Type, TypoTolerance, Unit, UpdateACartData, UpdateACartError, UpdateACartErrors, UpdateACartItemData, UpdateACartItemError, UpdateACartItemErrors, UpdateACartItemResponse, UpdateACartItemResponses, UpdateACartResponse, UpdateACartResponses, UpdateATaxItemData, UpdateATaxItemResponse, UpdateATaxItemResponses, UpdateAllOrNothingOptionsObject, UpdateAnOrderData, UpdateAnOrderError, UpdateAnOrderErrors, UpdateAnOrderResponse, UpdateAnOrderResponses, UpdateCartPaymentIntentData, UpdateCartPaymentIntentResponse, UpdateCartPaymentIntentResponses, UpdateCartShippingGroupRequest, UpdateCartsItems, UpdateCatalogData, UpdateCatalogError, UpdateCatalogErrors, UpdateCatalogResponse, UpdateCatalogResponses, UpdateCustomDiscountForCartData, UpdateCustomDiscountForCartItemData, UpdateCustomDiscountForCartItemResponse, UpdateCustomDiscountForCartItemResponses, UpdateCustomDiscountForCartResponse, UpdateCustomDiscountForCartResponses, UpdateInvoicePayment, UpdateInvoicePaymentAttributes, UpdateOrderShippingGroupRequest, UpdatePasswordProfileInfoData, UpdatePasswordProfileInfoError, UpdatePasswordProfileInfoErrors, UpdatePasswordProfileInfoResponse, UpdatePasswordProfileInfoResponses, UpdateRuleData, UpdateRuleError, UpdateRuleErrors, UpdateRuleResponse, UpdateRuleResponses, UpdateSearchRuleGroupRequest, UpdateSearchRuleRequest, UpdateShippingGroupData, UpdateShippingGroupError, UpdateShippingGroupErrors, UpdateShippingGroupResponse, UpdateShippingGroupResponses, UpdateStopwordSetAttributes, UpdateStopwordSetRequest, UpdateSynonymSetAttributes, UpdateSynonymSetRequest, UpdateTaxItemFromCartItemComponentData, UpdateTaxItemFromCartItemComponentResponse, UpdateTaxItemFromCartItemComponentResponses, UserAuthenticationInfo, UserAuthenticationInfoResponse, UserAuthenticationOidcProfileInfo, UserAuthenticationOidcProfileInfoResponse, UserAuthenticationPasswordProfileInfo, UserAuthenticationPasswordProfileInfoInput, UserAuthenticationPasswordProfileInfoResponse, UserAuthenticationPasswordProfileInfoUpdateInput, UsernameFormat, Uuid, ValidateCatalogRulesData, ValidateCatalogRulesError, ValidateCatalogRulesErrors, ValidateCatalogRulesResponse, ValidateCatalogRulesResponses, Variation, VariationOption, WritableParentId, _Error };
|