[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6},"actionData","errors","routes/docs",{"_7":8,"_9":10,"_11":12,"_13":14},"type","mdx","path","production/api-reference/index.mdx","markdownUrl","/llms.mdx/docs/production/api-reference/content.md","pageTree",{"_15":16,"_17":18},"$fumadocs_loader","page-tree","data",{"_7":19,"_20":21,"_22":19,"_23":24,"_25":26,"_27":28,"_29":30},"root","$ref",{"_36":54,"_45":304},"$id","name","Decoloop Docs","description","Developer documentation for Decoloop products.","children",[55,56,57],"fallback",{"_7":19,"_20":31,"_22":32,"_23":33,"_25":-7,"_27":34},{"_36":54,"_45":-7},"fallback:root","Docs",[35],{"_7":36,"_23":37,"_19":-7,"_38":-7,"_25":-7,"_39":-7,"_27":40,"_22":41,"_20":42,"_43":-7},"folder","Cpq","defaultOpen","collapsible",[46],"fallback:cpq",{"_36":44,"_45":-7},"icon","cpq","meta",{"_22":47,"_7":48,"_23":49,"_25":50,"_43":-7,"_51":52,"_20":53},"fallback:cpq/getting-started.mdx","page","Getting Started with CPQ","Start integrating with Decoloop CPQ.","url","/docs/cpq/getting-started","cpq/getting-started.mdx","",{"_22":300,"_7":48,"_23":301,"_25":302,"_43":-7,"_51":303,"_20":300},{"_7":36,"_23":121,"_19":59,"_38":59,"_25":122,"_39":61,"_27":123,"_22":44,"_20":124,"_65":125,"_43":126},{"_7":36,"_23":58,"_19":59,"_38":59,"_25":60,"_39":61,"_27":62,"_22":63,"_20":64,"_65":66,"_43":67},"Production",true,"Production API documentation for manufacturing, planning, packages, plugins, departments, ratings, and exports.",false,[71],"production",{"_36":63,"_45":70},"index",{"_22":68,"_7":48,"_23":58,"_25":60,"_43":67,"_51":69,"_20":68},"","production/index.mdx","/docs/production","production/meta.json",{"_7":36,"_23":72,"_19":-7,"_38":-7,"_25":73,"_39":-7,"_27":74,"_22":75,"_20":76,"_65":77,"_43":78},"API Reference","Reference documentation for Production API endpoints and schemas.",[81,82,83,84,85,86,87,88,89,90],"production/api-reference",{"_36":75,"_45":80},{"_22":10,"_7":48,"_23":72,"_25":73,"_43":-7,"_51":79,"_20":10},"","/docs/production/api-reference","production/api-reference/meta.json",{"_22":118,"_7":48,"_23":119,"_25":-7,"_43":-7,"_51":120,"_20":118},{"_22":115,"_7":48,"_23":116,"_25":-7,"_43":-7,"_51":117,"_20":115},{"_22":112,"_7":48,"_23":113,"_25":-7,"_43":-7,"_51":114,"_20":112},{"_22":109,"_7":48,"_23":110,"_25":-7,"_43":-7,"_51":111,"_20":109},{"_22":106,"_7":48,"_23":107,"_25":-7,"_43":-7,"_51":108,"_20":106},{"_22":103,"_7":48,"_23":104,"_25":-7,"_43":-7,"_51":105,"_20":103},{"_22":100,"_7":48,"_23":101,"_25":-7,"_43":-7,"_51":102,"_20":100},{"_22":97,"_7":48,"_23":98,"_25":-7,"_43":-7,"_51":99,"_20":97},{"_22":94,"_7":48,"_23":95,"_25":-7,"_43":-7,"_51":96,"_20":94},{"_22":91,"_7":48,"_23":92,"_25":-7,"_43":-7,"_51":93,"_20":91},"production/api-reference/status.mdx","Status","/docs/production/api-reference/status","production/api-reference/projectexport.mdx","Project Export","/docs/production/api-reference/projectexport","production/api-reference/polygonpackage.mdx","Polygon Package","/docs/production/api-reference/polygonpackage","production/api-reference/polygondepartment.mdx","Polygon Department","/docs/production/api-reference/polygondepartment","production/api-reference/polygon.mdx","Polygon","/docs/production/api-reference/polygon","production/api-reference/plugin.mdx","Plugin","/docs/production/api-reference/plugin","production/api-reference/package.mdx","Package","/docs/production/api-reference/package","production/api-reference/matching.mdx","Matching","/docs/production/api-reference/matching","production/api-reference/department.mdx","Department","/docs/production/api-reference/department","production/api-reference/customer.mdx","Customer","/docs/production/api-reference/customer","CPQ","Configure, Price, Quote developer documentation.",[131,132],{"_36":44,"_45":130},{"_22":127,"_7":48,"_23":121,"_25":128,"_43":126,"_51":129,"_20":127},"","cpq/index.mdx","Configure, Price, Quote developer documentation for configuration and embedded experiences.","/docs/cpq","cpq/meta.json",{"_7":36,"_23":181,"_19":-7,"_38":59,"_25":182,"_39":59,"_27":183,"_22":184,"_20":185,"_65":186,"_43":187},{"_7":36,"_23":133,"_19":-7,"_38":59,"_25":134,"_39":59,"_27":135,"_22":136,"_20":137,"_65":138,"_43":139},"Embedded","Embedded CPQ integration documentation.",[145,146,147],"cpq/(modules)/embedded",{"_36":136,"_45":144},{"_22":140,"_7":48,"_23":141,"_25":142,"_43":139,"_51":143,"_20":140},"","cpq/(modules)/embedded/index.mdx","Embedded CPQ","Embed CPQ configuration experiences directly in your application.","/docs/cpq/embedded","cpq/(modules)/embedded/meta.json",{"_7":36,"_23":169,"_19":-7,"_38":-7,"_25":170,"_39":61,"_27":171,"_22":172,"_20":173,"_65":174,"_43":175},{"_7":36,"_23":157,"_19":-7,"_38":-7,"_25":158,"_39":61,"_27":159,"_22":160,"_20":161,"_65":162,"_43":163},{"_7":36,"_23":72,"_19":-7,"_38":-7,"_25":148,"_39":61,"_27":149,"_22":150,"_20":151,"_65":152,"_43":78},"Reference documentation for embedded CPQ APIs and integration points.",[],"cpq/(modules)/embedded/api-reference",{"_36":150,"_45":156},{"_22":153,"_7":48,"_23":154,"_25":-7,"_43":-7,"_51":155,"_20":153},"cpq/(modules)/embedded/api-reference/index.mdx","CPQ Embedded","/docs/cpq/embedded/api-reference","cpq/(modules)/embedded/api-reference/meta.json","Proxy-Based Guide","Use api.decoloop.com as an embedded CPQ proxy for multi-instance or multi-supplier integrations.",[],"cpq/(modules)/embedded/proxy-guide",{"_36":160,"_45":168},{"_22":164,"_7":48,"_23":165,"_25":166,"_43":163,"_51":167,"_20":164},"","cpq/(modules)/embedded/proxy-guide/index.mdx","Proxy-Based Embedded CPQ Guide","Use api.decoloop.com as a proxy hub for embedded CPQ integrations across multiple applications, suppliers, or CPQ instances.","/docs/cpq/embedded/proxy-guide","cpq/(modules)/embedded/proxy-guide/meta.json","Guide","Implementation guidance for embedded CPQ experiences.",[],"cpq/(modules)/embedded/dev-guide",{"_36":172,"_45":180},{"_22":176,"_7":48,"_23":177,"_25":178,"_43":175,"_51":179,"_20":176},"","cpq/(modules)/embedded/dev-guide/index.mdx","Embedded CPQ Developer Guide","Implementation guidance for embedding CPQ experiences.","/docs/cpq/embedded/dev-guide","cpq/(modules)/embedded/dev-guide/meta.json","Configuration API","APIs for configuring products, options, rules, and selections.",[192,193,194],"cpq/(modules)/configuration-api",{"_36":184,"_45":191},{"_22":188,"_7":48,"_23":181,"_25":189,"_43":187,"_51":190,"_20":188},"","cpq/(modules)/configuration-api/index.mdx","Configure products, options, rules, and selections through the CPQ Configuration API.","/docs/cpq/configuration-api","cpq/(modules)/configuration-api/meta.json",{"_7":36,"_23":169,"_19":-7,"_38":-7,"_25":290,"_39":61,"_27":291,"_22":292,"_20":293,"_65":294,"_43":175},{"_7":36,"_23":279,"_19":-7,"_38":-7,"_25":280,"_39":61,"_27":281,"_22":282,"_20":283,"_65":284,"_43":175},{"_7":36,"_23":72,"_19":-7,"_38":-7,"_25":-7,"_39":-7,"_27":195,"_22":196,"_20":197,"_65":198,"_43":-7},[202,203,204,205,206,207,208,209,210,211,212,213,214,215,216,217],"cpq/(modules)/configuration-api/api-reference",{"_36":196,"_45":-7},{"_22":199,"_7":48,"_23":72,"_25":200,"_43":-7,"_51":201,"_20":199},"cpq/(modules)/configuration-api/api-reference/index.mdx","Reference documentation for Configuration API endpoints and schemas.","/docs/cpq/configuration-api/api-reference",{"_22":275,"_7":48,"_23":276,"_25":277,"_43":-7,"_51":278,"_20":275},{"_22":271,"_7":48,"_23":272,"_25":273,"_43":-7,"_51":274,"_20":271},{"_22":267,"_7":48,"_23":268,"_25":269,"_43":-7,"_51":270,"_20":267},{"_22":264,"_7":48,"_23":119,"_25":265,"_43":-7,"_51":266,"_20":264},{"_22":260,"_7":48,"_23":261,"_25":262,"_43":-7,"_51":263,"_20":260},{"_22":256,"_7":48,"_23":257,"_25":258,"_43":-7,"_51":259,"_20":256},{"_22":252,"_7":48,"_23":253,"_25":254,"_43":-7,"_51":255,"_20":252},{"_22":248,"_7":48,"_23":249,"_25":250,"_43":-7,"_51":251,"_20":248},{"_22":245,"_7":48,"_23":104,"_25":246,"_43":-7,"_51":247,"_20":245},{"_22":241,"_7":48,"_23":242,"_25":243,"_43":-7,"_51":244,"_20":241},{"_22":237,"_7":48,"_23":238,"_25":239,"_43":-7,"_51":240,"_20":237},{"_22":233,"_7":48,"_23":234,"_25":235,"_43":-7,"_51":236,"_20":233},{"_22":229,"_7":48,"_23":230,"_25":231,"_43":-7,"_51":232,"_20":229},{"_22":226,"_7":48,"_23":92,"_25":227,"_43":-7,"_51":228,"_20":226},{"_22":222,"_7":48,"_23":223,"_25":224,"_43":-7,"_51":225,"_20":222},{"_22":218,"_7":48,"_23":219,"_25":220,"_43":-7,"_51":221,"_20":218},"cpq/(modules)/configuration-api/api-reference/wizardpolygon.mdx","Wizard Polygon","The WizardPolygon section contains all operations related to configuring a WizardPolygon.\nThe WizardPolygon response contains all information needed to display a configurator based on wizard steps.","/docs/cpq/configuration-api/api-reference/wizardpolygon","cpq/(modules)/configuration-api/api-reference/wizard.mdx","Wizard","The Wizard section contains all operations related to product wizards.","/docs/cpq/configuration-api/api-reference/wizard","cpq/(modules)/configuration-api/api-reference/status.mdx","The Status section contains all operations related to configuring the statuses of a Project.","/docs/cpq/configuration-api/api-reference/status","cpq/(modules)/configuration-api/api-reference/standalonepolygon.mdx","Standalone Polygon","The StandalonePolygon section contains all operations related to configuring a StandalonePolygon (configuration).\nA standalone Polygon is a Polygon that is not part of a Project and should always be moved to a Project when it needs to be ordered.","/docs/cpq/configuration-api/api-reference/standalonepolygon","cpq/(modules)/configuration-api/api-reference/sets.mdx","Sets","The Sets section contains all operations related to Sets and ProjectSets.","/docs/cpq/configuration-api/api-reference/sets","cpq/(modules)/configuration-api/api-reference/purchase-order.mdx","Purchase order","The PurchaseOrder section contains optional operations to enrich a Project (order) or Polygon (order line) with purchase order information.","/docs/cpq/configuration-api/api-reference/purchase-order","cpq/(modules)/configuration-api/api-reference/project.mdx","Project","The Project section contains all operations related a Project (order).","/docs/cpq/configuration-api/api-reference/project","cpq/(modules)/configuration-api/api-reference/polygon.mdx","The Polygon section contains all operations related to configuring a Polygon (order line).\nBefore you can add a Polygon, you first need to create a Project.","/docs/cpq/configuration-api/api-reference/polygon","cpq/(modules)/configuration-api/api-reference/model.mdx","Model","The Model section contains all operations related to models (products).","/docs/cpq/configuration-api/api-reference/model","cpq/(modules)/configuration-api/api-reference/measurement.mdx","Measurement","The measurement section contains all operation related to measuring a polygon.","/docs/cpq/configuration-api/api-reference/measurement","cpq/(modules)/configuration-api/api-reference/material.mdx","Material","The Material section contains all operations related to materials.\nMaterials are part of a configured product, for example a fabric for a curtain.","/docs/cpq/configuration-api/api-reference/material","cpq/(modules)/configuration-api/api-reference/licensee.mdx","Licensee","The Licensee section contains all operations related to Licensees.\nIn most CPQ instances, a Licensee is equal to a store. A CPQ instance can have multiple Licensees, each with multiple Employees (users).","/docs/cpq/configuration-api/api-reference/licensee","cpq/(modules)/configuration-api/api-reference/customer.mdx","The Customer section contains all operations related to customers.","/docs/cpq/configuration-api/api-reference/customer","cpq/(modules)/configuration-api/api-reference/contentblock.mdx","Content Block","The ContentBlock section contains all operations related to content blocks.\nContent blocks are configurable CMS content managed in Stuart and served via this API.","/docs/cpq/configuration-api/api-reference/contentblock","cpq/(modules)/configuration-api/api-reference/categorypreset.mdx","Category Preset","The CategoryPreset section contains all operations related to CategoryPresets.\nCategoryPresets are a predefined set of options and materials for a product.","/docs/cpq/configuration-api/api-reference/categorypreset","cpq/(modules)/configuration-api/api-reference/authentication.mdx","Authentication","The decoloop CPQ API uses JWT bearer tokens for authenticated requests.","/docs/cpq/configuration-api/api-reference/authentication","Guide (Project)","Implementation guidance for Project-based CPQ integrations.",[],"cpq/(modules)/configuration-api/dev-guide-project",{"_36":282,"_45":289},{"_22":285,"_7":48,"_23":286,"_25":287,"_43":175,"_51":288,"_20":285},"cpq/(modules)/configuration-api/dev-guide-project/index.mdx","Configuration API Guide — Project-based Flow","Build CPQ integrations where a full Project is created upfront and used to manage all configured items in the session.","/docs/cpq/configuration-api/dev-guide-project","cpq/(modules)/configuration-api/dev-guide-project/meta.json","Implementation guidance for webshop and cart integrations using standalone polygons.",[],"cpq/(modules)/configuration-api/dev-guide",{"_36":292,"_45":299},{"_22":295,"_7":48,"_23":296,"_25":297,"_43":175,"_51":298,"_20":295},"cpq/(modules)/configuration-api/dev-guide/index.mdx","Configuration API Guide — Standalone Polygon Flow","Build frontend application integrations where individual configured items are created as standalone polygons and promoted to a Project at finalization or submission.","/docs/cpq/configuration-api/dev-guide","cpq/(modules)/configuration-api/dev-guide/meta.json","getting-started.mdx","Getting Started","Learn how Decoloop developer documentation is organized and where to start.","/docs/getting-started","meta.json"]

API Reference

On this page