# Create Product ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /products: post: summary: Create Product deprecated: false description: >- Products can be created within your store at Salla by providing the required data in this endpoint. :::tip[Note] You can list available categories from [List Categories](https://docs.salla.dev/api-5394207/) endpoint. ::: :::caution[Alert] - Created products status will be set to `hidden` till attaching one image at least. - Created products status will be set to`out` till adding a value in quantity parameter. - Created products type cannot be changed after a product is created. ::: `products.read_write`- Products Read & Write operationId: Create-Product539 tags: - Default module/Merchant API/APIs/Products - Products parameters: [] requestBody: content: application/json: schema: type: object x-apidog-refs: 01KKDK2X914VFP9RS6MZT7CKX9: $ref: '#/components/schemas/product_request_body' x-apidog-overrides: {} properties: name: type: string description: >- A Product Name is a succinct label for a specific item, aiding in easy identification and categorization within a product listing. price: type: number description: >- Product price is the specified cost assigned to a particular item, determining its value in a commercial transaction. status: type: string description: >- Product status refers to the current condition or state of availability of a particular item within a product catalog or inventory. Available values 'hidden','sale','out'. enum: - sale - out - hidden - deleted product_type: type: string description: >- Product type categorizes items based on shared attributes or characteristics, aiding in effective organization and search within a product inventory. Available values are, 'product', 'service', 'group_products', 'codes', 'digital', 'food', and 'donating' enum: - product - service - group_products - codes - digital - food - booking - donating quantity: type: number description: >- Product quantity indicates the numerical count of a specific item available in inventory, representing its availability for sale or distribution. booking_details: type: object properties: location: type: string description: >- The specific place or site where a reservation or booking is made. examples: - Medina type: type: string description: Booking Type. Required if `booking_details != null` enum: - date_time - date examples: - date_time session_duration: type: number description: >- The length of time that a particular session. Required if `type = date_` session_gap: type: number description: >- The period of time between two consecutive sessions or events, indicating the duration between the end of one session and the start of the next.. Required if `type = date_time` session_count: type: number description: >- Booking Sessions Count, which is the number of sessions allowed for one customer . Required if `booking_details != null` time_strict_value: type: number description: >- A timeframe where it is not applicable to make reservations. examples: - 2 time_strict_type: type: string enum: - minutes - hours - days description: >- The restriction on making bookings within a specific timeframe is measured in minutes, hours, or days. default: days availabilities: type: array description: Required if `booking_details != null` items: type: object properties: day: type: string description: Days which are available for booking. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday examples: - sunday is_available: type: boolean description: Option to enable booking availability. default: true times: type: array description: Required if `booking_details.type = date_time` items: type: object x-stoplight: id: lwi1q37zuo5mw properties: from: type: string description: "The starting time of the of available booking slot in 24 hours format. Required if `booking_details.type = date_time`\r\n" examples: - '14:30' to: type: string description: "The ending time of the of available booking slot in 24 hours format. Required if `booking_details.type = date_time`\r\n" examples: - '17:30' x-apidog-orders: - from - to x-apidog-ignore-properties: [] x-apidog-orders: - day - is_available - times x-apidog-ignore-properties: [] overrides: type: array description: >- Overwrite availability for a particular day, on a particular date items: type: object properties: day: type: string description: Booking Overrides Day enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday examples: - sunday date: type: string description: Booking Overrides Date value examples: - '2022-01-10' x-apidog-orders: - day - date x-apidog-ignore-properties: [] x-apidog-orders: - location - type - session_duration - session_gap - session_count - time_strict_value - time_strict_type - availabilities - overrides x-apidog-ignore-properties: [] unlimited_quantity: type: boolean description: Option to indicate the product is of unlimited quantity. description: type: string description: >- A product description provides detailed information about an item, helping customers understand its features, benefits, and intended use. categories: type: array description: >- A list of categories ID's, that will be associated with the product. items: type: number min_amount_donating: type: number description: The minimum amount to donate. max_amount_donating: type: number description: The maximum amount to donate. sale_price: type: number description: Product sale price value. cost_price: type: number description: >- Product cost price, the amount a business pays to acquire or manufacture a product before any additional expenses, such as overhead or markup, are applied. sale_end: type: string description: >- The date when a promotional sale or discount on a product is scheduled to expire. sale_start: type: string description: >- The date when a promotional sale or discount on a product is scheduled to start. require_shipping: type: boolean description: >- Require shipping indicates whether the product necessitates a physical delivery process or can be provided digitally without shipping. maximum_quantity_per_order: type: number description: >- Maximum quantity per order for the customer or the maximum quantity for the product. weight: type: number description: >- The weight of the product represented in numerical form if applicable. weight_type: type: string description: Weight Type enum: - kg - g - lb - oz video: type: object properties: url: type: string sort: type: number x-apidog-orders: - url - sort description: Video of a youtube url x-apidog-ignore-properties: [] videos: type: array items: type: object properties: url: type: string sort: type: number x-apidog-orders: - url - sort x-apidog-ignore-properties: [] description: >- As well as a single video as mentioned above, It also can be list of videos sku: type: string description: Sku of the product. mpn: type: string description: 'Manufacturer Part Number. ' gtin: type: string description: >- Global Trade Item Number. If `product_type` is set to any of the following: `product`, `group_products`, `codes`, `digital`, `donating` then value can be set. Otherwise, it can be set to `null` calories: type: string description: >- Calories Value. If `product_type` is set to`food`, value can bet set. Otherwise, it can be set to `null` examples: - '500.00' with_tax: type: boolean nullable: true tax_reason_code: type: string enum: - VATEX-SA-29 - VATEX-SA-29-7 - VATEX-SA-30 - VATEX-SA-32 - VATEX-SA-33 - VATEX-SA-34-1 - VATEX-SA-34-2 - VATEX-SA-34-3 - VATEX-SA-34-4 - VATEX-SA-34-5 - VATEX-SA-35 - VATEX-SA-36 - VATEX-SA-EDU - VATEX-SA-HEA - VATEX-SA-MLTRY description: Required if with_tax is false x-apidog-enum: - name: '' value: VATEX-SA-29 description: '' - name: '' value: VATEX-SA-29-7 description: '' - name: '' value: VATEX-SA-30 description: '' - name: '' value: VATEX-SA-32 description: '' - name: '' value: VATEX-SA-33 description: '' - name: '' value: VATEX-SA-34-1 description: '' - name: '' value: VATEX-SA-34-2 description: '' - name: '' value: VATEX-SA-34-3 description: '' - name: '' value: VATEX-SA-34-4 description: '' - name: '' value: VATEX-SA-34-5 description: '' - name: '' value: VATEX-SA-35 description: '' - name: '' value: VATEX-SA-36 description: '' - name: '' value: VATEX-SA-EDU description: '' - name: '' value: VATEX-SA-HEA description: '' - name: '' value: VATEX-SA-MLTRY description: '' hide_quantity: type: boolean description: weather to hide the quantity or not. show_in_web: type: boolean description: >- Whether or not to change the product's status to `hidden` if set to `true` or `sale` if set to `false` x-stoplight: id: b3ok1m511rqrl enable_upload_image: type: boolean description: >- To enable upload image for the product when the customer add it to cart. enable_note: type: boolean description: >- To enable add note for the product when customer add it to cart. pinned: type: boolean description: if you want pinned the product in categories page. active_advance: type: boolean description: if you want to activate product advanced option. subtitle: type: string description: >- Subtitle of the product will display under product name in pages. promotion_title: type: string description: A label to display in the main image. promotion_subtitle: type: string description: A sublabel to display in the main image. metadata_title: type: string description: >- The page title for product will display in search engine results. metadata_description: type: string description: >- The page description for product will display in search engine results. metadata_url: type: string description: >- The page url for product will display in search engine results. x-stoplight: id: d2fi9zezeng0h scoped_prices: type: object properties: scope_id: type: integer description: >- Refers to the id of the scope/market, as of now you can get it from merchant dashboard. price: type: number description: The price of the product. cost_price: type: number description: >- Product cost price, the amount a business pays to acquire or manufacture a product before any additional expenses, such as overhead or markup, are applied sale_price: type: number description: The sale price of the product. sale_end: type: string description: >- The date when a promotional sale or discount on a product is scheduled to expire. sale_start: type: string description: >- The date when a promotional sale or discount on a product is scheduled to start. x-apidog-orders: - scope_id - price - cost_price - sale_price - sale_end - sale_start description: >- Will contain the prices details that related to the store markets/scopes x-apidog-ignore-properties: [] brand_id: type: number description: The brand id for product. tags: type: array description: The tag ids, check tags sections for more details. items: type: number consisted_products: type: array description: The Product is under a Group of Products items: type: object properties: id: type: number description: 'Consisted Product ID ' examples: - 1695653204 quantity: type: number description: Consisted Product Quantity examples: - 1 x-apidog-orders: - id - quantity x-apidog-ignore-properties: [] images: type: array items: type: object properties: original: type: string description: Original quality image URL thumbnail: type: string description: Thumbnail image URL alt: type: string description: Alternative text for the image default: type: boolean description: >- Whether or not the image is the default one for the product sort: type: number description: >- Image's position in a list of other images within the product starting from the sort number 1. required: - original x-apidog-orders: - original - thumbnail - alt - default - sort x-apidog-ignore-properties: [] description: >- We overide the currently attached images and replace them with the newly added ones for this product. channels: type: array x-stoplight: id: k78q9nso2oy2j description: The product to appear in specific channels items: x-stoplight: id: xn1ftrhoxydxl type: string enum: - app - web options: type: array items: &ref_0 $ref: '#/components/schemas/productOption_request_body' sort: type: integer deprecated: true default: 0 title: >- Update product sort is no longer supported in product create/update endpoints description: >- Passing sort will no longer update product sort, use ctegory create/update endpoints to do that. nullable: true x-apidog-orders: - 01KKDK2X914VFP9RS6MZT7CKX9 - sort required: - name - price - product_type x-apidog-ignore-properties: - name - price - status - product_type - quantity - booking_details - unlimited_quantity - description - categories - min_amount_donating - max_amount_donating - sale_price - cost_price - sale_end - sale_start - require_shipping - maximum_quantity_per_order - weight - weight_type - video - videos - sku - mpn - gtin - calories - with_tax - tax_reason_code - hide_quantity - show_in_web - enable_upload_image - enable_note - pinned - active_advance - subtitle - promotion_title - promotion_subtitle - metadata_title - metadata_description - metadata_url - scoped_prices - brand_id - tags - consisted_products - images - channels - options example: name: T-Shirt Blue price: 96.33 status: out product_type: product quantity: 4 booking_details: location: Medina type: date time_strict_value: 5 time_strict_type: days sessions_count: 10 session_gap: 3 session_duration: 50 availabilities: - day: sunday is_available: true times: - from: '09:30' to: '13:00' - from: '12:00' to: '22:00' - day: monday is_available: true times: - from: '10:00' to: '12:00' overrides: - day: sunday date: '2023-04-09' - day: monday date: '2023-04-10' description: textophonious categories: - 1032561074 - 256950451 min_amount_donating: 1 max_amount_donating: 5 sale_price: 43 cost_price: 35 sale_end: '2025-08-13' require_shipping: false maximum_quantity_per_order: 0 weight: 12 weight_type: kg sku: 23-4324432 mpn: '45344432343' gtin: '58636897' hide_quantity: false enable_upload_image: true enable_note: true pinned: true active_advance: true subtitle: Collection 2020 promotion_title: New metadata_title: T-Shirt blue - collection 2020 metadata_description: T-Shirt blue - collection 2020 scoped_prices: - scope_id: 566146469 price: 300 cost_price: 100 sale_price: 239 sale_end: '2025-07-01' sale_start: 2026-07-1 - scope_id: 1473353380 price: 25 cost_price: 12 sale_price: 18 sale_end: '2025-07-01' sale_start: 2026-07-1 brand_id: 1097509908 tags: - 1366932222 - 591845887 images: - original: >- https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg thumbnail: >- https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg alt: image default: true sort: 5 options: - name: option2 display_type: text values: - name: الأزرق price: 120 quantity: 10 - name: الاحمر price: 120 quantity: 10 - name: الاصفر price: 120 quantity: 10 - name: option3 display_type: text values: - name: كبير price: 120 quantity: 10 - name: صغير price: 120 quantity: 10 - name: متوسط price: 120 quantity: 10 responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/product_response_body' headers: {} x-apidog-name: Created Successfully '422': description: '' content: application/json: schema: $ref: '#/components/schemas/error_validation_422' headers: {} x-apidog-name: Error Validation security: - oauth21: - offline_access x-salla-php-method-name: create x-salla-php-return-type: ProductDetails x-apidog-folder: Default module/Merchant API/APIs/Products x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/451700/apis/api-5394167-run components: schemas: productOption_request_body: type: object properties: name: type: string description: >- A distinctive label or title assigned to a specific item or commodity, serving as an identifier and often conveying essential information about the product. required: type: boolean description: Whether or not the product option is required. visibility: type: string description: Product option field visibilty. x-stoplight: id: frqfaaqmqiwvx default: always enum: - always - on_condition x-apidog-enum: - value: always name: '' description: Option is always visible. - value: on_condition name: '' description: Option is visible on conditions. visibility_condition_type: type: string description: >- Visibility condition type. Required if the `visibility` variable is set to `on_condition` x-stoplight: id: ffyarta6r1fan enum: - '=' - '!=' - '>' - < x-apidog-enum: - value: '=' name: '' description: Equal to. - value: '!=' name: '' description: Not equal to. - value: '>' name: '' description: Larger than. - value: < name: '' description: Smaller than. visibility_condition_option: type: string x-stoplight: id: gy9pos0tn8mkx description: >- The product option's ID for the condition. Required if the variable `visibility` is set to `on_condition`. visibility_condition_value: type: string x-stoplight: id: h5z6uezzsirin description: >- The product option value's ID for the condition. Required if the variable `visibility` is set to `on_condition` display_type: type: string description: >- The various choices or variations of a product are visually presented to customers, typically categorized as text, image, or color representations. default: text enum: - text - image - color x-apidog-enum: - value: text name: '' description: Option display type is text. - value: image name: '' description: Option display type is image. - value: color name: '' description: Option display type is color. values: type: array x-stoplight: id: ev9ebib0gu7ui items: x-stoplight: id: xxzdpjiumkk0d type: object properties: name: type: string description: >- A descriptive label or title given to a specific attribute, feature, or characteristic associated with a product, helping to define and differentiate its various qualities or options. price: type: number description: >- The additional price which will be added to the product price when the customer adds/selects this value. Alternatively the value is set 0 if there is no additional price. quantity: type: integer description: >- The specific quantity or number of units available for a particular option or variation of a product. examples: - 10 display_value: type: string description: >- The display value in UI based on display type of option, by default will use the name of value as display value when the 'display_value=text', but in case you used 'image' then you need to set the image id as value You can upload a new image to product using attach image endpoint then use 'image' id from response, otherwise when use 'color' as display type you need to pass the color for example '#000' for black color is_default: type: boolean description: >- The option to indicate if this value is the default value of the product option. required: - name x-apidog-orders: - name - price - quantity - display_value - is_default x-apidog-ignore-properties: [] x-apidog-orders: - name - required - visibility - visibility_condition_type - visibility_condition_option - visibility_condition_value - display_type - values x-apidog-ignore-properties: [] x-apidog-folder: '' product_request_body: type: object properties: name: type: string description: >- A Product Name is a succinct label for a specific item, aiding in easy identification and categorization within a product listing. price: type: number description: >- Product price is the specified cost assigned to a particular item, determining its value in a commercial transaction. status: type: string description: >- Product status refers to the current condition or state of availability of a particular item within a product catalog or inventory. Available values 'hidden','sale','out'. enum: - sale - out - hidden - deleted product_type: type: string description: >- Product type categorizes items based on shared attributes or characteristics, aiding in effective organization and search within a product inventory. Available values are, 'product', 'service', 'group_products', 'codes', 'digital', 'food', and 'donating' enum: - product - service - group_products - codes - digital - food - booking - donating quantity: type: number description: >- Product quantity indicates the numerical count of a specific item available in inventory, representing its availability for sale or distribution. booking_details: type: object properties: location: type: string description: >- The specific place or site where a reservation or booking is made. examples: - Medina type: type: string description: Booking Type. Required if `booking_details != null` enum: - date_time - date examples: - date_time session_duration: type: number description: >- The length of time that a particular session. Required if `type = date_` session_gap: type: number description: >- The period of time between two consecutive sessions or events, indicating the duration between the end of one session and the start of the next.. Required if `type = date_time` session_count: type: number description: >- Booking Sessions Count, which is the number of sessions allowed for one customer . Required if `booking_details != null` time_strict_value: type: number description: A timeframe where it is not applicable to make reservations. examples: - 2 time_strict_type: type: string enum: - minutes - hours - days description: >- The restriction on making bookings within a specific timeframe is measured in minutes, hours, or days. default: days availabilities: type: array description: Required if `booking_details != null` items: type: object properties: day: type: string description: Days which are available for booking. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday examples: - sunday is_available: type: boolean description: Option to enable booking availability. default: true times: type: array description: Required if `booking_details.type = date_time` items: type: object x-stoplight: id: lwi1q37zuo5mw properties: from: type: string description: "The starting time of the of available booking slot in 24 hours format. Required if `booking_details.type = date_time`\r\n" examples: - '14:30' to: type: string description: "The ending time of the of available booking slot in 24 hours format. Required if `booking_details.type = date_time`\r\n" examples: - '17:30' x-apidog-orders: - from - to x-apidog-ignore-properties: [] x-apidog-orders: - day - is_available - times x-apidog-ignore-properties: [] overrides: type: array description: >- Overwrite availability for a particular day, on a particular date items: type: object properties: day: type: string description: Booking Overrides Day enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday examples: - sunday date: type: string description: Booking Overrides Date value examples: - '2022-01-10' x-apidog-orders: - day - date x-apidog-ignore-properties: [] x-apidog-orders: - location - type - session_duration - session_gap - session_count - time_strict_value - time_strict_type - availabilities - overrides x-apidog-ignore-properties: [] unlimited_quantity: type: boolean description: Option to indicate the product is of unlimited quantity. description: type: string description: >- A product description provides detailed information about an item, helping customers understand its features, benefits, and intended use. categories: type: array description: A list of categories ID's, that will be associated with the product. items: type: number min_amount_donating: type: number description: The minimum amount to donate. max_amount_donating: type: number description: The maximum amount to donate. sale_price: type: number description: Product sale price value. cost_price: type: number description: >- Product cost price, the amount a business pays to acquire or manufacture a product before any additional expenses, such as overhead or markup, are applied. sale_end: type: string description: >- The date when a promotional sale or discount on a product is scheduled to expire. sale_start: type: string description: >- The date when a promotional sale or discount on a product is scheduled to start. require_shipping: type: boolean description: >- Require shipping indicates whether the product necessitates a physical delivery process or can be provided digitally without shipping. maximum_quantity_per_order: type: number description: >- Maximum quantity per order for the customer or the maximum quantity for the product. weight: type: number description: >- The weight of the product represented in numerical form if applicable. weight_type: type: string description: Weight Type enum: - kg - g - lb - oz video: type: object properties: url: type: string sort: type: number x-apidog-orders: - url - sort description: Video of a youtube url x-apidog-ignore-properties: [] videos: type: array items: type: object properties: url: type: string sort: type: number x-apidog-orders: - url - sort x-apidog-ignore-properties: [] description: >- As well as a single video as mentioned above, It also can be list of videos sku: type: string description: Sku of the product. mpn: type: string description: 'Manufacturer Part Number. ' gtin: type: string description: >- Global Trade Item Number. If `product_type` is set to any of the following: `product`, `group_products`, `codes`, `digital`, `donating` then value can be set. Otherwise, it can be set to `null` calories: type: string description: >- Calories Value. If `product_type` is set to`food`, value can bet set. Otherwise, it can be set to `null` examples: - '500.00' with_tax: type: boolean nullable: true tax_reason_code: type: string enum: - VATEX-SA-29 - VATEX-SA-29-7 - VATEX-SA-30 - VATEX-SA-32 - VATEX-SA-33 - VATEX-SA-34-1 - VATEX-SA-34-2 - VATEX-SA-34-3 - VATEX-SA-34-4 - VATEX-SA-34-5 - VATEX-SA-35 - VATEX-SA-36 - VATEX-SA-EDU - VATEX-SA-HEA - VATEX-SA-MLTRY description: Required if with_tax is false x-apidog-enum: - name: '' value: VATEX-SA-29 description: '' - name: '' value: VATEX-SA-29-7 description: '' - name: '' value: VATEX-SA-30 description: '' - name: '' value: VATEX-SA-32 description: '' - name: '' value: VATEX-SA-33 description: '' - name: '' value: VATEX-SA-34-1 description: '' - name: '' value: VATEX-SA-34-2 description: '' - name: '' value: VATEX-SA-34-3 description: '' - name: '' value: VATEX-SA-34-4 description: '' - name: '' value: VATEX-SA-34-5 description: '' - name: '' value: VATEX-SA-35 description: '' - name: '' value: VATEX-SA-36 description: '' - name: '' value: VATEX-SA-EDU description: '' - name: '' value: VATEX-SA-HEA description: '' - name: '' value: VATEX-SA-MLTRY description: '' hide_quantity: type: boolean description: weather to hide the quantity or not. show_in_web: type: boolean description: >- Whether or not to change the product's status to `hidden` if set to `true` or `sale` if set to `false` x-stoplight: id: b3ok1m511rqrl enable_upload_image: type: boolean description: >- To enable upload image for the product when the customer add it to cart. enable_note: type: boolean description: To enable add note for the product when customer add it to cart. pinned: type: boolean description: if you want pinned the product in categories page. active_advance: type: boolean description: if you want to activate product advanced option. subtitle: type: string description: Subtitle of the product will display under product name in pages. promotion_title: type: string description: A label to display in the main image. promotion_subtitle: type: string description: A sublabel to display in the main image. metadata_title: type: string description: The page title for product will display in search engine results. metadata_description: type: string description: >- The page description for product will display in search engine results. metadata_url: type: string description: The page url for product will display in search engine results. x-stoplight: id: d2fi9zezeng0h scoped_prices: type: object properties: scope_id: type: integer description: >- Refers to the id of the scope/market, as of now you can get it from merchant dashboard. price: type: number description: The price of the product. cost_price: type: number description: >- Product cost price, the amount a business pays to acquire or manufacture a product before any additional expenses, such as overhead or markup, are applied sale_price: type: number description: The sale price of the product. sale_end: type: string description: >- The date when a promotional sale or discount on a product is scheduled to expire. sale_start: type: string description: >- The date when a promotional sale or discount on a product is scheduled to start. x-apidog-orders: - scope_id - price - cost_price - sale_price - sale_end - sale_start description: >- Will contain the prices details that related to the store markets/scopes x-apidog-ignore-properties: [] brand_id: type: number description: The brand id for product. tags: type: array description: The tag ids, check tags sections for more details. items: type: number consisted_products: type: array description: The Product is under a Group of Products items: type: object properties: id: type: number description: 'Consisted Product ID ' examples: - 1695653204 quantity: type: number description: Consisted Product Quantity examples: - 1 x-apidog-orders: - id - quantity x-apidog-ignore-properties: [] images: type: array items: type: object properties: original: type: string description: Original quality image URL thumbnail: type: string description: Thumbnail image URL alt: type: string description: Alternative text for the image default: type: boolean description: Whether or not the image is the default one for the product sort: type: number description: >- Image's position in a list of other images within the product starting from the sort number 1. required: - original x-apidog-orders: - original - thumbnail - alt - default - sort x-apidog-ignore-properties: [] description: >- We overide the currently attached images and replace them with the newly added ones for this product. channels: type: array x-stoplight: id: k78q9nso2oy2j description: The product to appear in specific channels items: x-stoplight: id: xn1ftrhoxydxl type: string enum: - app - web options: type: array items: *ref_0 required: - name - price - product_type x-apidog-orders: - name - price - status - product_type - quantity - booking_details - unlimited_quantity - description - categories - min_amount_donating - max_amount_donating - sale_price - cost_price - sale_end - sale_start - require_shipping - maximum_quantity_per_order - weight - weight_type - video - videos - sku - mpn - gtin - calories - with_tax - tax_reason_code - hide_quantity - show_in_web - enable_upload_image - enable_note - pinned - active_advance - subtitle - promotion_title - promotion_subtitle - metadata_title - metadata_description - metadata_url - scoped_prices - brand_id - tags - consisted_products - images - channels - options x-apidog-ignore-properties: [] x-apidog-folder: '' product_response_body: type: object properties: status: type: number description: >- Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition. success: type: boolean description: >- Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes. data: $ref: '#/components/schemas/ProductDetails' x-apidog-orders: - status - success - data x-apidog-ignore-properties: [] x-apidog-folder: '' ProductDetails: description: >- Detailed structure of the Product model object showing its fields and data types. type: object x-examples: {} x-tags: - Models title: ProductDetails properties: id: type: number description: A unique identifier for a specific product within a database. promotion: type: object description: Product promotion details properties: title: type: string description: >- Name of a marketing or advertising campaign, offer, or special event to attract and inform potential customers about the promotion's content or benefits. 🌐 [Support multi-language](doc-421122) sub_title: type: string description: >- A secondary title that provides additional context about a promotion, complementing the main title. 🌐 [Support multi-language](doc-421122) x-apidog-orders: - title - sub_title required: - title - sub_title x-apidog-ignore-properties: [] sku: type: string description: >- Stock Keeping Unit is a unique alphanumeric code used to identify and manage specific products within a company's inventory. mpn: type: string description: >- Manufacturer Part Number (MPN) is a unique identifier assigned by manufacturers to products. examples: - '45343' nullable: true gtin: type: string description: >- "Global Trade Item Number" (GTIN), a unique and standardized identifier used to uniquely represent products in the global marketplace. examples: - '14643439' nullable: true type: type: string description: >- The categorization of a product based on its characteristics, features, or intended use. enum: - product - service - group_products - codes - digital - food - donating - booking x-apidog-enum: - value: product name: '' description: Tangible and shippable products - value: service name: '' description: >- Servecable products, such as design, rsearch, printing, writing etc - value: group_products name: '' description: More than a product under one product - value: codes name: '' description: >- Chargable cards (PlayStation Cards), sellable account (Netflix) etc - value: digital name: '' description: Electronic books, Courses, Downloadable files etc - value: food name: '' description: Food and drinks that require special shipping - value: donating name: '' description: Only in case when the store is of type charity - value: booking name: '' description: Consultancy, Medical and Tourism services etc name: type: string description: >- A label for an item, aiding in easy identification and categorization within a product listing. 🌐 [Supports multi-language](doc-421122) short_link_code: type: string description: >- A short and simplified alphanumeric code or URL used to provide a quick and easy way to access or share a specific product's webpage or information. urls: &ref_1 $ref: '#/components/schemas/URLs' price: type: object properties: amount: type: number description: Product price amount currency: type: string description: Product price currency x-apidog-orders: - amount - currency required: - amount - currency x-apidog-ignore-properties: [] taxed_price: type: object properties: amount: type: number description: Product taxed price amount currency: type: string description: Product taxed price currency x-apidog-orders: - amount - currency required: - amount - currency x-apidog-ignore-properties: [] pre_tax_price: type: object description: Product price details before the tax is applied. properties: amount: type: number description: Product price amount currency: type: string description: Product pretax price currency x-apidog-orders: - amount - currency required: - amount - currency x-apidog-ignore-properties: [] tax: type: object description: Product tax price details properties: amount: type: number description: Product tax price amount before the tax is applied. currency: type: string description: Product price currency before the tax is applied.. x-apidog-orders: - amount - currency required: - amount - currency x-apidog-ignore-properties: [] description: type: string description: >- A detailed information about an item. 🌐 [Support multi-language](doc-421122) quantity: type: integer description: The number of items available in stock. unlimited_quantity: type: boolean description: Whether or not the product is of unlimited quantity. status: type: string description: >- Product status refers to the current state of availability of a particular item within a product catalog or inventory. enum: - sale - out - hidden - deleted x-apidog-enum: - value: sale name: '' description: Product on sale, set by the Merchant from the store's dashboard - value: out name: '' description: >- Product is out of stock, set by the Merchant from the store's dashboard - value: hidden name: '' description: >- Product is hidden, set by the Merchant from the store's dashboard - value: deleted name: '' description: >- Product is deleted, set by the Merchant from the store's dashboard is_available: type: boolean description: Whether or not the product is available. views: type: integer description: >- The total number of times a specific product has been viewed by users. sale_price: type: object description: >- The information about the discounted price or special pricing for a product. properties: amount: type: number description: Product sale price amount currency: type: string description: Product sale price currency x-apidog-orders: - amount - currency required: - amount - currency x-apidog-ignore-properties: [] sale_end: type: string description: >- The date or time when a promotional sale or discount on a product is scheduled to expire. require_shipping: type: boolean description: >- Whether or not the product necessitates a physical delivery process or can be provided digitally without shipping. cost_price: type: number description: >- The amount a business pays to acquire or manufacture a product before any additional expenses, such as overhead or markup, are applied weight: type: number description: >- The weight of the product represented in numerical form if applicable. weight_type: type: string description: >- The classification or unit of measurement used to specify the weight of an object or item, such as kilograms (kg), pounds (lb), ounces (oz), or grams (g). enum: - kg - g - lb - oz x-apidog-enum: - value: kg name: '' description: Kilograms - value: g name: '' description: Grams - value: lb name: '' description: Pound - value: oz name: '' description: Ounce with_tax: type: boolean description: Whether or not a tax applied to this product or not. url: type: string description: The hyperlink that leads to a specific product's page. images: type: array items: type: object properties: id: type: number description: >- product image ID is a unique identifier or code assigned to a specific product image within a database or system, enabling efficient management and retrieval of images associated with a product. url: type: string description: >- The web addresses or hyperlinks that point to the online locations of images associated with the product, making it possible to display those images on websites, e-commerce platforms, or other online channels. main: type: boolean default: true description: Image Attribute as ma alt: type: string description: Product images alternative text video_url: type: string type: type: string description: Product images type as `image` or `video`. enum: - image - video x-apidog-enum: - value: image name: '' description: Media type, being image - value: video name: '' description: Media type, being video sort: type: number description: >- Product images sort number, a numerical value or order assigned to product images to determine their sequence or arrangement when displayed. three_d_image_url: type: string description: >- The URL of a 3D image, A product can only has __one__ product image with a 3D URL. main_image: type: string description: The URL of the main image of the product. x-apidog-orders: - id - url - main - alt - video_url - type - sort - three_d_image_url - main_image x-apidog-ignore-properties: [] description: >- Visual representations or pictures of a product, to showcase its appearance, features, and details to potential customers. sold_quantity: type: integer description: >- The total number of items of the product that have been purchased or sold over a certain period. rating: type: object description: >- Product rating details, include information about the ratings and reviews provided by customers for a specific product. properties: total: type: integer description: >- Total quantity of reviews or ratings that a specific product has received, which is often used as a metric to assess the popularity and credibility of the product. count: type: integer description: Counted number of ratings to the product rate: type: number description: >- The numerical evaluation or score given to a product based on level of satisfaction. x-apidog-orders: - total - count - rate required: - total - count - rate x-apidog-ignore-properties: [] regular_price: type: object description: Product regular price details. properties: amount: type: number description: Product regular price amount. currency: type: string description: Product regular price currency x-apidog-orders: - amount - currency required: - amount - currency x-apidog-ignore-properties: [] max_items_per_user: type: number description: >- The limit set on the number of products that an individual user is allowed to purchase. maximum_quantity_per_order: description: >- Maximum quantity per order for the customer or the maximum quantity for the product. type: number nullable: true show_in_app: type: boolean description: Whether or not to show the product in the App. notify_quantity: description: Notify quantity of the product. type: string nullable: true hide_quantity: description: Whether or not to hide the product quantity. type: boolean channels: type: array x-stoplight: id: nwrxrha0zd8pb description: The product to appear in specific channels. items: type: string x-stoplight: id: xm6mx26en8s8p enum: - app - web x-apidog-enum: - value: app name: '' description: Product to appea in the mobile app of the store - value: web name: '' description: Product to appear in the website of the store managed_by_branches: type: boolean description: Whether or not to indicate if the product is managed by branches. service_blocks: type: object description: 'External services for the prodcut. ' properties: installments: type: array description: >- Payment gateways that supports install-mental payments, which have been activated by the merchant from the [dashboard](https://s.salla.sa/payment). items: type: object properties: name: type: string description: >- Payment gateway name, the identifier of a specific payment processing service or platform that facilitates online transactions by securely transferring payment information between a customer, a merchant, and a financial institution, allowing for the authorization and settlement of payments for goods or services. title: type: string description: Payment gateway title, logo: type: string description: >- Payment gateway logo, a text string containing the URL or file path to an image file that serves as the logo for a particular payment gateway. details: type: string description: >- Comprehensive information about a specific payment processing service. x-apidog-orders: - name - title - logo - details x-apidog-ignore-properties: [] x-apidog-orders: - installments required: - installments x-apidog-ignore-properties: [] calories: type: string description: Calories amount of the product. examples: - '500.00' nullable: true starting_price: description: >- The merchant owner should activate this feature from his store from [here](https://s.salla.sa/settings/component/options). type: object properties: amount: type: integer description: >- Product starting price amount,the initial or base price at which a product is offered for sale, typically before any additional options, variations, or customizations are factored in, and it serves as the starting point for pricing. currency: type: string description: Currency of the starting price amount. x-apidog-orders: - amount - currency examples: - '500.00' required: - amount - currency x-apidog-ignore-properties: [] allow_attachments: type: boolean description: Whether or not to allow adding attachments to the prodcut details. is_pinned: type: boolean description: Whether or not to show if the prodcut is pinned. pinned_date: type: string description: The date which the product was pinned at. sort: type: number description: > Passing sort will no longer update product sort, use ctegory create/update endpoints to do that. deprecated: true nullable: true active_advance: type: boolean description: Whether or not to activate advance product details. enable_upload_image: type: boolean description: Whether or not to allow image uploading. updated_at: type: string description: Product last updated date. options: type: array items: $ref: '#/components/schemas/MiniProductOption' description: >- The additional choices that can be selected to customize the product according to preferences. skus: description: Product variants SKUs details type: array items: $ref: '#/components/schemas/ProductVariant' metadata: type: object properties: title: type: string description: >- Product de SEO Metadata Title which is a concise label used to optimize search engine results and enhance the visibility of a product details page. 🌐 [Support multi-language](doc-421122) description: type: string description: >- A succinct summary crafted to enhance search engine optimization . 🌐 [Support multi-language](doc-421122) url: type: string description: >- The web address of the Product Deatils page with embedded metadata (title, description, keywords) to enhance its search engine visibility. 🌐 [Support multi-language](doc-421122) x-apidog-orders: - title - description - url description: >- The data that describes other data, providing details on its creation, format, and context. required: - title - description - url x-apidog-ignore-properties: [] booking_details: type: object properties: id: type: number description: >- Unique identifier or code assigned to a specific booking or reservation, used for tracking, reference, and management purposes examples: - 1521087104 location: type: string description: >- The specific place or venue where a booking or reservation is made, such as a hotel, restaurant, event venue, or transportation service. examples: - Medina type: type: string description: >- Refers to the category or classification of a reservation or booking, indicating the nature or purpose of the booking. Required if `booking_details != null` enum: - date_time - date examples: - time x-apidog-enum: - value: date_time name: '' description: Booking details by date time format - value: date name: '' description: Booking details by date format session_duration: type: string description: >- Booking duration is mandatory when the booking type is set as `date_time`. format: date-time session_gap: type: number description: >- Booking session gap is necessary when the booking type is `date_time`, and it specifies the amount of time between consecutive booking sessions or appointments. sessions_count: type: number description: >- Booking Sessions Count, which is the number of sessions allowed for one customer . Required if `booking_details != null` time_strict_value: type: number description: A timeframe where it is not applicable to make reservations. examples: - 2 time_strict_type: type: string description: >- The restriction on making bookings within a specific timeframe is measured in minutes, hours, or days. enum: - minutes - hours - days default: days x-apidog-enum: - value: minutes name: '' description: Time restriction bu the minutes - value: hours name: '' description: Time restriction bu the hours - value: days name: '' description: Time restriction bu the days availabilities: type: array description: >- Available slots for booking. Required if `booking_details != null` items: type: object properties: day: type: string description: Days which are available for booking. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday examples: - sunday is_available: type: boolean description: Option to enable booking availability. default: true times: type: array description: Required if `booking_details.type = date_time` items: type: object x-stoplight: id: yc1bqhdmo9gld properties: from: type: string description: "The starting time of the of available booking slot in 24 hours format. Required if `booking_details.type = date_time`\r\n" examples: - '14:30' to: type: string description: "The ending time of the of available booking slot in 24 hours format. Required if `booking_details.type = date_time`\r\n" examples: - '17:30' x-apidog-orders: - from - to x-apidog-ignore-properties: [] x-apidog-orders: - day - is_available - times x-apidog-ignore-properties: [] overrides: type: array description: >- Overwrite availability for a particular day, on a particular date. items: type: object properties: id: type: number description: Booking Overrides ID examples: - 520625452 date: type: string description: >- The value of specific date that has been overridden in a booking examples: - '2022-01-10' x-apidog-orders: - id - date x-apidog-ignore-properties: [] x-apidog-orders: - id - location - type - session_duration - session_gap - sessions_count - time_strict_value - time_strict_type - availabilities - overrides description: >- The information related to a specific booking, such as date, time, location, and other relevant particulars required: - id - location - type - session_duration - session_gap - sessions_count - time_strict_value - time_strict_type - availabilities - overrides x-apidog-ignore-properties: [] categories: type: array items: &ref_2 $ref: '#/components/schemas/Category' description: >- The various sections or attributes that describe a product, such as name, price, description, specifications, and availability. brand: $ref: '#/components/schemas/Brand' tags: type: array items: type: object properties: id: type: number description: >- A unique identifier or code assigned to a specific tag or label used for categorization or classification purposes within a system or database. name: type: string description: >- The label or identifier assigned to a specific tag, used for categorizing or organizing items, content, or data within a system or database. x-apidog-orders: - id - name x-apidog-ignore-properties: [] scoped_prices: type: object properties: scope_id: type: string description: >- Branch (scope) unique identification. Get a list of Scope IDs related to the store from [here](https://docs.salla.dev/15104922e0) price: type: integer description: Price of the item / product based on the branch (scope) cost_price: type: integer description: Cost price of the item / product based on the branch (scope) sale_price: type: integer description: Item reduced price due to sale based on the branch (scope) sale_end: type: string description: >- End of the sale of the product / item before the original price is back based on the branch (scope) sale_start: type: string description: >- Start of the sale of the product / item before the original price is back based on the branch (scope) currency: type: string description: Price's currency based on the branch (scope) x-apidog-orders: - scope_id - price - cost_price - sale_price - sale_end - sale_start - currency x-apidog-ignore-properties: [] x-apidog-orders: - id - promotion - sku - mpn - gtin - type - name - short_link_code - urls - price - taxed_price - pre_tax_price - tax - description - quantity - unlimited_quantity - status - is_available - views - sale_price - sale_end - require_shipping - cost_price - weight - weight_type - with_tax - url - images - sold_quantity - rating - regular_price - max_items_per_user - maximum_quantity_per_order - show_in_app - notify_quantity - hide_quantity - channels - managed_by_branches - service_blocks - calories - starting_price - allow_attachments - is_pinned - pinned_date - sort - active_advance - enable_upload_image - updated_at - options - skus - metadata - booking_details - categories - brand - tags - scoped_prices required: - id - promotion - sku - mpn - gtin - type - name - short_link_code - urls - price - taxed_price - pre_tax_price - tax - description - quantity - unlimited_quantity - status - is_available - views - sale_price - sale_end - require_shipping - cost_price - weight - weight_type - with_tax - url - images - sold_quantity - rating - regular_price - max_items_per_user - maximum_quantity_per_order - show_in_app - notify_quantity - hide_quantity - channels - managed_by_branches - service_blocks - calories - starting_price - allow_attachments - is_pinned - pinned_date - active_advance - enable_upload_image - updated_at - options - skus - metadata - booking_details - categories - brand - tags x-apidog-ignore-properties: [] x-apidog-folder: '' Brand: description: >- Detailed structure of the brand model object showing its fields and data types. type: object x-examples: Webhook V2: value: event: brand.deleted merchent: 674390266 created_at: '2021-06-02 22:17:06' data: id: 1473353380 name: زارا description: زارا banner: https://i.ibb.co/jyqRQfQ/avatar-male.webp logo: https://i.ibb.co/jyqRQfQ/avatar-male.webp ar_char: ز en_char: z metadata: title: Zara brand description: Brand awareness seo url: zara/item Webhook V1: value: id: 1473353380 name: زارا description: زارا banner: https://i.ibb.co/jyqRQfQ/avatar-male.webp logo: https://i.ibb.co/jyqRQfQ/avatar-male.webp ar_char: ز en_char: z metadata: title: Zara brand description: Brand awareness seo url: zara/item x-tags: - Models title: Brand properties: id: description: A unique identifier assigned to a specific brand. type: number name: type: string description: >- The label given to a particular company, to identify its products in the market. 🌐 [Support multi-language](doc-421122) label: type: string description: >- The label given to a particular company, to identify its products in the market. 🌐 [Support multi-language](doc-421122) status: type: boolean description: Brand status nullable: true description: type: string description: >- A brief summary of a company, highlighting key attributes, values, and offerings to convey its identity and purpose. 🌐 [Support multi-language](doc-421122) banner: type: string description: >- A text or URL linking to a banner file, used as a visual identifier for a brand on a webpage or platform. nullable: true logo: type: string description: >- A text-based representation or URL link that directs to the logo file. ar_char: type: string description: Brand represented in Arabic characters. en_char: type: string description: Brand represented in English characters. channels: type: array items: type: string description: Brand channels metadata: type: object x-stoplight: id: 8d0s0tfwzpf28 properties: title: type: string description: >- A concise metadata title used to improve search engine visibility and optimize a brand page’s search ranking. 🌐 [Support multi-language](doc-421122) x-stoplight: id: bwvcv90k4e5uu nullable: true description: type: string description: >- Concise content enhancing search visibility and social sharing. 🌐 [Support multi-language](doc-421122) x-stoplight: id: idnybfvxrkyyv nullable: true url: type: string description: >- Web link for enhanced search engine visibility and social media sharing. 🌐 🌐 [Support multi-language](doc-421122) x-stoplight: id: ztu8v1b826bp3 nullable: true x-apidog-orders: - title - description - url required: - title - description - url x-apidog-ignore-properties: [] x-apidog-orders: - id - name - label - status - description - banner - logo - ar_char - en_char - channels - metadata required: - id - name - status - description - banner - logo - ar_char - en_char - metadata x-apidog-ignore-properties: [] x-apidog-folder: '' Category: type: object title: Category x-tags: - Models x-examples: {} properties: id: type: number description: >- Category ID, is a unique identifier assigned to a specific product category, facilitating organized classification and efficient management of products within a similar group. List of categories can be found [here](https://docs.salla.dev/api-5394207). name: type: string description: >- Category name is a descriptive label assigned to a product category, aiding in clear identification and organization of related products. 🌐 [Support multi-language](doc-421122) image: type: string description: The category image urls: *ref_1 parent_id: type: integer description: >- Category Parent ID refers to the unique identifier assigned to the parent category of a subcategory, establishing a hierarchical relationship between different levels of product classification. sort_order: type: integer description: 'The sequence or arrangement of categories when displayed to users. ' nullable: true product_sort_type: type: string description: >- unified or scoped unified means the same sort is applied for all markets if exist, scoped means the sort is applied based on the market. status: type: string description: >- The category status indicates whether the category is currently visible and accessible to users `active` or intentionally concealed from view `hidden`. It essentially controls whether the category is publicly displayed or kept private within the system. enum: - active - hidden x-apidog-enum: - value: active name: '' description: The category is active and visible. - value: hidden name: '' description: The category is inactive and invisible. show_in: type: object properties: app: type: boolean description: Whether or not to show the category in the Salla Merchant App salla_points: type: boolean description: Whether or not to show the category in Salla Points x-apidog-orders: - app - salla_points required: - app - salla_points x-apidog-ignore-properties: [] has_hidden_products: type: boolean description: Whether or not the category has hidden products. update_at: type: string description: The date where the category is updated in. metadata: type: object properties: title: type: string description: >- Category SEO Metadata Title which is a concise label used to optimize search engine results and enhance the visibility of a category page. description: type: string description: >- A succinct summary crafted to enhance search engine optimization and spotlight a brand's attributes within a category. url: type: string description: >- Metadata URL is a web address that contains information designed to improve a webpage's search engine visibility and shareability on social platforms. x-apidog-orders: - title - description - url required: - title - description - url x-apidog-ignore-properties: [] sub_categories: type: array items: type: string description: The subcategories list of the main category. translations: type: object properties: en: type: object properties: name: type: string description: Translated category name metadata: type: object properties: title: type: string description: >- Translated Category SEO Metadata Title which is a concise label used to optimize search engine results and enhance the visibility of a category page. description: type: string description: >- A succinct summary crafted to enhance search engine optimization and spotlight a brand's attributes within a Translated category. url: type: string description: >- Translated Metadata URL is a web address that contains information designed to improve a webpage's search engine visibility and shareability on social platforms. x-apidog-orders: - title - description - url required: - title - description - url x-apidog-ignore-properties: [] x-apidog-orders: - name - metadata required: - name - metadata description: Translation in English language. x-apidog-ignore-properties: [] x-apidog-orders: - en required: - en description: >- **You will get this object in the response if you use `with=translations` query parameter.** Category translations are based on the store's enabled language locale. For instance, if the store supports both Arabic and English, the `translations` object will return two entries: `ar` for Arabic and `en` for English. x-apidog-ignore-properties: [] items: type: array items: *ref_2 description: >- **You will get this array in the response if you use `with=items` query parameter.** x-apidog-orders: - id - name - image - urls - parent_id - sort_order - product_sort_type - status - show_in - has_hidden_products - update_at - metadata - sub_categories - translations - items required: - id - name - image - urls - parent_id - sort_order - product_sort_type - status - show_in - has_hidden_products - update_at - metadata - sub_categories - translations - items x-apidog-ignore-properties: [] x-apidog-folder: '' ProductVariant: description: >- Detailed structure of the product variant model object showing its fields and data types. type: object title: ProductVariant x-tags: - Models x-examples: Example: id: 1115785385 price: amount: 90.5 currency: SAR regular_price: amount: 100.33 currency: SAR sale_price: amount: 90.5 currency: SAR stock_quantity: 4 barcode: abc01 sku: 23-TD23-32 mpn: 43242342 gtin: 54353453 related_options: - 512644768 - 976327842 related_option_values: - 512644768 - 976327842 weight: 3 weight_type: kg weight_label: ٣ كجم properties: id: type: number description: >- A unique identifier associated with a specific variant of a product or item. price: type: object description: The price of the product variant. properties: amount: type: number description: 'The amount of the product price. Example: 96.33' examples: - 96.33 currency: type: string x-apidog-orders: - amount - currency required: - amount - currency x-apidog-ignore-properties: [] regular_price: type: object x-stoplight: id: uub4l1jz09qkf description: The regular price of the product variant. properties: amount: type: number x-stoplight: id: a026eri5g9k4h currency: type: string x-stoplight: id: g8gzh6e6ghf4l x-apidog-orders: - amount - currency required: - amount - currency x-apidog-ignore-properties: [] cost_price: type: object description: The purchase price excluding any additional expenses. x-stoplight: id: 687chslg6fdqy properties: amount: type: number description: 'The value of the cost price amount. Example: 100.33' currency: type: string x-apidog-orders: - amount - currency required: - amount - currency x-apidog-ignore-properties: [] sale_price: type: object description: The sale price of the product variant. properties: amount: type: number description: 'The value of the sale price a Example: 100.33' currency: type: string x-apidog-orders: - amount - currency required: - amount - currency x-apidog-ignore-properties: [] has_special_price: type: boolean readOnly: true description: Whether or not the product variant has a special price. stock_quantity: type: integer description: >- The amount of the product variant total stock quantity. Only updated if the store feature manage product by branches is not activated. examples: - 4 unlimited_quantity: type: boolean x-stoplight: id: 62evc4ca3tf7u description: Whether or not the product variant is of unlimit quantity. notify_low: type: integer x-stoplight: id: j71y502ca9eth description: >- Sets a threshold value to trigger notifications when inventory falls below. barcode: type: string description: The barcode value of product variant. examples: - abc01 sku: type: string description: >- A unique Stock Keeping Unit (SKU) identifier assigned to a specific variant of a product. examples: - 23-TD23-32 mpn: type: string x-stoplight: id: 1xotdb1fnb2p0 description: >- Manufacturer Part Number, a unique identifier assigned by a manufacturer to a specific product or component. gtin: type: string x-stoplight: id: gp8b5bu8mg5y6 description: >- Global Trade Item Number, a unique and standardized identifier used to uniquely represent products, in the global marketplace, to enable efficient tracking and management across supply chains and retail sectors. If `product_type` is set to any of the following: `product`, `group_products`, `codes`, `digital`, `donating` then value can be set. Otherwise, it can be set to `null` updated_at: $ref: '#/components/schemas/Date' description: The date and time product variant is updated. related_options: type: array x-stoplight: id: gwg4szqmpeyr4 description: An array for the related options to this variant. items: x-stoplight: id: 2ezv3bfmmwob0 type: integer related_option_values: type: array x-stoplight: id: ruoh1jjr3rjq6 description: An array for the values of the related options to this variant. items: x-stoplight: id: 78wwfmqiyubcx type: integer weight: type: number description: >- The numerical value that represents the mass or weight of a specific variant of a product. examples: - 3 weight_type: type: string description: Product variant weight type examples: - kg weight_label: type: string description: Product variant weight label representing the type of the weight. examples: - ٣ كجم is_user_subscribed_to_sku: type: boolean readOnly: true description: Whether or not the user subscribed for the sku. is_default: type: boolean description: >- Whether or not enable showing that the product variant is the default x-apidog-orders: - id - price - regular_price - cost_price - sale_price - has_special_price - stock_quantity - unlimited_quantity - notify_low - barcode - sku - mpn - gtin - updated_at - related_options - related_option_values - weight - weight_type - weight_label - is_user_subscribed_to_sku - is_default required: - id - price - regular_price - cost_price - sale_price - has_special_price - stock_quantity - unlimited_quantity - notify_low - barcode - sku - mpn - gtin - updated_at - related_options - related_option_values - weight - weight_type - weight_label - is_user_subscribed_to_sku - is_default x-apidog-ignore-properties: [] x-apidog-folder: '' Date: type: object title: Date x-examples: Example: date: '2020-10-14 14:28:03.000000' timezone_type: 3 timezone: Asia/Riyadh x-tags: - Models properties: date: type: string format: date-time description: >- A specific point in time, typically expressed in terms of a calendar system, including the day, month, year, hour, minutes, seconds and nano seconds. For example: "2020-10-14 14:28:03.000000" timezone_type: type: number description: 'Timezone type of the date, for Middel East = 3 ' timezone: type: string description: Timezone value "Asia/Riyadh" x-apidog-orders: - date - timezone_type - timezone required: - date - timezone_type - timezone x-apidog-ignore-properties: [] x-apidog-folder: '' MiniProductOption: description: >- Detailed structure of the product option model object showing its fields and data types. type: object title: MiniProductOption x-tags: - Models x-examples: {} properties: id: type: number description: >- A unique identifier assigned to a specific product configuration or variant. name: type: string description: >- The label or title used to describe a specific choice or attribute associated with a product. description: type: string description: >- A text or content that provides detailed information about a specific choice associated with a product. nullable: true type: type: string description: Type of the product option, it can be a `radio` button or `checkbox` enum: - radio - checkbox x-apidog-enum: - value: radio name: '' description: Option type of radio. - value: checkbox name: '' description: Option type of checkbox. required: type: boolean description: Whether or not to indicate the product option is obligatory. associated_with_order_time: type: integer description: >- The product option is only relevant to order receiving time when it pertains to date-time selections. **ONLY** for date time options. sort: type: integer description: >- Product option sort refers to the method or criteria used to arrange or order product options. nullable: true display_type: type: string description: The manner in which product choices or attributes are presented. enum: - text - image - color x-apidog-enum: - value: text name: '' description: Option displayed as a text. - value: image name: '' description: Option displayed as an image. - value: color name: '' description: Option displayed as a color. visibility: type: string description: >- Product option visibility based on condition is applied exclusively to products categorized as 'food' or 'service', allowing certain choices or attributes to be shown or hidden based on specific criteria. enum: - always - on_condition x-apidog-enum: - value: always name: '' description: Always on display - value: on_condition name: '' description: Specific conditions to display the product visibility_condition_type: type: string description: Product option visiblity condition type. enum: - '>' - < - '=' - '!=' x-apidog-enum: - value: '>' name: '' description: Visibility condition of Bigger than. - value: < name: '' description: Visibility condition of Smaller than. - value: '=' name: '' description: Visibility condition of Equal to. - value: '!=' name: '' description: Visibility condition of Not equal to. visibility_condition_option: type: integer description: A unique identifier assigned to a specific product option. nullable: true visibility_condition_value: type: integer description: >- A unique identifier associated with a specific value or choice within a product option. nullable: true values: type: array items: $ref: '#/components/schemas/ProductValue' x-apidog-orders: - id - name - description - type - required - associated_with_order_time - sort - display_type - visibility - visibility_condition_type - visibility_condition_option - visibility_condition_value - values required: - id - name - description - type - required - associated_with_order_time - sort - display_type - visibility - visibility_condition_type - visibility_condition_option - visibility_condition_value - values x-apidog-ignore-properties: [] x-apidog-folder: '' ProductValue: description: >- Detailed structure of the product value model object showing its fields and data types. type: object title: ProductValue x-tags: - Models properties: id: type: number description: A unique identifier assigned to a value associated with a product. name: type: string description: Identifying label for a product attribute. price: type: object description: The product price. properties: amount: type: number description: Amout of the price. currency: type: string description: The currency of the amount. x-apidog-orders: - amount - currency x-apidog-ignore-properties: [] formatted_price: type: string description: >- The extra formatted price added when a customer selects a specific value. display_value: type: string description: >- The UI displays values based on the option's display type. By default, it shows the name when `display_value=text`. For `image`, use the image ID (uploaded via the attach image endpoint). For `color`, provide a value like `#000` for black. advance: type: boolean description: Is the option value is advanced or not option_id: description: A unique identifier assigned to a specific choice. type: number image_url: type: string description: The web address where the corresponding image is hosted. hashed_display_value: type: string description: >- if `option.type` = `image` then hashed display value return `image id`. if `option.type` = `text` then hashed display value return value `name` translations: type: object properties: ar: type: object properties: option_details_name: type: string readOnly: true description: Option Details Name in Arabic x-apidog-orders: - option_details_name readOnly: true description: Translation provided in Arabic language. x-apidog-ignore-properties: [] x-apidog-orders: - ar readOnly: true description: Translation of option values in different languages required: - ar x-apidog-ignore-properties: [] is_default: type: boolean description: >- This option will be enabled when this particular value is the default value. is_out_of_stock: type: boolean description: Whether or not the option value is out of stock. readOnly: true x-apidog-orders: - id - name - price - formatted_price - display_value - advance - option_id - image_url - hashed_display_value - translations - is_default - is_out_of_stock required: - id - name - price - formatted_price - display_value - advance - option_id - image_url - hashed_display_value - translations - is_default - is_out_of_stock x-apidog-ignore-properties: [] x-apidog-folder: '' URLs: description: >- To help companies and merchants, Salla provides a “urls” attribute that has been added to different modules to guide the merchants to have the full URL of this module from both scopes, the dashboard scope as a store admin, and as a customer. type: object title: Urls x-examples: Example: customer: https://shtara.com/profile admin: https://shtara.com/profiles x-tags: - Models properties: customer: type: string description: Customer link directly to the order. examples: - https://salla.sa/StoreLink admin: type: string description: Admin dashboard link directly to the order. examples: - https://s.salla./YourStoreDashboard digital_content: type: string description: >- A direct URL link to the digital asset, such as an e-book, image, PDF, video, or any downloadable file linked to the order or product. rating: type: string description: >- Order Rating Link.
Note that the order has to be of either of the following statuses: `completed`, `delivered`, or `shipped`. The merchant has to allow the product to be rated from the [Store Settings](https://s.salla.sa/settings) > Rating Settings checkout: type: string description: >- Order Checkout URL.
Note that the variable will only be returned if the order is unpaid. If the order is already paid, the variable will not appear in the response. x-apidog-orders: - customer - admin - digital_content - rating - checkout required: - customer - admin - digital_content x-apidog-ignore-properties: [] x-apidog-folder: '' error_validation_422: type: object properties: status: type: number description: >- Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition. success: type: boolean description: >- Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes. error: $ref: '#/components/schemas/Validation' x-apidog-orders: - status - success - error x-apidog-ignore-properties: [] x-apidog-folder: '' Validation: type: object properties: code: type: string description: >- Response error code,a numeric or alphanumeric unique identifier used to represent the error. message: type: string description: >- A message or data structure that is generated or returned when the response is not found or explain the error. fields: type: object description: Validation rules with problems properties: '{field-name}': type: array items: type: string x-apidog-orders: - '{field-name}' x-apidog-ignore-properties: [] x-apidog-orders: - code - message - fields required: - code - message - fields x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: bearerAuth: type: bearer scheme: bearer bearerAuth1: type: jwt scheme: bearer bearerFormat: JWT api_key: type: apikey name: api_key in: header petstore_auth: type: oauth2 flows: implicit: authorizationUrl: https://petstore.swagger.io/oauth/authorize scopes: read:pets: read your pets write:pets: modify pets in your account oauth21: type: oauth2 flows: authorizationCode: authorizationUrl: https://accounts.salla.sa/oauth2/auth tokenUrl: ' https://accounts.salla.sa/oauth2/token ' refreshUrl: '' scopes: offline_access: '' x-apidog: addTokenTo: header useTokenType: access_token queryParamKey: access_token headerPrefix: Bearer state: '12345678' redirectUri: https://app.apidog.com/oauth2-browser-callback.html clientId: 8a6c31ed-b841-48ca-85a9-3596e4d60d01 clientSecret: 1c9c66a597ec06c7ab9cd89d9d4e9a8bed005e6ee279e35ede14f905170b1ea5 codeVerifier: '' challengeAlgorithm: S256 clientAuthentication: body useTokenConfigAsRefreshTokenConfig: true authRequestParams: [] tokenRequestParams: [] servers: - url: '' description: Cloud Mock - url: https://api.salla.dev/admin/v2 description: Production security: - oauth21: - offline_access ```