This endpoint allows you to add a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Docs","colors":{"primary":"#FF2E49","light":"#FF2E49","dark":"#FF2E49"},"favicon":"images/faviconnew.png","logo":{"light":"https://s3.us-east-2.amazonaws.com/admin.artisncore.dev/products/xmart-logo.png","dark":"https://s3.us-east-2.amazonaws.com/admin.artisncore.dev/products/logoxmartblanco.png"},"navbar":{"links":[{"label":"Support","href":"mailto:support@x-mart.io"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.x-mart.io/auth/signin"}},"footer":{"socials":{"website":"https://www.artisn.io/xmart"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Create an account","href":"https://app.x-mart.io/auth/signin","icon":"Key"},{"anchor":"Version","href":"https://docs.x-mart.io/version","icon":"newspaper"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"trade","hasAudioNarration":false,"actualSubdomain":"trade","customDomains":["docs.x-mart.io"],"gitSource":{"type":"github","owner":"xmart-io","repo":"x-mart","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e6494c43fec466d79790","collectionId":"12a0dd3e-01d7-41c0-9567-768b2c6fef9a","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e6494c43fec466d79790:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Documentation","count":80},{"language":"default","tag":"API-Reference","count":60},{"language":"default","tag":"Admin","count":20},{"language":"default","tag":"Fiscal Engine","count":13},{"language":"default","tag":"Motor Fiscal","count":13},{"language":"default","tag":"Primeros Pasos","count":6},{"language":"default","tag":"Get Started","count":6},{"language":"default","tag":"Order Fulfillment","count":4},{"language":"default","tag":"Stores and Sales Channels","count":4},{"language":"default","tag":"Cambios de estado","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v3/products/post","slug":"/api-reference/v3/products/post","pageMetadata":{"title":"This endpoint allows adding a list to the system","openapi":"POST /api/v3/products","description":"This endpoint allows you to add a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted.","href":"/api-reference/v3/products/post"},"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: \"This endpoint allows you to add a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"title":"This endpoint allows adding a list to the system","openapi":"POST /api/v3/products","description":"This endpoint allows you to add a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted.","href":"/api-reference/v3/products/post"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Add a product list","description":"This endpoint allows you to add a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted.","requestBody":"b4020b58-87c4-4fe2-90c7-18744f2f1fda","responses":{"200":"ddd1b14f-c98d-448c-a74b-cda156701f7e","400":"51375e53-3da5-4956-a282-10b9ce537096"},"method":"post","type":"path","servers":["88b44c8d-4119-442c-9f3f-2ef147a38bed","508ba195-a5da-4c42-955f-a4e1d9981353","b6cc3f75-0d67-4005-9014-120dd3991dde"],"security":["52b7b3d9-ac60-468f-8a5d-b5cf21ad1ae8"],"path":"/api/v3/products","baseUrlOptions":["https://api.artisn.desarrollo-redbrand.com/api","https://api.kfc-group.desarrollo-redbrand.com","https://{apiId}.execute-api.{region}.amazonaws.com/{stage}"],"title":"Add a product list","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"list":{"type":"object","description":"General information of the list where the defined products will be added","properties":{"listName":{"type":"string","description":"Name that identifies the list","uniqueKey":"list.listName","typeLabel":"string"}},"uniqueKey":"list","typeLabel":"object"},"modifierGroups":{"type":"array","description":"Allows you to define a list of modifiers that will be used in the list","items":{"type":"object","properties":{"modifierId":{"type":"string","uniqueKey":"modifierGroups.items.[INDEX].modifierId","typeLabel":"string"},"modifier":{"type":"string","uniqueKey":"modifierGroups.items.[INDEX].modifier","typeLabel":"string"},"minOptions":{"type":"integer","uniqueKey":"modifierGroups.items.[INDEX].minOptions","typeLabel":"integer"},"maxOptions":{"type":"integer","uniqueKey":"modifierGroups.items.[INDEX].maxOptions","typeLabel":"integer"},"visible":{"type":"boolean","uniqueKey":"modifierGroups.items.[INDEX].visible","typeLabel":"boolean"},"position":{"type":"integer","uniqueKey":"modifierGroups.items.[INDEX].position","typeLabel":"integer"},"type":{"type":"string","uniqueKey":"modifierGroups.items.[INDEX].type","typeLabel":"string"},"modifierOptions":{"type":"array","items":{"type":"object","properties":{"optionId":{"type":"string","uniqueKey":"modifierGroups.items.[INDEX].modifierOptions.items.[INDEX].optionId","typeLabel":"string"},"productId":{"type":"string","uniqueKey":"modifierGroups.items.[INDEX].modifierOptions.items.[INDEX].productId","typeLabel":"string"},"default":{"type":"boolean","uniqueKey":"modifierGroups.items.[INDEX].modifierOptions.items.[INDEX].default","typeLabel":"boolean"},"position":{"type":"integer","uniqueKey":"modifierGroups.items.[INDEX].modifierOptions.items.[INDEX].position","typeLabel":"integer"},"additionalInfo":{"type":"object","additionalProperties":true,"description":"Additional information using key-value pairs","uniqueKey":"modifierGroups.items.[INDEX].modifierOptions.items.[INDEX].additionalInfo","typeLabel":"object"}},"uniqueKey":"modifierGroups.items.[INDEX].modifierOptions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"modifierGroups.items.[INDEX].modifierOptions","typeLabel":"object[]"}},"uniqueKey":"modifierGroups.items.[INDEX]","typeLabel":"object"},"uniqueKey":"modifierGroups","typeLabel":"object[]"},"products":{"type":"array","description":"Allows you to define the products or items, as well as their organization in the list","items":{"type":"object","properties":{"productId":{"type":"string","uniqueKey":"products.items.[INDEX].productId","typeLabel":"string"},"name":{"type":"string","uniqueKey":"products.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["PRODUCT","MODIFIER","COMPLEMENT"],"uniqueKey":"products.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","uniqueKey":"products.items.[INDEX].description","typeLabel":"string"},"standardTime":{"type":"boolean","uniqueKey":"products.items.[INDEX].standardTime","typeLabel":"boolean"},"featured":{"type":"boolean","uniqueKey":"products.items.[INDEX].featured","typeLabel":"boolean"},"modifierId":{"type":"string","uniqueKey":"products.items.[INDEX].modifierId","typeLabel":"string"},"taxesInfo":{"type":"array","items":{"type":"object","properties":{"vatRatePercentage":{"type":"integer","uniqueKey":"products.items.[INDEX].taxesInfo.items.[INDEX].vatRatePercentage","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"products.items.[INDEX].taxesInfo.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","uniqueKey":"products.items.[INDEX].taxesInfo.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"products.items.[INDEX].taxesInfo.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products.items.[INDEX].taxesInfo","typeLabel":"object[]"},"priceInfo":{"type":"object","properties":{"price":{"type":"number","uniqueKey":"products.items.[INDEX].priceInfo.price","typeLabel":"number"},"pointPrice":{"type":"integer","uniqueKey":"products.items.[INDEX].priceInfo.pointPrice","typeLabel":"integer"},"suggestedPrice":{"type":"number","uniqueKey":"products.items.[INDEX].priceInfo.suggestedPrice","typeLabel":"number"},"suggestedPointPrice":{"type":"integer","uniqueKey":"products.items.[INDEX].priceInfo.suggestedPointPrice","typeLabel":"integer"}},"uniqueKey":"products.items.[INDEX].priceInfo","typeLabel":"object"},"schedules":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY","SPECIAL"],"uniqueKey":"products.items.[INDEX].schedules.items.[INDEX].day","typeLabel":"enum\u003cstring>"},"startDate":{"type":"string","format":"date","uniqueKey":"products.items.[INDEX].schedules.items.[INDEX].startDate","typeLabel":"string\u003cdate>"},"endDate":{"type":"string","format":"date","uniqueKey":"products.items.[INDEX].schedules.items.[INDEX].endDate","typeLabel":"string\u003cdate>"},"startTime":{"type":"string","format":"time","uniqueKey":"products.items.[INDEX].schedules.items.[INDEX].startTime","typeLabel":"string\u003ctime>"},"endTime":{"type":"string","format":"time","uniqueKey":"products.items.[INDEX].schedules.items.[INDEX].endTime","typeLabel":"string\u003ctime>"}},"uniqueKey":"products.items.[INDEX].schedules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products.items.[INDEX].schedules","typeLabel":"object[]"},"upselling":{"type":"array","items":{"type":"string","uniqueKey":"products.items.[INDEX].upselling.items.[INDEX]","typeLabel":"string"},"description":"Set of unique product identifiers used in the upsell","uniqueKey":"products.items.[INDEX].upselling","typeLabel":"string[]"},"crossSelling":{"type":"array","items":{"type":"string","uniqueKey":"products.items.[INDEX].crossSelling.items.[INDEX]","typeLabel":"string"},"description":"Set of unique product identifiers used in cross-selling","uniqueKey":"products.items.[INDEX].crossSelling","typeLabel":"string[]"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"products.items.[INDEX].tags.items.[INDEX]","typeLabel":"string"},"description":"Allows you to assign tags to the product","uniqueKey":"products.items.[INDEX].tags","typeLabel":"string[]"},"images":{"type":"array","items":{"type":"object","properties":{"imageCategoryId":{"type":"string","uniqueKey":"products.items.[INDEX].images.items.[INDEX].imageCategoryId","typeLabel":"string"},"fileUrl":{"type":"string","uniqueKey":"products.items.[INDEX].images.items.[INDEX].fileUrl","typeLabel":"string"}},"uniqueKey":"products.items.[INDEX].images.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products.items.[INDEX].images","typeLabel":"object[]"},"productModifiers":{"type":"array","description":"Allows you to associate modifiers to the product","items":{"type":"object","properties":{"modifierId":{"type":"string","uniqueKey":"products.items.[INDEX].productModifiers.items.[INDEX].modifierId","typeLabel":"string"},"position":{"type":"integer","uniqueKey":"products.items.[INDEX].productModifiers.items.[INDEX].position","typeLabel":"integer"}},"uniqueKey":"products.items.[INDEX].productModifiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products.items.[INDEX].productModifiers","typeLabel":"object[]"},"additionalInfo":{"type":"object","additionalProperties":true,"description":"Allows you to define additional information using key-value pairs","uniqueKey":"products.items.[INDEX].additionalInfo","typeLabel":"object"}},"uniqueKey":"products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products","typeLabel":"object[]"},"categories":{"type":"array","description":"Allows you to define product categories as well as their organization in the list","items":{"type":"object","properties":{"categoryId":{"type":"string","uniqueKey":"categories.items.[INDEX].categoryId","typeLabel":"string"},"categoryName":{"type":"string","uniqueKey":"categories.items.[INDEX].categoryName","typeLabel":"string"},"displayInList":{"type":"boolean","uniqueKey":"categories.items.[INDEX].displayInList","typeLabel":"boolean"},"featured":{"type":"boolean","uniqueKey":"categories.items.[INDEX].featured","typeLabel":"boolean"},"crossSellingCategory":{"type":"boolean","uniqueKey":"categories.items.[INDEX].crossSellingCategory","typeLabel":"boolean"},"position":{"type":"integer","uniqueKey":"categories.items.[INDEX].position","typeLabel":"integer"},"images":{"type":"array","items":{"type":"object","properties":{"imageCategoryId":{"type":"string","uniqueKey":"categories.items.[INDEX].images.items.[INDEX].imageCategoryId","typeLabel":"string"},"fileUrl":{"type":"string","uniqueKey":"categories.items.[INDEX].images.items.[INDEX].fileUrl","typeLabel":"string"}},"uniqueKey":"categories.items.[INDEX].images.items.[INDEX]","typeLabel":"object"},"uniqueKey":"categories.items.[INDEX].images","typeLabel":"object[]"},"childCategories":{"type":"array","items":{"type":"object","properties":{"categoryId":{"type":"string","uniqueKey":"categories.items.[INDEX].childCategories.items.[INDEX].categoryId","typeLabel":"string"},"categoryName":{"type":"string","uniqueKey":"categories.items.[INDEX].childCategories.items.[INDEX].categoryName","typeLabel":"string"}},"uniqueKey":"categories.items.[INDEX].childCategories.items.[INDEX]","typeLabel":"object"},"uniqueKey":"categories.items.[INDEX].childCategories","typeLabel":"object[]"},"productListing":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","uniqueKey":"categories.items.[INDEX].productListing.items.[INDEX].productId","typeLabel":"string"},"position":{"type":"integer","uniqueKey":"categories.items.[INDEX].productListing.items.[INDEX].position","typeLabel":"integer"}},"uniqueKey":"categories.items.[INDEX].productListing.items.[INDEX]","typeLabel":"object"},"uniqueKey":"categories.items.[INDEX].productListing","typeLabel":"object[]"},"schedules":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","uniqueKey":"categories.items.[INDEX].schedules.items.[INDEX].day","typeLabel":"string"},"startDate":{"type":"string","uniqueKey":"categories.items.[INDEX].schedules.items.[INDEX].startDate","typeLabel":"string"},"endDate":{"type":"string","uniqueKey":"categories.items.[INDEX].schedules.items.[INDEX].endDate","typeLabel":"string"},"startTime":{"type":"string","uniqueKey":"categories.items.[INDEX].schedules.items.[INDEX].startTime","typeLabel":"string"},"endTime":{"type":"string","uniqueKey":"categories.items.[INDEX].schedules.items.[INDEX].endTime","typeLabel":"string"}},"uniqueKey":"categories.items.[INDEX].schedules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"categories.items.[INDEX].schedules","typeLabel":"object[]"}},"uniqueKey":"categories.items.[INDEX]","typeLabel":"object"},"uniqueKey":"categories","typeLabel":"object[]"},"ecommerceChannelId":{"type":"integer","description":"Unified sales channel identifier, refers to the standardized channel identifier","uniqueKey":"ecommerceChannelId","typeLabel":"integer"},"channelReferenceName":{"type":"string","description":"Unique reference name, used for search and association of the standardized channel.","uniqueKey":"channelReferenceName","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"list":{"listName":"\u003cstring>"},"modifierGroups":[{"modifierId":"\u003cstring>","modifier":"\u003cstring>","minOptions":123,"maxOptions":123,"visible":true,"position":123,"type":"\u003cstring>","modifierOptions":[{"optionId":"\u003cstring>","productId":"\u003cstring>","default":true,"position":123,"additionalInfo":{}}]}],"products":[{"productId":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","standardTime":true,"featured":true,"modifierId":"\u003cstring>","taxesInfo":[{"vatRatePercentage":123,"name":"\u003cstring>","type":"\u003cstring>"}],"priceInfo":{"price":123,"pointPrice":123,"suggestedPrice":123,"suggestedPointPrice":123},"schedules":[{"startDate":"2023-12-25","endDate":"2023-12-25","startTime":"\u003cstring>","endTime":"\u003cstring>"}],"upselling":["\u003cstring>"],"crossSelling":["\u003cstring>"],"tags":["\u003cstring>"],"images":[{"imageCategoryId":"\u003cstring>","fileUrl":"\u003cstring>"}],"productModifiers":[{"modifierId":"\u003cstring>","position":123}],"additionalInfo":{}}],"categories":[{"categoryId":"\u003cstring>","categoryName":"\u003cstring>","displayInList":true,"featured":true,"crossSellingCategory":true,"position":123,"images":[{"imageCategoryId":"\u003cstring>","fileUrl":"\u003cstring>"}],"childCategories":[{"categoryId":"\u003cstring>","categoryName":"\u003cstring>"}],"productListing":[{"productId":"\u003cstring>","position":123}],"schedules":[{"day":"\u003cstring>","startDate":"\u003cstring>","endDate":"\u003cstring>","startTime":"\u003cstring>","endTime":"\u003cstring>"}]}],"ecommerceChannelId":123,"channelReferenceName":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ddd1b14f-c98d-448c-a74b-cda156701f7e":{"description":"List successfully registered","content":{"application/json":{"schema":{"type":"object","properties":{"listId":{"type":"string","uniqueKey":"listId","typeLabel":"string"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"active":{"type":"boolean","uniqueKey":"active","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"listId":"\u003cstring>","name":"\u003cstring>","active":true}}},"exampleType":"generated"}},"exampleType":"generated"},"51375e53-3da5-4956-a282-10b9ce537096":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"52b7b3d9-ac60-468f-8a5d-b5cf21ad1ae8":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"88b44c8d-4119-442c-9f3f-2ef147a38bed":{"url":"https://api.artisn.desarrollo-redbrand.com/api"},"508ba195-a5da-4c42-955f-a4e1d9981353":{"url":"https://api.kfc-group.desarrollo-redbrand.com"},"b6cc3f75-0d67-4005-9014-120dd3991dde":{"url":"https://{apiId}.execute-api.{region}.amazonaws.com/{stage}","description":"API Gateway (PRIVATE; invocación típica vía VPC endpoint).","variables":{"apiId":{"default":"{api-id}","description":"ID del API REST desplegado."},"region":{"default":"us-east-1"},"stage":{"default":"dev","description":"Mismo valor que parámetro EnvironmentName del stack."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"trade","siteName":"Docs","title":"This endpoint allows adding a list to the system - Docs","navMaps":{"firstHrefInVersion":{"English":{"href":"/api-reference/v3/products/post","matchLevel":0},"Español":{"href":"/espanol/api-reference/v3/products/post","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2025-10-21T19:14:28.599Z","originalFileLocation":"api-reference/v3/products/post.mdx"},"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=\"This endpoint allows you to add a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trade/XdhoalqB5nCheMBg/_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/trade/XdhoalqB5nCheMBg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trade/XdhoalqB5nCheMBg/_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/trade/XdhoalqB5nCheMBg/_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/trade/XdhoalqB5nCheMBg/_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/trade/XdhoalqB5nCheMBg/_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/trade/XdhoalqB5nCheMBg/_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/trade/XdhoalqB5nCheMBg/_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/trade/XdhoalqB5nCheMBg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"This endpoint allows adding a list to the system - Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint allows you to add a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.x-mart.io/api-reference/v3/products/post\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://trade.mintlify.app/_mintlify/api/og/v2?division=Products\u0026amp;title=This+endpoint+allows+adding+a+list+to+the+system\u0026amp;description=This+endpoint+allows+you+to+add+a+list+in+the+system.+Important%3A+Each+submitted+request+is+processed+as+a+new+configuration%2C+so+if+a+product%2C+category%2C+modifier\u0026amp;theme=ac2561b2347515189b2505f1\u0026amp;signature=c76bbf026bf35debc351b6157a489bb7821b950e9588c25ee237a855983366b6\">\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=\"This endpoint allows adding a list to the system - Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint allows you to add a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trade.mintlify.app/_mintlify/api/og/v2?division=Products\u0026amp;title=This+endpoint+allows+adding+a+list+to+the+system\u0026amp;description=This+endpoint+allows+you+to+add+a+list+in+the+system.+Important%3A+Each+submitted+request+is+processed+as+a+new+configuration%2C+so+if+a+product%2C+category%2C+modifier\u0026amp;theme=ac2561b2347515189b2505f1\u0026amp;signature=c76bbf026bf35debc351b6157a489bb7821b950e9588c25ee237a855983366b6\">\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/trade/XdhoalqB5nCheMBg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF2E49\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.x-mart.io/api-reference/v3/products/post\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v3/products/post.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.x-mart.io/#organization\",\"name\":\"Docs\",\"url\":\"https://docs.x-mart.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://s3.us-east-2.amazonaws.com/admin.artisncore.dev/products/xmart-logo.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.x-mart.io#website\",\"name\":\"Docs\",\"url\":\"https://docs.x-mart.io\",\"publisher\":{\"@id\":\"https://docs.x-mart.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.x-mart.io/api-reference/v3/products/post#webpage\",\"url\":\"https://docs.x-mart.io/api-reference/v3/products/post\",\"name\":\"This endpoint allows adding a list to the system\",\"description\":\"This endpoint allows you to add a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted.\",\"dateModified\":\"2025-10-21T19:14:28.599Z\",\"isPartOf\":{\"@id\":\"https://docs.x-mart.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.x-mart.io/api-reference/v3/products/post#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.x-mart.io/api-reference/v3/products/post#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API-Reference\",\"item\":\"https://docs.x-mart.io/ingles/api-reference/authentication/login/post\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"This endpoint allows adding a list to the system\",\"item\":\"https://docs.x-mart.io/api-reference/v3/products/post\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.x-mart.io/api-reference/v3/products/post#apireference\",\"headline\":\"This endpoint allows adding a list to the system\",\"name\":\"This endpoint allows adding a list to the system\",\"description\":\"This endpoint allows you to add a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted.\",\"url\":\"https://docs.x-mart.io/api-reference/v3/products/post\",\"mainEntityOfPage\":{\"@id\":\"https://docs.x-mart.io/api-reference/v3/products/post#webpage\"},\"dateModified\":\"2025-10-21T19:14:28.599Z\",\"publisher\":{\"@id\":\"https://docs.x-mart.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.x-mart.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Docs","nav":{"global":{"anchors":[{"anchor":"Create an account","href":"https://app.x-mart.io/auth/signin","icon":"Key"},{"anchor":"Version","href":"https://docs.x-mart.io/version","icon":"newspaper"}]},"versions":[{"version":"English","anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/ingles/introduction"},{"title":"Our API","href":"/ingles/Our API"},{"title":"Quickstart","href":"/ingles/quickstart"},{"group":"Concepts","pages":[{"title":"Stores","icon":"store","href":"/ingles/Concepts/Stores"},{"title":"List","icon":"list","href":"/ingles/Concepts/list"},{"title":"Channels","icon":"Globe","href":"/ingles/Concepts/Channels"}]}]},{"group":"Guides","pages":[{"title":"Authentication","icon":"gear","href":"/ingles/essentials/auth"},{"title":"Store Integration Guide","icon":"store","href":"/ingles/essentials/stores integration Guide"},{"title":"Menu integration Guide","icon":"text-size","href":"/ingles/essentials/menu integration Guide"},{"title":"Order integration Guide","icon":"Link","href":"/ingles/essentials/Order integration Guide"}]},{"group":"API-Reference","pages":[{"group":"Auth","pages":[{"title":"Get Token","openapi":"POST /authentication/login","href":"/ingles/api-reference/authentication/login/post"}]},{"group":"Stores and Sales Channels","pages":[{"title":"Get stores by brand","openapi":"GET /v3/stores","href":"/api-reference/v3/stores/get"},{"title":"Create Stores and Sales Channels","openapi":"POST /v3/channels-stores","href":"/api-reference/v3/channels-stores/post"},{"title":"Get store by id","openapi":"GET /v3/stores/{storeId}","href":"/api-reference/v3/stores/getId"},{"title":"Change store status","openapi":"PUT /v3/stores/{storeId}","href":"/api-reference/v3/stores/put"}]},{"group":"Lists","pages":[{"title":"Get Synchronization Report","openapi":"GET /v3/lists/sync-summary/lists","href":"/api-reference/v3/lists/get"},{"title":"This endpoint allows registering or editing a list in the system","openapi":"PUT /v3/lists/{listId}","description":"This endpoint allows you to register or edit a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted","href":"/api-reference/v3/lists/put"}]},{"group":"Products","pages":[{"title":"This endpoint allows adding a list to the system","openapi":"POST /api/v3/products","href":"/api-reference/v3/products/post"},{"title":"This endpoint allows updating product information","openapi":"PUT /api/v3/products/{vendorId}","description":"This endpoint allows you to update product information","href":"/api-reference/v3/products/put"},{"title":"This endpoint allows registering or editing a list in the system","openapi":"PUT /api/v3/products/{update}","href":"/api-reference/v3/products/putpro"}]},{"group":"Injection Web Services","pages":[{"title":"New Order Webhook","openapi":"POST /domain-cliente/webhook/new-order","href":"/api-reference/injection/postorder"},{"title":"Get Order","openapi":"GET /order/{orderId}","href":"/api-reference/injection/get"}]},{"group":"Order Fulfillment","pages":[{"title":"Registers tracking information for a specific order","openapi":"POST /api/order/tracking","href":"/api-reference/fulfillment/posttrack"},{"title":"Orders - Status Change","openapi":"POST /api/order/status","href":"/api-reference/fulfillment/poststatus"},{"title":"Pickup Orders - Dispatched","openapi":"POST /api/order/dispatched","href":"/api-reference/fulfillment/postdispatched"},{"title":"Orders - Transfer","openapi":"PUT /api/order/transfer","href":"/api-reference/fulfillment/puttransfer"}]},{"group":"Switch Transactional","pages":[{"title":"Orders - Payment Information","openapi":"GET /api/order/infoPayments","href":"/api-reference/fulfillment/getpay"}]},{"group":"Fiscal Engine","pages":[{"group":"Orders","pages":[{"title":"Enrich order with taxes","openapi":"api-reference/openapi.json POST /enrich-order","href":"/api-reference/fiscal/post-enrich-order"},{"title":"Enrich, persist, and notify via webhook","openapi":"api-reference/openapi.json POST /enrich-order-forward","href":"/api-reference/fiscal/post-enrich-order-forward"},{"title":"List persisted orders (paginated)","openapi":"api-reference/openapi.json GET /admin/orders","href":"/api-reference/fiscal/get-admin-orders"}]},{"group":"Admin","pages":[{"title":"List fiscal_groups","openapi":"api-reference/openapi.json GET /admin/fiscal-groups","href":"/api-reference/fiscal/get-admin-fiscal-groups"},{"title":"Create fiscal_group","openapi":"api-reference/openapi.json POST /admin/fiscal-groups","href":"/api-reference/fiscal/post-admin-fiscal-groups"},{"title":"Get fiscal_group by UUID","openapi":"api-reference/openapi.json GET /admin/fiscal-groups/{id}","href":"/api-reference/fiscal/get-admin-fiscal-groups-id"},{"title":"Update fiscal_group (partial)","openapi":"api-reference/openapi.json PUT /admin/fiscal-groups/{id}","href":"/api-reference/fiscal/put-admin-fiscal-groups-id"},{"title":"Delete fiscal_group","openapi":"api-reference/openapi.json DELETE /admin/fiscal-groups/{id}","href":"/api-reference/fiscal/delete-admin-fiscal-groups-id"},{"title":"List product_fiscal_category","openapi":"api-reference/openapi.json GET /admin/product-fiscal-categories","href":"/api-reference/fiscal/get-admin-product-fiscal-categories"},{"title":"Create product fiscal category","openapi":"api-reference/openapi.json POST /admin/product-fiscal-categories","href":"/api-reference/fiscal/post-admin-product-fiscal-categories"},{"title":"Get by productId (text)","openapi":"api-reference/openapi.json GET /admin/product-fiscal-categories/{productId}","href":"/api-reference/fiscal/get-admin-product-fiscal-categories-productid"},{"title":"Update category (productId cannot be sent in body)","openapi":"api-reference/openapi.json PUT /admin/product-fiscal-categories/{productId}","href":"/api-reference/fiscal/put-admin-product-fiscal-categories-productid"},{"title":"Delete category by productId","openapi":"api-reference/openapi.json DELETE /admin/product-fiscal-categories/{productId}","href":"/api-reference/fiscal/delete-admin-product-fiscal-categories-productid"}]}]}]}]}]},{"version":"Español","pages":[{"title":"Español","href":"/espanol/api-reference/v3/products/post"}]}]},"basePath":"","title":"This endpoint allows adding a list to the system - Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}