Supplier Object


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 ID.

Properties
appIdstringRead-onlyformat GUID

App ID of the provider application responsible for managing the supplier and its products. Automatically set to the ID of the application making the create request.


createdDatestringRead-onlyformat date-time

Date and time the Supplier was created.


idstringRead-onlyformat GUID

Supplier ID.


locationLocation

Supplier location.


namestringminLength 1maxLength 200

Supplier name. Displayed to providers when browsing and selecting suppliers for their product catalogs.


ratingstringdecimalValue {"gte":"1","lte":"5","maxScale":2}

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.


reviewCountintegerminimum 1format int32

Number of reviews for the supplier. Provider applications should update both rating and reviewCount together to maintain consistency.


revisionstringRead-onlyformat int64

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.


tagsTags

Supplier tags for organization and categorization.


typesArray <string>minItems 1maxItems 2

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.


updatedDatestringRead-onlyformat date-time

Date and time the Supplier was last updated.


verifiedboolean

Whether the supplier has passed verification processes.

Default: false

Did this help?