> 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: suppliersHub # Namespace: suppliers # Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/suppliers-hub/suppliers/supplier-deleted.md ## Introduction Triggered when a supplier is deleted. --- ## REST API ### Schema ``` Webhook: Supplier Deleted Description: Triggered when a supplier is deleted. 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. ``` --- ## JavaScript SDK ### Schema ``` Webhook: onSupplierDeleted Description: Triggered when a supplier is deleted. Payload: SupplierDeletedEnvelope - name: entity | type: Supplier | description: none - name: _id | type: string | description: Supplier GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the Supplier is updated. To prevent conflicting changes, the current revision must be passed when updating the Supplier. Ignored when creating a Supplier. - name: _createdDate | type: Date | description: Date and time the Supplier was created. - name: _updatedDate | type: Date | description: Date and time the Supplier was last updated. - name: name | type: string | description: Supplier name. Displayed to providers when browsing and selecting suppliers for their product catalogs. - name: appId | type: string | description: App GUID of the provider application responsible for managing the supplier and its products. Automatically set to the GUID of the application making the create request. - name: location | type: Location | description: Supplier location. - name: country | type: string | description: 2-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1) format. For example, `US` for United States or `GB` for United Kingdom. - name: rating | type: string | description: Supplier rating from 1.00 to 5.00. For example, `4.25`. Provider applications manage ratings and should update both `rating` and `reviewCount` together to maintain consistency. - name: verified | type: boolean | description: Whether the supplier has passed verification processes. Default: `false` - name: types | type: array | description: Supplier business model types. `DROPSHIPPING` suppliers ship directly to end customers, while `WHOLESALE` suppliers ship in bulk to the provider who fulfills orders. A supplier can support multiple fulfillment models. - enum: - DROPSHIPPING: Supplier ships products directly to end customers. The provider does not handle physical inventory or fulfillment. - WHOLESALE: Supplier ships products in bulk to the provider, who then fulfills orders to end customers. - name: reviewCount | type: integer | description: Number of reviews for the supplier. Provider applications should update both `rating` and `reviewCount` together to maintain consistency. - name: tags | type: Tags | description: Supplier tags for organization and categorization. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - 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 { suppliers } from '@wix/suppliers-hub'; suppliers.onSupplierDeleted((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { suppliers } from '@wix/suppliers-hub'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { suppliers, }, }); wixClient.suppliers.onSupplierDeleted((event) => { // handle your event here }); ``` ---