Send a page with a limited number of products. This parameter determines the number of the page that will be sent in the response.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Determines the number of products on a page.
\n","type":"text/plain"},"key":"items_per_page","value":"1"},{"disabled":true,"description":{"content":"Determines the parameter by which the products are sorted in the response: date, status, list_price, product, price, code, amount
\n","type":"text/plain"},"key":"sort_by","value":"product"},{"disabled":true,"description":{"content":"Determines the sorting order:\nasc—ascending\ndesc—descending
\n","type":"text/plain"},"key":"sort_order","value":"asc"},{"disabled":true,"description":{"content":"List price—searches products with a specific “List price”. If a product has a higher list price than price, then the difference will be considered a discount.
\n","type":"text/plain"},"key":"list_price","value":null},{"disabled":true,"description":{"content":"Price—searches only base product price in your store’s primary currency.
\n","type":"text/plain"},"key":"price","value":null},{"disabled":true,"description":{"content":"Product name—searches the name of the product as it appears on the storefront and in the Administration panel.
\n","type":"text/plain"},"key":"product","value":null},{"disabled":true,"description":{"content":"Product code—a sorting parameter that searches the identifier of the product that you use in your store.
\n","type":"text/plain"},"key":"code","value":null},{"disabled":true,"description":{"content":"In stock—searches the number of products in the stock.
\n","type":"text/plain"},"key":"amount","value":null},{"disabled":true,"description":{"content":"Product name—searches the name of the product as it appears on the storefront and in the Administration panel.
\n","type":"text/plain"},"key":"pname","value":null},{"disabled":true,"description":{"content":"Searches a short product description which appears on the product list on the storefront.
\n","type":"text/plain"},"key":"pshort","value":null},{"disabled":true,"description":{"content":"Searches for products with a specific word or a part of phrase in their “Full description”.
\n","type":"text/plain"},"key":"pfull","value":null},{"disabled":true,"description":{"content":"Meta keywords—searches for a list of search keywords that appear on the product page.
\n","type":"text/plain"},"key":"pkeywords\t\n","value":null},{"disabled":true,"description":{"content":"A parameter used to filter the identifier of the product that you use in your store.
\n","type":"text/plain"},"key":"pcode","value":null},{"disabled":true,"description":{"content":"A parameter used to filter the categories that the product will be assigned to.
\n","type":"text/plain"},"key":"cid","value":null},{"disabled":true,"description":{"content":"Include subcategories of the given category (the cid filter must be used) in the search scope:\nY—Yes\nN—No
\n","type":"text/plain"},"key":"subcats\t\n","value":null},{"disabled":true,"description":{"content":"Searches only for products that have an equal or lower “amount” (product quantity).
\n","type":"text/plain"},"key":"amount_from\t\n","value":null},{"disabled":true,"description":{"content":"Searches only for products that have an equal or higher “amount” (product quantity).
\n","type":"text/plain"},"key":"amount_to\t\n","value":null},{"disabled":true,"description":{"content":"Searches only for products that have an equal or higher “Price”.
\n","type":"text/plain"},"key":"price_from","value":null},{"disabled":true,"description":{"content":"Searches only for products that have an equal or lower “Price”.
\n","type":"text/plain"},"key":"price_to\t\n","value":null},{"disabled":true,"description":{"content":"Comma-separated list of of the order IDs to search the products in:\n1,13,24
\n","type":"text/plain"},"key":"order_ids","value":null},{"disabled":true,"description":{"content":"Searches only for Products with enabled or disabled Free shipping.\nY—Yes\nN—No
\n","type":"text/plain"},"key":"free_shipping\t\n","value":null},{"disabled":true,"description":{"content":"Searches for product with statuses:\nA for Active\nD for Disabled\nH for Hidden
\n","type":"text/plain"},"key":"status","value":null},{"disabled":true,"description":{"content":"Searches for products with the specified age limit only.
\n","type":"text/plain"},"key":"age_limit","value":null},{"disabled":true,"description":{"content":"Searches for products with the age verification and allows to filter them based on the values:\nY—Enabled\nN—Disabled
\n","type":"text/plain"},"key":"age_verification","value":null},{"disabled":true,"description":{"content":"Searches for products with a specific age warning message.
\n","type":"text/plain"},"key":"age_warning_message","value":null},{"disabled":true,"description":{"content":"Filters products:\nP—a Product which appears on the storefront as separate products\nV—a main Product Variation which appears on the storefront as one product
\n","type":"text/plain"},"key":"product_type","value":null},{"disabled":true,"description":{"content":"Searches only for returnable or non-returnable products.\nY—The product is labeled as available for the return.\nN—The product is not available for the return.
\n","type":"text/plain"},"key":"is_returnable","value":null}],"variable":[]}},"response":[{"id":"799a2f2c-51c5-46c9-878e-1330d12d2817","name":"products-list","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"cache-control","value":"no-cache","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"company_id","value":"","type":"text"}]},"url":{"raw":"https://sandbox-api.tijarahub.com/api/products","host":["https://sandbox-api.tijarahub.com/api"],"path":["products"],"query":[{"key":"page","value":"1","description":"Send a page with a limited number of products. This parameter determines the number of the page that will be sent in the response.","disabled":true},{"key":"items_per_page","value":"1","description":"Determines the number of products on a page.","disabled":true},{"key":"sort_by","value":"product","description":"Determines the parameter by which the products are sorted in the response: date, status, list_price, product, price, code, amount","disabled":true},{"key":"","value":"","description":"Determines the sorting order:\nasc—ascending\ndesc—descending","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 01 Aug 2024 08:14:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept-Encoding"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"content-security-policy","value":"frame-ancestors 'self';"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=zp8RsPt1T%2B9Iphc1arldgmhdsxNwyal22%2B3Jvc3DrecJ61Rzrbs0pQh8B9PERRziA8i7AB1nbbyPPIv88Hq3KCRyEEkSc9kprOmkOheGYZRy7TMGYum112Wb9ioZisaFegR%2FajWTNA%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=0; includeSubDomains"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ac45f43d977d564-CDG"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"products\": [],\n \"params\": {\n \"area\": \"A\",\n \"use_caching\": true,\n \"extend\": [\n \"product_name\",\n \"prices\",\n \"categories\",\n \"categories\"\n ],\n \"custom_extend\": [],\n \"pname\": \"Y\",\n \"pshort\": \"Y\",\n \"pfull\": \"Y\",\n \"pkeywords\": \"Y\",\n \"feature\": [],\n \"type\": \"simple\",\n \"page\": 1,\n \"action\": \"\",\n \"filter_variants\": [],\n \"features_hash\": \"\",\n \"limit\": 0,\n \"bid\": 0,\n \"match\": \"all\",\n \"tracking\": [],\n \"get_frontend_urls\": false,\n \"items_per_page\": 50,\n \"apply_disabled_filters\": \"\",\n \"load_products_extra_data\": true,\n \"storefront\": null,\n \"company_ids\": \"\",\n \"subcats\": \"Y\",\n \"pcode_from_q\": \"Y\",\n \"search_performed\": \"Y\",\n \"ajax_custom\": \"1\",\n \"exclude_pid\": 602,\n \"hide_out_of_stock_products\": false,\n \"sort_by\": \"popularity\",\n \"sort_order\": \"desc\",\n \"usergroup_ids\": [],\n \"include_child_variations\": true,\n \"group_child_variations\": false,\n \"sort_order_rev\": \"asc\",\n \"total_items\": \"0\"\n }\n}"}],"_postman_id":"551eb093-988c-4f1c-8abb-c759dd7a834a"},{"name":"Get-a-Specific-Product","id":"69a0761e-aca1-46b9-8cf5-e777d1f19bc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-api.tijarahub.com/api/products/15856","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"info@example.com"},{"key":"password","value":"sFVIBxsMkCYpM8k36A2tqa17Pr2UUIgE74vdELVG41OuGYIu5w"}]},"isInherited":true,"source":{"_postman_id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","name":"Tijarahub-Sandbox","type":"collection"}},"urlObject":{"path":["products","15856"],"host":["https://sandbox-api.tijarahub.com/api"],"query":[{"disabled":true,"description":{"content":"IDs of the categories to which the product belongs
\n","type":"text/plain"},"key":"category_ids\t","value":"Array of valid category IDs\t"},{"disabled":true,"description":{"content":"ID of the main category
\n","type":"text/plain"},"key":"main_category\t","value":"Existing category ID\t"},{"disabled":true,"description":{"content":"The base product price in your store’s primary currency
\n","type":"text/plain"},"key":"price","value":"float"},{"disabled":true,"description":{"content":"ID of the store or vendor the product belongs to
\n","type":"text/plain"},"key":"company_id","value":"integer"},{"disabled":true,"description":{"content":"Product status:\nA for Active\nD for Disabled\nH for Hidden
\n","type":"text/plain"},"key":"status","value":"A\nD\nH"},{"disabled":true,"description":{"content":"The number of products in the stock
\n","type":"text/plain"},"key":"amount\t","value":"integer"},{"disabled":true,"description":{"content":"Date from which the product is available
\n","type":"text/plain"},"key":"avail_since","value":"Date in UNIX format\t"},{"disabled":true,"description":{"content":"Box height
\n","type":"text/plain"},"key":"box_height\t","value":"integer"},{"disabled":true,"description":{"content":"Box length
\n","type":"text/plain"},"key":"box_length\t","value":"integer"},{"disabled":true,"description":{"content":"Box width
\n","type":"text/plain"},"key":"box_width\t","value":"integer\t"},{"disabled":true,"description":{"content":"Product details page layout
\n","type":"text/plain"},"key":"details_layout","value":"Valid product template name\t"},{"disabled":true,"description":{"content":"Only for a downloadable product: Enable/disable shipping
\n","type":"text/plain"},"key":"edp_shipping\t\n","value":"Y\nN"},{"disabled":true,"description":{"content":"Exception type (Allow/ Forbid products with certain option combinations)
\n","type":"text/plain"},"key":"exceptions_type\t\n","value":"A\nF"},{"disabled":true,"description":{"content":"Determines if the Free shipping is allowed
\n","type":"text/plain"},"key":"free_shipping","value":"Y\nN"},{"disabled":true,"description":{"content":"Full product description
\n","type":"text/plain"},"key":"full_description\t","value":"string"},{"disabled":true,"description":{"content":"Additional image pairs
\n","type":"text/plain"},"key":"image_pairs\t","value":"object with image pair ID as key and image pair as value (see below)\t"},{"disabled":true,"description":{"content":"Determines if the product is downloadable or not
\n","type":"text/plain"},"key":"is_edp\t\n","value":"Y\nN"},{"disabled":true,"description":{"content":"Language code
\n","type":"text/plain"},"key":"lang_code\t\n","value":"\t\nen\netc."},{"disabled":true,"description":{"content":"Manufacturer suggested price
\n","type":"text/plain"},"key":"list_price\t","value":"float"},{"disabled":true,"description":{"content":"Number of items in the quantity select box
\n","type":"text/plain"},"key":"list_qty_count","value":"integer"},{"disabled":true,"description":{"content":"String of comma-separated localization IDs
\n","type":"text/plain"},"key":"localization","value":"string"},{"disabled":true,"description":{"content":"Minimal availability in stock value
\n","type":"text/plain"},"key":"low_avail_limit","value":"integer"},{"disabled":true,"description":{"content":"Product image and thumbnail pair
\n","type":"text/plain"},"key":"main_pair","value":"Main pair object\t"},{"disabled":true,"description":{"content":"Maximal number of items per box
\n","type":"text/plain"},"key":"max_items_in_box","value":"integer"},{"disabled":true,"description":{"content":"Maximal order quantity
\n","type":"text/plain"},"key":"max_qty\t","value":"integer"},{"disabled":true,"description":{"content":"Meta description
\n","type":"text/plain"},"key":"meta_description","value":"string"},{"disabled":true,"description":{"content":"Meta keywords
\n","type":"text/plain"},"key":"meta_keywords\t","value":"string"},{"disabled":true,"description":{"content":"Minimal number of items per box
\n","type":"text/plain"},"key":"min_items_in_box\t","value":"integer"},{"disabled":true,"description":{"content":"Minimal order quantity
\n","type":"text/plain"},"key":"min_qty","value":"integer"},{"disabled":true,"description":{"content":"Apply options simultaneously (P) or sequentially (S)
\n","type":"text/plain"},"key":"options_type\t\n","value":"S\nP"},{"disabled":true,"description":{"content":"Out of stock action:\nN for None\nB for Buy in advance\nS for Sign up for notification
\n","type":"text/plain"},"key":"out_of_stock_actions","value":"N\nB\nS"},{"disabled":true,"description":{"content":"Product page title
\n","type":"text/plain"},"key":"page_title\t","value":"string"},{"disabled":true,"description":{"content":"Price in reward points
\n","type":"text/plain"},"key":"point_price","value":"float"},{"disabled":true,"description":{"content":"Product popularity rating based on views, adding to cart, and purchases
\n","type":"text/plain"},"key":"popularity","value":"integer"},{"disabled":true,"description":{"content":"Product code
\n","type":"text/plain"},"key":"product_code","value":"string"},{"disabled":true,"description":{"content":"Product features
\n","type":"text/plain"},"key":"product_features\t","value":"object that contains product features with feature ID as key and feature data as value"},{"disabled":true,"description":{"content":"Promo text that appears on the product page on the storefront
\n","type":"text/plain"},"key":"promo_text","value":"string"},{"disabled":true,"description":{"content":"Quantity step
\n","type":"text/plain"},"key":"qty_step","value":"integer"},{"disabled":true,"description":{"content":"Return period in days
\n","type":"text/plain"},"key":"return_period\t","value":"integer"},{"disabled":true,"description":{"content":"Sales amount
\n","type":"text/plain"},"key":"sales_amount\t","value":"integer"},{"disabled":true,"description":{"content":"Search keywords for the product
\n","type":"text/plain"},"key":"search_words","value":"string"},{"disabled":true,"description":{"content":"SEO name for the product page
\n","type":"text/plain"},"key":"seo_name\t","value":"string"},{"disabled":true,"description":{"content":"Only for the Store Builder Ultimate: determines if the Product is shared on storefronts
\n","type":"text/plain"},"key":"shared_product\t\n","value":"Y\nN"},{"disabled":true,"description":{"content":"Shipping freight
\n","type":"text/plain"},"key":"shipping_freight\t","value":"float"},{"disabled":true,"description":{"content":"Aggregated shipping data
\n","type":"text/plain"},"key":"shipping_params","value":"string"},{"disabled":true,"description":{"content":"Short description
\n","type":"text/plain"},"key":"short_description\t","value":"string"},{"disabled":true,"description":{"content":"Array of tax IDs which are selected for the Product
\n","type":"text/plain"},"key":"tax_ids","value":"array"},{"disabled":true,"description":{"content":"Inventory tracking mode\nB for “Track”\nD for “Do not track”
\n","type":"text/plain"},"key":"tracking","value":"B\nD"},{"disabled":true,"description":{"content":"For EDP (downloadable products): determines if a product can be downloaded a limited number of times (N), or as many times as needed (Y)
\n","type":"text/plain"},"key":"unlimited_download\t\n","value":"Y\nN"},{"disabled":true,"description":{"content":"Last update timestamp
\n","type":"text/plain"},"key":"updated_timestamp","value":"Valid timestamp in UNIX format\t"},{"disabled":true,"description":{"content":"IDs of user groups that can see this product
\n","type":"text/plain"},"key":"usergroup_ids","value":"String of comma-separated user group IDs\t"},{"disabled":true,"description":{"content":"Weight
\n","type":"text/plain"},"key":"weight","value":"float"},{"disabled":true,"description":{"content":"Zero price action\nR for “Do not allow customers to add product to cart”\nP for “Allow customers to add product to cart”\nA for “Ask customer to enter the price”
\n","type":"text/plain"},"key":"zero_price_action\t\n","value":"R\nP\nA"},{"disabled":true,"key":"product_id","value":""}],"variable":[]}},"response":[{"id":"fd277e4b-c252-4405-a5dc-7ffcc69b50fc","name":"Get-a-Specific-Product","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic base64('$vendor_email:$api_token');","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://sandbox-api.tijarahub.com/api/products/15788","host":["https://sandbox-api.tijarahub.com/api"],"path":["products","15788"],"query":[{"key":"category_ids\t","value":"Array of valid category IDs\t","description":"IDs of the categories to which the product belongs\n","disabled":true},{"key":"main_category\t","value":"Existing category ID\t","description":"ID of the main category\n","disabled":true},{"key":"price","value":"float","description":"The base product price in your store’s primary currency\n","disabled":true},{"key":"company_id","value":"integer","description":"ID of the store or vendor the product belongs to\n","disabled":true},{"key":"status","value":"A\nD\nH","description":"Product status:\nA for Active\nD for Disabled\nH for Hidden","disabled":true},{"key":"amount\t","value":"integer","description":"The number of products in the stock\n","disabled":true},{"key":"avail_since","value":"Date in UNIX format\t","description":"Date from which the product is available\n","disabled":true},{"key":"box_height\t","value":"integer","description":"Box height\n","disabled":true},{"key":"box_length\t","value":"integer","description":"Box length\n","disabled":true},{"key":"box_width\t","value":"integer\t","description":"Box width\n","disabled":true},{"key":"details_layout","value":"Valid product template name\t","description":"Product details page layout\n","disabled":true},{"key":"edp_shipping\t\n","value":"Y\nN","description":"Only for a downloadable product: Enable/disable shipping\n","disabled":true},{"key":"exceptions_type\t\n","value":"A\nF","description":"Exception type (Allow/ Forbid products with certain option combinations)\n","disabled":true},{"key":"free_shipping","value":"Y\nN","description":"Determines if the Free shipping is allowed\n","disabled":true},{"key":"full_description\t","value":"string","description":"Full product description\n","disabled":true},{"key":"image_pairs\t","value":"object with image pair ID as key and image pair as value (see below)\t","description":"Additional image pairs\n","disabled":true},{"key":"is_edp\t\n","value":"Y\nN","description":"Determines if the product is downloadable or not\n","disabled":true},{"key":"lang_code\t\n","value":"\t\nen\netc.","description":"Language code\n","disabled":true},{"key":"list_price\t","value":"float","description":"Manufacturer suggested price\n","disabled":true},{"key":"list_qty_count","value":"integer","description":"Number of items in the quantity select box\n","disabled":true},{"key":"localization","value":"string","description":"String of comma-separated localization IDs\n","disabled":true},{"key":"low_avail_limit","value":"integer","description":"Minimal availability in stock value\n","disabled":true},{"key":"main_pair","value":"Main pair object\t","description":"Product image and thumbnail pair\n","disabled":true},{"key":"max_items_in_box","value":"integer","description":"Maximal number of items per box\n","disabled":true},{"key":"max_qty\t","value":"integer","description":"Maximal order quantity\n","disabled":true},{"key":"meta_description","value":"string","description":"Meta description\n","disabled":true},{"key":"meta_keywords\t","value":"string","description":"Meta keywords\n","disabled":true},{"key":"min_items_in_box\t","value":"integer","description":"Minimal number of items per box\n","disabled":true},{"key":"min_qty","value":"integer","description":"Minimal order quantity\n","disabled":true},{"key":"options_type\t\n","value":"S\nP","description":"Apply options simultaneously (P) or sequentially (S)\n","disabled":true},{"key":"out_of_stock_actions","value":"N\nB\nS","description":"Out of stock action:\nN for None\nB for Buy in advance\nS for Sign up for notification","disabled":true},{"key":"page_title\t","value":"string","description":"Product page title\n","disabled":true},{"key":"point_price","value":"float","description":"Price in reward points\n","disabled":true},{"key":"popularity","value":"integer","description":"Product popularity rating based on views, adding to cart, and purchases\n","disabled":true},{"key":"product_code","value":"string","description":"Product code\n","disabled":true},{"key":"product_features\t","value":"object that contains product features with feature ID as key and feature data as value","description":"Product features","disabled":true},{"key":"promo_text","value":"string","description":"Promo text that appears on the product page on the storefront\n","disabled":true},{"key":"qty_step","value":"integer","description":"Quantity step\n","disabled":true},{"key":"return_period\t","value":"integer","description":"Return period in days\n","disabled":true},{"key":"sales_amount\t","value":"integer","description":"Sales amount\n","disabled":true},{"key":"search_words","value":"string","description":"Search keywords for the product\n","disabled":true},{"key":"seo_name\t","value":"string","description":"SEO name for the product page\n","disabled":true},{"key":"shared_product\t\n","value":"Y\nN","description":"Only for the Store Builder Ultimate: determines if the Product is shared on storefronts\n","disabled":true},{"key":"shipping_freight\t","value":"float","description":"Shipping freight\n","disabled":true},{"key":"shipping_params","value":"string","description":"Aggregated shipping data\n","disabled":true},{"key":"short_description\t","value":"string","description":"Short description\n","disabled":true},{"key":"tax_ids","value":"array","description":"Array of tax IDs which are selected for the Product\n","disabled":true},{"key":"tracking","value":"B\nD","description":"Inventory tracking mode\nB for “Track”\nD for “Do not track”","disabled":true},{"key":"unlimited_download\t\n","value":"Y\nN","description":"For EDP (downloadable products): determines if a product can be downloaded a limited number of times (N), or as many times as needed (Y)","disabled":true},{"key":"updated_timestamp","value":"Valid timestamp in UNIX format\t","description":"Last update timestamp\n","disabled":true},{"key":"usergroup_ids","value":"String of comma-separated user group IDs\t","description":"IDs of user groups that can see this product\n","disabled":true},{"key":"weight","value":"float","description":"Weight","disabled":true},{"key":"zero_price_action\t\n","value":"R\nP\nA","description":"Zero price action\nR for “Do not allow customers to add product to cart”\nP for “Allow customers to add product to cart”\nA for “Ask customer to enter the price”","disabled":true},{"key":"product_id","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 Aug 2024 13:11:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept-Encoding"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"content-security-policy","value":"frame-ancestors 'self';"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=OMOrBrrmbV1oaNsKo8fwjmYHGZag%2FhF4orqgym5CcQYbE4ZSzF13eqeBzTzhjFhWUHh%2B69ItpScYTFZ79x6fI%2FXviKUpPVxXESdrOkTlfmouZjbIbqT%2FcrTmi2k3OCASzUGBlhKytQ%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=0; includeSubDomains"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8aef45edef32be5a-ZRH"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"min_items_in_box\": 0,\n \"max_items_in_box\": 0,\n \"box_length\": 0,\n \"box_width\": 0,\n \"box_height\": 0,\n \"product_id\": 15788,\n \"product_code\": \"\",\n \"product_type\": \"P\",\n \"status\": \"A\",\n \"company_id\": \"5\",\n \"list_price\": \"0.00\",\n \"amount\": \"0\",\n \"weight\": \"0.000\",\n \"length\": \"0\",\n \"width\": \"0\",\n \"height\": \"0\",\n \"shipping_freight\": \"0.00\",\n \"low_avail_limit\": \"0\",\n \"timestamp\": \"1722949828\",\n \"updated_timestamp\": \"1722949828\",\n \"usergroup_ids\": \"0\",\n \"is_edp\": \"N\",\n \"edp_shipping\": \"N\",\n \"unlimited_download\": \"N\",\n \"tracking\": \"B\",\n \"free_shipping\": \"N\",\n \"zero_price_action\": \"R\",\n \"is_pbp\": \"N\",\n \"is_op\": \"N\",\n \"is_oper\": \"N\",\n \"is_returnable\": \"Y\",\n \"return_period\": \"10\",\n \"avail_since\": \"0\",\n \"out_of_stock_actions\": \"N\",\n \"localization\": \"\",\n \"min_qty\": \"0\",\n \"max_qty\": \"0\",\n \"qty_step\": \"0\",\n \"list_qty_count\": \"0\",\n \"tax_ids\": [],\n \"age_verification\": \"N\",\n \"age_limit\": \"0\",\n \"options_type\": \"P\",\n \"exceptions_type\": \"F\",\n \"details_layout\": \"\",\n \"shipping_params\": \"a:5:{s:16:\\\"min_items_in_box\\\";i:0;s:16:\\\"max_items_in_box\\\";i:0;s:10:\\\"box_length\\\";i:0;s:9:\\\"box_width\\\";i:0;s:10:\\\"box_height\\\";i:0;}\",\n \"facebook_obj_type\": \"\",\n \"parent_product_id\": \"0\",\n \"buy_now_url\": \"\",\n \"units_in_product\": \"0.000\",\n \"show_price_per_x_units\": \"1.000\",\n \"ab__stickers_manual_ids\": null,\n \"ab__stickers_generated_ids\": null,\n \"srx_enable_sample\": \"0\",\n \"srx_sample_price\": \"0.00\",\n \"srx_sample_min_qty\": \"1\",\n \"srx_sample_max_qty\": \"1\",\n \"srx_sample_id\": null,\n \"srx_is_sample\": \"0\",\n \"lang_code\": \"en\",\n \"product\": \"Football\",\n \"shortname\": \"\",\n \"short_description\": null,\n \"full_description\": null,\n \"meta_keywords\": \"\",\n \"meta_description\": null,\n \"search_words\": null,\n \"page_title\": \"\",\n \"age_warning_message\": null,\n \"promo_text\": null,\n \"unit_name\": \"\",\n \"stop_words\": \"\",\n \"srx_master_unit\": null,\n \"srx_sample_tip\": null,\n \"srx_sample_title\": null,\n \"price\": \"55.00\",\n \"category_ids\": [\n 159\n ],\n \"popularity\": null,\n \"company_name\": \"Matrix Food Industries\",\n \"sales_amount\": null,\n \"seo_name\": \"football-en-2\",\n \"seo_path\": \"159\",\n \"discussion_type\": \"D\",\n \"average_rating\": null,\n \"product_reviews_count\": null,\n \"base_price\": \"55.00\",\n \"main_category\": 159,\n \"image_pairs\": [],\n \"main_pair\": [],\n \"prices\": [\n {\n \"product_id\": \"15788\",\n \"lower_limit\": \"1\",\n \"usergroup_id\": \"0\",\n \"percentage_discount\": \"0.00\",\n \"price\": \"55.00\"\n }\n ],\n \"product_features\": [],\n \"options_type_raw\": null,\n \"exceptions_type_raw\": null,\n \"tracking_raw\": null,\n \"zero_price_action_raw\": null,\n \"min_qty_raw\": null,\n \"max_qty_raw\": null,\n \"qty_step_raw\": null,\n \"list_qty_count_raw\": null,\n \"details_layout_raw\": \"\",\n \"detailed_params\": {\n \"info_type\": \"D\",\n \"is_preview\": false\n },\n \"relative_vendor_rating\": 0,\n \"premoderation_reason\": \"\",\n \"have_required\": \"N\",\n \"selected_options\": [],\n \"variation_features\": [],\n \"has_options\": false,\n \"product_options\": [],\n \"discounts\": {\n \"A\": 0,\n \"P\": 0\n },\n \"qty_content\": []\n}"}],"_postman_id":"69a0761e-aca1-46b9-8cf5-e777d1f19bc6"},{"name":"Create-a-Product","id":"e1c0114d-b6f2-46a9-ae0f-01e772c42208","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic base64('$vendor_email:$api_token');","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"product","value":"test -create-for","type":"text"},{"key":"price","value":"50","type":"text"},{"key":"category_ids","value":"159","type":"text"}]},"url":"https://sandbox-api.tijarahub.com/api/products","description":"| Store Builder | Send a POST request to /api/stores//products/ |
| Multi-Vendor | Send a POST request to /api/products/ |
Category name
\n","type":"text/plain"},"key":"category","value":"string"},{"disabled":true,"description":{"content":"ID of the store or vendor the category belongs to
\n","type":"text/plain"},"key":"company_id\t","value":"Default company ID\tinteger"},{"disabled":true,"description":{"content":"Category status:\nA for Active\nD for Disabled\nH for Hidden
\n","type":"text/plain"},"key":"status","value":"A\nD\nH"},{"disabled":true,"description":{"content":"Age access restriction value in years
\n","type":"text/plain"},"key":"age_limit\t","value":"\tinteger"},{"disabled":true,"description":{"content":"Activate/disable age verification
\n","type":"text/plain"},"key":"age_verification","value":"\t\nY\nN"},{"disabled":true,"description":{"content":"Forbidden age warning message
\n","type":"text/plain"},"key":"age_warning_message\t","value":"string"},{"disabled":true,"description":{"content":"Category ID
\n","type":"text/plain"},"key":"category_id","value":"integer"},{"disabled":true,"description":{"content":"Default product list layout
\n","type":"text/plain"},"key":"default_layout\t","value":"Valid product template name\n"},{"disabled":true,"description":{"content":"Category description
\n","type":"text/plain"},"key":"description\t","value":"string"},{"disabled":true,"description":{"content":"Parent category ID chain
\n","type":"text/plain"},"key":"id_path\t","value":"A sequence of category IDs separated by slashes\n"},{"disabled":true,"description":{"content":"Language code
\n","type":"text/plain"},"key":"lang_code","value":"Default language code\t\n"},{"disabled":true,"description":{"content":"String of comma-separated localization IDs
\n","type":"text/plain"},"key":"localization","value":"string\n"},{"disabled":true,"description":{"content":"Full image and thumbnail pair
\n","type":"text/plain"},"key":"main_pair","value":"empty array\t"},{"disabled":true,"description":{"content":"Meta description
\n","type":"text/plain"},"key":"meta_description","value":"string"},{"disabled":true,"description":{"content":"Meta keywords
\n","type":"text/plain"},"key":"meta_keywords\t","value":"string"},{"disabled":true,"description":{"content":"Category page title
\n","type":"text/plain"},"key":"page_title\t","value":"string"},{"disabled":true,"description":{"content":"Parent category age access restriction value in years
\n","type":"text/plain"},"key":"parent_age_limit\t","value":"integer\n"},{"disabled":true,"description":{"content":"Parent category activate/disable age verification
\n","type":"text/plain"},"key":"parent_age_verification","value":"Y\nN"},{"disabled":true,"description":{"content":"Parent category ID
\n","type":"text/plain"},"key":"parent_id","value":"0 (root category ID)\tinteger"},{"disabled":true,"description":{"content":"Category position in the category list
\n","type":"text/plain"},"key":"position","value":"Set automatically\tinteger"},{"disabled":true,"description":{"content":"Number of product columns displayed in a template
\n","type":"text/plain"},"key":"product_columns","value":"integer"},{"disabled":true,"description":{"content":"Number of products
\n","type":"text/plain"},"key":"product_count\t","value":"0\tinteger"},{"disabled":true,"description":{"content":"Product details page layout
\n","type":"text/plain"},"key":"product_details_layout","value":"default’\tValid product template name"},{"disabled":true,"description":{"content":"Available product list layouts
\n","type":"text/plain"},"key":"selected_layouts","value":"Serialized array of template names"},{"disabled":true,"description":{"content":"SEO name for the category page
\n","type":"text/plain"},"key":"seo_name","value":"string\n"},{"disabled":true,"description":{"content":"Creation timestamp
\n","type":"text/plain"},"key":"timestamp\t","value":"Set automatically\tValid timestamp in seconds"},{"disabled":true,"description":{"content":"User group IDs
\n","type":"text/plain"},"key":"usergroup_ids","value":"0’\tString of comma-separated user group IDs"},{"disabled":true,"description":{"content":"Shows categories on a page with the defined number
\n","type":"text/plain"},"key":"page","value":null},{"disabled":true,"description":{"content":"Shows N categories, where N - is a number defined in the parameter
\n","type":"text/plain"},"key":"items_per_page","value":null}],"variable":[]}},"response":[{"id":"44d59b62-10a9-44a7-96f8-ccaa19bed0e1","name":"category-list","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic base64('$vendor_email:$api_token');","type":"text"}],"url":{"raw":"https://sandbox-api.tijarahub.com/api/categories","host":["https://sandbox-api.tijarahub.com/api"],"path":["categories"],"query":[{"key":"category","value":"string","description":"Category name","type":"text","disabled":true},{"key":"company_id\t","value":"Default company ID\tinteger","description":"ID of the store or vendor the category belongs to","type":"text","disabled":true},{"key":"status","value":"A\nD\nH","description":"Category status:\nA for Active\nD for Disabled\nH for Hidden","type":"text","disabled":true},{"key":"age_limit\t","value":"\tinteger","description":"Age access restriction value in years","type":"text","disabled":true},{"key":"age_verification","value":"\t\nY\nN","description":"Activate/disable age verification","type":"text","disabled":true},{"key":"age_warning_message\t","value":"string","description":"Forbidden age warning message\t","type":"text","disabled":true},{"key":"category_id","value":"integer","description":"Category ID\t","type":"text","disabled":true},{"key":"default_layout\t","value":"Valid product template name\n","description":"Default product list layout\t","type":"text","disabled":true},{"key":"description\t","value":"string","description":"Category description\t","type":"text","disabled":true},{"key":"id_path\t","value":"A sequence of category IDs separated by slashes\n","description":"Parent category ID chain\t","type":"text","disabled":true},{"key":"lang_code","value":"Default language code\t\n","description":"Language code\t","type":"text","disabled":true},{"key":"localization","value":"string\n","description":"String of comma-separated localization IDs\t","type":"text","disabled":true},{"key":"main_pair","value":"empty array\t","description":"Full image and thumbnail pair\t","type":"text","disabled":true},{"key":"meta_description","value":"string","description":"Meta description\t","type":"text","disabled":true},{"key":"meta_keywords\t","value":"string","description":"Meta keywords\t","type":"text","disabled":true},{"key":"page_title\t","value":"string","description":"Category page title\t\n","type":"text","disabled":true},{"key":"parent_age_limit\t","value":"integer\n","description":"Parent category age access restriction value in years\t","type":"text","disabled":true},{"key":"parent_age_verification","value":"Y\nN","description":"Parent category activate/disable age verification\t","type":"text","disabled":true},{"key":"parent_id","value":"0 (root category ID)\tinteger","description":"Parent category ID\t","type":"text","disabled":true},{"key":"position","value":"Set automatically\tinteger","description":"Category position in the category list\t","type":"text","disabled":true},{"key":"product_columns","value":"integer","description":"Number of product columns displayed in a template\t","type":"text","disabled":true},{"key":"product_count\t","value":"0\tinteger","description":"Number of products\t","type":"text","disabled":true},{"key":"product_details_layout","value":"default’\tValid product template name","description":"Product details page layout\t","type":"text","disabled":true},{"key":"selected_layouts","value":"Serialized array of template names","description":"Available product list layouts\t","type":"text","disabled":true},{"key":"seo_name","value":"string\n","description":"SEO name for the category page\t","type":"text","disabled":true},{"key":"timestamp\t","value":"Set automatically\tValid timestamp in seconds","description":"Creation timestamp\t","type":"text","disabled":true},{"key":"usergroup_ids","value":"0’\tString of comma-separated user group IDs","description":"User group IDs\t","type":"text","disabled":true},{"key":"page","value":null,"description":"Shows categories on a page with the defined number\n","type":"text","disabled":true},{"key":"items_per_page","value":null,"description":"Shows N categories, where N - is a number defined in the parameter\n","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Aug 2024 08:37:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept-Encoding"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-methods","value":"GET, POST, PATCH, PUT, DELETE, OPTIONS, FILES"},{"key":"access-control-allow-headers","value":"Origin, Content-Type"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"58"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=Izmh8EfhSnraAX7YrUfpJqeG1YkZD7JqSDz9%2BsYxzwrE4c0ZTC%2B%2BpwuQBQv5SxyRArsBu%2FleiuyhWPdapWx7i77MS8f30SeJKjyqZVxhc6IcGTZ05PJPATsXdh9ZNJ84Gw9VEgDNzuzMF2E%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=0; includeSubDomains"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8afe2ed1fb7c3c86-CDG"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"categories\": [\n {\n \"category_id\": \"159\",\n \"parent_id\": \"0\",\n \"id_path\": \"159\",\n \"category\": \"Back to School\",\n \"position\": \"0\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"140\",\n \"seo_name\": \"back-to-school\",\n \"seo_path\": \"\"\n },\n {\n \"category_id\": \"156\",\n \"parent_id\": \"33\",\n \"id_path\": \"33/156\",\n \"category\": \"Baby & Toddlers\",\n \"position\": \"24\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"117\",\n \"seo_name\": \"baby-and-toddlers\",\n \"seo_path\": \"33\"\n },\n {\n \"category_id\": \"154\",\n \"parent_id\": \"83\",\n \"id_path\": \"40/83/154\",\n \"category\": \"Dairy Products\",\n \"position\": \"117\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"50\",\n \"seo_name\": \"dairy-products\",\n \"seo_path\": \"40/83\"\n },\n {\n \"category_id\": \"146\",\n \"parent_id\": \"137\",\n \"id_path\": \"137/146\",\n \"category\": \"Others | Ramadan Offers\",\n \"position\": \"7\",\n \"status\": \"D\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"0\",\n \"seo_name\": \"others-ramadan-offers\",\n \"seo_path\": \"137\"\n },\n {\n \"category_id\": \"144\",\n \"parent_id\": \"137\",\n \"id_path\": \"137/144\",\n \"category\": \"Handmade | Ramadan Offers\",\n \"position\": \"6\",\n \"status\": \"D\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"0\",\n \"seo_name\": \"handmade-ramadan-offers\",\n \"seo_path\": \"137\"\n },\n {\n \"category_id\": \"143\",\n \"parent_id\": \"137\",\n \"id_path\": \"137/143\",\n \"category\": \"Furniture | Ramadan Offers \",\n \"position\": \"5\",\n \"status\": \"D\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"0\",\n \"seo_name\": \"furniture-ramadan-offers\",\n \"seo_path\": \"137\"\n },\n {\n \"category_id\": \"142\",\n \"parent_id\": \"137\",\n \"id_path\": \"137/142\",\n \"category\": \"Health & Beauty | Ramadan Offers\",\n \"position\": \"3\",\n \"status\": \"D\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"0\",\n \"seo_name\": \"health-and-beauty-ramadan-offers\",\n \"seo_path\": \"137\"\n },\n {\n \"category_id\": \"141\",\n \"parent_id\": \"137\",\n \"id_path\": \"137/141\",\n \"category\": \"Home & Garden | Ramadan Offers \",\n \"position\": \"4\",\n \"status\": \"D\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"8\",\n \"seo_name\": \"home-and-garden-ramadan-offers\",\n \"seo_path\": \"137\"\n },\n {\n \"category_id\": \"140\",\n \"parent_id\": \"137\",\n \"id_path\": \"137/140\",\n \"category\": \"Apparel & Accessories | Ramadan Offers\",\n \"position\": \"2\",\n \"status\": \"D\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"0\",\n \"seo_name\": \"apparel-and-accessories-ramadan-offers\",\n \"seo_path\": \"137\"\n },\n {\n \"category_id\": \"139\",\n \"parent_id\": \"137\",\n \"id_path\": \"137/139\",\n \"category\": \" Food & beverages | Ramadan Offers\",\n \"position\": \"1\",\n \"status\": \"D\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"0\",\n \"seo_name\": \"food-and-beverages-ramadan-offers\",\n \"seo_path\": \"137\"\n },\n {\n \"category_id\": \"137\",\n \"parent_id\": \"0\",\n \"id_path\": \"137\",\n \"category\": \"Ramadan Offers\",\n \"position\": \"20\",\n \"status\": \"D\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"37\",\n \"seo_name\": \"ramadan-products\",\n \"seo_path\": \"\"\n },\n {\n \"category_id\": \"136\",\n \"parent_id\": \"33\",\n \"id_path\": \"33/136\",\n \"category\": \"Swimwear\",\n \"position\": \"25\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"118\",\n \"seo_name\": \"swimwear\",\n \"seo_path\": \"33\"\n },\n {\n \"category_id\": \"134\",\n \"parent_id\": \"52\",\n \"id_path\": \"52/134\",\n \"category\": \"Sofas\",\n \"position\": \"52\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"76\",\n \"seo_name\": \"sofas\",\n \"seo_path\": \"52\"\n },\n {\n \"category_id\": \"128\",\n \"parent_id\": \"34\",\n \"id_path\": \"34/128\",\n \"category\": \"Health Care\",\n \"position\": \"32\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"137\",\n \"seo_name\": \"health-care\",\n \"seo_path\": \"34\"\n },\n {\n \"category_id\": \"126\",\n \"parent_id\": \"33\",\n \"id_path\": \"33/126\",\n \"category\": \"Bags & Wallets \",\n \"position\": \"27\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"188\",\n \"seo_name\": \"bags-and-wallets\",\n \"seo_path\": \"33\"\n },\n {\n \"category_id\": \"125\",\n \"parent_id\": \"41\",\n \"id_path\": \"41/125\",\n \"category\": \"Electronics \",\n \"position\": \"43\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"106\",\n \"seo_name\": \"electronics\",\n \"seo_path\": \"41\"\n },\n {\n \"category_id\": \"123\",\n \"parent_id\": \"41\",\n \"id_path\": \"41/123\",\n \"category\": \"Kitchen & Dining\",\n \"position\": \"44\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"350\",\n \"seo_name\": \"kitchen-and-dining\",\n \"seo_path\": \"41\"\n },\n {\n \"category_id\": \"112\",\n \"parent_id\": \"41\",\n \"id_path\": \"41/112\",\n \"category\": \"Fireplaces\",\n \"position\": \"46\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"10\",\n \"seo_name\": \"fireplaces\",\n \"seo_path\": \"41\"\n },\n {\n \"category_id\": \"110\",\n \"parent_id\": \"83\",\n \"id_path\": \"40/83/110\",\n \"category\": \"Fruits & Vegetables\",\n \"position\": \"115\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"3\",\n \"seo_name\": \"fruits-and-vegetables\",\n \"seo_path\": \"40/83\"\n },\n {\n \"category_id\": \"107\",\n \"parent_id\": \"33\",\n \"id_path\": \"33/107\",\n \"category\": \"Men's Clothing\",\n \"position\": \"22\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"252\",\n \"seo_name\": \"mens-clothing\",\n \"seo_path\": \"33\"\n },\n {\n \"category_id\": \"102\",\n \"parent_id\": \"41\",\n \"id_path\": \"41/102\",\n \"category\": \"Linens & Bedding\",\n \"position\": \"45\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"105\",\n \"seo_name\": \"linens-and-bedding\",\n \"seo_path\": \"41\"\n },\n {\n \"category_id\": \"99\",\n \"parent_id\": \"41\",\n \"id_path\": \"41/99\",\n \"category\": \"Decor \",\n \"position\": \"42\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"167\",\n \"seo_name\": \"decor\",\n \"seo_path\": \"41\"\n },\n {\n \"category_id\": \"97\",\n \"parent_id\": \"52\",\n \"id_path\": \"52/97\",\n \"category\": \"Chairs \",\n \"position\": \"53\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"236\",\n \"seo_name\": \"chairs\",\n \"seo_path\": \"52\"\n },\n {\n \"category_id\": \"92\",\n \"parent_id\": \"83\",\n \"id_path\": \"40/83/92\",\n \"category\": \"Meat, Seafood & Eggs\",\n \"position\": \"116\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"1\",\n \"seo_name\": \"meat-seafood-and-eggs\",\n \"seo_path\": \"40/83\"\n },\n {\n \"category_id\": \"90\",\n \"parent_id\": \"41\",\n \"id_path\": \"41/90\",\n \"category\": \"Household Supplies\",\n \"position\": \"41\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"215\",\n \"seo_name\": \"household-supplies\",\n \"seo_path\": \"41\"\n },\n {\n \"category_id\": \"88\",\n \"parent_id\": \"83\",\n \"id_path\": \"40/83/88\",\n \"category\": \"Cooking & Baking Ingredients\",\n \"position\": \"113\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"244\",\n \"seo_name\": \"cooking-and-baking-ingredients\",\n \"seo_path\": \"40/83\"\n },\n {\n \"category_id\": \"85\",\n \"parent_id\": \"83\",\n \"id_path\": \"40/83/85\",\n \"category\": \"Dips & Spreads\",\n \"position\": \"119\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"64\",\n \"seo_name\": \"dips-and-spreads\",\n \"seo_path\": \"40/83\"\n },\n {\n \"category_id\": \"84\",\n \"parent_id\": \"83\",\n \"id_path\": \"40/83/84\",\n \"category\": \"Candy & Chocolate\",\n \"position\": \"120\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"153\",\n \"seo_name\": \"candy-and-chocolate\",\n \"seo_path\": \"40/83\"\n },\n {\n \"category_id\": \"83\",\n \"parent_id\": \"40\",\n \"id_path\": \"40/83\",\n \"category\": \"Food Items \",\n \"position\": \"11\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"137\",\n \"seo_name\": \"food-items\",\n \"seo_path\": \"40\"\n },\n {\n \"category_id\": \"81\",\n \"parent_id\": \"33\",\n \"id_path\": \"33/81\",\n \"category\": \"Accessories \",\n \"position\": \"26\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"266\",\n \"seo_name\": \"accessories\",\n \"seo_path\": \"33\"\n },\n {\n \"category_id\": \"80\",\n \"parent_id\": \"52\",\n \"id_path\": \"52/80\",\n \"category\": \"Furniture Accessories \",\n \"position\": \"54\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"63\",\n \"seo_name\": \"furniture-accessories\",\n \"seo_path\": \"52\"\n },\n {\n \"category_id\": \"79\",\n \"parent_id\": \"34\",\n \"id_path\": \"34/79\",\n \"category\": \"Personal Care \",\n \"position\": \"31\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"250\",\n \"seo_name\": \"personal-care\",\n \"seo_path\": \"34\"\n },\n {\n \"category_id\": \"75\",\n \"parent_id\": \"41\",\n \"id_path\": \"41/75\",\n \"category\": \"Household Appliances\",\n \"position\": \"40\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"10\",\n \"seo_name\": \"household-appliances\",\n \"seo_path\": \"41\"\n },\n {\n \"category_id\": \"73\",\n \"parent_id\": \"33\",\n \"id_path\": \"33/73\",\n \"category\": \"Kid's Clothing\",\n \"position\": \"23\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"731\",\n \"seo_name\": \"kids-clothing\",\n \"seo_path\": \"33\"\n },\n {\n \"category_id\": \"72\",\n \"parent_id\": \"33\",\n \"id_path\": \"33/72\",\n \"category\": \"Women's Clothing\",\n \"position\": \"21\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"2207\",\n \"seo_name\": \"womens-clothing\",\n \"seo_path\": \"33\"\n },\n {\n \"category_id\": \"71\",\n \"parent_id\": \"40\",\n \"id_path\": \"40/71\",\n \"category\": \"Beverages \",\n \"position\": \"12\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"152\",\n \"seo_name\": \"beverages\",\n \"seo_path\": \"40\"\n },\n {\n \"category_id\": \"70\",\n \"parent_id\": \"52\",\n \"id_path\": \"52/70\",\n \"category\": \"Office Furniture\",\n \"position\": \"50\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"160\",\n \"seo_name\": \"office-furniture\",\n \"seo_path\": \"52\"\n },\n {\n \"category_id\": \"67\",\n \"parent_id\": \"52\",\n \"id_path\": \"52/67\",\n \"category\": \"Home Furniture \",\n \"position\": \"51\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"136\",\n \"seo_name\": \"home-furniture\",\n \"seo_path\": \"52\"\n },\n {\n \"category_id\": \"65\",\n \"parent_id\": \"83\",\n \"id_path\": \"40/83/65\",\n \"category\": \"Snack Foods\",\n \"position\": \"118\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"391\",\n \"seo_name\": \"snack-foods\",\n \"seo_path\": \"40/83\"\n },\n {\n \"category_id\": \"59\",\n \"parent_id\": \"83\",\n \"id_path\": \"40/83/59\",\n \"category\": \"Pasta & Noodles\",\n \"position\": \"114\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"94\",\n \"seo_name\": \"pasta-and-noodles\",\n \"seo_path\": \"40/83\"\n },\n {\n \"category_id\": \"57\",\n \"parent_id\": \"83\",\n \"id_path\": \"40/83/57\",\n \"category\": \"Grains, Rice & Cereal\",\n \"position\": \"112\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"107\",\n \"seo_name\": \"grains-rice-and-cereal\",\n \"seo_path\": \"40/83\"\n },\n {\n \"category_id\": \"54\",\n \"parent_id\": \"83\",\n \"id_path\": \"40/83/54\",\n \"category\": \" Condiments & Sauces \",\n \"position\": \"111\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"737\",\n \"seo_name\": \"condiments-and-sauces\",\n \"seo_path\": \"40/83\"\n },\n {\n \"category_id\": \"52\",\n \"parent_id\": \"0\",\n \"id_path\": \"52\",\n \"category\": \"Furniture\",\n \"position\": \"5\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"280\",\n \"seo_name\": \"furniture\",\n \"seo_path\": \"\"\n },\n {\n \"category_id\": \"44\",\n \"parent_id\": \"0\",\n \"id_path\": \"44\",\n \"category\": \"Handmade \",\n \"position\": \"6\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"1552\",\n \"seo_name\": \"hand-made\",\n \"seo_path\": \"\"\n },\n {\n \"category_id\": \"42\",\n \"parent_id\": \"0\",\n \"id_path\": \"42\",\n \"category\": \"Others\",\n \"position\": \"7\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"497\",\n \"seo_name\": \"others\",\n \"seo_path\": \"\"\n },\n {\n \"category_id\": \"41\",\n \"parent_id\": \"0\",\n \"id_path\": \"41\",\n \"category\": \"Home & Garden\",\n \"position\": \"4\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"540\",\n \"seo_name\": \"home-garden\",\n \"seo_path\": \"\"\n },\n {\n \"category_id\": \"40\",\n \"parent_id\": \"0\",\n \"id_path\": \"40\",\n \"category\": \" Food & Beverages\",\n \"position\": \"1\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"648\",\n \"seo_name\": \"food-and-beverage\",\n \"seo_path\": \"\"\n },\n {\n \"category_id\": \"34\",\n \"parent_id\": \"0\",\n \"id_path\": \"34\",\n \"category\": \"Health & Beauty \",\n \"position\": \"3\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"281\",\n \"seo_name\": \"health-and-beauty\",\n \"seo_path\": \"\"\n },\n {\n \"category_id\": \"33\",\n \"parent_id\": \"0\",\n \"id_path\": \"33\",\n \"category\": \"Apparel & Accessories\",\n \"position\": \"2\",\n \"status\": \"A\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"629\",\n \"seo_name\": \"apparel-and-accessories\",\n \"seo_path\": \"\"\n },\n {\n \"category_id\": \"1\",\n \"parent_id\": \"0\",\n \"id_path\": \"1\",\n \"category\": \"Marketplace fees\",\n \"position\": \"10\",\n \"status\": \"D\",\n \"company_id\": \"0\",\n \"storefront_id\": \"0\",\n \"product_count\": \"1\",\n \"seo_name\": \"marketplace-fees\",\n \"seo_path\": \"\"\n }\n ],\n \"params\": {\n \"category_id\": 0,\n \"visible\": false,\n \"current_category_id\": 0,\n \"simple\": false,\n \"plain\": true,\n \"limit\": 0,\n \"item_ids\": \"\",\n \"group_by_level\": false,\n \"get_images\": false,\n \"category_delimiter\": \"/\",\n \"get_frontend_urls\": false,\n \"max_nesting_level\": null,\n \"get_company_name\": false,\n \"storefront_ids\": null,\n \"ajax_custom\": \"1\",\n \"company_id\": \"291\",\n \"items_per_page\": 50,\n \"page\": 1,\n \"except_id\": 49,\n \"sort_order\": \"asc\",\n \"sort_by\": \"position\",\n \"sort_order_rev\": \"desc\",\n \"total_items\": \"84\"\n }\n}"}],"_postman_id":"8fc123f4-878d-4b8b-a027-6dc6df1dc189"},{"name":"New Request","id":"d41b7c4b-5d4b-4251-aab2-b5ae082b7701","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"info@example.com"},{"key":"password","value":"sFVIBxsMkCYpM8k36A2tqa17Pr2UUIgE74vdELVG41OuGYIu5w"}]},"isInherited":true,"source":{"_postman_id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","name":"Tijarahub-Sandbox","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"d41b7c4b-5d4b-4251-aab2-b5ae082b7701"}],"id":"2e7ae3ee-b3fc-4b90-8e59-30639e4606c6","_postman_id":"2e7ae3ee-b3fc-4b90-8e59-30639e4606c6","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"info@example.com"},{"key":"password","value":"sFVIBxsMkCYpM8k36A2tqa17Pr2UUIgE74vdELVG41OuGYIu5w"}]},"isInherited":true,"source":{"_postman_id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","name":"Tijarahub-Sandbox","type":"collection"}}},{"name":"Features","item":[{"name":"GET /features/","id":"9ce5f041-d74b-4e37-9796-71adbf062d94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic base64('$vendor_email:$api_token');","type":"text"}],"url":"https://sandbox-api.tijarahub.com/api/features","description":"Send the data in the body of the HTTP request. The data should comply with the content-type.
If you successfully create a feature, you will receive HTTP/1.1 201 Created.
\nIf the feature couldn’t be created, you will receive HTTP/1.1 400 Bad Request.
\nRequired fields: company_id, description, feature_type
\nAvailable fields: company_id, feature_type, purpose, feature_style, filter_style, parent_id, display_on_product, display_on_catalog, display_on_header, description, lang_code, prefix, suffix, categories_path, full_description, status, comparison, position, _variants
_
Send the data in the body of the HTTP request. The data should comply with the content-type.
Required fields: company_id, description, feature_type
\nAvailable fields: company_id, feature_type, parent_id, display_on_product, display_on_catalog, display_on_header, description, lang_code, prefix, suffix, categories_path, full_description, status, comparison, position, _variants
_
If you successfully delete a product feature, you will receive HTTP/1.1 204 No Content.
\nIf the product feature couldn’t be deleted, you will receive HTTP/1.1 400 Bad Request.
\nIf the product feature doesn’t exist, you will receive HTTP/1.1 404 Not Found.
\nThis example request deletes the product feature with the feature_id=22.
To get the features of a product use the following method:
\nThis example request returns the list of features of a product with product_id=14.
Suppose we have a product feature of the Other: Text type with feature_id=23.
Let’s specify the value of this feature as we create a new product with POST /products/.
Send the data in the body of the HTTP request. The data should comply with the content-type.
This example request creates a new product with the value of the feature set to Test.
\nIf you successfully create a product, you will receive the ID of the product in the response.
\nUpdate a feature of a product using PUT /products/:id/.
Send the data in the body of the HTTP request. The data should comply with the content-type.
This example request updates the product with product_id=250. It sets the value of the text feature with feature_id=23 to Feature updated.
In the response you receive the ID of the product.
\nTo get a specific number of features or list of features from a concrete page in a response, use pagination parameters:
\nExamples:
\n\nResponse is an array with 10 features from the 5th page (10 is the default value of the items_per_page parameter).
Response is an array with 20 features from the first page.
\n\nResponse is an array with 20 features from the 5th page.
\nA product feature has a number of properties, represented by fields.
\nThe full list of supported fields is given below (mandatory fields are marked with *).
\nAny field not listed in the table below will be ignored if occurs in an API request JSON data.
\ncurl -X POST \"http://example.com/api/product_variations_groups\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\" \\\n-d '{\"product_ids\":[286,287,288],\n\"code\":\"MY_GROUP_1\",\n\"features\":[\n {\n \"feature_id\":549,\n \"purpose\":\"group_catalog_item\"\n }\n]\n }'\n\ncurl -X GET \"http://example.com/api/product_variations_groups\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\"\n\nExample 1:
\ncurl -X GET \"http://example.com/api/product_variations_groups/:id\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\"\n\n:id is a variation group ID.Example 2:
\ncurl -X GET \"http://example.com/api/product_variations_groups/:code\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\"\n\nWhere :code is a symbol ID of a variation group.
curl -X PUT \"http://example.com/api/product_variations_groups/:code\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\" \\\n-d '{\"code\":\"MY_GROUP_NEW\"}'\n\nWhere :code is a symbol ID of a variation group.
curl -X DELETE \"http://example.com/api/product_variations_groups/:code\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\" \\\n-d '{}'\n\nWhere :code is a symbol ID of a variation group.
Let’s say we have a T-shirt available in 3 colors and 5 sizes in your store. It means we have 15 similar products. We want to switch between the colors and sizes on the storefront.
\nTo do this, we have to put these similar products in a variation group. In this case the product will be considered as a variation. A product can belong only to one group at the same time, but it’s easy to change the product’s group. If a variation is removed from the group, it becomes a standard product.
\napi/product_variations_groups —refer to all product variation groups.
\n Only GET and POST are supported.
api/product_variations_groups/:id —refer to a product variation group.
\nGET, PUT, and DELETE are supported.
id—variation group ID;
code—variation group code;
features—list of the product features that were used to create the product variation group;
feature_id—product feature ID;
purpose—purpose of the product feature;
group_catalog_item—variations as separate products;
group_variation_catalog_item—variations as one product;
is_purpose_create_catalog_item—flag. If it takes on the value true, the purpose of the feature is Variations as separate products;
is_purpose_create_variation_of_catalog_item—flag. If it takes on the value true, the purpose of the feature is Variations as one product;
products—list of the products in the variation group;
product_id—product ID;
parent_product_id—parent product ID;
company_id—ID of the vendor/storefront the product belongs to;
feature_values—list of the product feature values;
feature_id—product feature ID;
variant_id—ID of the product feature variant;
created_at—time when the variation group was created;
updated_at—last time when the variation group was updated.
{\n \"groups\":[\n {\n \"id\":10,\n \"code\":\"PV-27186628F\",\n \"features\":[\n {\n \"feature_id\":548,\n \"purpose\":\"group_variation_catalog_item\",\n \"is_purpose_create_catalog_item\":false,\n \"is_purpose_create_variation_of_catalog_item\":true\n },\n {\n \"feature_id\":549,\n \"purpose\":\"group_catalog_item\",\n \"is_purpose_create_catalog_item\":true,\n \"is_purpose_create_variation_of_catalog_item\":false\n }\n ],\"products\":[\n {\n \"product_id\":278,\n \"parent_product_id\":0,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":548,\n \"variant_id\":\"1195\"\n },\n {\n \"feature_id\":549,\n \"variant_id\":\"1201\"\n }\n ]\n },\n {\n \"product_id\":279,\n \"parent_product_id\":278,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":548,\n \"variant_id\":\"1194\"\n },\n {\n \"feature_id\":549,\n \"variant_id\":\"1201\"\n }\n ]\n },\n {\n \"product_id\":280,\n \"parent_product_id\":0,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":548,\n \"variant_id\":\"1195\"\n },\n {\n \"feature_id\":549,\n \"variant_id\":\"1200\"\n }\n ]\n },\n {\n \"product_id\":281,\n \"parent_product_id\":280,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":548,\n \"variant_id\":\"1194\"\n },\n {\n \"feature_id\":549,\n \"variant_id\":\"1200\"\n }\n ]\n },\n {\n \"product_id\":282,\n \"parent_product_id\":0,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":548,\n \"variant_id\":\"1195\"\n },\n {\n \"feature_id\":549,\n \"variant_id\":\"1199\"\n }\n ]\n },\n {\n \"product_id\":284,\n \"parent_product_id\":282,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":548,\n \"variant_id\":\"1193\"\n },\n {\n \"feature_id\":549,\n \"variant_id\":\"1199\"\n }\n ]\n },\n {\n \"product_id\":283,\n \"parent_product_id\":282,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":548,\n \"variant_id\":\"1194\"\n },\n {\n \"feature_id\":549,\n \"variant_id\":\"1199\"\n }\n ]\n }\n ],\n \"created_at\":1545294915,\n \"updated_at\":1545294915\n },\n {\n \"id\":11,\n \"code\":\"MY_GROUP_1\",\n \"features\":[\n {\n \"feature_id\":549,\n \"purpose\":\"group_catalog_item\",\n \"is_purpose_create_catalog_item\":true,\n \"is_purpose_create_variation_of_catalog_item\":false\n },\n {\n \"feature_id\":548,\n \"purpose\":\"group_variation_catalog_item\",\n \"is_purpose_create_catalog_item\":false,\n \"is_purpose_create_variation_of_catalog_item\":true\n }\n ],\n \"products\":[\n {\n \"product_id\":286,\n \"parent_product_id\":0,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":548,\n \"variant_id\":\"1193\"\n },\n {\n \"feature_id\":549,\n \"variant_id\":\"1198\"\n }\n ]\n },\n {\n \"product_id\":287,\n \"parent_product_id\":0,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":548,\n \"variant_id\":\"1193\"\n },\n {\n \"feature_id\":549,\n \"variant_id\":\"1199\"\n }\n ]\n },\n {\n \"product_id\":288,\n \"parent_product_id\":287,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":548,\n \"variant_id\":\"1194\"\n },\n {\n \"feature_id\":549,\n \"variant_id\":\"1199\"\n }\n ]\n }\n ],\n \"created_at\":1585052457,\n \"updated_at\":1585052457\n }\n ],\n \"params\":{\n \"items_per_page\":10,\n \"page\":1,\n \"total_items\":2\n }\n\n}\n\nResponse to a request for a variation group by its ID or code
{
\"id\":11,
\n\"code\":\"MY_GROUP_1\",
\n\"features\":[
\n{
\n\"feature_id\":549,
\n\"purpose\":\"group_catalog_item\",
\n\"is_purpose_create_catalog_item\":true,
\n\"is_purpose_create_variation_of_catalog_item\":false
\n},
\n{
\n\"feature_id\":548,
\n\"purpose\":\"group_variation_catalog_item\",
\n\"is_purpose_create_catalog_item\":false,
\n\"is_purpose_create_variation_of_catalog_item\":true
\n}
\n],
\n\"products\":[
\n{
\n\"product_id\":286,
\n\"parent_product_id\":0,
\n\"company_id\":1,
\n\"feature_values\":[
\n{
\n\"feature_id\":548,
\n\"variant_id\":\"1193\"
\n},
\n{
\n\"feature_id\":549,
\n\"variant_id\":\"1198\"
\n}
\n]
\n},
\n{
\n\"product_id\":287,
\n\"parent_product_id\":0,
\n\"company_id\":1,
\n\"feature_values\":[
\n{
\n\"feature_id\":548,
\n\"variant_id\":\"1193\"
\n},
\n{
\n\"feature_id\":549,
\n\"variant_id\":\"1199\"
\n}
\n]
\n},
\n{
\n\"product_id\":288,
\n\"parent_product_id\":287,
\n\"company_id\":1,
\n\"feature_values\":[
\n{
\n\"feature_id\":548,
\n\"variant_id\":\"1194\"
\n},
\n{
\n\"feature_id\":549,
\n\"variant_id\":\"1199\"
\n}
\n]
\n}
\n],
\n\"created_at\":1585052457,
\n\"updated_at\":1585052457
\n}
\ncurl -X POST \"http://example.com/api/product_variations_groups\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\" \\\n-d '{\"product_ids\":[286,287,288],\n\"code\":\"MY_GROUP_1\",\n\"features\":[\n {\n \"feature_id\":549,\n \"purpose\":\"group_catalog_item\"\n }\n]\n }'\n\nExample 1:
\n:id is a variation group ID.Example 2:
\ncurl -X GET \"http://example.com/api/product_variations_groups/:id/product_variations\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\"\n\n:id is a variation group ID.Example 3:
\ncurl -X GET \"http://example.com/api/product_variations_groups/:code/product_variations\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\"\n\n:code is a symbol code of the variation group.Example 4:
\ncurl -X GET \"http://example.com/api/products?variation_group_id=:id\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\"\n\n:id is a variation group ID.Get only variations:
\nExample 1:
\ncurl -X GET \"http://example.com/api/product_variations\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\"\n\nExample 2:
\ncurl -X GET \"http://example.com/api/products?has_variation_group=1\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\"\n\nAdd a product to the variation group:
\ncurl -X PUT \"http://example.com/api/product_variations/:id\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\" \\\n-d '{\"variation_group_id\":11}'\n\n:id is the product ID.Create a product and add it to the variation group:
\ncurl -X POST \"http://example.com/api/product_variations_groups/:code/product_variations\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Basic ******\" \\\n-d '{\"product\":\"Pants\",\"price\":150,\"product_features\":{\"549\":1199,\"548\":1195},\"category_ids\":[224]}'\n\nAPI entity for generating variations based on combinations of product features.
\napi/product_variations/:id/generate_product_variations—only POST requests are supported.
curl -X POST \"http://example.com/api/product_variations/:id/generate_product_variations\" \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Basic ****\" \\\n -d '{\"combinations\":[{\"548\":1193,\"549\":1200},{\"548\":1197,\"549\":1199}]}'\n\nWhere:
\n:id is the ID of the product to create variations for;
combinations is the list of the feature variants combinations in the feature_id: variant_id format.
{\n \"group\":{\n \"id\":13,\n \"code\":\"PV-93ECD34F4\",\n \"features\":[\n {\n \"feature_id\":549,\n \"purpose\":\"group_catalog_item\",\n \"is_purpose_create_catalog_item\":true,\n \"is_purpose_create_variation_of_catalog_item\":false\n },\n {\n \"feature_id\":548,\n \"purpose\":\"group_variation_catalog_item\",\n \"is_purpose_create_catalog_item\":false,\n \"is_purpose_create_variation_of_catalog_item\":true\n }\n ],\n \"products\":[\n {\n \"product_id\":295,\n \"parent_product_id\":0,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":549,\n \"variant_id\":\"1199\"\n },\n {\n \"feature_id\":548,\n \"variant_id\":\"1194\"\n }\n ]\n },\n {\n \"product_id\":296,\n \"parent_product_id\":0,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":549,\n \"variant_id\":\"1200\"\n },\n {\n \"feature_id\":548,\n \"variant_id\":\"1193\"\n }\n ]\n },\n {\n \"product_id\":297,\n \"parent_product_id\":295,\n \"company_id\":1,\n \"feature_values\":[\n {\n \"feature_id\":549,\n \"variant_id\":\"1199\"\n },\n {\n \"feature_id\":548,\n \"variant_id\":\"1197\"\n }\n ]\n }\n ],\n \"created_at\":1585055941,\n \"updated_at\":1585055941\n },\n \"products_status\":{\n \"295\":1,\n \"296\":1,\n \"297\":1\n }\n}\n\ngroup—object that describes a variation group.
products_status— statuses of the result of adding the product to the variation group in the product_id: result format. The result can take on the following values:
Product Variations are similar products that differ from each other only in one or a few features. For example, a T-shirt comes in 3 colors, and each color has 5 sizes. That means 15 products. If we put these products into a variation group, we will have the ability to switch between their colors and sizes on the storefront.
\nA product can belong only to one group at the same time, but it’s easy to change the product’s group. If a variation is removed from the group, it becomes a standard product.
\nOnly GET and POST are supported.
GET, PUT, and DELETE are supported.
http://example.com/api/product_variations_groups/:id/product_variations—refer to all product variations of a particular product variation group.
\nhttp://example.com/api/product_variations_groups/:id/product_variations/:id—refer to a particular product variation of a particular product variation group.
\nhttp://example.com/api/product_variations_groups/:code/product_variations—refer to all product variations of a particular product variation group.
\nhttp://example.com/api/product_variations_groups/:code/product_variations/:id—refer to a particular product variation of a particular product variation group.
\nDetachProductVariation
\nSetDefaultProductVariation
\nGenerateProductVariations
\nSorting and pagination parameters are inherited from Products.
\nFiltering parameters are inherited from Products The Product Variations add-on adds the following filtering parameters, available via Products API or Product Variations API:
\nproduct_type _(enum[P|V])_—filter by product type. Allows you to get only default variations or child variations (product_type=V).
variation_group_id _(int)_—filter by variation group. Allows you to get all variations from a particular variation group.
variations_by_product_id _(int)_—filter that allows you to get variations by product ID.
parent_product_id (int)—filter that allows you to get child variations.
include_child_variations _(enum[0|1])_—filter that allows you to include child variations to the selection. By default, child variations are not included in the selection for the storefront.
group_child_variations _(enum[0|1])_—filter that allows you to combine child variations in groups. By default, child variations are combined in groups for the storefront, and not combined for the admin panel.
Additional parameters for product selection are inherited from Products. The Product Variations add-on adds the following new parameters, available via Products API or Product Variations API:
\nget_variation_features_variants _(enum[0|1])_—flag for expanding product data. If the parameter is specified, each variation will have a variation_features_variants array with all the possible feature variants. CS-Cart and Multi-Vendor use that data to show feature variant selectors.
get_variation_info _(enum[0|1])_—flag for expanding product data. If this parameter is specified, the following data will be defined for each variation:
variation_feature_ids—IDs of features that were used to create the product variation group;
variation_feature_collection—collection of features and their purposes that were used to create the product variation group;
variation_group_id—variation group ID;
variation_group_code—symbol code of the variation group;
variation_parent_product_id—parent product ID;
variation_sub_group_id—subgroup symbol ID;
variation_features—the values of all variation-capable features of the product;
get_variation_name _(enum[0|1])—flag for expanding product data. If the parameter is specified, the product name with the label will be defined for each variation in the _variation_name_ _property. Example: T-shirt, Color: Blue (Medium).
Fields are inherited from Products. The Product Variations add-on adds the following new fields, available via Products API or Product Variations API:
\nvariation_group_id—variation group ID;
variation_group_code—symbol code of the variation group;
variation_parent_product_id—parent product ID;
variation_sub_group_id—subgroup symbol ID;
variation_features—variants of the feature which purpose allows to create variations;
variation_feature_ids—IDs of features that were used to create the product variation group;
variation_feature_collection—collection of features and their purposes that were used to create the product variation group.
Creating/Updating ProductsThe logics of creation/updating products in a variation group is inherited from products. The Product Variations add-on considers the following fields when creating/updating products:Examples
\nvariation_feature_values—list of the product feature values in the feature_id: variant_id format. Allows you to change the values of those features that were used to create variation groups.
variation_group_id—variation group ID. Allows you to add the product to the variation group.
To get a list of options of a specific product, send a GET request to /api/options/?product_id=:id. For example:
GET /api/options/?product_id=12\n\nIf the request is successful, you’ll receive HTTP/1.1 200 OK and JSON with the options of the product.
\n{\n \"3\": {\n \"option_id\": \"3\",\n \"product_id\": \"12\",\n \"company_id\": \"1\",\n \"option_type\": \"S\",\n \"inventory\": \"Y\",\n \"regexp\": \"\",\n \"required\": \"N\",\n \"multiupload\": \"N\",\n \"allowed_extensions\": \"\",\n \"max_file_size\": \"0\",\n \"missing_variants_handling\": \"M\",\n \"status\": \"A\",\n \"position\": \"20\",\n \"value\": \"\",\n \"option_name\": \"Size\",\n \"option_text\": \"Size\",\n \"description\": \"\",\n \"inner_hint\": \"\",\n \"incorrect_message\": \"\",\n \"comment\": \"\",\n \"variants\": {\n \"12\": {\n \"variant_id\": \"12\",\n \"option_id\": \"3\",\n \"position\": \"10\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"Small\",\n \"image_pair\": []\n },\n \"13\": {\n \"variant_id\": \"13\",\n \"option_id\": \"3\",\n \"position\": \"20\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"Medium\",\n \"image_pair\": []\n },\n \"14\": {\n \"variant_id\": \"14\",\n \"option_id\": \"3\",\n \"position\": \"30\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"Large\",\n \"image_pair\": []\n },\n \"15\": {\n \"variant_id\": \"15\",\n \"option_id\": \"3\",\n \"position\": \"40\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"X Large\",\n \"image_pair\": []\n },\n \"16\": {\n \"variant_id\": \"16\",\n \"option_id\": \"3\",\n \"position\": \"50\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"XX Large\",\n \"image_pair\": []\n }\n }\n },\n \"4\": {\n \"option_id\": \"4\",\n \"product_id\": \"12\",\n \"company_id\": \"1\",\n \"option_type\": \"S\",\n \"inventory\": \"Y\",\n \"regexp\": \"\",\n \"required\": \"N\",\n \"multiupload\": \"N\",\n \"allowed_extensions\": \"\",\n \"max_file_size\": \"0\",\n \"missing_variants_handling\": \"M\",\n \"status\": \"A\",\n \"position\": \"0\",\n \"value\": \"\",\n \"option_name\": \"Color\",\n \"option_text\": \"\",\n \"description\": \"\",\n \"inner_hint\": \"\",\n \"incorrect_message\": \"\",\n \"comment\": \"\",\n \"variants\": {\n \"17\": {\n \"variant_id\": \"17\",\n \"option_id\": \"4\",\n \"position\": \"0\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"Black/White/White\",\n \"image_pair\": {\n \"pair_id\": \"805\",\n \"image_id\": \"861\",\n \"detailed_id\": \"0\",\n \"position\": \"0\",\n \"icon\": {\n \"image_path\": \"http://localhost/images/variant_image/0/173283_01.jpg\",\n \"alt\": \"\",\n \"image_x\": \"500\",\n \"image_y\": \"500\",\n \"http_image_path\": \"http://localhost/images/variant_image/0/173283_01.jpg\",\n \"https_image_path\": \"https://localhost/images/variant_image/0/173283_01.jpg\",\n \"absolute_path\": \"/var/www/html/images/variant_image/0/173283_01.jpg\",\n \"relative_path\": \"variant_image/0/173283_01.jpg\"\n }\n }\n },\n \"18\": {\n \"variant_id\": \"18\",\n \"option_id\": \"4\",\n \"position\": \"0\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"Dark Navy/White/White\",\n \"image_pair\": {\n \"pair_id\": \"806\",\n \"image_id\": \"862\",\n \"detailed_id\": \"0\",\n \"position\": \"0\",\n \"icon\": {\n \"image_path\": \"http://localhost/images/variant_image/0/242265_01.jpg\",\n \"alt\": \"\",\n \"image_x\": \"500\",\n \"image_y\": \"500\",\n \"http_image_path\": \"http://localhost/images/variant_image/0/242265_01.jpg\",\n \"https_image_path\": \"https://localhost/images/variant_image/0/242265_01.jpg\",\n \"absolute_path\": \"/var/www/html/images/variant_image/0/242265_01.jpg\",\n \"relative_path\": \"variant_image/0/242265_01.jpg\"\n }\n }\n },\n \"19\": {\n \"variant_id\": \"19\",\n \"option_id\": \"4\",\n \"position\": \"0\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"White/Prime Green\",\n \"image_pair\": {\n \"pair_id\": \"807\",\n \"image_id\": \"863\",\n \"detailed_id\": \"0\",\n \"position\": \"0\",\n \"icon\": {\n \"image_path\": \"http://localhost/images/variant_image/0/X29580_01.jpg\",\n \"alt\": \"\",\n \"image_x\": \"500\",\n \"image_y\": \"500\",\n \"http_image_path\": \"http://localhost/images/variant_image/0/X29580_01.jpg\",\n \"https_image_path\": \"https://localhost/images/variant_image/0/X29580_01.jpg\",\n \"absolute_path\": \"/var/www/html/images/variant_image/0/X29580_01.jpg\",\n \"relative_path\": \"variant_image/0/X29580_01.jpg\"\n }\n }\n }\n }\n }\n}\n\nTo get the details of a specific option, send a GET request to /api/options/. For example:
GET /api/options/3\n\nIf the request is successful, you’ll receive HTTP/1.1 200 OK and JSON with the details of the option.
\nThe fields below represent various option details.
\nThe Tijarahub/Multi-Vendor REST API always accepts and returns data as strings and arrays/objects. The Values column in the table merely shows what kind of data you can expect in the fields.
\nA Selectbox or Radiogroup option can have different variants for the customer to choose from. These variants appear in the variants object.
To create an option, send a POST request to /api/options/.
Pass the fields with the option details in the HTTP request body in accordance with the passed Content-Type. Required fields are marked with *:
product_id*—the unique identifier of the product that the option is associated with.
\noption_name*—the name of the option.
\noption_type—the type of the option:
\nS—select box
R—radiogroup
C—checkbox
I—text (one line)
T—text area
F—file
required—determines if customers must specify this option before they can add the product to cart. Pass Y for “Yes” and N for “No”.
inventory—determines if the option is taken into account when forming the product inventory. Pass Y for Yes and N for No.
main_pair—an object with the icons of the option variants.
\nAny other fields that apply to the option of a particular type.
\nExample JSON:
\n{\n \"product_id\": \"12\",\n \"option_name\": \"Packaging\",\n \"option_type\": \"R\",\n \"required\": \"Y\",\n \"inventory\": \"N\",\n \"main_pair\": {\n \"icon\": {\n \"image_path\": {\n \"1\": \"http://example.com/image1.jpg\",\n \"2\": \"http://example.com/image2.jpg\"\n }\n }\n },\n \"variants\": {\n \"1\": {\n \"variant_name\": \"None\"\n },\n \"2\": {\n \"variant_name\": \"Gift wrap\",\n \"modifier_type\":\"A\",\n \"modifier\":\"5\"\n }\n }\n}\n\nThis request creates a new option for the product with product_id=12:
PackagingRadiogroup
\nNone—doesn’t change the price of the product.
\nGift wrap—increases the price of the product by $5 (if the primary currency of your store is U.S. dollar).
\n{\n \"option_id\": 27\n}\n\nTo update an existing option, send the PUT request to /api/options//. For example:
PUT /api/options/27\n\nPass the fields with option details in the HTTP request body in accordance with the passed Content-Type. None of the fields are required.
Example JSON:
\n{\n \"option_type\": \"S\",\n \"main_pair\": {\n \"icon\": {\n \"image_path\": {\n \"2\": \"http://example.com/image3.jpg\",\n \"3\": \"http://example.com/image4.jpg\"\n }\n }\n },\n \"variants\": {\n \"2\": {\n \"variant_name\": \"Gift wrap\"\n },\n \"3\": {\n \"variant_name\": \"Present box\",\n \"modifier_type\":\"P\",\n \"modifier\":\"20\"\n }\n }\n}\n\nThis request changes the variant icons and variant types of the option with option_id=27. When we first created this option (Packaging), it had the Radiogroup type and 2 variants: None and Gift Wrap.
Here we change the option type to _Select box_—it supports variants as well. We didn’t pass None this time, so this variant is removed. Gift wrap doesn’t change. We also add a new variant called Present box. Choosing this variant will increase the price of the product by 20%.
\nTo delete an option, send the DELETE request to /api/options/:
DELETE /api/options/27\n\nThis request will delete the specified option.
\nPossible responses:
\nHTTP/1.1 204 No Content—the option has been deleted successfully.
\nHTTP/1.1 400 Bad Request—the option couldn’t be deleted.
\nHTTP/1.1 404 Not Found—the option doesn’t exist.
\nProducts in Tijarahub and Multi-Vendor can have options—additional properties that customers may select when buying a product. For example, for clothes that would be color, size, optional accessories, etc.
\n","_postman_id":"569dd5bd-c268-4277-8608-beee272959c4","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"info@example.com"},{"key":"password","value":"sFVIBxsMkCYpM8k36A2tqa17Pr2UUIgE74vdELVG41OuGYIu5w"}]},"isInherited":true,"source":{"_postman_id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","name":"Tijarahub-Sandbox","type":"collection"}}},{"name":"Option Combinations","item":[{"name":"List Options of a Product","id":"8a76d1c2-cf15-4634-9e8c-e27e501cc703","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"product_id","value":"15833","type":"text","disabled":true}]},"url":"https://sandbox-api.tijarahub.com/api/combinations/15833","description":"To get a list of options of a specific product, send a GET request to /api/options/?product_id=:id. For example:
GET /api/options/?product_id=12\n\nIf the request is successful, you’ll receive HTTP/1.1 200 OK and JSON with the options of the product.
\n{\n \"3\": {\n \"option_id\": \"3\",\n \"product_id\": \"12\",\n \"company_id\": \"1\",\n \"option_type\": \"S\",\n \"inventory\": \"Y\",\n \"regexp\": \"\",\n \"required\": \"N\",\n \"multiupload\": \"N\",\n \"allowed_extensions\": \"\",\n \"max_file_size\": \"0\",\n \"missing_variants_handling\": \"M\",\n \"status\": \"A\",\n \"position\": \"20\",\n \"value\": \"\",\n \"option_name\": \"Size\",\n \"option_text\": \"Size\",\n \"description\": \"\",\n \"inner_hint\": \"\",\n \"incorrect_message\": \"\",\n \"comment\": \"\",\n \"variants\": {\n \"12\": {\n \"variant_id\": \"12\",\n \"option_id\": \"3\",\n \"position\": \"10\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"Small\",\n \"image_pair\": []\n },\n \"13\": {\n \"variant_id\": \"13\",\n \"option_id\": \"3\",\n \"position\": \"20\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"Medium\",\n \"image_pair\": []\n },\n \"14\": {\n \"variant_id\": \"14\",\n \"option_id\": \"3\",\n \"position\": \"30\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"Large\",\n \"image_pair\": []\n },\n \"15\": {\n \"variant_id\": \"15\",\n \"option_id\": \"3\",\n \"position\": \"40\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"X Large\",\n \"image_pair\": []\n },\n \"16\": {\n \"variant_id\": \"16\",\n \"option_id\": \"3\",\n \"position\": \"50\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"XX Large\",\n \"image_pair\": []\n }\n }\n },\n \"4\": {\n \"option_id\": \"4\",\n \"product_id\": \"12\",\n \"company_id\": \"1\",\n \"option_type\": \"S\",\n \"inventory\": \"Y\",\n \"regexp\": \"\",\n \"required\": \"N\",\n \"multiupload\": \"N\",\n \"allowed_extensions\": \"\",\n \"max_file_size\": \"0\",\n \"missing_variants_handling\": \"M\",\n \"status\": \"A\",\n \"position\": \"0\",\n \"value\": \"\",\n \"option_name\": \"Color\",\n \"option_text\": \"\",\n \"description\": \"\",\n \"inner_hint\": \"\",\n \"incorrect_message\": \"\",\n \"comment\": \"\",\n \"variants\": {\n \"17\": {\n \"variant_id\": \"17\",\n \"option_id\": \"4\",\n \"position\": \"0\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"Black/White/White\",\n \"image_pair\": {\n \"pair_id\": \"805\",\n \"image_id\": \"861\",\n \"detailed_id\": \"0\",\n \"position\": \"0\",\n \"icon\": {\n \"image_path\": \"http://localhost/images/variant_image/0/173283_01.jpg\",\n \"alt\": \"\",\n \"image_x\": \"500\",\n \"image_y\": \"500\",\n \"http_image_path\": \"http://localhost/images/variant_image/0/173283_01.jpg\",\n \"https_image_path\": \"https://localhost/images/variant_image/0/173283_01.jpg\",\n \"absolute_path\": \"/var/www/html/images/variant_image/0/173283_01.jpg\",\n \"relative_path\": \"variant_image/0/173283_01.jpg\"\n }\n }\n },\n \"18\": {\n \"variant_id\": \"18\",\n \"option_id\": \"4\",\n \"position\": \"0\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"Dark Navy/White/White\",\n \"image_pair\": {\n \"pair_id\": \"806\",\n \"image_id\": \"862\",\n \"detailed_id\": \"0\",\n \"position\": \"0\",\n \"icon\": {\n \"image_path\": \"http://localhost/images/variant_image/0/242265_01.jpg\",\n \"alt\": \"\",\n \"image_x\": \"500\",\n \"image_y\": \"500\",\n \"http_image_path\": \"http://localhost/images/variant_image/0/242265_01.jpg\",\n \"https_image_path\": \"https://localhost/images/variant_image/0/242265_01.jpg\",\n \"absolute_path\": \"/var/www/html/images/variant_image/0/242265_01.jpg\",\n \"relative_path\": \"variant_image/0/242265_01.jpg\"\n }\n }\n },\n \"19\": {\n \"variant_id\": \"19\",\n \"option_id\": \"4\",\n \"position\": \"0\",\n \"modifier\": \"0.000\",\n \"modifier_type\": \"A\",\n \"weight_modifier\": \"0.000\",\n \"weight_modifier_type\": \"A\",\n \"point_modifier\": \"0.000\",\n \"point_modifier_type\": \"A\",\n \"variant_name\": \"White/Prime Green\",\n \"image_pair\": {\n \"pair_id\": \"807\",\n \"image_id\": \"863\",\n \"detailed_id\": \"0\",\n \"position\": \"0\",\n \"icon\": {\n \"image_path\": \"http://localhost/images/variant_image/0/X29580_01.jpg\",\n \"alt\": \"\",\n \"image_x\": \"500\",\n \"image_y\": \"500\",\n \"http_image_path\": \"http://localhost/images/variant_image/0/X29580_01.jpg\",\n \"https_image_path\": \"https://localhost/images/variant_image/0/X29580_01.jpg\",\n \"absolute_path\": \"/var/www/html/images/variant_image/0/X29580_01.jpg\",\n \"relative_path\": \"variant_image/0/X29580_01.jpg\"\n }\n }\n }\n }\n }\n}\n\nTo get the details of a specific option combination, send a GET request to /api/combinations/. For example:
GET /api/combinations/822274303\n\nIf the request is successful, you’ll receive HTTP/1.1 200 OK and JSON with the details of the option combination.
\nThe fields below represent various details of an option combination.
\nThe Tijarahub/Multi-Vendor REST API always accepts and returns data as strings and arrays/objects. The Values column in the table merely shows what kind of data you can expect in the fields.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"info@example.com"},{"key":"password","value":"sFVIBxsMkCYpM8k36A2tqa17Pr2UUIgE74vdELVG41OuGYIu5w"}]},"isInherited":true,"source":{"_postman_id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","name":"Tijarahub-Sandbox","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"0b96d3bf-ed19-447f-9da7-e160f942b3f4"},{"name":"Create an Option Combination","id":"3ac1299e-44dc-4a95-af18-5d15496fab76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_id\": \"15846\",\n \"combination\": {\n \"24\": \"74\",\n \"25\": \"80\",\n \"26\": \"86\"\n },\n \"amount\": \"100\",\n \"position\": \"10\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-api.tijarahub.com/api/combinations/","description":"To create an option combination, send a POST request to /api/combinations/.
Pass the fields with the option combination details in the HTTP request body in accordance with the passed Content-Type. Required fields are marked with *:
product_id*—the unique identifier of the product that the option combination is associated with.
\namount—how many items of this combination are in stock.
\nposition—the lower this number, the higher the option combination appears on the list in the Administration panel.
\ncombination—the options and variants that comprise the combination.
\nExample JSON:
\n{\n \"product_id\": \"4\",\n \"combination\": {\n \"24\": \"74\",\n \"25\": \"80\",\n \"26\": \"86\"\n },\n \"amount\": \"34\",\n \"position\": \"10\"\n}\n\nThis request creates a new option combination for the product with product_id=4. This combination consists of:
variant 74 of option24
\nvariant 80 of option 25
\nvariant 86 of option 26
\nThere are 34 items of this particular combination in stock.
\nIf the option combination is created successfully, you will receive HTTP/1.1 201 Created and the combination hash in the response:
\n{\n \"combination_hash\": \"2822626827\"\n}\n\nIf the option couldn’t be created, you will receive HTTP/1.1 400 Bad Request.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"info@example.com"},{"key":"password","value":"sFVIBxsMkCYpM8k36A2tqa17Pr2UUIgE74vdELVG41OuGYIu5w"}]},"isInherited":true,"source":{"_postman_id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","name":"Tijarahub-Sandbox","type":"collection"}},"urlObject":{"path":["combinations",""],"host":["https://sandbox-api.tijarahub.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ac1299e-44dc-4a95-af18-5d15496fab76"},{"name":"Update an Option Combination","id":"fbeb07aa-0042-4cba-bc2b-846b6cb45531","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"description":"To update an existing option combination, send the PUT request to /api/combinations//. For example:
PUT /api/combinations/2822626827\n\nPass the fields with option combination details in the HTTP request body in accordance with the passed Content-Type. None of the fields are required.
Example JSON:
\n{\n \"product_code\": \"Product 34214\",\n \"amount\": \"42\",\n \"position\": \"0\"\n}\n\nThis request changes the amount of items in stock, the product code of the combination, and the position of the combination on the list.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"info@example.com"},{"key":"password","value":"sFVIBxsMkCYpM8k36A2tqa17Pr2UUIgE74vdELVG41OuGYIu5w"}]},"isInherited":true,"source":{"_postman_id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","name":"Tijarahub-Sandbox","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"fbeb07aa-0042-4cba-bc2b-846b6cb45531"},{"name":"Delete an Option Combination","id":"0ecbdded-414f-4636-a5e3-254470d8775a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"description":"To delete an option combination, send the DELETE request to /api/combinations/?product_id=:id.
DELETE /api/combinations/2822626827?product_id=4\n\nThis request deletes the specified option combination of the product.
\nPossible responses:
\nHTTP/1.1 204 No Content—the option combination has been deleted successfully.
\nHTTP/1.1 400 Bad Request—the option combination couldn’t be deleted.
\nHTTP/1.1 404 Not Found—the option combination doesn’t exist.
\nProduct Option in Tijarahub and Multi-Vendor can be grouped in option combinations—this is useful for tracking products. For example, clothes come in various colors and sizes. It’s convenient to track separately, how many blue XL T-shirts and white M T-shirts you have. You can also separate code and image for the combination.
\n","_postman_id":"b07a1a38-ec0f-47df-83d5-ac38f4f29c2e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"info@example.com"},{"key":"password","value":"sFVIBxsMkCYpM8k36A2tqa17Pr2UUIgE74vdELVG41OuGYIu5w"}]},"isInherited":true,"source":{"_postman_id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","name":"Tijarahub-Sandbox","type":"collection"}}},{"name":"Option Exceptions","item":[{"name":"List Exceptions of a Product","id":"e9f83ba8-ab98-40b9-9b66-b2b096ef95f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"product_id\": \"12\",\n \"combination\": {\n \"3\": \"-1\",\n \"4\": \"19\",\n \"17\": \"61\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-api.tijarahub.com/api/exceptions/","description":"To get all the exceptions of a specific product, send a GET request to /api/exceptions/?product_id=:id. For example:
GET /api/exceptions/?product_id=12\n\nIf the request is successful, you’ll receive HTTP/1.1 200 OK and JSON with all the exceptions of the specified product:
\n[\n {\n \"exception_id\": \"1\",\n \"product_id\": \"12\",\n \"combination\": {\n \"3\": \"12\",\n \"4\": \"17\",\n \"17\": \"-1\"\n }\n },\n {\n \"exception_id\": \"4\",\n \"product_id\": \"12\",\n \"combination\": {\n \"3\": \"13\",\n \"4\": \"17\",\n \"17\": \"-2\"\n }\n },\n {\n \"exception_id\": \"5\",\n \"product_id\": \"12\",\n \"combination\": {\n \"3\": \"16\",\n \"4\": \"-1\",\n \"17\": \"-2\"\n }\n }\n]\n\nTo get the details of a specific exception, send a GET request to /api/exceptions/. For example:
GET /api/exceptions/1\n\nIf the request is successful, you’ll receive HTTP/1.1 200 OK and JSON with the details of the exception.
\nThe fields below represent various details of an exception.
\nThe Tijarahub/Multi-Vendor REST API always accepts and returns data as strings and arrays/objects. The Values column in the table merely shows what kind of data you can expect in the fields.
\nOption variants of the exceptions can have a negative value in the combination object:
-1—any variant of this option can be selected.
-2—no variant of this option can be selected.
For example:
\n{\n \"exception_id\": \"5\",\n \"product_id\": \"12\",\n \"combination\": {\n \"3\": \"16\",\n \"4\": \"-1\",\n \"17\": \"-2\"\n }\n}\n\nThis is an exception for the product with product_id=12. Let’s assume that:
the product we’re talking about is a T-shirt;
\nthe exception is of the Forbidden type;
\noption 3 is Size, and variant 16 is XXL;
\noption 4 is Color;
\noption 17 is a checkbox.
\nThen the checkbox will be grayed out and won’t be considered when a customer selects the XXL size for any color.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"info@example.com"},{"key":"password","value":"sFVIBxsMkCYpM8k36A2tqa17Pr2UUIgE74vdELVG41OuGYIu5w"}]},"isInherited":true,"source":{"_postman_id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","name":"Tijarahub-Sandbox","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"b86ffa44-d12e-433f-862b-ba32c23718cc"},{"name":"Create an Exception","id":"3095dbdd-7793-4bc7-8480-b0bc42e87c5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"product_id\": \"12\",\n \"combination\": {\n \"3\": \"-1\",\n \"4\": \"19\",\n \"17\": \"61\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-api.tijarahub.com/api/exceptions/15788","description":"To create an exception, send a POST request to /api/exceptions/.
Pass the fields with the exception details in the HTTP request body in accordance with the passed Content-Type. Required fields are marked with *:
product_id*—the unique identifier of the product that the exception is associated with.
\ncombination—the options and variants that comprise the exception.
\nExample JSON:
\n{\n \"product_id\": \"12\",\n \"combination\": {\n \"3\": \"-1\",\n \"4\": \"19\",\n \"17\": \"61\"\n }\n}\n\nThis request creates a new exception for the product with product_id=12. This exception describes the following combination of variants:
Any variant of option 3
\nVariant 19 of option 4
\nVariant 61 of option 17
\nIf the option exception is created successfully, you will receive HTTP/1.1 201 Created and the exception ID in the response:
\n{\n \"exception_id\": \"10\"\n}\n\nIf the exception couldn’t be created, you will receive HTTP/1.1 400 Bad Request.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"info@example.com"},{"key":"password","value":"sFVIBxsMkCYpM8k36A2tqa17Pr2UUIgE74vdELVG41OuGYIu5w"}]},"isInherited":true,"source":{"_postman_id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","id":"aa170b28-8e72-42e5-bf3f-3b0ba08f5af1","name":"Tijarahub-Sandbox","type":"collection"}},"urlObject":{"path":["exceptions","15788"],"host":["https://sandbox-api.tijarahub.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"3095dbdd-7793-4bc7-8480-b0bc42e87c5b"},{"name":"Update an Exception","id":"48e47fea-6cad-4853-9f16-3c7d63e44a2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"description":"To update an existing exception, send the PUT request to /api/exceptions//. For example:
PUT /api/exceptions/10\n\nPass the fields with exception details in the HTTP request body in accordance with the passed Content-Type. None of the fields are required.
**Example JSON:
**{
\"combination\": {
\n\"3\": \"-1\",
\n\"4\": \"18\",
\n\"17\": \"60\"
\n}
\n}
This request changes the option variants of the exception.
To delete an exception, send the DELETE request to /api/exceptions/?product_id=:id.
DELETE /api/exceptions/10?product_id=12\n\nThis request deletes the specified exception of the product.
\nPossible responses:
\nHTTP/1.1 204 No Content—the exception has been deleted successfully.
\nHTTP/1.1 400 Bad Request—the exception couldn’t be deleted.
\nHTTP/1.1 404 Not Found—the exception doesn’t exist.
\nYou can use exceptions to make specific combinations of Product Options Exceptions that the customers won’t be able to select. For example, if you sell a T-shirt in various colors and sizes, you can make a certain color unavailable for a specific size.
\nExceptions are somewhat similar to option combinations—they both include the combination object with variants of different options.
There are two types of exceptions:
\nForbidden—customers won’t be able to select the combinations of option variants specified in the combination object.
Allowed—customers will be able to select ONLY the combinations of option variants specified in the combination object.
The type of the exception is determined by the product that the exception is associated with. A product has a field called exceptions_type, that can have either A (allowed) or F (forbidden) as its value.