import { ai as CreateInventoryItemRequest$1, aj as CreateInventoryItemResponse$1, ak as BulkCreateInventoryItemsRequest$1, b as BulkCreateInventoryItemsResponse$1, ap as GetInventoryItemRequest$1, aq as GetInventoryItemResponse$1, ar as UpdateInventoryItemRequest$1, as as UpdateInventoryItemResponse$1, av as BulkUpdateInventoryItemsRequest$1, h as BulkUpdateInventoryItemsResponse$1, aw as BulkUpsertInventoryItemsRequest$1, ax as BulkUpsertInventoryItemsResponse$1, az as BulkUpdateInventoryItemsByFilterRequest$1, k as BulkUpdateInventoryItemsByFilterResponse$1, aB as DeleteInventoryItemRequest$1, aC as DeleteInventoryItemResponse$1, aD as BulkDeleteInventoryItemsRequest$1, m as BulkDeleteInventoryItemsResponse$1, aF as BulkDeleteInventoryItemsByFilterRequest$1, aG as BulkDeleteInventoryItemsByFilterResponse$1, aH as QueryInventoryItemsRequest$1, aN as QueryInventoryItemsResponse$1, aQ as SearchInventoryItemsRequest$1, S as SearchInventoryItemsResponse$1, bx as BulkDecrementInventoryItemsRequest$1, p as BulkDecrementInventoryItemsResponse$1, by as BulkIncrementInventoryItemsRequest$1, t as BulkIncrementInventoryItemsResponse$1, bz as BulkDecrementInventoryItemsByVariantAndLocationRequest$1, x as BulkDecrementInventoryItemsByVariantAndLocationResponse$1, bA as BulkIncrementInventoryItemsByVariantAndLocationRequest$1, E as BulkIncrementInventoryItemsByVariantAndLocationResponse$1, bL as BulkSetOrAdjustInventoryItemsByFilterRequest$1, bO as BulkSetOrAdjustInventoryItemsByFilterResponse$1, bP as BulkAdjustInventoryItemsByFilterRequest$1, bQ as BulkAdjustInventoryItemsByFilterResponse$1, bR as BulkCreateInventoryItemsByVariantFilterRequest$1, bT as BulkCreateInventoryItemsByVariantFilterResponse$1 } from './stores-catalog-v3-inventory-item-inventory-items-v-3.universal-BiExdr6E.js'; import '@wix/sdk-types'; /** * Inventory Item. * * Each inventory item represents a specific product variant at a specific location. * The combination of `variantId` and `locationId` is unique — you can't have two inventory items for the same variant at the same location. */ interface InventoryItem extends InventoryItemTrackingMethodOneOf { /** * Indicates that inventory is tracked by status rather than quantity. * * When set to `true`, the item is marked as available for sale without tracking exact quantities. * When set to `false`, the item is marked as out of stock. * This tracking method is useful for made-to-order products or items with unlimited inventory. * * When using this tracking method, `trackQuantity` is `false` and preorder limits aren't supported. */ inStock?: boolean; /** * Indicates that inventory is tracked by quantity. * * Set this field to the number of items currently in stock. * This tracking method is useful when you need to know exactly how many items are available. * * When using this tracking method, `trackQuantity` is `true`. * Quantity can be negative when inventory is decremented for an order that has already been paid. * @min -99999 * @max 99999 */ quantity?: number; /** * Inventory item ID. * @format GUID * @readonly */ id?: string | null; /** * Revision number, which increments by 1 each time the inventory item is updated. * To prevent conflicting changes, * the current revision must be passed when updating the inventory item. * * Ignored when creating an inventory item. * @readonly */ revision?: string | null; /** * Date and time the inventory item was created. * @readonly */ createdDate?: Date | null; /** * Date and time the inventory item was last updated. * @readonly */ updatedDate?: Date | null; /** * Variant ID. * @format GUID * @immutable */ variantId?: string; /** * Stores location ID. If not specified when creating an inventory item, the store's default location is used. * @format GUID * @immutable */ locationId?: string | null; /** * Product ID. * @minLength 1 * @maxLength 36 * @immutable */ productId?: string; /** * Whether the quantity is being tracked. * @readonly */ trackQuantity?: boolean; /** * Inventory item availability status. * @readonly */ availabilityStatus?: AvailabilityStatusWithLiterals; /** * Item preorder info. * * Preorder settings are configured per inventory item, so each variant-location combination can have its own preorder configuration. * * > **Note:** The product entity's `inventory.preorderStatus` and `inventory.preorderAvailability` fields reflect only the default location's preorder state. */ preorderInfo?: PreorderInfo; /** * Associated product and variant details. * @readonly */ product?: Product; /** * Custom field data for the inventory item object. * * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls. */ extendedFields?: ExtendedFields; } /** @oneof */ interface InventoryItemTrackingMethodOneOf { /** * Indicates that inventory is tracked by status rather than quantity. * * When set to `true`, the item is marked as available for sale without tracking exact quantities. * When set to `false`, the item is marked as out of stock. * This tracking method is useful for made-to-order products or items with unlimited inventory. * * When using this tracking method, `trackQuantity` is `false` and preorder limits aren't supported. */ inStock?: boolean; /** * Indicates that inventory is tracked by quantity. * * Set this field to the number of items currently in stock. * This tracking method is useful when you need to know exactly how many items are available. * * When using this tracking method, `trackQuantity` is `true`. * Quantity can be negative when inventory is decremented for an order that has already been paid. * @min -99999 * @max 99999 */ quantity?: number; } declare enum AvailabilityStatus { /** Item is out of stock. For tracked inventory, `quantity` is zero or negative and preorder isn't available. */ OUT_OF_STOCK = "OUT_OF_STOCK", /** Item is in stock and available for purchase. For tracked inventory, see the `quantity` field for the exact amount in stock. */ IN_STOCK = "IN_STOCK", /** Item is available for preorder only. Stock is zero or negative, but preorder is enabled with remaining capacity. */ PREORDER = "PREORDER" } /** @enumType */ type AvailabilityStatusWithLiterals = AvailabilityStatus | 'OUT_OF_STOCK' | 'IN_STOCK' | 'PREORDER'; interface PreorderInfo { /** * Whether preorder is enabled for this inventory item. * * > **Note:** Preorder can't be enabled for digital products or products with subscriptions. * * Default: `false` */ enabled?: boolean | null; /** * Message displayed to customers when the item is out of stock and preorder is enabled. * @minLength 1 * @maxLength 250 */ message?: string | null; /** * Maximum number of items that can be preordered after stock reaches zero. * * Supported only for inventory items with `trackQuantity = true`. * * Default: `100000` * @max 100000 */ limit?: number | null; /** * Number of times this item has been preordered. * * Supported only for inventory items with `trackQuantity = true`. * @readonly * @max 99999 */ counter?: number | null; /** * Remaining quantity available for preorder. * * Supported only for items with `trackQuantity` set to `true`. * @readonly */ quantity?: number | null; } interface Product { /** * Product name. * @maxLength 80 */ name?: string | null; /** * List of category IDs that this product is included in directly. * @format GUID * @maxSize 2000 */ directCategoryIds?: string[]; /** * Variant name. * @minLength 1 * @maxLength 250 */ variantName?: string | null; /** * Variant SKU (stock keeping unit). * @minLength 1 * @maxLength 40 */ variantSku?: string | null; /** Whether the variant is visible in the store. */ variantVisible?: boolean | null; } /** Product brand information. */ interface Brand { /** * Brand ID. * @format GUID */ id?: string | null; /** * Brand name. * @maxLength 50 */ name?: string | null; } interface ExtendedFields { /** * Extended field data. Each key corresponds to the namespace of the app that created the extended fields. * The value of each key is structured according to the schema defined when the extended fields were configured. * * You can only access fields for which you have the appropriate permissions. * * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). */ namespaces?: Record>; } interface InvalidateCache extends InvalidateCacheGetByOneOf { /** * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ metaSiteId?: string; /** * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ siteId?: string; /** Invalidate by App */ app?: App; /** Invalidate by page id */ page?: Page; /** Invalidate by URI path */ uri?: URI; /** Invalidate by file (for media files such as PDFs) */ file?: File; /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */ customTag?: CustomTag; /** Invalidate by multiple page ids */ pages?: Pages; /** Invalidate by multiple URI paths */ uris?: URIs; /** * tell us why you're invalidating the cache. You don't need to add your app name * @maxLength 256 */ reason?: string | null; /** Is local DS */ localDc?: boolean; hardPurge?: boolean; /** * Optional caller-provided ID for tracking this invalidation through the system. * When set, the corresponding CDN purge completion event will include this ID, * allowing you to confirm when the invalidation has fully propagated. * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event. * @maxLength 256 */ correlationId?: string | null; } /** @oneof */ interface InvalidateCacheGetByOneOf { /** * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ metaSiteId?: string; /** * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ siteId?: string; /** Invalidate by App */ app?: App; /** Invalidate by page id */ page?: Page; /** Invalidate by URI path */ uri?: URI; /** Invalidate by file (for media files such as PDFs) */ file?: File; /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */ customTag?: CustomTag; /** Invalidate by multiple page ids */ pages?: Pages; /** Invalidate by multiple URI paths */ uris?: URIs; } interface App { /** * The AppDefId * @minLength 1 */ appDefId?: string; /** * The instance Id * @format GUID */ instanceId?: string; } interface Page { /** * the msid the page is on * @format GUID */ metaSiteId?: string; /** * Invalidate by Page ID * @minLength 1 */ pageId?: string; } interface URI { /** * the msid the URI is on * @format GUID */ metaSiteId?: string; /** * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes * @minLength 1 */ uriPath?: string; } interface File { /** * the msid the file is related to * @format GUID */ metaSiteId?: string; /** * Invalidate by filename (for media files such as PDFs) * @minLength 1 * @maxLength 256 */ fileName?: string; } interface CustomTag { /** * the msid the tag is related to * @format GUID */ metaSiteId?: string; /** * Tag to invalidate by * @minLength 1 * @maxLength 256 */ tag?: string; } interface Pages { /** * the msid the pages are on * @format GUID */ metaSiteId?: string; /** * Invalidate by multiple Page IDs in a single message * @maxSize 100 * @minLength 1 */ pageIds?: string[]; } interface URIs { /** * the msid the URIs are on * @format GUID */ metaSiteId?: string; /** * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes * @maxSize 100 * @minLength 1 */ uriPaths?: string[]; } interface BulkInventoryItemAction { /** * Inventory items. * @maxSize 1000 */ inventoryItems?: InventoryItem[]; /** Type of bulk inventory changed event - created, updated or deleted */ eventType?: EventTypeWithLiterals; } declare enum EventType { UNKNOWN = "UNKNOWN", CREATED = "CREATED", UPDATED = "UPDATED", DELETED = "DELETED" } /** @enumType */ type EventTypeWithLiterals = EventType | 'UNKNOWN' | 'CREATED' | 'UPDATED' | 'DELETED'; interface CreateInventoryItemRequest { /** Inventory item to create. */ inventoryItem: InventoryItem; } interface CreateInventoryItemResponse { /** Created inventory item. */ inventoryItem?: InventoryItem; } interface BulkCreateInventoryItemsRequest { /** * Inventory items to create. * @minSize 1 * @maxSize 1000 */ inventoryItems: InventoryItem[]; /** * Whether to return the full inventory item entities in the response. * * Default: `false` */ returnEntity?: boolean; } interface BulkCreateInventoryItemsResponse { /** * Inventory items created by bulk action. * @minSize 1 * @maxSize 1000 */ results?: V3BulkInventoryItemResult[]; /** Bulk action metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface V3BulkInventoryItemResult { /** Bulk action metadata for inventory item. */ itemMetadata?: ItemMetadata; /** * Full inventory item entity. * * Returned only if `returnEntity: true` is passed in the request. */ item?: InventoryItem; } interface ItemMetadata { /** * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). * @format GUID */ id?: string | null; /** Index of the item within the request array. Allows for correlation between request and response items. */ originalIndex?: number; /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */ success?: boolean; /** Details about the error in case of failure. */ error?: ApplicationError; } interface ApplicationError { /** Error code. */ code?: string; /** Description of the error. */ description?: string; /** Data related to the error. */ data?: Record | null; } interface BulkActionMetadata { /** Number of items that were successfully processed. */ totalSuccesses?: number; /** Number of items that couldn't be processed. */ totalFailures?: number; /** Number of failures without details because detailed failure threshold was exceeded. */ undetailedFailures?: number; } interface GetInventoryItemRequest { /** * Inventory item ID. * @format GUID */ inventoryItemId: string; } interface GetInventoryItemResponse { /** Inventory item. */ inventoryItem?: InventoryItem; } interface UpdateInventoryItemRequest { /** Inventory item to update. */ inventoryItem: InventoryItem; /** Reason for update. */ reason?: ReasonTypeWithLiterals; } /** The reason for the inventory change. */ declare enum ReasonType { ORDER = "ORDER", MANUAL = "MANUAL", REVERT_INVENTORY_CHANGE = "REVERT_INVENTORY_CHANGE" } /** @enumType */ type ReasonTypeWithLiterals = ReasonType | 'ORDER' | 'MANUAL' | 'REVERT_INVENTORY_CHANGE'; interface UpdateInventoryItemResponse { /** Updated inventory item. */ inventoryItem?: InventoryItem; } /** Report when Inventory item stock status changed from in stock to out of stock and the opposite. */ interface InventoryItemStockStatusUpdatedEvent { /** Inventory item new status. */ inStock?: boolean; } interface InventoryItemUpdatedWithReason { /** Updated inventory item. */ currentEntity?: InventoryItem; /** Reason for the update. */ reason?: ReasonTypeWithLiterals; /** * ID of the app that updated this inventory item. * * When Wix Stores updates an inventory item, value will always be: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`. * @format GUID */ appId?: string; } interface BulkUpdateInventoryItemsRequest { /** * Inventory items to update. * @minSize 1 * @maxSize 1000 */ inventoryItems: MaskedInventoryItem[]; /** * Whether to return the full inventory item entities in the response. * * Default: `false` */ returnEntity?: boolean; /** Reason for update. */ reason?: ReasonTypeWithLiterals; } interface MaskedInventoryItem { /** Inventory item to update. */ inventoryItem?: InventoryItem; } interface BulkUpdateInventoryItemsResponse { /** * Inventory items updated by bulk action. * @minSize 1 * @maxSize 1000 */ results?: V3BulkInventoryItemResult[]; /** Bulk action metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkUpsertInventoryItemsRequest { /** * Inventory items to create or update. * @minSize 1 * @maxSize 1000 */ inventoryItems: MaskedInventoryItem[]; /** * Whether to return the full inventory item entities in the response. * * Default: `false` */ returnEntity?: boolean; } interface BulkUpsertInventoryItemsResponse { /** * Inventory items created or updated by the bulk action. * @minSize 1 * @maxSize 1000 */ results?: BulkUpsertInventoryItemResult[]; /** Bulk action metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkUpsertInventoryItemResult { /** Bulk action metadata for the inventory item. */ itemMetadata?: ItemMetadata; /** * Full inventory item entity. * * Returned only if `returnEntity: true` is passed in the request. */ item?: InventoryItem; } interface BulkUpdateInventoryItemsByFilterRequest { /** Filter object. */ filter: Record | null; /** Inventory item to update. */ inventoryItem: InventoryItem; /** Free text to match in searchable fields. */ search?: SearchDetails; } interface SearchDetails { /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */ mode?: ModeWithLiterals; /** * Search term or expression. * @maxLength 100 */ expression?: string | null; /** * Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`. * @maxLength 200 * @maxSize 20 */ fields?: string[]; /** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */ fuzzy?: boolean; } declare enum Mode { /** At least one of the search terms must be present. */ OR = "OR", /** All search terms must be present. */ AND = "AND" } /** @enumType */ type ModeWithLiterals = Mode | 'OR' | 'AND'; interface BulkUpdateInventoryItemsByFilterResponse { /** * Job ID. * * Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/introduction) to retrieve job details and metadata. * @format GUID */ jobId?: string; } interface DeleteInventoryItemRequest { /** * Inventory item ID. * @format GUID */ inventoryItemId: string; } interface DeleteInventoryItemResponse { } interface BulkDeleteInventoryItemsRequest { /** * IDs of inventory items to delete. * @format GUID * @minLength 1 * @maxLength 36 * @minSize 1 * @maxSize 1000 */ inventoryItemIds: string[]; } interface BulkDeleteInventoryItemsResponse { /** * Inventory items deleted by bulk action. * @minSize 1 * @maxSize 1000 */ results?: BulkInventoryItemResult[]; /** Bulk action metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkInventoryItemResult { /** Bulk action metadata for inventory item. */ itemMetadata?: ItemMetadata; } interface BulkDeleteInventoryItemsByFilterRequest { /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter: Record | null; /** Free text to match in searchable fields. */ search?: SearchDetails; } interface BulkDeleteInventoryItemsByFilterResponse { /** * Job ID. * * Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/introduction) to retrieve job details and metadata. * @format GUID */ jobId?: string; } interface QueryInventoryItemsRequest { /** Query options. */ query?: QueryV2; } interface QueryV2 extends QueryV2PagingMethodOneOf { /** Paging options to limit and offset the number of items. */ paging?: Paging; /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; /** * Filter object. * * Learn more about [filtering](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters). */ filter?: Record | null; /** * Sort object. * * Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#sorting). * @maxSize 10 */ sort?: Sorting[]; } /** @oneof */ interface QueryV2PagingMethodOneOf { /** Paging options to limit and offset the number of items. */ paging?: Paging; /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; } interface Sorting { /** * Name of the field to sort by. * @maxLength 512 */ fieldName?: string; /** Sort order. */ order?: SortOrderWithLiterals; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } /** @enumType */ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC'; interface Paging { /** * Number of items to load. * @max 1000 */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface CursorPaging { /** * Maximum number of items to return in the results. * @max 1000 */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. * @maxLength 16000 */ cursor?: string | null; } interface QueryInventoryItemsResponse { /** * List of inventory items. * @minSize 1 * @maxSize 1000 */ inventoryItems?: InventoryItem[]; /** Paging metadata. */ pagingMetadata?: PlatformPagingMetadataV2; } interface PlatformPagingMetadataV2 { /** The number of items returned in this response. */ count?: number | null; /** Cursors to navigate through result pages. Returned if cursor paging was used. */ cursors?: CommonCursors; } interface CommonCursors { /** * Cursor string pointing to the next page in the list of results. * @maxLength 16000 */ next?: string | null; /** * Cursor pointing to the previous page in the list of results. * @maxLength 16000 */ prev?: string | null; } interface SearchInventoryItemsRequest { /** Search options. */ search?: CursorSearch; } interface CursorSearch extends CursorSearchPagingMethodOneOf { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging). */ cursorPaging?: CursorPaging; /** * Filter object. * * Learn more about [filtering](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters). */ filter?: Record | null; /** * List of sort objects. * * Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#sorting). * @maxSize 10 */ sort?: Sorting[]; /** * Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories. * @maxSize 10 */ aggregations?: Aggregation[]; /** Free text to match in searchable fields. */ search?: SearchDetails; /** * Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format. * Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z". * @maxLength 50 */ timeZone?: string | null; } /** @oneof */ interface CursorSearchPagingMethodOneOf { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging). */ cursorPaging?: CursorPaging; } interface Aggregation extends AggregationKindOneOf { /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */ value?: ValueAggregation; /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */ range?: RangeAggregation; /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */ scalar?: ScalarAggregation; /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */ dateHistogram?: DateHistogramAggregation; /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */ nested?: NestedAggregation; /** * Aggregation name, returned in `aggregations.results.name`. * @maxLength 100 */ name?: string | null; /** Type of aggregation to perform. Must align with the corresponding aggregation field. */ type?: AggregationTypeWithLiterals; /** * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. * @maxLength 200 */ fieldPath?: string; /** * Deprecated. Use `nested` instead. * @deprecated Deprecated. Use `nested` instead. * @replacedBy kind.nested * @targetRemovalDate 2024-03-30 */ groupBy?: GroupByAggregation; } /** @oneof */ interface AggregationKindOneOf { /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */ value?: ValueAggregation; /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */ range?: RangeAggregation; /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */ scalar?: ScalarAggregation; /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */ dateHistogram?: DateHistogramAggregation; /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */ nested?: NestedAggregation; } interface RangeBucket { /** Inclusive lower bound of the range. Required if `to` is not provided. */ from?: number | null; /** Exclusive upper bound of the range. Required if `from` is not provided. */ to?: number | null; } declare enum SortType { /** Number of matches in the results. */ COUNT = "COUNT", /** Alphabetically by the field value. */ VALUE = "VALUE" } /** @enumType */ type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE'; declare enum SortDirection { /** Descending order. */ DESC = "DESC", /** Ascending order. */ ASC = "ASC" } /** @enumType */ type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC'; declare enum MissingValues { /** Exclude missing values from the aggregation results. */ EXCLUDE = "EXCLUDE", /** Include missing values in the aggregation results. */ INCLUDE = "INCLUDE" } /** @enumType */ type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE'; interface IncludeMissingValuesOptions { /** * Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans. * @maxLength 20 */ addToBucket?: string; } declare enum ScalarType { /** Total number of distinct values. */ COUNT_DISTINCT = "COUNT_DISTINCT", /** Minimum value. */ MIN = "MIN", /** Maximum value. */ MAX = "MAX" } /** @enumType */ type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX'; interface ValueAggregation extends ValueAggregationOptionsOneOf { /** Options for including missing values in results. */ includeOptions?: IncludeMissingValuesOptions; /** Sort type. */ sortType?: SortTypeWithLiterals; /** Sort direction. */ sortDirection?: SortDirectionWithLiterals; /** * Number of aggregation results to return. * Min: `1` * Max: `250` * Default: `10` */ limit?: number | null; /** * Whether to include or exclude missing values in the aggregation results. * Default: `EXCLUDE`. */ missingValues?: MissingValuesWithLiterals; } /** @oneof */ interface ValueAggregationOptionsOneOf { /** Options for including missing values in results. */ includeOptions?: IncludeMissingValuesOptions; } declare enum NestedAggregationType { /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */ VALUE = "VALUE", /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */ RANGE = "RANGE", /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */ SCALAR = "SCALAR", /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */ DATE_HISTOGRAM = "DATE_HISTOGRAM" } /** @enumType */ type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM'; interface RangeAggregation { /** * List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds. * @maxSize 50 */ buckets?: RangeBucket[]; } interface ScalarAggregation { /** Operator type for the scalar aggregation. */ type?: ScalarTypeWithLiterals; } interface DateHistogramAggregation { /** Interval for date histogram aggregation. */ interval?: IntervalWithLiterals; } declare enum Interval { /** Yearly interval */ YEAR = "YEAR", /** Monthly interval */ MONTH = "MONTH", /** Weekly interval */ WEEK = "WEEK", /** Daily interval */ DAY = "DAY", /** Hourly interval */ HOUR = "HOUR", /** Minute interval */ MINUTE = "MINUTE", /** Second interval */ SECOND = "SECOND" } /** @enumType */ type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND'; interface NestedAggregationItem extends NestedAggregationItemKindOneOf { /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */ value?: ValueAggregation; /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */ range?: RangeAggregation; /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */ scalar?: ScalarAggregation; /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */ dateHistogram?: DateHistogramAggregation; /** * Unique, caller-defined aggregation name, returned in `aggregations.results`. * @maxLength 100 */ name?: string | null; /** Type of aggregation to perform. The matching aggregation field must be passed. */ type?: NestedAggregationTypeWithLiterals; /** * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. * @maxLength 200 */ fieldPath?: string; } /** @oneof */ interface NestedAggregationItemKindOneOf { /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */ value?: ValueAggregation; /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */ range?: RangeAggregation; /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */ scalar?: ScalarAggregation; /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */ dateHistogram?: DateHistogramAggregation; } declare enum AggregationType { /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */ VALUE = "VALUE", /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */ RANGE = "RANGE", /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */ SCALAR = "SCALAR", /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */ DATE_HISTOGRAM = "DATE_HISTOGRAM", /** Flattened list of aggregations, where each aggregation is nested within previous one. */ NESTED = "NESTED" } /** @enumType */ type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED'; /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */ interface NestedAggregation { /** * Flattened list of aggregations, where each next aggregation is nested within previous one. * @minSize 2 * @maxSize 3 */ nestedAggregations?: NestedAggregationItem[]; } interface GroupByAggregation extends GroupByAggregationKindOneOf { /** Value aggregation configuration. */ value?: ValueAggregation; /** * Unique, caller-defined aggregation name, returned in `aggregations.results`. * @maxLength 100 */ name?: string | null; /** * Field to aggregate by. * @maxLength 200 */ fieldPath?: string; } /** @oneof */ interface GroupByAggregationKindOneOf { /** Value aggregation configuration. */ value?: ValueAggregation; } interface SearchInventoryItemsResponse { /** * List of inventory items. * @minSize 1 * @maxSize 1000 */ inventoryItems?: InventoryItem[]; /** Paging metadata. */ pagingMetadata?: CursorPagingMetadata; /** Aggregation data. */ aggregationData?: AggregationData; } interface CursorPagingMetadata { /** Number of items returned in current page. */ count?: number | null; /** Cursor strings that point to the next page, previous page, or both. */ cursors?: Cursors; /** * Whether there are more pages to retrieve following the current page. * * + `true`: Another page of results can be retrieved. * + `false`: This is the last page. */ hasNext?: boolean | null; } interface Cursors { /** * Cursor string pointing to the next page in the list of results. * @maxLength 16000 */ next?: string | null; /** * Cursor pointing to the previous page in the list of results. * @maxLength 16000 */ prev?: string | null; } interface AggregationData { /** * List of the aggregated data results. * @maxSize 10000 */ results?: AggregationResults[]; } interface ValueAggregationResult { /** * Value of the field. * @maxLength 100 */ value?: string; /** Number of entities with this value. */ count?: number; } interface RangeAggregationResult { /** Inclusive lower bound of the range. */ from?: number | null; /** Exclusive upper bound of the range. */ to?: number | null; /** Total number of entities in this range. */ count?: number; } interface NestedAggregationResults extends NestedAggregationResultsResultOneOf { /** Value aggregation results. */ values?: ValueResults; /** Range aggregation results. */ ranges?: RangeResults; /** Scalar aggregation results. */ scalar?: AggregationResultsScalarResult; /** * Unique, caller-defined aggregation name, identifiable by the requested aggregation `name`. * @maxLength 100 */ name?: string; /** Aggregation type. */ type?: AggregationTypeWithLiterals; /** * Field which the data was aggregated by. * @maxLength 200 */ fieldPath?: string; } /** @oneof */ interface NestedAggregationResultsResultOneOf { /** Value aggregation results. */ values?: ValueResults; /** Range aggregation results. */ ranges?: RangeResults; /** Scalar aggregation results. */ scalar?: AggregationResultsScalarResult; } interface ValueResults { /** * List of value aggregations. * @maxSize 250 */ results?: ValueAggregationResult[]; } interface RangeResults { /** * List of ranges returned in same order as requested. * @maxSize 50 */ results?: RangeAggregationResult[]; } interface AggregationResultsScalarResult { /** Type of scalar aggregation. */ type?: ScalarTypeWithLiterals; /** Value of the scalar aggregation. */ value?: number; } interface NestedValueAggregationResult { /** * Value of the field. * @maxLength 1000 */ value?: string; /** Nested aggregations. */ nestedResults?: NestedAggregationResults; } interface ValueResult { /** * Value of the field. * @maxLength 1000 */ value?: string; /** Number of entities with this value. */ count?: number | null; } interface RangeResult { /** Inclusive lower bound of the range. */ from?: number | null; /** Exclusive upper bound of the range. */ to?: number | null; /** Total number of entities in this range. */ count?: number | null; } interface ScalarResult { /** Value of the scalar aggregation. */ value?: number; } interface NestedResultValue extends NestedResultValueResultOneOf { /** Value aggregation result. */ value?: ValueResult; /** Range aggregation result. */ range?: RangeResult; /** Scalar aggregation result. */ scalar?: ScalarResult; /** Date histogram aggregation result. */ dateHistogram?: ValueResult; } /** @oneof */ interface NestedResultValueResultOneOf { /** Value aggregation result. */ value?: ValueResult; /** Range aggregation result. */ range?: RangeResult; /** Scalar aggregation result. */ scalar?: ScalarResult; /** Date histogram aggregation result. */ dateHistogram?: ValueResult; } interface Results { /** List of nested aggregations. */ results?: Record; } interface DateHistogramResult { /** * Date in ISO 8601 format. * @maxLength 100 */ value?: string; /** Count of documents in the bucket. */ count?: number; } interface GroupByValueResults { /** * List of value aggregations. * @maxSize 1000 */ results?: NestedValueAggregationResult[]; } interface DateHistogramResults { /** * List of date histogram aggregations. * @maxSize 200 */ results?: DateHistogramResult[]; } /** * Results of `NESTED` aggregation type in a flattened form. * Aggregations in resulting array are keyed by requested aggregation `name`. */ interface NestedResults { /** * List of nested aggregations. * @maxSize 1000 */ results?: Results[]; } interface AggregationResults extends AggregationResultsResultOneOf { /** Value aggregation results. */ values?: ValueResults; /** Range aggregation results. */ ranges?: RangeResults; /** Scalar aggregation results. */ scalar?: AggregationResultsScalarResult; /** Group by value aggregation results. */ groupedByValue?: GroupByValueResults; /** Date histogram aggregation results. */ dateHistogram?: DateHistogramResults; /** Nested aggregation results. */ nested?: NestedResults; /** * Aggregation name, returned in `aggregations.results.name`. * @maxLength 100 */ name?: string; /** Aggregation type. Must align with the corresponding aggregation field. */ type?: AggregationTypeWithLiterals; /** * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. * @maxLength 200 */ fieldPath?: string; } /** @oneof */ interface AggregationResultsResultOneOf { /** Value aggregation results. */ values?: ValueResults; /** Range aggregation results. */ ranges?: RangeResults; /** Scalar aggregation results. */ scalar?: AggregationResultsScalarResult; /** Group by value aggregation results. */ groupedByValue?: GroupByValueResults; /** Date histogram aggregation results. */ dateHistogram?: DateHistogramResults; /** Nested aggregation results. */ nested?: NestedResults; } interface SearchInventoryItemsWithOffsetRequest { /** WQL expression. */ search?: OffsetSearch; } interface OffsetSearch extends OffsetSearchPagingMethodOneOf { /** Paging options to limit and offset the number of items. */ paging?: Paging; /** * Filter object. * * Learn more about [filtering](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters). */ filter?: Record | null; /** * Sort object. * * Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#sorting). * @maxSize 10 */ sort?: Sorting[]; /** * Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. * @maxLength 200 * @maxSize 20 */ fields?: string[]; /** * Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. * @maxLength 100 * @maxSize 20 */ fieldsets?: string[]; /** * Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories. * @maxSize 10 */ aggregations?: Aggregation[]; /** Free text to match in searchable fields. */ search?: SearchDetails; /** * Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format. * Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z". * @maxLength 50 */ timeZone?: string | null; } /** @oneof */ interface OffsetSearchPagingMethodOneOf { /** Paging options to limit and offset the number of items. */ paging?: Paging; } interface SearchInventoryItemsWithOffsetResponse { /** InventoryItems which satisfy the provided query. */ inventoryItems?: InventoryItem[]; /** Paging metadata. Contains cursor which can be used in next query. */ pagingMetadata?: PagingMetadata; } interface PagingMetadata { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; } interface BulkDecrementInventoryItemsRequest { /** * Inventory item IDs and decrement data. * @minSize 1 * @maxSize 300 */ decrementData: DecrementDataById[]; /** * Whether inventory is restricted from going below zero. * * Default: `true` - inventory does not go below zero. */ restrictInventory?: boolean | null; /** * Whether to return the full inventory item entities in the response. * * Default: `false` */ returnEntity?: boolean; /** Reason for decrement inventory action. */ reason?: ReasonTypeWithLiterals; } interface DecrementDataById { /** * Inventory item ID. * @format GUID */ inventoryItemId?: string; /** * Amount to decrement by. * @min 1 * @max 99999 */ decrementBy?: number; /** * Whether the request to decrement the inventory item's quantity was made as part of a purchase that includes preorder items. * * + If `true` and the item is available for preorder in the default location, negative inventory quantity is allowed. * + If `false` and the item is not available for preorder, negative inventory is not allowed. */ preorderRequest?: boolean; } interface BulkDecrementInventoryItemsResponse { /** * Inventory items updated by bulk action. * @minSize 1 * @maxSize 300 */ results?: V3BulkInventoryItemResult[]; /** Bulk action metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkIncrementInventoryItemsRequest { /** * Inventory item IDs and increment data. * @minSize 1 * @maxSize 300 */ incrementData: IncrementDataById[]; /** * Whether to return the full inventory item entities in the response. * * Default: `false` */ returnEntity?: boolean; /** Reason for increment inventory action. */ reason?: ReasonTypeWithLiterals; } interface IncrementDataById { /** * Inventory item ID. * @format GUID */ inventoryItemId?: string; /** * Amount to increment by. * @min 1 * @max 99999 */ incrementBy?: number; } interface BulkIncrementInventoryItemsResponse { /** * Inventory items updated by bulk action. * @minSize 1 * @maxSize 300 */ results?: V3BulkInventoryItemResult[]; /** Bulk action metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkDecrementInventoryItemsByVariantAndLocationRequest { /** * Variant and location IDs, as well as decrement data. * @minSize 1 * @maxSize 300 */ decrementData: DecrementDataByVariantAndLocation[]; /** * Whether to allow negative inventory following this decrement action. * * Default: `false` (negative inventory is not allowed) */ restrictInventory?: boolean | null; /** * Whether to return the full inventory item entities in the response. * * Default: `false` */ returnEntity?: boolean; /** Reason for decrement inventory action. */ reason?: ReasonTypeWithLiterals; } interface DecrementDataByVariantAndLocation { /** * Variant ID. * @format GUID */ variantId?: string; /** * Location ID. * @format GUID */ locationId?: string | null; /** * Amount to decrement by. * @min 1 * @max 99999 */ decrementBy?: number; /** * Whether the request to decrement the inventory item's quantity was made as part of a purchase that includes preorder items. * * + If `true` and the item is available for preorder in the default location, negative inventory quantity is allowed. * + If `false` and the item is not available for preorder, negative inventory is not allowed. */ preorderRequest?: boolean; } interface BulkDecrementInventoryItemsByVariantAndLocationResponse { /** * Inventory items updated by bulk action. * @minSize 1 * @maxSize 300 */ results?: V3BulkInventoryItemResult[]; /** Bulk action metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkIncrementInventoryItemsByVariantAndLocationRequest { /** * Variant and location IDs, as well as increment data. * @minSize 1 * @maxSize 300 */ incrementData: IncrementDataByVariantAndLocation[]; /** * Whether to return the full inventory item entities in the response. * * Default: `false` */ returnEntity?: boolean; /** Reason for increment inventory action. */ reason?: ReasonTypeWithLiterals; } interface IncrementDataByVariantAndLocation { /** * Variant ID. * @format GUID */ variantId?: string; /** * Location ID. * @format GUID */ locationId?: string | null; /** * Amount to increment by. * @min 1 * @max 99999 */ incrementBy?: number; } interface BulkIncrementInventoryItemsByVariantAndLocationResponse { /** * Inventory items updated by bulk action. * @minSize 1 * @maxSize 300 */ results?: V3BulkInventoryItemResult[]; /** Bulk action metadata details as: totalSuccess and totalFailure. */ bulkActionMetadata?: BulkActionMetadata; } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entityAsJson?: string; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; } interface RestoreInfo { deletedDate?: Date | null; } interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntityAsJson?: string; } interface EntityDeletedEvent { /** Entity that was deleted. */ deletedEntityAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } interface Empty { } interface RecloneSiteRequest { /** @format GUID */ cloneFrom?: string; } interface RecloneSiteResponse { } interface BulkSetOrAdjustInventoryItemsByFilterRequest { /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter: Record | null; /** Action to adjust the inventory by. (e.g increment or decrement) */ adjustedInventoryAction: AdjustInventoryAction; /** Free text to match in searchable fields */ search?: SearchDetails; } interface AdjustInventoryAction extends AdjustInventoryActionActionOneOf { /** * Amount to increment by. * @min 1 * @max 99999 */ incrementBy?: number; /** * Amount to decrement by. * Quantity can be reduced until it reaches zero but not below. Attempting to further decrease an already negative inventory will fail. * @min 1 * @max 99999 */ decrementBy?: number; } /** @oneof */ interface AdjustInventoryActionActionOneOf { /** * Amount to increment by. * @min 1 * @max 99999 */ incrementBy?: number; /** * Amount to decrement by. * Quantity can be reduced until it reaches zero but not below. Attempting to further decrease an already negative inventory will fail. * @min 1 * @max 99999 */ decrementBy?: number; } interface BulkSetOrAdjustInventoryItemsByFilterResponse { /** * Job ID. * * Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/introduction) to retrieve job details and metadata. * @format GUID */ jobId?: string; } interface BulkAdjustInventoryItemsByFilterRequest { /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter: Record | null; /** Action to adjust the inventory by (e.g. increment or decrement). */ adjustment: AdjustInventoryAction; /** Free text to match in searchable fields. */ search?: SearchDetails; /** If set to `true`, will set track method to track quantity. Default: `false`. */ trackQuantity?: boolean; } interface BulkAdjustInventoryItemsByFilterResponse { /** * Job ID. * * Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/introduction) to retrieve job details and metadata. * @format GUID */ jobId?: string; } interface BulkCreateInventoryItemsByVariantFilterRequest { /** * Filter for variants. See [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) * for WQL syntax and [Search Variants](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/product-variants-reader/search-variants) * for available filter fields. */ filter: Record | null; /** * Free text to match in searchable fields. * When both `filter` and `search` are provided, results must satisfy both conditions (AND logic). * Use `filter` for precise field-based criteria and `search` for broad text matching. */ search?: SearchDetails; /** * Target location ID where inventory items will be created. * @format GUID */ locationId: string; /** Inventory data for created inventory items. */ inventoryCreationData?: InventoryCreationData; } interface InventoryCreationData { /** * Default quantity for created inventory items. * Items will be created with quantity tracking enabled and this initial quantity. * @max 99999 */ quantity?: number; } interface BulkCreateInventoryItemsByVariantFilterResponse { /** * Job ID. * * Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/introduction) to retrieve job details and metadata. * @format GUID */ jobId?: string; } /** * Published on Greyhound topic "catalog-rollback-requested" after the site is handled by the V3 population rollback. * Each owning service reacts to this rollback request according to its own policy. */ interface CatalogRollbackRequested { /** * The MetaSite ID of the store whose catalog migration rollback was requested. * @format GUID */ metaSiteId?: string; /** Whether owner services should clean V3 catalog data as a reaction to this rollback request. */ cleanData?: boolean; } interface MessageEnvelope { /** * App instance ID. * @format GUID */ instanceId?: string | null; /** * Event type. * @maxLength 150 */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; /** Details related to the account */ accountInfo?: AccountInfo; } interface IdentificationData extends IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; /** @readonly */ identityType?: WebhookIdentityTypeWithLiterals; } /** @oneof */ interface IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } /** @docsIgnore */ type CreateInventoryItemApplicationErrors = { code?: 'ITEM_ALREADY_EXISTS'; description?: string; data?: Record; } | { code?: 'PRE_ORDER_VALIDATION'; description?: string; data?: Record; }; /** @docsIgnore */ type CreateInventoryItemValidationErrors = { ruleName?: 'REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE'; } | { ruleName?: 'PREORDER_LIMIT_NOT_SUPPORTED_FOR_UNTRACKED_INVENTORY'; } | { ruleName?: 'DUPLICATE_BULK_UPSERT_KEY'; }; /** @docsIgnore */ type BulkCreateInventoryItemsApplicationErrors = { code?: 'PRE_ORDER_VALIDATION'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkCreateInventoryItemsValidationErrors = { ruleName?: 'REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE'; } | { ruleName?: 'PREORDER_LIMIT_NOT_SUPPORTED_FOR_UNTRACKED_INVENTORY'; }; /** @docsIgnore */ type UpdateInventoryItemApplicationErrors = { code?: 'REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE_DECREASING'; description?: string; data?: Record; } | { code?: 'PRE_ORDER_VALIDATION'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkUpdateInventoryItemsApplicationErrors = { code?: 'REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE_DECREASING'; description?: string; data?: Record; } | { code?: 'PRE_ORDER_VALIDATION'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkUpsertInventoryItemsApplicationErrors = { code?: 'INVALID_TARGET_QUANTITY'; description?: string; data?: Record; } | { code?: 'PRE_ORDER_VALIDATION'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkUpdateInventoryItemsByFilterApplicationErrors = { code?: 'REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE_DECREASING'; description?: string; data?: Record; } | { code?: 'PRE_ORDER_VALIDATION'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkDecrementInventoryItemsApplicationErrors = { code?: 'INVENTORY_QUANTITY_NOT_TRACKED'; description?: string; data?: Record; } | { code?: 'INSUFFICIENT_INVENTORY'; description?: string; data?: Record; } | { code?: 'MIN_QUANTITY_LIMIT_REACHED'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkIncrementInventoryItemsApplicationErrors = { code?: 'INVENTORY_QUANTITY_NOT_TRACKED'; description?: string; data?: Record; } | { code?: 'MAX_QUANTITY_LIMIT_REACHED'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkDecrementInventoryItemsByVariantAndLocationApplicationErrors = { code?: 'INVENTORY_QUANTITY_NOT_TRACKED'; description?: string; data?: Record; } | { code?: 'INSUFFICIENT_INVENTORY'; description?: string; data?: Record; } | { code?: 'MIN_QUANTITY_LIMIT_REACHED'; description?: string; data?: Record; } | { code?: 'NOT_FOUND'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkIncrementInventoryItemsByVariantAndLocationApplicationErrors = { code?: 'INVENTORY_QUANTITY_NOT_TRACKED'; description?: string; data?: Record; } | { code?: 'MAX_QUANTITY_LIMIT_REACHED'; description?: string; data?: Record; } | { code?: 'NOT_FOUND'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkSetOrAdjustInventoryItemsByFilterApplicationErrors = { code?: 'INVENTORY_QUANTITY_NOT_TRACKED'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkAdjustInventoryItemsByFilterApplicationErrors = { code?: 'INVENTORY_QUANTITY_NOT_TRACKED'; description?: string; data?: Record; } | { code?: 'INSUFFICIENT_INVENTORY'; description?: string; data?: Record; } | { code?: 'MIN_QUANTITY_LIMIT_REACHED'; description?: string; data?: Record; } | { code?: 'MAX_QUANTITY_LIMIT_REACHED'; description?: string; data?: Record; }; type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createInventoryItem(): __PublicMethodMetaInfo<'POST', {}, CreateInventoryItemRequest$1, CreateInventoryItemRequest, CreateInventoryItemResponse$1, CreateInventoryItemResponse>; declare function bulkCreateInventoryItems(): __PublicMethodMetaInfo<'POST', {}, BulkCreateInventoryItemsRequest$1, BulkCreateInventoryItemsRequest, BulkCreateInventoryItemsResponse$1, BulkCreateInventoryItemsResponse>; declare function getInventoryItem(): __PublicMethodMetaInfo<'GET', { inventoryItemId: string; }, GetInventoryItemRequest$1, GetInventoryItemRequest, GetInventoryItemResponse$1, GetInventoryItemResponse>; declare function updateInventoryItem(): __PublicMethodMetaInfo<'PATCH', { inventoryItemId: string; }, UpdateInventoryItemRequest$1, UpdateInventoryItemRequest, UpdateInventoryItemResponse$1, UpdateInventoryItemResponse>; declare function bulkUpdateInventoryItems(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateInventoryItemsRequest$1, BulkUpdateInventoryItemsRequest, BulkUpdateInventoryItemsResponse$1, BulkUpdateInventoryItemsResponse>; declare function bulkUpsertInventoryItems(): __PublicMethodMetaInfo<'POST', {}, BulkUpsertInventoryItemsRequest$1, BulkUpsertInventoryItemsRequest, BulkUpsertInventoryItemsResponse$1, BulkUpsertInventoryItemsResponse>; declare function bulkUpdateInventoryItemsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateInventoryItemsByFilterRequest$1, BulkUpdateInventoryItemsByFilterRequest, BulkUpdateInventoryItemsByFilterResponse$1, BulkUpdateInventoryItemsByFilterResponse>; declare function deleteInventoryItem(): __PublicMethodMetaInfo<'DELETE', { inventoryItemId: string; }, DeleteInventoryItemRequest$1, DeleteInventoryItemRequest, DeleteInventoryItemResponse$1, DeleteInventoryItemResponse>; declare function bulkDeleteInventoryItems(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteInventoryItemsRequest$1, BulkDeleteInventoryItemsRequest, BulkDeleteInventoryItemsResponse$1, BulkDeleteInventoryItemsResponse>; declare function bulkDeleteInventoryItemsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteInventoryItemsByFilterRequest$1, BulkDeleteInventoryItemsByFilterRequest, BulkDeleteInventoryItemsByFilterResponse$1, BulkDeleteInventoryItemsByFilterResponse>; declare function queryInventoryItems(): __PublicMethodMetaInfo<'GET', {}, QueryInventoryItemsRequest$1, QueryInventoryItemsRequest, QueryInventoryItemsResponse$1, QueryInventoryItemsResponse>; declare function searchInventoryItems(): __PublicMethodMetaInfo<'GET', {}, SearchInventoryItemsRequest$1, SearchInventoryItemsRequest, SearchInventoryItemsResponse$1, SearchInventoryItemsResponse>; declare function bulkDecrementInventoryItems(): __PublicMethodMetaInfo<'POST', {}, BulkDecrementInventoryItemsRequest$1, BulkDecrementInventoryItemsRequest, BulkDecrementInventoryItemsResponse$1, BulkDecrementInventoryItemsResponse>; declare function bulkIncrementInventoryItems(): __PublicMethodMetaInfo<'POST', {}, BulkIncrementInventoryItemsRequest$1, BulkIncrementInventoryItemsRequest, BulkIncrementInventoryItemsResponse$1, BulkIncrementInventoryItemsResponse>; declare function bulkDecrementInventoryItemsByVariantAndLocation(): __PublicMethodMetaInfo<'POST', {}, BulkDecrementInventoryItemsByVariantAndLocationRequest$1, BulkDecrementInventoryItemsByVariantAndLocationRequest, BulkDecrementInventoryItemsByVariantAndLocationResponse$1, BulkDecrementInventoryItemsByVariantAndLocationResponse>; declare function bulkIncrementInventoryItemsByVariantAndLocation(): __PublicMethodMetaInfo<'POST', {}, BulkIncrementInventoryItemsByVariantAndLocationRequest$1, BulkIncrementInventoryItemsByVariantAndLocationRequest, BulkIncrementInventoryItemsByVariantAndLocationResponse$1, BulkIncrementInventoryItemsByVariantAndLocationResponse>; declare function bulkSetOrAdjustInventoryItemsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkSetOrAdjustInventoryItemsByFilterRequest$1, BulkSetOrAdjustInventoryItemsByFilterRequest, BulkSetOrAdjustInventoryItemsByFilterResponse$1, BulkSetOrAdjustInventoryItemsByFilterResponse>; declare function bulkAdjustInventoryItemsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkAdjustInventoryItemsByFilterRequest$1, BulkAdjustInventoryItemsByFilterRequest, BulkAdjustInventoryItemsByFilterResponse$1, BulkAdjustInventoryItemsByFilterResponse>; declare function bulkCreateInventoryItemsByVariantFilter(): __PublicMethodMetaInfo<'POST', {}, BulkCreateInventoryItemsByVariantFilterRequest$1, BulkCreateInventoryItemsByVariantFilterRequest, BulkCreateInventoryItemsByVariantFilterResponse$1, BulkCreateInventoryItemsByVariantFilterResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AdjustInventoryActionActionOneOf as AdjustInventoryActionActionOneOfOriginal, type AdjustInventoryAction as AdjustInventoryActionOriginal, type AggregationData as AggregationDataOriginal, type AggregationKindOneOf as AggregationKindOneOfOriginal, type Aggregation as AggregationOriginal, type AggregationResults as AggregationResultsOriginal, type AggregationResultsResultOneOf as AggregationResultsResultOneOfOriginal, type AggregationResultsScalarResult as AggregationResultsScalarResultOriginal, AggregationType as AggregationTypeOriginal, type AggregationTypeWithLiterals as AggregationTypeWithLiteralsOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, AvailabilityStatus as AvailabilityStatusOriginal, type AvailabilityStatusWithLiterals as AvailabilityStatusWithLiteralsOriginal, type Brand as BrandOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkAdjustInventoryItemsByFilterApplicationErrors as BulkAdjustInventoryItemsByFilterApplicationErrorsOriginal, type BulkAdjustInventoryItemsByFilterRequest as BulkAdjustInventoryItemsByFilterRequestOriginal, type BulkAdjustInventoryItemsByFilterResponse as BulkAdjustInventoryItemsByFilterResponseOriginal, type BulkCreateInventoryItemsApplicationErrors as BulkCreateInventoryItemsApplicationErrorsOriginal, type BulkCreateInventoryItemsByVariantFilterRequest as BulkCreateInventoryItemsByVariantFilterRequestOriginal, type BulkCreateInventoryItemsByVariantFilterResponse as BulkCreateInventoryItemsByVariantFilterResponseOriginal, type BulkCreateInventoryItemsRequest as BulkCreateInventoryItemsRequestOriginal, type BulkCreateInventoryItemsResponse as BulkCreateInventoryItemsResponseOriginal, type BulkCreateInventoryItemsValidationErrors as BulkCreateInventoryItemsValidationErrorsOriginal, type BulkDecrementInventoryItemsApplicationErrors as BulkDecrementInventoryItemsApplicationErrorsOriginal, type BulkDecrementInventoryItemsByVariantAndLocationApplicationErrors as BulkDecrementInventoryItemsByVariantAndLocationApplicationErrorsOriginal, type BulkDecrementInventoryItemsByVariantAndLocationRequest as BulkDecrementInventoryItemsByVariantAndLocationRequestOriginal, type BulkDecrementInventoryItemsByVariantAndLocationResponse as BulkDecrementInventoryItemsByVariantAndLocationResponseOriginal, type BulkDecrementInventoryItemsRequest as BulkDecrementInventoryItemsRequestOriginal, type BulkDecrementInventoryItemsResponse as BulkDecrementInventoryItemsResponseOriginal, type BulkDeleteInventoryItemsByFilterRequest as BulkDeleteInventoryItemsByFilterRequestOriginal, type BulkDeleteInventoryItemsByFilterResponse as BulkDeleteInventoryItemsByFilterResponseOriginal, type BulkDeleteInventoryItemsRequest as BulkDeleteInventoryItemsRequestOriginal, type BulkDeleteInventoryItemsResponse as BulkDeleteInventoryItemsResponseOriginal, type BulkIncrementInventoryItemsApplicationErrors as BulkIncrementInventoryItemsApplicationErrorsOriginal, type BulkIncrementInventoryItemsByVariantAndLocationApplicationErrors as BulkIncrementInventoryItemsByVariantAndLocationApplicationErrorsOriginal, type BulkIncrementInventoryItemsByVariantAndLocationRequest as BulkIncrementInventoryItemsByVariantAndLocationRequestOriginal, type BulkIncrementInventoryItemsByVariantAndLocationResponse as BulkIncrementInventoryItemsByVariantAndLocationResponseOriginal, type BulkIncrementInventoryItemsRequest as BulkIncrementInventoryItemsRequestOriginal, type BulkIncrementInventoryItemsResponse as BulkIncrementInventoryItemsResponseOriginal, type BulkInventoryItemAction as BulkInventoryItemActionOriginal, type BulkInventoryItemResult as BulkInventoryItemResultOriginal, type BulkSetOrAdjustInventoryItemsByFilterApplicationErrors as BulkSetOrAdjustInventoryItemsByFilterApplicationErrorsOriginal, type BulkSetOrAdjustInventoryItemsByFilterRequest as BulkSetOrAdjustInventoryItemsByFilterRequestOriginal, type BulkSetOrAdjustInventoryItemsByFilterResponse as BulkSetOrAdjustInventoryItemsByFilterResponseOriginal, type BulkUpdateInventoryItemsApplicationErrors as BulkUpdateInventoryItemsApplicationErrorsOriginal, type BulkUpdateInventoryItemsByFilterApplicationErrors as BulkUpdateInventoryItemsByFilterApplicationErrorsOriginal, type BulkUpdateInventoryItemsByFilterRequest as BulkUpdateInventoryItemsByFilterRequestOriginal, type BulkUpdateInventoryItemsByFilterResponse as BulkUpdateInventoryItemsByFilterResponseOriginal, type BulkUpdateInventoryItemsRequest as BulkUpdateInventoryItemsRequestOriginal, type BulkUpdateInventoryItemsResponse as BulkUpdateInventoryItemsResponseOriginal, type BulkUpsertInventoryItemResult as BulkUpsertInventoryItemResultOriginal, type BulkUpsertInventoryItemsApplicationErrors as BulkUpsertInventoryItemsApplicationErrorsOriginal, type BulkUpsertInventoryItemsRequest as BulkUpsertInventoryItemsRequestOriginal, type BulkUpsertInventoryItemsResponse as BulkUpsertInventoryItemsResponseOriginal, type CatalogRollbackRequested as CatalogRollbackRequestedOriginal, type CommonCursors as CommonCursorsOriginal, type CreateInventoryItemApplicationErrors as CreateInventoryItemApplicationErrorsOriginal, type CreateInventoryItemRequest as CreateInventoryItemRequestOriginal, type CreateInventoryItemResponse as CreateInventoryItemResponseOriginal, type CreateInventoryItemValidationErrors as CreateInventoryItemValidationErrorsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DateHistogramAggregation as DateHistogramAggregationOriginal, type DateHistogramResult as DateHistogramResultOriginal, type DateHistogramResults as DateHistogramResultsOriginal, type DecrementDataById as DecrementDataByIdOriginal, type DecrementDataByVariantAndLocation as DecrementDataByVariantAndLocationOriginal, type DeleteInventoryItemRequest as DeleteInventoryItemRequestOriginal, type DeleteInventoryItemResponse as DeleteInventoryItemResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, EventType as EventTypeOriginal, type EventTypeWithLiterals as EventTypeWithLiteralsOriginal, type ExtendedFields as ExtendedFieldsOriginal, type File as FileOriginal, type GetInventoryItemRequest as GetInventoryItemRequestOriginal, type GetInventoryItemResponse as GetInventoryItemResponseOriginal, type GroupByAggregationKindOneOf as GroupByAggregationKindOneOfOriginal, type GroupByAggregation as GroupByAggregationOriginal, type GroupByValueResults as GroupByValueResultsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IncludeMissingValuesOptions as IncludeMissingValuesOptionsOriginal, type IncrementDataById as IncrementDataByIdOriginal, type IncrementDataByVariantAndLocation as IncrementDataByVariantAndLocationOriginal, Interval as IntervalOriginal, type IntervalWithLiterals as IntervalWithLiteralsOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type InventoryCreationData as InventoryCreationDataOriginal, type InventoryItem as InventoryItemOriginal, type InventoryItemStockStatusUpdatedEvent as InventoryItemStockStatusUpdatedEventOriginal, type InventoryItemTrackingMethodOneOf as InventoryItemTrackingMethodOneOfOriginal, type InventoryItemUpdatedWithReason as InventoryItemUpdatedWithReasonOriginal, type ItemMetadata as ItemMetadataOriginal, type MaskedInventoryItem as MaskedInventoryItemOriginal, type MessageEnvelope as MessageEnvelopeOriginal, MissingValues as MissingValuesOriginal, type MissingValuesWithLiterals as MissingValuesWithLiteralsOriginal, Mode as ModeOriginal, type ModeWithLiterals as ModeWithLiteralsOriginal, type NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOfOriginal, type NestedAggregationItem as NestedAggregationItemOriginal, type NestedAggregation as NestedAggregationOriginal, type NestedAggregationResults as NestedAggregationResultsOriginal, type NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOfOriginal, NestedAggregationType as NestedAggregationTypeOriginal, type NestedAggregationTypeWithLiterals as NestedAggregationTypeWithLiteralsOriginal, type NestedResultValue as NestedResultValueOriginal, type NestedResultValueResultOneOf as NestedResultValueResultOneOfOriginal, type NestedResults as NestedResultsOriginal, type NestedValueAggregationResult as NestedValueAggregationResultOriginal, type OffsetSearch as OffsetSearchOriginal, type OffsetSearchPagingMethodOneOf as OffsetSearchPagingMethodOneOfOriginal, type Page as PageOriginal, type Pages as PagesOriginal, type PagingMetadata as PagingMetadataOriginal, type Paging as PagingOriginal, type PlatformPagingMetadataV2 as PlatformPagingMetadataV2Original, type PreorderInfo as PreorderInfoOriginal, type Product as ProductOriginal, type QueryInventoryItemsRequest as QueryInventoryItemsRequestOriginal, type QueryInventoryItemsResponse as QueryInventoryItemsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type RangeAggregation as RangeAggregationOriginal, type RangeAggregationResult as RangeAggregationResultOriginal, type RangeBucket as RangeBucketOriginal, type RangeResult as RangeResultOriginal, type RangeResults as RangeResultsOriginal, ReasonType as ReasonTypeOriginal, type ReasonTypeWithLiterals as ReasonTypeWithLiteralsOriginal, type RecloneSiteRequest as RecloneSiteRequestOriginal, type RecloneSiteResponse as RecloneSiteResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type Results as ResultsOriginal, type ScalarAggregation as ScalarAggregationOriginal, type ScalarResult as ScalarResultOriginal, ScalarType as ScalarTypeOriginal, type ScalarTypeWithLiterals as ScalarTypeWithLiteralsOriginal, type SearchDetails as SearchDetailsOriginal, type SearchInventoryItemsRequest as SearchInventoryItemsRequestOriginal, type SearchInventoryItemsResponse as SearchInventoryItemsResponseOriginal, type SearchInventoryItemsWithOffsetRequest as SearchInventoryItemsWithOffsetRequestOriginal, type SearchInventoryItemsWithOffsetResponse as SearchInventoryItemsWithOffsetResponseOriginal, SortDirection as SortDirectionOriginal, type SortDirectionWithLiterals as SortDirectionWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, SortType as SortTypeOriginal, type SortTypeWithLiterals as SortTypeWithLiteralsOriginal, type Sorting as SortingOriginal, type URI as URIOriginal, type URIs as URIsOriginal, type UpdateInventoryItemApplicationErrors as UpdateInventoryItemApplicationErrorsOriginal, type UpdateInventoryItemRequest as UpdateInventoryItemRequestOriginal, type UpdateInventoryItemResponse as UpdateInventoryItemResponseOriginal, type V3BulkInventoryItemResult as V3BulkInventoryItemResultOriginal, type ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOfOriginal, type ValueAggregation as ValueAggregationOriginal, type ValueAggregationResult as ValueAggregationResultOriginal, type ValueResult as ValueResultOriginal, type ValueResults as ValueResultsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkAdjustInventoryItemsByFilter, bulkCreateInventoryItems, bulkCreateInventoryItemsByVariantFilter, bulkDecrementInventoryItems, bulkDecrementInventoryItemsByVariantAndLocation, bulkDeleteInventoryItems, bulkDeleteInventoryItemsByFilter, bulkIncrementInventoryItems, bulkIncrementInventoryItemsByVariantAndLocation, bulkSetOrAdjustInventoryItemsByFilter, bulkUpdateInventoryItems, bulkUpdateInventoryItemsByFilter, bulkUpsertInventoryItems, createInventoryItem, deleteInventoryItem, getInventoryItem, queryInventoryItems, searchInventoryItems, updateInventoryItem };