This is an optional parameter with default value of 5
\n","type":"text/plain"},"key":"maxCategories","value":"This is an optional parameter with default value of 50
\n","type":"text/plain"},"key":"productsPerCategory","value":"Ecommerce Platform
\n","type":"text/plain"},"key":"eCommercePlatform","value":"< magento | shopify >"}],"variable":[]}},"response":[],"_postman_id":"6f2d364d-cf3d-451e-8e59-e08105e99e18"},{"name":"XRS v1.3.0 Example","id":"bd9b5d6f-4643-47a0-963a-02a7bcf9878a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://xrs.compat.io/?merchantKey=j2m5lq9uNbV4ETc0skb0&variantID=40297326018605&maxCategories=10&productsPerCategory=100&eCommercePlatform=shopify","urlObject":{"protocol":"https","path":[""],"host":["xrs","compat","io"],"query":[{"key":"merchantKey","value":"j2m5lq9uNbV4ETc0skb0"},{"key":"variantID","value":"40297326018605"},{"key":"maxCategories","value":"10"},{"key":"productsPerCategory","value":"100"},{"key":"eCommercePlatform","value":"shopify"}],"variable":[]}},"response":[{"id":"290f55b7-335a-4e03-819d-09afb02a33a1","name":"XRS v1.3.0","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://xrs.compat.io/?merchantKey=7YWVopW2g7lsfiBtDduy&variantID=10000&maxCategories=10&productsPerCategory=100&eCommercePlatform=shopify","protocol":"https","host":["xrs","compat","io"],"path":[""],"query":[{"key":"merchantKey","value":"7YWVopW2g7lsfiBtDduy"},{"key":"variantID","value":"10000"},{"key":"maxCategories","value":"10"},{"key":"productsPerCategory","value":"100"},{"key":"eCommercePlatform","value":"shopify"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"inputs\": {\n \"variantID\": \"10000\",\n \"applicationID\": \"example\",\n \"merchantKey\": \"7YWVopW2g7lsfiBtDduy\"\n },\n \"compatibleCategories\": [\n {\n \"relevanceRank\": 1,\n \"categoryImageUrl\": \"https://media.mwstatic.com/product-images/src/Primary/415/415396.jpg?imwidth=2200\",\n \"categoryName\": \"Shoes\",\n \"categoryID\": \"fe623a3ec15811ec840b5ef286a0d60c\",\n \"products\": [\n {\n \"merchantProductID\": \"20074\",\n \"merchantParentProductID\": \"2030\",\n \"compatioScore\": 0.9998091984693072\n },\n {\n \"merchantProductID\": \"20065\",\n \"merchantParentProductID\": \"2026\",\n \"compatioScore\": 0.9998091984693072\n },\n {\n \"merchantProductID\": \"20013\",\n \"merchantParentProductID\": \"2004\",\n \"compatioScore\": 0.9998091984693072\n },\n {\n \"merchantProductID\": \"20000\",\n \"merchantParentProductID\": \"2001\",\n \"compatioScore\": 0.9993388939619681\n },\n {\n \"merchantProductID\": \"20004\",\n \"merchantParentProductID\": \"2001\",\n \"compatioScore\": 0.998868589454629\n },\n {\n \"merchantProductID\": \"20001\",\n \"merchantParentProductID\": \"2001\",\n \"compatioScore\": 0.998868589454629\n },\n {\n \"merchantProductID\": \"20014\",\n \"merchantParentProductID\": \"2004\",\n \"compatioScore\": 0.998868589454629\n },\n {\n \"merchantProductID\": \"20066\",\n \"merchantParentProductID\": \"2026\",\n \"compatioScore\": 0.998868589454629\n },\n {\n \"merchantProductID\": \"20027\",\n \"merchantParentProductID\": \"2011\",\n \"compatioScore\": 0.9983982849472899\n },\n {\n \"merchantProductID\": \"20071\",\n \"merchantParentProductID\": \"2029\",\n \"compatioScore\": 0.9976928281862812\n },\n {\n \"merchantProductID\": \"20054\",\n \"merchantParentProductID\": \"2023\",\n \"compatioScore\": 0.9976928281862812\n },\n {\n \"merchantProductID\": \"20034\",\n \"merchantParentProductID\": \"2013\",\n \"compatioScore\": 0.9974576759326117\n },\n {\n \"merchantProductID\": \"20009\",\n \"merchantParentProductID\": \"2002\",\n \"compatioScore\": 0.9974576759326117\n },\n {\n \"merchantProductID\": \"20070\",\n \"merchantParentProductID\": \"2029\",\n \"compatioScore\": 0.9974576759326117\n },\n {\n \"merchantProductID\": \"20022\",\n \"merchantParentProductID\": \"2009\",\n \"compatioScore\": 0.9974576759326117\n },\n {\n \"merchantProductID\": \"20053\",\n \"merchantParentProductID\": \"2023\",\n \"compatioScore\": 0.9972225236789422\n },\n {\n \"merchantProductID\": \"20006\",\n \"merchantParentProductID\": \"2002\",\n \"compatioScore\": 0.9969873714252726\n },\n {\n \"merchantProductID\": \"20007\",\n \"merchantParentProductID\": \"2002\",\n \"compatioScore\": 0.9969873714252726\n },\n {\n \"merchantProductID\": \"20028\",\n \"merchantParentProductID\": \"2012\",\n \"compatioScore\": 0.9969873714252726\n },\n {\n \"merchantProductID\": \"20096\",\n \"merchantParentProductID\": \"2037\",\n \"compatioScore\": 0.9969850199027359\n },\n {\n \"merchantProductID\": \"20094\",\n \"merchantParentProductID\": \"2037\",\n \"compatioScore\": 0.9969850199027359\n },\n {\n \"merchantProductID\": \"20095\",\n \"merchantParentProductID\": \"2037\",\n \"compatioScore\": 0.9969850199027359\n },\n {\n \"merchantProductID\": \"20069\",\n \"merchantParentProductID\": \"2028\",\n \"compatioScore\": 0.9967522191716031\n },\n {\n \"merchantProductID\": \"20093\",\n \"merchantParentProductID\": \"2036\",\n \"compatioScore\": 0.9967498676490664\n },\n {\n \"merchantProductID\": \"20092\",\n \"merchantParentProductID\": \"2036\",\n \"compatioScore\": 0.9967498676490664\n },\n {\n \"merchantProductID\": \"20030\",\n \"merchantParentProductID\": \"2012\",\n \"compatioScore\": 0.9965170669179335\n },\n {\n \"merchantProductID\": \"20031\",\n \"merchantParentProductID\": \"2012\",\n \"compatioScore\": 0.9965170669179335\n },\n {\n \"merchantProductID\": \"20008\",\n \"merchantParentProductID\": \"2002\",\n \"compatioScore\": 0.9965170669179335\n },\n {\n \"merchantProductID\": \"20011\",\n \"merchantParentProductID\": \"2003\",\n \"compatioScore\": 0.9965170669179335\n },\n {\n \"merchantProductID\": \"20029\",\n \"merchantParentProductID\": \"2012\",\n \"compatioScore\": 0.9965170669179335\n },\n {\n \"merchantProductID\": \"20078\",\n \"merchantParentProductID\": \"2031\",\n \"compatioScore\": 0.9960467624105944\n },\n {\n \"merchantProductID\": \"20052\",\n \"merchantParentProductID\": \"2022\",\n \"compatioScore\": 0.9960467624105944\n },\n {\n \"merchantProductID\": \"20080\",\n \"merchantParentProductID\": \"2032\",\n \"compatioScore\": 0.9958116101569249\n },\n {\n \"merchantProductID\": \"20063\",\n \"merchantParentProductID\": \"2024\",\n \"compatioScore\": 0.9958116101569249\n },\n {\n \"merchantProductID\": \"20058\",\n \"merchantParentProductID\": \"2023\",\n \"compatioScore\": 0.9951061533959163\n },\n {\n \"merchantProductID\": \"20026\",\n \"merchantParentProductID\": \"2010\",\n \"compatioScore\": 0.9951061533959163\n },\n {\n \"merchantProductID\": \"20060\",\n \"merchantParentProductID\": \"2024\",\n \"compatioScore\": 0.9951061533959163\n },\n {\n \"merchantProductID\": \"20090\",\n \"merchantParentProductID\": \"2035\",\n \"compatioScore\": 0.9951038018733797\n },\n {\n \"merchantProductID\": \"20086\",\n \"merchantParentProductID\": \"2034\",\n \"compatioScore\": 0.9951038018733797\n },\n {\n \"merchantProductID\": \"20085\",\n \"merchantParentProductID\": \"2034\",\n \"compatioScore\": 0.9951038018733797\n },\n {\n \"merchantProductID\": \"20023\",\n \"merchantParentProductID\": \"2010\",\n \"compatioScore\": 0.9946358488885773\n },\n {\n \"merchantProductID\": \"20024\",\n \"merchantParentProductID\": \"2010\",\n \"compatioScore\": 0.9946358488885773\n },\n {\n \"merchantProductID\": \"20068\",\n \"merchantParentProductID\": \"2028\",\n \"compatioScore\": 0.9946358488885773\n },\n {\n \"merchantProductID\": \"20020\",\n \"merchantParentProductID\": \"2008\",\n \"compatioScore\": 0.9936952398738991\n },\n {\n \"merchantProductID\": \"20018\",\n \"merchantParentProductID\": \"2008\",\n \"compatioScore\": 0.99322493536656\n },\n {\n \"merchantProductID\": \"20044\",\n \"merchantParentProductID\": \"2017\",\n \"compatioScore\": 0.9927522793366842\n },\n {\n \"merchantProductID\": \"20045\",\n \"merchantParentProductID\": \"2018\",\n \"compatioScore\": 0.9906359090536584\n },\n {\n \"merchantProductID\": \"20109\",\n \"merchantParentProductID\": \"2046\",\n \"compatioScore\": 0.9889898432779716\n },\n {\n \"merchantProductID\": \"20107\",\n \"merchantParentProductID\": \"2046\",\n \"compatioScore\": 0.9889898432779716\n },\n {\n \"merchantProductID\": \"20037\",\n \"merchantParentProductID\": \"2015\",\n \"compatioScore\": 0.988754691024302\n },\n {\n \"merchantProductID\": \"20036\",\n \"merchantParentProductID\": \"2015\",\n \"compatioScore\": 0.988754691024302\n },\n {\n \"merchantProductID\": \"20049\",\n \"merchantParentProductID\": \"2021\",\n \"compatioScore\": 0.9880492342632934\n },\n {\n \"merchantProductID\": \"20100\",\n \"merchantParentProductID\": \"2040\",\n \"compatioScore\": 0.9875789297559543\n },\n {\n \"merchantProductID\": \"20038\",\n \"merchantParentProductID\": \"2015\",\n \"compatioScore\": 0.9866383207412761\n },\n {\n \"merchantProductID\": \"20099\",\n \"merchantParentProductID\": \"2039\",\n \"compatioScore\": 0.985697711726598\n },\n {\n \"merchantProductID\": \"20047\",\n \"merchantParentProductID\": \"2019\",\n \"compatioScore\": 0.9854625594729285\n },\n {\n \"merchantProductID\": \"20104\",\n \"merchantParentProductID\": \"2044\",\n \"compatioScore\": 0.9842867982045808\n },\n {\n \"merchantProductID\": \"20103\",\n \"merchantParentProductID\": \"2043\",\n \"compatioScore\": 0.9833461891899026\n },\n {\n \"merchantProductID\": \"20106\",\n \"merchantParentProductID\": \"2045\",\n \"compatioScore\": 0.9828758846825635\n },\n {\n \"merchantProductID\": \"20110\",\n \"merchantParentProductID\": \"2047\",\n \"compatioScore\": 0.9828758846825635\n },\n {\n \"merchantProductID\": \"20040\",\n \"merchantParentProductID\": \"2016\",\n \"compatioScore\": 0.9824055801752244\n },\n {\n \"merchantProductID\": \"20039\",\n \"merchantParentProductID\": \"2016\",\n \"compatioScore\": 0.9824055801752244\n },\n {\n \"merchantProductID\": \"20102\",\n \"merchantParentProductID\": \"2042\",\n \"compatioScore\": 0.9758213170724773\n }\n ]\n }\n ]\n}"}],"_postman_id":"bd9b5d6f-4643-47a0-963a-02a7bcf9878a"}],"id":"6270a032-965e-486f-9f0d-742f58e56d47","description":"XRS - Expert Recommendation System
\nThe XRS API provides a set of categorized, scored, and recommended products for any type of recommendation or bundling application. Returns a list of categories of products compatible with the product passed as input.
\nParameters
\nOutput
\n","_postman_id":"6270a032-965e-486f-9f0d-742f58e56d47"},{"name":"Commend: ARS v1.8","item":[{"name":"ARS v1.8","id":"f7786ebf-bfe3-40df-82d2-8e5d0e496d6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://ars.compatio.ai/v2/:merchantKey/:variantID/:modelID?eCommercePlatform=< magento | shopify | custom | bigcommerce >","urlObject":{"protocol":"https","path":["v2",":merchantKey",":variantID",":modelID"],"host":["ars","compatio","ai"],"query":[{"description":{"content":"Ecommerce Platform
\n","type":"text/plain"},"key":"eCommercePlatform","value":"< magento | shopify | custom | bigcommerce >"}],"variable":[{"id":"b219839b-359d-463e-9120-934184ffbbb4","type":"any","value":null,"key":"merchantKey"},{"id":"09599461-b137-40ea-b162-d75c968eb883","type":"any","value":null,"key":"variantID"},{"id":"29362a4d-5268-4302-968f-a6c448a32471","type":"any","value":"","key":"modelID"}]}},"response":[{"id":"24b5ea62-bc9b-48b7-bfea-6b07f7e3ce90","name":"ARS v1.8 Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://ars.compatio.ai/v2/:merchantKey/:variantID/:modelID?eCommercePlatform=< magento | shopify | custom>","protocol":"https","host":["ars","compatio","ai"],"path":["v2",":merchantKey",":variantID",":modelID"],"query":[{"key":"eCommercePlatform","value":"< magento | shopify | custom>","description":"Ecommerce Platform"}],"variable":[{"key":"merchantKey","value":"gmsd8vaiteomy2uxfvup"},{"key":"variantID","value":"489375"},{"key":"modelID","value":"ec-p2-24"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"model\":{\n \"id\": \"ec-p2-24\",\n \"version\": \"20Dec24\",\n \"mode\": \"pre2.0\" \n },\n \"results\": [\n \"259425\",\n \"711794\",\n \"604267\",\n \"393091\",\n \"743375\",\n \"862951\",\n \"448069\",\n \"788783\",\n \"482607\",\n \"872027\",\n \"769721\",\n \"904002\",\n \"709577\",\n \"902835\",\n \"757727\",\n \"825417\",\n \"295445\",\n \"680650\",\n \"795051\",\n \"151153\",\n \"291127\",\n \"603348\",\n \"493433\"\n ],\n \"score\": false,\n \"title\": \"Shop Products from our Experts\"\n}"}],"_postman_id":"f7786ebf-bfe3-40df-82d2-8e5d0e496d6c"},{"name":"Model Assignment API","id":"500d2e3e-84c8-4773-804b-3206c9b4c08b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"1019e7d3-53fe-4492-89a0-fc679e43ee9d","name":"Model Assignment API","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://ms.compatio.ai/models/:merchantKey","protocol":"http","host":["ms","compatio","ai"],"path":["models",":merchantKey"],"variable":[{"key":"merchantKey","value":"gmsd8vaiteomy2uxfvup"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"models\": {\n \"applet_1\": \"Advanced Recommender System (ARS)
\nThe Compatio Recommender API provides a set of recommended products for any type of recommendation or bundling application. Returns a list of recommended products for a given application, widget position, and productID.
\nChangelog:
\nv1.8
\n- \n
ARS v1.8 API now requires a modelID path variable, which is returned from model assignment API, failing to provide this parameter will result in ARS falling back to previous mode, which is deprecated and will be removed in next major version release.
\n \nRemoved applicationID field
\n \nAdditional API released for A/B model assignment.
\n \nIMPORTANT: ARS v1.8 now returns product IDs as strings instead of integers, depending on how this is handled in custom frontend implementations, it can be a breaking change, please ensure this is handled properly in code.
\n \n
Changes to flow for model assignment and invoking ARS API
\nModel Assignment API
\nIn order to support A/B testing, a new Model Assignment API has been released. This enables the Host Platform to retrieve modelIDs for three distinct applets/widgets. This endpoint should be invoked once per session, with the returned modelIDs persisted in the user's session storage.
\nSession Management:
Upon successful modelID assignment and storage, all subsequent ARS API requests must include the corresponding modelID parameter. This parameter determines which model will be utilized for processing the request.
Response Structure:
The ARS API response now includes a model metadata field, which must be forwarded to the Analytics API for tracking and analysis purposes.
Parameters
\nOutput
\n","_postman_id":"b0e63daa-0bf6-4453-b82c-653f33cc53de"},{"name":"Analytics 1.4.1","item":[{"name":"CART_ITEM_ADDED Example","id":"17256cac-22b8-4e9c-9c03-18005f7311bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sessionID\": \"134335660\",\n \"eventType\": \"CART_ITEM_ADDED\",\n \"customerID\": 0,\n \"domainURL\": \"https://example.com\",\n \"merchantKey\": \"j2m5lq9uNbV4ETc0skb0\",\n \"platform\": \"Analytics Service
\nThe Analytics API is an asynchronous, high-capacity data capture service for clickstream and order event packets from digital commerce channels. It accepts an event data packet, and provides 200 (OK) response.
\nChangelog for v1.4.1
\n- \n
- field orderID is mandatory for events of type ORDER_CREATED \n
Changelog for v1.4
\n- \n
Added following new event types: ADD_TO_BUILD, FIELD_SELECTED, FIELD_UNSELECTED, REMOVE_FROM_BUILD, BUILD_QTY_UPDATED and PAGE_CLICKED
\n \nAdded optional field \"buildSessionID\" to events: CART_ITEM_ADDED, CART_ITEM_UPDATED, CART_ITEM_REMOVED, ORDER_CREATED, which is only applicable if event is emitted by configure(SB3) app.
\n \nrenamed merchantKey to csKey. \"merchantKey\" is still supported for current integrations but will be deprecated in future in favor of csKey.
\n \nUpdated description for recommendationSource and recommenderInstance fields. \"recommenderInstance\" field is now mandatory if value of recommendationSource is \"ARS\".
\n \n
Event Types
\nJSON Body fields
\nEventData details
\nThe eventData array holds information about the actual event. In case of some event like ORDER_CREATED certain fields like \"recommendationSource\" and \"recommendationInstance\" are part of the event data as each order item could have been created from a different recommendation source.
\nAlso, field values can be integers or Strings. e.g. price can be sent as 39.95 or \"39.95\"
\nEventType: CART_ITEM_UPDATED, CART_ITEM_ADDED,CART_ITEM_REMOVED
\nJSON Structure:
\n[{\n \"purchasedFinalProductID\": 40297391783981, //if no parent-variant structure this is the SKU or FG (finished good),\n \"purchasedParentProductID\": 6940304310317, //optional, only required when there is a parent-variant structure. This is the variant parent or model code\n \"price\": \"39.95\", \n \"quantity\": 1, \n \"referringVariantID\": \"40297473048621\", //if applicable\n \"baseFinalProductID\": 88230, //optional, only required if purchaseType is ‘recommended’ – ie. when this product is a recommended rather than a base product \"baseParentProductID\": 81345, //optional, only required when there is baseFinalProductID and it is a child in a parent-variant relationship.\n \"baseParentProductID\": 88120, //only required for Shopify Platform \n \"recommendationSource\": 1\n }\n]\n\nEventType: ORDER_CREATED
\nJSON Structure
\n[{ //ORDER_CREATED is the only event type where model object is part of eventData\n \"purchasedFinalProductID\": 40297391783981,\n \"purchasedParentProductID\": 6940304310317,\n \"price\": 39.95,\n \"quantity\": 1,\n \"referringVariantID\": \"40297473048621\",\n \"model\": {\n \"id\": \"gm39dfjl2\",\n \"version\": \"dec20m1\",\n \"mode\": \"pre20\"\n },\n \"recommendationSource\": \"ARS\",\n \"recommenderInstance\": 2,\n \"purchaseType\": \"base\",\n \"baseFinalProductID\": 88230,\n \"baseParentProductID\": 81345\n },{\n \"purchasedFinalProductID\": 30297391783981,\n \"purchasedParentProductID\": 3940304310317,\n \"price\": 70.95,\n \"quantity\": 1,\n \"referringVariantID\": \"30297473048621\",\n \"modelVersion\": \"version_info\", \n \"model\": {\n \"id\": \"gm39dfjl2\",\n \"version\": \"dec20m1\",\n \"mode\": \"pre20\"\n },\n \"recommendationSource\": \"SmartBuilder\",\n \"recommenderInstance\": 1,\n \"purchaseType\": \"base\",\n \"baseFinalProductID\": 99230,\n \"baseParentProductID\": 99345\n }\n]\n\nEventType: PRODUCT_CLICKED
\nJSON Structure
\n[{\n \"finalProductID\": \"88123\",\n \"parentProductID\": \"88105\", //This field will be fired only for Shopify platform\n \"baseFinalProductName\": \"AIRFLO SUPER-FLO POWER TAPER FLY LINE\",\n \"price\": 1499.95,\n \"baseFinalProductID\": \"32722407555156\",\n \"baseParentProductID\": \"32722407555156\", //This field will be fired only for Shopify platform\n \"clickAction\": \"GOTO_VARIANT\"\n }]\n\nEventType: CATEGORY_CLICKED
\nJSON Structure
\n[{\n \"categoryID\": \"573a2bd36c484d838eef729984a36132\",\n \"categoryName\": \"Reels\",\n \"categoryPosition\": 1,//The position of the category within the builder\n \"clickAction\": \"OPEN_CAT\",//To identify the action that was taken on the event\n \"baseFinalProductName\": \"Example product name\", //Name of the product\n \"baseParentProductID\": \"32722407555156\" \n }]\n\nEventType: CAROUSEL_CLICKED
\nJSON Structure
\n[{\n \"clickAction\":\"RIGHT_CLICK\",\n \"currentPageIndex\":2,\n \"baseFinalProductID\":\"ACS880-01-077A-5+D150-ABBI\",\n \"baseParentProductID\":\"ACS880-01-077A-5+D150-ABBI\",\n \"baseFinalProductName\":\"ACS880-01-077A-5+D150\"\n }]\n\nEventType: SORT_ORDER_CHANGED
\nJSON Structure
\n[{\n \"baseFinalProductID\": \"32722407555156\",\n \"baseParentProductID\": \"32722407555156\", //This field will be fired only for Shopify platform\n \"baseFinalProductName\": \"AIRFLO SUPER-FLO POWER TAPER FLY LINE\",\n \"categoryID\": \"573a2bd36c484d838eef729984a36132\",\n \"categoryName\": \"Reels\",\n \"categoryPosition\": 1,\n \"oldSortOrder\": \"compatioscore_descending\",\n \"newSortOrder\": \"price_ascending\"\n }]\n\nEventType: APPLET_LOADED
\nJSON Structure
\n[\n {\n \"baseFinalProductID\": \"88564\",\n \"baseParentProductID\": \"88734\", //This field will be fired only for Shopify platform\n }\n]\n}\n\nEventType: BUILDER_LOADED
\nJSON Structure
\n[{\n \"baseFinalProductID\":\"ACS880-01-077A-5+D150-ABBI\",\n \"baseParentProductID\":\"ACS880-01-077A-5+D150-ABBI\",\n \"baseFinalProductName\":\"ACS880-01-077A-5+D150\",\n \"click_action\":\"GOTO_BUILDER\"\n }]\n\nEventType: ADD_TO_BUILD
\nJSON Structure
\n{ \"productID\": \"<productID>\", \"categoryID\":\"<category id>\" }\n\nEventType: FIELD_SELECTED
\nJSON Structure
\n{ \"submodelID\": \"<submodel id>\", \"fieldID\":\"<field id>\", \"selectedOption\":\"<selected option id\" }\n\nEventType: FIELD_UNSELECTED
\nJSON Structure
\n{ \"submodelID\": \"<submodel id>\", \"fieldID\":\"<field id>\", \"unselectedOption\":\"<selected option id\" }\n\nEventType: REMOVE_FROM_BUILD**
\nJSON Structure
\n{ \"productID\": \"<productID>\", \"categoryID\":\"<category id>\" }\n\nEventType: BUILD_QTY_UPDATED**
\nJSON Structure
\n{ \"productID\": \"<productID>\", \"quantity\":\"<quantity>\" }\n\nEventType: PAGE_CLICKED**
\nJSON Structure
\n{ \"pageID\": \"<page id>\"}\n\nResponse:
\n{ success: true }\n\nThis is intended to be a real-time item availability tracking service.
\nSend availability state change for an item to Compatio Availability Service.
\nThis function will accommodate up to 1 item state change at a time. (For transmissions of bulk item state changes, please use Compatio bulk transfer services.)
\n","urlObject":{"path":[":merchantKey",""],"host":["availability","compatio","ai"],"query":[{"key":"variantId","value":"TRUE or FALSE
\n","type":"text/plain"},"key":"newAvailabilityState","value":"Channel key provided by Compatio, for example \"6810z81fkjq\"
\n","type":"text/plain"},"type":"any","value":"Create a new quote. [Optional] Items can be provided to initialize the quote with those.
\nHere's the list of fields
\nownerKey: key for the organization that owns the quote, issued by Compatio
engineInstanceID:
quoteHeader: Object for quote's meta information like shipping/billing address and agent associated
itemList: List of items to be added to the quote, an item can also be configurable which is marked by configurable boolean flag. If the item is configurable, then another JSON object called configurationOptions is required, which is a list of object containing:
propID: Configuration property ID
propValue: Configurable property value
qty: quantity of items input by user.
A successful request will return a similar structure shown below with generated quoteID, createdAt and unitPrice for items sent in the request.
List all the quotes user is authorized to view based on its JWT claims.
\nAdditionally, an ids query string parameter can be provided with comma separated ids to filter the results based on those ids. In future, more parameters will be supported.
\n","urlObject":{"protocol":"https","path":["v1",":ownerKey","quotes"],"host":["quoting","compatio","ai"],"query":[{"key":"ids","value":"1,2,3"}],"variable":[{"id":"a244509f-9074-414f-ac1b-0e7a45731db1","type":"any","value":"","key":"ownerKey"}]}},"response":[{"id":"921e130e-dd72-4840-851d-946fdcbfb3e1","name":"List Quotes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerAdd/update more item(s) to the given quote ID. Similar to \"Add Quote\" request, this will respond with a payload itemList
Delete a given quote. Bulk delete is not supported at this time.
\n","urlObject":{"protocol":"https","path":["v1",":ownerKey","quotes",":id"],"host":["quoting","compatio","ai"],"query":[],"variable":[{"id":"6f068423-b696-4856-9b3a-03485aeead24","type":"any","value":"","key":"ownerKey"},{"id":"b4993def-4598-46c1-9a4d-bef3b75a0a65","type":"any","value":"","key":"id"}]}},"response":[{"id":"13684f35-51c1-4be0-b54d-442c57a44967","name":"Delete Quote","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerAPI Documentation for Quote Management System
\nAuthorization:
\nAll APIs must be provided encoded JWT tokens in Authorization header. The role and permissions in the JWT will determine whether the request will be successful or not.
Sample JWT payload claims
\n{ \n \"iss\": \"https://hostapp\", // issuer\n \"sub\": \"1234567890\", // subject\n \"aud\": \"compatio-quote-api\", //audience\n \"exp\": 1615855793, //expiry UNIX - timestamp\n \"nbf\": 1615852193, //do not accept before - UNIX timestamp\n \"iat\": 1615852193, // Issued At - Unix timestamp\n \"jti\": \"unique-jwt-id\", \n \"role\": \"sales-agent\", //Roles defined and supported by Compatio \n \"permissions\": [\"read\", \"write\", \"delete\"],\n \"ownerKeys\": [\"xyz123\",\"pqr098\"] //keys current user has access to\n}\n\nInitializes a blank builder and generates a session. This is typically the first API call you'll make.
\nSuccess Response:
{
\"status\": \"success\",
\"session_id\": \"46690d9cb61807d32419ae7e033b025ad5dce727011c4d48f483997d63ef7ffb\",
\"data\": { ... }
}
Note: Store the session_id and cookies from the response for use in subsequent requests. On browser based implementations, these domain cookies will already be added to same domain urls, for server side implementation, it has to be set explicitly.
\n","urlObject":{"protocol":"https","path":["api","configurator","load"],"host":["isr-api","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"a991015a-f5d7-46ca-9218-8cd9745da21b"},{"name":"2. Initialize Default Model","id":"b5acaa77-1669-4c0a-a7a6-cda0fd37f76a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"cookie","value":"_ga=GA1.1.1933876426.1727343282; _ga_226770T1J0=GS1.1.1727343282.1.0.1727343291.0.0.0; AWSALBAPP-1=_remove_; AWSALBAPP-2=_remove_; AWSALBAPP-3=_remove_; COMPATIOSB3=4ph-MswBllM; AWSALBAPP-0=AAAAAAAAAACwXtvgCn5pI13XbUqUdTCH8w9FRqn86vSwIG6vCh5gSYXsg2EhVkkVthQPW/6lCWpDPC2ceLQ8C3ByoZ6a+8nz82O+CFs1jpOEvq6+xQx//n+ycteFRtxphAyBYx1XtzDkVm4="}],"body":{"mode":"raw","raw":"{\n \"version\": \"live\",\n \"merchant_key\": \"gms9EqvG4rlZDlLtUb1V\"\n}"},"url":"https://isr-api.compatio.net/api/configurator/load","description":"Loads a default model for the builder. This endpoint is similar to the Blank Builder Load, but it doesn't require a project_id.
\nSuccess Response:
{
\"status\": \"success\",
\"session_id\": \"46690d9cb61807d32419ae7e033b025ad5dce727011c4d48f483997d63ef7ffb\",
\"data\": { ... }
}
Note: Store the session_id and update the cookies from the response for use in subsequent requests.
\n","urlObject":{"protocol":"https","path":["api","configurator","load"],"host":["isr-api","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"b5acaa77-1669-4c0a-a7a6-cda0fd37f76a"},{"name":"3. Builder Initialize for Preview","id":"be0ed9f1-f33b-4325-92f5-8ee5e38b94f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"project_id\": \"cb4e0ce600c411f0b0b536a281231da4\"\n}"},"url":"https://isr-api.compatio.net/api/configurator/preview/load","description":"Loads a preview of the builder. This endpoint is used when you want to preview a specific project configuration.
\nSuccess Response:
{
\"status\": \"success\",
\"data\": { ... }
}
Retrieves the model for a specific product variant.
\nSuccess Response:
{
\"status\": \"success\",
\"data\": { ... }
}
Note: Include the cookies from the initial load in the header of this request.
\n","urlObject":{"protocol":"https","path":["api","configurator","variant","models"],"host":["isr-api","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"0047a8a0-a6ae-4ad7-9870-74630556944f"},{"name":"5. Launch Non-Linear Builder","id":"730924a4-fc85-4e52-b5d8-311233869e6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"cookie","value":"_ga=GA1.1.1933876426.1727343282; _ga_226770T1J0=GS1.1.1727343282.1.0.1727343291.0.0.0; AWSALBAPP-1=_remove_; AWSALBAPP-2=_remove_; AWSALBAPP-3=_remove_; COMPATIOSB3=uFON-6EMT-Q; AWSALBAPP-0=AAAAAAAAAAAgUbM5gYPNiuXWLzlqwx8hwkd3yvCD9oLecOJ/AJEbEtiNsd0FafJHowPK4IypCNFTZsZGTePYFOLLnqKplhY/B/d+oXvRHUxHKxphSeY8LmAsJFGyrmVQUFwvQZZ8zAZjHOU="}],"body":{"mode":"raw","raw":"{\n \"merchant_key\": \"gms9EqvG4rlZDlLtUb1V\",\n \"variants_list\": [\n \"PDW-XE-001\"\n ],\n \"project_id\": \"cb4e0ce600c411f0b0b536a281231da4\"\n}"},"url":"https://isr-api.compatio.net/api/configurator/load","description":"Launches a non-linear builder with specified variants.
\nSuccess Response:
{
\"status\": \"success\",
\"session_id\": \"46690d9cb61807d32419ae7e033b025ad5dce727011c4d48f483997d63ef7ffb\",
\"data\": { ... }
}
Note: Store the session_id and update the cookies from the response for use in subsequent requests.
\n","urlObject":{"protocol":"https","path":["api","configurator","load"],"host":["isr-api","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"730924a4-fc85-4e52-b5d8-311233869e6c"},{"name":"6. Fetch Category Products","id":"52902ff7-b07f-4ca3-8224-97de183df537","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"cookie","value":"_ga=GA1.1.1933876426.1727343282; _ga_226770T1J0=GS1.1.1727343282.1.0.1727343291.0.0.0; AWSALBAPP-1=_remove_; AWSALBAPP-2=_remove_; AWSALBAPP-3=_remove_; COMPATIOSB3=pMmuLw4sD1I; AWSALBAPP-0=AAAAAAAAAADKDduyjqytQqHPBVRzrz6Ke1UuPV1Gxp1Obb6k5h+LzROMVQSHYZdOAdx/iK1UrsPQrULwlQu3VilXogWKJOT0OiSTuwP3eff/o1XPZFcF5p3W7+3sVVgRyKbW3HENtupnEHE="}],"body":{"mode":"raw","raw":"{\n \"session_id\": \"87f1a7c16d78240a1408cd69f33044c1563b5b9fc697fc60ad0765249dffbd29\",\n \"category_name\": [\"CPU\"],\n \"instance_ID\": \"3ea130b6-5cf8-4ace-9e5b-12bffefc4537\"\n}"},"url":"https://isr-api.compatio.net/api/configurator/result?end=50","description":"Lists products for a specified category. The 'end' query parameter determines the number of results to return.
\nSuccess Response:
{
\"status\": \"success\",
\"data\": {
\"products\": [ ... ],
\"total_count\": 150
}
}
Selects an item from a picklist. This endpoint is used to update the configuration based on user selections.
\nSuccess Response:
{
\"status\": \"success\",
\"data\": { ... }
}
Note: Include the session cookies in the header of this request.
\n","urlObject":{"protocol":"https","path":["api","configurator","instance"],"host":["isr-api","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd54278e-c47f-4fc5-872a-8e535ed3d1cc"},{"name":"8. Toggle Unavilable Option","id":"bee2f56c-665b-4857-a891-c7a33c411b74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"cookie","value":"_ga=GA1.1.1933876426.1727343282; _ga_226770T1J0=GS1.1.1727343282.1.0.1727343291.0.0.0; AWSALBAPP-1=_remove_; AWSALBAPP-2=_remove_; AWSALBAPP-3=_remove_; COMPATIOSB3=jWo2JqGIXBM; AWSALBAPP-0=AAAAAAAAAABx0tc/VrQk6VCBb9ibPgPX85JFd0DDG9OLIGAZc05OqPqvsN5ng6skrXPZ5/MsWVK4XjwVMbCiMHvUYVniVowuP42aCb2gzgyeGCBmjAlQxWhZ3b2I93jhEHMyGd+wHieHP/A="}],"body":{"mode":"raw","raw":"{\n \"session_id\": \"87f1a7c16d78240a1408cd69f33044c1563b5b9fc697fc60ad0765249dffbd29\",\n \"instance_ID\": \"b1826cb6-ded5-411c-a2e9-7eb4dc21158e\",\n \"instance_data\": {\n \"9877302c40f311ef93f2a23dd5af6f59\": [\"MB2\"]\n }\n}"},"url":"https://isr-api.compatio.net/api/configurator/instance?isDisabled=true","description":"Selects a greyed-out (disabled) option. This endpoint is similar to the 'Select a Picklist' but with the isDisabled query parameter set to true.
\nSuccess Response:
{
\"status\": \"success\",
\"data\": { ... }
}
Note: Include the session cookies in the header of this request.
\n","urlObject":{"protocol":"https","path":["api","configurator","instance"],"host":["isr-api","compatio","net"],"query":[{"key":"isDisabled","value":"true"}],"variable":[]}},"response":[],"_postman_id":"bee2f56c-665b-4857-a891-c7a33c411b74"},{"name":"9. Override & Apply Configuration Rollback","id":"4aa6b8b3-afff-4f99-8b26-214cf6c3336d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"cookie","value":"_ga=GA1.1.1933876426.1727343282; _ga_226770T1J0=GS1.1.1727343282.1.0.1727343291.0.0.0; AWSALBAPP-1=_remove_; AWSALBAPP-2=_remove_; AWSALBAPP-3=_remove_; COMPATIOSB3=jWo2JqGIXBM; AWSALBAPP-0=AAAAAAAAAADstjl+mHLJRcre26qSQOyEKWFf8tbacOBIEwYym1GQm5gGhKcqR5dhEkyK46UYJyzBABcuCMYiCCBrVPPzCcZiR6njc4KmllfsqrxA4mkbkjdalIwkzkGUPodPEbdGX9oWrCU="}],"body":{"mode":"raw","raw":"{\n \"session_id\": \"87f1a7c16d78240a1408cd69f33044c1563b5b9fc697fc60ad0765249dffbd29\",\n \"instance_ID\": \"b1826cb6-ded5-411c-a2e9-7eb4dc21158e\",\n \"instance_data\": {\n \"9877302c40f311ef93f2a23dd5af6f59\": [\"MB2\"]\n }\n}"},"url":"https://isr-api.compatio.net/api/configurator/instance?isForced=true","description":"Overrides a selection and allows for rollback. This endpoint is similar to 'Select a Picklist' but with the isForced query parameter set to true.
\nSuccess Response:
{
\"status\": \"success\",
\"data\": { ... }
}
Note: Include the session cookies in the header of this request.
\n","urlObject":{"protocol":"https","path":["api","configurator","instance"],"host":["isr-api","compatio","net"],"query":[{"key":"isForced","value":"true"}],"variable":[]}},"response":[],"_postman_id":"4aa6b8b3-afff-4f99-8b26-214cf6c3336d"},{"name":"10. Add Item to Cart","id":"5954a8d2-8b0e-4fac-aa8f-b07ac74b0838","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"cookie","value":"_ga=GA1.1.1933876426.1727343282; _ga_226770T1J0=GS1.1.1727343282.1.0.1727343291.0.0.0; AWSALBAPP-1=_remove_; AWSALBAPP-2=_remove_; AWSALBAPP-3=_remove_; COMPATIOSB3=O7lZS4so1gs; AWSALBAPP-0=AAAAAAAAAADwVKJzhdXQN8PJlwd57VGjmNu38JzccqqHea5Au1Qoa4RZ8ZcSWwoAT2/yu9T7jc1bsR1oh08V8+kZU+wvkNVAF7i6LMr6gfsfe4ToZ7lFA3uuRl/KgYHBoDrOK/0HSqGu75w="}],"body":{"mode":"raw","raw":"{\n \"version\": \"live\",\n \"merchant_key\": \"gms9EqvG4rlZDlLtUb1V\",\n \"variants_list\": [\"MB2\"]\n}"},"url":"https://isr-api.compatio.net/api/configurator/load","description":"Adds a product to the cart. This endpoint initiates a new session with the specified variants in the cart.
\nSuccess Response:
{
\"status\": \"success\",
\"session_id\": \"db7421d71630cf57aac2385f43364885aea43b1917f0fc19dbfd43322465fdda\",
\"data\": {
\"cart\": {
\"items\": [
{
\"variant_id\": \"N412242008WC-WIEG\",
\"quantity\": 1,
\"price\": 299.99
}
],
\"total_price\": 299.99
}
}
}
Note: Store the session_id and cookies from the response for use in subsequent requests.
\n","urlObject":{"protocol":"https","path":["api","configurator","load"],"host":["isr-api","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"5954a8d2-8b0e-4fac-aa8f-b07ac74b0838"},{"name":"11. Remove Item from Cart","id":"afcaebe2-c7a9-460a-b475-aea806002adf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"cookie","value":"_ga=GA1.1.1933876426.1727343282; _ga_226770T1J0=GS1.1.1727343282.1.0.1727343291.0.0.0; AWSALBAPP-1=_remove_; AWSALBAPP-2=_remove_; AWSALBAPP-3=_remove_; COMPATIOSB3=uFON-6EMT-Q; AWSALBAPP-0=AAAAAAAAAABKSWlmSJDNHl3AKIHa0kN37mrCEK7JujUTjxqnULXv7jaw6i0L1C93zOYXeKdbFAAN1roqE0wUMYW4PnAMXmBS5QfP3FL4PAuRtoT9gfxD/Udd6BpmCchTgoAQA2BHZvZTD5k="}],"body":{"mode":"raw","raw":"{\n \"session_id\": \"87f1a7c16d78240a1408cd69f33044c1563b5b9fc697fc60ad0765249dffbd29\",\n \"instance_ID\": \"b1826cb6-ded5-411c-a2e9-7eb4dc21158e\",\n \"instance_data\": {\n \"9877302c40f311ef93f2a23dd5af6f59\": []\n }\n}"},"url":"https://isr-api.compatio.net/api/configurator/instance","description":"Removes a product from the cart. The empty array in instance_data for the specified key indicates the removal of the product.
\nSuccess Response:
{
\"status\": \"success\",
\"data\": {
\"cart\": {
\"items\": [],
}
}
}
Note: Ensure to include the session cookies in the header of this request. The cookie value provided is an example and should be replaced with the actual cookies received from previous requests.
\n","urlObject":{"protocol":"https","path":["api","configurator","instance"],"host":["isr-api","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"afcaebe2-c7a9-460a-b475-aea806002adf"},{"name":"12. Apply Product Sorting","id":"b7ed2a99-84da-433f-9865-9e22af55134d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"cookie","value":"_ga=GA1.1.1933876426.1727343282; _ga_226770T1J0=GS1.1.1727343282.1.0.1727343291.0.0.0; AWSALBAPP-1=_remove_; AWSALBAPP-2=_remove_; AWSALBAPP-3=_remove_; COMPATIOSB3=uFON-6EMT-Q; AWSALBAPP-0=AAAAAAAAAAD6BmoFKJRpZekFsTX3VVkvpi6O09AGOI8KGZVkOkr4FnTIzNkvHOmVId329oTcAuH4Blb5Zh+VRpEq4whKBrrx3x39qI3XJ4hfHofZvkDgaCzlgyGWlEyo0Ma08P6ZmgRo7Vo="}],"body":{"mode":"raw","raw":"{\n \"session_id\": \"87f1a7c16d78240a1408cd69f33044c1563b5b9fc697fc60ad0765249dffbd29\",\n \"category_name\": [\"Motherboard\"],\n \"instance_ID\": \"b1826cb6-ded5-411c-a2e9-7eb4dc21158e\"\n}"},"url":"https://isr-api.compatio.net/api/configurator/result?end=50&s_key=min_ad_price&s_order=asc","description":"Retrieves a sorted list of products based on specified criteria.
\nQuery Parameters:
\n- \n
end: Number of results to return (e.g., 50)
\n \ns_key: Sort key (e.g., \"min_ad_price\", \"name\")
\n \ns_order: Sort order (\"asc\" or \"desc\")
\n \n
Success Response:
{
\"status\": \"success\",
\"data\": {
\"products\": [ ... ],
\"total_count\": 150
}
}
Note: Ensure to include the session cookies in the header of this request. The cookie value provided is an example and should be replaced with the actual cookies received from previous requests. The sort functionality allows for various sorting options, including price (min_ad_price) and name, in ascending or descending order.
\n","urlObject":{"protocol":"https","path":["api","configurator","result"],"host":["isr-api","compatio","net"],"query":[{"key":"end","value":"50"},{"key":"s_key","value":"min_ad_price"},{"key":"s_order","value":"asc"}],"variable":[]}},"response":[],"_postman_id":"b7ed2a99-84da-433f-9865-9e22af55134d"},{"name":"13. Create Sub Model Instance","id":"b68a3c0f-3060-43df-ad44-d603dca3f104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"accept-language","value":"en-GB,en-US;q=0.9,en;q=0.8"},{"key":"authorization","value":""},{"key":"cache-control","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"origin","value":"https://sb3-demo.compatio.ai"},{"key":"pragma","value":"no-cache"},{"key":"priority","value":"u=1, i"},{"key":"referer","value":"https://sb3-demo.compatio.ai/"},{"key":"sec-ch-ua","value":"\"Not(A:Brand\";v=\"99\", \"Google Chrome\";v=\"133\", \"Chromium\";v=\"133\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"sec-fetch-dest","value":"empty"},{"key":"sec-fetch-mode","value":"cors"},{"key":"sec-fetch-site","value":"cross-site"},{"key":"user-agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36"}],"body":{"mode":"raw","raw":"{\n \"session_id\": \"87f1a7c16d78240a1408cd69f33044c1563b5b9fc697fc60ad0765249dffbd29\",\n \"sub_model_ID\": \"ef9d511000c411f0a3ee36a281231da4\"\n}","options":{"raw":{"language":"json"}}},"url":"https://isr-api.compatio.net/api/configurator/instance","description":"Request Body Parameters:
\n- \n
\nsession_id: String - Unique identifier for the current configuration session \n
\nsub_model_ID: String - ID of the component model to instantiate \n
\n\nSuccess Response: {
\n
\"status\": \"success\",
\"data\": { ... }
}
Note: This endpoint creates a new instance of the specified component model within your configuration session. The returned instance ID should be used when establishing connections or modifying the instance. Session cookies must be included in the request body to maintain session context. The response includes instance metadata and model-specific data that may be needed for rendering or configuration purposes.
\n","urlObject":{"protocol":"https","path":["api","configurator","instance"],"host":["isr-api","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"b68a3c0f-3060-43df-ad44-d603dca3f104"},{"name":"14. Remove Sub Model Instance","id":"4025d454-16ec-4dfd-af38-08ff30d5be34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"accept","value":"application/json"},{"key":"accept-language","value":"en-GB,en-US;q=0.9,en;q=0.8"},{"key":"authorization","value":""},{"key":"cache-control","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"origin","value":"https://sb3-demo.compatio.ai"},{"key":"pragma","value":"no-cache"},{"key":"priority","value":"u=1, i"},{"key":"referer","value":"https://sb3-demo.compatio.ai/"},{"key":"sec-ch-ua","value":"\"Not(A:Brand\";v=\"99\", \"Google Chrome\";v=\"133\", \"Chromium\";v=\"133\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"sec-fetch-dest","value":"empty"},{"key":"sec-fetch-mode","value":"cors"},{"key":"sec-fetch-site","value":"cross-site"},{"key":"user-agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36"}],"body":{"mode":"raw","raw":"{\n \"session_id\": \"87f1a7c16d78240a1408cd69f33044c1563b5b9fc697fc60ad0765249dffbd29\",\n \"instance_ID\": \"a707dee7-4b99-443e-bb4f-0151d0e5f6e7\"\n}","options":{"raw":{"language":"json"}}},"url":"https://isr-api.compatio.net/api/configurator/instance","description":"Request Body Parameters:
\n- \n
\nsession_id: String - Unique identifier for the current configuration session \n
\ninstance_ID: String - UUID of the component instance to be removed \n
\n\nSuccess Response: {
\n
\"status\": \"success\",
\"data\": { ... }
}
Note: This endpoint soft removes the specified component instance from your configuration. Any connections to or from this instance will also be automatically removed and listed in the response. Ensure the session ID corresponds to your active configuration session.
\n","urlObject":{"protocol":"https","path":["api","configurator","instance"],"host":["isr-api","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"4025d454-16ec-4dfd-af38-08ff30d5be34"},{"name":"15. Connect Sub Models","id":"c64a05af-5687-46e6-ad8c-2f1198c27ccc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"accept-language","value":"en-GB,en-US;q=0.9,en;q=0.8"},{"key":"authorization","value":""},{"key":"cache-control","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"origin","value":"https://sb3-demo.compatio.ai"},{"key":"pragma","value":"no-cache"},{"key":"priority","value":"u=1, i"},{"key":"referer","value":"https://sb3-demo.compatio.ai/"},{"key":"sec-ch-ua","value":"\"Not(A:Brand\";v=\"99\", \"Google Chrome\";v=\"133\", \"Chromium\";v=\"133\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"sec-fetch-dest","value":"empty"},{"key":"sec-fetch-mode","value":"cors"},{"key":"sec-fetch-site","value":"cross-site"},{"key":"user-agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36"}],"body":{"mode":"raw","raw":"{\"session_id\":\"87f1a7c16d78240a1408cd69f33044c1563b5b9fc697fc60ad0765249dffbd29\",\"instance_from\":\"a707dee7-4b99-443e-bb4f-0151d0e5f6e7\",\"instance_to\":\"be760f7a-d811-49be-b9b2-cecaf1ec2ba7\"}","options":{"raw":{"language":"json"}}},"url":"https://isr-api-dev.compatio.net/api/configurator/addconnection","description":"Request Body Parameters:
\n- \n
\nsession_id: String - Unique identifier for the current configuration session \n
\ninstance_from: String - ID of the source component instance \n
\ninstance_to: String - ID of the target component instance \n
\n\nSuccess Response: {
\n
\"status\": \"success\",
\"data\": { ... }
}
Note: This endpoint creates a logical connection between two components in your configuration. Both component instances must exist within the same session. The connection direction is significant, flowing from the source instance to the target instance. Ensure the session ID matches your active configuration session.
\n","urlObject":{"protocol":"https","path":["api","configurator","addconnection"],"host":["isr-api-dev","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"c64a05af-5687-46e6-ad8c-2f1198c27ccc"},{"name":"16. Disconnect Sub Models","id":"dd2c95cf-c978-4b43-aa62-5160291b5adb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"accept-language","value":"en-GB,en-US;q=0.9,en;q=0.8"},{"key":"authorization","value":""},{"key":"cache-control","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"origin","value":"https://sb3-demo.compatio.ai"},{"key":"pragma","value":"no-cache"},{"key":"priority","value":"u=1, i"},{"key":"referer","value":"https://sb3-demo.compatio.ai/"},{"key":"sec-ch-ua","value":"\"Not(A:Brand\";v=\"99\", \"Google Chrome\";v=\"133\", \"Chromium\";v=\"133\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"sec-fetch-dest","value":"empty"},{"key":"sec-fetch-mode","value":"cors"},{"key":"sec-fetch-site","value":"cross-site"},{"key":"user-agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36"}],"body":{"mode":"raw","raw":"{\"session_id\":\"87f1a7c16d78240a1408cd69f33044c1563b5b9fc697fc60ad0765249dffbd29\",\"instance_from\":\"a707dee7-4b99-443e-bb4f-0151d0e5f6e7\",\"instance_to\":\"be760f7a-d811-49be-b9b2-cecaf1ec2ba7\"}","options":{"raw":{"language":"json"}}},"url":"https://isr-api-dev.compatio.net/api/configurator/dropconnection","description":"Request Body Parameters:
\n- \n
\nsession_id: String - Unique identifier for the current configuration session \n
\ninstance_from: String - ID of the source component instance \n
\ninstance_to: String - ID of the target component instance \n
\n\nSuccess Response: {
\n
\"status\": \"success\",
\"data\": { ... }
}
Note: This endpoint removes a logical connection previously established between two component instances. Both the source and target instance UUIDs must match the original connection exactly. Ensure the session ID corresponds to your active configuration session.
\n","urlObject":{"protocol":"https","path":["api","configurator","dropconnection"],"host":["isr-api-dev","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd2c95cf-c978-4b43-aa62-5160291b5adb"},{"name":"17. Save Configuration","id":"e5d070ce-6036-490a-a522-9c2b2fd3d7ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"accept-language","value":"en-GB,en-US;q=0.9,en;q=0.8"},{"key":"authorization","value":"Bearer YOUR_AUTH_TOKEN"},{"key":"content-type","value":"application/json"},{"key":"origin","value":"https://sb3-demo.compatio.ai"},{"key":"referer","value":"https://sb3-demo.compatio.ai/"}],"body":{"mode":"raw","raw":"{\n \"session_id\": \"87f1a7c16d78240a1408cd69f33044c1563b5b9fc697fc60ad0765249dffbd29\"\n}","options":{"raw":{"language":"json"}}},"url":"https://isr-api.compatio.net/api/configurations/save","description":"Create Configuration
\nCreates a new configuration with user inputs and build items. This endpoint saves configuration details including model ID, user ID, organization ID, and additional metadata.
\nRequest Endpoint: POST /api/configurations/save
Request Body Parameters:
\n- \n
session_id: String - Current configuration session ID \n
Success Response: { \"status\": \"success\", \"data\": { \"config_id\": \"cf12345678\", \"created_at\": \"2025-03-13T14:30:45Z\", \"updated_at\": \"2025-03-13T14:30:45Z\", ... } }
Note: Authentication token required in the authorization header.
\n","urlObject":{"protocol":"https","path":["api","configurations","save"],"host":["isr-api","compatio","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5d070ce-6036-490a-a522-9c2b2fd3d7ef"}],"id":"376c9060-3486-4d7b-b9c8-91eeb837c028","description":"Overview
\nThe Configurator API serves as an interface for Configurator and Guided-Selling frontend applications.
\nThe Configuration API supports frontend applications that deliver user interfaces enabling third-party host applications to leverage Compatio's builder models. These models facilitate the creation of complex configurations using specified products and options while ensuring compatibility and incorporating machine learning capabilities.
\nPrerequisites
\n- \n
Host applications require a merchantKey, which is assigned to a specific sales channel
\n \nCatalog, inventory, and order data ingestion must be established and completed as a one-time setup
\n \nBuilder and recommender models must be properly configured and published in the appropriate environment
\n \n
Demo Environment
\n- \n
Base URL: https://isr-api-test.compatio.net/
\n \nmerchantKey: gms9EqvG4rlZDlLtUb1V
\n \n
Core Concepts
\n- \n
Configurations operate within sessions that are stored and managed server-side
\n \nSessions evaluate models in real-time based on user inputs
\n \nA session may contain multiple instances depending on the model type, typically representing items that appear more than once in a configuration with different settings or options
\n \nInstances in a configuration can be connected by connections
\n \n
Implementation Flow
\nFollowing set of diagrams below illustrate sequence/flow of API calls by a consumer app for some common cases. Actual flow depends on user activity, but it helps in understanding how and when certain APIs are called.
\n