{"items":[{"type":"link","label":"Mirakl Connect Channel Platform APIs","link":"/content/product/connect-channel-platform/rest/connect/openapi3","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3","content":{"contentType":"overview","meta":{"name":"Mirakl Connect Channel Platform APIs"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"description":"Connect Channel Platform API","url":"https://miraklconnect.com/api/channel-platform"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Mirakl Connect Channel Platform APIs","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"partial","attributes":{"file":"partial-content/product/connect-channel-platform/rest/connect/openapi-description.md","variables":{"$$apiDocsHeadingScope":{"operationId":"","deepLinkSuffix":"section"}}},"children":[]}]}],"sectionId":"/content/product/connect-channel-platform/rest/connect/openapi3"}],"sectionId":"/content/product/connect-channel-platform/rest/connect/openapi3"}]}]}},{"type":"group","label":"Catalog Configuration","link":"/content/product/connect-channel-platform/rest/connect/openapi3/catalog-configuration","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/catalog-configuration","items":[{"label":"configureChannelCatalog - Configure Catalog capabilities for a channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/catalog-configuration/configurechannelcatalog","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/catalog-configuration/configurechannelcatalog","metadata":{"seo":{"title":"configureChannelCatalog - Configure Catalog capabilities for a channel","description":"Call FrequencyRecommended usage: only once, at channel setupMaximum usage: 1 per minute"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"configureChannelCatalog","name":"configureChannelCatalog - Configure Catalog capabilities for a channel","isWebhook":false,"pointer":"/paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"configureChannelCatalog - Configure Catalog capabilities for a channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: only once, at channel setup"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: 1 per minute"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:channel-catalog:configure"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_0","description":"Connect Channel identifier","required":true}],"pointer":"/paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json; charset=UTF-8"],"mediaTypeSchemas":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/ChannelCatalogCapabilities","exampleIds":["paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-2","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-3","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-4","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-5","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-6","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"schemaId":"components/schemas/ChannelCatalogCapabilities","exampleIds":["paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-2","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-3","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-4","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-5","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-6","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"],"pointer":"/paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/catalog-configuration/channels/{channel_id}","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"schemaId":"schema_0","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:channel-catalog:configure"]}],"requestBody":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/ChannelCatalogCapabilities","exampleIds":["paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-2","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-3","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-4","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-5","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-6","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"responseCodes":["202","400"],"pointer":"/v1/catalog-configuration/channels/{channel_id}","href":"catalog-configuration/configurechannelcatalog","openApiOperationId":"configureChannelCatalog","summary":"configureChannelCatalog - Configure Catalog capabilities for a channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"components/schemas/ChannelCatalogCapabilities","exampleIds":["paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-2","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-3","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-4","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-5","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-6","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"],"mediaTypes":["application/json; charset=UTF-8"],"mediaTypeSchemas":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/ChannelCatalogCapabilities","exampleIds":["paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-2","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-3","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-4","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-5","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-6","paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request - the request body does not match the API contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body is an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/problem+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" document with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array lists the violations found (up to a maximum, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then says the list is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"truncated). Each error gives the JSON path of the offending value in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the whole document)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and what is wrong in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/responses"}],"panels":[]}]},"httpPath":"/v1/catalog-configuration/channels/{channel_id}"}],"content":{"contentType":"group","meta":{"name":"Catalog Configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Catalog Configuration","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/catalog-configuration/channels/{channel_id}","summary":"configureChannelCatalog - Configure Catalog capabilities for a channel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/catalog-configuration/configurechannelcatalog","deprecated":false}]}]}]}]}},{"type":"group","label":"Taxonomy","link":"/content/product/connect-channel-platform/rest/connect/openapi3/taxonomy","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/taxonomy","items":[{"label":"createTaxonomyRule - Create a Taxonomy Rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/taxonomy/createtaxonomyrule","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/taxonomy/createtaxonomyrule","metadata":{"seo":{"title":"createTaxonomyRule - Create a Taxonomy Rule","description":"Call FrequencyRecommended usage: 5 per secondMaximum usage: 10 per second"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTaxonomyRule","name":"createTaxonomyRule - Create a Taxonomy Rule","isWebhook":false,"pointer":"/paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"createTaxonomyRule - Create a Taxonomy Rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: 5 per second"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: 10 per second"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:taxonomy-rule:create"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_0","description":"Connect Channel identifier","required":true}],"pointer":"/paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json; charset=UTF-8"],"mediaTypeSchemas":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/TaxonomyRuleRequest","exampleIds":["paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"schemaId":"components/schemas/TaxonomyRuleRequest","exampleIds":["paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"],"pointer":"/paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/taxonomy/channels/{channel_id}/rules","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"schemaId":"schema_0","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:taxonomy-rule:create"]}],"requestBody":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/TaxonomyRuleRequest","exampleIds":["paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"responseCodes":["202","400"],"pointer":"/v1/taxonomy/channels/{channel_id}/rules","href":"taxonomy/createtaxonomyrule","openApiOperationId":"createTaxonomyRule","summary":"createTaxonomyRule - Create a Taxonomy Rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"components/schemas/TaxonomyRuleRequest","exampleIds":["paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"],"mediaTypes":["application/json; charset=UTF-8"],"mediaTypeSchemas":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/TaxonomyRuleRequest","exampleIds":["paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request - the request body does not match the API contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body is an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/problem+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" document with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array lists the violations found (up to a maximum, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then says the list is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"truncated). Each error gives the JSON path of the offending value in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the whole document)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and what is wrong in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/responses"}],"panels":[]}]},"httpPath":"/v1/taxonomy/channels/{channel_id}/rules"},{"label":"upsertProductType - Create or Update a Product Type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/taxonomy/upsertproducttype","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/taxonomy/upsertproducttype","metadata":{"seo":{"title":"upsertProductType - Create or Update a Product Type","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertProductType","name":"upsertProductType - Create or Update a Product Type","isWebhook":false,"pointer":"/paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"upsertProductType - Create or Update a Product Type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates or fully replaces a Product Type for the specified channel."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full replacement (PUT semantics):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the entire product type definition (including all embedded attributes, their value lists, and rule references) is replaced with the content of this request. Any attribute, value list entry, or rule reference not present in the request body will be removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always provide the complete product type definition in every request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", even when only a subset of attributes or rules needs to change."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an asynchronous operation - the request is accepted and processed in the background."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: 5 per second"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: 10 per second"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:taxonomy-product-type:upsert"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_0","description":"Connect Channel identifier","required":true}],"pointer":"/paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"product_type_id","in":"query","schemaId":"schema_1","description":"The unique identifier of the product type, which may contain special characters like slashes.","required":true},{"name":"store_id","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store identifier scoping this product type to a specific store."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided, the product type is pushed at store-level granularity instead of channel-level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This granularity is not enabled by default: contact Mirakl technical teams beforehand."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json; charset=UTF-8"],"mediaTypeSchemas":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/ProductType","exampleIds":["paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1","paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"schemaId":"components/schemas/ProductType","exampleIds":["paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1","paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"],"pointer":"/paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/taxonomy/channels/{channel_id}/product-types","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"schemaId":"schema_0","style":"simple","explode":false}],"query":[{"name":"product_type_id","in":"query","required":true,"schemaId":"components/schemas/ProductTypeId","style":"form","explode":true},{"name":"store_id","in":"query","required":false,"schemaId":"components/schemas/StoreId","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:taxonomy-product-type:upsert"]}],"requestBody":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/ProductType","exampleIds":["paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1","paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"responseCodes":["202","400","401","404"],"pointer":"/v1/taxonomy/channels/{channel_id}/product-types","href":"taxonomy/upsertproducttype","openApiOperationId":"upsertProductType","summary":"upsertProductType - Create or Update a Product Type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"components/schemas/ProductType","exampleIds":["paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1","paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"],"mediaTypes":["application/json; charset=UTF-8"],"mediaTypeSchemas":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/ProductType","exampleIds":["paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0","paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1","paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request - the request body does not match the API contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body is an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/problem+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" document with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array lists the violations found (up to a maximum, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then says the list is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"truncated). Each error gives the JSON path of the offending value in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the whole document)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and what is wrong in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"code":"401","description":"The channel is not configured to allow the requested taxonomy granularity (channel-level or store-level)."},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channel not found, or store not found when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"store_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/responses"}],"panels":[]}]},"httpPath":"/v1/taxonomy/channels/{channel_id}/product-types"}],"content":{"contentType":"group","meta":{"name":"Taxonomy"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Taxonomy","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/taxonomy/channels/{channel_id}/rules","summary":"createTaxonomyRule - Create a Taxonomy Rule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/taxonomy/createtaxonomyrule","deprecated":false},{"title":"/v1/taxonomy/channels/{channel_id}/product-types","summary":"upsertProductType - Create or Update a Product Type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/taxonomy/upsertproducttype","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/content/product/connect-channel-platform/rest/connect/openapi3/orders","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/orders","items":[{"label":"deleteOrderDocument - Delete order document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/orders/deleteorderdocument","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/orders/deleteorderdocument","metadata":{"seo":{"title":"deleteOrderDocument - Delete order document","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderDocument","name":"deleteOrderDocument - Delete order document","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"deleteOrderDocument - Delete order document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this API to delete a document."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: On each document deletion on the order"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: On each document deletion on the order"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:order-document:delete"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_order_id","in":"path","schemaId":"schema_3","description":"Order identifier from the channel","required":true,"example":"COMMERCIAL_ID-A"},{"name":"channel_document_id","in":"path","schemaId":"schema_3","description":"Document ID from the channel","required":true,"example":"DOC-1234"}],"pointer":"/paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"schema_4","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/orders/{channel_order_id}/documents/{channel_document_id}","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[{"name":"channel_order_id","in":"path","required":true,"example":"COMMERCIAL_ID-A","schemaId":"schema_3","style":"simple","explode":false},{"name":"channel_document_id","in":"path","required":true,"example":"DOC-1234","schemaId":"schema_3","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:order-document:delete"]}],"requestBody":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/requestBody/content/application~1json/examples/application~1json-auto"]}},"responseCodes":["204","400","404"],"pointer":"/v1/orders/{channel_order_id}/documents/{channel_document_id}","href":"orders/deleteorderdocument","openApiOperationId":"deleteOrderDocument","summary":"deleteOrderDocument - Delete order document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"schema_4","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/400/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/400/content/application~1json/examples/application~1json-auto"]},{"code":"404","description":"The channel document ID does not exists. This may occur if the ID is incorrect or the document has already been deleted.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/404/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/404/content/application~1json/examples/application~1json-auto"]}],"pointer":"/paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/400/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/400/content/application~1json/examples/application~1json-auto"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/404/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/404/content/application~1json/examples/application~1json-auto"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/orders/{channel_order_id}/documents/{channel_document_id}"},{"label":"updateActionStatus - Update asynchronous action status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/orders/updateactionstatus","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/orders/updateactionstatus","metadata":{"seo":{"title":"updateActionStatus - Update asynchronous action status","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateActionStatus","name":"updateActionStatus - Update asynchronous action status","isWebhook":false,"pointer":"/paths/~1v1~1orders~1actions~1{action_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"updateActionStatus - Update asynchronous action status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the final status of an asynchronous action previously initiated through a command event."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"orders/updateactionstatus/request/overview","deepLinkHash":"/orders/updateactionstatus#orders/updateactionstatus/request/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an asynchronous action is requested via command event, an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided to track the action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to report the final outcome (SUCCESS or FAILURE) of the action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For failed actions, detailed error information must be provided"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"orders/updateactionstatus/request/usage-notes","deepLinkHash":"/orders/updateactionstatus#orders/updateactionstatus/request/usage-notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update should be sent once the action is fully completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple errors can be provided for failed actions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action ID must match the one provided in the original command event"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: Send update as soon as the action is completed"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: Once per action completion"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:order-action:upsert"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"action_id","in":"path","schemaId":"schema_3","description":"The unique identifier of the action. This ID was provided in the original command event that initiated the action.","required":true,"example":"1ba5fc4b-c4fd-4251-880b-3052e301bbd4"}],"pointer":"/paths/~1v1~1orders~1actions~1{action_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateActionRequest","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/UpdateActionRequest","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/~1v1~1orders~1actions~1{action_id}/put/requestBody","description":"The updated status and any error details for the action"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/orders/actions/{action_id}","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[{"name":"action_id","in":"path","required":true,"example":"1ba5fc4b-c4fd-4251-880b-3052e301bbd4","schemaId":"schema_3","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:order-action:upsert"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateActionRequest","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/requestBody/content/application~1json/examples/application~1json-auto"]}},"responseCodes":["204","400","404"],"pointer":"/v1/orders/actions/{action_id}","href":"orders/updateactionstatus","openApiOperationId":"updateActionStatus","summary":"updateActionStatus - Update asynchronous action status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"components/schemas/UpdateActionRequest","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateActionRequest","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The action status was successfully updated. No additional content is provided."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was invalid. Common causes include: - Invalid action status : must be either SUCCESS or FAILED - Action is already in a final state (SUCCESS or FAILED). This error will have code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTION_ALREADY_FINAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". - Invalid error format"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/responses/400/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/responses/400/content/application~1json/examples/application~1json-auto"]},{"code":"404","description":"The specified action ID was not found. This may occur if: - The ID is incorrect - The action has expired - The action was already completed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/responses/404/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/responses/404/content/application~1json/examples/application~1json-auto"]}],"pointer":"/paths/~1v1~1orders~1actions~1{action_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/responses/400/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/responses/400/content/application~1json/examples/application~1json-auto"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/responses/404/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1actions~1{action_id}/put/responses/404/content/application~1json/examples/application~1json-auto"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/orders/actions/{action_id}"},{"label":"updateAnonymizeAfterDate - Update anonymization date for orders","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/orders/updateanonymizeafterdate","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/orders/updateanonymizeafterdate","metadata":{"seo":{"title":"updateAnonymizeAfterDate - Update anonymization date for orders","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAnonymizeAfterDate","name":"updateAnonymizeAfterDate - Update anonymization date for orders","isWebhook":false,"pointer":"/paths/~1v1~1orders~1anonymize-after/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"updateAnonymizeAfterDate - Update anonymization date for orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the anonymization date for orders in the Mirakl Connect platform."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this API to indicated after which date orders should be anonymized by Connect."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The anonymization process is irreversible and should be used with caution."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: Once per order when the anonymization date is set"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: Every time the anonymization date needs to be changed"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:order:update-anonymize-after"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAnonymizeAfterRequest","exampleIds":["paths/~1v1~1orders~1anonymize-after/put/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/UpdateAnonymizeAfterRequest","exampleIds":["paths/~1v1~1orders~1anonymize-after/put/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/~1v1~1orders~1anonymize-after/put/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new anonymize_after date for the orders"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/orders/anonymize-after","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:order:update-anonymize-after"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAnonymizeAfterRequest","exampleIds":["paths/~1v1~1orders~1anonymize-after/put/requestBody/content/application~1json/examples/application~1json-auto"]}},"responseCodes":["204","400"],"pointer":"/v1/orders/anonymize-after","href":"orders/updateanonymizeafterdate","openApiOperationId":"updateAnonymizeAfterDate","summary":"updateAnonymizeAfterDate - Update anonymization date for orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"components/schemas/UpdateAnonymizeAfterRequest","exampleIds":["paths/~1v1~1orders~1anonymize-after/put/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAnonymizeAfterRequest","exampleIds":["paths/~1v1~1orders~1anonymize-after/put/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successfully updated the anonymize_after date for all orders of the request. No additional content is provided."},"children":[]}]}]}]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one the item of the payload is invalid. The entire request is canceled, none of the anonymize_after date have been updated. Common errors include: - referencing an order that does not exist - trying to set an anonymize_after date in the past"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the error message for more details."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1anonymize-after/put/responses/400/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1anonymize-after/put/responses/400/content/application~1json/examples/application~1json-auto"]}],"pointer":"/paths/~1v1~1orders~1anonymize-after/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1anonymize-after/put/responses/400/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1anonymize-after/put/responses/400/content/application~1json/examples/application~1json-auto"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/orders/anonymize-after"},{"label":"uploadOrderDocument - Upload order document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/orders/uploadorderdocument","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/orders/uploadorderdocument","metadata":{"seo":{"title":"uploadOrderDocument - Upload order document","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadOrderDocument","name":"uploadOrderDocument - Upload order document","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{channel_order_id}~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"uploadOrderDocument - Upload order document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this API to upload a document for an order or its related entities (e.g. returns)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: On each new document on the order"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: On each new document on the order"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:order-document:upload"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_order_id","in":"path","schemaId":"schema_3","description":"Order identifier from the channel","required":true,"example":"COMMERCIAL_ID-A"}],"pointer":"/paths/~1v1~1orders~1{channel_order_id}~1documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents/post/requestBody/content/multipart~1form-data/examples/multipart~1form-data-auto"]}},"schemaId":"schema_5","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents/post/requestBody/content/multipart~1form-data/examples/multipart~1form-data-auto"],"pointer":"/paths/~1v1~1orders~1{channel_order_id}~1documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/{channel_order_id}/documents","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[{"name":"channel_order_id","in":"path","required":true,"example":"COMMERCIAL_ID-A","schemaId":"schema_3","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:order-document:upload"]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_5","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents/post/requestBody/content/multipart~1form-data/examples/multipart~1form-data-auto"]}},"responseCodes":["204","400"],"pointer":"/v1/orders/{channel_order_id}/documents","href":"orders/uploadorderdocument","openApiOperationId":"uploadOrderDocument","summary":"uploadOrderDocument - Upload order document"},"definitionSamples":[{"lang":"cURL","source":"curl -i -X POST \\\n  https://miraklconnect.com/api/channel-platform/v1/orders/{channel_order_id}/documents \\\n  -H 'Content-Type: multipart/form-data' \\\n  -F 'file=@path/to/file' \\\n  -F 'origin=\"{\\\"channel_id\\\":\\\"string\\\",\\\"channel_store_id\\\":\\\"string\\\",\\\"sub_channel_code\\\":\\\"string\\\"}\";type=application/json' \\\n  -F 'metadata=\"{\\\"channel_document_id\\\":\\\"string\\\",\\\"filename\\\":\\\"UPS_1Z999AA10123456784.pdf\\\",\\\"type\\\":\\\"RETURN_LABEL\\\",\\\"channel_type\\\":\\\"string\\\",\\\"entity\\\":{\\\"id\\\":\\\"caf30673-ea3d-4113-9a18-674850f6a290\\\",\\\"type\\\":\\\"RETURN\\\"}}\";type=application/json'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"schema_5","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents/post/requestBody/content/multipart~1form-data/examples/multipart~1form-data-auto"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents/post/requestBody/content/multipart~1form-data/examples/multipart~1form-data-auto"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents/post/responses/400/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents/post/responses/400/content/application~1json/examples/application~1json-auto"]}],"pointer":"/paths/~1v1~1orders~1{channel_order_id}~1documents/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents/post/responses/400/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1{channel_order_id}~1documents/post/responses/400/content/application~1json/examples/application~1json-auto"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/orders/{channel_order_id}/documents"},{"label":"upsertOrders - Upsert orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/orders/upsertorders","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/orders/upsertorders","metadata":{"seo":{"title":"upsertOrders - Upsert orders","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertOrders","name":"upsertOrders - Upsert orders","isWebhook":false,"pointer":"/paths/~1v1~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"upsertOrders - Upsert orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this API to synchronize orders with Mirakl Connect."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not partially successful"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": if any order in the payload is invalid, the entire request is rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API does not support PATCH operations. All fields must be sent with each upsert request to ensure the complete update of the order data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel_updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp is older than the value already stored in Connect are silently ignored (anti-replay guard)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: 20 / sec"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: 30 / sec"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:orders:upsert"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpsertOrdersRequest","exampleIds":["paths/~1v1~1orders/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/UpsertOrdersRequest","exampleIds":["paths/~1v1~1orders/post/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/~1v1~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:orders:upsert"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpsertOrdersRequest","exampleIds":["paths/~1v1~1orders/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"responseCodes":["204","400","404"],"pointer":"/v1/orders","href":"orders/upsertorders","openApiOperationId":"upsertOrders","summary":"upsertOrders - Upsert orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"components/schemas/UpsertOrdersRequest","exampleIds":["paths/~1v1~1orders/post/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpsertOrdersRequest","exampleIds":["paths/~1v1~1orders/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders/post/responses/400/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders/post/responses/400/content/application~1json/examples/application~1json-auto"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A critical resource was not found. This may occur if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channel or its technology is unknown to Connect"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The store is unknown to Connect"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders/post/responses/404/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders/post/responses/404/content/application~1json/examples/application~1json-auto"]}],"pointer":"/paths/~1v1~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders/post/responses/400/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders/post/responses/400/content/application~1json/examples/application~1json-auto"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders/post/responses/404/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders/post/responses/404/content/application~1json/examples/application~1json-auto"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/orders"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/orders/{channel_order_id}/documents/{channel_document_id}","summary":"deleteOrderDocument - Delete order document","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/deleteorderdocument","deprecated":false},{"title":"/v1/orders/actions/{action_id}","summary":"updateActionStatus - Update asynchronous action status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/updateactionstatus","deprecated":false},{"title":"/v1/orders/anonymize-after","summary":"updateAnonymizeAfterDate - Update anonymization date for orders","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/updateanonymizeafterdate","deprecated":false},{"title":"/v1/orders/{channel_order_id}/documents","summary":"uploadOrderDocument - Upload order document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/uploadorderdocument","deprecated":false},{"title":"/v1/orders","summary":"upsertOrders - Upsert orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/upsertorders","deprecated":false}]}]}]}]}},{"type":"group","label":"Warehouse","link":"/content/product/connect-channel-platform/rest/connect/openapi3/warehouse","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/warehouse","items":[{"label":"getStoreWarehouses - Get the warehouses of a store\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/warehouse/getstorewarehouses","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/warehouse/getstorewarehouses","metadata":{"seo":{"title":"getStoreWarehouses - Get the warehouses of a store\n","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStoreWarehouses","name":"getStoreWarehouses - Get the warehouses of a store\n","isWebhook":false,"pointer":"/paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"getStoreWarehouses - Get the warehouses of a store\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the warehouses linked to a store."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An empty list is returned when no warehouse is linked to the store."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:store:read"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_6","required":true},{"name":"channel_store_id","in":"path","schemaId":"schema_7","required":true}],"pointer":"/paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/channels/{channel_id}/stores/{channel_store_id}/warehouses","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"schemaId":"schema_6","style":"simple","explode":false},{"name":"channel_store_id","in":"path","required":true,"schemaId":"schema_7","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:store:read"]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/channels/{channel_id}/stores/{channel_store_id}/warehouses","href":"warehouse/getstorewarehouses","openApiOperationId":"getStoreWarehouses","summary":"getStoreWarehouses - Get the warehouses of a store\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of warehouses linked to the store","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/200/content/application~1json/examples/application~1json-auto"]}},"schemaId":"schema_8","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/200/content/application~1json/examples/application~1json-auto"]},{"code":"400","description":"Bad Request Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/400/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/400/content/application~1json/examples/application~1json-auto"]},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/401/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/401/content/application~1json/examples/application~1json-auto"]},{"code":"403","description":"Forbidden Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/403/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/403/content/application~1json/examples/application~1json-auto"]},{"code":"404","description":"Not Found Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/404/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/404/content/application~1json/examples/application~1json-auto"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/500/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/500/content/application~1json/examples/application~1json-auto"]}],"pointer":"/paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_8","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/200/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/200/content/application~1json/examples/application~1json-auto"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/400/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/400/content/application~1json/examples/application~1json-auto"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/401/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/401/content/application~1json/examples/application~1json-auto"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/403/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/403/content/application~1json/examples/application~1json-auto"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/404/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/404/content/application~1json/examples/application~1json-auto"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/500/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/500/content/application~1json/examples/application~1json-auto"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/channels/{channel_id}/stores/{channel_store_id}/warehouses"}],"content":{"contentType":"group","meta":{"name":"Warehouse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Warehouse","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/channels/{channel_id}/stores/{channel_store_id}/warehouses","summary":"getStoreWarehouses - Get the warehouses of a store\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/warehouse/getstorewarehouses","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Feedback","link":"/content/product/connect-channel-platform/rest/connect/openapi3/product-feedback","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/product-feedback","items":[{"label":"updateStoreCatalogItems - Update Store Catalog Items for a given channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/product-feedback/updatestorecatalogitems","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/product-feedback/updatestorecatalogitems","metadata":{"seo":{"title":"updateStoreCatalogItems - Update Store Catalog Items for a given channel","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateStoreCatalogItems","name":"updateStoreCatalogItems - Update Store Catalog Items for a given channel","isWebhook":false,"pointer":"/paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"updateStoreCatalogItems - Update Store Catalog Items for a given channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the store catalog items for a specific channel with the provided product IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the specified store does not exist in Mirakl Connect, a 404 error is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an asynchronous operation - the request is accepted and processed in the background."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products that do not exist in Mirakl Connect are silently ignored (no error returned when the request is accepted)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successfully matched products will be updated regardless of unmatched products in the same request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: 20 per second"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: 30 per second"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:store-catalog-items:update"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_0","description":"Connect Channel identifier","required":true},{"name":"store_id","in":"path","schemaId":"schema_9","description":"Store identifier in the channel","required":true,"deprecated":true}],"pointer":"/paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json; charset=UTF-8"],"mediaTypeSchemas":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/UpdateStoreCatalogItemsRequest","exampleIds":["paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"schemaId":"components/schemas/UpdateStoreCatalogItemsRequest","exampleIds":["paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"],"pointer":"/paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/channel-catalog/{channel_id}/store-catalog-items/{store_id}","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"schemaId":"schema_0","style":"simple","explode":false},{"name":"store_id","in":"path","required":true,"schemaId":"schema_9","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:store-catalog-items:update"]}],"requestBody":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/UpdateStoreCatalogItemsRequest","exampleIds":["paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"responseCodes":["202","400","404"],"pointer":"/v1/channel-catalog/{channel_id}/store-catalog-items/{store_id}","href":"product-feedback/updatestorecatalogitems","openApiOperationId":"updateStoreCatalogItems","summary":"updateStoreCatalogItems - Update Store Catalog Items for a given channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"components/schemas/UpdateStoreCatalogItemsRequest","exampleIds":["paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"],"mediaTypes":["application/json; charset=UTF-8"],"mediaTypeSchemas":{"application/json; charset=UTF-8":{"schemaId":"components/schemas/UpdateStoreCatalogItemsRequest","exampleIds":["paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request accepted for processing.\n\nThe store catalog items update has been queued and will be processed asynchronously.\nNon-existent products will be silently ignored during processing.\n"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request - the request body does not match the API contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body is an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/problem+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" document with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array lists the violations found (up to a maximum, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then says the list is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"truncated). Each error gives the JSON path of the offending value in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the whole document)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and what is wrong in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"code":"404","description":"Channel or Store not found in Mirakl Connect."}],"pointer":"/paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post/responses"}],"panels":[]}]},"httpPath":"/v1/channel-catalog/{channel_id}/store-catalog-items/{store_id}"}],"content":{"contentType":"group","meta":{"name":"Product Feedback"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Feedback","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/channel-catalog/{channel_id}/store-catalog-items/{store_id}","summary":"updateStoreCatalogItems - Update Store Catalog Items for a given channel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-feedback/updatestorecatalogitems","deprecated":false}]}]}]}]}},{"type":"group","label":"Store","link":"/content/product/connect-channel-platform/rest/connect/openapi3/store","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/store","items":[{"label":"upsertBusinessInformation - Update business information of a store\n","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/store/upsertbusinessinformation","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/store/upsertbusinessinformation","metadata":{"seo":{"title":"upsertBusinessInformation - Update business information of a store\n","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertBusinessInformation","name":"upsertBusinessInformation - Update business information of a store\n","isWebhook":false,"pointer":"/paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"upsertBusinessInformation - Update business information of a store\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update business information of a store."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Those information will be displayed to the seller in Mirakl Connect."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They are mandatory to consider a store as usable in Mirakl Connect."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is replacing all data at once. Developer have to provide the complete state every time."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: 1 per minute"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: 5 per minute"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:store:write"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_9","required":true},{"name":"channel_store_id","in":"path","schemaId":"schema_7","required":true}],"pointer":"/paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessInformationInput","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/BusinessInformationInput","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/requestBody","description":"Input to update business information of a store"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/channels/{channel_id}/stores/{channel_store_id}","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"schemaId":"schema_9","style":"simple","explode":false},{"name":"channel_store_id","in":"path","required":true,"schemaId":"schema_7","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:store:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessInformationInput","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/requestBody/content/application~1json/examples/application~1json-auto"]}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/channels/{channel_id}/stores/{channel_store_id}","href":"store/upsertbusinessinformation","openApiOperationId":"upsertBusinessInformation","summary":"upsertBusinessInformation - Update business information of a store\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"components/schemas/BusinessInformationInput","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessInformationInput","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Store information updated"},{"code":"400","description":"Bad Request Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/400/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/400/content/application~1json/examples/application~1json-auto"]},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/401/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/401/content/application~1json/examples/application~1json-auto"]},{"code":"403","description":"Forbidden Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/403/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/403/content/application~1json/examples/application~1json-auto"]},{"code":"404","description":"Not Found Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/404/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/404/content/application~1json/examples/application~1json-auto"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/500/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/500/content/application~1json/examples/application~1json-auto"]}],"pointer":"/paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/400/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/400/content/application~1json/examples/application~1json-auto"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/401/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/401/content/application~1json/examples/application~1json-auto"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/403/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/403/content/application~1json/examples/application~1json-auto"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/404/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/404/content/application~1json/examples/application~1json-auto"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/500/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/500/content/application~1json/examples/application~1json-auto"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/channels/{channel_id}/stores/{channel_store_id}"}],"content":{"contentType":"group","meta":{"name":"Store"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Store","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/channels/{channel_id}/stores/{channel_store_id}","summary":"upsertBusinessInformation - Update business information of a store\n","prefix":{"name":"put","color":"put"},"badges":[],"link":"/store/upsertbusinessinformation","deprecated":false}]}]}]}]}},{"type":"group","label":"Carriers","link":"/content/product/connect-channel-platform/rest/connect/openapi3/carriers","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/carriers","items":[{"label":"upsertCarriers - Upsert carriers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/carriers/upsertcarriers","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/carriers/upsertcarriers","metadata":{"seo":{"title":"upsertCarriers - Upsert carriers","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertCarriers","name":"upsertCarriers - Upsert carriers","isWebhook":false,"pointer":"/paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"upsertCarriers - Upsert carriers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this API to share the channel's allowed list of carriers with Mirakl Connect, and keep it synchronized over time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must provide the complete list of carriers in a single request, any carriers not included will be deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the marketplace allows it, you can add an \"Other\" carrier to cover unlisted carriers; otherwise, only include formally supported carriers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend sharing the full list of carriers: Mirakl Connect automatically maps carriers with slight naming differences"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: When the channel's allowed list of carriers changes"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: 1 / hour"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:carrier:upsert"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_3","description":"Unique identifier of the sales channel","required":true}],"pointer":"/paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpsertCarriersRequest","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/UpsertCarriersRequest","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/channels/{channel_id}/carriers","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"schemaId":"schema_3","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:carrier:upsert"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpsertCarriersRequest","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"responseCodes":["204","400","404"],"pointer":"/v1/orders/channels/{channel_id}/carriers","href":"carriers/upsertcarriers","openApiOperationId":"upsertCarriers","summary":"upsertCarriers - Upsert carriers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"components/schemas/UpsertCarriersRequest","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpsertCarriersRequest","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/400/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/400/content/application~1json/examples/application~1json-auto"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channel was not found. This may occur if: - The channel_id does not exist - The channel does not belong to the calling connector's technology"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/404/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/404/content/application~1json/examples/application~1json-auto"]}],"pointer":"/paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/400/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/400/content/application~1json/examples/application~1json-auto"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/404/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/404/content/application~1json/examples/application~1json-auto"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/orders/channels/{channel_id}/carriers"}],"content":{"contentType":"group","meta":{"name":"Carriers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Carriers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/orders/channels/{channel_id}/carriers","summary":"upsertCarriers - Upsert carriers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/carriers/upsertcarriers","deprecated":false}]}]}]}]}},{"type":"group","label":"Returns","link":"/content/product/connect-channel-platform/rest/connect/openapi3/returns","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/returns","items":[{"label":"upsertReturns - Upsert returns","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/content/product/connect-channel-platform/rest/connect/openapi3/returns/upsertreturns","routeSlug":"/content/product/connect-channel-platform/rest/connect/openapi3/returns/upsertreturns","metadata":{"seo":{"title":"upsertReturns - Upsert returns","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertReturns","name":"upsertReturns - Upsert returns","isWebhook":false,"pointer":"/paths/~1v1~1orders~1returns/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"upsertReturns - Upsert returns","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this API to synchronize returns with Mirakl Connect."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"returns/upsertreturns/request/overview","deepLinkHash":"/returns/upsertreturns#returns/upsertreturns/request/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns are always associated to an order already known by Mirakl Connect"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each return line must reference an order line already known by Mirakl Connect"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API performs an upsert: existing returns are updated, new ones are created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partially successful"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": some returns in the payload can succeed while others fail"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"returns/upsertreturns/request/usage-notes","deepLinkHash":"/returns/upsertreturns#returns/upsertreturns/request/usage-notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must reference an order previously synchronized through the orders API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel_order_line_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must reference an order line previously synchronized through the orders API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API does not support PATCH operations. Always send all fields for each return."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the request is syntactically valid, HTTP status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" even if some or all returns failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global failures are reported with standard HTTP errors: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for invalid payloads and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for unknown global resources (such as channel or store)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"api-description-extension"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"extension-title"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Call Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"recommended-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recommended usage: Every 5 minutes"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"max-call-frequency"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum usage: Once per minute"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":["connect-channel-platform:order-returns:upsert"],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpsertReturnsRequest","exampleIds":["paths/~1v1~1orders~1returns/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/UpsertReturnsRequest","exampleIds":["paths/~1v1~1orders~1returns/post/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/~1v1~1orders~1returns/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/returns","servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":["connect-channel-platform:order-returns:upsert"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpsertReturnsRequest","exampleIds":["paths/~1v1~1orders~1returns/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"responseCodes":["200","400","404"],"pointer":"/v1/orders/returns","href":"returns/upsertreturns","openApiOperationId":"upsertReturns","summary":"upsertReturns - Upsert returns"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"schemaId":"components/schemas/UpsertReturnsRequest","exampleIds":["paths/~1v1~1orders~1returns/post/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpsertReturnsRequest","exampleIds":["paths/~1v1~1orders~1returns/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Detailed per-return upsert result. Response body contains success and error details for each return.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpsertReturnsResponse","exampleIds":["paths/~1v1~1orders~1returns/post/responses/200/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/UpsertReturnsResponse","exampleIds":["paths/~1v1~1orders~1returns/post/responses/200/content/application~1json/examples/application~1json-auto"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1returns/post/responses/400/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1returns/post/responses/400/content/application~1json/examples/application~1json-auto"]},{"code":"404","description":"A critical resource was not found. This may occur if: - The channel or its technology is unknown to connect - The store is unknown to connect","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1returns/post/responses/404/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1returns/post/responses/404/content/application~1json/examples/application~1json-auto"]}],"pointer":"/paths/~1v1~1orders~1returns/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpsertReturnsResponse","exampleIds":["paths/~1v1~1orders~1returns/post/responses/200/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpsertReturnsResponse","exampleIds":["paths/~1v1~1orders~1returns/post/responses/200/content/application~1json/examples/application~1json-auto"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1returns/post/responses/400/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1returns/post/responses/400/content/application~1json/examples/application~1json-auto"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1returns/post/responses/404/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1v1~1orders~1returns/post/responses/404/content/application~1json/examples/application~1json-auto"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/orders/returns"}],"content":{"contentType":"group","meta":{"name":"Returns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/orders/returns","summary":"upsertReturns - Upsert returns","prefix":{"name":"post","color":"post"},"badges":[],"link":"/returns/upsertreturns","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ActionError":{"id":"components/schemas/ActionError","kind":"json-schema","title":"ActionError","data":{"type":"object","description":"Detailed information about an error encountered during action processing","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code identifying the type of failure."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"INVALID_INPUT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DATA_NOT_FOUND\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"UNEXPECTED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"UNAVAILABLE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TOO_MANY_REQUEST\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ACTION_NOT_SUPPORTED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ORDER_IN_WRONG_STATE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"RETURN_IN_WRONG_STATE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CARRIER_NOT_SUPPORTED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"MISSING_CARRIER\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"WAREHOUSE_ID_NOT_FOUND\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"WAREHOUSE_ID_REQUIRED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OTHER\""},"children":[]}]}]}]},"message":{"type":"string","description":"Human-readable description of the error.\n","examples":["Cannot process cancellation: order is already shipped"]}},"required":["code","message"]}},"components/schemas/AddressRequest":{"id":"components/schemas/AddressRequest","kind":"json-schema","title":"AddressRequest","data":{"type":"object","properties":{"additional_info":{"type":"string","description":"Additional delivery instructions or notes."},"city":{"type":"string","description":"City."},"company":{"type":"string","description":"Company name, if applicable."},"country":{"type":"string","description":"Country name."},"country_iso_code":{"type":"string","description":"ISO 3166-1 alpha-3 country code (e.g. FRA, USA, DEU)."},"first_name":{"type":"string","description":"Recipient's first name."},"last_name":{"type":"string","description":"Recipient's last name."},"phone":{"type":"string","description":"Phone number of the recipient."},"state":{"type":"string","description":"State or region."},"street":{"type":"string","description":"Street name and number. Strongly recommended for accurate delivery; may be omitted for block-based address systems (e.g. Japan)."},"street_additional_info":{"type":"string","description":"Additional street information (apartment, floor, building, etc.)."},"zip_code":{"type":"string","description":"Postal or ZIP code."}},"required":["city","last_name"]}},"components/schemas/AdjustmentRequest":{"id":"components/schemas/AdjustmentRequest","kind":"json-schema","title":"AdjustmentRequest","data":{"type":"object","properties":{"channel_adjustment_id":{"type":"string","description":"Unique identifier of the adjustment on the channel."},"created_at":{"type":"string","format":"date-time","description":"Date and time when the adjustment was created on the channel."},"price":{"$ref":"#/components/schemas/Money","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunded or cancelled amount, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Taxes on the adjusted product amount are listed separately in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"quantity":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of units affected by this adjustment. For a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is the number of units cancelled. For a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is the number of units for which the refund applies."},"children":[]}]}]}]},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business reason for the adjustment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CUSTOMER_CANCELATION\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OUT_OF_STOCK\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"RETURN\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ITEM_NOT_RECEIVED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AGREEMENT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DEFECT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"UNABLE_TO_DELIVER\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CHANNEL_SPECIFIC\""},"children":[]}]}]}]},"shipping_price":{"$ref":"#/components/schemas/Money","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunded or cancelled shipping amount, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Shipping taxes are listed separately in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipping_taxes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"shipping_taxes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taxes on the adjusted shipping amount. These amounts are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipping_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TaxRequest"}},"taxes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunded or cancelled taxes. These amounts should "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TaxRequest"}},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nature of the adjustment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means units were removed from the line (quantity reduction); connect will release the corresponding stock reservation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a monetary compensation was issued without changing the ordered quantity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REFUND\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CANCELATION\""},"children":[]}]}]}]}},"required":["channel_adjustment_id","created_at","price","quantity","reason","shipping_price","type"]}},"components/schemas/Attribute":{"id":"components/schemas/Attribute","kind":"json-schema","title":"Attribute","data":{"type":"object","discriminator":{"mapping":{"Boolean":"#/components/schemas/BooleanAttribute","List":"#/components/schemas/ListAttribute","Numeric":"#/components/schemas/NumericAttribute","Text":"#/components/schemas/TextAttribute"},"propertyName":"type"},"properties":{"configuration_modes":{"type":"array","description":"List of accepted configuration modes for providing the value","items":{"$ref":"#/components/schemas/ConfigurationMode"},"minItems":1},"descriptions":{"type":"array","description":"Additional attribute descriptions","items":{"$ref":"#/components/schemas/Localized"}},"id":{"type":"string","description":"Id of the attribute","minLength":1},"labels":{"type":"array","description":"Labels of the attribute","items":{"$ref":"#/components/schemas/Localized"},"minItems":1},"requirement_level":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement level of the attribute"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OPTIONAL\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"RECOMMENDED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REQUIRED\""},"children":[]}]}]}]},"type":{"$ref":"#/components/schemas/AttributeType"}},"required":["configuration_modes","id","labels","requirement_level","type"]}},"components/schemas/AttributeContext":{"id":"components/schemas/AttributeContext","kind":"json-schema","title":"AttributeContext","data":{"type":"object","description":"Additional context information about where this attribute label is located within \nthe marketplace's data structure. This helps with catalog transformation.\n","properties":{"labels":{"type":"array","description":"List of labels context for the attribute","items":{"$ref":"#/components/schemas/Localized"}},"path":{"type":"string","description":"The path indicating where this attribute label is located in the marketplace's data structure.\nUsed for data mapping and transformation purposes.\n"}}}},"components/schemas/AttributeType":{"id":"components/schemas/AttributeType","kind":"json-schema","title":"AttributeType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Boolean\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Numeric\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Text\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"List\""},"children":[]}]}]}]}},"components/schemas/Behaviors":{"id":"components/schemas/Behaviors","kind":"json-schema","title":"Behaviors","data":{"type":"object","properties":{"emit_group_of_products":{"anyOf":[{"$ref":"#/components/schemas/ConnectStandardAttributesForGroupUpsert"},{"type":"null"}],"description":"Connect standard attribute that can be used to group product updates.\n"}}}},"components/schemas/BillingInfoRequest":{"id":"components/schemas/BillingInfoRequest","kind":"json-schema","title":"BillingInfoRequest","data":{"type":"object","description":"Billing information for invoice and payment purposes. Optional.","properties":{"address":{"$ref":"#/components/schemas/AddressRequest","description":"Billing address used for invoice and payment purposes."}}}},"components/schemas/BooleanAttribute":{"id":"components/schemas/BooleanAttribute","kind":"json-schema","title":"BooleanAttribute","data":{"allOf":[{"$ref":"#/components/schemas/Attribute"},{"type":"object","properties":{"default_value":{"type":"boolean","description":"Default boolean value of the attribute, used for required attributes only"}}}]}},"components/schemas/BusinessInformationInput":{"id":"components/schemas/BusinessInformationInput","kind":"json-schema","title":"BusinessInformationInput","data":{"type":"object","properties":{"currency":{"type":"string","description":"Currency tag, expected in ISO 4217 format. Cannot be changed later.","example":"USD","maxLength":3,"minLength":1,"pattern":"^[A-Z]{3}$"},"kyc_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC (Know Your Customer) status of the configuration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If KYC is not required, the status will be set to NOT_REQUIRED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PENDING_SUBMISSION\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PENDING_APPROVAL\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REFUSED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"APPROVED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NOT_REQUIRED\""},"children":[]}]}]}]},"kyc_status_reason":{"type":"string","description":"Reason of a problem with the KYC configuration.\nThis information can be displayed to the seller if needed in Mirakl Connect\n"},"missing_configuration":{"type":"boolean","description":"Indicates if the store is missing configuration to be properly functioning.\nThis can be either required information not filled or documents not sent.\nFalse indicates that there is no missing configuration for the store.\nTrue will raise a warning to the seller stating that they need to configure their store.\n"},"payment_information_configured":{"type":"boolean","description":"Indicates if a payment method is configured for the store.\n"},"payment_information_warning":{"type":"string","description":"Reason of a problem with the payment configuration.\nA null value indicates no problems encountered, payment configuration is valid.\nAny content will raise a warning in Mirakl Connect for the seller stating that there might be a problem \nwith how their payment method is configured in the Marketplace where their store is located.\n"},"quality_suspension_reasons":{"type":"array","description":"List of reasons for the suspension of the store related to quality standard defined by the Marketplace.\nA null or empty value indicates no problems encountered, store is not suspended.\nAny content will raise a warning in Mirakl Connect for the seller stating that there might be \nquality issues with their store.\n","items":{"$ref":"#/components/schemas/QualitySuspensionReason"}},"shipping_warning":{"type":"string","description":"Reason of a problem with the shipping configuration.\nA null value indicates no problems encountered, shipping configuration is valid.\n"},"sub_channels":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of sales channels inside the Marketplace where the store is located."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is useful for marketplaces where sellers have a global product catalog with multiple sales channels."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One store can be provided per seller with as many sub channels as the sales channels the store operates in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By doing so, the store will receive offers, prices and stock updates per sub channel. Product events will come once for the store."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub channels are a critical part, it can impact the business of a seller."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By deleting one the seller participates in, all offers synchronization will stop for the marketplace sales channel it relates to. Orders should also not be sent anymore to Connect."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior for the sub channel field:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be null if it was never filled before."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be an empty array if it was never filled before."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be emptied if there was at least one item before."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a new sub channel: add it to the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing sub channel: update the item in the list with the same id."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete an existing sub channel: remove it from the list."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/SubChannel"}},"updated_at":{"type":"string","format":"date-time","description":"Date of the last update of the store information.\nOlder event for a store will not be saved.\n"}},"required":["currency","updated_at"]}},"components/schemas/CarrierRequest":{"id":"components/schemas/CarrierRequest","kind":"json-schema","title":"CarrierRequest","data":{"type":"object","properties":{"channel_carrier_id":{"type":"string","description":"Unique identifier of the carrier on the channel"},"name":{"type":"string","description":"Display name of the carrier"}},"required":["channel_carrier_id","name"]}},"components/schemas/ChannelCatalogCapabilities":{"id":"components/schemas/ChannelCatalogCapabilities","kind":"json-schema","title":"ChannelCatalogCapabilities","data":{"type":"object","properties":{"behaviors":{"$ref":"#/components/schemas/Behaviors"},"discount_prices":{"$ref":"#/components/schemas/DataConfiguration"},"offer_configuration":{"$ref":"#/components/schemas/OfferConfiguration"},"standard_prices":{"$ref":"#/components/schemas/DataConfiguration"},"stock_quantities":{"$ref":"#/components/schemas/StockDataConfiguration"},"use_case_configurations":{"$ref":"#/components/schemas/UseCaseConfigurations"}}}},"components/schemas/ConfigurationMode":{"id":"components/schemas/ConfigurationMode","kind":"json-schema","title":"ConfigurationMode","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user can configure an attribute via:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONSTANT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a constant value for all the catalog"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VARIABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a value that can be different for each item, based on an attribute"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CONSTANT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"VARIABLE\""},"children":[]}]}]}]}},"components/schemas/ConnectStandardAttribute":{"id":"components/schemas/ConnectStandardAttribute","kind":"json-schema","title":"ConnectStandardAttribute","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equivalent of the attribute in Connect standard taxonomy"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PRODUCT_ID\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CATEGORY\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"BRAND\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TITLE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DESCRIPTION\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"IMAGE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"GTIN\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"VARIANT_GROUP_CODE\""},"children":[]}]}]}]}},"components/schemas/ConnectStandardAttributesForGroupUpsert":{"id":"components/schemas/ConnectStandardAttributesForGroupUpsert","kind":"json-schema","title":"ConnectStandardAttributesForGroupUpsert","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of standard attributes that can be used to group product updates"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"BRAND\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"VARIANT_GROUP_CODE\""},"children":[]}]}]}]}},"components/schemas/CustomAttributeBooleanRequest":{"id":"components/schemas/CustomAttributeBooleanRequest","kind":"json-schema","title":"CustomAttributeBooleanRequest","data":{"allOf":[{"$ref":"#/components/schemas/CustomAttributeRequest"},{"type":"object","properties":{"value":{"type":"boolean","description":"Attribute's boolean value","examples":["true"]}}}],"required":["id","type","value"]}},"components/schemas/CustomAttributeDateRequest":{"id":"components/schemas/CustomAttributeDateRequest","kind":"json-schema","title":"CustomAttributeDateRequest","data":{"allOf":[{"$ref":"#/components/schemas/CustomAttributeRequest"},{"type":"object","properties":{"value":{"type":"string","format":"date-time","description":"Attribute's date value","examples":["2024-01-27T09:24:36.326Z"]}}}],"required":["id","type","value"]}},"components/schemas/CustomAttributeListRequest":{"id":"components/schemas/CustomAttributeListRequest","kind":"json-schema","title":"CustomAttributeListRequest","data":{"allOf":[{"$ref":"#/components/schemas/CustomAttributeRequest"},{"type":"object","properties":{"value":{"type":"array","description":"Additional attribute values","items":{"type":"string","maxLength":10000},"maxItems":1000,"minItems":1}}}],"required":["id","type","value"]}},"components/schemas/CustomAttributeNumericRequest":{"id":"components/schemas/CustomAttributeNumericRequest","kind":"json-schema","title":"CustomAttributeNumericRequest","data":{"allOf":[{"$ref":"#/components/schemas/CustomAttributeRequest"},{"type":"object","properties":{"value":{"type":"number","format":"with decimals","description":"Attribute's numeric value","examples":["1234.56"],"maximum":1000000000,"minimum":-1000000000}}}],"required":["id","type","value"]}},"components/schemas/CustomAttributeRequest":{"id":"components/schemas/CustomAttributeRequest","kind":"json-schema","title":"CustomAttributeRequest","data":{"type":"object","description":"A custom attribute.","discriminator":{"mapping":{"BOOLEAN":"#/components/schemas/CustomAttributeBooleanRequest","DATE":"#/components/schemas/CustomAttributeDateRequest","LIST":"#/components/schemas/CustomAttributeListRequest","NUMERIC":"#/components/schemas/CustomAttributeNumericRequest","STRING":"#/components/schemas/CustomAttributeStringRequest"},"propertyName":"type"},"properties":{"id":{"type":"string","description":"Attribute's id","maxLength":255,"minLength":1},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The attribute's type"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"STRING\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NUMERIC\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"BOOLEAN\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DATE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"LIST\""},"children":[]}]}]}]}},"required":["id","type"]}},"components/schemas/CustomAttributeStringRequest":{"id":"components/schemas/CustomAttributeStringRequest","kind":"json-schema","title":"CustomAttributeStringRequest","data":{"allOf":[{"$ref":"#/components/schemas/CustomAttributeRequest"},{"type":"object","properties":{"value":{"type":"string","description":"Attribute's string value","examples":["red"],"maxLength":100000}}}],"required":["id","type","value"]}},"components/schemas/CustomAttributesRequest":{"id":"components/schemas/CustomAttributesRequest","kind":"json-schema","title":"CustomAttributesRequest","data":{"type":"array","description":"Custom attributes","items":{"$ref":"#/components/schemas/CustomAttributeRequest"},"maxItems":1000,"minItems":0}},"components/schemas/DataConfiguration":{"id":"components/schemas/DataConfiguration","kind":"json-schema","title":"DataConfiguration","data":{"type":"object","properties":{"lifecycle":{"$ref":"#/components/schemas/Lifecycle"},"per_store_default":{"$ref":"#/components/schemas/PerStoreDefault"}},"required":["lifecycle"]}},"components/schemas/Diagnostic":{"id":"components/schemas/Diagnostic","kind":"json-schema","title":"Diagnostic","data":{"type":"object","description":"Represents a diagnostic message related to a catalog item.","properties":{"channel_attribute_id":{"type":["string","null"],"description":"The identifier of the channel attribute related to the diagnostic."},"channel_diagnostic_id":{"type":["string","null"],"description":"The diagnostic identifier in the channel."},"connector_override_action":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REMOVED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},"message":{"type":"string","description":"The diagnostic message."},"severity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Says what the seller should do about the diagnostic."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applies to product_diagnostics."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ERROR"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The seller must fix the problem."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The problem is not an error yet, and the seller should fix it soon."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Nothing is wrong, the channel shared information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ERROR\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"WARNING\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"INFO\""},"children":[]}]}]}]}},"required":["message"]}},"components/schemas/DiscountPricePeriod":{"id":"components/schemas/DiscountPricePeriod","kind":"json-schema","title":"DiscountPricePeriod","data":{"type":"object","description":"Configuration for discount price period.","properties":{"end_date":{"$ref":"#/components/schemas/PricingConfigurationField"},"start_date":{"$ref":"#/components/schemas/PricingConfigurationField"},"support":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support for the discount price period"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"SUPPORTED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"UNSUPPORTED\""},"children":[]}]}]}]}},"required":["end_date","start_date","support"]}},"components/schemas/DocumentOriginRequest":{"id":"components/schemas/DocumentOriginRequest","kind":"json-schema","title":"DocumentOriginRequest","data":{"type":"object","properties":{"channel_id":{"type":"string","description":"Unique identifier of the sales channel"},"channel_store_id":{"type":"string","description":"Store identifier on the sales channel."},"sub_channel_code":{"type":"string","description":"Code of the sub-channel on which the document was uploaded."}},"required":["channel_id","channel_store_id"]}},"components/schemas/EmbeddedAttribute":{"id":"components/schemas/EmbeddedAttribute","kind":"json-schema","title":"EmbeddedAttribute","data":{"type":"object","discriminator":{"mapping":{"Decimal":"#/components/schemas/EmbeddedDecimalAttribute","Integer":"#/components/schemas/EmbeddedIntegerAttribute","List":"#/components/schemas/EmbeddedListAttribute","Media":"#/components/schemas/EmbeddedMediaAttribute","Text":"#/components/schemas/EmbeddedTextAttribute"},"propertyName":"type"},"properties":{"connect_standard_attributes":{"type":"array","description":"Map one attribute per standard type (e.g., your main image attribute to IMAGE). \nFor multi-lingual catalogs, multiple locale-specific attributes may map to TITLE and DESCRIPTION.\n","items":{"$ref":"#/components/schemas/ConnectStandardAttribute"}},"context":{"$ref":"#/components/schemas/AttributeContext"},"descriptions":{"type":"array","description":"Additional attribute descriptions with their associated locale","items":{"$ref":"#/components/schemas/Localized"}},"id":{"$ref":"#/components/schemas/ProductAttributeId"},"labels":{"type":"array","description":"Labels for the attribute with their associated locale","items":{"$ref":"#/components/schemas/Localized"},"minItems":1},"requirement_level":{"$ref":"#/components/schemas/RequirementLevel"},"type":{"$ref":"#/components/schemas/ProductAttributeType"}},"required":["descriptions","id","labels","requirement_level","type"]}},"components/schemas/EmbeddedDecimalAttribute":{"id":"components/schemas/EmbeddedDecimalAttribute","kind":"json-schema","title":"EmbeddedDecimalAttribute","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/EmbeddedAttribute"}],"examples":["42.3"],"properties":{"maximum":{"type":"number","format":"double","description":"The maximum allowed value (inclusive)","example":1000000},"minimum":{"type":"number","format":"double","description":"The minimum number allowed (inclusive)","example":0},"scale":{"type":"integer","description":"Number of decimal places","minimum":0}},"required":["scale"]}},"components/schemas/EmbeddedIntegerAttribute":{"id":"components/schemas/EmbeddedIntegerAttribute","kind":"json-schema","title":"EmbeddedIntegerAttribute","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/EmbeddedAttribute"}],"examples":["42"],"properties":{"maximum":{"type":"integer","format":"int64","description":"The maximum Number allowed","example":9999},"minimum":{"type":"integer","format":"int64","description":"The minimum number allowed","example":-9999}}}},"components/schemas/EmbeddedListAttribute":{"id":"components/schemas/EmbeddedListAttribute","kind":"json-schema","title":"EmbeddedListAttribute","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/EmbeddedAttribute"}],"properties":{"available_values":{"type":"array","description":"List of available values for the attribute","items":{"$ref":"#/components/schemas/ProductListAttributeValue"},"maxItems":1000,"minItems":1},"max_values":{"type":"integer","description":"Maximum number of values a given product can have for this attribute","minimum":1}},"required":["available_values"]}},"components/schemas/EmbeddedMediaAttribute":{"id":"components/schemas/EmbeddedMediaAttribute","kind":"json-schema","title":"EmbeddedMediaAttribute","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/EmbeddedAttribute"}],"properties":{"media_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of media associated with the attribute."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"media_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMAGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this attribute serves the role of an Image (e.g., for display or illustration purposes)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"IMAGE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OTHER\""},"children":[]}]}]}]}}}},"components/schemas/EmbeddedTextAttribute":{"id":"components/schemas/EmbeddedTextAttribute","kind":"json-schema","title":"EmbeddedTextAttribute","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/EmbeddedAttribute"}],"properties":{"max_length":{"type":"integer","description":"Maximum length for Text attributes","example":255,"minimum":1},"min_length":{"type":"integer","description":"Minimum length for Text attributes","example":3,"minimum":0}}}},"components/schemas/EqualsRuleConditionPayload":{"id":"components/schemas/EqualsRuleConditionPayload","kind":"json-schema","title":"EqualsRuleConditionPayload","data":{"type":"object","additionalProperties":false,"properties":{"@type":{"type":"string"},"attribute":{"$ref":"#/components/schemas/TaxonomyRuleAttributeId"},"value":{"$ref":"#/components/schemas/EqualsRuleConditionPayloadValue"}},"required":["attribute","value"]}},"components/schemas/EqualsRuleConditionPayloadValue":{"id":"components/schemas/EqualsRuleConditionPayloadValue","kind":"json-schema","title":"EqualsRuleConditionPayloadValue","data":{"description":"The value to compare against","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"code":{"type":"string","description":"Error code (immutable)","examples":["DATA_NOT_FOUND"]},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorItem"}},"extensions":{"type":"object","description":"Free map where you find additional context data to better describe the error","examples":[{"maxLength":255,"minLength":1}]},"message":{"type":"string","description":"Literal string error description (Please do not base your error handling on this field since it is subject to change)","examples":["An error occurred while processing your request"]}},"required":["code","message"]}},"components/schemas/ErrorItem":{"id":"components/schemas/ErrorItem","kind":"json-schema","title":"ErrorItem","data":{"type":"object","properties":{"extensions":{"type":"object","description":"Free map where you find additional context data to better describe the error","examples":[{"maxLength":255,"minLength":1}]},"field":{"type":"string","description":"JsonPath to the field where the error occurred","examples":["input.account.id"]},"message":{"type":"string","description":"Literal string error item description (Please do not base your error handling on this field since it is subject to change)","examples":["An error occurred while processing your request: id is null"]}},"required":["message"]}},"components/schemas/FulfillmentRequest":{"id":"components/schemas/FulfillmentRequest","kind":"json-schema","title":"FulfillmentRequest","data":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the fulfillment partner. Only meaningful when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULFILLED_BY_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Ignored for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULFILLED_BY_SELLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates who is responsible for physically fulfilling the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FULFILLED_BY_SELLER\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FULFILLED_BY_PARTNER\""},"children":[]}]}]}]}},"required":["type"]}},"components/schemas/InRuleConditionPayload":{"id":"components/schemas/InRuleConditionPayload","kind":"json-schema","title":"InRuleConditionPayload","data":{"type":"object","additionalProperties":false,"properties":{"@type":{"type":"string"},"attribute":{"$ref":"#/components/schemas/TaxonomyRuleAttributeId"},"values":{"type":"array","description":"List of values to check against","items":{"$ref":"#/components/schemas/InRuleConditionPayloadValue"},"minItems":1}},"required":["attribute","values"]}},"components/schemas/InRuleConditionPayloadValue":{"id":"components/schemas/InRuleConditionPayloadValue","kind":"json-schema","title":"InRuleConditionPayloadValue","data":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"components/schemas/IsSetRuleConditionPayload":{"id":"components/schemas/IsSetRuleConditionPayload","kind":"json-schema","title":"IsSetRuleConditionPayload","data":{"type":"object","additionalProperties":false,"properties":{"attribute":{"$ref":"#/components/schemas/TaxonomyRuleAttributeId"}},"required":["attribute"]}},"components/schemas/Lifecycle":{"id":"components/schemas/Lifecycle","kind":"json-schema","title":"Lifecycle","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Granularity level at which the data is configured"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PER_STORE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PER_SUB_CHANNEL\""},"children":[]}]}]}]}},"components/schemas/ListAttribute":{"id":"components/schemas/ListAttribute","kind":"json-schema","title":"ListAttribute","data":{"allOf":[{"$ref":"#/components/schemas/Attribute"},{"type":"object","properties":{"default_values":{"type":"array","description":"Default values of the attribute (use the id in your attribute values), used for required attributes only","items":{"type":"string"}},"max_size":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max number of values to select. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means selection of a single value."},"children":[]}]}]}],"minimum":1},"values":{"type":"array","items":{"$ref":"#/components/schemas/ListAttributeItem","description":"List of available values"},"maxItems":100}}}],"required":["max_size","values"]}},"components/schemas/ListAttributeItem":{"id":"components/schemas/ListAttributeItem","kind":"json-schema","title":"ListAttributeItem","data":{"type":"object","properties":{"id":{"type":"string","description":"id","minLength":1},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Localized"}}},"required":["id"]}},"components/schemas/Locale":{"id":"components/schemas/Locale","kind":"json-schema","title":"Locale","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language format can be ISO-639 or ISO-639_ISO-3166"},"children":[]}]}]}],"examples":["en_US"]}},"components/schemas/Localized":{"id":"components/schemas/Localized","kind":"json-schema","title":"Localized","data":{"type":"object","properties":{"locale":{"$ref":"#/components/schemas/Locale"},"value":{"type":"string","description":"The localized value in this locale"}},"required":["locale","value"]}},"components/schemas/Money":{"id":"components/schemas/Money","kind":"json-schema","title":"Money","data":{"type":"object","properties":{"amount":{"type":"number","description":"Monetary amount. Must be zero or positive.","minimum":0},"currency":{"type":"string","description":"ISO 4217 currency code (e.g. EUR, USD, GBP)."}},"required":["amount","currency"]}},"components/schemas/NumericAttribute":{"id":"components/schemas/NumericAttribute","kind":"json-schema","title":"NumericAttribute","data":{"allOf":[{"$ref":"#/components/schemas/Attribute"},{"type":"object","properties":{"default_value":{"type":"number","description":"Default numeric value of the attribute, used for required attributes only"}}}]}},"components/schemas/OfferConfiguration":{"id":"components/schemas/OfferConfiguration","kind":"json-schema","title":"OfferConfiguration","data":{"type":"object","properties":{"custom_attributes":{"type":"array","description":"Attributes the sellers must configure for offer-related features","items":{"$ref":"#/components/schemas/Attribute"}},"pricing_configuration":{"$ref":"#/components/schemas/PricingConfiguration"}}}},"components/schemas/OrderLineRequest":{"id":"components/schemas/OrderLineRequest","kind":"json-schema","title":"OrderLineRequest","data":{"type":"object","properties":{"adjustments":{"type":"array","description":"Post-order modifications on this line, such as partial cancellations or refunds. Each adjustment represents a discrete event that occurred after the order was placed. Adjustments are append-only: send all past adjustments on every upsert.","items":{"$ref":"#/components/schemas/AdjustmentRequest"}},"can_cancel":{"type":"boolean","description":"Whether the order line is currently eligible for cancellation."},"can_refund":{"type":"boolean","description":"Whether the order line is currently eligible for refund."},"channel_order_line_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the order line on the channel. Must be unique across "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" orders of the channel, not just within the current order."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","description":"Date and time when the order line was created on the channel."},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributesRequest"},"price":{"$ref":"#/components/schemas/Money","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total price of the order line, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is the price for the entire order line, i.e. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unit price × quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not the unit price. Taxes are listed separately in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array and should "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be included in this amount."},"children":[]}]}]}]},"product":{"$ref":"#/components/schemas/ProductRequest"},"quantity":{"type":"integer","description":"Number of units ordered for this product."},"ship_from":{"type":"object","description":"Warehouse from which the marketplace requires this order line to be shipped when it manages order routing. Optional; omitted if not provided by the marketplace.","properties":{"warehouse":{"type":"object","description":"Warehouse from which the order line is required to be shipped.","properties":{"id":{"type":"string","description":"Identifier of the warehouse."}}}}},"shipping_taxes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taxes applied to the shipping price. These amounts are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_shipping_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TaxRequest"}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current lifecycle status of the order line. Lines within the same order can have different statuses (e.g. one line shipped while another is still awaiting shipment). See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the meaning of each value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AWAITING_ACCEPTANCE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AWAITING_FRAUD_CHECK\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AWAITING_PAYMENT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AWAITING_SHIPMENT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CHANNEL_SPECIFIC\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CLOSED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DELIVERED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"SHIPPED\""},"children":[]}]}]}]},"status_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason that explains why this order line reached its current status. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.status_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the meaning of each value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ACCEPTANCE_TIMEOUT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AUTOMATICALLY_CLOSED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CANCELED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FRAUD_CHECK_FAILED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FRAUD_CHECK_TIMEOUT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PAYMENT_TIMEOUT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REFUNDED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REFUSED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REFUSED_PAYMENT\""},"children":[]}]}]}]},"taxes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taxes applied to the product price. These amounts should "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each entry represents a distinct tax type (e.g. VAT, GST)."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TaxRequest"}},"total_shipping_price":{"$ref":"#/components/schemas/Money","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total shipping price for this order line, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is the total amount (not per-unit) for the shipping of this line. Shipping taxes are listed separately in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipping_taxes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":"Date and time of the last update of this order line on the channel."}},"required":["can_cancel","can_refund","channel_order_line_id","created_at","price","product","quantity","status","total_shipping_price","updated_at"]}},"components/schemas/OrderRequest":{"id":"components/schemas/OrderRequest","kind":"json-schema","title":"OrderRequest","data":{"type":"object","properties":{"billing_info":{"$ref":"#/components/schemas/BillingInfoRequest"},"channel_order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the order on the channel. Order uniqueness is guaranteed by the combination of the channel ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin.channel_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the store ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin.channel_store_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the sub-channel ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_channel_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"channel_updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time of the last update on the channel. Connect uses this timestamp to handle updates versioning: an order is updated only if this value is greater or equal to the current stored value in Connect.  This means that an update whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel_updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is older than the currently stored value will be silently ignored."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","description":"Date and time when the order was placed on the channel."},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributesRequest"},"fulfillment":{"$ref":"#/components/schemas/FulfillmentRequest"},"has_incident":{"type":"boolean","description":"Indicates whether the order has an active incident or dispute."},"order_lines":{"type":"array","description":"Lines composing the order. Each line corresponds to one distinct product in a given quantity.","items":{"$ref":"#/components/schemas/OrderLineRequest"},"minItems":1},"shipping_info":{"$ref":"#/components/schemas/ShippingInfoRequest"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current lifecycle status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FRAUD_CHECK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order is pending fraud verification before being confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_ACCEPTANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order has been placed and is waiting for the seller to accept or refuse it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_PAYMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order has been accepted but payment has not yet been confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_SHIPMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order is paid and accepted, waiting for the seller to ship."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHIPPED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order has been handed to a carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order has been delivered to the buyer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order lifecycle is complete (delivered, cancelled, or refunded)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHANNEL_SPECIFIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order has a status specific to the channel that does not map to any standard Connect status. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to carry additional context."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AWAITING_ACCEPTANCE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AWAITING_FRAUD_CHECK\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AWAITING_PAYMENT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AWAITING_SHIPMENT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CHANNEL_SPECIFIC\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CLOSED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DELIVERED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"SHIPPED\""},"children":[]}]}]}]},"status_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason that explains why the order reached its current status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Typically used for terminal or exceptional statuses (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHANNEL_SPECIFIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTANCE_TIMEOUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Seller did not accept the order within the acceptance deadline."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTOMATICALLY_CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order was automatically closed by the channel."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order was cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FRAUD_CHECK_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order failed fraud verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FRAUD_CHECK_TIMEOUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fraud check was not completed within the deadline."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_TIMEOUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment was not received within the deadline."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUNDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order was fully refunded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order was refused by the seller."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUSED_PAYMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment was refused."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ACCEPTANCE_TIMEOUT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AUTOMATICALLY_CLOSED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CANCELED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FRAUD_CHECK_FAILED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FRAUD_CHECK_TIMEOUT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PAYMENT_TIMEOUT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REFUNDED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REFUSED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REFUSED_PAYMENT\""},"children":[]}]}]}]},"sub_channel_code":{"type":"string","description":"Code of the sub-channel"}},"required":["channel_order_id","channel_updated_at","created_at","fulfillment","order_lines","shipping_info","status"]}},"components/schemas/OriginRequest":{"id":"components/schemas/OriginRequest","kind":"json-schema","title":"OriginRequest","data":{"type":"object","properties":{"channel_id":{"type":"string","description":"Unique identifier of the sales channel"},"channel_store_id":{"type":"string","description":"Store identifier on the sales channel."}},"required":["channel_id","channel_store_id"]}},"components/schemas/PerStoreDefault":{"id":"components/schemas/PerStoreDefault","kind":"json-schema","title":"PerStoreDefault","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when lifecycle is PER_SUB_CHANNEL."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configures whether a per-store default value is used as a fallback."},"children":[]}]}]}],"properties":{"support":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the per-store default is required, optional, or unsupported"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REQUIRED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OPTIONAL\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"UNSUPPORTED\""},"children":[]}]}]}]}}}},"components/schemas/PricingConfiguration":{"id":"components/schemas/PricingConfiguration","kind":"json-schema","title":"PricingConfiguration","data":{"type":"object","description":"Configuration for pricing capabilities.","properties":{"discount_price_period":{"$ref":"#/components/schemas/DiscountPricePeriod"}}}},"components/schemas/PricingConfigurationField":{"id":"components/schemas/PricingConfigurationField","kind":"json-schema","title":"PricingConfigurationField","data":{"type":"object","description":"Pricing configuration field","properties":{"requirement_level":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement level of the attribute"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OPTIONAL\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REQUIRED\""},"children":[]}]}]}]}},"required":["requirement_level"]}},"components/schemas/ProductAttribute":{"id":"components/schemas/ProductAttribute","kind":"json-schema","title":"ProductAttribute","data":{"type":"object","description":"An attribute of a product","discriminator":{"mapping":{"List":"#/components/schemas/ProductListAttribute","Text":"#/components/schemas/ProductTextAttribute"},"propertyName":"type"},"properties":{"descriptions":{"type":"array","description":"Additional attribute descriptions with their associated locale","items":{"$ref":"#/components/schemas/Localized"}},"id":{"$ref":"#/components/schemas/ProductAttributeId"},"labels":{"type":"array","description":"Labels for the attribute with their associated locale","items":{"$ref":"#/components/schemas/Localized"},"minItems":1},"type":{"$ref":"#/components/schemas/ProductAttributeType"}},"required":["id","labels","type"]}},"components/schemas/ProductAttributeId":{"id":"components/schemas/ProductAttributeId","kind":"json-schema","title":"ProductAttributeId","data":{"type":"string","description":"Anything that uniquely identifies the product attribute.","examples":["COLOR"],"maxLength":255,"minLength":1}},"components/schemas/ProductAttributeType":{"id":"components/schemas/ProductAttributeType","kind":"json-schema","title":"ProductAttributeType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each type of attributes has a different set of properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Text\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Integer\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Decimal\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"List\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Media\""},"children":[]}]}]}]}},"components/schemas/ProductListAttribute":{"id":"components/schemas/ProductListAttribute","kind":"json-schema","title":"ProductListAttribute","data":{"allOf":[{"$ref":"#/components/schemas/ProductAttribute"},{"type":"object","properties":{"available_values":{"type":"array","description":"List of available values for the attribute","items":{"$ref":"#/components/schemas/ProductListAttributeValue"},"maxItems":1000,"minItems":1},"max_values":{"type":"integer","description":"Maximum number of values a given product can have for this attribute","minimum":1}}}],"required":["available_values"]}},"components/schemas/ProductListAttributeValue":{"id":"components/schemas/ProductListAttributeValue","kind":"json-schema","title":"ProductListAttributeValue","data":{"type":"object","properties":{"id":{"type":"string","description":"Value of the attribute"},"labels":{"type":"array","description":"Labels for the attribute value with their associated locale","items":{"$ref":"#/components/schemas/Localized"},"minItems":1}},"required":["id"]}},"components/schemas/ProductRequest":{"id":"components/schemas/ProductRequest","kind":"json-schema","title":"ProductRequest","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product. This must be the seller's product identifier (usually the SKU)."},"thumbnail_url":{"type":"string","format":"uri","description":"URL of a product image."},"title":{"type":"string","description":"Display name of the product as shown to the buyer."}},"required":["id","title"]}},"components/schemas/ProductTextAttribute":{"id":"components/schemas/ProductTextAttribute","kind":"json-schema","title":"ProductTextAttribute","data":{"allOf":[{"$ref":"#/components/schemas/ProductAttribute"},{"type":"object"}]}},"components/schemas/ProductType":{"id":"components/schemas/ProductType","kind":"json-schema","title":"ProductType","data":{"type":"object","properties":{"context":{"$ref":"#/components/schemas/ProductTypeContext"},"embedded_attributes":{"type":"array","description":"List of embedded attributes for the product type","items":{"$ref":"#/components/schemas/EmbeddedAttribute"}},"labels":{"type":"array","description":"List of labels for the product type","items":{"$ref":"#/components/schemas/Localized"},"minItems":1},"rules":{"type":"array","description":"List of rules associated with the product type","items":{"$ref":"#/components/schemas/ProductTypeRuleReference"}}},"required":["embedded_attributes","labels"]}},"components/schemas/ProductTypeContext":{"id":"components/schemas/ProductTypeContext","kind":"json-schema","title":"ProductTypeContext","data":{"type":"object","description":"Additional context information about where this product type label is located within \nthe marketplace's data structure. This helps with catalog transformation.\n","properties":{"labels":{"type":"array","description":"List of labels context for the product type","items":{"$ref":"#/components/schemas/Localized"}}}}},"components/schemas/ProductTypeId":{"id":"components/schemas/ProductTypeId","kind":"json-schema","title":"ProductTypeId","data":{"type":"string","description":"Anything that uniquely identifies the product type.","examples":["Smartphones"],"maxLength":255,"minLength":1}},"components/schemas/ProductTypeRule":{"id":"components/schemas/ProductTypeRule","kind":"json-schema","title":"ProductTypeRule","data":{"type":"object","additionalProperties":false,"description":"A rule associated with the product type","properties":{"id":{"type":"string","description":"Unique identifier of the rule","example":"rule-1234","minLength":1},"then":{"$ref":"#/components/schemas/ProductTypeRuleActionAll"},"when":{"$ref":"#/components/schemas/ProductTypeRuleCondition"}},"required":["id","then","when"]}},"components/schemas/ProductTypeRuleActionAll":{"id":"components/schemas/ProductTypeRuleActionAll","kind":"json-schema","title":"ProductTypeRuleActionAll","data":{"type":"object","additionalProperties":false,"description":"A set of actions to apply when the rule is triggered","properties":{"all":{"type":"array","description":"List of actions to apply","items":{"$ref":"#/components/schemas/ProductTypeRuleActionRedefineAttribute"},"minItems":1}},"required":["all"]}},"components/schemas/ProductTypeRuleActionRedefineAttribute":{"id":"components/schemas/ProductTypeRuleActionRedefineAttribute","kind":"json-schema","title":"Redefine attribute","data":{"type":"object","additionalProperties":false,"description":"An action to redefine an attribute's properties","properties":{"redefine":{"$ref":"#/components/schemas/RedefineAttributeActionPayload"}},"required":["redefine"],"title":"Redefine attribute"}},"components/schemas/ProductTypeRuleCondition":{"id":"components/schemas/ProductTypeRuleCondition","kind":"json-schema","title":"ProductTypeRuleCondition","data":{"description":"Condition to trigger the rule","oneOf":[{"$ref":"#/components/schemas/ProductTypeRuleConditionAll"},{"$ref":"#/components/schemas/ProductTypeRuleConditionAny"},{"$ref":"#/components/schemas/ProductTypeRuleConditionNot"},{"$ref":"#/components/schemas/ProductTypeRuleConditionIsSet"},{"$ref":"#/components/schemas/ProductTypeRuleConditionEquals"},{"$ref":"#/components/schemas/ProductTypeRuleConditionIn"}]}},"components/schemas/ProductTypeRuleConditionAll":{"id":"components/schemas/ProductTypeRuleConditionAll","kind":"json-schema","title":"All","data":{"type":"object","additionalProperties":false,"description":"A set of conditions that must all be met to trigger the rule","properties":{"@type":{"type":"string"},"all":{"type":"array","description":"List of conditions to satisfy","items":{"$ref":"#/components/schemas/ProductTypeRuleCondition"},"minItems":1}},"required":["all"],"title":"All"}},"components/schemas/ProductTypeRuleConditionAny":{"id":"components/schemas/ProductTypeRuleConditionAny","kind":"json-schema","title":"Any","data":{"type":"object","additionalProperties":false,"description":"A set of conditions where at least one must be met to trigger the rule","properties":{"@type":{"type":"string"},"any":{"type":"array","description":"List of conditions where at least one must be satisfied","items":{"$ref":"#/components/schemas/ProductTypeRuleCondition"},"minItems":1}},"required":["any"],"title":"Any"}},"components/schemas/ProductTypeRuleConditionEquals":{"id":"components/schemas/ProductTypeRuleConditionEquals","kind":"json-schema","title":"Equals","data":{"type":"object","additionalProperties":false,"description":"A condition that checks if a specific attribute equals a given value","properties":{"@type":{"type":"string"},"equals":{"$ref":"#/components/schemas/EqualsRuleConditionPayload"}},"required":["equals"],"title":"Equals"}},"components/schemas/ProductTypeRuleConditionIn":{"id":"components/schemas/ProductTypeRuleConditionIn","kind":"json-schema","title":"In","data":{"type":"object","additionalProperties":false,"description":"A condition that checks if a specific attribute's value is in a given list of","properties":{"@type":{"type":"string"},"in":{"$ref":"#/components/schemas/InRuleConditionPayload"}},"required":["in"],"title":"In"}},"components/schemas/ProductTypeRuleConditionIsSet":{"id":"components/schemas/ProductTypeRuleConditionIsSet","kind":"json-schema","title":"IsSet","data":{"type":"object","additionalProperties":false,"description":"A condition that checks if a specific attribute is set","properties":{"@type":{"type":"string"},"isSet":{"$ref":"#/components/schemas/IsSetRuleConditionPayload"}},"required":["isSet"],"title":"IsSet"}},"components/schemas/ProductTypeRuleConditionNot":{"id":"components/schemas/ProductTypeRuleConditionNot","kind":"json-schema","title":"Not","data":{"type":"object","additionalProperties":false,"description":"A condition that must not be met to trigger the rule","properties":{"@type":{"type":"string"},"not":{"$ref":"#/components/schemas/ProductTypeRuleCondition"}},"required":["not"],"title":"Not"}},"components/schemas/ProductTypeRuleReference":{"id":"components/schemas/ProductTypeRuleReference","kind":"json-schema","title":"ProductTypeRuleReference","data":{"type":"object","description":"A reference to a rule associated with the product type","properties":{"ref":{"type":"string","description":"The unique identifier of the referenced rule","examples":["rule-1234"]}},"required":["ref"]}},"components/schemas/QualitySuspensionReason":{"id":"components/schemas/QualitySuspensionReason","kind":"json-schema","title":"QualitySuspensionReason","data":{"type":"object","properties":{"period":{"type":"string","description":"Period considered by the Marketplace for the statistics related to the rule.\n","example":"Last month"},"rule":{"type":"string","description":"Rule that triggered the suspension of the store.\nThis can be a rule related to quality, payment, shipping or any other rule defined by the Marketplace.\nBy assembling every parameters, we can build a human readable description of the rule.\n","example":"Evaluation Grade last month was lower than 3.5 expected to never be lower than 4.0"},"rule_comparison_method":{"type":"string","description":"Comparison method used by the Marketplace to evaluate the rule.\n","example":"lower than"},"rule_type":{"type":"string","description":"Type of the rule that triggered the suspension of the store such as DECIMAL or INTEGER.\n","example":"DECIMAL"},"stat_value":{"type":"number","format":"with decimals","description":"Value of the statistic that triggered the rule.\nThis is the value that was compared to the threshold defined by the Marketplace.\n","example":3.5},"threshold":{"type":"number","format":"with decimals","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Threshold value defined by the Marketplace for the rule."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the stat_value is lower than this threshold, the store is considered suspended."},"children":[]}]}]}]}},"required":["rule"]}},"components/schemas/RedefineAttributeActionPayload":{"id":"components/schemas/RedefineAttributeActionPayload","kind":"json-schema","title":"RedefineAttributeActionPayload","data":{"type":"object","additionalProperties":false,"properties":{"attribute":{"$ref":"#/components/schemas/TaxonomyRuleAttributeId"},"requirementLevel":{"$ref":"#/components/schemas/RequirementLevel"}},"required":["attribute"]}},"components/schemas/RequirementLevel":{"id":"components/schemas/RequirementLevel","kind":"json-schema","title":"RequirementLevel","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement level of the attribute when creating or updating a product"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OPTIONAL\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"RECOMMENDED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REQUIRED\""},"children":[]}]}]}]}},"components/schemas/ReturnErrorDetail":{"id":"components/schemas/ReturnErrorDetail","kind":"json-schema","title":"ReturnErrorDetail","data":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DATA_NOT_FOUND\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"RETURN_OUTSIDE_RETENTION_WINDOW\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"INVALID_INPUT\""},"children":[]}]}]}]},"field":{"type":"string","description":"JsonPath to the field where the error occurred"},"message":{"type":"string","description":"Human-readable error message"}},"required":["code","message"]}},"components/schemas/ReturnLineRequest":{"id":"components/schemas/ReturnLineRequest","kind":"json-schema","title":"ReturnLineRequest","data":{"type":"object","properties":{"channel_order_line_id":{"type":"string","description":"Order line identifier on the sales channel"},"quantity":{"type":"integer","description":"Quantity of items being returned"},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for the return"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"WRONG_ITEM\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"MISSING_ITEM\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DEFECTIVE_ITEM\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DAMAGED_ITEM\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"UNWANTED_ITEM\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OTHER\""},"children":[]}]}]}]}},"required":["channel_order_line_id","quantity","reason"]}},"components/schemas/ReturnRequest":{"id":"components/schemas/ReturnRequest","kind":"json-schema","title":"ReturnRequest","data":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string","description":"City"},"country":{"type":"string","description":"Country"},"country_iso_code":{"type":"string","format":"iso-3166-1 alpha-3","description":"Country ISO code"},"state":{"type":"string","description":"State"},"street":{"type":"string","description":"Street information. Strongly recommended for accurate delivery; may be omitted for block-based address systems (e.g. Japan)."},"street_additional_info":{"type":"string","description":"Additional street information"},"zip_code":{"type":"string","description":"Postal code"}},"required":["city","country_iso_code"]},"channel_order_id":{"type":"string","description":"Order identifier on the sales channel"},"channel_return_id":{"type":"string","description":"Return identifier on the sales channel"},"channel_updated_at":{"type":"string","format":"date-time","description":"Date time the return was last updated on the sales channel"},"created_at":{"type":"string","format":"date-time","description":"Date time the return was created on the sales channel"},"label_url":{"type":"string","description":"URL for the return shipping label"},"method":{"type":"string","description":"Shipping method name on the sales channel"},"rejection_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for the return rejection"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"RETURN_WINDOW_CLOSED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NOT_ELIGIBLE_FOR_RETURN\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FINAL_SALES\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OTHER\""},"children":[]}]}]}]},"return_lines":{"type":"array","items":{"$ref":"#/components/schemas/ReturnLineRequest"},"minItems":1},"rma_id":{"type":"string","description":"Return Merchandise Authorization ID"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current return status"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REQUEST_INITIATED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"REQUEST_DECLINED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OPENED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"RECEIVED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CLOSED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CHANNEL_SPECIFIC\""},"children":[]}]}]}]},"sub_channel_code":{"type":"string","description":"Code of the sub-channel"},"tracking":{"type":"object","properties":{"carrier_name":{"type":"string","description":"Carrier company name"},"tracking_number":{"type":"string","description":"Carrier tracking number"},"tracking_url":{"type":"string","description":"URL to track the return"}}}},"required":["channel_order_id","channel_return_id","channel_updated_at","created_at","return_lines","status"]}},"components/schemas/ShippingInfoRequest":{"id":"components/schemas/ShippingInfoRequest","kind":"json-schema","title":"ShippingInfoRequest","data":{"type":"object","description":"Shipping destination and logistics information for the order.","properties":{"address":{"$ref":"#/components/schemas/AddressRequest","description":"Delivery address of the recipient."},"carrier":{"type":"string","description":"Name of the carrier handling the shipment, as defined on the channel."},"delivery_date":{"type":"object","description":"Estimated delivery window communicated to the buyer.","properties":{"earliest":{"type":"string","format":"date-time","description":"Earliest expected delivery date."},"latest":{"type":"string","format":"date-time","description":"Latest expected delivery date."}},"required":["earliest","latest"]},"email":{"type":"string","format":"email","description":"Email address of the recipient."},"method":{"type":"string","description":"Shipping service level or method name (e.g. standard, express, next-day)."},"pudo_id":{"type":"string","description":"Identifier of the pick-up/drop-off point (PUDO) when the delivery targets a relay point, locker, or store rather than a home address."},"shipping_deadline":{"type":"string","format":"date-time","description":"Latest date and time by which the seller must ship the order."}}}},"components/schemas/StockDataConfiguration":{"id":"components/schemas/StockDataConfiguration","kind":"json-schema","title":"StockDataConfiguration","data":{"type":"object","description":"Stock configuration. Unlike prices, stock does not support a per-store default value\nas a fallback when configured per sub-channel.\n","properties":{"lifecycle":{"$ref":"#/components/schemas/Lifecycle"}},"required":["lifecycle"]}},"components/schemas/StoreId":{"id":"components/schemas/StoreId","kind":"json-schema","title":"StoreId","data":{"type":"string","description":"Store identifier in the channel","minLength":1}},"components/schemas/SubChannel":{"id":"components/schemas/SubChannel","kind":"json-schema","title":"SubChannel","data":{"type":"object","properties":{"currency":{"type":"string","description":"Currency tag of the sub-channel, expected in ISO 4217 format. Cannot be changed later.","example":"USD","maxLength":3,"minLength":1,"pattern":"^[A-Z]{3}$"},"id":{"type":"string","description":"Id of the sub-channel inside the Marketplace where the store is located. Cannot be blank.","example":"12345","minLength":1,"pattern":".*\\S.*"},"name":{"type":"string","description":"Name of the sub-channel inside the Marketplace where the store is located.","example":"Premium Sellers"}},"required":["currency","id","name"]}},"components/schemas/TaxRequest":{"id":"components/schemas/TaxRequest","kind":"json-schema","title":"TaxRequest","data":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money","description":"Total amount for this tax entry."},"channel_collectible":{"$ref":"#/components/schemas/Money","description":"Amount collected by the operator (marketplace facilitator)."},"code":{"type":"string","description":"Identifier of the tax type, as defined by the channel (e.g. VAT, GST, HST)."},"rate":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax rate expressed as a decimal (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 20%)."},"children":[]}]}]}]},"seller_collectible":{"$ref":"#/components/schemas/Money","description":"Amount the seller must collect and declare to tax authorities."}},"required":["amount","code"]}},"components/schemas/TaxonomyRuleAttributeId":{"id":"components/schemas/TaxonomyRuleAttributeId","kind":"json-schema","title":"TaxonomyRuleAttributeId","data":{"type":"string","description":"Identifier of the product attribute a taxonomy rule refers to"}},"components/schemas/TaxonomyRuleRequest":{"id":"components/schemas/TaxonomyRuleRequest","kind":"json-schema","title":"TaxonomyRuleRequest","data":{"type":"object","additionalProperties":false,"description":"Request to create a taxonomy rule","properties":{"rules":{"type":"array","description":"List of rules to create","items":{"$ref":"#/components/schemas/ProductTypeRule"},"minItems":1}},"required":["rules"]}},"components/schemas/TextAttribute":{"id":"components/schemas/TextAttribute","kind":"json-schema","title":"TextAttribute","data":{"allOf":[{"$ref":"#/components/schemas/Attribute"},{"type":"object","properties":{"default_value":{"type":"string","description":"Default text value of the attribute, used for required attributes only"},"max_size":{"type":"integer","description":"Max characters size"}}}],"required":["max_size"]}},"components/schemas/UpdateActionRequest":{"id":"components/schemas/UpdateActionRequest","kind":"json-schema","title":"UpdateActionRequest","data":{"type":"object","description":"Request payload for updating an asynchronous action's status","properties":{"errors":{"type":"array","description":"List of errors encountered during action processing.\nRequired when status is FAILED.\nMultiple errors can be included to provide comprehensive failure details.\n","items":{"$ref":"#/components/schemas/ActionError"}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final status of the asynchronous action:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUCCESS - The action completed successfully with no errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - The action encountered errors and could not be completed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(requires error details in the errors array)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"SUCCESS\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FAILED\""},"children":[]}]}]}]}},"required":["status"]}},"components/schemas/UpdateAnonymizeAfterRequest":{"id":"components/schemas/UpdateAnonymizeAfterRequest","kind":"json-schema","title":"UpdateAnonymizeAfterRequest","data":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/UpdateAnonymizeAfterRequestItem"},"maxItems":100,"minItems":1}},"required":["orders"]}},"components/schemas/UpdateAnonymizeAfterRequestItem":{"id":"components/schemas/UpdateAnonymizeAfterRequestItem","kind":"json-schema","title":"UpdateAnonymizeAfterRequestItem","data":{"type":"object","properties":{"anonymize_after":{"type":"string","format":"date-time","description":"The date after which the order should be anonymized. The date must be in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) and in the futur relative to time of call (note: a tolerance of few minutes will be tolerated to prevent false positive errors)","examples":["2023-10-01T00:00:00Z"]},"channel_id":{"type":"string","description":"The ID of the channel on which the order was placed.","examples":[1234]},"channel_order_id":{"type":"string","description":"The ID of the order on the channel.","examples":["COMMERCIAL_ID-A"]},"channel_store_id":{"type":"string","description":"Store identifier on the sales channel.","examples":["2005"]},"sub_channel_code":{"type":"string","description":"Code of the sub-channel"}},"required":["anonymize_after","channel_id","channel_order_id","channel_store_id"]}},"components/schemas/UpdateStoreCatalogItem":{"id":"components/schemas/UpdateStoreCatalogItem","kind":"json-schema","title":"UpdateStoreCatalogItem","data":{"type":"object","properties":{"diagnostics":{"type":["array","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of general diagnostics related to the store catalog item (deprecated use offer_diagnostics instead)."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Diagnostic"},"maxItems":100,"minItems":0},"id":{"type":"string","description":"The item identifier of the store catalog item."},"offer_diagnostics":{"type":["array","null"],"description":"A list of diagnostics related to the offer status of the store catalog item, this list should reflect all the current active diagnostics. Use an empty list to clear all the diagnostics.","items":{"$ref":"#/components/schemas/Diagnostic"},"maxItems":100,"minItems":0},"offer_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the offer in the channel. Possible values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFER_ACTIVE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The offer is active and visible in the channel."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only price, stock and offer specific information updates will be sent from now on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(no product or offer creation will be sent from connect once an offer is declared as active)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFER_DOES_NOT_EXIST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The offer is not found in the channel."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An offer creation attempt will be sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTION_REQUIRED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The offer requires an action, such as updates or fixes, before it can be active."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An offer creation will be retried after the action."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OFFER_ACTIVE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OFFER_DOES_NOT_EXIST\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ACTION_REQUIRED\""},"children":[]}]}]}]},"product_diagnostics":{"type":["array","null"],"description":"A list of diagnostics related to the product status of the store catalog item, this list should reflect all the current active diagnostics. Use an empty list to clear all the diagnostics.","items":{"$ref":"#/components/schemas/Diagnostic"},"maxItems":100,"minItems":0},"product_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the product in the channel. Possible values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRODUCT_DOES_NOT_EXIST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The product is not found in the channel."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRODUCT_PENDING_APPROVAL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The product has been submitted and is waiting for approval in the channel."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRODUCT_REFUSED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The product was reviewed but rejected by the channel."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRODUCT_CREATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The product exists and has been successfully created in the channel."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTION_REQUIRED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The product requires an action, such as updates or fixes, before it can proceed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PRODUCT_DOES_NOT_EXIST\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PRODUCT_PENDING_APPROVAL\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PRODUCT_REFUSED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PRODUCT_CREATED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ACTION_REQUIRED\""},"children":[]}]}]}]}},"required":["id"]}},"components/schemas/UpdateStoreCatalogItemsRequest":{"id":"components/schemas/UpdateStoreCatalogItemsRequest","kind":"json-schema","title":"UpdateStoreCatalogItemsRequest","data":{"type":"object","properties":{"store_catalog_items":{"type":"array","items":{"$ref":"#/components/schemas/UpdateStoreCatalogItem"},"maxItems":10000,"minItems":1}},"required":["store_catalog_items"]}},"components/schemas/UploadOrderDocumentMetadata":{"id":"components/schemas/UploadOrderDocumentMetadata","kind":"json-schema","title":"UploadOrderDocumentMetadata","data":{"type":"object","properties":{"channel_document_id":{"type":"string","description":"The channel document ID, it must be unique in the channel."},"channel_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channel-specific document type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is optional and should be provided when type is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHANNEL_SPECIFIC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It allows connectors to store the original document type from the marketplace."},"children":[]}]}]}]},"entity":{"type":"object","description":"Entity this document is associated with.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the entity (e.g. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returnId"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for type : "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETURN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") this document is associated with."},"children":[]}]}]}],"examples":["caf30673-ea3d-4113-9a18-674850f6a290"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of entity this document is associated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"RETURN\""},"children":[]}]}]}]}},"required":["id","type"]},"filename":{"type":"string","description":"Name of the document (only this field counts as the file name).\n","examples":["UPS_1Z999AA10123456784.pdf","DHL_JJD0000123456.jpg","中国邮政_774602727890.png"],"maxLength":255,"minLength":1},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the document"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"RETURN_LABEL\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CUSTOMER_INVOICE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DELIVERY_SLIP\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"SHIPMENT_DELIVERY_SLIP\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CHANNEL_SPECIFIC\""},"children":[]}]}]}]}},"required":["channel_document_id","filename","type"]}},"components/schemas/UpsertCarriersRequest":{"id":"components/schemas/UpsertCarriersRequest","kind":"json-schema","title":"UpsertCarriersRequest","data":{"type":"object","properties":{"carriers":{"type":"array","description":"List of carriers available on the channel","items":{"$ref":"#/components/schemas/CarrierRequest"},"maxItems":5000,"minItems":1}},"required":["carriers"]}},"components/schemas/UpsertOrdersRequest":{"id":"components/schemas/UpsertOrdersRequest","kind":"json-schema","title":"UpsertOrdersRequest","data":{"type":"object","properties":{"orders":{"type":"array","description":"List of orders to create or update.","items":{"$ref":"#/components/schemas/OrderRequest"},"maxItems":100,"minItems":1},"origin":{"$ref":"#/components/schemas/OriginRequest"}},"required":["orders","origin"]}},"components/schemas/UpsertReturnsRequest":{"id":"components/schemas/UpsertReturnsRequest","kind":"json-schema","title":"UpsertReturnsRequest","data":{"type":"object","properties":{"origin":{"$ref":"#/components/schemas/OriginRequest"},"returns":{"type":"array","items":{"$ref":"#/components/schemas/ReturnRequest"},"maxItems":100,"minItems":1}},"required":["origin","returns"]}},"components/schemas/UpsertReturnsResponse":{"id":"components/schemas/UpsertReturnsResponse","kind":"json-schema","title":"UpsertReturnsResponse","data":{"type":"object","properties":{"return_errors":{"type":"array","items":{"type":"object","properties":{"channel_order_id":{"type":"string"},"channel_return_id":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ReturnErrorDetail"}}}}},"return_success":{"type":"array","items":{"type":"object","properties":{"channel_order_id":{"type":"string"},"channel_return_id":{"type":"string"}}}}}}},"components/schemas/UseCaseConfiguration":{"id":"components/schemas/UseCaseConfiguration","kind":"json-schema","title":"UseCaseConfiguration","data":{"type":"object","description":"Configuration for a specific use case. \nThis API provides the configuration of required offer fields by use cases\n","properties":{"optional":{"$ref":"#/components/schemas/UseCaseConfigurationAttributes","description":"Optional fields for the use case"},"required":{"$ref":"#/components/schemas/UseCaseConfigurationAttributes","description":"Required fields for the use case"},"support":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support for the use case"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"SUPPORTED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"UNSUPPORTED\""},"children":[]}]}]}]}},"required":["required","support"]}},"components/schemas/UseCaseConfigurationAttributes":{"id":"components/schemas/UseCaseConfigurationAttributes","kind":"json-schema","title":"UseCaseConfigurationAttributes","data":{"type":"object","properties":{"custom_attributes":{"type":"array","items":{"type":"string"}},"standard_attributes":{"type":"array","items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ID\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"STANDARD_PRICE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DISCOUNT_PRICE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"STOCK\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"GTIN\""},"children":[]}]}]}]}}}}},"components/schemas/UseCaseConfigurations":{"id":"components/schemas/UseCaseConfigurations","kind":"json-schema","title":"UseCaseConfigurations","data":{"type":"object","description":"Configuration for offer related features by use case. \nThis API provides the configuration of required offer fields by use cases\n","properties":{"offer_creation":{"$ref":"#/components/schemas/UseCaseConfiguration","description":"Configuration for offer creation"},"offer_update":{"$ref":"#/components/schemas/UseCaseConfiguration","description":"Configuration for offer update"}},"required":["offer_creation","offer_update"]}},"components/schemas/Warehouse":{"id":"components/schemas/Warehouse","kind":"json-schema","title":"Warehouse","data":{"type":"object","properties":{"code":{"type":"string","description":"Code of the warehouse.\nThis is the stable identifier of the warehouse within Connect.\n","example":"WH-PARIS-01"},"name":{"type":"string","description":"Human readable name of the warehouse.\n","example":"Paris warehouse"}},"required":["code","name"]}},"schema_0":{"kind":"json-schema","data":{"type":"string","examples":["1234"],"minLength":1},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ProductTypeId"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"$ref":"#/components/schemas/StoreId"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"object","properties":{"origin":{"$ref":"#/components/schemas/DocumentOriginRequest"}},"required":["origin"]},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document file to upload."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 MB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported formats are :"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JPEG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PNG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV"},"children":[]}]}]}]}]}]},"metadata":{"$ref":"#/components/schemas/UploadOrderDocumentMetadata"},"origin":{"$ref":"#/components/schemas/DocumentOriginRequest"}},"required":["file","metadata","origin"]},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","description":"Id of the channel","minLength":1},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","description":"Id of the store in channel","minLength":1},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Warehouse"}},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"string","minLength":1},"id":"schema_9"}},"exampleStore":{"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0":{"value":"{\n    \"offer_configuration\": {\n        \"custom_attributes\": [\n            {\n                \"id\": \"OFFER_STATE\",\n                \"type\": \"List\",\n                \"labels\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"Offer condition\"\n                    }\n                ],\n                \"configuration_modes\": [\n                    \"CONSTANT\",\n                    \"VARIABLE\"\n                ],\n                \"descriptions\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"The condition of the offer.\"\n                    }\n                ],\n                \"max_size\": 1,\n                \"requirement_level\": \"REQUIRED\",\n                \"values\": [\n                    {\n                        \"id\": \"NEW\",\n                        \"labels\": [\n                            {\n                                \"locale\": \"en_US\",\n                                \"value\": \"New\"\n                            }\n                        ]\n                    },\n                    {\n                        \"id\": \"REFURBISHED\",\n                        \"labels\": [\n                            {\n                                \"locale\": \"en_US\",\n                                \"value\": \"Refurbished - as good as new\"\n                            }\n                        ]\n                    }\n                ]\n            },\n            {\n                \"id\": \"ASIN\",\n                \"type\": \"Text\",\n                \"configuration_modes\": [\n                    \"VARIABLE\"\n                ],\n                \"descriptions\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"ASIN of the product. You are strongly encouraged to provide this value.\"\n                    }\n                ],\n                \"requirement_level\": \"RECOMMENDED\",\n                \"max_size\" : 255,\n                \"labels\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"Amazon Standard Identification Number\"\n                    }\n                ]\n            },\n            {\n                \"id\": \"productTaxCode\",\n                \"type\": \"Text\",\n                \"configuration_modes\": [\n                    \"VARIABLE\"\n                ],\n                \"descriptions\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"The tax code for the product.\"\n                    }\n                ],\n                \"requirement_level\": \"OPTIONAL\",\n                \"max_size\" : 255,\n                \"labels\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"Product Tax Code\"\n                    }\n                ]\n            },\n            {\n                \"id\": \"length\",\n                \"type\": \"Text\",\n                \"configuration_modes\": [\n                    \"VARIABLE\"\n                ],\n                \"descriptions\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"The length of the product.\"\n                    }\n                ],\n                \"requirement_level\": \"OPTIONAL\",\n                \"max_size\" : 255,\n                \"labels\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"Length\"\n                    }\n                ]\n            }\n        ]\n    },\n    \"use_case_configurations\": {\n        \"offer_creation\": {\n            \"support\": \"SUPPORTED\",\n\n            \"required\": {\n                \"standard_attributes\": [ \"GTIN\", \"ID\", \"STOCK\" ],\n                \"custom_attributes\": [ \"OFFER_STATE\" ]\n            },\n\n            \"optional\": {\n                \"standard_attributes\": [ \"STANDARD_PRICE\", \"DISCOUNT_PRICE\" ],\n                \"custom_attributes\": [ \"length\" ]\n            }\n        },\n\n        \"offer_update\": {\n            \"support\": \"SUPPORTED\",\n\n            \"required\": {\n                \"standard_attributes\": [ \"ID\" ],\n                \"custom_attributes\": [ ]\n            },\n\n            \"optional\": {\n                \"standard_attributes\": [ ],\n                \"custom_attributes\": [ \"productTaxCode\" ]\n            }\n        }\n    }\n}\n","key":"application/json; charset=UTF-8-0","summary":"Channel 1 - Catalog capabilities","id":"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0"},"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1":{"value":"{\n    \"offer_configuration\": {\n        \"custom_attributes\": [\n            {\n                \"id\": \"CONDITION\",\n                \"type\": \"List\",\n                \"labels\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"Offer condition\"\n                    }\n                ],\n                \"configuration_modes\": [\n                    \"CONSTANT\",\n                    \"VARIABLE\"\n                ],\n                \"descriptions\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"The condition of the offer.\"\n                    }\n                ],\n                \"max_size\": 1,\n                \"requirement_level\": \"REQUIRED\",\n                \"values\": [\n                    {\n                        \"id\": \"NEW\",\n                        \"labels\": [\n                            {\n                                \"locale\": \"en_US\",\n                                \"value\": \"New\"\n                            }\n                        ]\n                    },\n                    {\n                        \"id\": \"REFURBISHED\",\n                        \"labels\": [\n                            {\n                                \"locale\": \"en_US\",\n                                \"value\": \"Refurbished - as good as new\"\n                            }\n                        ]\n                    }\n                ]\n            },\n            {\n                \"id\": \"taxcode\",\n                \"type\": \"Text\",\n                \"max_size\": 255,\n                \"configuration_modes\": [\n                    \"CONSTANT\",\n                    \"VARIABLE\"\n                ],\n                \"descriptions\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"The tax code\"\n                    }\n                ],\n                \"requirement_level\": \"RECOMMENDED\",\n                \"labels\": [\n                    {\n                        \"locale\": \"en_US\",\n                        \"value\": \"Tax code\"\n                    }\n                ]\n            }\n        ]\n    },\n\n    \"use_case_configurations\": {\n        \"offer_creation\": {\n            \"support\": \"SUPPORTED\",\n\n            \"required\": {\n                \"standard_attributes\": [ \"GTIN\", \"ID\", \"STOCK\" ],\n                \"custom_attributes\": [ ]\n            },\n\n            \"optional\": {\n                \"standard_attributes\": [ \"STANDARD_PRICE\", \"DISCOUNT_PRICE\" ],\n                \"custom_attributes\": [ ]\n            }\n        },\n\n        \"offer_update\": {\n            \"support\": \"SUPPORTED\",\n\n            \"required\": {\n                \"standard_attributes\": [ \"ID\" ],\n                \"custom_attributes\": [ ]\n            },\n\n            \"optional\": {\n                \"standard_attributes\": [ ],\n                \"custom_attributes\": [ ]\n            }\n        }\n    }\n}\n","key":"application/json; charset=UTF-8-1","summary":"Channel 2 - Catalog capabilities","id":"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1"},"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-2":{"value":"{\n    \"standard_prices\": {\n        \"lifecycle\": \"PER_STORE\"\n    },\n    \"discount_prices\": {\n        \"lifecycle\": \"PER_STORE\"\n    }\n}\n","key":"application/json; charset=UTF-8-2","summary":"Pricing - No channel-level pricing (fully per-store)","id":"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-2"},"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-3":{"value":"{\n    \"standard_prices\": {\n        \"lifecycle\": \"PER_SUB_CHANNEL\",\n        \"per_store_default\": {\n            \"support\": \"REQUIRED\"\n        }\n    },\n    \"discount_prices\": {\n        \"lifecycle\": \"PER_SUB_CHANNEL\",\n        \"per_store_default\": {\n            \"support\": \"OPTIONAL\"\n        }\n    }\n}\n","key":"application/json; charset=UTF-8-3","summary":"Pricing - Channel-level pricing with a per-store backup","id":"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-3"},"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-4":{"value":"{\n    \"standard_prices\": {\n        \"lifecycle\": \"PER_SUB_CHANNEL\",\n        \"per_store_default\": {\n            \"support\": \"UNSUPPORTED\"\n        }\n    },\n    \"discount_prices\": {\n        \"lifecycle\": \"PER_SUB_CHANNEL\",\n        \"per_store_default\": {\n            \"support\": \"UNSUPPORTED\"\n        }\n    }\n}\n","key":"application/json; charset=UTF-8-4","summary":"Pricing - Channel-level pricing only, no per-store backup","id":"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-4"},"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-5":{"value":"{\n    \"stock_quantities\": {\n        \"lifecycle\": \"PER_STORE\"\n    }\n}\n","key":"application/json; charset=UTF-8-5","summary":"Stock - Managed per-store","id":"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-5"},"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-6":{"value":"{\n    \"stock_quantities\": {\n        \"lifecycle\": \"PER_SUB_CHANNEL\"\n    }\n}\n","key":"application/json; charset=UTF-8-6","summary":"Stock - Managed per sub-channel","id":"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-6"},"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto":{"value":{"behaviors":{"emit_group_of_products":"object"},"stock_quantities":{"lifecycle":"PER_STORE"},"standard_prices":{"lifecycle":"PER_STORE","per_store_default":{"support":"REQUIRED"}},"discount_prices":{"lifecycle":"PER_STORE","per_store_default":{"support":"REQUIRED"}},"offer_configuration":{"custom_attributes":[{"id":"string","type":"Boolean","configuration_modes":["CONSTANT"],"requirement_level":"OPTIONAL","labels":[{"locale":"en_US","value":"string"}],"descriptions":[{"locale":"en_US","value":"string"}]}],"pricing_configuration":{"discount_price_period":{"support":"SUPPORTED","start_date":{"requirement_level":"OPTIONAL"},"end_date":{"requirement_level":"OPTIONAL"}}}},"use_case_configurations":{"offer_creation":{"support":"SUPPORTED","required":{"standard_attributes":["ID"],"custom_attributes":["string"]},"optional":{"standard_attributes":["ID"],"custom_attributes":["string"]}},"offer_update":{"support":"SUPPORTED","required":{"standard_attributes":["ID"],"custom_attributes":["string"]},"optional":{"standard_attributes":["ID"],"custom_attributes":["string"]}}}},"key":"application/json; charset=UTF-8-auto","summary":"Complete example with value types (application/json; charset=utf-8)","id":"paths/~1v1~1catalog-configuration~1channels~1{channel_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"},"paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0":{"value":"{\n    \"rules\": [\n        {\n            \"id\": \"rule-smartphones\",\n            \"when\": {\n                \"all\": [\n                    {\n                        \"equals\": {\n                            \"attribute\": \"model\",\n                            \"value\": \"samsung-galaxy-s21\"\n                        }\n                    },\n                    {\n                        \"not\": {\n                            \"isSet\": {\n                                \"attribute\": \"color\"\n                            }\n                        }\n                    }\n                ]\n            },\n            \"then\": {\n                \"all\": [\n                    {\n                        \"redefine\": {\n                            \"attribute\": \"samsung-special-color\",\n                            \"requirementLevel\": \"REQUIRED\"\n                        }\n                    }\n                ]\n            }\n        }\n    ]\n}\n","key":"application/json; charset=UTF-8-0","summary":"Example of a taxonomy rule","id":"paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0"},"paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto":{"value":{"rules":[{"id":"rule-1234","when":"object","then":{"all":[{"redefine":{"attribute":"string","requirementLevel":"OPTIONAL"}}]}}]},"key":"application/json; charset=UTF-8-auto","summary":"Complete example with value types (application/json; charset=utf-8)","id":"paths/~1v1~1taxonomy~1channels~1{channel_id}~1rules/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"},"paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0":{"value":"{\n    \"labels\": [\n        {\n            \"locale\": \"en\",\n            \"value\": \"Smartphones\"\n        },\n        {\n            \"locale\": \"fr\",\n            \"value\": \"Smartphones\"\n        }\n    ],\n    \"context\": {\n        \"labels\": [\n            {\n                \"locale\": \"en\",\n                \"value\": \"Electronics / Mobile Devices / Smartphones\"\n            },\n            {\n                \"locale\": \"fr\",\n                \"value\": \"Électronique / Appareils Mobiles / Smartphones\"\n            }\n        ]\n    },\n    \"embedded_attributes\": [\n        {\n            \"id\": \"recommended_browse_nodes\",\n            \"requirement_level\": \"REQUIRED\",\n            \"type\": \"List\",\n            \"labels\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Browse Nodes\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Catégories\"\n                }\n            ],\n            \"context\": {\n                \"labels\": [\n                    {\n                        \"locale\": \"en\",\n                        \"value\": \"Classification / Browse Nodes\"\n                    },\n                    {\n                        \"locale\": \"fr\",\n                        \"value\": \"Classification / Catégories\"\n                    }\n                ],\n                \"path\": \"$.recommended_browse_nodes\"\n            },\n            \"descriptions\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Category of the product in the channel browse tree\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Catégorie du produit dans l'arborescence du canal\"\n                }\n            ],\n            \"available_values\": [\n                {\n                    \"id\": \"340320031\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Mobile Phones\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Téléphones Mobiles\"\n                        }\n                    ]\n                },\n                {\n                    \"id\": \"541546121\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Phones\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Téléphones\"\n                        }\n                    ]\n                }\n            ]\n        },\n        {\n            \"id\": \"Brand\",\n            \"requirement_level\": \"REQUIRED\",\n            \"type\": \"List\",\n            \"labels\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Brand\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Marque\"\n                }\n            ],\n            \"context\": {\n                \"labels\": [\n                    {\n                        \"locale\": \"en\",\n                        \"value\": \"Product Information / Brand\"\n                    },\n                    {\n                        \"locale\": \"fr\",\n                        \"value\": \"Information Produit / Marque\"\n                    }\n                ],\n                \"path\": \"$.brand\"\n            },\n            \"descriptions\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Brand of the product\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Marque du produit\"\n                }\n            ],\n            \"connect_standard_attributes\": [\n                \"BRAND\"\n            ],\n            \"available_values\": [\n                {\n                    \"id\": \"APPLE\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Apple\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Apple\"\n                        }\n                    ]\n                },\n                {\n                    \"id\": \"SAMSUNG\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Samsung\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Samsung\"\n                        }\n                    ]\n                },\n                {\n                    \"id\": \"XIAOMI\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Xiaomi\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Xiaomi\"\n                        }\n                    ]\n                }\n            ]\n        },\n        {\n            \"id\": \"COLOR\",\n            \"requirement_level\": \"RECOMMENDED\",\n            \"type\": \"List\",\n            \"labels\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Color\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Couleur\"\n                }\n            ],\n            \"context\": {\n                \"labels\": [\n                    {\n                        \"locale\": \"en\",\n                        \"value\": \"Physical Characteristics / Color\"\n                    },\n                    {\n                        \"locale\": \"fr\",\n                        \"value\": \"Caractéristiques Physiques / Couleur\"\n                    }\n                ],\n                \"path\": \"$.color\"\n            },\n            \"descriptions\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Main color of the product\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Couleur principale du produit\"\n                }\n            ],\n            \"available_values\": [\n                {\n                    \"id\": \"BLACK\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Black\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Noir\"\n                        }\n                    ]\n                },\n                {\n                    \"id\": \"WHITE\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"White\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Blanc\"\n                        }\n                    ]\n                },\n                {\n                    \"id\": \"GOLD\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Gold\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Or\"\n                        }\n                    ]\n                }\n            ]\n        },\n        {\n            \"id\": \"Mobile_OS\",\n            \"requirement_level\": \"RECOMMENDED\",\n            \"type\": \"List\",\n            \"labels\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Mobile OS\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Système d'exploitation\"\n                }\n            ],\n            \"context\": {\n                \"labels\": [\n                    {\n                        \"locale\": \"en\",\n                        \"value\": \"Technical Specifications / Operating System\"\n                    },\n                    {\n                        \"locale\": \"fr\",\n                        \"value\": \"Spécifications Techniques / Système d'exploitation\"\n                    }\n                ],\n                \"path\": \"$.mobile_os\"\n            },\n            \"descriptions\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Operating system of the smartphone\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Système d'exploitation du smartphone\"\n                }\n            ],\n            \"available_values\": [\n                {\n                    \"id\": \"ANDROID\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Android\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Android\"\n                        }\n                    ]\n                },\n                {\n                    \"id\": \"IOS\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"iOS\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"iOS\"\n                        }\n                    ]\n                }\n            ]\n        },\n        {\n            \"id\": \"Mobile_OS_version\",\n            \"requirement_level\": \"RECOMMENDED\",\n            \"type\": \"Text\",\n            \"labels\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"OS Version\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Version OS\"\n                }\n            ],\n            \"context\": {\n                \"labels\": [\n                    {\n                        \"locale\": \"en\",\n                        \"value\": \"Technical Specifications / OS Version\"\n                    },\n                    {\n                        \"locale\": \"fr\",\n                        \"value\": \"Spécifications Techniques / Version OS\"\n                    }\n                ],\n                \"path\": \"$.mobile_os_version\"\n            },\n            \"descriptions\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Version of the smartphone operating system\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Version du système d'exploitation du smartphone\"\n                }\n            ]\n        },\n        {\n            \"id\": \"main_image\",\n            \"requirement_level\": \"REQUIRED\",\n            \"type\": \"Media\",\n            \"media_type\": \"IMAGE\",\n            \"labels\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Main image\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Image principale\"\n                }\n            ],\n            \"context\": {\n                \"labels\": [\n                    {\n                        \"locale\": \"en\",\n                        \"value\": \"Media / Product Images / Main Image\"\n                    },\n                    {\n                        \"locale\": \"fr\",\n                        \"value\": \"Média / Images Produit / Image Principale\"\n                    }\n                ],\n                \"path\": \"$.main_image\"\n            },\n            \"descriptions\": [],\n            \"connect_standard_attributes\": [\n                \"IMAGE\"\n            ]\n        }\n    ],\n    \"rules\": [\n        {\n            \"ref\": \"rule-smartphones\"\n        }\n    ]\n}\n","key":"application/json; charset=UTF-8-0","summary":"Product Type 'Smartphones' on a fake channel (dummy example)","id":"paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-0"},"paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1":{"value":"{\n    \"labels\": [\n        {\n            \"locale\": \"en\",\n            \"value\": \"Smartphones\"\n        },\n        {\n            \"locale\": \"fr\",\n            \"value\": \"Smartphones\"\n        }\n    ],\n    \"context\": {\n        \"labels\": [\n            {\n                \"locale\": \"en\",\n                \"value\": \"Electronics / Mobile Devices / Smartphones\"\n            },\n            {\n                \"locale\": \"fr\",\n                \"value\": \"Électronique / Appareils Mobiles / Smartphones\"\n            }\n        ]\n    },\n    \"embedded_attributes\": [\n        {\n            \"id\": \"Brand\",\n            \"requirement_level\": \"REQUIRED\",\n            \"type\": \"List\",\n            \"labels\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Brand\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Marque\"\n                }\n            ],\n            \"context\": {\n                \"labels\": [\n                    {\n                        \"locale\": \"en\",\n                        \"value\": \"Product Information / Brand\"\n                    },\n                    {\n                        \"locale\": \"fr\",\n                        \"value\": \"Information Produit / Marque\"\n                    }\n                ],\n                \"path\": \"$.brand\"\n            },\n            \"descriptions\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Brand of the product\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Marque du produit\"\n                }\n            ],\n            \"connect_standard_attributes\": [\n                \"BRAND\"\n            ],\n            \"available_values\": [\n                {\n                    \"id\": \"APPLE\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Apple\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Apple\"\n                        }\n                    ]\n                },\n                {\n                    \"id\": \"SAMSUNG\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Samsung\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Samsung\"\n                        }\n                    ]\n                },\n                {\n                    \"id\": \"XIAOMI\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Xiaomi\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Xiaomi\"\n                        }\n                    ]\n                }\n            ]\n        },\n        {\n            \"id\": \"Mobile_OS\",\n            \"requirement_level\": \"REQUIRED\",\n            \"type\": \"List\",\n            \"labels\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Mobile OS\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Système d'exploitation\"\n                }\n            ],\n            \"context\": {\n                \"labels\": [\n                    {\n                        \"locale\": \"en\",\n                        \"value\": \"Technical Specifications / Operating System\"\n                    },\n                    {\n                        \"locale\": \"fr\",\n                        \"value\": \"Spécifications Techniques / Système d'exploitation\"\n                    }\n                ],\n                \"path\": \"$.mobile_os\"\n            },\n            \"descriptions\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Operating system of the smartphone\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Système d'exploitation du smartphone\"\n                }\n            ],\n            \"available_values\": [\n                {\n                    \"id\": \"ANDROID\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"Android\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"Android\"\n                        }\n                    ]\n                },\n                {\n                    \"id\": \"IOS\",\n                    \"labels\": [\n                        {\n                            \"locale\": \"en\",\n                            \"value\": \"iOS\"\n                        },\n                        {\n                            \"locale\": \"fr\",\n                            \"value\": \"iOS\"\n                        }\n                    ]\n                }\n            ]\n        },\n        {\n            \"id\": \"main_video\",\n            \"requirement_level\": \"REQUIRED\",\n            \"type\": \"Media\",\n            \"media_type\": \"OTHER\",\n            \"labels\": [\n                {\n                    \"locale\": \"en\",\n                    \"value\": \"Main video\"\n                },\n                {\n                    \"locale\": \"fr\",\n                    \"value\": \"Vidéo principale\"\n                }\n            ],\n            \"context\": {\n                \"labels\": [\n                    {\n                        \"locale\": \"en\",\n                        \"value\": \"Media / Product Videos / Main Video\"\n                    },\n                    {\n                        \"locale\": \"fr\",\n                        \"value\": \"Média / Vidéos Produit / Vidéo Principale\"\n                    }\n                ],\n                \"path\": \"$.main_video\"\n            },\n            \"descriptions\": [],\n            \"connect_standard_attributes\": [\n                \"BRAND\"\n            ]\n        }\n    ],\n    \"rules\": [\n        {\n            \"ref\": \"rule-smartphones\"\n        }\n    ]\n}\n","key":"application/json; charset=UTF-8-1","summary":"Product Type 'Smartphones' on another fake channel (dummy example)","id":"paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-1"},"paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto":{"value":{"labels":[{"locale":"en_US","value":"string"}],"context":{"labels":[{"locale":"en_US","value":"string"}]},"embedded_attributes":[{"id":"COLOR","requirement_level":"OPTIONAL","type":"Text","connect_standard_attributes":["PRODUCT_ID"],"labels":[{"locale":"en_US","value":"string"}],"context":{"path":"string","labels":[{"locale":"en_US","value":"string"}]},"descriptions":[{"locale":"en_US","value":"string"}]}],"rules":[{"ref":"rule-1234"}]},"key":"application/json; charset=UTF-8-auto","summary":"Complete example with value types (application/json; charset=utf-8)","id":"paths/~1v1~1taxonomy~1channels~1{channel_id}~1product-types/put/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"},"paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"origin":{"channel_id":"string","channel_store_id":"string","sub_channel_code":"string"}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/requestBody/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/400/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/400/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/404/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1{channel_order_id}~1documents~1{channel_document_id}/delete/responses/404/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1actions~1{action_id}/put/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"status":"SUCCESS","errors":[{"code":"INVALID_INPUT","message":"Cannot process cancellation: order is already shipped"}]},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1actions~1{action_id}/put/requestBody/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1actions~1{action_id}/put/responses/400/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1actions~1{action_id}/put/responses/400/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1actions~1{action_id}/put/responses/404/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1actions~1{action_id}/put/responses/404/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1anonymize-after/put/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"orders":[{"channel_order_id":"COMMERCIAL_ID-A","channel_id":1234,"channel_store_id":"2005","sub_channel_code":"string","anonymize_after":"2023-10-01T00:00:00Z"}]},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1anonymize-after/put/requestBody/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1anonymize-after/put/responses/400/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1anonymize-after/put/responses/400/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1{channel_order_id}~1documents/post/requestBody/content/multipart~1form-data/examples/multipart~1form-data-auto":{"value":{"file":"string","origin":{"channel_id":"string","channel_store_id":"string","sub_channel_code":"string"},"metadata":{"channel_document_id":"string","filename":"UPS_1Z999AA10123456784.pdf","type":"RETURN_LABEL","channel_type":"string","entity":{"id":"caf30673-ea3d-4113-9a18-674850f6a290","type":"RETURN"}}},"key":"multipart/form-data-auto","summary":"Complete example with value types (multipart/form-data)","id":"paths/~1v1~1orders~1{channel_order_id}~1documents/post/requestBody/content/multipart~1form-data/examples/multipart~1form-data-auto"},"paths/~1v1~1orders~1{channel_order_id}~1documents/post/responses/400/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1{channel_order_id}~1documents/post/responses/400/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders/post/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"origin":{"channel_id":"string","channel_store_id":"string"},"orders":[{"channel_order_id":"string","created_at":"2023-03-28T09:34:42Z","channel_updated_at":"2023-03-28T09:34:42Z","status":"AWAITING_ACCEPTANCE","shipping_info":{"email":"string","address":{"last_name":"string","street":"string","city":"string","first_name":"string","company":"string","street_additional_info":"string","state":"string","country":"string","country_iso_code":"string","zip_code":"string","phone":"string","additional_info":"string"},"carrier":"string","method":"string","pudo_id":"string","shipping_deadline":"2023-03-28T09:34:42Z","delivery_date":{"earliest":"2023-03-28T09:34:42Z","latest":"2023-03-28T09:34:42Z"}},"order_lines":[{"channel_order_line_id":"string","created_at":"2023-03-28T09:34:42Z","updated_at":"2023-03-28T09:34:42Z","quantity":0,"can_cancel":true,"can_refund":true,"total_shipping_price":{"amount":0,"currency":"string"},"price":{"amount":0,"currency":"string"},"product":{"id":"string","title":"string","thumbnail_url":"string"},"taxes":[{"amount":{"amount":0,"currency":"string"},"code":"string","rate":0,"seller_collectible":{"amount":0,"currency":"string"},"channel_collectible":{"amount":0,"currency":"string"}}],"shipping_taxes":[{"amount":{"amount":0,"currency":"string"},"code":"string","rate":0,"seller_collectible":{"amount":0,"currency":"string"},"channel_collectible":{"amount":0,"currency":"string"}}],"status":"AWAITING_ACCEPTANCE","status_reason":"ACCEPTANCE_TIMEOUT","adjustments":[{"channel_adjustment_id":"string","reason":"CUSTOMER_CANCELATION","created_at":"2023-03-28T09:34:42Z","type":"REFUND","quantity":0,"price":{"amount":0,"currency":"string"},"taxes":[{"amount":{"amount":0,"currency":"string"},"code":"string","rate":0,"seller_collectible":{"amount":0,"currency":"string"},"channel_collectible":{"amount":0,"currency":"string"}}],"shipping_price":{"amount":0,"currency":"string"},"shipping_taxes":[{"amount":{"amount":0,"currency":"string"},"code":"string","rate":0,"seller_collectible":{"amount":0,"currency":"string"},"channel_collectible":{"amount":0,"currency":"string"}}]}],"custom_attributes":[{"id":"string","type":"STRING"}],"ship_from":{"warehouse":{"id":"string"}}}],"status_reason":"ACCEPTANCE_TIMEOUT","fulfillment":{"type":"FULFILLED_BY_SELLER","code":"string"},"billing_info":{"address":{"last_name":"string","street":"string","city":"string","first_name":"string","company":"string","street_additional_info":"string","state":"string","country":"string","country_iso_code":"string","zip_code":"string","phone":"string","additional_info":"string"}},"has_incident":true,"custom_attributes":[{"id":"string","type":"STRING"}],"sub_channel_code":"string"}]},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders/post/requestBody/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders/post/responses/400/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders/post/responses/400/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders/post/responses/404/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders/post/responses/404/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/200/content/application~1json/examples/application~1json-auto":{"value":[{"code":"WH-PARIS-01","name":"Paris warehouse"}],"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/200/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/400/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/400/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/401/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/401/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/403/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/403/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/404/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/404/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/500/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}~1warehouses/get/responses/500/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto":{"value":{"store_catalog_items":[{"id":"string","diagnostics":[{"message":"string","severity":"ERROR","channel_diagnostic_id":"string","channel_attribute_id":"string","connector_override_action":"REMOVED"}],"offer_diagnostics":[{"message":"string","severity":"ERROR","channel_diagnostic_id":"string","channel_attribute_id":"string","connector_override_action":"REMOVED"}],"product_diagnostics":[{"message":"string","severity":"ERROR","channel_diagnostic_id":"string","channel_attribute_id":"string","connector_override_action":"REMOVED"}],"offer_status":"OFFER_ACTIVE","product_status":"PRODUCT_DOES_NOT_EXIST"}]},"key":"application/json; charset=UTF-8-auto","summary":"Complete example with value types (application/json; charset=utf-8)","id":"paths/~1v1~1channel-catalog~1{channel_id}~1store-catalog-items~1{store_id}/post/requestBody/content/application~1json; charset=UTF-8/examples/application~1json; charset=UTF-8-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"currency":"USD","kyc_status":"PENDING_SUBMISSION","kyc_status_reason":"string","shipping_warning":"string","payment_information_warning":"string","payment_information_configured":true,"quality_suspension_reasons":[{"rule":"Evaluation Grade last month was lower than 3.5 expected to never be lower than 4.0","period":"Last month","rule_comparison_method":"lower than","rule_type":"DECIMAL","stat_value":3.5,"threshold":0}],"sub_channels":[{"id":"12345","name":"Premium Sellers","currency":"USD"}],"missing_configuration":true,"updated_at":"2023-03-28T09:34:42Z"},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/requestBody/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/400/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/400/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/401/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/401/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/403/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/403/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/404/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/404/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/500/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1channels~1{channel_id}~1stores~1{channel_store_id}/put/responses/500/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"carriers":[{"channel_carrier_id":"string","name":"string"}]},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/requestBody/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/400/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/400/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/404/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1channels~1{channel_id}~1carriers/post/responses/404/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1returns/post/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"origin":{"channel_id":"string","channel_store_id":"string"},"returns":[{"channel_return_id":"string","channel_order_id":"string","rma_id":"string","status":"REQUEST_INITIATED","tracking":{"tracking_number":"string","carrier_name":"string","tracking_url":"string"},"label_url":"string","method":"string","rejection_reason":"RETURN_WINDOW_CLOSED","address":{"street":"string","street_additional_info":"string","city":"string","state":"string","country":"string","country_iso_code":"string","zip_code":"string"},"created_at":"2023-03-28T09:34:42Z","channel_updated_at":"2023-03-28T09:34:42Z","return_lines":[{"channel_order_line_id":"string","quantity":0,"reason":"WRONG_ITEM"}],"sub_channel_code":"string"}]},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1returns/post/requestBody/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1returns/post/responses/200/content/application~1json/examples/application~1json-auto":{"value":{"return_success":[{"channel_order_id":"string","channel_return_id":"string"}],"return_errors":[{"channel_order_id":"string","channel_return_id":"string","details":[{"code":"DATA_NOT_FOUND","message":"string","field":"string"}]}]},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1returns/post/responses/200/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1returns/post/responses/400/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1returns/post/responses/400/content/application~1json/examples/application~1json-auto"},"paths/~1v1~1orders~1returns/post/responses/404/content/application~1json/examples/application~1json-auto":{"value":{"code":"DATA_NOT_FOUND","message":"An error occurred while processing your request","errors":[{"message":"An error occurred while processing your request: id is null","field":"input.account.id","extensions":{"minLength":1,"maxLength":255}}],"extensions":{"minLength":1,"maxLength":255}},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/~1v1~1orders~1returns/post/responses/404/content/application~1json/examples/application~1json-auto"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"https://miraklconnect.com/api/channel-platform","description":"Connect Channel Platform API"}],"specType":"openapi"},"options":{"hideDownloadButtons":true,"hidePropertiesPrefix":true,"hideSchemaTitles":true,"schemasExpansionLevel":0,"hideReplay":true,"feedback":{"hide":true,"settings":{"label":""}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/content/product/connect-channel-platform/rest/connect/openapi3.json?download"},{"url":"/_bundle/content/product/connect-channel-platform/rest/connect/openapi3.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Mirakl Connect Channel Platform APIs","description":"{% partial file=\"/partial-content/product/connect-channel-platform/rest/connect/openapi-description.md\" /%}"}},"baseSlug":"/content/product/connect-channel-platform/rest/connect/openapi3","routesMapping":{}}