Welcome to the Gaia Documentation
\nThis documentation provides a comprehensive reference for integrating with the Gaia. Here you will find detailed descriptions of available endpoints, authentication requirements, request and response schemas, as well as ready-to-use Postman collections to accelerate your integration.
\nThe collections included in this workspace are maintained and kept up to date with the latest API versions. Each request is pre-configured with the necessary headers and example payloads, allowing your team to test and explore the APIs without additional setup.
\nIf you are new to these APIs, we recommend starting with the Authentication section before proceeding to the individual endpoint references.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15213152","collectionId":"4fadc984-0051-440f-ad27-5126cb33eff3","publishedId":"2s93RRusES","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-03-31T12:24:46.000Z"},"item":[{"name":"Get Updated Products GTINs","id":"949479da-8fb1-4777-a160-42279767454d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.equadis.com/EquadisRefonte/product/getUpdatedProductsGTINs","description":"L'API getUpdatedProductsGTINs retourne la liste des GTINs disponibles dans le catalogue GAIA.
\nParamètres de la requête :
\nStartFragment
\nEndFragment
\nL'API getFilteredUpdatedProductsGTINsWithFilter retourne la liste des GTIN disponibles dans le catalogue GAIA, en appliquant des filtres avancés.
\nChaque filtre peut être appliqué sur un champ GAIA (à travers l'identifiant du champ retrouvé dans la bibliothèque GAIA), un opérateur (tableau ci-dessous) et une valeur de comparaison.
\n","urlObject":{"protocol":"https","path":["EquadisRefonte","product","getUpdatedProductsGTINsWithFilter"],"host":["api","equadis","com"],"query":[],"variable":[]}},"response":[{"id":"2379666d-efe5-4c89-868f-3c74f57b95af","name":"Ex: Get Filtered Updated Products","originalRequest":{"method":"POST","header":[{"key":"JSESSIONID","value":"xxxxxx","description":"JSESSIONID retourné par l'API signin.","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"idEquaField\": \"3\",\r\n \"value\": \"Ref\",\r\n \"operator\": \"Lk\"\r\n },{\r\n \"idEquaField\": \"3\",\r\n \"value\": \"Code\",\r\n \"operator\": \"Lk\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://api.equadis.com/EquadisRefonte/product/getUpdatedProductsGTINsWithFilter"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\r\n \"11111111111111\",\r\n \"22222222222222\"\r\n]"}],"_postman_id":"e36d9fb8-2af2-45c2-8408-c9da827106ab"},{"name":"Get Products","id":"b62cbaa4-671f-49cb-b4a8-cf8b8d5f2b12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"paging\": {\r\n \"currentPage\": 1,\r\n \"numberOfRowsPerPage\": 5\r\n },\r\n \"filters\": [\r\n {\r\n \"field\": \"gtins\",\r\n \"values\": [\r\n \"00000000000000\",\r\n \"33322222222222\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.equadis.com/EquadisRefonte/product/getProducts","description":"Cette API retourne les données des produits par leurs GTINs.
\nParamètres de la requête :
\nPar example, pour retourner les données de 200 GTINs, cette API doit être appelée 2 fois, la première fois avec currentPage=1 et numberOfRowsPerPage=100, et la deuxième avec currentPage=2.
\nLe nombre total des produits existant est retourné dans la réponse de l'API dans l'attribut totalRows.
\n","urlObject":{"protocol":"https","path":["EquadisRefonte","product","getProducts"],"host":["api","equadis","com"],"query":[],"variable":[]}},"response":[{"id":"877bb24b-43cc-420c-ab01-aaa53775b008","name":"Ex: Get Products info (OK)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"JSESSIONID","value":"xxxxxx","description":"JSESSIONID retourné par l'API signin.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"paging\": {\r\n \"currentPage\": \"1\",\r\n \"numberOfRowsPerPage\": 5\r\n },\r\n \"filters\": [\r\n {\r\n \"field\": \"gtins\",\r\n \"values\": [\r\n \"00000000000000\",\r\n \"11111111111111\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.equadis.com/EquadisRefonte/product/getProducts"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"paginglist\": [{\r\n \"1\": \"uvc\",\r\n \"2\": \"11111111111111\",\r\n \"3\": \"RefUVC1\",\r\n \"8\": [{\r\n \"8_1\": \"PAYS_FR\",\r\n \"8_2\": null,\r\n \"8_3\": []\r\n }\r\n ],\r\n \"Logs\": [{\r\n \"UL3P\": [{\r\n \"UL3_3\": [],\r\n \"UL3_2\": null,\r\n \"UL3_1\": \"PAYS_FR\"\r\n }\r\n ],\r\n \"UL2\": false,\r\n \"UL1\": {\r\n \"values\": [{\r\n\r\n \"language\": \"LANG_FRA\",\r\n \"value\": \"LOGISTIQUE1\"\r\n }\r\n ]\r\n },\r\n \"PK\": [{\r\n \"PK2\": \"REFCAR1\",\r\n \"PK1\": \"22222222223333\",\r\n \"PK3\": \"COND_CARTON\"\r\n }, {\r\n\r\n \"PK2\": \"REFCAR2\",\r\n \"PK1\": \"33333333333333\",\r\n \"PK3\": \"COND_PALETTE\"\r\n\r\n }\r\n ]\r\n }\r\n ]\r\n }, {\r\n \"1\": \"uvc\",\r\n \"2\": \"22222222222222\",\r\n \"3\": \"0BI0413\",\r\n \"8\": [{\r\n \"8_1\": \"PAYS_FR\",\r\n \"8_2\": null,\r\n \"8_3\": []\r\n }\r\n ],\r\n \"Logs\": [{\r\n \"UL3P\": [{\r\n \"UL3_3\": [],\r\n \"UL3_2\": null,\r\n \"UL3_1\": \"PAYS_FR\"\r\n }\r\n ],\r\n \"UL2\": false,\r\n \"UL1\": {\r\n \"values\": [{\r\n \"language\": \"LANG_FRA\",\r\n \"value\": \"LOGISTIQUE\"\r\n }\r\n ]\r\n },\r\n \"PK\": [{\r\n \"PK2\": \"0BI0413\",\r\n \"PK1\": \"08000050000008\",\r\n \"PK3\": \"COND_CARTON\"\r\n }, {\r\n \"PK2\": \"0BI0413\",\r\n \"PK1\": \"80000000000308\",\r\n \"PK3\": \"COND_PALETTE\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"totalRows\": 2\r\n}\r\n"},{"id":"40adace5-43cf-4612-b1ca-66b626516d2c","name":"Ex: Get Products info (KO)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"JSESSIONID","value":"xxxxxx","description":"JSESSIONID retourné par l'API signin.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"paging\": {\r\n \"currentPage\": \"1\",\r\n \"numberOfRowsPerPage\": 5\r\n },\r\n \"filters\": [\r\n {\r\n \"field\": \"gtins\",\r\n \"values\": [\r\n \"00000000000000\",\r\n \"11111111111111\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.equadis.com/EquadisRefonte/product/getProducts"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"errorCode\": 511,\r\n \"errorMessage\": \"Votre session a expiré, merci de vous reconnecter.\"\r\n}"}],"_postman_id":"b62cbaa4-671f-49cb-b4a8-cf8b8d5f2b12"},{"name":"Sign In","id":"4223d657-492e-4dad-b930-ef09c411fbec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"Identifiant\",\r\n \"password\": \"MotDePasse\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.equadis.com/EquadisRefonte/log/signin","description":"La première étape, nécessaire pour appeler les autres APIs, est l'authentification. Pour s'authentifier, l'API Sign In doit être appelée avec l'identifiant/mot de passe fournis par EQUADIS.
\nParamètres de la requête :
\nUn token JSESSIONID est retourné dans l'entête (Header) de la réponse. L'appel des autres endpoints doit contenir ce token dans l'entête.
\n","urlObject":{"protocol":"https","path":["EquadisRefonte","log","signin"],"host":["api","equadis","com"],"query":[],"variable":[]}},"response":[{"id":"e15782db-0a48-48dc-9025-df36a7c21aae","name":"Ex: Sign In (OK)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"ID111\",\r\n \"password\": \"MDP111\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.equadis.com/EquadisRefonte/log/signin"},"code":200,"_postman_previewlanguage":"html","header":[{"key":"JSESSIONID","value":"xxxxxx","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"errorCode\": 200\r\n}"},{"id":"b057fae0-f133-4b4e-8c15-3e276c03465e","name":"Ex: Sign In (KO)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"ID222\",\r\n \"password\": \"MDP222\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.equadis.com/EquadisRefonte/log/signin"},"status":"Forbidden","code":403,"_postman_previewlanguage":"html","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"errorCode\": 406,\r\n \"errorMessage\": \"Votre identifiant ou mot de passe est incorrect.\"\r\n}"}],"_postman_id":"4223d657-492e-4dad-b930-ef09c411fbec"}]}