Product
Class name: Product
| Property | Type | Description | Required |
|---|---|---|---|
| vendorId | string | The ID of the vendor that created this product | Yes |
| name | string | The name of the product | Yes |
| variations | ProductVariation[] | The variations of the product (if this is a variable product) | No |
| status | enum | The status of the product, can be draft, pending, trash, published | Yes |
| featured | boolean | Is this product featured? Only admins can set this | No |
| shortDesc | string | The short description of the product, 300 characters max | Yes |
| desc | string | The description of the product. 10000 characters max | No |
| price | double | The price of the product (only for simple products) | No |
| salePrice | double | The sale price of the product (only for simple products) | No |
| stockQuantity | int | The stock quantity of the product | No |
| sku | string | The SKU of the product | Yes |
| moq | int | The minimum order quantity of the product | No |
| weight | double | The weight of the product in kg | No |
| dimensions | double[] | The dimensions of the product in cm. (length, width, height) (only for simple products) | No |
| noteToAdmin | string | Optional note to admin for complaints. E.g. if required variation attributes are unavailable. 200 characters max | No |
| categoryIds | string[] | list of ids of the product categories according to their hierarchy. Eg. mens-wears, sneakers. Note that a product can be only assigned to a category | Yes |
| imageIds | string[] | list of ids of the product images | Yes |
| featuredVideoId | string | An optional featured video id of the product. 1 minute video max. Usually, the ID will be the same as the product ID, since there can only be one of its kind. | No |
| upsells | string[] | list of ids of the upsells products | No |
| crosssells | string[] | list of ids of the crosssells products | No |
| rating | double | The rating of the product. A double value | No |
| wishlistCount | int | The number of users that have this product in their wishlist | No |
| cartCount | int | The number of users that have this product in their cart | No |
| purchaseCount | int | The number of times this product has been purchased | No |
| currency | string | The currency of the product set according to the vendor's perferred currency which helps for rate conversion and payouts | No |
| tagIds | string[] | list of ids of the product tags | No |