> 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 # CreateSupplier # Package: suppliersHub # Namespace: MarketplaceSupplier # Method link: https://dev.wix.com/docs/api-reference/business-solutions/suppliers-hub/suppliers/create-supplier.md ## Permission Scopes: Write Marketplace: SCOPE.SUPPLIERS_HUB.WRITE_MARKETPLACE ## Introduction Creates a supplier profile. The supplier's `appId` is automatically set to the ID of the calling application. Use this endpoint when onboarding new suppliers to your marketplace provider's network. --- ## REST API ### Schema ``` Method: createSupplier Description: Creates a supplier profile. The supplier's `appId` is automatically set to the GUID of the calling application. Use this endpoint when onboarding new suppliers to your marketplace provider's network. URL: https://www.wixapis.com/suppliers-hub/v1/suppliers Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: supplier, supplier.name, supplier.location, supplier.types Method parameters: param name: supplier | type: Supplier | description: A supplier is an individual or company that provides products to marketplace providers, enabling them to sell those products to end users. Suppliers represent the source layer in the marketplace ecosystem, where providers purchase inventory for their catalogs. Suppliers can operate through different business models, either dropshipping or wholesale, maintain ratings and review counts, and be tagged for organization. Each supplier is managed by a specific provider application, tracked via the app GUID. | required: true - name: name | type: string | description: Supplier name. Displayed to providers when browsing and selecting suppliers for their product catalogs. | required: true - name: location | type: Location | description: Supplier location. | required: true - 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. | required: true - 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. Return type: CreateSupplierResponse - name: supplier | type: Supplier | description: The created Supplier. - 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: string | description: Date and time the Supplier was created. - name: updatedDate | type: string | 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. ``` ### Examples ### Create a new supplier Creates a supplier with location and rating information ```curl curl -X POST \ 'https://www.wixapis.com/suppliers-hub/v1/suppliers' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "supplier": { "name": "Top rated", "location": { "country": "CH" }, "rating": "5", "verified": true, "types": [ "WHOLESALE", "DROPSHIPPING" ], "reviewCount": 12544 } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.suppliersHub.MarketplaceSupplier.createSupplier(supplier) Description: Creates a supplier profile. The supplier's `appId` is automatically set to the GUID of the calling application. Use this endpoint when onboarding new suppliers to your marketplace provider's network. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: supplier, supplier.name, supplier.location, supplier.types Method parameters: param name: supplier | type: Supplier | description: A supplier is an individual or company that provides products to marketplace providers, enabling them to sell those products to end users. Suppliers represent the source layer in the marketplace ecosystem, where providers purchase inventory for their catalogs. Suppliers can operate through different business models, either dropshipping or wholesale, maintain ratings and review counts, and be tagged for organization. Each supplier is managed by a specific provider application, tracked via the app GUID. | required: true - name: name | type: string | description: Supplier name. Displayed to providers when browsing and selecting suppliers for their product catalogs. | required: true - name: location | type: Location | description: Supplier location. | required: true - 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. | required: true - 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. Return type: PROMISE - 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. ``` ### Examples ### createSupplier ```javascript import { suppliers } from '@wix/suppliers-hub'; async function createSupplier(supplier) { const response = await suppliers.createSupplier(supplier); }; ``` ### createSupplier (with elevated permissions) ```javascript import { suppliers } from '@wix/suppliers-hub'; import { auth } from '@wix/essentials'; async function myCreateSupplierMethod(supplier) { const elevatedCreateSupplier = auth.elevate(suppliers.createSupplier); const response = await elevatedCreateSupplier(supplier); } ``` ### createSupplier (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { suppliers } from '@wix/suppliers-hub'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { suppliers }, // Include the auth strategy and host as relevant }); async function createSupplier(supplier) { const response = await myWixClient.suppliers.createSupplier(supplier); }; ``` ---