> For the complete documentation index, see [llms.txt](https://geosquare-1.gitbook.io/geosquare-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://geosquare-1.gitbook.io/geosquare-docs/product-products.md). # Product Products ## List products > Retrieve list of products with filtering and pagination support. Product. \ > \ > ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"product_product_list":{"type":"object","properties":{"models":{"type":"array","items":{"$ref":"#/components/schemas/product_product_list_item"}},"total_count":{"type":"integer","description":"Total number of items"}},"required":["models","total_count"]},"product_product_list_item":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"tva":{"type":["null","string"]},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":"null","description":"Description enrichie"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"shelf_id":{"type":["integer","string","null"],"description":"Rayon"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"name":{"type":["string","null"],"description":"Nom"},"main_item_price":{"type":["string","number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["null","string"]},"pamp":{"type":["null","string","number"]},"ean":{"type":["string","null"],"description":"EAN"},"reference":{"type":["string","null"],"description":"Référence"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"thumb_url":{"type":["null","string"]},"image_url":{"type":["null","string"]},"image_online_url":{"type":"null","description":"Url du visuel"},"conditionnement":{"type":["null","string"]},"mark_rate":{"type":"null","description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"cost_category_id":{"type":["integer","string","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","string","null"],"description":"Type de charge"},"month_advised_location_nb":{"type":["integer","null"],"description":"Month advised location nb"},"volume":{"type":["null","string"]},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"stock_min":{"type":["null","string"]},"stock_max":{"type":["null","string"]},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"warranty_id":{"type":["integer","string","null"],"description":"Garantie"},"is_readonly":{"type":["boolean","null"],"description":"Is readonly"},"conditionning":{"type":["null","string"]},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"sale_commissioned":{"type":["boolean","null"],"description":"Sale commissioned"},"unit_weight":{"type":["null","number"]},"hide_default_pamp":{"type":["boolean","null"],"description":"Hide default pamp"},"the_good_thumb_url":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"synchro":{"type":["boolean","null"],"description":"Synchronisation ?"},"shelf":{"type":"null","description":"Rayon"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":["string","null"],"description":"Unité d'achat"},"cost_category":{"type":["string","null"],"description":"Catégorie de charge"},"cost_type":{"type":["string","null"],"description":"Type de charge"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"has_items":{"type":["boolean","null"],"description":"Déclinaisons"},"warranty":{"type":"null","description":"Garantie"},"main_item_price_with_taxes":{"type":["string","number","null"],"description":"Prix de vente T.T.C."},"has_stock_change":{"type":["boolean","null"],"description":"Has stock change"},"has_zero_stock":{"type":["boolean","null"],"description":"Has zero stock"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"main_condition_bp":{"type":["string","number","null"],"description":"Prix d'achat H.T."}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name"],"additionalProperties":true}}},"paths":{"/products":{"get":{"summary":"List products","tags":["Product - Products"],"description":"Retrieve list of products with filtering and pagination support. Product. \n\n ","parameters":[{"name":"search","in":"query","required":false,"description":"Tableau des différents attributs de recherche","schema":{"type":"object","properties":{"name":{"type":"string","description":"Nom"},"reference":{"type":"string","description":"Référence"},"description":{"type":"string","description":"Description"},"extended_description":{"type":"string","description":"Description enrichie"},"conditionnement":{"type":"string","description":"Conditionnement"},"quantity":{"type":"number","description":"Quantité par défaut"},"unit_id":{"type":"integer","description":"Unité de mesure"},"category_id":{"type":"integer","description":"Catégorie"},"created_by_id":{"type":"integer","description":"Created by id"},"updated_by_id":{"type":"integer","description":"Updated by id"},"inactivated_at":{"type":"string","description":"Inactivated at"},"type":{"type":"string","description":"Type"},"image":{"type":"string","description":"Photo"},"image_online_url":{"type":"string","description":"Url du visuel"},"ean":{"type":"string","description":"EAN"},"mark_rate":{"type":"number","description":"Taux de marque"},"variable_weight":{"type":"boolean","description":"Produit à poids variable"},"invoiced_amount":{"type":"number","description":"Quantité facturée"},"shelf_id":{"type":"integer","description":"Rayon"},"has_pcb":{"type":"boolean","description":"Disponible en colis"},"pcb_quantity":{"type":"number","description":"Nombre d'articles par colis"},"enable_stock":{"type":"boolean","description":"Gestion du stock"},"stock_min":{"type":"number","description":"Stock minimum"},"stock_max":{"type":"number","description":"Stock souhaité"},"purchase_equivalence":{"type":"number","description":"Équivalence d'achat"},"purchase_unit_id":{"type":"integer","description":"Unité d'achat"},"brand_id":{"type":"integer","description":"Marque"},"is_equipment":{"type":"boolean","description":"Ce produit gère du matériel"},"is_for_sale":{"type":"boolean","description":"Ce produit est à la vente"},"show_on_client_area":{"type":"boolean","description":"Afficher dans l'espace client"},"has_rental":{"type":"boolean","description":"Disponible à la location"},"cost_price":{"type":"number","description":"Prix de revient H.T."},"unit_weight":{"type":"number","description":"Poids"},"warranty_id":{"type":"integer","description":"Garantie"},"interco_synchro_enabled":{"type":"boolean","description":"Ce produit est synchronisé"},"is_readonly":{"type":"boolean","description":"Is readonly"},"conditionning":{"type":"number","description":"Conditionnement"},"can_be_discounted":{"type":"boolean","description":"Peut être remisé"},"cost_category_id":{"type":"integer","description":"Catégorie de charge"},"cost_type_id":{"type":"integer","description":"Type de charge"},"sale_commissioned":{"type":"boolean","description":"Sale commissioned"},"volume":{"type":"number","description":"Volume"},"weight_per_cup":{"type":"number","description":"Weight per cup"},"month_cups_nb":{"type":"integer","description":"Month cups nb"},"advised_sell_price":{"type":"number","description":"Advised sell price"},"month_advised_location_nb":{"type":"integer","description":"Month advised location nb"},"name_en":{"type":"string","description":"Name en"},"name_de":{"type":"string","description":"Name de"},"scientific_name":{"type":"string","description":"Scientific name"},"unit_length":{"type":"number","description":"Unit length"},"unit_width":{"type":"number","description":"Unit width"},"unit_height":{"type":"number","description":"Unit height"},"composition_total_pieces":{"type":"integer","description":"Composition total pieces"},"import_json":{"type":"object","description":"Import json"},"search_index":{"type":"string","description":"Search index"},"main_item_price":{"type":"string","description":"Prix de vente H.T."},"pamp":{"type":"string","description":"Prix d'achat moyen pondéré"},"is_composition":{"type":"string","description":"Composition"},"the_good_thumb_url":{"type":"string","description":"Photo"},"has_items":{"type":"string","description":"Déclinaisons"},"main_condition_bp":{"type":"string","description":"Prix d'achat H.T."},"family_id":{"type":"integer","description":"Famille"},"tva":{"type":"string","description":"TVA par défaut"}},"additionalProperties":false}},{"name":"sort","in":"query","required":false,"description":"Tableau des différents attributs","schema":{"type":"object","properties":{"name":{"type":"string","description":"name DESC NULLS LAST(Descendant) ou name (Ascendant)"},"reference":{"type":"string","description":"reference DESC NULLS LAST(Descendant) ou reference (Ascendant)"},"description":{"type":"string","description":"description DESC NULLS LAST(Descendant) ou description (Ascendant)"},"extended_description":{"type":"string","description":"extended_description DESC NULLS LAST(Descendant) ou extended_description (Ascendant)"},"conditionnement":{"type":"string","description":"conditionnement DESC NULLS LAST(Descendant) ou conditionnement (Ascendant)"},"main_item_price":{"type":"string","description":"main_item_price DESC NULLS LAST(Descendant) ou main_item_price (Ascendant)"},"pamp":{"type":"string","description":"pamp DESC NULLS LAST(Descendant) ou pamp (Ascendant)"},"quantity":{"type":"string","description":"quantity DESC NULLS LAST(Descendant) ou quantity (Ascendant)"},"unit_id":{"type":"string","description":"unit_id DESC NULLS LAST(Descendant) ou unit_id (Ascendant)"},"family_id":{"type":"string","description":"family_id DESC NULLS LAST(Descendant) ou family_id (Ascendant)"},"category_id":{"type":"string","description":"category_id DESC NULLS LAST(Descendant) ou category_id (Ascendant)"},"created_by_id":{"type":"string","description":"created_by_id DESC NULLS LAST(Descendant) ou created_by_id (Ascendant)"},"updated_by_id":{"type":"string","description":"updated_by_id DESC NULLS LAST(Descendant) ou updated_by_id (Ascendant)"},"inactivated_at":{"type":"string","description":"inactivated_at DESC NULLS LAST(Descendant) ou inactivated_at (Ascendant)"},"tva":{"type":"string","description":"tva DESC NULLS LAST(Descendant) ou tva (Ascendant)"},"type":{"type":"string","description":"type DESC NULLS LAST(Descendant) ou type (Ascendant)"},"image":{"type":"string","description":"image DESC NULLS LAST(Descendant) ou image (Ascendant)"},"image_online_url":{"type":"string","description":"image_online_url DESC NULLS LAST(Descendant) ou image_online_url (Ascendant)"},"ean":{"type":"string","description":"ean DESC NULLS LAST(Descendant) ou ean (Ascendant)"},"mark_rate":{"type":"string","description":"mark_rate DESC NULLS LAST(Descendant) ou mark_rate (Ascendant)"},"variable_weight":{"type":"string","description":"variable_weight DESC NULLS LAST(Descendant) ou variable_weight (Ascendant)"},"invoiced_amount":{"type":"string","description":"invoiced_amount DESC NULLS LAST(Descendant) ou invoiced_amount (Ascendant)"},"shelf_id":{"type":"string","description":"shelf_id DESC NULLS LAST(Descendant) ou shelf_id (Ascendant)"},"has_pcb":{"type":"string","description":"has_pcb DESC NULLS LAST(Descendant) ou has_pcb (Ascendant)"},"pcb_quantity":{"type":"string","description":"pcb_quantity DESC NULLS LAST(Descendant) ou pcb_quantity (Ascendant)"},"enable_stock":{"type":"string","description":"enable_stock DESC NULLS LAST(Descendant) ou enable_stock (Ascendant)"},"stock_min":{"type":"string","description":"stock_min DESC NULLS LAST(Descendant) ou stock_min (Ascendant)"},"stock_max":{"type":"string","description":"stock_max DESC NULLS LAST(Descendant) ou stock_max (Ascendant)"},"purchase_equivalence":{"type":"string","description":"purchase_equivalence DESC NULLS LAST(Descendant) ou purchase_equivalence (Ascendant)"},"purchase_unit_id":{"type":"string","description":"purchase_unit_id DESC NULLS LAST(Descendant) ou purchase_unit_id (Ascendant)"},"brand_id":{"type":"string","description":"brand_id DESC NULLS LAST(Descendant) ou brand_id (Ascendant)"},"is_equipment":{"type":"string","description":"is_equipment DESC NULLS LAST(Descendant) ou is_equipment (Ascendant)"},"is_for_sale":{"type":"string","description":"is_for_sale DESC NULLS LAST(Descendant) ou is_for_sale (Ascendant)"},"show_on_client_area":{"type":"string","description":"show_on_client_area DESC NULLS LAST(Descendant) ou show_on_client_area (Ascendant)"},"has_rental":{"type":"string","description":"has_rental DESC NULLS LAST(Descendant) ou has_rental (Ascendant)"},"cost_price":{"type":"string","description":"cost_price DESC NULLS LAST(Descendant) ou cost_price (Ascendant)"},"unit_weight":{"type":"string","description":"unit_weight DESC NULLS LAST(Descendant) ou unit_weight (Ascendant)"},"warranty_id":{"type":"string","description":"warranty_id DESC NULLS LAST(Descendant) ou warranty_id (Ascendant)"},"interco_synchro_enabled":{"type":"string","description":"interco_synchro_enabled DESC NULLS LAST(Descendant) ou interco_synchro_enabled (Ascendant)"},"is_readonly":{"type":"string","description":"is_readonly DESC NULLS LAST(Descendant) ou is_readonly (Ascendant)"},"conditionning":{"type":"string","description":"conditionning DESC NULLS LAST(Descendant) ou conditionning (Ascendant)"},"can_be_discounted":{"type":"string","description":"can_be_discounted DESC NULLS LAST(Descendant) ou can_be_discounted (Ascendant)"},"cost_category_id":{"type":"string","description":"cost_category_id DESC NULLS LAST(Descendant) ou cost_category_id (Ascendant)"},"cost_type_id":{"type":"string","description":"cost_type_id DESC NULLS LAST(Descendant) ou cost_type_id (Ascendant)"},"sale_commissioned":{"type":"string","description":"sale_commissioned DESC NULLS LAST(Descendant) ou sale_commissioned (Ascendant)"},"volume":{"type":"string","description":"volume DESC NULLS LAST(Descendant) ou volume (Ascendant)"},"weight_per_cup":{"type":"string","description":"weight_per_cup DESC NULLS LAST(Descendant) ou weight_per_cup (Ascendant)"},"month_cups_nb":{"type":"string","description":"month_cups_nb DESC NULLS LAST(Descendant) ou month_cups_nb (Ascendant)"},"advised_sell_price":{"type":"string","description":"advised_sell_price DESC NULLS LAST(Descendant) ou advised_sell_price (Ascendant)"},"month_advised_location_nb":{"type":"string","description":"month_advised_location_nb DESC NULLS LAST(Descendant) ou month_advised_location_nb (Ascendant)"},"name_en":{"type":"string","description":"name_en DESC NULLS LAST(Descendant) ou name_en (Ascendant)"},"name_de":{"type":"string","description":"name_de DESC NULLS LAST(Descendant) ou name_de (Ascendant)"},"scientific_name":{"type":"string","description":"scientific_name DESC NULLS LAST(Descendant) ou scientific_name (Ascendant)"},"unit_length":{"type":"string","description":"unit_length DESC NULLS LAST(Descendant) ou unit_length (Ascendant)"},"unit_width":{"type":"string","description":"unit_width DESC NULLS LAST(Descendant) ou unit_width (Ascendant)"},"unit_height":{"type":"string","description":"unit_height DESC NULLS LAST(Descendant) ou unit_height (Ascendant)"},"composition_total_pieces":{"type":"string","description":"composition_total_pieces DESC NULLS LAST(Descendant) ou composition_total_pieces (Ascendant)"},"import_json":{"type":"string","description":"import_json DESC NULLS LAST(Descendant) ou import_json (Ascendant)"},"is_composition":{"type":"string","description":"is_composition DESC NULLS LAST(Descendant) ou is_composition (Ascendant)"},"has_items":{"type":"string","description":"has_items DESC NULLS LAST(Descendant) ou has_items (Ascendant)"},"main_condition_bp":{"type":"string","description":"main_condition_bp DESC NULLS LAST(Descendant) ou main_condition_bp (Ascendant)"}},"additionalProperties":false}},{"name":"page","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Number of items per page (-1 for all items/options mode)","schema":{"type":"integer"}},{"name":"scope","in":"query","required":false,"description":"Filter scope to apply","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Filter by tag name","schema":{"type":"string"}},{"name":"with_deleted","in":"query","required":false,"description":"Include soft-deleted items (1 to include, 0 or omit to exclude)","schema":{"type":"integer"}},{"name":"only_deleted","in":"query","required":false,"description":"Show only soft-deleted items (1 for only deleted)","schema":{"type":"integer"}},{"name":"with_inactivated","in":"query","required":false,"description":"Include inactivated items (1 to include)","schema":{"type":"integer"}},{"name":"only_inactivated","in":"query","required":false,"description":"Show only inactivated items (1 for only inactivated)","schema":{"type":"integer"}},{"name":"force_sort","in":"query","required":false,"description":"Force sorting even when custom search is used","schema":{"type":"string"}},{"name":"group_ids","in":"query","required":false,"description":"Comma-separated group IDs to filter by","schema":{"type":"string"}},{"name":"json_format","in":"query","required":false,"description":"Custom serialization format","schema":{"type":"string"}}],"responses":{"200":{"description":"List retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_list"}}}},"401":{"description":"Unauthorized - Invalid token"}}}}}} ``` ## Create product > Create a new Product product. Product ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"product_product_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":["string","null"],"description":"Tag names"},"description":"Tag names"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"tva":{"type":["null","string"]},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":["string","null"],"description":"Description enrichie"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"shelf_id":{"type":["integer","string","null"],"description":"Rayon"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"name":{"type":["string","null"],"description":"Nom"},"main_item_price":{"type":["string","number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["null","string"]},"pamp":{"type":["null","string","number"]},"ean":{"type":["string","null"],"description":"EAN"},"reference":{"type":["string","null"],"description":"Référence"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"thumb_url":{"type":["null","string"]},"image_url":{"type":["null","string"]},"image_online_url":{"type":["string","null"],"description":"Url du visuel"},"conditionnement":{"type":["null","string"]},"mark_rate":{"type":"null","description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"cost_category_id":{"type":["integer","string","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","string","null"],"description":"Type de charge"},"month_advised_location_nb":{"type":["integer","null"],"description":"Month advised location nb"},"volume":{"type":["null","string"]},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"stock_min":{"type":["null","string"]},"stock_max":{"type":["null","string"]},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"warranty_id":{"type":["integer","string","null"],"description":"Garantie"},"is_readonly":{"type":["boolean","null"],"description":"Is readonly"},"conditionning":{"type":["null","string"]},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"sale_commissioned":{"type":["boolean","null"],"description":"Sale commissioned"},"unit_weight":{"type":["null","number"]},"hide_default_pamp":{"type":["boolean","null"],"description":"Hide default pamp"},"the_good_thumb_url":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"synchro":{"type":["boolean","null"],"description":"Synchronisation ?"},"shelf":{"type":"null","description":"Rayon"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":["string","null"],"description":"Unité d'achat"},"cost_category":{"type":["string","null"],"description":"Catégorie de charge"},"cost_type":{"type":["string","null"],"description":"Type de charge"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"has_items":{"type":["boolean","null"],"description":"Déclinaisons"},"warranty":{"type":"null","description":"Garantie"},"main_item_price_with_taxes":{"type":["string","number","null"],"description":"Prix de vente T.T.C."},"has_stock_change":{"type":["boolean","null"],"description":"Has stock change"},"has_zero_stock":{"type":["boolean","null"],"description":"Has zero stock"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"main_condition_bp":{"type":"null","description":"Prix d'achat H.T."},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"stock_localizations":{"type":["null","object"]},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"rental_pricings":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"duration_number":{"type":["integer","null"],"description":"Duration number"},"duration_unite":{"type":["string","null"],"description":"Duration unite"},"group_contact_id":{"type":["integer","string","null"],"description":"Group contact id"},"group_contact":{"type":"null","description":"Group contact"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"price_ttc":{"type":["string","number","null"],"description":"Price ttc"}},"required":[],"additionalProperties":true},"description":"Rental pricings"},"items":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"tva":{"type":["null","string"]},"image_url":{"type":["null","string"]},"thumb_url":{"type":["null","string"]},"is_default":{"type":["boolean","null"],"description":"Is default"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"pamp":{"type":["null","string","number"]},"is_default_composition":{"type":["boolean","null"],"description":"Is default composition"},"unit_weight":{"type":["null","number"]},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"batch_ids":{"type":["array","null"],"items":{"type":["integer","null"],"description":"Batch ids"},"description":"Batch ids"},"main_batch":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"item_id":{"type":["integer","string","null"],"description":"Item id"},"number":{"type":"null","description":"Number"},"expiration_date":{"type":"null","description":"Expiration date"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"ean":{"type":["string","null"],"description":"EAN"}},"required":[],"additionalProperties":true},"main_batch_id":{"type":["integer","string","null"],"description":"Main batch id"},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"article_description":{"type":["string","null"],"description":"Article description"},"article_name":{"type":["string","null"],"description":"Article name"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"real_name":{"type":"null","description":"Real name"},"real_selling_price":{"type":"null","description":"Real selling price"},"real_reference":{"type":"null","description":"Real reference"},"real_ean":{"type":["string","null"],"description":"Real ean"},"real_quantity":{"type":["string","number","null"],"description":"Real quantity"},"real_invoiced_amount":{"type":"null","description":"Real invoiced amount"},"real_purchase_equivalence":{"type":"null","description":"Real purchase equivalence"},"real_stock_min":{"type":["string","number","null"],"description":"Real stock min"},"real_stock_max":{"type":["string","number","null"],"description":"Real stock max"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"name":{"type":["string","null"],"description":"Nom"},"selling_price":{"type":["string","number","null"],"description":"Selling price"},"reference":{"type":["string","null"],"description":"Référence"},"ean":{"type":["string","null"],"description":"EAN"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"description":{"type":["string","null"],"description":"Description"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":"null","description":"Unité d'achat"},"default_condition":{"type":"null","description":"Default condition"},"mark_rate":{"type":"null","description":"Taux de marque"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"composition_data":{"type":["array","null"],"items":{"type":"object"}},"composition_rows":{"type":["array","null"],"items":{"type":"object"}},"stock_localizations":{"type":["null","object"]},"has_customer_prices":{"type":["boolean","null"],"description":"Has customer prices"},"customer_price":{"type":"null","description":"Customer price"},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"conditionning":{"type":["null","string"]},"condition_buying_price":{"type":"null","description":"Condition buying price"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"}},"required":[],"additionalProperties":true},"description":"Items"}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true},"product_product_params":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"integer","description":"Identifiant"},"image":{"type":["string","null"],"description":"Photo"},"image_online_url":{"type":["string","null"],"description":"Url du visuel"},"type":{"type":["string","null"],"description":"Type"},"main_item_price":{"type":["number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["number","null"],"description":"Prix de revient H.T."},"pamp":{"type":["number","null"],"description":"Prix d'achat moyen pondéré"},"ean":{"type":["string","null"],"description":"EAN"},"name":{"type":["string","null"],"description":"Nom"},"reference":{"type":["string","null"],"description":"Référence"},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":["string","null"],"description":"Description enrichie"},"price":{"type":["string","null"],"description":"Prix Unitaire H.T"},"tva":{"type":["number","null"],"description":"TVA par défaut"},"quantity":{"type":"number","description":"Quantité par défaut"},"unit_id":{"type":["integer","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","null"],"description":"Unité d'achat"},"family_id":{"type":["integer","null"],"description":"Famille"},"brand_id":{"type":["integer","null"],"description":"Marque"},"shelf_id":{"type":["integer","null"],"description":"Rayon"},"category_id":{"type":["integer","null"],"description":"Catégorie"},"mark_rate":{"type":["number","null"],"description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"invoiced_amount":{"type":"number","description":"Quantité facturée"},"purchase_equivalence":{"type":"number","description":"Équivalence d'achat"},"stock_min":{"type":["number","null"],"description":"Stock minimum"},"stock_max":{"type":["number","null"],"description":"Stock souhaité"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["number","null"],"description":"Nombre d'articles par colis"},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"batch_price_change_percentage":{"type":["string","null"],"description":"Augmentation/Diminution globale en pourcentage"},"batch_price_change_rounding_type":{"type":["string","null"],"description":"Type d'arrondi"},"batch_price_change_precision":{"type":["string","null"],"description":"Précision"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"unit_weight":{"type":["number","null"],"description":"Poids"},"warranty_id":{"type":["integer","null"],"description":"Garantie"},"conditionning":{"type":["number","null"],"description":"Conditionnement"},"volume":{"type":["number","null"],"description":"Volume"},"batch_tags":{"type":["string","null"],"description":"Mots clés"},"cost_category_id":{"type":["integer","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","null"],"description":"Type de charge"},"sale_commissioned":{"type":"boolean","description":"Sale commissioned"},"items_attributes":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Identifiant"},"name":{"type":["string","null"],"description":"Description"},"reference":{"type":["string","null"],"description":"Référence"},"selling_price":{"type":["string","null"],"description":"Prix Unitaire H.T"},"quantity":{"type":["string","null"],"description":"Quantité par défaut"},"ean":{"type":["string","null"],"description":"EAN"},"invoiced_amount":{"type":["string","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","null"],"description":"Équivalence d'achat"},"stock_min":{"type":["string","null"],"description":"Stock minimum"},"stock_max":{"type":["string","null"],"description":"Stock souhaité"},"_destroy":{"type":["string","null"],"description":" destroy"}}}},"required":["quantity","invoiced_amount","purchase_equivalence","sale_commissioned"]}},"required":["product"]}}},"paths":{"/products":{"post":{"summary":"Create product","tags":["Product - Products"],"description":"Create a new Product product. Product","parameters":[],"responses":{"200":{"description":"Created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_detail"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_params"}}}}}}}} ``` ## New product form data > Get form data for creating new product ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"product_product_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":["string","null"],"description":"Tag names"},"description":"Tag names"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"tva":{"type":["null","string"]},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":["string","null"],"description":"Description enrichie"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"shelf_id":{"type":["integer","string","null"],"description":"Rayon"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"name":{"type":["string","null"],"description":"Nom"},"main_item_price":{"type":["string","number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["null","string"]},"pamp":{"type":["null","string","number"]},"ean":{"type":["string","null"],"description":"EAN"},"reference":{"type":["string","null"],"description":"Référence"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"thumb_url":{"type":["null","string"]},"image_url":{"type":["null","string"]},"image_online_url":{"type":["string","null"],"description":"Url du visuel"},"conditionnement":{"type":["null","string"]},"mark_rate":{"type":"null","description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"cost_category_id":{"type":["integer","string","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","string","null"],"description":"Type de charge"},"month_advised_location_nb":{"type":["integer","null"],"description":"Month advised location nb"},"volume":{"type":["null","string"]},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"stock_min":{"type":["null","string"]},"stock_max":{"type":["null","string"]},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"warranty_id":{"type":["integer","string","null"],"description":"Garantie"},"is_readonly":{"type":["boolean","null"],"description":"Is readonly"},"conditionning":{"type":["null","string"]},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"sale_commissioned":{"type":["boolean","null"],"description":"Sale commissioned"},"unit_weight":{"type":["null","number"]},"hide_default_pamp":{"type":["boolean","null"],"description":"Hide default pamp"},"the_good_thumb_url":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"synchro":{"type":["boolean","null"],"description":"Synchronisation ?"},"shelf":{"type":"null","description":"Rayon"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":["string","null"],"description":"Unité d'achat"},"cost_category":{"type":["string","null"],"description":"Catégorie de charge"},"cost_type":{"type":["string","null"],"description":"Type de charge"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"has_items":{"type":["boolean","null"],"description":"Déclinaisons"},"warranty":{"type":"null","description":"Garantie"},"main_item_price_with_taxes":{"type":["string","number","null"],"description":"Prix de vente T.T.C."},"has_stock_change":{"type":["boolean","null"],"description":"Has stock change"},"has_zero_stock":{"type":["boolean","null"],"description":"Has zero stock"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"main_condition_bp":{"type":"null","description":"Prix d'achat H.T."},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"stock_localizations":{"type":["null","object"]},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"rental_pricings":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"duration_number":{"type":["integer","null"],"description":"Duration number"},"duration_unite":{"type":["string","null"],"description":"Duration unite"},"group_contact_id":{"type":["integer","string","null"],"description":"Group contact id"},"group_contact":{"type":"null","description":"Group contact"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"price_ttc":{"type":["string","number","null"],"description":"Price ttc"}},"required":[],"additionalProperties":true},"description":"Rental pricings"},"items":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"tva":{"type":["null","string"]},"image_url":{"type":["null","string"]},"thumb_url":{"type":["null","string"]},"is_default":{"type":["boolean","null"],"description":"Is default"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"pamp":{"type":["null","string","number"]},"is_default_composition":{"type":["boolean","null"],"description":"Is default composition"},"unit_weight":{"type":["null","number"]},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"batch_ids":{"type":["array","null"],"items":{"type":["integer","null"],"description":"Batch ids"},"description":"Batch ids"},"main_batch":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"item_id":{"type":["integer","string","null"],"description":"Item id"},"number":{"type":"null","description":"Number"},"expiration_date":{"type":"null","description":"Expiration date"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"ean":{"type":["string","null"],"description":"EAN"}},"required":[],"additionalProperties":true},"main_batch_id":{"type":["integer","string","null"],"description":"Main batch id"},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"article_description":{"type":["string","null"],"description":"Article description"},"article_name":{"type":["string","null"],"description":"Article name"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"real_name":{"type":"null","description":"Real name"},"real_selling_price":{"type":"null","description":"Real selling price"},"real_reference":{"type":"null","description":"Real reference"},"real_ean":{"type":["string","null"],"description":"Real ean"},"real_quantity":{"type":["string","number","null"],"description":"Real quantity"},"real_invoiced_amount":{"type":"null","description":"Real invoiced amount"},"real_purchase_equivalence":{"type":"null","description":"Real purchase equivalence"},"real_stock_min":{"type":["string","number","null"],"description":"Real stock min"},"real_stock_max":{"type":["string","number","null"],"description":"Real stock max"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"name":{"type":["string","null"],"description":"Nom"},"selling_price":{"type":["string","number","null"],"description":"Selling price"},"reference":{"type":["string","null"],"description":"Référence"},"ean":{"type":["string","null"],"description":"EAN"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"description":{"type":["string","null"],"description":"Description"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":"null","description":"Unité d'achat"},"default_condition":{"type":"null","description":"Default condition"},"mark_rate":{"type":"null","description":"Taux de marque"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"composition_data":{"type":["array","null"],"items":{"type":"object"}},"composition_rows":{"type":["array","null"],"items":{"type":"object"}},"stock_localizations":{"type":["null","object"]},"has_customer_prices":{"type":["boolean","null"],"description":"Has customer prices"},"customer_price":{"type":"null","description":"Customer price"},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"conditionning":{"type":["null","string"]},"condition_buying_price":{"type":"null","description":"Condition buying price"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"}},"required":[],"additionalProperties":true},"description":"Items"}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/products/new":{"get":{"summary":"New product form data","tags":["Product - Products"],"description":"Get form data for creating new product","responses":{"200":{"description":"Form data retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_detail"}}}}}}}}} ``` ## Show product > Get a specific product by ID ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"product_product_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":["string","null"],"description":"Tag names"},"description":"Tag names"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"tva":{"type":["null","string"]},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":["string","null"],"description":"Description enrichie"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"shelf_id":{"type":["integer","string","null"],"description":"Rayon"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"name":{"type":["string","null"],"description":"Nom"},"main_item_price":{"type":["string","number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["null","string"]},"pamp":{"type":["null","string","number"]},"ean":{"type":["string","null"],"description":"EAN"},"reference":{"type":["string","null"],"description":"Référence"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"thumb_url":{"type":["null","string"]},"image_url":{"type":["null","string"]},"image_online_url":{"type":["string","null"],"description":"Url du visuel"},"conditionnement":{"type":["null","string"]},"mark_rate":{"type":"null","description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"cost_category_id":{"type":["integer","string","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","string","null"],"description":"Type de charge"},"month_advised_location_nb":{"type":["integer","null"],"description":"Month advised location nb"},"volume":{"type":["null","string"]},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"stock_min":{"type":["null","string"]},"stock_max":{"type":["null","string"]},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"warranty_id":{"type":["integer","string","null"],"description":"Garantie"},"is_readonly":{"type":["boolean","null"],"description":"Is readonly"},"conditionning":{"type":["null","string"]},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"sale_commissioned":{"type":["boolean","null"],"description":"Sale commissioned"},"unit_weight":{"type":["null","number"]},"hide_default_pamp":{"type":["boolean","null"],"description":"Hide default pamp"},"the_good_thumb_url":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"synchro":{"type":["boolean","null"],"description":"Synchronisation ?"},"shelf":{"type":"null","description":"Rayon"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":["string","null"],"description":"Unité d'achat"},"cost_category":{"type":["string","null"],"description":"Catégorie de charge"},"cost_type":{"type":["string","null"],"description":"Type de charge"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"has_items":{"type":["boolean","null"],"description":"Déclinaisons"},"warranty":{"type":"null","description":"Garantie"},"main_item_price_with_taxes":{"type":["string","number","null"],"description":"Prix de vente T.T.C."},"has_stock_change":{"type":["boolean","null"],"description":"Has stock change"},"has_zero_stock":{"type":["boolean","null"],"description":"Has zero stock"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"main_condition_bp":{"type":"null","description":"Prix d'achat H.T."},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"stock_localizations":{"type":["null","object"]},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"rental_pricings":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"duration_number":{"type":["integer","null"],"description":"Duration number"},"duration_unite":{"type":["string","null"],"description":"Duration unite"},"group_contact_id":{"type":["integer","string","null"],"description":"Group contact id"},"group_contact":{"type":"null","description":"Group contact"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"price_ttc":{"type":["string","number","null"],"description":"Price ttc"}},"required":[],"additionalProperties":true},"description":"Rental pricings"},"items":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"tva":{"type":["null","string"]},"image_url":{"type":["null","string"]},"thumb_url":{"type":["null","string"]},"is_default":{"type":["boolean","null"],"description":"Is default"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"pamp":{"type":["null","string","number"]},"is_default_composition":{"type":["boolean","null"],"description":"Is default composition"},"unit_weight":{"type":["null","number"]},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"batch_ids":{"type":["array","null"],"items":{"type":["integer","null"],"description":"Batch ids"},"description":"Batch ids"},"main_batch":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"item_id":{"type":["integer","string","null"],"description":"Item id"},"number":{"type":"null","description":"Number"},"expiration_date":{"type":"null","description":"Expiration date"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"ean":{"type":["string","null"],"description":"EAN"}},"required":[],"additionalProperties":true},"main_batch_id":{"type":["integer","string","null"],"description":"Main batch id"},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"article_description":{"type":["string","null"],"description":"Article description"},"article_name":{"type":["string","null"],"description":"Article name"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"real_name":{"type":"null","description":"Real name"},"real_selling_price":{"type":"null","description":"Real selling price"},"real_reference":{"type":"null","description":"Real reference"},"real_ean":{"type":["string","null"],"description":"Real ean"},"real_quantity":{"type":["string","number","null"],"description":"Real quantity"},"real_invoiced_amount":{"type":"null","description":"Real invoiced amount"},"real_purchase_equivalence":{"type":"null","description":"Real purchase equivalence"},"real_stock_min":{"type":["string","number","null"],"description":"Real stock min"},"real_stock_max":{"type":["string","number","null"],"description":"Real stock max"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"name":{"type":["string","null"],"description":"Nom"},"selling_price":{"type":["string","number","null"],"description":"Selling price"},"reference":{"type":["string","null"],"description":"Référence"},"ean":{"type":["string","null"],"description":"EAN"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"description":{"type":["string","null"],"description":"Description"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":"null","description":"Unité d'achat"},"default_condition":{"type":"null","description":"Default condition"},"mark_rate":{"type":"null","description":"Taux de marque"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"composition_data":{"type":["array","null"],"items":{"type":"object"}},"composition_rows":{"type":["array","null"],"items":{"type":"object"}},"stock_localizations":{"type":["null","object"]},"has_customer_prices":{"type":["boolean","null"],"description":"Has customer prices"},"customer_price":{"type":"null","description":"Customer price"},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"conditionning":{"type":["null","string"]},"condition_buying_price":{"type":"null","description":"Condition buying price"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"}},"required":[],"additionalProperties":true},"description":"Items"}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/products/{id}":{"get":{"summary":"Show product","tags":["Product - Products"],"description":"Get a specific product by ID","responses":{"200":{"description":"Product details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_detail"}}}},"404":{"description":"Product not found"}}}}}} ``` ## Delete product > Delete a product (soft delete) ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"delete_response":{"type":"object","properties":{}}}},"paths":{"/products/{id}":{"delete":{"summary":"Delete product","tags":["Product - Products"],"description":"Delete a product (soft delete)","responses":{"200":{"description":"Deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete_response"}}}}}}}}} ``` ## Update product > Update an existing product ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"product_product_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":["string","null"],"description":"Tag names"},"description":"Tag names"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"tva":{"type":["null","string"]},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":["string","null"],"description":"Description enrichie"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"shelf_id":{"type":["integer","string","null"],"description":"Rayon"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"name":{"type":["string","null"],"description":"Nom"},"main_item_price":{"type":["string","number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["null","string"]},"pamp":{"type":["null","string","number"]},"ean":{"type":["string","null"],"description":"EAN"},"reference":{"type":["string","null"],"description":"Référence"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"thumb_url":{"type":["null","string"]},"image_url":{"type":["null","string"]},"image_online_url":{"type":["string","null"],"description":"Url du visuel"},"conditionnement":{"type":["null","string"]},"mark_rate":{"type":"null","description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"cost_category_id":{"type":["integer","string","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","string","null"],"description":"Type de charge"},"month_advised_location_nb":{"type":["integer","null"],"description":"Month advised location nb"},"volume":{"type":["null","string"]},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"stock_min":{"type":["null","string"]},"stock_max":{"type":["null","string"]},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"warranty_id":{"type":["integer","string","null"],"description":"Garantie"},"is_readonly":{"type":["boolean","null"],"description":"Is readonly"},"conditionning":{"type":["null","string"]},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"sale_commissioned":{"type":["boolean","null"],"description":"Sale commissioned"},"unit_weight":{"type":["null","number"]},"hide_default_pamp":{"type":["boolean","null"],"description":"Hide default pamp"},"the_good_thumb_url":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"synchro":{"type":["boolean","null"],"description":"Synchronisation ?"},"shelf":{"type":"null","description":"Rayon"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":["string","null"],"description":"Unité d'achat"},"cost_category":{"type":["string","null"],"description":"Catégorie de charge"},"cost_type":{"type":["string","null"],"description":"Type de charge"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"has_items":{"type":["boolean","null"],"description":"Déclinaisons"},"warranty":{"type":"null","description":"Garantie"},"main_item_price_with_taxes":{"type":["string","number","null"],"description":"Prix de vente T.T.C."},"has_stock_change":{"type":["boolean","null"],"description":"Has stock change"},"has_zero_stock":{"type":["boolean","null"],"description":"Has zero stock"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"main_condition_bp":{"type":"null","description":"Prix d'achat H.T."},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"stock_localizations":{"type":["null","object"]},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"rental_pricings":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"duration_number":{"type":["integer","null"],"description":"Duration number"},"duration_unite":{"type":["string","null"],"description":"Duration unite"},"group_contact_id":{"type":["integer","string","null"],"description":"Group contact id"},"group_contact":{"type":"null","description":"Group contact"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"price_ttc":{"type":["string","number","null"],"description":"Price ttc"}},"required":[],"additionalProperties":true},"description":"Rental pricings"},"items":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"tva":{"type":["null","string"]},"image_url":{"type":["null","string"]},"thumb_url":{"type":["null","string"]},"is_default":{"type":["boolean","null"],"description":"Is default"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"pamp":{"type":["null","string","number"]},"is_default_composition":{"type":["boolean","null"],"description":"Is default composition"},"unit_weight":{"type":["null","number"]},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"batch_ids":{"type":["array","null"],"items":{"type":["integer","null"],"description":"Batch ids"},"description":"Batch ids"},"main_batch":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"item_id":{"type":["integer","string","null"],"description":"Item id"},"number":{"type":"null","description":"Number"},"expiration_date":{"type":"null","description":"Expiration date"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"ean":{"type":["string","null"],"description":"EAN"}},"required":[],"additionalProperties":true},"main_batch_id":{"type":["integer","string","null"],"description":"Main batch id"},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"article_description":{"type":["string","null"],"description":"Article description"},"article_name":{"type":["string","null"],"description":"Article name"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"real_name":{"type":"null","description":"Real name"},"real_selling_price":{"type":"null","description":"Real selling price"},"real_reference":{"type":"null","description":"Real reference"},"real_ean":{"type":["string","null"],"description":"Real ean"},"real_quantity":{"type":["string","number","null"],"description":"Real quantity"},"real_invoiced_amount":{"type":"null","description":"Real invoiced amount"},"real_purchase_equivalence":{"type":"null","description":"Real purchase equivalence"},"real_stock_min":{"type":["string","number","null"],"description":"Real stock min"},"real_stock_max":{"type":["string","number","null"],"description":"Real stock max"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"name":{"type":["string","null"],"description":"Nom"},"selling_price":{"type":["string","number","null"],"description":"Selling price"},"reference":{"type":["string","null"],"description":"Référence"},"ean":{"type":["string","null"],"description":"EAN"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"description":{"type":["string","null"],"description":"Description"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":"null","description":"Unité d'achat"},"default_condition":{"type":"null","description":"Default condition"},"mark_rate":{"type":"null","description":"Taux de marque"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"composition_data":{"type":["array","null"],"items":{"type":"object"}},"composition_rows":{"type":["array","null"],"items":{"type":"object"}},"stock_localizations":{"type":["null","object"]},"has_customer_prices":{"type":["boolean","null"],"description":"Has customer prices"},"customer_price":{"type":"null","description":"Customer price"},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"conditionning":{"type":["null","string"]},"condition_buying_price":{"type":"null","description":"Condition buying price"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"}},"required":[],"additionalProperties":true},"description":"Items"}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true},"product_product_params":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"integer","description":"Identifiant"},"image":{"type":["string","null"],"description":"Photo"},"image_online_url":{"type":["string","null"],"description":"Url du visuel"},"type":{"type":["string","null"],"description":"Type"},"main_item_price":{"type":["number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["number","null"],"description":"Prix de revient H.T."},"pamp":{"type":["number","null"],"description":"Prix d'achat moyen pondéré"},"ean":{"type":["string","null"],"description":"EAN"},"name":{"type":["string","null"],"description":"Nom"},"reference":{"type":["string","null"],"description":"Référence"},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":["string","null"],"description":"Description enrichie"},"price":{"type":["string","null"],"description":"Prix Unitaire H.T"},"tva":{"type":["number","null"],"description":"TVA par défaut"},"quantity":{"type":"number","description":"Quantité par défaut"},"unit_id":{"type":["integer","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","null"],"description":"Unité d'achat"},"family_id":{"type":["integer","null"],"description":"Famille"},"brand_id":{"type":["integer","null"],"description":"Marque"},"shelf_id":{"type":["integer","null"],"description":"Rayon"},"category_id":{"type":["integer","null"],"description":"Catégorie"},"mark_rate":{"type":["number","null"],"description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"invoiced_amount":{"type":"number","description":"Quantité facturée"},"purchase_equivalence":{"type":"number","description":"Équivalence d'achat"},"stock_min":{"type":["number","null"],"description":"Stock minimum"},"stock_max":{"type":["number","null"],"description":"Stock souhaité"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["number","null"],"description":"Nombre d'articles par colis"},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"batch_price_change_percentage":{"type":["string","null"],"description":"Augmentation/Diminution globale en pourcentage"},"batch_price_change_rounding_type":{"type":["string","null"],"description":"Type d'arrondi"},"batch_price_change_precision":{"type":["string","null"],"description":"Précision"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"unit_weight":{"type":["number","null"],"description":"Poids"},"warranty_id":{"type":["integer","null"],"description":"Garantie"},"conditionning":{"type":["number","null"],"description":"Conditionnement"},"volume":{"type":["number","null"],"description":"Volume"},"batch_tags":{"type":["string","null"],"description":"Mots clés"},"cost_category_id":{"type":["integer","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","null"],"description":"Type de charge"},"sale_commissioned":{"type":"boolean","description":"Sale commissioned"},"items_attributes":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Identifiant"},"name":{"type":["string","null"],"description":"Description"},"reference":{"type":["string","null"],"description":"Référence"},"selling_price":{"type":["string","null"],"description":"Prix Unitaire H.T"},"quantity":{"type":["string","null"],"description":"Quantité par défaut"},"ean":{"type":["string","null"],"description":"EAN"},"invoiced_amount":{"type":["string","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","null"],"description":"Équivalence d'achat"},"stock_min":{"type":["string","null"],"description":"Stock minimum"},"stock_max":{"type":["string","null"],"description":"Stock souhaité"},"_destroy":{"type":["string","null"],"description":" destroy"}}}},"required":["quantity","invoiced_amount","purchase_equivalence","sale_commissioned"]}},"required":["product"]}}},"paths":{"/products/{id}":{"patch":{"summary":"Update product","tags":["Product - Products"],"description":"Update an existing product","parameters":[],"responses":{"200":{"description":"Updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_detail"}}}},"404":{"description":"Product not found"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_params"}}}}}}}} ``` ## POST /products/{id}/active > Mark product as active ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"product_product_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":["string","null"],"description":"Tag names"},"description":"Tag names"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"tva":{"type":["null","string"]},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":["string","null"],"description":"Description enrichie"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"shelf_id":{"type":["integer","string","null"],"description":"Rayon"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"name":{"type":["string","null"],"description":"Nom"},"main_item_price":{"type":["string","number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["null","string"]},"pamp":{"type":["null","string","number"]},"ean":{"type":["string","null"],"description":"EAN"},"reference":{"type":["string","null"],"description":"Référence"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"thumb_url":{"type":["null","string"]},"image_url":{"type":["null","string"]},"image_online_url":{"type":["string","null"],"description":"Url du visuel"},"conditionnement":{"type":["null","string"]},"mark_rate":{"type":"null","description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"cost_category_id":{"type":["integer","string","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","string","null"],"description":"Type de charge"},"month_advised_location_nb":{"type":["integer","null"],"description":"Month advised location nb"},"volume":{"type":["null","string"]},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"stock_min":{"type":["null","string"]},"stock_max":{"type":["null","string"]},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"warranty_id":{"type":["integer","string","null"],"description":"Garantie"},"is_readonly":{"type":["boolean","null"],"description":"Is readonly"},"conditionning":{"type":["null","string"]},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"sale_commissioned":{"type":["boolean","null"],"description":"Sale commissioned"},"unit_weight":{"type":["null","number"]},"hide_default_pamp":{"type":["boolean","null"],"description":"Hide default pamp"},"the_good_thumb_url":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"synchro":{"type":["boolean","null"],"description":"Synchronisation ?"},"shelf":{"type":"null","description":"Rayon"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":["string","null"],"description":"Unité d'achat"},"cost_category":{"type":["string","null"],"description":"Catégorie de charge"},"cost_type":{"type":["string","null"],"description":"Type de charge"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"has_items":{"type":["boolean","null"],"description":"Déclinaisons"},"warranty":{"type":"null","description":"Garantie"},"main_item_price_with_taxes":{"type":["string","number","null"],"description":"Prix de vente T.T.C."},"has_stock_change":{"type":["boolean","null"],"description":"Has stock change"},"has_zero_stock":{"type":["boolean","null"],"description":"Has zero stock"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"main_condition_bp":{"type":"null","description":"Prix d'achat H.T."},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"stock_localizations":{"type":["null","object"]},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"rental_pricings":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"duration_number":{"type":["integer","null"],"description":"Duration number"},"duration_unite":{"type":["string","null"],"description":"Duration unite"},"group_contact_id":{"type":["integer","string","null"],"description":"Group contact id"},"group_contact":{"type":"null","description":"Group contact"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"price_ttc":{"type":["string","number","null"],"description":"Price ttc"}},"required":[],"additionalProperties":true},"description":"Rental pricings"},"items":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"tva":{"type":["null","string"]},"image_url":{"type":["null","string"]},"thumb_url":{"type":["null","string"]},"is_default":{"type":["boolean","null"],"description":"Is default"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"pamp":{"type":["null","string","number"]},"is_default_composition":{"type":["boolean","null"],"description":"Is default composition"},"unit_weight":{"type":["null","number"]},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"batch_ids":{"type":["array","null"],"items":{"type":["integer","null"],"description":"Batch ids"},"description":"Batch ids"},"main_batch":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"item_id":{"type":["integer","string","null"],"description":"Item id"},"number":{"type":"null","description":"Number"},"expiration_date":{"type":"null","description":"Expiration date"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"ean":{"type":["string","null"],"description":"EAN"}},"required":[],"additionalProperties":true},"main_batch_id":{"type":["integer","string","null"],"description":"Main batch id"},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"article_description":{"type":["string","null"],"description":"Article description"},"article_name":{"type":["string","null"],"description":"Article name"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"real_name":{"type":"null","description":"Real name"},"real_selling_price":{"type":"null","description":"Real selling price"},"real_reference":{"type":"null","description":"Real reference"},"real_ean":{"type":["string","null"],"description":"Real ean"},"real_quantity":{"type":["string","number","null"],"description":"Real quantity"},"real_invoiced_amount":{"type":"null","description":"Real invoiced amount"},"real_purchase_equivalence":{"type":"null","description":"Real purchase equivalence"},"real_stock_min":{"type":["string","number","null"],"description":"Real stock min"},"real_stock_max":{"type":["string","number","null"],"description":"Real stock max"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"name":{"type":["string","null"],"description":"Nom"},"selling_price":{"type":["string","number","null"],"description":"Selling price"},"reference":{"type":["string","null"],"description":"Référence"},"ean":{"type":["string","null"],"description":"EAN"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"description":{"type":["string","null"],"description":"Description"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":"null","description":"Unité d'achat"},"default_condition":{"type":"null","description":"Default condition"},"mark_rate":{"type":"null","description":"Taux de marque"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"composition_data":{"type":["array","null"],"items":{"type":"object"}},"composition_rows":{"type":["array","null"],"items":{"type":"object"}},"stock_localizations":{"type":["null","object"]},"has_customer_prices":{"type":["boolean","null"],"description":"Has customer prices"},"customer_price":{"type":"null","description":"Customer price"},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"conditionning":{"type":["null","string"]},"condition_buying_price":{"type":"null","description":"Condition buying price"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"}},"required":[],"additionalProperties":true},"description":"Items"}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/products/{id}/active":{"post":{"summary":"Mark product as active","tags":["Product - Products"],"responses":{"200":{"description":"Marked as active","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_detail"}}}}}}}}} ``` ## POST /products/{id}/inactive > Mark product as inactive ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"product_product_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":["string","null"],"description":"Tag names"},"description":"Tag names"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"tva":{"type":["null","string"]},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":["string","null"],"description":"Description enrichie"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"shelf_id":{"type":["integer","string","null"],"description":"Rayon"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"name":{"type":["string","null"],"description":"Nom"},"main_item_price":{"type":["string","number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["null","string"]},"pamp":{"type":["null","string","number"]},"ean":{"type":["string","null"],"description":"EAN"},"reference":{"type":["string","null"],"description":"Référence"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"thumb_url":{"type":["null","string"]},"image_url":{"type":["null","string"]},"image_online_url":{"type":["string","null"],"description":"Url du visuel"},"conditionnement":{"type":["null","string"]},"mark_rate":{"type":"null","description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"cost_category_id":{"type":["integer","string","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","string","null"],"description":"Type de charge"},"month_advised_location_nb":{"type":["integer","null"],"description":"Month advised location nb"},"volume":{"type":["null","string"]},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"stock_min":{"type":["null","string"]},"stock_max":{"type":["null","string"]},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"warranty_id":{"type":["integer","string","null"],"description":"Garantie"},"is_readonly":{"type":["boolean","null"],"description":"Is readonly"},"conditionning":{"type":["null","string"]},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"sale_commissioned":{"type":["boolean","null"],"description":"Sale commissioned"},"unit_weight":{"type":["null","number"]},"hide_default_pamp":{"type":["boolean","null"],"description":"Hide default pamp"},"the_good_thumb_url":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"synchro":{"type":["boolean","null"],"description":"Synchronisation ?"},"shelf":{"type":"null","description":"Rayon"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":["string","null"],"description":"Unité d'achat"},"cost_category":{"type":["string","null"],"description":"Catégorie de charge"},"cost_type":{"type":["string","null"],"description":"Type de charge"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"has_items":{"type":["boolean","null"],"description":"Déclinaisons"},"warranty":{"type":"null","description":"Garantie"},"main_item_price_with_taxes":{"type":["string","number","null"],"description":"Prix de vente T.T.C."},"has_stock_change":{"type":["boolean","null"],"description":"Has stock change"},"has_zero_stock":{"type":["boolean","null"],"description":"Has zero stock"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"main_condition_bp":{"type":"null","description":"Prix d'achat H.T."},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"stock_localizations":{"type":["null","object"]},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"rental_pricings":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"duration_number":{"type":["integer","null"],"description":"Duration number"},"duration_unite":{"type":["string","null"],"description":"Duration unite"},"group_contact_id":{"type":["integer","string","null"],"description":"Group contact id"},"group_contact":{"type":"null","description":"Group contact"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"price_ttc":{"type":["string","number","null"],"description":"Price ttc"}},"required":[],"additionalProperties":true},"description":"Rental pricings"},"items":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"tva":{"type":["null","string"]},"image_url":{"type":["null","string"]},"thumb_url":{"type":["null","string"]},"is_default":{"type":["boolean","null"],"description":"Is default"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"pamp":{"type":["null","string","number"]},"is_default_composition":{"type":["boolean","null"],"description":"Is default composition"},"unit_weight":{"type":["null","number"]},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"batch_ids":{"type":["array","null"],"items":{"type":["integer","null"],"description":"Batch ids"},"description":"Batch ids"},"main_batch":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"item_id":{"type":["integer","string","null"],"description":"Item id"},"number":{"type":"null","description":"Number"},"expiration_date":{"type":"null","description":"Expiration date"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"ean":{"type":["string","null"],"description":"EAN"}},"required":[],"additionalProperties":true},"main_batch_id":{"type":["integer","string","null"],"description":"Main batch id"},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"article_description":{"type":["string","null"],"description":"Article description"},"article_name":{"type":["string","null"],"description":"Article name"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"real_name":{"type":"null","description":"Real name"},"real_selling_price":{"type":"null","description":"Real selling price"},"real_reference":{"type":"null","description":"Real reference"},"real_ean":{"type":["string","null"],"description":"Real ean"},"real_quantity":{"type":["string","number","null"],"description":"Real quantity"},"real_invoiced_amount":{"type":"null","description":"Real invoiced amount"},"real_purchase_equivalence":{"type":"null","description":"Real purchase equivalence"},"real_stock_min":{"type":["string","number","null"],"description":"Real stock min"},"real_stock_max":{"type":["string","number","null"],"description":"Real stock max"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"name":{"type":["string","null"],"description":"Nom"},"selling_price":{"type":["string","number","null"],"description":"Selling price"},"reference":{"type":["string","null"],"description":"Référence"},"ean":{"type":["string","null"],"description":"EAN"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"description":{"type":["string","null"],"description":"Description"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":"null","description":"Unité d'achat"},"default_condition":{"type":"null","description":"Default condition"},"mark_rate":{"type":"null","description":"Taux de marque"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"composition_data":{"type":["array","null"],"items":{"type":"object"}},"composition_rows":{"type":["array","null"],"items":{"type":"object"}},"stock_localizations":{"type":["null","object"]},"has_customer_prices":{"type":["boolean","null"],"description":"Has customer prices"},"customer_price":{"type":"null","description":"Customer price"},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"conditionning":{"type":["null","string"]},"condition_buying_price":{"type":"null","description":"Condition buying price"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"}},"required":[],"additionalProperties":true},"description":"Items"}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/products/{id}/inactive":{"post":{"summary":"Mark product as inactive","tags":["Product - Products"],"responses":{"200":{"description":"Marked as inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_detail"}}}}}}}}} ``` ## POST /products/{id}/undelete > Undelete product ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"product_product_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":["string","null"],"description":"Tag names"},"description":"Tag names"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"tva":{"type":["null","string"]},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":["string","null"],"description":"Description enrichie"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"shelf_id":{"type":["integer","string","null"],"description":"Rayon"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"name":{"type":["string","null"],"description":"Nom"},"main_item_price":{"type":["string","number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["null","string"]},"pamp":{"type":["null","string","number"]},"ean":{"type":["string","null"],"description":"EAN"},"reference":{"type":["string","null"],"description":"Référence"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"thumb_url":{"type":["null","string"]},"image_url":{"type":["null","string"]},"image_online_url":{"type":["string","null"],"description":"Url du visuel"},"conditionnement":{"type":["null","string"]},"mark_rate":{"type":"null","description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"cost_category_id":{"type":["integer","string","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","string","null"],"description":"Type de charge"},"month_advised_location_nb":{"type":["integer","null"],"description":"Month advised location nb"},"volume":{"type":["null","string"]},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"stock_min":{"type":["null","string"]},"stock_max":{"type":["null","string"]},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"warranty_id":{"type":["integer","string","null"],"description":"Garantie"},"is_readonly":{"type":["boolean","null"],"description":"Is readonly"},"conditionning":{"type":["null","string"]},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"sale_commissioned":{"type":["boolean","null"],"description":"Sale commissioned"},"unit_weight":{"type":["null","number"]},"hide_default_pamp":{"type":["boolean","null"],"description":"Hide default pamp"},"the_good_thumb_url":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"synchro":{"type":["boolean","null"],"description":"Synchronisation ?"},"shelf":{"type":"null","description":"Rayon"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":["string","null"],"description":"Unité d'achat"},"cost_category":{"type":["string","null"],"description":"Catégorie de charge"},"cost_type":{"type":["string","null"],"description":"Type de charge"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"has_items":{"type":["boolean","null"],"description":"Déclinaisons"},"warranty":{"type":"null","description":"Garantie"},"main_item_price_with_taxes":{"type":["string","number","null"],"description":"Prix de vente T.T.C."},"has_stock_change":{"type":["boolean","null"],"description":"Has stock change"},"has_zero_stock":{"type":["boolean","null"],"description":"Has zero stock"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"main_condition_bp":{"type":"null","description":"Prix d'achat H.T."},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"stock_localizations":{"type":["null","object"]},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"rental_pricings":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"duration_number":{"type":["integer","null"],"description":"Duration number"},"duration_unite":{"type":["string","null"],"description":"Duration unite"},"group_contact_id":{"type":["integer","string","null"],"description":"Group contact id"},"group_contact":{"type":"null","description":"Group contact"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"price_ttc":{"type":["string","number","null"],"description":"Price ttc"}},"required":[],"additionalProperties":true},"description":"Rental pricings"},"items":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"tva":{"type":["null","string"]},"image_url":{"type":["null","string"]},"thumb_url":{"type":["null","string"]},"is_default":{"type":["boolean","null"],"description":"Is default"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"pamp":{"type":["null","string","number"]},"is_default_composition":{"type":["boolean","null"],"description":"Is default composition"},"unit_weight":{"type":["null","number"]},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"batch_ids":{"type":["array","null"],"items":{"type":["integer","null"],"description":"Batch ids"},"description":"Batch ids"},"main_batch":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"item_id":{"type":["integer","string","null"],"description":"Item id"},"number":{"type":"null","description":"Number"},"expiration_date":{"type":"null","description":"Expiration date"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"ean":{"type":["string","null"],"description":"EAN"}},"required":[],"additionalProperties":true},"main_batch_id":{"type":["integer","string","null"],"description":"Main batch id"},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"article_description":{"type":["string","null"],"description":"Article description"},"article_name":{"type":["string","null"],"description":"Article name"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"real_name":{"type":"null","description":"Real name"},"real_selling_price":{"type":"null","description":"Real selling price"},"real_reference":{"type":"null","description":"Real reference"},"real_ean":{"type":["string","null"],"description":"Real ean"},"real_quantity":{"type":["string","number","null"],"description":"Real quantity"},"real_invoiced_amount":{"type":"null","description":"Real invoiced amount"},"real_purchase_equivalence":{"type":"null","description":"Real purchase equivalence"},"real_stock_min":{"type":["string","number","null"],"description":"Real stock min"},"real_stock_max":{"type":["string","number","null"],"description":"Real stock max"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"name":{"type":["string","null"],"description":"Nom"},"selling_price":{"type":["string","number","null"],"description":"Selling price"},"reference":{"type":["string","null"],"description":"Référence"},"ean":{"type":["string","null"],"description":"EAN"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"description":{"type":["string","null"],"description":"Description"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":"null","description":"Unité d'achat"},"default_condition":{"type":"null","description":"Default condition"},"mark_rate":{"type":"null","description":"Taux de marque"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"composition_data":{"type":["array","null"],"items":{"type":"object"}},"composition_rows":{"type":["array","null"],"items":{"type":"object"}},"stock_localizations":{"type":["null","object"]},"has_customer_prices":{"type":["boolean","null"],"description":"Has customer prices"},"customer_price":{"type":"null","description":"Customer price"},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"conditionning":{"type":["null","string"]},"condition_buying_price":{"type":"null","description":"Condition buying price"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"}},"required":[],"additionalProperties":true},"description":"Items"}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/products/{id}/undelete":{"post":{"summary":"Undelete product","tags":["Product - Products"],"responses":{"200":{"description":"Undeleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_detail"}}}}}}}}} ``` ## Copy product > Get copy of product for duplication ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"product_product_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":["string","null"],"description":"Tag names"},"description":"Tag names"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"interco_synchro_enabled":{"type":["boolean","null"],"description":"Ce produit est synchronisé"},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"tva":{"type":["null","string"]},"description":{"type":["string","null"],"description":"Description"},"extended_description":{"type":["string","null"],"description":"Description enrichie"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"shelf_id":{"type":["integer","string","null"],"description":"Rayon"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"name":{"type":["string","null"],"description":"Nom"},"main_item_price":{"type":["string","number","null"],"description":"Prix de vente H.T."},"cost_price":{"type":["null","string"]},"pamp":{"type":["null","string","number"]},"ean":{"type":["string","null"],"description":"EAN"},"reference":{"type":["string","null"],"description":"Référence"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"thumb_url":{"type":["null","string"]},"image_url":{"type":["null","string"]},"image_online_url":{"type":["string","null"],"description":"Url du visuel"},"conditionnement":{"type":["null","string"]},"mark_rate":{"type":"null","description":"Taux de marque"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"cost_category_id":{"type":["integer","string","null"],"description":"Catégorie de charge"},"cost_type_id":{"type":["integer","string","null"],"description":"Type de charge"},"month_advised_location_nb":{"type":["integer","null"],"description":"Month advised location nb"},"volume":{"type":["null","string"]},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"stock_min":{"type":["null","string"]},"stock_max":{"type":["null","string"]},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"is_for_sale":{"type":["boolean","null"],"description":"Ce produit est à la vente"},"show_on_client_area":{"type":["boolean","null"],"description":"Afficher dans l'espace client"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"warranty_id":{"type":["integer","string","null"],"description":"Garantie"},"is_readonly":{"type":["boolean","null"],"description":"Is readonly"},"conditionning":{"type":["null","string"]},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"sale_commissioned":{"type":["boolean","null"],"description":"Sale commissioned"},"unit_weight":{"type":["null","number"]},"hide_default_pamp":{"type":["boolean","null"],"description":"Hide default pamp"},"the_good_thumb_url":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"synchro":{"type":["boolean","null"],"description":"Synchronisation ?"},"shelf":{"type":"null","description":"Rayon"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":["string","null"],"description":"Unité d'achat"},"cost_category":{"type":["string","null"],"description":"Catégorie de charge"},"cost_type":{"type":["string","null"],"description":"Type de charge"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"has_items":{"type":["boolean","null"],"description":"Déclinaisons"},"warranty":{"type":"null","description":"Garantie"},"main_item_price_with_taxes":{"type":["string","number","null"],"description":"Prix de vente T.T.C."},"has_stock_change":{"type":["boolean","null"],"description":"Has stock change"},"has_zero_stock":{"type":["boolean","null"],"description":"Has zero stock"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"main_condition_bp":{"type":"null","description":"Prix d'achat H.T."},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"stock_localizations":{"type":["null","object"]},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"rental_pricings":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"duration_number":{"type":["integer","null"],"description":"Duration number"},"duration_unite":{"type":["string","null"],"description":"Duration unite"},"group_contact_id":{"type":["integer","string","null"],"description":"Group contact id"},"group_contact":{"type":"null","description":"Group contact"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"price_ttc":{"type":["string","number","null"],"description":"Price ttc"}},"required":[],"additionalProperties":true},"description":"Rental pricings"},"items":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Fiche Technique"},"id":{"type":["integer","null"],"description":"Identifiant"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"unit_id":{"type":["integer","string","null"],"description":"Unité de mesure"},"purchase_unit_id":{"type":["integer","string","null"],"description":"Unité d'achat"},"tva":{"type":["null","string"]},"image_url":{"type":["null","string"]},"thumb_url":{"type":["null","string"]},"is_default":{"type":["boolean","null"],"description":"Is default"},"article_id":{"type":["integer","string","null"],"description":"Article id"},"pamp":{"type":["null","string","number"]},"is_default_composition":{"type":["boolean","null"],"description":"Is default composition"},"unit_weight":{"type":["null","number"]},"category_id":{"type":["integer","string","null"],"description":"Catégorie"},"brand_id":{"type":["integer","string","null"],"description":"Marque"},"family_id":{"type":["integer","string","null"],"description":"Famille"},"can_be_discounted":{"type":["boolean","null"],"description":"Peut être remisé"},"batch_ids":{"type":["array","null"],"items":{"type":["integer","null"],"description":"Batch ids"},"description":"Batch ids"},"main_batch":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Identifiant"},"item_id":{"type":["integer","string","null"],"description":"Item id"},"number":{"type":"null","description":"Number"},"expiration_date":{"type":"null","description":"Expiration date"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"ean":{"type":["string","null"],"description":"EAN"}},"required":[],"additionalProperties":true},"main_batch_id":{"type":["integer","string","null"],"description":"Main batch id"},"category":{"type":["object","null"],"properties":{"color":{"type":["string","number","null"],"description":"Color"},"option_label":{"type":["string","null"],"description":"Option label"}},"required":[],"additionalProperties":true},"article_description":{"type":["string","null"],"description":"Article description"},"article_name":{"type":["string","null"],"description":"Article name"},"family":{"type":["string","null"],"description":"Famille"},"brand":{"type":"null","description":"Marque"},"real_name":{"type":"null","description":"Real name"},"real_selling_price":{"type":"null","description":"Real selling price"},"real_reference":{"type":"null","description":"Real reference"},"real_ean":{"type":["string","null"],"description":"Real ean"},"real_quantity":{"type":["string","number","null"],"description":"Real quantity"},"real_invoiced_amount":{"type":"null","description":"Real invoiced amount"},"real_purchase_equivalence":{"type":"null","description":"Real purchase equivalence"},"real_stock_min":{"type":["string","number","null"],"description":"Real stock min"},"real_stock_max":{"type":["string","number","null"],"description":"Real stock max"},"stock_real":{"type":["string","number","null"],"description":"Stock physique"},"stock_virtual":{"type":["string","number","null"],"description":"Stock virtuel"},"stock_customer_order":{"type":["string","number","null"],"description":"Stock en commande client"},"stock_supplier_order":{"type":["string","number","null"],"description":"Stock en commande fournisseur"},"stock_rental":{"type":["string","number","null"],"description":"Stock en location"},"stock":{"type":["object","null"],"properties":{},"required":[],"additionalProperties":true},"name":{"type":["string","null"],"description":"Nom"},"selling_price":{"type":["string","number","null"],"description":"Selling price"},"reference":{"type":["string","null"],"description":"Référence"},"ean":{"type":["string","null"],"description":"EAN"},"quantity":{"type":["string","number","null"],"description":"Quantité par défaut"},"invoiced_amount":{"type":["string","number","null"],"description":"Quantité facturée"},"purchase_equivalence":{"type":["string","number","null"],"description":"Équivalence d'achat"},"price":{"type":["string","number","null"],"description":"Prix Unitaire H.T"},"description":{"type":["string","null"],"description":"Description"},"unit":{"type":["string","null"],"description":"Unité"},"purchase_unit":{"type":"null","description":"Unité d'achat"},"default_condition":{"type":"null","description":"Default condition"},"mark_rate":{"type":"null","description":"Taux de marque"},"has_pcb":{"type":["boolean","null"],"description":"Disponible en colis"},"has_rental":{"type":["boolean","null"],"description":"Disponible à la location"},"is_equipment":{"type":["boolean","null"],"description":"Ce produit gère du matériel"},"pcb_quantity":{"type":["string","number","null"],"description":"Nombre d'articles par colis"},"variable_weight":{"type":["boolean","null"],"description":"Produit à poids variable"},"enable_stock":{"type":["boolean","null"],"description":"Gestion du stock"},"is_composition":{"type":["boolean","null"],"description":"Composition"},"composition_data":{"type":["array","null"],"items":{"type":"object"}},"composition_rows":{"type":["array","null"],"items":{"type":"object"}},"stock_localizations":{"type":["null","object"]},"has_customer_prices":{"type":["boolean","null"],"description":"Has customer prices"},"customer_price":{"type":"null","description":"Customer price"},"has_pricing_list":{"type":["boolean","null"],"description":"Has pricing list"},"pricing_list_price":{"type":"null","description":"Pricing list price"},"image":{"type":["object","null"],"properties":{"url":{"type":["null","string"]},"thumb":{"type":["object","null"],"properties":{"url":{"type":["null","string"]}},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},"conditionning":{"type":["null","string"]},"condition_buying_price":{"type":"null","description":"Condition buying price"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"}},"required":[],"additionalProperties":true},"description":"Items"}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/products/{id}/copy":{"get":{"summary":"Copy product","tags":["Product - Products"],"description":"Get copy of product for duplication","responses":{"200":{"description":"Copy data retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_product_detail"}}}}}}}}} ``` ## GET /products/{id}/mpdf > Export product to PDF ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/products/{id}/mpdf":{"get":{"summary":"Export product to PDF","tags":["Product - Products"],"responses":{"200":{"description":"PDF file","content":{"application/pdf":{"schema":{"type":"string","contentMediaType":"application/octet-stream"}}}}}}}}} ``` ## GET /products/{id}/mcsv > Export product to CSV ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/products/{id}/mcsv":{"get":{"summary":"Export product to CSV","tags":["Product - Products"],"responses":{"200":{"description":"CSV export data"}}}}}} ``` ## Get products IDs > Get list of products IDs ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"ids_response":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer"}}},"required":["ids"]}}},"paths":{"/products/ids":{"get":{"summary":"Get products IDs","tags":["Product - Products"],"description":"Get list of products IDs","parameters":[{"name":"search","in":"query","required":false,"description":"Tableau des différents attributs de recherche","schema":{"type":"object","properties":{"name":{"type":"string","description":"Nom"},"reference":{"type":"string","description":"Référence"},"description":{"type":"string","description":"Description"},"extended_description":{"type":"string","description":"Description enrichie"},"conditionnement":{"type":"string","description":"Conditionnement"},"quantity":{"type":"number","description":"Quantité par défaut"},"unit_id":{"type":"integer","description":"Unité de mesure"},"category_id":{"type":"integer","description":"Catégorie"},"created_by_id":{"type":"integer","description":"Created by id"},"updated_by_id":{"type":"integer","description":"Updated by id"},"inactivated_at":{"type":"string","description":"Inactivated at"},"type":{"type":"string","description":"Type"},"image":{"type":"string","description":"Photo"},"image_online_url":{"type":"string","description":"Url du visuel"},"ean":{"type":"string","description":"EAN"},"mark_rate":{"type":"number","description":"Taux de marque"},"variable_weight":{"type":"boolean","description":"Produit à poids variable"},"invoiced_amount":{"type":"number","description":"Quantité facturée"},"shelf_id":{"type":"integer","description":"Rayon"},"has_pcb":{"type":"boolean","description":"Disponible en colis"},"pcb_quantity":{"type":"number","description":"Nombre d'articles par colis"},"enable_stock":{"type":"boolean","description":"Gestion du stock"},"stock_min":{"type":"number","description":"Stock minimum"},"stock_max":{"type":"number","description":"Stock souhaité"},"purchase_equivalence":{"type":"number","description":"Équivalence d'achat"},"purchase_unit_id":{"type":"integer","description":"Unité d'achat"},"brand_id":{"type":"integer","description":"Marque"},"is_equipment":{"type":"boolean","description":"Ce produit gère du matériel"},"is_for_sale":{"type":"boolean","description":"Ce produit est à la vente"},"show_on_client_area":{"type":"boolean","description":"Afficher dans l'espace client"},"has_rental":{"type":"boolean","description":"Disponible à la location"},"cost_price":{"type":"number","description":"Prix de revient H.T."},"unit_weight":{"type":"number","description":"Poids"},"warranty_id":{"type":"integer","description":"Garantie"},"interco_synchro_enabled":{"type":"boolean","description":"Ce produit est synchronisé"},"is_readonly":{"type":"boolean","description":"Is readonly"},"conditionning":{"type":"number","description":"Conditionnement"},"can_be_discounted":{"type":"boolean","description":"Peut être remisé"},"cost_category_id":{"type":"integer","description":"Catégorie de charge"},"cost_type_id":{"type":"integer","description":"Type de charge"},"sale_commissioned":{"type":"boolean","description":"Sale commissioned"},"volume":{"type":"number","description":"Volume"},"weight_per_cup":{"type":"number","description":"Weight per cup"},"month_cups_nb":{"type":"integer","description":"Month cups nb"},"advised_sell_price":{"type":"number","description":"Advised sell price"},"month_advised_location_nb":{"type":"integer","description":"Month advised location nb"},"name_en":{"type":"string","description":"Name en"},"name_de":{"type":"string","description":"Name de"},"scientific_name":{"type":"string","description":"Scientific name"},"unit_length":{"type":"number","description":"Unit length"},"unit_width":{"type":"number","description":"Unit width"},"unit_height":{"type":"number","description":"Unit height"},"composition_total_pieces":{"type":"integer","description":"Composition total pieces"},"import_json":{"type":"object","description":"Import json"},"search_index":{"type":"string","description":"Search index"},"main_item_price":{"type":"string","description":"Prix de vente H.T."},"pamp":{"type":"string","description":"Prix d'achat moyen pondéré"},"is_composition":{"type":"string","description":"Composition"},"the_good_thumb_url":{"type":"string","description":"Photo"},"has_items":{"type":"string","description":"Déclinaisons"},"main_condition_bp":{"type":"string","description":"Prix d'achat H.T."},"family_id":{"type":"integer","description":"Famille"},"tva":{"type":"string","description":"TVA par défaut"}},"additionalProperties":false}},{"name":"sort","in":"query","required":false,"description":"Tableau des différents attributs","schema":{"type":"object","properties":{"name":{"type":"string","description":"name DESC NULLS LAST(Descendant) ou name (Ascendant)"},"reference":{"type":"string","description":"reference DESC NULLS LAST(Descendant) ou reference (Ascendant)"},"description":{"type":"string","description":"description DESC NULLS LAST(Descendant) ou description (Ascendant)"},"extended_description":{"type":"string","description":"extended_description DESC NULLS LAST(Descendant) ou extended_description (Ascendant)"},"conditionnement":{"type":"string","description":"conditionnement DESC NULLS LAST(Descendant) ou conditionnement (Ascendant)"},"main_item_price":{"type":"string","description":"main_item_price DESC NULLS LAST(Descendant) ou main_item_price (Ascendant)"},"pamp":{"type":"string","description":"pamp DESC NULLS LAST(Descendant) ou pamp (Ascendant)"},"quantity":{"type":"string","description":"quantity DESC NULLS LAST(Descendant) ou quantity (Ascendant)"},"unit_id":{"type":"string","description":"unit_id DESC NULLS LAST(Descendant) ou unit_id (Ascendant)"},"family_id":{"type":"string","description":"family_id DESC NULLS LAST(Descendant) ou family_id (Ascendant)"},"category_id":{"type":"string","description":"category_id DESC NULLS LAST(Descendant) ou category_id (Ascendant)"},"created_by_id":{"type":"string","description":"created_by_id DESC NULLS LAST(Descendant) ou created_by_id (Ascendant)"},"updated_by_id":{"type":"string","description":"updated_by_id DESC NULLS LAST(Descendant) ou updated_by_id (Ascendant)"},"inactivated_at":{"type":"string","description":"inactivated_at DESC NULLS LAST(Descendant) ou inactivated_at (Ascendant)"},"tva":{"type":"string","description":"tva DESC NULLS LAST(Descendant) ou tva (Ascendant)"},"type":{"type":"string","description":"type DESC NULLS LAST(Descendant) ou type (Ascendant)"},"image":{"type":"string","description":"image DESC NULLS LAST(Descendant) ou image (Ascendant)"},"image_online_url":{"type":"string","description":"image_online_url DESC NULLS LAST(Descendant) ou image_online_url (Ascendant)"},"ean":{"type":"string","description":"ean DESC NULLS LAST(Descendant) ou ean (Ascendant)"},"mark_rate":{"type":"string","description":"mark_rate DESC NULLS LAST(Descendant) ou mark_rate (Ascendant)"},"variable_weight":{"type":"string","description":"variable_weight DESC NULLS LAST(Descendant) ou variable_weight (Ascendant)"},"invoiced_amount":{"type":"string","description":"invoiced_amount DESC NULLS LAST(Descendant) ou invoiced_amount (Ascendant)"},"shelf_id":{"type":"string","description":"shelf_id DESC NULLS LAST(Descendant) ou shelf_id (Ascendant)"},"has_pcb":{"type":"string","description":"has_pcb DESC NULLS LAST(Descendant) ou has_pcb (Ascendant)"},"pcb_quantity":{"type":"string","description":"pcb_quantity DESC NULLS LAST(Descendant) ou pcb_quantity (Ascendant)"},"enable_stock":{"type":"string","description":"enable_stock DESC NULLS LAST(Descendant) ou enable_stock (Ascendant)"},"stock_min":{"type":"string","description":"stock_min DESC NULLS LAST(Descendant) ou stock_min (Ascendant)"},"stock_max":{"type":"string","description":"stock_max DESC NULLS LAST(Descendant) ou stock_max (Ascendant)"},"purchase_equivalence":{"type":"string","description":"purchase_equivalence DESC NULLS LAST(Descendant) ou purchase_equivalence (Ascendant)"},"purchase_unit_id":{"type":"string","description":"purchase_unit_id DESC NULLS LAST(Descendant) ou purchase_unit_id (Ascendant)"},"brand_id":{"type":"string","description":"brand_id DESC NULLS LAST(Descendant) ou brand_id (Ascendant)"},"is_equipment":{"type":"string","description":"is_equipment DESC NULLS LAST(Descendant) ou is_equipment (Ascendant)"},"is_for_sale":{"type":"string","description":"is_for_sale DESC NULLS LAST(Descendant) ou is_for_sale (Ascendant)"},"show_on_client_area":{"type":"string","description":"show_on_client_area DESC NULLS LAST(Descendant) ou show_on_client_area (Ascendant)"},"has_rental":{"type":"string","description":"has_rental DESC NULLS LAST(Descendant) ou has_rental (Ascendant)"},"cost_price":{"type":"string","description":"cost_price DESC NULLS LAST(Descendant) ou cost_price (Ascendant)"},"unit_weight":{"type":"string","description":"unit_weight DESC NULLS LAST(Descendant) ou unit_weight (Ascendant)"},"warranty_id":{"type":"string","description":"warranty_id DESC NULLS LAST(Descendant) ou warranty_id (Ascendant)"},"interco_synchro_enabled":{"type":"string","description":"interco_synchro_enabled DESC NULLS LAST(Descendant) ou interco_synchro_enabled (Ascendant)"},"is_readonly":{"type":"string","description":"is_readonly DESC NULLS LAST(Descendant) ou is_readonly (Ascendant)"},"conditionning":{"type":"string","description":"conditionning DESC NULLS LAST(Descendant) ou conditionning (Ascendant)"},"can_be_discounted":{"type":"string","description":"can_be_discounted DESC NULLS LAST(Descendant) ou can_be_discounted (Ascendant)"},"cost_category_id":{"type":"string","description":"cost_category_id DESC NULLS LAST(Descendant) ou cost_category_id (Ascendant)"},"cost_type_id":{"type":"string","description":"cost_type_id DESC NULLS LAST(Descendant) ou cost_type_id (Ascendant)"},"sale_commissioned":{"type":"string","description":"sale_commissioned DESC NULLS LAST(Descendant) ou sale_commissioned (Ascendant)"},"volume":{"type":"string","description":"volume DESC NULLS LAST(Descendant) ou volume (Ascendant)"},"weight_per_cup":{"type":"string","description":"weight_per_cup DESC NULLS LAST(Descendant) ou weight_per_cup (Ascendant)"},"month_cups_nb":{"type":"string","description":"month_cups_nb DESC NULLS LAST(Descendant) ou month_cups_nb (Ascendant)"},"advised_sell_price":{"type":"string","description":"advised_sell_price DESC NULLS LAST(Descendant) ou advised_sell_price (Ascendant)"},"month_advised_location_nb":{"type":"string","description":"month_advised_location_nb DESC NULLS LAST(Descendant) ou month_advised_location_nb (Ascendant)"},"name_en":{"type":"string","description":"name_en DESC NULLS LAST(Descendant) ou name_en (Ascendant)"},"name_de":{"type":"string","description":"name_de DESC NULLS LAST(Descendant) ou name_de (Ascendant)"},"scientific_name":{"type":"string","description":"scientific_name DESC NULLS LAST(Descendant) ou scientific_name (Ascendant)"},"unit_length":{"type":"string","description":"unit_length DESC NULLS LAST(Descendant) ou unit_length (Ascendant)"},"unit_width":{"type":"string","description":"unit_width DESC NULLS LAST(Descendant) ou unit_width (Ascendant)"},"unit_height":{"type":"string","description":"unit_height DESC NULLS LAST(Descendant) ou unit_height (Ascendant)"},"composition_total_pieces":{"type":"string","description":"composition_total_pieces DESC NULLS LAST(Descendant) ou composition_total_pieces (Ascendant)"},"import_json":{"type":"string","description":"import_json DESC NULLS LAST(Descendant) ou import_json (Ascendant)"},"is_composition":{"type":"string","description":"is_composition DESC NULLS LAST(Descendant) ou is_composition (Ascendant)"},"has_items":{"type":"string","description":"has_items DESC NULLS LAST(Descendant) ou has_items (Ascendant)"},"main_condition_bp":{"type":"string","description":"main_condition_bp DESC NULLS LAST(Descendant) ou main_condition_bp (Ascendant)"}},"additionalProperties":false}},{"name":"page","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Number of items per page (-1 for all items/options mode)","schema":{"type":"integer"}},{"name":"scope","in":"query","required":false,"description":"Filter scope to apply","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Filter by tag name","schema":{"type":"string"}},{"name":"with_deleted","in":"query","required":false,"description":"Include soft-deleted items (1 to include, 0 or omit to exclude)","schema":{"type":"integer"}},{"name":"only_deleted","in":"query","required":false,"description":"Show only soft-deleted items (1 for only deleted)","schema":{"type":"integer"}},{"name":"with_inactivated","in":"query","required":false,"description":"Include inactivated items (1 to include)","schema":{"type":"integer"}},{"name":"only_inactivated","in":"query","required":false,"description":"Show only inactivated items (1 for only inactivated)","schema":{"type":"integer"}},{"name":"force_sort","in":"query","required":false,"description":"Force sorting even when custom search is used","schema":{"type":"string"}},{"name":"group_ids","in":"query","required":false,"description":"Comma-separated group IDs to filter by","schema":{"type":"string"}},{"name":"json_format","in":"query","required":false,"description":"Custom serialization format","schema":{"type":"string"}}],"responses":{"200":{"description":"IDs retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ids_response"}}}}}}}}} ``` ## GET /products/tags > Get available tags ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"tags_response":{"type":"array","items":{"type":"string"}}}},"paths":{"/products/tags":{"get":{"summary":"Get available tags","tags":["Product - Products"],"responses":{"200":{"description":"Tags retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tags_response"}}}}}}}}} ``` ## POST /products/{id}/add\_tag/{tag} > Add tag to product ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/products/{id}/add_tag/{tag}":{"post":{"summary":"Add tag to product","tags":["Product - Products"],"responses":{"200":{"description":"Tag added","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}} ``` ## DELETE /products/{id}/remove\_tag/{tag} > Remove tag from product ```json {"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}},"paths":{"/products/{id}/remove_tag/{tag}":{"delete":{"summary":"Remove tag from product","tags":["Product - Products"],"responses":{"200":{"description":"Tag removed","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://geosquare-1.gitbook.io/geosquare-docs/product-products.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.