{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Chift","colors":{"primary":"#04C28F","light":"#3AF2AE","dark":"#052B2E"},"logo":{"light":"https://mintcdn.com/chift/SsdLyPJfpLncQDvV/logo/light.svg?fit=max\u0026auto=format\u0026n=SsdLyPJfpLncQDvV\u0026q=85\u0026s=b43848bb528c7d184e769b3f620b6a3b","dark":"https://mintcdn.com/chift/SsdLyPJfpLncQDvV/logo/dark.svg?fit=max\u0026auto=format\u0026n=SsdLyPJfpLncQDvV\u0026q=85\u0026s=31e25aa5df3f1a1d04f93f3c5db928b2"},"favicon":"https://mintcdn.com/chift/zDhHILEvsOX-FIP4/favicon.svg?fit=max\u0026auto=format\u0026n=zDhHILEvsOX-FIP4\u0026q=85\u0026s=9ce78a32dbbd106fd70eea5d5cfa6f02","navbar":{"links":[{"href":"/home","label":"Developer Documentation"},{"href":"/help/overview","label":"User Documentation"}],"primary":{"type":"button","label":"Dashboard","href":"https://chift.app"}},"search":{"prompt":"Search or ask... (Boosted by AI)"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"href":"home"},{"language":"fr","href":"fr/help/overview"},{"language":"es","href":"es/help/overview"},{"language":"nl","href":"nl/help/overview"},{"language":"de","href":"de/help/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chift","hasAudioNarration":false,"actualSubdomain":"chift","customDomains":["docs.chift.eu"],"gitSource":{"type":"github","owner":"chift-oneapi","repo":"chift-api-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aedf654637c395c8819c271","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"en","tag":"Developer Documentation","count":502},{"language":"en","tag":"Connectors","count":306},{"language":"en","tag":"API Reference","count":202},{"language":"en","tag":"Accounting","count":175},{"language":"en","tag":"User Documentation","count":157},{"language":"fr","tag":"User Documentation","count":153},{"language":"de","tag":"User Documentation","count":152},{"language":"es","tag":"User Documentation","count":152},{"language":"nl","tag":"User Documentation","count":152},{"language":"en","tag":"POS","count":123},{"language":"en","tag":"Unified APIs","count":99},{"language":"en","tag":"Invoicing","count":78},{"language":"en","tag":"Concepts","count":56},{"language":"en","tag":"Other","count":52},{"language":"de","tag":"Accounting","count":52},{"language":"es","tag":"Accounting","count":52},{"language":"fr","tag":"Accounting","count":52},{"language":"nl","tag":"Accounting","count":52},{"language":"fr","tag":"POS","count":46},{"language":"de","tag":"POS","count":45},{"language":"es","tag":"POS","count":45},{"language":"nl","tag":"POS","count":45},{"language":"de","tag":"Invoicing","count":26},{"language":"es","tag":"Invoicing","count":26},{"language":"fr","tag":"Invoicing","count":26},{"language":"nl","tag":"Invoicing","count":26},{"language":"de","tag":"Marketplace","count":8},{"language":"es","tag":"Marketplace","count":8},{"language":"fr","tag":"Marketplace","count":8},{"language":"nl","tag":"Marketplace","count":8},{"language":"de","tag":"Payment","count":7},{"language":"es","tag":"Payment","count":7},{"language":"fr","tag":"Payment","count":7},{"language":"nl","tag":"Payment","count":7},{"language":"de","tag":"eCommerce","count":4},{"language":"de","tag":"PMS","count":4},{"language":"de","tag":"Local Agent","count":4},{"language":"de","tag":"Manage my account","count":4},{"language":"es","tag":"eCommerce","count":4},{"language":"es","tag":"PMS","count":4},{"language":"es","tag":"Local Agent","count":4},{"language":"es","tag":"Manage my account","count":4},{"language":"fr","tag":"eCommerce","count":4},{"language":"fr","tag":"PMS","count":4},{"language":"fr","tag":"Local Agent","count":4},{"language":"fr","tag":"Manage my account","count":4},{"language":"nl","tag":"eCommerce","count":4},{"language":"nl","tag":"PMS","count":4},{"language":"nl","tag":"Local Agent","count":4},{"language":"nl","tag":"Manage my account","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"connectors/custom.css","content":"#content-area table th:first-child,#content-area table td:first-child{position:sticky;left:0;z-index:2;background-color:#ffffff}html.dark #content-area table th:first-child,html.dark #content-area table td:first-child{background-color:#000f06ff}#content-area table th:first-child{border-right:1px solid var(--border-subtle)}#content-area table td:first-child{border-right:1px solid var(--border-subtle)}.coverage-table-container{height:70vh;overflow:auto;border:1px solid #ddd;margin:20px 0;position:relative;display:block}.coverage-table-container table{display:table!important;width:100%!important;border-collapse:collapse!important}.coverage-table-container table thead{display:table-header-group!important;position:sticky!important;top:0!important;z-index:10!important;background-color:#ffffff!important}.coverage-table-container table thead th{background-color:#ffffff!important;border-bottom:2px solid #ddd!important;padding:8px!important;text-align:left!important}html.dark .coverage-table-container table thead{background-color:#000f06ff!important}html.dark .coverage-table-container table thead th{background-color:#000f06ff!important}.coverage-table-container table thead th:first-child{z-index:11!important}"},{"filePath":"style.css","content":"html[data-page-mode=\"wide\"] #content-container{max-width:100%}html[data-docs-section=\"help\"] .nav-dropdown-trigger,html[data-docs-section=\"help\"] .navbar-link{display:none!important}@media (min-width: 1024px){.nav-dropdown-trigger{display:none!important}html[data-docs-section=\"dev\"] .navbar-link:has(a:not([href*=\"/help\"])){display:none}html[data-docs-section=\"dev\"] #localization-select-trigger{display:none}html[data-docs-section=\"help\"] #topbar-cta-button{display:none}}.cw{--cw-border: rgba(5, 43, 46, 0.12);--cw-muted: rgba(5, 43, 46, 0.6);--cw-chip-bg: rgba(5, 43, 46, 0.04);margin-top:1rem}.dark .cw{--cw-border: rgba(255, 255, 255, 0.12);--cw-muted: rgba(255, 255, 255, 0.6);--cw-chip-bg: rgba(255, 255, 255, 0.04)}.cw-stats{display:grid;grid-template-columns:repeat(3, 1fr);gap:0.75rem;margin-bottom:1.5rem}.cw-stats>div{border:1px solid var(--cw-border);border-radius:12px;padding:1rem;text-align:center}.cw-stats strong{display:block;font-size:2rem;line-height:1.1;color:#04c28f}.cw-stats span{font-size:0.85rem;color:var(--cw-muted)}.cw-controls{display:flex;flex-wrap:wrap;gap:0.75rem;align-items:center;justify-content:space-between;margin-bottom:1rem}.cw-chips{display:flex;flex-wrap:wrap;gap:0.4rem}.cw-chip{border:1px solid var(--cw-border);background:var(--cw-chip-bg);border-radius:999px;padding:0.3rem 0.8rem;font-size:0.85rem;cursor:pointer}.cw-chip-on{background:#04c28f;border-color:#04c28f;color:#052b2e;font-weight:600}.cw-search{border:1px solid var(--cw-border);background:transparent;border-radius:8px;padding:0.4rem 0.75rem;font-size:0.9rem;min-width:0;width:14rem;max-width:100%}.cw-section{margin-top:1.75rem}.cw-head{display:flex;flex-wrap:wrap;align-items:baseline;justify-content:space-between;gap:0.5rem;margin-bottom:0.75rem}.cw-head h3{margin:0;font-size:1.1rem;font-weight:600}.cw-count{font-size:0.8rem;font-weight:500;color:var(--cw-muted);margin-left:0.25rem}.cw-more{font-size:0.85rem;color:#04c28f}.cw-grid{display:grid;grid-template-columns:repeat(auto-fill, minmax(64px, 1fr));gap:0.6rem}.cw-tile{position:relative;display:flex;align-items:center;justify-content:center;aspect-ratio:1;background:#fff;border:1px solid var(--cw-border);border-radius:12px;padding:10px;transition:transform 0.15s ease, box-shadow 0.15s ease, border-color 0.15s ease}.cw a.cw-tile{border-bottom:1px solid var(--cw-border);z-index:1}.cw .cw-tile:hover,.cw .cw-tile:focus-visible{transform:translateY(-2px);border:1px solid #04c28f;box-shadow:0 4px 14px rgba(4, 194, 143, 0.25);outline:none;z-index:20}.cw-tile-static{cursor:default}.cw-logo{width:100%;height:100%;object-fit:contain;margin:0!important;border-radius:6px}.cw-name{font-weight:700;font-size:0.7rem;line-height:1.1;text-align:center;overflow-wrap:anywhere;color:#052b2e}.cw-new{position:absolute;top:-7px;right:-7px;background:#04c28f;color:#052b2e;border:1px solid #04c28f;border-radius:999px;padding:0 0.35rem;font-size:0.6rem;font-weight:700;line-height:1.5;letter-spacing:0.02em}.dark .cw-new{background:#052b2e;color:#3af2ae;border-color:#04c28f}.cw-tip{position:absolute;bottom:calc(100% + 6px);left:50%;transform:translateX(-50%);white-space:nowrap;background:#04c28f;color:#052b2e;font-weight:600;box-shadow:0 2px 8px rgba(0, 0, 0, 0.25);font-size:0.75rem;padding:0.25rem 0.5rem;border-radius:6px;pointer-events:none;opacity:0;transition:opacity 0.12s ease}.cw-tile:hover .cw-tip,.cw-tile:focus-visible .cw-tip{opacity:1}.cw-empty{color:var(--cw-muted)}@media (max-width: 480px){.cw-stats strong{font-size:1.5rem}.cw-search{width:100%}}"}],"page":{"pagePath":"api-reference/endpoints/ecommerce/create-an-order","slug":"/api-reference/endpoints/ecommerce/create-an-order","pageMetadata":{"openapi":"post /consumers/{consumer_id}/commerce/orders","title":"Create an order","description":"Creates a new customer order in the e-commerce system and returns the created order record.","href":"/api-reference/endpoints/ecommerce/create-an-order"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a new customer order in the e-commerce system and returns the created order record.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Learn more:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`What is an order? `,_jsx(_components.a,{href:`/unified-apis/ecommerce/concepts/order`,target:`_blank`,children:`↗`})]}),`\n`,_jsxs(_components.li,{children:[`How are amounts and taxes rounded? `,_jsx(_components.a,{href:`/unified-apis/ecommerce/concepts/amounts-rounding`,target:`_blank`,children:`↗`})]}),`\n`,_jsxs(_components.li,{children:[`What is a customer? `,_jsx(_components.a,{href:`/unified-apis/ecommerce/concepts/customer`,target:`_blank`,children:`↗`})]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /consumers/{consumer_id}/commerce/orders","title":"Create an order","description":"Creates a new customer order in the e-commerce system and returns the created order record.","href":"/api-reference/endpoints/ecommerce/create-an-order"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/chift/f67c86372f363744/custom.js"],"openApiReferenceData":{"operation":{"tags":["eCommerce","Orders"],"summary":"Create an order","description":"Creates a new customer order in the e-commerce system and returns the created order record.","operationId":"ecommerce_create_order","security":["89e00bda-aac7-4b45-80b2-5de22a7c1469"],"parameters":["fe2cd94e-fe59-401d-bcab-7d5b5712503b"],"requestBody":"31e0e842-9f01-4576-8f28-4a77c46f898d","responses":{"200":"6f89cf36-1fca-4db4-b769-fb7b42f29294","400":"937b0290-a6d4-4aef-8281-b5260d5e324c","422":"5443768a-7f64-4172-99ae-42d41dbd6da1"},"method":"post","type":"path","servers":["5defdfa8-71fb-4ec4-801e-b5f74b591689"],"path":"/consumers/{consumer_id}/commerce/orders","baseUrlOptions":["https://api.chift.eu"],"title":"Create an order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fe2cd94e-fe59-401d-bcab-7d5b5712503b":{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"customer":{"properties":{"email":{"type":"string","title":"Email","examples":["john.doe@example.com"],"isRequired":true,"uniqueKey":"customer.email","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","title":"First Name","example":"John","uniqueKey":"customer.first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","example":"John","uniqueKey":"customer.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","example":"Doe","uniqueKey":"customer.last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","example":"Doe","uniqueKey":"customer.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.last_name","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"customer.phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"customer.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.phone","typeLabel":"string | null"},"internal_notes":{"oneOf":[{"type":"string","title":"Internal Notes","example":"Preferred contact: accounts payable team.","uniqueKey":"customer.internal_notes.oneOf.0","typeLabel":"string"},{"type":"null","title":"Internal Notes","example":"Preferred contact: accounts payable team.","uniqueKey":"customer.internal_notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.internal_notes","typeLabel":"string | null"}},"type":"object","required":["email"],"title":"OrderCustomerItem","isRequired":true,"uniqueKey":"customer","typeLabel":"OrderCustomerItem · object"},"billing_address":{"properties":{"first_name":{"type":"string","title":"First Name","examples":["John"],"isRequired":true,"uniqueKey":"billing_address.first_name","typeLabel":"string"},"last_name":{"type":"string","title":"Last Name","examples":["Doe"],"isRequired":true,"uniqueKey":"billing_address.last_name","typeLabel":"string"},"street":{"type":"string","title":"Street","examples":["Example Street"],"isRequired":true,"uniqueKey":"billing_address.street","typeLabel":"string"},"number":{"type":"string","title":"Number","examples":["123"],"isRequired":true,"uniqueKey":"billing_address.number","typeLabel":"string"},"city":{"type":"string","title":"City","examples":["Brussels"],"isRequired":true,"uniqueKey":"billing_address.city","typeLabel":"string"},"country":{"type":"string","minLength":1,"title":"Country","description":"Format: ISO 3166-1 codes.","examples":["BE"],"isRequired":true,"uniqueKey":"billing_address.country","typeLabel":"string"},"box":{"oneOf":[{"type":"string","title":"Box","example":"A","uniqueKey":"billing_address.box.oneOf.0","typeLabel":"string"},{"type":"null","title":"Box","example":"A","uniqueKey":"billing_address.box.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.box","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","example":"1000","uniqueKey":"billing_address.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","example":"1000","uniqueKey":"billing_address.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.postal_code","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"billing_address.phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"billing_address.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.phone","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","example":"john.doe@example.com","uniqueKey":"billing_address.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","example":"john.doe@example.com","uniqueKey":"billing_address.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.email","typeLabel":"string | null"}},"type":"object","required":["first_name","last_name","street","number","city","country"],"title":"CommerceAddressItemIn","isRequired":true,"uniqueKey":"billing_address","typeLabel":"CommerceAddressItemIn · object"},"shipping_address":{"properties":{"first_name":{"type":"string","title":"First Name","examples":["John"],"isRequired":true,"uniqueKey":"shipping_address.first_name","typeLabel":"string"},"last_name":{"type":"string","title":"Last Name","examples":["Doe"],"isRequired":true,"uniqueKey":"shipping_address.last_name","typeLabel":"string"},"street":{"type":"string","title":"Street","examples":["Example Street"],"isRequired":true,"uniqueKey":"shipping_address.street","typeLabel":"string"},"number":{"type":"string","title":"Number","examples":["123"],"isRequired":true,"uniqueKey":"shipping_address.number","typeLabel":"string"},"city":{"type":"string","title":"City","examples":["Brussels"],"isRequired":true,"uniqueKey":"shipping_address.city","typeLabel":"string"},"country":{"type":"string","minLength":1,"title":"Country","description":"Format: ISO 3166-1 codes.","examples":["BE"],"isRequired":true,"uniqueKey":"shipping_address.country","typeLabel":"string"},"box":{"oneOf":[{"type":"string","title":"Box","example":"A","uniqueKey":"shipping_address.box.oneOf.0","typeLabel":"string"},{"type":"null","title":"Box","example":"A","uniqueKey":"shipping_address.box.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.box","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","example":"1000","uniqueKey":"shipping_address.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","example":"1000","uniqueKey":"shipping_address.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.postal_code","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"shipping_address.phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"shipping_address.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.phone","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","example":"john.doe@example.com","uniqueKey":"shipping_address.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","example":"john.doe@example.com","uniqueKey":"shipping_address.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.email","typeLabel":"string | null"}},"type":"object","required":["first_name","last_name","street","number","city","country"],"title":"CommerceAddressItemIn","isRequired":true,"uniqueKey":"shipping_address","typeLabel":"CommerceAddressItemIn · object"},"currency":{"type":"string","title":"Currency","description":"Indicates the currency of the order (e.g. EUR).","examples":["EUR"],"isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"lines":{"items":{"properties":{"variant_id":{"type":"string","title":"Variant Id","description":"Technical id of the product variant in Chift","examples":["\u003ccommerce-variant-id>"],"isRequired":true,"uniqueKey":"lines.items.[INDEX].variant_id","typeLabel":"string"},"quantity":{"type":"integer","title":"Quantity","examples":[2],"isRequired":true,"uniqueKey":"lines.items.[INDEX].quantity","typeLabel":"integer"},"tax_rate":{"type":"number","title":"Tax Rate","description":"Indicates the tax rate used for the line (e.g. 21.0).","examples":[21],"isRequired":true,"uniqueKey":"lines.items.[INDEX].tax_rate","typeLabel":"number"},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price of the product without taxes.","examples":[100],"isRequired":true,"uniqueKey":"lines.items.[INDEX].unit_price","typeLabel":"number"}},"type":"object","required":["variant_id","quantity","tax_rate","unit_price"],"title":"OrderLineItemIn","uniqueKey":"lines.items.[INDEX]","typeLabel":"OrderLineItemIn · object"},"type":"array","minItems":1,"title":"Lines","isRequired":true,"uniqueKey":"lines","typeLabel":"OrderLineItemIn · object[]"},"note":{"oneOf":[{"type":"string","title":"Note","example":"Please leave at the front door.","uniqueKey":"note.oneOf.0","typeLabel":"string"},{"type":"null","title":"Note","example":"Please leave at the front door.","uniqueKey":"note.oneOf.1","typeLabel":"null"}],"uniqueKey":"note","typeLabel":"string | null"},"payment_method":{"oneOf":[{"type":"string","title":"Payment Method","description":"If filled in the order will be marked as paid and processed by this payment method.","example":"Credit card","uniqueKey":"payment_method.oneOf.0","typeLabel":"string"},{"type":"null","title":"Payment Method","description":"If filled in the order will be marked as paid and processed by this payment method.","example":"Credit card","uniqueKey":"payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method","typeLabel":"string | null"}},"type":"object","required":["customer","billing_address","shipping_address","currency","lines"],"title":"OrderItemIn","uniqueKey":"","typeLabel":"OrderItemIn · object"},"examples":{"Example":{"title":"Example","value":{"customer":{"email":"john.doe@example.com","first_name":"John","last_name":"Doe","phone":"+32 2 000 00 00","internal_notes":"Preferred contact: accounts payable team."},"billing_address":{"first_name":"John","last_name":"Doe","street":"Example Street","number":"123","city":"Brussels","country":"BE","box":"A","postal_code":"1000","phone":"+32 2 000 00 00","email":"john.doe@example.com"},"shipping_address":{"first_name":"John","last_name":"Doe","street":"Example Street","number":"123","city":"Brussels","country":"BE","box":"A","postal_code":"1000","phone":"+32 2 000 00 00","email":"john.doe@example.com"},"currency":"EUR","lines":[{"variant_id":"\u003ccommerce-variant-id>","quantity":2,"tax_rate":21,"unit_price":100}],"note":"Please leave at the front door.","payment_method":"Credit card"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6f89cf36-1fca-4db4-b769-fb7b42f29294":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift","examples":["\u003cthis-id>"],"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"source_ref":{"properties":{"id":{"oneOf":[{"type":"string","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"source_ref.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"source_ref.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_ref.id","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"source_ref.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"source_ref.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_ref.model","typeLabel":"string | null"}},"type":"object","title":"Ref","description":"Technical id in the target software","isRequired":true,"uniqueKey":"source_ref","typeLabel":"Ref · object"},"status":{"type":"string","enum":["cancelled_unpaid","cancelled","draft","confirmed","shipped","refunded"],"title":"OrderStatus","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"discount_amount":{"type":"number","title":"Discount Amount","examples":[0],"isRequired":true,"uniqueKey":"discount_amount","typeLabel":"number"},"untaxed_amount_without_fees":{"type":"number","title":"Untaxed Amount Without Fees","description":"Untaxed amount without fees (e.g. shipping) but with discout. Refunds and returns are not included.","examples":[200],"isRequired":true,"uniqueKey":"untaxed_amount_without_fees","typeLabel":"number"},"tax_amount_without_fees":{"type":"number","title":"Tax Amount Without Fees","description":"Total taxes applied to the order without taxes linked to fees (e.g. shipping).","examples":[42],"isRequired":true,"uniqueKey":"tax_amount_without_fees","typeLabel":"number"},"total_without_fees":{"type":"number","title":"Total Without Fees","description":"Total of the order without fees (e.g. shipping) but with discount. Refunds and returns are not included.","examples":[242],"isRequired":true,"uniqueKey":"total_without_fees","typeLabel":"number"},"current_untaxed_amount":{"type":"number","title":"Current Untaxed Amount","description":"Untaxed amount with discout and any kind of fee (e.g. shipping). After returns, removes and returns.","examples":[200],"isRequired":true,"uniqueKey":"current_untaxed_amount","typeLabel":"number"},"current_tax_amount":{"type":"number","title":"Current Tax Amount","description":"Total taxes applied to the order. After returns, removes and returns.","examples":[42],"isRequired":true,"uniqueKey":"current_tax_amount","typeLabel":"number"},"current_total":{"type":"number","title":"Current Total","description":"Current total of the order with discount. After returns, removes and returns.","examples":[242],"isRequired":true,"uniqueKey":"current_total","typeLabel":"number"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount with discout and any kind of fee (e.g. shipping). Refunds and returns are not included.","examples":[200],"isRequired":true,"uniqueKey":"untaxed_amount","typeLabel":"number"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes applied to the order. Refunds and returns are not included.","examples":[42],"isRequired":true,"uniqueKey":"tax_amount","typeLabel":"number"},"total":{"type":"number","title":"Total","description":"Total of the order with discount. Refunds and returns are not included.","examples":[242],"isRequired":true,"uniqueKey":"total","typeLabel":"number"},"currency":{"type":"string","title":"Currency","description":"Indicates the currency of the order (e.g. EUR).","examples":["EUR"],"isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"lines":{"items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift","examples":["\u003cthis-id>"],"isRequired":true,"uniqueKey":"lines.items.[INDEX].id","typeLabel":"string"},"source_ref":{"properties":{"id":{"oneOf":[{"type":"string","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"lines.items.[INDEX].source_ref.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"lines.items.[INDEX].source_ref.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"lines.items.[INDEX].source_ref.id","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"lines.items.[INDEX].source_ref.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"lines.items.[INDEX].source_ref.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"lines.items.[INDEX].source_ref.model","typeLabel":"string | null"}},"type":"object","title":"Ref","description":"Technical id in the target software","isRequired":true,"uniqueKey":"lines.items.[INDEX].source_ref","typeLabel":"Ref · object"},"quantity":{"type":"integer","title":"Quantity","examples":[2],"isRequired":true,"uniqueKey":"lines.items.[INDEX].quantity","typeLabel":"integer"},"current_quantity":{"type":"integer","title":"Current Quantity","description":"Quantity without refunds and returns.","examples":[2],"isRequired":true,"uniqueKey":"lines.items.[INDEX].current_quantity","typeLabel":"integer"},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price of the product without taxes.","examples":[100],"isRequired":true,"uniqueKey":"lines.items.[INDEX].unit_price","typeLabel":"number"},"description":{"type":"string","title":"Description","examples":["T-Shirt - M"],"isRequired":true,"uniqueKey":"lines.items.[INDEX].description","typeLabel":"string"},"tax_rate":{"type":"number","title":"Tax Rate","description":"Indicates the tax rate used for the line (e.g. 21.0).","examples":[21],"isRequired":true,"uniqueKey":"lines.items.[INDEX].tax_rate","typeLabel":"number"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount of the order line with discount.","examples":[200],"isRequired":true,"uniqueKey":"lines.items.[INDEX].untaxed_amount","typeLabel":"number"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes applied to the order line.","examples":[42],"isRequired":true,"uniqueKey":"lines.items.[INDEX].tax_amount","typeLabel":"number"},"total":{"type":"number","title":"Total","description":"Total of the order line with discount.","examples":[242],"isRequired":true,"uniqueKey":"lines.items.[INDEX].total","typeLabel":"number"},"created_on":{"oneOf":[{"type":"string","title":"Created On","format":"date-time","example":"2026-01-15T10:30:00Z","uniqueKey":"lines.items.[INDEX].created_on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created On","example":"2026-01-15T10:30:00Z","uniqueKey":"lines.items.[INDEX].created_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"lines.items.[INDEX].created_on","typeLabel":"string\u003cdate-time> | null"},"variant":{"oneOf":[{"type":"object","title":"OrderLineProductVariantItem","description":"Product variant","required":["id","name"],"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the product variant in Chift","examples":["\u003ccommerce-variant-id>"],"isRequired":true,"uniqueKey":"lines.items.[INDEX].variant.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","title":"Name","examples":["T-Shirt - M"],"isRequired":true,"uniqueKey":"lines.items.[INDEX].variant.oneOf.0.name","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","title":"Sku","example":"TSHIRT-M","uniqueKey":"lines.items.[INDEX].variant.oneOf.0.sku.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sku","example":"TSHIRT-M","uniqueKey":"lines.items.[INDEX].variant.oneOf.0.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"lines.items.[INDEX].variant.oneOf.0.sku","typeLabel":"string | null"},"categories":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the category in Chift","examples":["\u003cthis-category-id>"],"isRequired":true,"uniqueKey":"lines.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","title":"Name","examples":["Beverages"],"isRequired":true,"uniqueKey":"lines.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"type":"object","required":["id","name"],"title":"CommerceProductCategoryItem","uniqueKey":"lines.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX]","typeLabel":"CommerceProductCategoryItem · object"},"title":"Categories","default":[],"uniqueKey":"lines.items.[INDEX].variant.oneOf.0.categories.oneOf.0","typeLabel":"CommerceProductCategoryItem · object[]"},{"type":"null","title":"Categories","default":[],"uniqueKey":"lines.items.[INDEX].variant.oneOf.0.categories.oneOf.1","typeLabel":"null"}],"uniqueKey":"lines.items.[INDEX].variant.oneOf.0.categories","typeLabel":"CommerceProductCategoryItem · object[] | null"}},"uniqueKey":"lines.items.[INDEX].variant.oneOf.0","typeLabel":"OrderLineProductVariantItem · object"},{"type":"null","description":"Product variant","uniqueKey":"lines.items.[INDEX].variant.oneOf.1","typeLabel":"null"}],"uniqueKey":"lines.items.[INDEX].variant","typeLabel":"OrderLineProductVariantItem · object | null"},"tax_id":{"oneOf":[{"type":"string","title":"Tax Id","description":"Technical id of the tax rate in Chift","example":"\u003ccommerce-tax-id>","uniqueKey":"lines.items.[INDEX].tax_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Tax Id","description":"Technical id of the tax rate in Chift","example":"\u003ccommerce-tax-id>","uniqueKey":"lines.items.[INDEX].tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"lines.items.[INDEX].tax_id","typeLabel":"string | null"},"discounts":{"oneOf":[{"type":"array","items":{"properties":{"name":{"type":"string","title":"Name","examples":["Promo code"],"isRequired":true,"uniqueKey":"lines.items.[INDEX].discounts.oneOf.0.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","title":"Description","examples":["10% discount"],"isRequired":true,"uniqueKey":"lines.items.[INDEX].discounts.oneOf.0.items.[INDEX].description","typeLabel":"string"},"amount":{"type":"number","title":"Amount","examples":[10],"isRequired":true,"uniqueKey":"lines.items.[INDEX].discounts.oneOf.0.items.[INDEX].amount","typeLabel":"number"}},"type":"object","required":["name","description","amount"],"title":"CommerceDiscountItem","uniqueKey":"lines.items.[INDEX].discounts.oneOf.0.items.[INDEX]","typeLabel":"CommerceDiscountItem · object"},"title":"Discounts","default":[],"uniqueKey":"lines.items.[INDEX].discounts.oneOf.0","typeLabel":"CommerceDiscountItem · object[]"},{"type":"null","title":"Discounts","default":[],"uniqueKey":"lines.items.[INDEX].discounts.oneOf.1","typeLabel":"null"}],"uniqueKey":"lines.items.[INDEX].discounts","typeLabel":"CommerceDiscountItem · object[] | null"},"gift_card":{"oneOf":[{"type":"boolean","title":"Gift Card","default":false,"uniqueKey":"lines.items.[INDEX].gift_card.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Gift Card","default":false,"uniqueKey":"lines.items.[INDEX].gift_card.oneOf.1","typeLabel":"null"}],"uniqueKey":"lines.items.[INDEX].gift_card","typeLabel":"boolean | null"},"is_gift":{"oneOf":[{"type":"boolean","title":"Is Gift","default":false,"uniqueKey":"lines.items.[INDEX].is_gift.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Gift","default":false,"uniqueKey":"lines.items.[INDEX].is_gift.oneOf.1","typeLabel":"null"}],"uniqueKey":"lines.items.[INDEX].is_gift","typeLabel":"boolean | null"}},"type":"object","required":["id","source_ref","quantity","current_quantity","unit_price","description","tax_rate","untaxed_amount","tax_amount","total"],"title":"OrderLineItemOut","uniqueKey":"lines.items.[INDEX]","typeLabel":"OrderLineItemOut · object"},"type":"array","title":"Lines","isRequired":true,"uniqueKey":"lines","typeLabel":"OrderLineItemOut · object[]"},"order_number":{"oneOf":[{"type":"string","title":"Order Number","example":"1001","uniqueKey":"order_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Order Number","example":"1001","uniqueKey":"order_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_number","typeLabel":"string | null"},"channel":{"oneOf":[{"type":"string","title":"Channel","example":"Online store","uniqueKey":"channel.oneOf.0","typeLabel":"string"},{"type":"null","title":"Channel","example":"Online store","uniqueKey":"channel.oneOf.1","typeLabel":"null"}],"uniqueKey":"channel","typeLabel":"string | null"},"customer":{"oneOf":[{"type":"object","title":"OrderCustomerItemOut","required":["id"],"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the customer in Chift","examples":["\u003cthis-customer-id>"],"isRequired":true,"uniqueKey":"customer.oneOf.0.id","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","title":"First Name","example":"John","uniqueKey":"customer.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","example":"John","uniqueKey":"customer.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","example":"Doe","uniqueKey":"customer.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","example":"Doe","uniqueKey":"customer.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.last_name","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"customer.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"customer.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.phone","typeLabel":"string | null"},"internal_notes":{"oneOf":[{"type":"string","title":"Internal Notes","example":"Preferred contact: accounts payable team.","uniqueKey":"customer.oneOf.0.internal_notes.oneOf.0","typeLabel":"string"},{"type":"null","title":"Internal Notes","example":"Preferred contact: accounts payable team.","uniqueKey":"customer.oneOf.0.internal_notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.internal_notes","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","example":"john.doe@example.com","uniqueKey":"customer.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","example":"john.doe@example.com","uniqueKey":"customer.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"customer.oneOf.0","typeLabel":"OrderCustomerItemOut · object"},{"type":"null","uniqueKey":"customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer","typeLabel":"OrderCustomerItemOut · object | null"},"billing_address":{"oneOf":[{"type":"object","title":"CommerceAddressItemOut","required":["address_type"],"properties":{"address_type":{"type":"string","enum":["main","delivery","invoice"],"title":"AddressType","isRequired":true,"uniqueKey":"billing_address.oneOf.0.address_type","typeLabel":"enum\u003cstring>"},"company_name":{"oneOf":[{"type":"string","title":"Company Name","example":"Example Company S.A.","uniqueKey":"billing_address.oneOf.0.company_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Company Name","example":"Example Company S.A.","uniqueKey":"billing_address.oneOf.0.company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.company_name","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","title":"First Name","example":"John","uniqueKey":"billing_address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","example":"John","uniqueKey":"billing_address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","example":"Doe","uniqueKey":"billing_address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","example":"Doe","uniqueKey":"billing_address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.last_name","typeLabel":"string | null"},"street":{"oneOf":[{"type":"string","title":"Street","example":"Example Street","uniqueKey":"billing_address.oneOf.0.street.oneOf.0","typeLabel":"string"},{"type":"null","title":"Street","example":"Example Street","uniqueKey":"billing_address.oneOf.0.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.street","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","title":"Number","example":"123","uniqueKey":"billing_address.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Number","example":"123","uniqueKey":"billing_address.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.number","typeLabel":"string | null"},"box":{"oneOf":[{"type":"string","title":"Box","example":"A","uniqueKey":"billing_address.oneOf.0.box.oneOf.0","typeLabel":"string"},{"type":"null","title":"Box","example":"A","uniqueKey":"billing_address.oneOf.0.box.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.box","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","example":"Brussels","uniqueKey":"billing_address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","example":"Brussels","uniqueKey":"billing_address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.city","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","example":"1000","uniqueKey":"billing_address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","example":"1000","uniqueKey":"billing_address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"Format: ISO 3166-1 codes.","example":"BE","uniqueKey":"billing_address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"Format: ISO 3166-1 codes.","example":"BE","uniqueKey":"billing_address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.country","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"billing_address.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"billing_address.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.phone","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","example":"john.doe@example.com","uniqueKey":"billing_address.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","example":"john.doe@example.com","uniqueKey":"billing_address.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.email","typeLabel":"string | null"},"vat":{"oneOf":[{"type":"string","title":"Vat","example":"BE0000000000","uniqueKey":"billing_address.oneOf.0.vat.oneOf.0","typeLabel":"string"},{"type":"null","title":"Vat","example":"BE0000000000","uniqueKey":"billing_address.oneOf.0.vat.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address.oneOf.0.vat","typeLabel":"string | null"}},"uniqueKey":"billing_address.oneOf.0","typeLabel":"CommerceAddressItemOut · object"},{"type":"null","uniqueKey":"billing_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_address","typeLabel":"CommerceAddressItemOut · object | null"},"shipping_address":{"oneOf":[{"type":"object","title":"CommerceAddressItemOut","required":["address_type"],"properties":{"address_type":{"type":"string","enum":["main","delivery","invoice"],"title":"AddressType","isRequired":true,"uniqueKey":"shipping_address.oneOf.0.address_type","typeLabel":"enum\u003cstring>"},"company_name":{"oneOf":[{"type":"string","title":"Company Name","example":"Example Company S.A.","uniqueKey":"shipping_address.oneOf.0.company_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Company Name","example":"Example Company S.A.","uniqueKey":"shipping_address.oneOf.0.company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.company_name","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","title":"First Name","example":"John","uniqueKey":"shipping_address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","example":"John","uniqueKey":"shipping_address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","example":"Doe","uniqueKey":"shipping_address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","example":"Doe","uniqueKey":"shipping_address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.last_name","typeLabel":"string | null"},"street":{"oneOf":[{"type":"string","title":"Street","example":"Example Street","uniqueKey":"shipping_address.oneOf.0.street.oneOf.0","typeLabel":"string"},{"type":"null","title":"Street","example":"Example Street","uniqueKey":"shipping_address.oneOf.0.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.street","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","title":"Number","example":"123","uniqueKey":"shipping_address.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Number","example":"123","uniqueKey":"shipping_address.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.number","typeLabel":"string | null"},"box":{"oneOf":[{"type":"string","title":"Box","example":"A","uniqueKey":"shipping_address.oneOf.0.box.oneOf.0","typeLabel":"string"},{"type":"null","title":"Box","example":"A","uniqueKey":"shipping_address.oneOf.0.box.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.box","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","example":"Brussels","uniqueKey":"shipping_address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","example":"Brussels","uniqueKey":"shipping_address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.city","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","example":"1000","uniqueKey":"shipping_address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","example":"1000","uniqueKey":"shipping_address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"Format: ISO 3166-1 codes.","example":"BE","uniqueKey":"shipping_address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"Format: ISO 3166-1 codes.","example":"BE","uniqueKey":"shipping_address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.country","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"shipping_address.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone","example":"+32 2 000 00 00","uniqueKey":"shipping_address.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.phone","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","example":"john.doe@example.com","uniqueKey":"shipping_address.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","example":"john.doe@example.com","uniqueKey":"shipping_address.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.email","typeLabel":"string | null"},"vat":{"oneOf":[{"type":"string","title":"Vat","example":"BE0000000000","uniqueKey":"shipping_address.oneOf.0.vat.oneOf.0","typeLabel":"string"},{"type":"null","title":"Vat","example":"BE0000000000","uniqueKey":"shipping_address.oneOf.0.vat.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address.oneOf.0.vat","typeLabel":"string | null"}},"uniqueKey":"shipping_address.oneOf.0","typeLabel":"CommerceAddressItemOut · object"},{"type":"null","uniqueKey":"shipping_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_address","typeLabel":"CommerceAddressItemOut · object | null"},"created_on":{"oneOf":[{"type":"string","title":"Created On","format":"date-time","example":"2026-01-15T10:30:00Z","uniqueKey":"created_on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created On","example":"2026-01-15T10:30:00Z","uniqueKey":"created_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_on","typeLabel":"string\u003cdate-time> | null"},"last_updated_on":{"oneOf":[{"type":"string","title":"Last Updated On","format":"date-time","example":"2026-01-15T10:30:00Z","uniqueKey":"last_updated_on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Updated On","example":"2026-01-15T10:30:00Z","uniqueKey":"last_updated_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_updated_on","typeLabel":"string\u003cdate-time> | null"},"confirmed_on":{"oneOf":[{"type":"string","title":"Confirmed On","format":"date-time","example":"2026-01-15T10:30:00Z","uniqueKey":"confirmed_on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Confirmed On","example":"2026-01-15T10:30:00Z","uniqueKey":"confirmed_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"confirmed_on","typeLabel":"string\u003cdate-time> | null"},"delivery_date":{"oneOf":[{"type":"string","title":"Delivery Date","format":"date-time","example":"2026-02-14T10:30:00Z","uniqueKey":"delivery_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Delivery Date","example":"2026-02-14T10:30:00Z","uniqueKey":"delivery_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"delivery_date","typeLabel":"string\u003cdate-time> | null"},"cancelled_on":{"oneOf":[{"type":"string","title":"Cancelled On","format":"date-time","example":"2026-01-20T10:30:00Z","uniqueKey":"cancelled_on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Cancelled On","example":"2026-01-20T10:30:00Z","uniqueKey":"cancelled_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelled_on","typeLabel":"string\u003cdate-time> | null"},"fulfillment":{"oneOf":[{"type":"object","title":"EcommerceFulfillmentObject","required":["fulfillment_type"],"properties":{"fulfillment_type":{"type":"string","enum":["FBA","FBM"],"title":"EcommerceFulfillmentType","isRequired":true,"uniqueKey":"fulfillment.oneOf.0.fulfillment_type","typeLabel":"enum\u003cstring>"},"shipping_from_address":{"oneOf":[{"type":"object","title":"AddressItemOut","required":["address_type"],"properties":{"address_type":{"type":"string","enum":["main","delivery","invoice"],"title":"AddressType","isRequired":true,"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.address_type","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.name","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","title":"Number","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Number","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.number","typeLabel":"string | null"},"box":{"oneOf":[{"type":"string","title":"Box","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.box.oneOf.0","typeLabel":"string"},{"type":"null","title":"Box","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.box.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.box","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","title":"Phone","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.phone","typeLabel":"string | null"},"mobile":{"oneOf":[{"type":"string","title":"Mobile","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.mobile.oneOf.0","typeLabel":"string"},{"type":"null","title":"Mobile","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.mobile.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.mobile","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.email","typeLabel":"string | null"},"street":{"oneOf":[{"type":"string","title":"Street","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.street.oneOf.0","typeLabel":"string"},{"type":"null","title":"Street","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.street","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.city","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"Format: ISO 3166-1 codes.","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"Format: ISO 3166-1 codes.","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.0","typeLabel":"AddressItemOut · object"},{"type":"null","uniqueKey":"fulfillment.oneOf.0.shipping_from_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.0.shipping_from_address","typeLabel":"AddressItemOut · object | null"}},"uniqueKey":"fulfillment.oneOf.0","typeLabel":"EcommerceFulfillmentObject · object"},{"type":"null","uniqueKey":"fulfillment.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment","typeLabel":"EcommerceFulfillmentObject · object | null"},"refunded_amount":{"oneOf":[{"type":"number","title":"Refunded Amount","default":0,"example":0,"uniqueKey":"refunded_amount.oneOf.0","typeLabel":"number"},{"type":"null","title":"Refunded Amount","default":0,"example":0,"uniqueKey":"refunded_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunded_amount","typeLabel":"number | null"},"note":{"oneOf":[{"type":"string","title":"Note","example":"Please leave at the front door.","uniqueKey":"note.oneOf.0","typeLabel":"string"},{"type":"null","title":"Note","example":"Please leave at the front door.","uniqueKey":"note.oneOf.1","typeLabel":"null"}],"uniqueKey":"note","typeLabel":"string | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Tags","default":[],"example":["vip"],"uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Tags","default":[],"example":["vip"],"uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"},"other_fees":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift","examples":["\u003cthis-id>"],"isRequired":true,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].id","typeLabel":"string"},"source_ref":{"properties":{"id":{"oneOf":[{"type":"string","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"other_fees.oneOf.0.items.[INDEX].source_ref.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"other_fees.oneOf.0.items.[INDEX].source_ref.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_fees.oneOf.0.items.[INDEX].source_ref.id","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"other_fees.oneOf.0.items.[INDEX].source_ref.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"other_fees.oneOf.0.items.[INDEX].source_ref.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_fees.oneOf.0.items.[INDEX].source_ref.model","typeLabel":"string | null"}},"type":"object","title":"Ref","description":"Technical id in the target software","isRequired":true,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].source_ref","typeLabel":"Ref · object"},"type":{"type":"string","enum":["shipping","other"],"title":"FeesType","isRequired":true,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"tax_rate":{"type":"number","title":"Tax Rate","examples":[21],"isRequired":true,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].tax_rate","typeLabel":"number"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","examples":[10],"isRequired":true,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].untaxed_amount","typeLabel":"number"},"tax_amount":{"type":"number","title":"Tax Amount","examples":[2.1],"isRequired":true,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].tax_amount","typeLabel":"number"},"total":{"type":"number","title":"Total","examples":[12.1],"isRequired":true,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].total","typeLabel":"number"},"created_on":{"oneOf":[{"type":"string","title":"Created On","format":"date-time","example":"2026-01-15T10:30:00Z","uniqueKey":"other_fees.oneOf.0.items.[INDEX].created_on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created On","example":"2026-01-15T10:30:00Z","uniqueKey":"other_fees.oneOf.0.items.[INDEX].created_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_fees.oneOf.0.items.[INDEX].created_on","typeLabel":"string\u003cdate-time> | null"},"removed":{"oneOf":[{"type":"boolean","title":"Removed","description":"Indicates if the fee has been removed from the order","default":false,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].removed.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Removed","description":"Indicates if the fee has been removed from the order","default":false,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].removed.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_fees.oneOf.0.items.[INDEX].removed","typeLabel":"boolean | null"},"tax_id":{"oneOf":[{"type":"string","title":"Tax Id","description":"Technical id of the tax rate in Chift","example":"\u003ccommerce-tax-id>","uniqueKey":"other_fees.oneOf.0.items.[INDEX].tax_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Tax Id","description":"Technical id of the tax rate in Chift","example":"\u003ccommerce-tax-id>","uniqueKey":"other_fees.oneOf.0.items.[INDEX].tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_fees.oneOf.0.items.[INDEX].tax_id","typeLabel":"string | null"},"discounts":{"oneOf":[{"type":"array","items":{"properties":{"name":{"type":"string","title":"Name","examples":["Promo code"],"isRequired":true,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].discounts.oneOf.0.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","title":"Description","examples":["10% discount"],"isRequired":true,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].discounts.oneOf.0.items.[INDEX].description","typeLabel":"string"},"amount":{"type":"number","title":"Amount","examples":[10],"isRequired":true,"uniqueKey":"other_fees.oneOf.0.items.[INDEX].discounts.oneOf.0.items.[INDEX].amount","typeLabel":"number"}},"type":"object","required":["name","description","amount"],"title":"CommerceDiscountItem","uniqueKey":"other_fees.oneOf.0.items.[INDEX].discounts.oneOf.0.items.[INDEX]","typeLabel":"CommerceDiscountItem · object"},"title":"Discounts","default":[],"uniqueKey":"other_fees.oneOf.0.items.[INDEX].discounts.oneOf.0","typeLabel":"CommerceDiscountItem · object[]"},{"type":"null","title":"Discounts","default":[],"uniqueKey":"other_fees.oneOf.0.items.[INDEX].discounts.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_fees.oneOf.0.items.[INDEX].discounts","typeLabel":"CommerceDiscountItem · object[] | null"}},"type":"object","required":["id","source_ref","type","tax_rate","untaxed_amount","tax_amount","total"],"title":"FeesItem","uniqueKey":"other_fees.oneOf.0.items.[INDEX]","typeLabel":"FeesItem · object"},"title":"Other Fees","default":[],"uniqueKey":"other_fees.oneOf.0","typeLabel":"FeesItem · object[]"},{"type":"null","title":"Other Fees","default":[],"uniqueKey":"other_fees.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_fees","typeLabel":"FeesItem · object[] | null"},"payment_method_id":{"oneOf":[{"type":"string","title":"Payment Method Id","description":"Technical id of the payment method in the eCommerce","example":"\u003ccommerce-payment-method-id>","uniqueKey":"payment_method_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Payment Method Id","description":"Technical id of the payment method in the eCommerce","example":"\u003ccommerce-payment-method-id>","uniqueKey":"payment_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method_id","typeLabel":"string | null"},"transactions":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the transaction in the eCommerce","examples":["\u003ccommerce-transaction-id>"],"isRequired":true,"uniqueKey":"transactions.oneOf.0.items.[INDEX].id","typeLabel":"string"},"amount":{"type":"number","title":"Amount","examples":[242],"isRequired":true,"uniqueKey":"transactions.oneOf.0.items.[INDEX].amount","typeLabel":"number"},"status":{"type":"string","enum":["failed","pending","success"],"title":"CommerceTransactionStatus","isRequired":true,"uniqueKey":"transactions.oneOf.0.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"created_on":{"oneOf":[{"type":"string","title":"Created On","format":"date-time","example":"2026-01-15T10:30:00Z","uniqueKey":"transactions.oneOf.0.items.[INDEX].created_on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created On","example":"2026-01-15T10:30:00Z","uniqueKey":"transactions.oneOf.0.items.[INDEX].created_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactions.oneOf.0.items.[INDEX].created_on","typeLabel":"string\u003cdate-time> | null"},"payment_method_id":{"oneOf":[{"type":"string","title":"Payment Method Id","description":"Technical id of the payment method in the eCommerce","example":"\u003ccommerce-payment-method-id>","uniqueKey":"transactions.oneOf.0.items.[INDEX].payment_method_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Payment Method Id","description":"Technical id of the payment method in the eCommerce","example":"\u003ccommerce-payment-method-id>","uniqueKey":"transactions.oneOf.0.items.[INDEX].payment_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactions.oneOf.0.items.[INDEX].payment_method_id","typeLabel":"string | null"},"payment_method_name":{"oneOf":[{"type":"string","title":"Payment Method Name","description":"Name of the payment method","example":"Credit card","uniqueKey":"transactions.oneOf.0.items.[INDEX].payment_method_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Payment Method Name","description":"Name of the payment method","example":"Credit card","uniqueKey":"transactions.oneOf.0.items.[INDEX].payment_method_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactions.oneOf.0.items.[INDEX].payment_method_name","typeLabel":"string | null"}},"type":"object","required":["id","amount","status"],"title":"OrderTransactions","uniqueKey":"transactions.oneOf.0.items.[INDEX]","typeLabel":"OrderTransactions · object"},"title":"Transactions","default":[],"uniqueKey":"transactions.oneOf.0","typeLabel":"OrderTransactions · object[]"},{"type":"null","title":"Transactions","default":[],"uniqueKey":"transactions.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactions","typeLabel":"OrderTransactions · object[] | null"},"payment_methods":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the payment method in the eCommerce","examples":["\u003ccommerce-payment-method-id>"],"isRequired":true,"uniqueKey":"payment_methods.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","description":"Name of the payment method","example":"Credit card","uniqueKey":"payment_methods.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"Name of the payment method","example":"Credit card","uniqueKey":"payment_methods.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods.oneOf.0.items.[INDEX].name","typeLabel":"string | null"}},"type":"object","required":["id"],"title":"OrderPaymentMethods","uniqueKey":"payment_methods.oneOf.0.items.[INDEX]","typeLabel":"OrderPaymentMethods · object"},"title":"Payment Methods","default":[],"uniqueKey":"payment_methods.oneOf.0","typeLabel":"OrderPaymentMethods · object[]"},{"type":"null","title":"Payment Methods","default":[],"uniqueKey":"payment_methods.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods","typeLabel":"OrderPaymentMethods · object[] | null"},"detailed_refunds":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift","examples":["\u003cthis-id>"],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].id","typeLabel":"string"},"source_ref":{"properties":{"id":{"oneOf":[{"type":"string","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].source_ref.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].source_ref.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].source_ref.id","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].source_ref.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].source_ref.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].source_ref.model","typeLabel":"string | null"}},"type":"object","title":"Ref","description":"Technical id in the target software","isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].source_ref","typeLabel":"Ref · object"},"total":{"type":"number","title":"Total","examples":[121],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].total","typeLabel":"number"},"created_on":{"oneOf":[{"type":"string","title":"Created On","format":"date-time","example":"2026-01-15T10:30:00Z","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].created_on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created On","example":"2026-01-15T10:30:00Z","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].created_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].created_on","typeLabel":"string\u003cdate-time> | null"},"reason":{"oneOf":[{"type":"string","title":"Reason","example":"Damaged item","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reason","example":"Damaged item","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].reason","typeLabel":"string | null"},"order_lines":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the order line in Chift","examples":["\u003ccommerce-order-line-id>"],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"integer","title":"Quantity","examples":[1],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount refunded (after discount).","examples":[100],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].untaxed_amount","typeLabel":"number"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes refunded (after discount).","examples":[21],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].tax_amount","typeLabel":"number"},"total":{"type":"number","title":"Total","description":"Total refunded (after discount).","examples":[121],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].total","typeLabel":"number"},"variant":{"oneOf":[{"type":"object","title":"OrderLineProductVariantItem","description":"Product variant","required":["id","name"],"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the product variant in Chift","examples":["\u003ccommerce-variant-id>"],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","title":"Name","examples":["T-Shirt - M"],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.name","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","title":"Sku","example":"TSHIRT-M","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.sku.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sku","example":"TSHIRT-M","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.sku","typeLabel":"string | null"},"categories":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the category in Chift","examples":["\u003cthis-category-id>"],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","title":"Name","examples":["Beverages"],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"type":"object","required":["id","name"],"title":"CommerceProductCategoryItem","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX]","typeLabel":"CommerceProductCategoryItem · object"},"title":"Categories","default":[],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0","typeLabel":"CommerceProductCategoryItem · object[]"},{"type":"null","title":"Categories","default":[],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories","typeLabel":"CommerceProductCategoryItem · object[] | null"}},"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0","typeLabel":"OrderLineProductVariantItem · object"},{"type":"null","description":"Product variant","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant","typeLabel":"OrderLineProductVariantItem · object | null"}},"type":"object","required":["id","quantity","untaxed_amount","tax_amount","total"],"title":"RefundOrderLineItem","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX]","typeLabel":"RefundOrderLineItem · object"},"title":"Order Lines","default":[],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.0","typeLabel":"RefundOrderLineItem · object[]"},{"type":"null","title":"Order Lines","default":[],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].order_lines","typeLabel":"RefundOrderLineItem · object[] | null"},"other":{"oneOf":[{"type":"number","title":"Other","default":0,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other.oneOf.0","typeLabel":"number"},{"type":"null","title":"Other","default":0,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other","typeLabel":"number | null"},"shipping_refunds":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift","examples":["\u003cthis-id>"],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].id","typeLabel":"string"},"source_ref":{"properties":{"id":{"oneOf":[{"type":"string","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].source_ref.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].source_ref.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].source_ref.id","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].source_ref.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].source_ref.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].source_ref.model","typeLabel":"string | null"}},"type":"object","title":"Ref","description":"Technical id in the target software","isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].source_ref","typeLabel":"Ref · object"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount refunded (after discount).","examples":[10],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].untaxed_amount","typeLabel":"number"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes refunded (after discount).","examples":[2.1],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].tax_amount","typeLabel":"number"},"total":{"type":"number","title":"Total","description":"Total refunded (after discount).","examples":[12.1],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX].total","typeLabel":"number"}},"type":"object","required":["id","source_ref","untaxed_amount","tax_amount","total"],"title":"ShippingRefund","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0.items.[INDEX]","typeLabel":"ShippingRefund · object"},"title":"Shipping Refunds","default":[],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.0","typeLabel":"ShippingRefund · object[]"},{"type":"null","title":"Shipping Refunds","default":[],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].shipping_refunds","typeLabel":"ShippingRefund · object[] | null"},"other_fees":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the fee in Chift","examples":["\u003ccommerce-fee-id>"],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].id","typeLabel":"string"},"source_ref":{"properties":{"id":{"oneOf":[{"type":"string","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].source_ref.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].source_ref.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].source_ref.id","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].source_ref.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].source_ref.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].source_ref.model","typeLabel":"string | null"}},"type":"object","title":"Ref","description":"Technical id in the target software","isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].source_ref","typeLabel":"Ref · object"},"type":{"type":"string","enum":["shipping","other"],"title":"FeesType","isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","examples":[5],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].untaxed_amount","typeLabel":"number"},"tax_amount":{"type":"number","title":"Tax Amount","examples":[1.05],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].tax_amount","typeLabel":"number"},"total":{"type":"number","title":"Total","examples":[6.05],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX].total","typeLabel":"number"}},"type":"object","required":["id","source_ref","type","untaxed_amount","tax_amount","total"],"title":"RefundFeesItem","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0.items.[INDEX]","typeLabel":"RefundFeesItem · object"},"title":"Other Fees","default":[],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.0","typeLabel":"RefundFeesItem · object[]"},{"type":"null","title":"Other Fees","default":[],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].other_fees","typeLabel":"RefundFeesItem · object[] | null"},"transactions":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the transaction in the eCommerce","examples":["\u003ccommerce-transaction-id>"],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].id","typeLabel":"string"},"amount":{"type":"number","title":"Amount","examples":[242],"isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].amount","typeLabel":"number"},"status":{"type":"string","enum":["failed","pending","success"],"title":"CommerceTransactionStatus","isRequired":true,"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"created_on":{"oneOf":[{"type":"string","title":"Created On","format":"date-time","example":"2026-01-15T10:30:00Z","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].created_on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created On","example":"2026-01-15T10:30:00Z","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].created_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].created_on","typeLabel":"string\u003cdate-time> | null"},"payment_method_id":{"oneOf":[{"type":"string","title":"Payment Method Id","description":"Technical id of the payment method in the eCommerce","example":"\u003ccommerce-payment-method-id>","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].payment_method_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Payment Method Id","description":"Technical id of the payment method in the eCommerce","example":"\u003ccommerce-payment-method-id>","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].payment_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].payment_method_id","typeLabel":"string | null"},"payment_method_name":{"oneOf":[{"type":"string","title":"Payment Method Name","description":"Name of the payment method","example":"Credit card","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].payment_method_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Payment Method Name","description":"Name of the payment method","example":"Credit card","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].payment_method_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX].payment_method_name","typeLabel":"string | null"}},"type":"object","required":["id","amount","status"],"title":"OrderTransactions","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0.items.[INDEX]","typeLabel":"OrderTransactions · object"},"title":"Transactions","default":[],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.0","typeLabel":"OrderTransactions · object[]"},{"type":"null","title":"Transactions","default":[],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX].transactions","typeLabel":"OrderTransactions · object[] | null"}},"type":"object","required":["id","source_ref","total"],"title":"OrderRefundItem","uniqueKey":"detailed_refunds.oneOf.0.items.[INDEX]","typeLabel":"OrderRefundItem · object"},"title":"Detailed Refunds","uniqueKey":"detailed_refunds.oneOf.0","typeLabel":"OrderRefundItem · object[]"},{"type":"null","title":"Detailed Refunds","uniqueKey":"detailed_refunds.oneOf.1","typeLabel":"null"}],"uniqueKey":"detailed_refunds","typeLabel":"OrderRefundItem · object[] | null"},"returns":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the return in Chift","examples":["\u003cthis-return-id>"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].id","typeLabel":"string"},"source_ref":{"properties":{"id":{"oneOf":[{"type":"string","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"returns.oneOf.0.items.[INDEX].source_ref.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"returns.oneOf.0.items.[INDEX].source_ref.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].source_ref.id","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"returns.oneOf.0.items.[INDEX].source_ref.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"returns.oneOf.0.items.[INDEX].source_ref.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].source_ref.model","typeLabel":"string | null"}},"type":"object","title":"Ref","description":"Technical id in the target software","isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].source_ref","typeLabel":"Ref · object"},"created_on":{"oneOf":[{"type":"string","title":"Created On","format":"date-time","example":"2026-01-15T10:30:00Z","uniqueKey":"returns.oneOf.0.items.[INDEX].created_on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created On","example":"2026-01-15T10:30:00Z","uniqueKey":"returns.oneOf.0.items.[INDEX].created_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].created_on","typeLabel":"string\u003cdate-time> | null"},"order_lines":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the order line in Chift","examples":["\u003ccommerce-order-line-id>"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"integer","title":"Quantity","examples":[1],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount refunded (after discount).","examples":[100],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].untaxed_amount","typeLabel":"number"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes refunded (after discount).","examples":[21],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].tax_amount","typeLabel":"number"},"total":{"type":"number","title":"Total","description":"Total refunded (after discount).","examples":[121],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].total","typeLabel":"number"},"variant":{"oneOf":[{"type":"object","title":"OrderLineProductVariantItem","description":"Product variant","required":["id","name"],"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the product variant in Chift","examples":["\u003ccommerce-variant-id>"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","title":"Name","examples":["T-Shirt - M"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.name","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","title":"Sku","example":"TSHIRT-M","uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.sku.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sku","example":"TSHIRT-M","uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.sku","typeLabel":"string | null"},"categories":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the category in Chift","examples":["\u003cthis-category-id>"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","title":"Name","examples":["Beverages"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"type":"object","required":["id","name"],"title":"CommerceProductCategoryItem","uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX]","typeLabel":"CommerceProductCategoryItem · object"},"title":"Categories","default":[],"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0","typeLabel":"CommerceProductCategoryItem · object[]"},{"type":"null","title":"Categories","default":[],"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories","typeLabel":"CommerceProductCategoryItem · object[] | null"}},"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.0","typeLabel":"OrderLineProductVariantItem · object"},{"type":"null","description":"Product variant","uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX].variant","typeLabel":"OrderLineProductVariantItem · object | null"}},"type":"object","required":["id","quantity","untaxed_amount","tax_amount","total"],"title":"ReturnOrderLineItem","uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0.items.[INDEX]","typeLabel":"ReturnOrderLineItem · object"},"title":"Order Lines","default":[],"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.0","typeLabel":"ReturnOrderLineItem · object[]"},{"type":"null","title":"Order Lines","default":[],"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].order_lines","typeLabel":"ReturnOrderLineItem · object[] | null"},"new_lines":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the order line in Chift","examples":["\u003ccommerce-order-line-id>"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"integer","title":"Quantity","examples":[1],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount refunded (after discount).","examples":[100],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].untaxed_amount","typeLabel":"number"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes refunded (after discount).","examples":[21],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].tax_amount","typeLabel":"number"},"total":{"type":"number","title":"Total","description":"Total refunded (after discount).","examples":[121],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].total","typeLabel":"number"},"variant":{"oneOf":[{"type":"object","title":"OrderLineProductVariantItem","description":"Product variant","required":["id","name"],"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the product variant in Chift","examples":["\u003ccommerce-variant-id>"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","title":"Name","examples":["T-Shirt - M"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.name","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","title":"Sku","example":"TSHIRT-M","uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.sku.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sku","example":"TSHIRT-M","uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.sku","typeLabel":"string | null"},"categories":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the category in Chift","examples":["\u003cthis-category-id>"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","title":"Name","examples":["Beverages"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"type":"object","required":["id","name"],"title":"CommerceProductCategoryItem","uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0.items.[INDEX]","typeLabel":"CommerceProductCategoryItem · object"},"title":"Categories","default":[],"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.0","typeLabel":"CommerceProductCategoryItem · object[]"},{"type":"null","title":"Categories","default":[],"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0.categories","typeLabel":"CommerceProductCategoryItem · object[] | null"}},"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.0","typeLabel":"OrderLineProductVariantItem · object"},{"type":"null","description":"Product variant","uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX].variant","typeLabel":"OrderLineProductVariantItem · object | null"}},"type":"object","required":["id","quantity","untaxed_amount","tax_amount","total"],"title":"ReturnOrderLineItem","uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0.items.[INDEX]","typeLabel":"ReturnOrderLineItem · object"},"title":"New Lines","default":[],"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.0","typeLabel":"ReturnOrderLineItem · object[]"},{"type":"null","title":"New Lines","default":[],"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].new_lines","typeLabel":"ReturnOrderLineItem · object[] | null"},"linked_fees":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the fee in Chift","examples":["\u003ccommerce-fee-id>"],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].id","typeLabel":"string"},"source_ref":{"properties":{"id":{"oneOf":[{"type":"string","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].source_ref.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","description":"Technical id in the target software","example":"\u003ctarget-software-id>","uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].source_ref.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].source_ref.id","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].source_ref.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"Name of the model/entity in the target software","example":"invoice","uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].source_ref.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].source_ref.model","typeLabel":"string | null"}},"type":"object","title":"Ref","description":"Technical id in the target software","isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].source_ref","typeLabel":"Ref · object"},"type":{"type":"string","enum":["shipping","other"],"title":"FeesType","isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","examples":[5],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].untaxed_amount","typeLabel":"number"},"tax_amount":{"type":"number","title":"Tax Amount","examples":[1.05],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].tax_amount","typeLabel":"number"},"total":{"type":"number","title":"Total","examples":[6.05],"isRequired":true,"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX].total","typeLabel":"number"}},"type":"object","required":["id","source_ref","type","untaxed_amount","tax_amount","total"],"title":"ReturnFeesItem","uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0.items.[INDEX]","typeLabel":"ReturnFeesItem · object"},"title":"Linked Fees","default":[],"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.0","typeLabel":"ReturnFeesItem · object[]"},{"type":"null","title":"Linked Fees","default":[],"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns.oneOf.0.items.[INDEX].linked_fees","typeLabel":"ReturnFeesItem · object[] | null"}},"type":"object","required":["id","source_ref"],"title":"OrderReturnItem","uniqueKey":"returns.oneOf.0.items.[INDEX]","typeLabel":"OrderReturnItem · object"},"title":"Returns","default":[],"uniqueKey":"returns.oneOf.0","typeLabel":"OrderReturnItem · object[]"},{"type":"null","title":"Returns","default":[],"uniqueKey":"returns.oneOf.1","typeLabel":"null"}],"uniqueKey":"returns","typeLabel":"OrderReturnItem · object[] | null"}},"type":"object","required":["id","source_ref","status","discount_amount","untaxed_amount_without_fees","tax_amount_without_fees","total_without_fees","current_untaxed_amount","current_tax_amount","current_total","untaxed_amount","tax_amount","total","currency","lines"],"title":"OrderItemOut","uniqueKey":"","typeLabel":"OrderItemOut · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cthis-id>","source_ref":{"id":"\u003ctarget-software-id>","model":"invoice"},"status":"cancelled_unpaid","discount_amount":0,"untaxed_amount_without_fees":200,"tax_amount_without_fees":42,"total_without_fees":242,"current_untaxed_amount":200,"current_tax_amount":42,"current_total":242,"untaxed_amount":200,"tax_amount":42,"total":242,"currency":"EUR","lines":[{"id":"\u003cthis-id>","source_ref":{"id":"\u003ctarget-software-id>","model":"invoice"},"quantity":2,"current_quantity":2,"unit_price":100,"description":"T-Shirt - M","tax_rate":21,"untaxed_amount":200,"tax_amount":42,"total":242,"created_on":"2026-01-15T10:30:00Z","variant":{"id":"\u003ccommerce-variant-id>","name":"T-Shirt - M","sku":"TSHIRT-M","categories":[]},"tax_id":"\u003ccommerce-tax-id>","discounts":[],"gift_card":false,"is_gift":false}],"order_number":"1001","channel":"Online store","customer":{"id":"\u003cthis-customer-id>","first_name":"John","last_name":"Doe","phone":"+32 2 000 00 00","internal_notes":"Preferred contact: accounts payable team.","email":"john.doe@example.com"},"billing_address":{"address_type":"main","company_name":"Example Company S.A.","first_name":"John","last_name":"Doe","street":"Example Street","number":"123","box":"A","city":"Brussels","postal_code":"1000","country":"BE","phone":"+32 2 000 00 00","email":"john.doe@example.com","vat":"BE0000000000"},"shipping_address":{"address_type":"main","company_name":"Example Company S.A.","first_name":"John","last_name":"Doe","street":"Example Street","number":"123","box":"A","city":"Brussels","postal_code":"1000","country":"BE","phone":"+32 2 000 00 00","email":"john.doe@example.com","vat":"BE0000000000"},"created_on":"2026-01-15T10:30:00Z","last_updated_on":"2026-01-15T10:30:00Z","confirmed_on":"2026-01-15T10:30:00Z","delivery_date":"2026-02-14T10:30:00Z","cancelled_on":"2026-01-20T10:30:00Z","fulfillment":{"fulfillment_type":"FBA","shipping_from_address":{"address_type":"main","name":"\u003cstring>","number":"\u003cstring>","box":"\u003cstring>","phone":"\u003cstring>","mobile":"\u003cstring>","email":"\u003cstring>","street":"\u003cstring>","city":"\u003cstring>","postal_code":"\u003cstring>","country":"\u003cstring>"}},"refunded_amount":0,"note":"Please leave at the front door.","tags":["vip"],"other_fees":[],"payment_method_id":"\u003ccommerce-payment-method-id>","transactions":[],"payment_methods":[],"detailed_refunds":[{"id":"\u003cthis-id>","source_ref":{"id":"\u003ctarget-software-id>","model":"invoice"},"total":121,"created_on":"2026-01-15T10:30:00Z","reason":"Damaged item","order_lines":[],"other":0,"shipping_refunds":[],"other_fees":[],"transactions":[]}],"returns":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"937b0290-a6d4-4aef-8281-b5260d5e324c":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"properties":{"message":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"oneOf":[{"type":"string","title":"Status","default":"error","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status","default":"error","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"string | null"},"detail":{"oneOf":[{"type":"string","title":"Detail","default":"","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","default":"","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","title":"Error Code","uniqueKey":"error_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Error Code","uniqueKey":"error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_code","typeLabel":"string | null"}},"type":"object","required":["message"],"title":"ChiftError","uniqueKey":"","typeLabel":"ChiftError · object"},"examples":{"Example":{"title":"Example","value":{"message":"Error while trying to perform your request","status":"error"}}},"exampleType":"examples"}},"description":"Bad Request","exampleType":"examples"},"5443768a-7f64-4172-99ae-42d41dbd6da1":{"content":{"application/json":{"examples":{"ERROR_PHONE_INVALID":{"title":"ERROR_PHONE_INVALID","value":{"message":"The phone number doesnt seem to be valid. The number must begin with the country code.","status":"error","error_code":"ERROR_PHONE_INVALID"}},"ERROR_PHONE_ALREADY_USED":{"title":"ERROR_PHONE_ALREADY_USED","value":{"message":"The phone number is already used by another client.","status":"error","error_code":"ERROR_PHONE_ALREADY_USED"}}},"schema":{"properties":{"message":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"oneOf":[{"type":"string","title":"Status","default":"error","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status","default":"error","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"string | null"},"detail":{"oneOf":[{"type":"string","title":"Detail","default":"","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","default":"","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","title":"Error Code","uniqueKey":"error_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Error Code","uniqueKey":"error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_code","typeLabel":"string | null"}},"type":"object","required":["message"],"title":"ChiftError","uniqueKey":"","typeLabel":"ChiftError · object"},"exampleType":"examples"}},"description":"Unprocessable Entity","exampleType":"examples"}},"security":{"89e00bda-aac7-4b45-80b2-5de22a7c1469":{"mcp_auth":{"$ref":"4d5f18f1-b622-4001-ae86-182e5ca2fb5a","scopes":["commerce","commerce.orders","400","400.orders"]}}},"servers":{"5defdfa8-71fb-4ec4-801e-b5f74b591689":{"url":"https://api.chift.eu","description":"Chift"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"chift","siteName":"Chift","title":"Create an order - Chift","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/endpoints/ecommerce/create-an-order","matchLevel":0},"fr":{"href":"/fr/help/overview","matchLevel":4},"es":{"href":"/es/help/overview","matchLevel":4},"nl":{"href":"/nl/help/overview","matchLevel":4},"de":{"href":"/de/help/overview","matchLevel":4}}},"lastModified":"2026-09-07T12:46:32.906Z","originalFileLocation":"api-reference/endpoints/ecommerce/create-an-order.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a new customer order in the e-commerce system and returns the created order record.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Chift\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an order - Chift\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new customer order in the e-commerce system and returns the created order record.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chift\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chift.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+an+order\u0026amp;description=Creates+a+new+customer+order+in+the+e-commerce+system+and+returns+the+created+order+record.\u0026amp;theme=f033b722e138919620599cda\u0026amp;signature=766639c840499754bb44cd8eaedde20187d5cca9ee0e886bc0c47bf11bc09841\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create an order - Chift\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new customer order in the e-commerce system and returns the created order record.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chift.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+an+order\u0026amp;description=Creates+a+new+customer+order+in+the+e-commerce+system+and+returns+the+created+order+record.\u0026amp;theme=f033b722e138919620599cda\u0026amp;signature=766639c840499754bb44cd8eaedde20187d5cca9ee0e886bc0c47bf11bc09841\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chift\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#04C28F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/ecommerce/create-an-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.chift.eu/#organization\",\"name\":\"Chift\",\"url\":\"https://docs.chift.eu\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chift/SsdLyPJfpLncQDvV/logo/light.svg?fit=max\u0026auto=format\u0026n=SsdLyPJfpLncQDvV\u0026q=85\u0026s=b43848bb528c7d184e769b3f620b6a3b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.chift.eu#website\",\"name\":\"Chift\",\"url\":\"https://docs.chift.eu\",\"publisher\":{\"@id\":\"https://docs.chift.eu/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order#webpage\",\"url\":\"https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order\",\"name\":\"Create an order\",\"description\":\"Creates a new customer order in the e-commerce system and returns the created order record.\",\"dateModified\":\"2026-09-07T12:46:32.906Z\",\"isPartOf\":{\"@id\":\"https://docs.chift.eu#website\"},\"breadcrumb\":{\"@id\":\"https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"eCommerce\",\"item\":\"https://docs.chift.eu/api-reference/endpoints/ecommerce/get-all-orders\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Orders\",\"item\":\"https://docs.chift.eu/api-reference/endpoints/ecommerce/get-all-orders\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create an order\",\"item\":\"https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order#apireference\",\"headline\":\"Create an order\",\"name\":\"Create an order\",\"description\":\"Creates a new customer order in the e-commerce system and returns the created order record.\",\"url\":\"https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order#webpage\"},\"dateModified\":\"2026-09-07T12:46:32.906Z\",\"publisher\":{\"@id\":\"https://docs.chift.eu/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.chift.eu#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chift\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Chift","nav":{"global":null,"languages":[{"language":"en","default":true,"dropdowns":[{"dropdown":"Developer Documentation","icon":"book-open","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Unified APIs","pages":[{"title":"Unified APIs","href":"/unified-apis/overview"}]},{"tab":"Syncs","pages":[{"title":"Syncs","href":"/syncs/overview"}]},{"tab":"API Reference","groups":[{"group":"API Reference Overview","pages":[{"title":null,"href":"/api-reference/overview"}]},{"group":"Access \u0026 Connections","pages":[{"group":"Authentication","pages":[{"openapi":"post /token","title":"Get access token","href":"/api-reference/endpoints/general/get-access-token"}]},{"group":"Consumers","pages":[{"openapi":"post /consumers","title":"Create new consumer","href":"/api-reference/endpoints/consumers/create-new-consumer"},{"openapi":"get /consumers/{consumer_id}","title":"Get one consumer","href":"/api-reference/endpoints/consumers/get-one-consumer"},{"openapi":"get /consumers","title":"Get consumers","href":"/api-reference/endpoints/consumers/get-consumers"},{"openapi":"patch /consumers/{consumer_id}","title":"Update one consumer","href":"/api-reference/endpoints/consumers/update-one-consumer"},{"openapi":"delete /consumers/{consumer_id}","title":"Delete one consumer","href":"/api-reference/endpoints/consumers/delete-one-consumer"}]},{"group":"Connections","pages":[{"openapi":"post /consumers/{consumer_id}/connections","title":"Add new connection","href":"/api-reference/endpoints/connections/add-new-connection"},{"openapi":"get /consumers/{consumer_id}/connections/{connectionid}","title":"Get one connection","href":"/api-reference/endpoints/connections/get-one-connection"},{"openapi":"get /consumers/{consumer_id}/connections","title":"Get connections","href":"/api-reference/endpoints/connections/get-connections"},{"openapi":"patch /consumers/{consumer_id}/connections/{connectionid}","title":"Update an existing connection","href":"/api-reference/endpoints/connections/update-an-existing-connection"},{"openapi":"delete /consumers/{consumer_id}/connections/{connectionid}","title":"Delete one connection","href":"/api-reference/endpoints/connections/delete-one-connection"}]},{"group":"Integrations","pages":[{"openapi":"get /integrations","title":"Get list of integrations","href":"/api-reference/endpoints/integrations/get-list-of-integrations"},{"openapi":"get /integrations/{integrationid}","title":"Get one integration","href":"/api-reference/endpoints/integrations/get-one-integration"},{"openapi":"get /integrations/{integrationid}/{image_type}.json","title":"Get integration logo/icon (as base64)","href":"/api-reference/endpoints/integrations/get-integration-logoicon-as-base64"}]}]},{"group":"Accounting","pages":[{"group":"Folders","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/folders","title":"Get folders","href":"/api-reference/endpoints/accounting/get-folders"},{"openapi":"get /consumers/{consumer_id}/accounting/folders/{folder_id}","title":"Get one folder","href":"/api-reference/endpoints/accounting/get-one-folder"}]},{"group":"Book years","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/bookyears","title":"Get book years","href":"/api-reference/endpoints/accounting/get-book-years"}]},{"group":"Clients","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/clients","title":"Create client","href":"/api-reference/endpoints/accounting/create-client"},{"openapi":"get /consumers/{consumer_id}/accounting/clients/{client_id}","title":"Get one client","href":"/api-reference/endpoints/accounting/get-one-client"},{"openapi":"get /consumers/{consumer_id}/accounting/clients","title":"Get clients","href":"/api-reference/endpoints/accounting/get-clients"},{"openapi":"patch /consumers/{consumer_id}/accounting/clients/{client_id}","title":"Update client","href":"/api-reference/endpoints/accounting/update-client"}]},{"group":"Suppliers","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/suppliers","title":"Create supplier","href":"/api-reference/endpoints/accounting/create-supplier"},{"openapi":"get /consumers/{consumer_id}/accounting/suppliers/{supplier_id}","title":"Get one supplier","href":"/api-reference/endpoints/accounting/get-one-supplier"},{"openapi":"get /consumers/{consumer_id}/accounting/suppliers","title":"Get suppliers","href":"/api-reference/endpoints/accounting/get-suppliers"},{"openapi":"patch /consumers/{consumer_id}/accounting/suppliers/{supplier_id}","title":"Update one supplier","href":"/api-reference/endpoints/accounting/update-one-supplier"}]},{"group":"Invoices","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/invoices","title":"Create sale/purchase entry","href":"/api-reference/endpoints/accounting/create-salepurchase-entry"},{"openapi":"post /consumers/{consumer_id}/accounting/invoices/multi-analytic-plans","title":"Create sale/purchase entry (Multiple plans)","href":"/api-reference/endpoints/accounting/create-salepurchase-entry-multiple-plans"},{"openapi":"get /consumers/{consumer_id}/accounting/invoices/type/{invoice_type}","title":"Get invoices by type (sale/purchase entries)","href":"/api-reference/endpoints/accounting/get-invoices-by-type-salepurchase-entries"},{"openapi":"get /consumers/{consumer_id}/accounting/invoices/{invoice_id}","title":"Get one invoice (sale/purchase entry)","href":"/api-reference/endpoints/accounting/get-one-invoice-salepurchase-entry"},{"openapi":"get /consumers/{consumer_id}/accounting/invoices/multi-analytic-plans/{invoice_id}","title":"Get one invoice (sale/purchase entry - Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/get-one-invoice-salepurchase-entry--multiple-analytic-plans"},{"openapi":"get /consumers/{consumer_id}/accounting/invoices/multi-analytic-plans/type/{invoice_type}","title":"Get invoices by type (sale/purchase entries - Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/get-invoices-by-type-salepurchase-entries--multiple-analytic-plans"},{"openapi":"post /consumers/{consumer_id}/accounting/invoices/payments","title":"Create an invoice payment","href":"/api-reference/endpoints/accounting/create-an-invoice-payment"},{"openapi":"get /consumers/{consumer_id}/accounting/payment-methods","title":"Get payment methods","href":"/api-reference/endpoints/accounting/get-payment-methods"},{"openapi":"get /consumers/{consumer_id}/accounting/payment-terms","title":"Get payment terms","href":"/api-reference/endpoints/accounting/get-payment-terms"}]},{"group":"Banking","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/bank-accounts","title":"Create bank account","href":"/api-reference/endpoints/accounting/create-bank-account"},{"openapi":"get /consumers/{consumer_id}/accounting/bank-accounts","title":"Get bank accounts","href":"/api-reference/endpoints/accounting/get-bank-accounts"},{"openapi":"post /consumers/{consumer_id}/accounting/bank-transactions","title":"Create bank transactions","href":"/api-reference/endpoints/accounting/create-bank-transactions"}]},{"group":"Ledger accounts","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/accounts","title":"Create ledger account","href":"/api-reference/endpoints/accounting/create-ledger-account"},{"openapi":"get /consumers/{consumer_id}/accounting/chart-of-accounts","title":"Get chart of accounts","href":"/api-reference/endpoints/accounting/get-chart-of-accounts"},{"openapi":"post /consumers/{consumer_id}/accounting/chart-of-accounts/balance","title":"Get the balance of accounts","href":"/api-reference/endpoints/accounting/get-the-balance-of-accounts"}]},{"group":"Journals","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/journal","title":"Create journal","href":"/api-reference/endpoints/accounting/create-journal"},{"openapi":"get /consumers/{consumer_id}/accounting/journals","title":"Get journals","href":"/api-reference/endpoints/accounting/get-journals"}]},{"group":"Journal entries","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/journal-entries","title":"Create Journal Entry","href":"/api-reference/endpoints/accounting/create-journal-entry"},{"openapi":"post /consumers/{consumer_id}/accounting/financial-entries","title":"Create a financial entry","href":"/api-reference/endpoints/accounting/create-a-financial-entry"},{"openapi":"get /consumers/{consumer_id}/accounting/journal/entries","title":"Get journal entries","href":"/api-reference/endpoints/accounting/get-journal-entries"},{"openapi":"get /consumers/{consumer_id}/accounting/journal/entries/multi-analytic-plans","title":"Get journal entries (Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/get-journal-entries-multiple-analytic-plans"},{"openapi":"get /consumers/{consumer_id}/accounting/journal/entries/{journal_entry_id}","title":"Get one journal entry","href":"/api-reference/endpoints/accounting/get-one-journal-entry"},{"openapi":"post /consumers/{consumer_id}/accounting/matching","title":"Match entries","href":"/api-reference/endpoints/accounting/match-entries"}]},{"group":"Expenses","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/expenses","deprecated":true,"title":"Create an expense","href":"/api-reference/endpoints/accounting/create-an-expense"}]},{"group":"Employees","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/employees","title":"Get employees","href":"/api-reference/endpoints/accounting/get-employees"}]},{"group":"Analytic plans","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/analytic-plans","title":"Get analytic plans","href":"/api-reference/endpoints/accounting/get-analytic-plans"}]},{"group":"Analytic accounts","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/analytic-accounts","title":"Create analytic account","href":"/api-reference/endpoints/accounting/create-analytic-account"},{"openapi":"post /consumers/{consumer_id}/accounting/analytic-accounts/multi-analytic-plans/{analytic_plan}","title":"Create analytic account (Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/create-analytic-account-multiple-analytic-plans"},{"openapi":"get /consumers/{consumer_id}/accounting/analytic-accounts","title":"Get analytic accounts","href":"/api-reference/endpoints/accounting/get-analytic-accounts"},{"openapi":"get /consumers/{consumer_id}/accounting/analytic-accounts/{analytic_account_id}","title":"Get analytic account","href":"/api-reference/endpoints/accounting/get-analytic-account"},{"openapi":"patch /consumers/{consumer_id}/accounting/analytic-accounts/{analytic_account_id}","title":"Update analytic account","href":"/api-reference/endpoints/accounting/update-analytic-account"},{"openapi":"get /consumers/{consumer_id}/accounting/analytic-accounts/{analytic_account_id}/multi-analytic-plans/{analytic_plan}","title":"Get analytic account (Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/get-analytic-account-multiple-analytic-plans"},{"openapi":"patch /consumers/{consumer_id}/accounting/analytic-accounts/{analytic_account_id}/multi-analytic-plans/{analytic_plan}","title":"Update analytic account (Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/update-analytic-account-multiple-analytic-plans"},{"openapi":"get /consumers/{consumer_id}/accounting/analytic-accounts/multi-analytic-plans","title":"Get analytic accounts (Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/get-analytic-accounts-multiple-analytic-plans"}]},{"group":"Outstandings","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/outstandings","title":"Get clients/suppliers outstanding items","href":"/api-reference/endpoints/accounting/get-clientssuppliers-outstanding-items"}]},{"group":"VAT codes","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/vat-codes","title":"Get vat codes","href":"/api-reference/endpoints/accounting/get-vat-codes"}]},{"group":"Attachments","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/invoices/pdf/{invoice_id}","title":"Attach a document (PDF)","href":"/api-reference/endpoints/accounting/attach-a-document-pdf"},{"openapi":"get /consumers/{consumer_id}/accounting/attachments","title":"Get attachments","href":"/api-reference/endpoints/accounting/get-attachments"}]},{"group":"Exports","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/export-fec","title":"Export entries in FEC format","href":"/api-reference/endpoints/accounting/export-entries-in-fec-format"}]}]},{"group":"Invoicing","pages":[{"group":"Contacts","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/contacts/{contact_id}","title":"Retrieve one contact","href":"/api-reference/endpoints/invoicing/retrieve-one-contact"},{"openapi":"get /consumers/{consumer_id}/invoicing/contacts","title":"Retrieve all contacts","href":"/api-reference/endpoints/invoicing/retrieve-all-contacts"},{"openapi":"post /consumers/{consumer_id}/invoicing/contacts","title":"Create a contact","href":"/api-reference/endpoints/invoicing/create-a-contact"}]},{"group":"Invoices","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/invoices/{invoice_id}","title":"Retrieve one invoice","href":"/api-reference/endpoints/invoicing/retrieve-one-invoice"},{"openapi":"get /consumers/{consumer_id}/invoicing/invoices","title":"Retrieve all invoices","href":"/api-reference/endpoints/invoicing/retrieve-all-invoices"},{"openapi":"post /consumers/{consumer_id}/invoicing/invoices","title":"Create an invoice","href":"/api-reference/endpoints/invoicing/create-an-invoice"},{"openapi":"post /consumers/{consumer_id}/invoicing/upload-document","title":"Upload a document (PDF)","href":"/api-reference/endpoints/invoicing/upload-a-document-pdf"}]},{"group":"Products","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/products/{product_id}","title":"Retrieve one product","href":"/api-reference/endpoints/invoicing/retrieve-one-product"},{"openapi":"get /consumers/{consumer_id}/invoicing/products","title":"Retrieve all products","href":"/api-reference/endpoints/invoicing/retrieve-all-products"},{"openapi":"post /consumers/{consumer_id}/invoicing/products","title":"Create a product","href":"/api-reference/endpoints/invoicing/create-a-product"}]},{"group":"Taxes","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/taxes/{tax_id}","title":"Retrieve one tax","href":"/api-reference/endpoints/invoicing/retrieve-one-tax"},{"openapi":"get /consumers/{consumer_id}/invoicing/taxes","title":"Retrieve all taxes","href":"/api-reference/endpoints/invoicing/retrieve-all-taxes"}]},{"group":"Opportunities","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}","title":"Retrieve one opportunity","href":"/api-reference/endpoints/invoicing/retrieve-one-opportunity"},{"openapi":"get /consumers/{consumer_id}/invoicing/opportunities","title":"Retrieve all opportunities","href":"/api-reference/endpoints/invoicing/retrieve-all-opportunities"}]},{"group":"Payments","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/payments","title":"Retrieve all payments (invoicing)","href":"/api-reference/endpoints/invoicing/retrieve-all-payments-invoicing"}]},{"group":"Payment methods","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/payment-methods","title":"Retrieve all payment methods","href":"/api-reference/endpoints/invoicing/retrieve-all-payment-methods"}]},{"group":"Bank Accounts","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/bank-accounts","title":"Retrieve all Bank Accounts","href":"/api-reference/endpoints/invoicing/retrieve-all-bank-accounts"}]},{"group":"Bank Transactions","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/bank-transactions","title":"Retrieve all Bank Transactions","href":"/api-reference/endpoints/invoicing/retrieve-all-bank-transactions"}]}]},{"group":"POS","pages":[{"group":"Orders","pages":[{"openapi":"get /consumers/{consumer_id}/pos/orders","title":"Get orders","href":"/api-reference/endpoints/point-of-sale/get-orders"},{"openapi":"get /consumers/{consumer_id}/pos/orders/{order_id}","title":"Get one order","href":"/api-reference/endpoints/point-of-sale/get-one-order"},{"openapi":"get /consumers/{consumer_id}/pos/sales","title":"Get sales","href":"/api-reference/endpoints/point-of-sale/get-sales"},{"openapi":"patch /consumers/{consumer_id}/pos/orders/{order_id}","title":"Update order","href":"/api-reference/endpoints/point-of-sale/update-order"}]},{"group":"Payment methods","pages":[{"openapi":"get /consumers/{consumer_id}/pos/payment-methods","title":"Get payment methods (POS)","href":"/api-reference/endpoints/point-of-sale/get-payment-methods-pos"}]},{"group":"Payments","pages":[{"openapi":"get /consumers/{consumer_id}/pos/payments","title":"Get payments","href":"/api-reference/endpoints/point-of-sale/get-payments"}]},{"group":"Closure / Report","pages":[{"openapi":"get /consumers/{consumer_id}/pos/closures/{date}","title":"Get closure info for a specific day","href":"/api-reference/endpoints/point-of-sale/get-closure-info-for-a-specific-day"},{"openapi":"get /consumers/{consumer_id}/pos/report","title":"Get report for a specific date (E-reporting)","href":"/api-reference/endpoints/point-of-sale/get-report-for-a-specific-date-e-reporting"}]},{"group":"Locations","pages":[{"openapi":"get /consumers/{consumer_id}/pos/locations","title":"Get locations","href":"/api-reference/endpoints/point-of-sale/get-locations"}]},{"group":"Products","pages":[{"openapi":"get /consumers/{consumer_id}/pos/products","title":"Get products","href":"/api-reference/endpoints/point-of-sale/get-products"},{"openapi":"get /consumers/{consumer_id}/pos/modifiers","title":"Get Modifiers","href":"/api-reference/endpoints/point-of-sale/get-modifiers"}]},{"group":"Categories","pages":[{"openapi":"get /consumers/{consumer_id}/pos/product-categories","title":"Get product categories","href":"/api-reference/endpoints/point-of-sale/get-product-categories"},{"openapi":"get /consumers/{consumer_id}/pos/accounting-categories","title":"Get accounting categories","href":"/api-reference/endpoints/point-of-sale/get-accounting-categories"}]},{"group":"Customers","pages":[{"openapi":"get /consumers/{consumer_id}/pos/customers","title":"Get customers","href":"/api-reference/endpoints/point-of-sale/get-customers"},{"openapi":"get /consumers/{consumer_id}/pos/customers/{customer_id}","title":"Get one customer","href":"/api-reference/endpoints/point-of-sale/get-one-customer"},{"openapi":"post /consumers/{consumer_id}/pos/customers","title":"Create one customer","href":"/api-reference/endpoints/point-of-sale/create-one-customer"}]},{"group":"Objectives","pages":[{"openapi":"get /consumers/{consumer_id}/pos/objectives","title":"Get objectives","href":"/api-reference/endpoints/point-of-sale/get-objectives"}]},{"group":"Taxes","pages":[{"openapi":"get /consumers/{consumer_id}/pos/tax-rates","title":"Get tax rates (POS)","href":"/api-reference/endpoints/point-of-sale/get-tax-rates-pos"}]}]},{"group":"eCommerce","pages":[{"group":"Orders","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/orders","title":"Get all orders","href":"/api-reference/endpoints/ecommerce/get-all-orders"},{"openapi":"get /consumers/{consumer_id}/commerce/orders/{order_id}","title":"Get one specific order","description":"Returns a specific order from the e-commerce system by its unique identifier.","href":"/api-reference/endpoints/ecommerce/get-one-specific-order"},{"openapi":"post /consumers/{consumer_id}/commerce/orders","title":"Create an order","href":"/api-reference/endpoints/ecommerce/create-an-order"}]},{"group":"Products \u0026 variants","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/products","title":"Get all products","description":"Returns the list of all products available in the e-commerce catalog, optionally filtered.","href":"/api-reference/endpoints/ecommerce/get-all-products"},{"openapi":"get /consumers/{consumer_id}/commerce/products/{product_id}","title":"Get one specific product","href":"/api-reference/endpoints/ecommerce/get-one-specific-product"},{"openapi":"get /consumers/{consumer_id}/commerce/variants/{variant_id}","title":"Get one specific product variant","href":"/api-reference/endpoints/ecommerce/get-one-specific-product-variant"},{"openapi":"post /consumers/{consumer_id}/commerce/variants/set_quantity/{variant_id}","title":"Update available quantity","href":"/api-reference/endpoints/ecommerce/update-available-quantity"}]},{"group":"Categories","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/product-categories","title":"Get all product categories","href":"/api-reference/endpoints/ecommerce/get-all-product-categories"}]},{"group":"Customers","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/customers","title":"Get all customers","href":"/api-reference/endpoints/ecommerce/get-all-customers"},{"openapi":"get /consumers/{consumer_id}/commerce/customers/{customer_id}","title":"Get one specific customer","href":"/api-reference/endpoints/ecommerce/get-one-specific-customer"}]},{"group":"Payment methods","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/payment-methods","title":"Get all payment methods","href":"/api-reference/endpoints/ecommerce/get-all-payment-methods"}]},{"group":"Locations","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/locations","title":"Get all locations","href":"/api-reference/endpoints/ecommerce/get-all-locations"}]},{"group":"Countries","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/countries","title":"Get all countries","href":"/api-reference/endpoints/ecommerce/get-all-countries"}]},{"group":"Taxes","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/taxes","title":"Get all tax rates","href":"/api-reference/endpoints/ecommerce/get-all-tax-rates"}]}]},{"group":"PMS","pages":[{"group":"Orders","pages":[{"openapi":"get /consumers/{consumer_id}/pms/orders","title":"Get orders (PMS)","href":"/api-reference/endpoints/property-management-system/get-orders-pms"}]},{"group":"Invoices","pages":[{"openapi":"get /consumers/{consumer_id}/pms/invoices","title":"Get invoices (PMS)","href":"/api-reference/endpoints/property-management-system/get-invoices-pms"}]},{"group":"Payment methods","pages":[{"openapi":"get /consumers/{consumer_id}/pms/payment-methods","title":"Get payment methods (PMS)","href":"/api-reference/endpoints/property-management-system/get-payment-methods-pms"}]},{"group":"Payments","pages":[{"openapi":"get /consumers/{consumer_id}/pms/payments","title":"Get payments (PMS)","href":"/api-reference/endpoints/property-management-system/get-payments-pms"}]},{"group":"Closure info","pages":[{"openapi":"get /consumers/{consumer_id}/pms/closures/{date}","title":"Get closure info for a specific day (PMS)","href":"/api-reference/endpoints/property-management-system/get-closure-info-for-a-specific-day-pms"}]},{"group":"Locations","pages":[{"openapi":"get /consumers/{consumer_id}/pms/locations","title":"Get locations (PMS)","href":"/api-reference/endpoints/property-management-system/get-locations-pms"}]},{"group":"Categories","pages":[{"openapi":"get /consumers/{consumer_id}/pms/accounting-categories","title":"Get accounting categories (PMS)","href":"/api-reference/endpoints/property-management-system/get-accounting-categories-pms"}]},{"group":"Customers","pages":[{"openapi":"get /consumers/{consumer_id}/pms/customers","title":"Get customers (PMS)","href":"/api-reference/endpoints/property-management-system/get-customers-pms"}]},{"group":"Taxes","pages":[{"openapi":"get /consumers/{consumer_id}/pms/taxes","title":"Get tax rates (PMS)","href":"/api-reference/endpoints/property-management-system/get-tax-rates-pms"}]},{"group":"Accounting transactions","pages":[{"openapi":"get /consumers/{consumer_id}/pms/accounting-transactions","title":"Get the accounting transactions (PMS)","href":"/api-reference/endpoints/property-management-system/get-the-accounting-transactions-pms"}]}]},{"group":"Payment","pages":[{"group":"Payments","pages":[{"openapi":"get /consumers/{consumer_id}/payment/payments/{payment_id}","title":"Get a payment","href":"/api-reference/endpoints/payment/get-a-payment"},{"openapi":"get /consumers/{consumer_id}/payment/payments","title":"Retrieve all payments","href":"/api-reference/endpoints/payment/retrieve-all-payments"}]},{"group":"Balances","pages":[{"openapi":"get /consumers/{consumer_id}/payment/balances","title":"Retrieve all balances","href":"/api-reference/endpoints/payment/retrieve-all-balances"}]},{"group":"Transactions","pages":[{"openapi":"get /consumers/{consumer_id}/payment/transactions","title":"Retrieve all transactions","href":"/api-reference/endpoints/payment/retrieve-all-transactions"}]},{"group":"Refunds","pages":[{"openapi":"get /consumers/{consumer_id}/payment/refunds","title":"Retrieve all refunds","href":"/api-reference/endpoints/payment/retrieve-all-refunds"}]}]},{"group":"Banking","pages":[{"group":"Financial institutions","pages":[{"openapi":"get /consumers/{consumer_id}/banking/financial-institutions","title":"Get list of financial institutions","href":"/api-reference/endpoints/banking/get-list-of-financial-institutions"}]},{"group":"Banking accounts","pages":[{"openapi":"get /consumers/{consumer_id}/banking/accounts","title":"Get list of banking accounts","href":"/api-reference/endpoints/banking/get-list-of-banking-accounts"},{"openapi":"get /consumers/{consumer_id}/banking/counterparts","title":"Get aggregated list of account counterparts found in transactions","href":"/api-reference/endpoints/banking/get-aggregated-list-of-account-counterparts-found-in-transactions"}]},{"group":"Transactions","pages":[{"openapi":"get /consumers/{consumer_id}/banking/transactions","title":"Get list of financial transactions","href":"/api-reference/endpoints/banking/get-list-of-financial-transactions"}]}]},{"group":"Spend Management","pages":[{"group":"Legal entities","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/legal-entities","title":"Retrieve legal entities available to this connection","href":"/api-reference/endpoints/spend-management/retrieve-legal-entities-available-to-this-connection"}]},{"group":"Ledger accounts","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/ledger-accounts","title":"Retrieve the chart of accounts","href":"/api-reference/endpoints/spend-management/retrieve-the-chart-of-accounts"},{"openapi":"post /consumers/{consumer_id}/spend_management/ledger-accounts","title":"Create ledger account","href":"/api-reference/endpoints/spend-management/create-ledger-account"},{"openapi":"patch /consumers/{consumer_id}/spend_management/ledger-accounts/{ledger_account_id}","title":"Update ledger account","href":"/api-reference/endpoints/spend-management/update-ledger-account"}]},{"group":"Tax codes","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/tax-codes","title":"Retrieve all tax codes","href":"/api-reference/endpoints/spend-management/retrieve-all-tax-codes"},{"openapi":"post /consumers/{consumer_id}/spend_management/tax-codes","title":"Create tax code","href":"/api-reference/endpoints/spend-management/create-tax-code"},{"openapi":"patch /consumers/{consumer_id}/spend_management/tax-codes/{tax_code_id}","title":"Update tax code","href":"/api-reference/endpoints/spend-management/update-tax-code"}]},{"group":"Analytical plans","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/analytical-plans","title":"Retrieve all analytical plans (cost centers, projects, ...)","href":"/api-reference/endpoints/spend-management/retrieve-all-analytical-plans-cost-centers-projects-"},{"openapi":"post /consumers/{consumer_id}/spend_management/analytical-plans","title":"Create an analytical plan","href":"/api-reference/endpoints/spend-management/create-an-analytical-plan"},{"openapi":"patch /consumers/{consumer_id}/spend_management/analytical-plans/{analytical_plan_id}","title":"Update an analytical plan","href":"/api-reference/endpoints/spend-management/update-an-analytical-plan"}]},{"group":"Analytic accounts","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/analytic-accounts","title":"Retrieve the values of the analytical plans","href":"/api-reference/endpoints/spend-management/retrieve-the-values-of-the-analytical-plans"},{"openapi":"get /consumers/{consumer_id}/spend_management/analytic-accounts/{analytic_account_id}/analytic-plans/{analytic_plan}","title":"Get one analytic account","href":"/api-reference/endpoints/spend-management/get-one-analytic-account"},{"openapi":"post /consumers/{consumer_id}/spend_management/analytic-accounts/analytic-plans/{analytic_plan}","title":"Create analytic account","href":"/api-reference/endpoints/spend-management/create-analytic-account"},{"openapi":"patch /consumers/{consumer_id}/spend_management/analytic-accounts/{analytic_account_id}/analytic-plans/{analytic_plan}","title":"Update analytic account","href":"/api-reference/endpoints/spend-management/update-analytic-account"}]},{"group":"Payables","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/payables","title":"Retrieve payables (supplier invoices, supplier refunds, or card purchases)","href":"/api-reference/endpoints/spend-management/retrieve-payables-supplier-invoices-supplier-refunds-or-card-purchases"},{"openapi":"get /consumers/{consumer_id}/spend_management/payables/{payable_id}","title":"Get one payable","href":"/api-reference/endpoints/spend-management/get-one-payable"},{"openapi":"patch /consumers/{consumer_id}/spend_management/payables/{payable_id}/mark-as-exported","title":"Mark one payable as exported","href":"/api-reference/endpoints/spend-management/mark-one-payable-as-exported"}]},{"group":"Financial movements","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/financial-movements","title":"Retrieve all financial movements (payments, refunds, reimbursements, ...)","href":"/api-reference/endpoints/spend-management/retrieve-all-financial-movements-payments-refunds-reimbursements-"},{"openapi":"patch /consumers/{consumer_id}/spend_management/financial-movements/{financial_movement_id}/mark-as-exported","title":"Mark one financial movement as exported","href":"/api-reference/endpoints/spend-management/mark-one-financial-movement-as-exported"}]},{"group":"Suppliers","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/suppliers","title":"Retrieve all suppliers/vendors","href":"/api-reference/endpoints/spend-management/retrieve-all-suppliersvendors"},{"openapi":"get /consumers/{consumer_id}/spend_management/suppliers/{supplier_id}","title":"Get one supplier/vendor","href":"/api-reference/endpoints/spend-management/get-one-suppliervendor"},{"openapi":"post /consumers/{consumer_id}/spend_management/suppliers","title":"Create supplier/vendor","href":"/api-reference/endpoints/spend-management/create-suppliervendor"},{"openapi":"patch /consumers/{consumer_id}/spend_management/suppliers/{supplier_id}","title":"Update supplier/vendor","href":"/api-reference/endpoints/spend-management/update-suppliervendor"}]},{"group":"Employees","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/employees","title":"Retrieve all employees","href":"/api-reference/endpoints/spend-management/retrieve-all-employees"}]}]},{"group":"Other","pages":[{"group":"API transactions","pages":[{"openapi":"get /consumers/{consumer_id}/connections/{connection_id}/transactions","title":"Get transaction information","href":"/api-reference/endpoints/connections/get-transaction-information"}]},{"group":"Webhooks","pages":[{"openapi":"post /webhooks","title":"Add new webhook instance","href":"/api-reference/endpoints/webhooks/add-new-webhook-instance"},{"openapi":"get /webhooks/{webhookid}","title":"Get one webhook instance","href":"/api-reference/endpoints/webhooks/get-one-webhook-instance"},{"openapi":"get /webhooks","title":"Get list of webhook instances","href":"/api-reference/endpoints/webhooks/get-list-of-webhook-instances"},{"openapi":"patch /webhooks/{webhookid}","title":"Update one webhook","href":"/api-reference/endpoints/webhooks/update-one-webhook"},{"openapi":"delete /webhooks/{webhookid}","title":"Delete one webhook","href":"/api-reference/endpoints/webhooks/delete-one-webhook"},{"openapi":"get /webhooks/list","title":"Get list of possible webhooks","href":"/api-reference/endpoints/webhooks/get-list-of-possible-webhooks"},{"openapi":"get /webhooks/{webhookid}/logs","title":"Get list of webhook logs for one webhook","href":"/api-reference/endpoints/webhooks/get-list-of-webhook-logs-for-one-webhook"}]},{"group":"Syncs","pages":[{"openapi":"get /syncs","title":"Get syncs","href":"/api-reference/endpoints/syncs/get-syncs"},{"openapi":"get /syncs/{syncid}","title":"Get sync","href":"/api-reference/endpoints/syncs/get-sync"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}","title":"Get sync information for one consumer","href":"/api-reference/endpoints/consumers/get-sync-information-for-one-consumer"},{"openapi":"post /consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable","title":"Enable a flow for a specific consumer","href":"/api-reference/endpoints/syncs/enable-a-flow-for-a-specific-consumer"},{"openapi":"post /syncs/{syncid}/flows/{flowid}/event","deprecated":true,"title":"Send a custom event for a specific flow (deprecated)","href":"/api-reference/endpoints/syncs/send-a-custom-event-for-a-specific-flow-deprecated"},{"openapi":"get /syncs/{syncid}/flows/{flowid}/executions/{executionid}","title":"Get execution details","href":"/api-reference/endpoints/syncs/get-execution-details"},{"openapi":"get /consumers/{consumer_id}/datastore/{datastoreid}/data","title":"Get execution data for a specific consumer and a specific datastore","href":"/api-reference/endpoints/consumers/get-execution-data-for-a-specific-consumer-and-a-specific-datastore"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/executions","title":"Get executions information for one consumer/flow/sync","href":"/api-reference/endpoints/consumers/get-executions-information-for-one-consumerflowsync"},{"openapi":"get /syncs/{syncid}/executions","title":"Get executions for a sync","href":"/api-reference/endpoints/syncs/get-executions-for-a-sync"},{"openapi":"patch /consumers/{consumer_id}/syncs/{syncid}","title":"Update flow mappings for a specific consumer","href":"/api-reference/endpoints/syncs/update-flow-mappings-for-a-specific-consumer"},{"openapi":"patch /consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}","title":"Update flow settings for a specific consumer","href":"/api-reference/endpoints/syncs/update-flow-settings-for-a-specific-consumer"},{"openapi":"post /consumers/{consumer_id}/syncs","title":"Retrieve the url of a sync for a specific consumer","href":"/api-reference/endpoints/consumers/retrieve-the-url-of-a-sync-for-a-specific-consumer"}]},{"group":"Agentic syncs","pages":[{"openapi":"get /syncs/{syncid}/capabilities","title":"Capabilities of an agentic sync, and which your consumers are offered","href":"/api-reference/endpoints/syncs/capabilities-of-an-agentic-sync-and-which-your-consumers-are-offered"},{"openapi":"put /syncs/{syncid}/capabilities","title":"Choose which capabilities your consumers are offered","href":"/api-reference/endpoints/syncs/choose-which-capabilities-your-consumers-are-offered"},{"openapi":"get /syncs/{syncid}/integrations","title":"Integrations a consumer can connect to an agentic sync","href":"/api-reference/endpoints/syncs/integrations-a-consumer-can-connect-to-an-agentic-sync"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/capabilities","title":"A consumer's setup of an agentic sync","href":"/api-reference/endpoints/syncs/a-consumers-setup-of-an-agentic-sync"},{"openapi":"put /consumers/{consumer_id}/syncs/{syncid}/capabilities","title":"Choose a consumer's capabilities and modes","href":"/api-reference/endpoints/syncs/choose-a-consumers-capabilities-and-modes"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/journey","title":"Where a consumer stands in setting up an agentic sync","href":"/api-reference/endpoints/syncs/where-a-consumer-stands-in-setting-up-an-agentic-sync"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/questions","title":"Questions a consumer's capabilities ask, with their answers","href":"/api-reference/endpoints/syncs/questions-a-consumers-capabilities-ask-with-their-answers"},{"openapi":"patch /consumers/{consumer_id}/syncs/{syncid}/questions","title":"Answer a consumer's questions","href":"/api-reference/endpoints/syncs/answer-a-consumers-questions"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/mappings","title":"The mapping tables a consumer's sync needs","href":"/api-reference/endpoints/syncs/the-mapping-tables-a-consumers-sync-needs"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/mappings/{table_key}","title":"One mapping table of a consumer: its rows, values and candidates","href":"/api-reference/endpoints/syncs/one-mapping-table-of-a-consumer:-its-rows-values-and-candidates"},{"openapi":"post /consumers/{consumer_id}/syncs/{syncid}/ai-fill","title":"Fill a consumer's mapping values","href":"/api-reference/endpoints/syncs/fill-a-consumers-mapping-values"},{"openapi":"post /consumers/{consumer_id}/syncs/{syncid}/previews","title":"Preview what a consumer's sync would create","href":"/api-reference/endpoints/syncs/preview-what-a-consumers-sync-would-create"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/previews","title":"A consumer's recent previews","href":"/api-reference/endpoints/syncs/a-consumers-recent-previews"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}","title":"One preview: where it stands, what it would create and what would fail","href":"/api-reference/endpoints/syncs/one-preview:-where-it-stands-what-it-would-create-and-what-would-fail"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}/objects","title":"The objects a preview would create","href":"/api-reference/endpoints/syncs/the-objects-a-preview-would-create"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/objects/{kind}","title":"The objects of one type a consumer's sync handled","href":"/api-reference/endpoints/syncs/the-objects-of-one-type-a-consumers-sync-handled"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/objects/{kind}/{object_id}","title":"What a consumer's sync did to one object","href":"/api-reference/endpoints/syncs/what-a-consumers-sync-did-to-one-object"}]},{"group":"Data layer","pages":[{"openapi":"post /consumers/{consumer_id}/connections/{connection_id}/enable_datalayer","title":"Enable the datalayer sync for a connection","href":"/api-reference/endpoints/datalayer/enable-the-datalayer-sync-for-a-connection"},{"openapi":"post /consumers/{consumer_id}/connections/{connection_id}/refresh_datalayer","title":"Refresh the datalayer sync for a connection","href":"/api-reference/endpoints/datalayer/refresh-the-datalayer-sync-for-a-connection"},{"openapi":"post /consumers/{consumer_id}/connections/{connection_id}/disable_datalayer","title":"Disable the datalayer sync for a connection","href":"/api-reference/endpoints/datalayer/disable-the-datalayer-sync-for-a-connection"}]},{"group":"Issues","pages":[{"openapi":"get /issues","title":"Get issues","href":"/api-reference/endpoints/issues/get-issues"},{"openapi":"get /consumers/{consumer_id}/issues","title":"Get issues by consumer id","href":"/api-reference/endpoints/issues/get-issues-by-consumer-id"},{"openapi":"get /issues/{issue_id}","title":"Get details about one issue","href":"/api-reference/endpoints/issues/get-details-about-one-issue"}]},{"group":"Datastores","pages":[{"openapi":"get /datastores","title":"Get list of datastores","href":"/api-reference/endpoints/datastores/get-list-of-datastores"}]}]}]},{"tab":"Use Cases","pages":[{"title":"Use Cases","href":"/use-cases/overview"}]},{"tab":"Connectors","pages":[{"title":"Connectors","href":"/connectors/connectors"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/platform/overview"}]},{"tab":"AI","pages":[{"title":"AI","href":"/ai/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelogs/2026-07"}]}]},{"dropdown":"User Documentation","icon":"circle-question","groups":[{"group":"Overview","pages":[{"title":"Help Center","href":"/help/overview"}]},{"group":"Accounting","pages":[{"title":"a3ERP","sidebarTitle":"a3ERP","href":"/help/connectors/8039"},{"title":"ACD","sidebarTitle":"ACD","href":"/help/connectors/8003"},{"title":"ACD: launch an analysis","sidebarTitle":"ACD: Launch an analysis","href":"/help/connectors/8003/launch-an-analysis"},{"title":"AFAS","sidebarTitle":"AFAS Software","href":"/help/connectors/8037"},{"title":"Cegid Loop","sidebarTitle":"Cegid Loop","href":"/help/connectors/8011"},{"title":"Contasol","sidebarTitle":"Contasol","href":"/help/connectors/8049"},{"title":"DATEV","sidebarTitle":"DATEV","href":"/help/connectors/8019"},{"title":"DATEV Buchungsdatenservice","sidebarTitle":"DATEV - Buchungsdatenservice","href":"/help/connectors/8046"},{"title":"DATEV (LocalAgent)","sidebarTitle":"DATEV - Local Agent","href":"/help/connectors/8041"},{"title":"Dinero","sidebarTitle":"Dinero","href":"/help/connectors/8050"},{"title":"Dynamics 365 Business Central","sidebarTitle":"Dynamics 365 Business Central","href":"/help/connectors/8012"},{"title":"e-Boekhouden","sidebarTitle":"e-Boekhouden","href":"/help/connectors/8025"},{"title":"EBP Comptabilité","sidebarTitle":"EBP Comptabilité","href":"/help/connectors/8052"},{"title":"Visma e-conomic","sidebarTitle":"Visma e-conomic","href":"/help/connectors/8047"},{"title":"Exact Online BE","sidebarTitle":"Exact Online BE","href":"/help/connectors/8000"},{"title":"Exact Online DE","sidebarTitle":"Exact Online DE","href":"/help/connectors/8030"},{"title":"Exact Online FR","sidebarTitle":"Exact Online FR","href":"/help/connectors/8014"},{"title":"Exact Online NL","sidebarTitle":"Exact Online NL","href":"/help/connectors/8026"},{"title":"Fiken","sidebarTitle":"Fiken","href":"/help/connectors/8044"},{"title":"Fortnox","sidebarTitle":"Fortnox","href":"/help/connectors/8048"},{"title":"FreeAgent","sidebarTitle":"FreeAgent","href":"/help/connectors/8032"},{"title":"Fulll","sidebarTitle":"Fulll","href":"/help/connectors/8017"},{"title":"Holded","sidebarTitle":"Holded","href":"/help/connectors/8033"},{"title":"Horus","sidebarTitle":"Horus","href":"/help/connectors/8001"},{"title":"InexWeb - In Extenso","sidebarTitle":"InexWeb - In Extenso","href":"/help/connectors/8022"},{"title":"Inqom","sidebarTitle":"Inqom","href":"/help/connectors/8016"},{"title":"Lexware Office (Lexoffice)","sidebarTitle":"Lexware Office (Lexoffice)","href":"/help/connectors/8038"},{"title":"Minox","sidebarTitle":"Minox","href":"/help/connectors/8010"},{"title":"Moneybird","sidebarTitle":"Moneybird","href":"/help/connectors/8040"},{"title":"MyUnisoft","sidebarTitle":"MyUnisoft","href":"/help/connectors/8006"},{"title":"NetSuite","sidebarTitle":"NetSuite","href":"/help/connectors/8018"},{"title":"Octopus","sidebarTitle":"Octopus","href":"/help/connectors/8007"},{"title":"Odoo","sidebarTitle":"Odoo (Accounting)","href":"/help/connectors/1000"},{"title":"Pennylane","sidebarTitle":"Pennylane","href":"/help/connectors/8008"},{"title":"Procountor","sidebarTitle":"Procountor","href":"/help/connectors/8051"},{"title":"QuickBooks Accounting","sidebarTitle":"QuickBooks (Accounting)","href":"/help/connectors/8034"},{"title":"Sage 100 FR","sidebarTitle":"Sage 100 FR","href":"/help/connectors/8005"},{"title":"Sage 200 ES","sidebarTitle":"Sage 200 ES","href":"/help/connectors/8043"},{"title":"Sage 50 FR","sidebarTitle":"Sage 50 FR","href":"/help/connectors/8009"},{"title":"Sage 50 UK","sidebarTitle":"Sage 50 UK","href":"/help/connectors/8013"},{"title":"Sage BOB 50","sidebarTitle":"Sage BOB 50","href":"/help/connectors/1006"},{"title":"Sage Génération Experts","sidebarTitle":"Sage Génération Experts","href":"/help/connectors/8015"},{"title":"Sage Intacct","sidebarTitle":"Sage Intacct","href":"/help/connectors/8035"},{"title":"sevDesk","sidebarTitle":"sevDesk","href":"/help/connectors/8042"},{"title":"SnelStart","sidebarTitle":"SnelStart","href":"/help/connectors/8024"},{"title":"Tiime","sidebarTitle":"Tiime","href":"/help/connectors/8021"},{"title":"Tripletex","sidebarTitle":"Tripletex","href":"/help/connectors/8027"},{"title":"Twinfield","sidebarTitle":"Twinfield","href":"/help/connectors/8028"},{"title":"Visma eAccounting","sidebarTitle":"Visma eAccounting","href":"/help/connectors/8020"},{"title":"Visma Spiris","sidebarTitle":"Visma Spiris","href":"/help/connectors/8045"},{"title":"Winbooks Classic - Installation Guide","sidebarTitle":"Winbooks Classic - Local agent Installation Process","href":"/help/connectors/1005/installation-guide"},{"title":"Xero","sidebarTitle":"Xero","href":"/help/connectors/8029"},{"title":"Yuki","sidebarTitle":"Yuki","href":"/help/connectors/8023"}]},{"group":"POS","pages":[{"title":"Abill","href":"/help/connectors/9022"},{"title":"Addictill","href":"/help/connectors/9017"},{"title":"Agora","href":"/help/connectors/9042"},{"title":"APITIC","sidebarTitle":"Apitic","href":"/help/connectors/9024"},{"title":"Atilla","sidebarTitle":"AtillaSoft","href":"/help/connectors/9032"},{"title":"BDP","href":"/help/connectors/9028"},{"title":"Carrepos","href":"/help/connectors/9029"},{"title":"Cashmag","href":"/help/connectors/9015"},{"title":"Cashpad","href":"/help/connectors/9005"},{"title":"Cegid Retail","href":"/help/connectors/9031"},{"title":"Clyo Systems","href":"/help/connectors/9010"},{"title":"Clyo Systems - Prerequisite","href":"/help/connectors/9010/prerequisite"},{"title":"Connectill","href":"/help/connectors/9016"},{"title":"Fülle","href":"/help/connectors/9007"},{"title":"Fastmag","href":"/help/connectors/9040"},{"title":"HelloCash","href":"/help/connectors/9003"},{"title":"Hiboutik","href":"/help/connectors/9001"},{"title":"Hosteltactil","href":"/help/connectors/9041"},{"title":"Innovorder","href":"/help/connectors/9006"},{"title":"iPratico","href":"/help/connectors/9051"},{"title":"Jalia - JDC","href":"/help/connectors/9013"},{"title":"L'Addition","href":"/help/connectors/9019"},{"title":"Last.app","href":"/help/connectors/9021"},{"title":"Leo2","href":"/help/connectors/9025"},{"title":"Lightspeed","sidebarTitle":"Lightspeed (POS)","href":"/help/connectors/9008"},{"title":"MplusKASSA","href":"/help/connectors/9038"},{"title":"myPOS","sidebarTitle":"myPOS","href":"/help/connectors/9036"},{"title":"Neo","href":"/help/connectors/9050"},{"title":"Numier","href":"/help/connectors/9044"},{"title":"Odoo POS","sidebarTitle":"Odoo (POS)","href":"/help/connectors/9023"},{"title":"Oracle Simphony","href":"/help/connectors/9034"},{"title":"PI Electronique (Alpha Caisse)","href":"/help/connectors/9039"},{"title":"Planity","href":"/help/connectors/9018"},{"title":"Popina","href":"/help/connectors/9011"},{"title":"Izipass","href":"/help/connectors/9049"},{"title":"Restomax","href":"/help/connectors/9026"},{"title":"Revo","href":"/help/connectors/9037"},{"title":"Shopcaisse","href":"/help/connectors/9030"},{"title":"Shopify (POS)","href":"/help/connectors/9043"},{"title":"Square","sidebarTitle":"Square (POS)","href":"/help/connectors/9000"},{"title":"Synapsy","href":"/help/connectors/9004"},{"title":"Tactilpad","href":"/help/connectors/9027"},{"title":"Tiller","href":"/help/connectors/9020"},{"title":"Trivec","href":"/help/connectors/9009"},{"title":"Zelty","href":"/help/connectors/9012"},{"title":"Zettle","sidebarTitle":"PayPal POS (Zettle)","href":"/help/connectors/9002"},{"title":"Breeze","sidebarTitle":"Breeze","href":"/help/connectors/9052"}]},{"group":"Invoicing","pages":[{"title":"a3factura","sidebarTitle":"a3factura","href":"/help/connectors/7029"},{"title":"Axonaut","href":"/help/connectors/7000"},{"title":"Billit","href":"/help/connectors/7023"},{"title":"BoondManager","href":"/help/connectors/7009"},{"title":"Chargebee","href":"/help/connectors/7005"},{"title":"Digiforma","href":"/help/connectors/7027"},{"title":"Dolibarr","href":"/help/connectors/7022"},{"title":"EBP Gestion Commerciale","sidebarTitle":"EBP (Invoicing)","href":"/help/connectors/7026"},{"title":"Evoliz","href":"/help/connectors/7010"},{"title":"Factomos","href":"/help/connectors/7017"},{"title":"Fatture In Cloud","href":"/help/connectors/7016"},{"title":"Fuga","href":"/help/connectors/7021"},{"title":"Harvest","href":"/help/connectors/7008"},{"title":"Hubspot","sidebarTitle":"HubSpot","href":"/help/connectors/7014"},{"title":"Hyperline","href":"/help/connectors/7025"},{"title":"Odoo Invoicing","sidebarTitle":"Odoo (Invoicing)","href":"/help/connectors/7001"},{"title":"Organilog","href":"/help/connectors/7019"},{"title":"PayPal","sidebarTitle":"Paypal (Invoicing)","href":"/help/connectors/7013"},{"title":"Qonto","href":"/help/connectors/7015"},{"title":"Quickbooks","sidebarTitle":"QuickBooks (Invoicing)","href":"/help/connectors/7012"},{"title":"Sage 100 FR Gestion Commerciale - On premise","sidebarTitle":"Sage 100 Gestion Commerciale - On premise","href":"/help/connectors/7018/on-premise"},{"title":"Sage 100 FR Gestion Commerciale - SPC","sidebarTitle":"Sage 100 Gestion Commerciale - Azure Sage Partner Cloud (SPC)","href":"/help/connectors/7018/spc"},{"title":"Sage 100 Gestion Commerciale","href":"/help/connectors/7018"},{"title":"Sellsy","href":"/help/connectors/7003"},{"title":"TeamLeader","href":"/help/connectors/7002"},{"title":"Vosfactures","sidebarTitle":"Vos Factures","href":"/help/connectors/7006"},{"title":"Zoho Invoice","sidebarTitle":"Zoho One (Invoice)","href":"/help/connectors/7004"}]},{"group":"eCommerce","pages":[{"title":"Amazon Seller","href":"/help/connectors/6003"},{"title":"Prestashop","href":"/help/connectors/6002"},{"title":"Shopify","sidebarTitle":"Shopify (eCommerce)","href":"/help/connectors/1007"},{"title":"WooCommerce","href":"/help/connectors/1002"}]},{"group":"Payment","pages":[{"title":"AirWallex","href":"/help/connectors/7111"},{"title":"Gocardless","sidebarTitle":"GoCardless","href":"/help/connectors/7105"},{"title":"Shopify (Payment)","href":"/help/connectors/7110"},{"title":"Stripe","href":"/help/connectors/7103"},{"title":"SumUp","sidebarTitle":"SumUp (Payment)","href":"/help/connectors/7106"},{"title":"Klarna","sidebarTitle":"Klarna","href":"/help/connectors/7112"},{"title":"eBay","sidebarTitle":"eBay","href":"/help/connectors/7113"}]},{"group":"PMS","pages":[{"title":"Mews","href":"/help/connectors/9014"},{"title":"Noovy","href":"/help/connectors/9500"},{"title":"Oracle Opera","href":"/help/connectors/9502"},{"title":"Thais PMS","sidebarTitle":"Thaïs","href":"/help/connectors/9503"}]},{"group":"Banking","pages":[{"title":"Ponto","href":"/help/connectors/10000"}]},{"group":"Local Agent","pages":[{"title":"Local Agent","href":"/help/guides/local-agent"},{"title":"Cockpit — User Guide","href":"/help/guides/local-agent-cockpit-user-guide"},{"title":"Update the Local agent to the newest version","href":"/help/guides/update-the-local-agent-to-the-newest-version"},{"title":"Sage 100: Connect Multiple Accounting Folders at Once","href":"/help/guides/local-agent-connect-multiple-folders-at-once"}]},{"group":"Marketplace","pages":[{"title":"Marketplace","href":"/help/marketplace/overview"},{"title":"Marketplace Activation","href":"/help/marketplace/marketplace-activation"},{"group":"Manage my integrations","pages":[{"title":"Add a new integration","href":"/help/marketplace/manage-my-integrations/add-a-new-integration"},{"title":"Invite your accountant/client to configure the integration","href":"/help/marketplace/manage-my-integrations/invite-your-accountant-client-to-configure-the-integration"}]},{"group":"Manage my account","pages":[{"title":"Manage my profile","href":"/help/marketplace/manage-my-marketplace-account/manage-my-profile"},{"title":"Manage users \u0026 invitations","href":"/help/marketplace/manage-my-marketplace-account/manage-users-invitations"},{"title":"How to Update Account Access and Transfer Connection Ownership","href":"/help/marketplace/manage-my-marketplace-account/how-to-update-account-access-and-transfer-connection-ownership"},{"title":"Delete my account","href":"/help/marketplace/manage-my-marketplace-account/delete-my-account"}]}]},{"group":"Chift Insights","pages":[{"title":"Chift Insights","sidebarTitle":"Overview","href":"/insights/overview"}]}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/help/overview"}]},{"language":"es","pages":[{"title":"es","href":"/es/help/overview"}]},{"language":"nl","pages":[{"title":"nl","href":"/nl/help/overview"}]},{"language":"de","pages":[{"title":"de","href":"/de/help/overview"}]}]},"basePath":"","title":"Create an order - Chift","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}