{ "openapi": "3.0.0", "info": { "title": "Imbretex - API", "description": "Implementation of Swagger with in Laravel", "contact": { "email": "admin@admin.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0" }, "servers": [ { "url": "https://api.imbretex.fr", "description": "Demo API Server" } ], "paths": { "/api/products/products": { "get": { "tags": [ "Partners" ], "summary": "get new available products or modified products", "description": "Récupération des informations sur les articles", "operationId": "getPartnerProducts", "parameters": [ { "name": "sinceCreated", "in": "query", "description": "the created date since we need to get the products.(format : d-m-Y)", "style": "form", "explode": false, "schema": { "type": "string", "format": "date", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "example": "01-01-2024" } }, { "name": "sinceUpdated", "in": "query", "description": "the updated date since we need to get the products.(format : d-m-Y)", "style": "form", "explode": false, "schema": { "type": "string", "format": "date", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "example": "01-01-2024" } }, { "name": "perPage", "in": "query", "description": "number of item per page. max = 50", "required": false, "schema": { "type": "intger", "format": "int32", "default": 10, "maximum": 50, "minimum": 1 } }, { "name": "page", "in": "query", "description": "the page requested.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Retourne les informations produits", "content": { "application/json": { "schema": { "properties": { "": { "$ref": "#/components/schemas/ProductInformation" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "400": { "description": "Bad Request" }, "404": { "description": "not found" }, "403": { "description": "Forbidden" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "bearer_token": [] } ] } }, "/api/products/deleted": { "get": { "tags": [ "Partners" ], "summary": "Liste des produits supprimés", "description": "Récupération des articles supprimés", "operationId": "deletedProducts", "parameters": [ { "name": "since", "in": "query", "description": "the deleted date from which we wish to collect the products. (format : d-m-Y)", "required": true, "style": "form", "explode": false, "schema": { "type": "string", "format": "date", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "example": "01-01-2024" } }, { "name": "perPage", "in": "query", "description": "number of item per page. max = 50", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 50, "minimum": 1 } }, { "name": "page", "in": "query", "description": "the page requested.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Retourne les articles supprimés", "content": { "application/json": { "schema": { "properties": { "": { "$ref": "#/components/schemas/DeletedProductInformation" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "400": { "description": "Bad Request" }, "404": { "description": "not found" }, "403": { "description": "Forbidden" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "bearer_token": [] } ] } }, "/api/products/stocks": { "get": { "tags": [ "Partners" ], "summary": "Get products stocks", "description": "Get products stocks", "operationId": "getStockProducts", "parameters": [ { "name": "since", "in": "query", "description": "the updated date since we need to get the products stocks. (format : d-m-Y)", "style": "form", "explode": false, "schema": { "type": "string", "format": "date", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "example": "01-01-2024" } }, { "name": "perPage", "in": "query", "description": "number of item per page. max = 5000", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1000, "maximum": 5000, "minimum": 1 } }, { "name": "page", "in": "query", "description": "the page requested.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Get products stocks", "content": { "application/json": { "schema": { "properties": { "": { "$ref": "#/components/schemas/StockProductInformation" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "400": { "description": "Bad Request" }, "404": { "description": "not found" }, "403": { "description": "Forbidden" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "bearer_token": [] } ] } }, "/api/products/prices": { "get": { "tags": [ "Partners" ], "summary": "Get available prices", "description": "Get available prices", "operationId": "getPricesProducts", "parameters": [ { "name": "since", "in": "query", "description": "the updated date since we need to get the products prices.(format : d-m-Y)", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "date", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "example": "01-01-2024" } }, { "name": "perPage", "in": "query", "description": "number of item per page. max = 5000", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1000, "maximum": 5000, "minimum": 1 } }, { "name": "page", "in": "query", "description": "the page requested.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Get product stock", "content": { "application/json": { "schema": { "properties": { "": { "$ref": "#/components/schemas/PricesProductInformation" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "400": { "description": "Bad Request" }, "404": { "description": "not found" }, "403": { "description": "Forbidden" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "bearer_token": [] } ] } }, "/api/orders/create-order": { "post": { "tags": [ "CreateOrder" ], "summary": "Création d'une commande", "operationId": "createOrder", "requestBody": { "description": "Commande", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderRequest" } } } }, "responses": { "200": { "description": "Retourne la référence commande avec les informations", "content": { "application/json": { "schema": {}, "example": { "success": true, "status_code": 200, "message": "Commande envoyée avec succès", "reference": "IMB000000001", "order_infos": [], "errors_products": "" } } } }, "401": { "description": "Unauthenticated" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {}, "example": { "errors": "not found" } } } }, "422": { "description": "Unprocessable Entity" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" } }, "security": [ { "bearer_token": [] } ] } }, "/api/products/price-stock": { "get": { "tags": [ "Products" ], "summary": "Liste des produits", "description": "Récupération des prix et stocks d'un ou plusieurs articles", "operationId": "getProducts", "parameters": [ { "name": "products", "in": "query", "description": "codes articles (limite 150)", "required": true, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Retourne la liste des prix et stocks pour les références données.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceStock" } } } }, "401": { "description": "Unauthenticated" }, "400": { "description": "Bad Request" }, "404": { "description": "not found" }, "403": { "description": "Forbidden" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "bearer_token": [] } ] } }, "/api/products/price-stock/{productReference}": { "get": { "tags": [ "Products" ], "summary": "Liste des produits en fonction de la référence d'un produit", "description": "Récupération des prix et stocks de l'ensemble des articles d'une référence", "operationId": "getProductsByReference", "parameters": [ { "name": "productReference", "in": "path", "description": "Reference d'un produit", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Retourne la liste des prix et stocks pour la référence donnée", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceStockWithCode" } } } }, "401": { "description": "Unauthenticated" }, "400": { "description": "Bad Request" }, "404": { "description": "not found" }, "403": { "description": "Forbidden" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "bearer_token": [] } ] } } }, "components": { "schemas": { "AddressRequest": { "required": [ "name", "address", "zip", "city", "country_code" ], "properties": { "name": { "description": "Raison sociale", "type": "integer", "example": "RS001" }, "lastname": { "description": "Nom", "type": "integer", "example": "RS001" }, "firstname": { "description": "Nom", "type": "integer", "example": "RS001" }, "company": { "description": "Raison sociale", "type": "integer", "example": "RS001" }, "address": { "description": "Adresse", "type": "string", "example": "107 Avenue des Tuileries" }, "zip": { "description": "Code postal", "type": "string", "example": "23000" }, "city": { "description": "Ville", "type": "string", "example": "GUÉRET" }, "phone": { "description": "Téléphone", "type": "string", "example": "0102030405" }, "email": { "description": "email", "type": "string", "example": "email@email.com" } }, "type": "object", "example": { "company": "Raison sociale", "name": "Nom adresse", "lastname": "Nom", "firstname": "Prénom", "address": "107 Avenue des Tuileries", "additional_address_1": "Complément d'adresse", "zip": "23000", "city": "GUÉRET", "country_code": "FR", "phone": "0102030405", "email": "email@email.com" } }, "OrderLineRequest": { "required": [ "reference", "quantity" ], "properties": { "reference": { "description": "Référence article", "type": "string", "example": "SC28015L" }, "quantity": { "description": "Quantité", "type": "integer", "example": 2 } }, "type": "object" }, "OrderRequest": { "required": [ "delivery_method", "shipping_address", "order_lines" ], "properties": { "reference_internal": { "description": "Référence de commande interne du client", "type": "string", "maxLength": 20, "example": "IMB210410003" }, "order_id_2": { "description": "Numéro d'ordre interne du client", "type": "string", "example": "OrderId2" }, "partner_code": { "description": "Code partenaire", "type": "string", "example": "C001" }, "delivery_form": { "description": "Type de bon de livraison : 0 : IMBRETEX, 1 : PERSONNALISE, 2 : NEUTRE, 5 : Sans Bon de livraison ", "type": "integer", "default": "0", "enum": [ 0, 1, 2, 5, 6 ], "example": "0" }, "delivery_method": { "description": "Mode de livraison => 2 : Standard, 3: livraison express (non utilisé), 4 : Sur site, 6 : mode navette", "type": "integer", "enum": [ 2, 3, 4, 6 ], "example": "2" }, "comment": { "description": "Commentaire", "type": "string", "example": "Mon commentaire" }, "file_url": { "description": "Document à imprimer", "type": "string", "example": "" }, "order_lines": { "description": "Liste des produits", "type": "array", "items": { "$ref": "#/components/schemas/OrderLineRequest" } }, "shipping_address": { "$ref": "#/components/schemas/AddressRequest" } }, "type": "object" }, "PartnerProductPostRequest": {}, "ProductPostRequest": { "required": [ "products" ], "properties": { "products": { "description": "Liste des références produit", "type": "array", "items": { "type": "string" }, "example": [ "SC28015L", "SC28015XL" ] } }, "type": "object" }, "DeletedProductInformation": { "properties": { "success": { "type": "string", "example": "true" }, "products": { "description": "Informations articles supprimés", "type": "array", "items": { "type": "string" }, "example": [ { "success": true, "productCount": 723, "variantCount": 6616, "perPage": 10, "page": "1", "totalNumberPage": 662, "products": [ { "supplierReference": "21BE0901GY", "brands": "HEROCK", "variants": [ { "variantReference": "HK630350", "createdAt": "2019-11-28 12:03:55", "updatedAt": "2024-06-10 11:03:55", "deletedAt": "2024-06-10 11:03:55" } ] }, { "supplierReference": "TRJ366R 800032", "brands": "REGATTA", "variants": [ { "variantReference": "RG366RQR42", "createdAt": "2019-11-28 02:48:28", "updatedAt": "2024-02-08 02:48:28", "deletedAt": "2024-02-08 02:48:28" }, { "variantReference": "RG366R1542", "createdAt": "2019-11-28 02:48:27", "updatedAt": "2024-02-08 02:48:27", "deletedAt": "2024-02-08 02:48:27" } ] }, { "supplierReference": "TRJ368R 61I032", "brands": "REGATTA", "variants": [ { "variantReference": "RG368R5142", "createdAt": "2019-11-28 02:48:28", "updatedAt": "2024-02-08 02:48:28", "deletedAt": "2024-02-08 02:48:28" } ] }, { "supplierReference": "TRW348 26295", "brands": "REGATTA", "variants": [ { "variantReference": "RGW348PZS", "createdAt": "2019-11-28 02:46:02", "updatedAt": "2024-02-08 02:46:02", "deletedAt": "2024-02-08 02:46:02" }, { "variantReference": "RGW348PZM", "createdAt": "2019-11-28 02:46:02", "updatedAt": "2024-02-08 02:46:02", "deletedAt": "2024-02-08 02:46:02" }, { "variantReference": "RGW348PZL", "createdAt": "2019-11-28 02:46:01", "updatedAt": "2024-02-08 02:46:01", "deletedAt": "2024-02-08 02:46:01" }, { "variantReference": "RGW348PZXL", "createdAt": "2019-11-28 02:46:01", "updatedAt": "2024-02-08 02:46:01", "deletedAt": "2024-02-08 02:46:01" }, { "variantReference": "RGW348PZXXL", "createdAt": "2019-11-28 02:46:01", "updatedAt": "2024-02-08 02:46:01", "deletedAt": "2024-02-08 02:46:01" }, { "variantReference": "RGW348PZ3XL", "createdAt": "2019-11-28 02:46:01", "updatedAt": "2024-02-08 02:46:01", "deletedAt": "2024-02-08 02:46:01" } ] } ] } ] } }, "type": "object" }, "PricesProductInformation": { "properties": { "success": { "type": "string", "example": "true" }, "result": { "description": "Products prices", "type": "array", "items": { "type": "string" }, "example": [ { "success": true, "pricesCount": 77913, "perPage": 2, "page": "1", "totalNumberPage": 38957, "prices": [ { "variantPrices": { "minimumOfQuantity": 1, "variantReference": "RS322150", "updatedAt": "2024-09-24 13:40:27", "prices": [ { "quantity": 1, "price": null, "defaultPrice": 5, "publicPrice": 10 } ] } }, { "variantPrices": { "minimumOfQuantity": 1, "variantReference": "HK650150", "updatedAt": "2024-09-24 13:40:27", "prices": [ { "quantity": 1, "price": null, "defaultPrice": 2.4, "publicPrice": 4.8 } ] } } ] } ] } }, "type": "object" }, "ProductInformation": { "properties": { "success": { "type": "string", "example": "true" }, "products": { "description": "Informations Produits", "type": "array", "items": { "type": "string" }, "example": { "productCount": 14, "variantCount": 14, "perPage": 1, "page": "1", "totalNumberPage": 14, "products": [ { "reference": "CATART24", "createdAt": "2024-02-13 02:05:59", "updatedAt": "2024-02-19 02:05:59", "deletedAt": null, "brands": { "name": "REFERENCE TEXTILE", "logo": { "url": "https://admin.imbretex.local/media/2225552/1/0/1/logo-rt-p-marques.jpg" } }, "variants": [ { "variantReference": "CATART24FRSP0", "underConstruction": 0, "keywords": [ { "fr": [ "" ], "en": [ "" ], "de": [ "" ] } ], "characteristics": { "genders": [] }, "certifications": { "certifications": [] }, "careInstructions": [], "tags": [ "Nouveau produit" ], "title": { "fr": "REFERENCE TEXTILE 2024", "en": "REFERENCE TEXTILE 2024", "de": "REFERENCE TEXTILE 2024", "es": "" }, "longTitle": { "fr": "Catalogue sans prix", "en": "", "de": "", "es": "" }, "description": { "fr": "", "en": "", "de": "", "es": "" }, "longDescription": { "fr": null, "en": null, "de": null, "es": null }, "createdAt": "2024-02-13 02:00:42", "updatedAt": "2024-02-14 02:00:42", "deletedAt": null, "attributes": [ { "type": "sizes", "value": "0" }, { "type": "color", "value": "FRANCE SANS PRIX", "colorCode": "", "hex": "", "rgb": "", "cmyk": "0 0 0 100" }, { "type": "material", "value": null } ], "netWeight": { "unit": "kg", "value": 2.65 }, "countryOfOrigin": [], "grammage": { "unit": "g/m²", "value": null }, "averageWeight": { "unit": "kg", "value": 0 }, "packaging": { "lengthCarton": { "unit": "cm", "value": 31 }, "widthCarton": { "unit": "cm", "value": 23 }, "heightCarton": { "unit": "cm", "value": 15 }, "weightCarton": { "unit": "kg", "value": 10.6 }, "volumeCarton": { "unit": "dm3", "value": 11.196 }, "numberProductByCarton": 4, "numberProductByPack": 1 }, "customsCode": "49111010", "eanUpcCode": "", "categories": [ { "categories": { "fr": "", "en": "", "de": "", "es": "" }, "families": { "fr": "CATALOGUE", "en": "", "de": "", "es": "" } } ], "images": [] } ], "images": { "name": "CATARTPX24_studio.jpg", "url": "https://www.imbretex.fr/media-produit/187913/10/2/147187/11782076/CATARTPX24_studio.jpg", "type": 10 }, "links": [ { "name": "JC092.pdf", "url": "https://www.imbretex.fr/media-produit/180698/30//154223/11781937/JC092.pdf", "type": 30 }, { "name": "JC092_SP.pdf", "url": "https://www.imbretex.fr/media-produit/180698/30//152997/11781938/JC092_SP.pdf", "type": 30 } ] } ] } } }, "type": "object" }, "StockProductInformation": { "properties": { "success": { "type": "string", "example": "true" }, "stocks": { "description": "Products stocks", "type": "array", "items": { "type": "string" }, "example": [ { "success": true, "stocksCount": 62929, "perPage": 2, "page": "1", "totalNumberPage": 31465, "stocks": [ { "variantReference": "1500KC130", "incommings": { "date": [], "stock": null }, "stock": "164", "supplierStock": "429", "updatedAt": null }, { "variantReference": "1500KC150", "incommings": { "date": [], "stock": null }, "stock": "140", "supplierStock": "20", "updatedAt": null } ] } ] } }, "type": "object" }, "StockProductInformationByReference": { "properties": { "success": { "type": "string", "example": "true" }, "stocks": { "description": "Products stocks", "type": "array", "items": { "type": "string" }, "example": [ { "success": true, "stocksCount": 62929, "perPage": 2, "page": "1", "totalNumberPage": 31465, "stocks": [ { "variantReference": "1500KC130", "incommings": { "date": [], "stock": null }, "stock": "164", "supplierStock": "429", "updatedAt": null } ] } ] } }, "type": "object" }, "PriceStock": { "properties": { "success": { "type": "boolean", "example": "true" }, "products": { "description": "Liste des prix et stock", "type": "object", "example": { "SC28015L": { "quantity_unit": "1", "quantity_box": "36", "price": "6", "price_box": "6", "stock": "0", "stock_supplier": "0" }, "SC28015XL": { "quantity_unit": "1", "quantity_box": "36", "price": "6", "price_box": "6", "stock": "0", "stock_supplier": "0" } } }, "products_not_found": { "description": "Message d'erreur si une référence n'a pas été trouvée.", "type": "string", "example": "Les références produit suivantes sont introuvables : BC01" }, "limit_exceeded": { "description": "Message d'erreur si la limite du nombre de produits a été atteinte.", "type": "string", "example": "La limite de 150 produits a été dépassée." } }, "type": "object" }, "PriceStockWithCode": { "properties": { "success": { "type": "boolean", "example": true }, "products": { "description": "Liste des prix et stock", "type": "object", "example": [ { "code": "SC28015L", "quantity_unit": "1", "quantity_box": "36", "price": "6", "price_box": "6", "stock": "0", "stock_supplier": "0" }, { "code": "SC28015XL", "quantity_unit": "1", "quantity_box": "36", "price": "6", "price_box": "6", "stock": "0", "stock_supplier": "0" } ] }, "products_not_found": { "description": "Message d'erreur si une référence n'a pas été trouvée.", "type": "string", "example": "Les références produit suivantes sont introuvables : BC01" } }, "type": "object" } }, "securitySchemes": { "bearer_token": { "type": "apiKey", "description": "API Key provided by Hegyd. If you don’t have one, please send an email to support.technique@hegyd.fr.
Copy this into the value field: Bearer {token}", "name": "Authorization", "in": "header" } } }, "tags": [ { "name": "Partners", "description": "Partners" }, { "name": "CreateOrder", "description": "CreateOrder" }, { "name": "Products", "description": "Products" } ], "security": [ { "bearer_token": [] } ] }