> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Package: catalogV3 # Namespace: inventoryItemsV3 # Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/inventory-items-v3/inventory-item-created.md ## Introduction # Webhook Permissions Scopes IDs: Read inventory in v3 catalog: SCOPE.STORES.INVENTORY_ITEM_READ --- ## REST API ### Schema ``` Webhook: Inventory Item Created Description: Event body: - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events. - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event. - name: slug | type: string | description: Event name. - name: entityId | type: string | description: ID of the entity associated with the event. - name: eventTime | type: string (date-time) | description: Event timestamp. - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR. - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event. - name: createdEvent | type: object | description: Created event details. - name: entity | type: InventoryItem | description: The created entity. - ONE-OF: - name: inStock | type: boolean | description: 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. - name: quantity | type: integer | description: 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. - name: id | type: string | description: Inventory item GUID. - name: revision | type: string | description: 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. - name: createdDate | type: string | description: Date and time the inventory item was created. - name: updatedDate | type: string | description: Date and time the inventory item was last updated. - name: variantId | type: string | description: Variant GUID. - name: locationId | type: string | description: Stores location GUID. If not specified when creating an inventory item, the store's default location is used. - name: productId | type: string | description: Product GUID. - name: trackQuantity | type: boolean | description: Whether the quantity is being tracked. - name: availabilityStatus | type: AvailabilityStatus | description: Inventory item availability status. - enum: - OUT_OF_STOCK: Item is out of stock. For tracked inventory, `quantity` is zero or negative and preorder isn't available. - IN_STOCK: Item is in stock and available for purchase. For tracked inventory, see the `quantity` field for the exact amount in stock. - PREORDER: Item is available for preorder only. Stock is zero or negative, but preorder is enabled with remaining capacity. - name: preorderInfo | type: PreorderInfo | description: 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. - name: enabled | type: boolean | description: Whether preorder is enabled for this inventory item. > **Note:** Preorder can't be enabled for digital products or products with subscriptions. Default: `false` - name: message | type: string | description: Message displayed to customers when the item is out of stock and preorder is enabled. - name: limit | type: integer | description: Maximum number of items that can be preordered after stock reaches zero. Supported only for inventory items with `trackQuantity = true`. Default: `100000` - name: counter | type: integer | description: Number of times this item has been preordered. Supported only for inventory items with `trackQuantity = true`. - name: quantity | type: integer | description: Remaining quantity available for preorder. Supported only for items with `trackQuantity` set to `true`. - name: product | type: Product | description: Associated product and variant details. - name: name | type: string | description: Product name. - name: directCategoryIds | type: array | description: List of category GUIDs that this product is included in directly. - name: variantName | type: string | description: Variant name. - name: variantSku | type: string | description: Variant SKU (stock keeping unit). - name: variantVisible | type: boolean | description: Whether the variant is visible in the store. - name: extendedFields | type: ExtendedFields | description: 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.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: 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.md). ``` ### Examples ```curl { "entityAsJson": { "id": "68f4f6d1-9711-470c-9e51-77715adbfb64", "revision": "1", "createdDate": "2024-06-26T08:27:58.632Z", "updatedDate": "2024-06-26T08:27:58.632Z", "variantId": "ac00ed6f-1077-4672-b8ec-ace4ec283ff4", "locationId": "d85fbb4d-e415-49b1-98bc-9d22ec338cb1", "productId": "56ba4206-dd72-4c20-ab57-79392fc1cf33", "inStock": true, "trackQuantity": false, "availability": { "status": "PURCHASE" }, "availabilityStatus": "IN_STOCK", "preorderInfo": { "enabled": false } }, "eventTime": "2024-06-26T08:27:58.726958609Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "1" } ``` --- ## JavaScript SDK ### Schema ``` Webhook: onInventoryItemCreated Description: Payload: InventoryItemCreatedEnvelope - name: entity | type: InventoryItem | description: none - ONE-OF: - name: inStock | type: boolean | description: 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. - name: quantity | type: integer | description: 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. - name: _id | type: string | description: Inventory item GUID. - name: revision | type: string | description: 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. - name: _createdDate | type: Date | description: Date and time the inventory item was created. - name: _updatedDate | type: Date | description: Date and time the inventory item was last updated. - name: variantId | type: string | description: Variant GUID. - name: locationId | type: string | description: Stores location GUID. If not specified when creating an inventory item, the store's default location is used. - name: productId | type: string | description: Product GUID. - name: trackQuantity | type: boolean | description: Whether the quantity is being tracked. - name: availabilityStatus | type: AvailabilityStatus | description: Inventory item availability status. - enum: - OUT_OF_STOCK: Item is out of stock. For tracked inventory, `quantity` is zero or negative and preorder isn't available. - IN_STOCK: Item is in stock and available for purchase. For tracked inventory, see the `quantity` field for the exact amount in stock. - PREORDER: Item is available for preorder only. Stock is zero or negative, but preorder is enabled with remaining capacity. - name: preorderInfo | type: PreorderInfo | description: 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. - name: enabled | type: boolean | description: Whether preorder is enabled for this inventory item. > **Note:** Preorder can't be enabled for digital products or products with subscriptions. Default: `false` - name: message | type: string | description: Message displayed to customers when the item is out of stock and preorder is enabled. - name: limit | type: integer | description: Maximum number of items that can be preordered after stock reaches zero. Supported only for inventory items with `trackQuantity = true`. Default: `100000` - name: counter | type: integer | description: Number of times this item has been preordered. Supported only for inventory items with `trackQuantity = true`. - name: quantity | type: integer | description: Remaining quantity available for preorder. Supported only for items with `trackQuantity` set to `true`. - name: product | type: Product | description: Associated product and variant details. - name: name | type: string | description: Product name. - name: directCategoryIds | type: array | description: List of category GUIDs that this product is included in directly. - name: variantName | type: string | description: Variant name. - name: variantSku | type: string | description: Variant SKU (stock keeping unit). - name: variantVisible | type: boolean | description: Whether the variant is visible in the store. - name: extendedFields | type: ExtendedFields | description: 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.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: 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.md). - name: metadata | type: EventMetadata | description: none - name: instanceId | type: string | description: App instance GUID. - name: eventType | type: string | description: Event type. - name: identity | type: IdentificationData | description: The identification type and identity data. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site. - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site. - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.). - name: appId | type: string | description: GUID of an app. - name: identityType | type: WebhookIdentityType | description: - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP - name: accountInfo | type: AccountInfo | description: Details related to the account - name: accountId | type: string | description: GUID of the Wix account associated with the event. - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account. - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site. - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them. - name: entityFqdn | type: string | description: 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`. - name: slug | type: string | description: 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`. - name: entityId | type: string | description: GUID of the entity associated with the event. - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR). - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event. - name: entityEventSequence | type: string | description: 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. ``` ### Examples ```javascript import { inventoryItemsV3 } from '@wix/stores'; inventoryItemsV3.onInventoryItemCreated((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { inventoryItemsV3 } from '@wix/stores'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { inventoryItemsV3, }, }); wixClient.inventoryItemsV3.onInventoryItemCreated((event) => { // handle your event here }); ``` ---