{"items":[{"type":"link","label":"Mirakl Connect Channel Platform Webhooks","link":"/content/product/connect-channel-platform/webhooks/webhook","routeSlug":"/content/product/connect-channel-platform/webhooks/webhook","content":{"contentType":"overview","meta":{"name":"Mirakl Connect Channel Platform Webhooks"},"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":"The URL of your server","url":"https://your-service.mirakl.net"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Mirakl Connect Channel Platform Webhooks","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"partial","attributes":{"file":"partial-content/product/connect-channel-platform/webhooks/common/openapi-description.md","variables":{"$$apiDocsHeadingScope":{"operationId":"","deepLinkSuffix":"section"}}},"children":[]}]}],"sectionId":"/content/product/connect-channel-platform/webhooks/webhook"}],"sectionId":"/content/product/connect-channel-platform/webhooks/webhook"}]}]}},{"type":"group","label":"webhooks","link":"/content/product/connect-channel-platform/webhooks/webhook/webhooks","routeSlug":"/content/product/connect-channel-platform/webhooks/webhook/webhooks","items":[{"label":"Give information about a created or updated offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/content/product/connect-channel-platform/webhooks/webhook/webhooks/offerupsertevent","routeSlug":"/content/product/connect-channel-platform/webhooks/webhook/webhooks/offerupsertevent","metadata":{"seo":{"title":"Give information about a created or updated offer","description":"The offer upsert event received by third parties"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OfferUpsertEvent","name":"Give information about a created or updated offer","isWebhook":true,"pointer":"/paths/OfferUpsertEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Give information about a created or updated offer","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The offer upsert event received by third parties"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferUpsertEvent","exampleIds":["paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/OfferUpsertEvent","exampleIds":["paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/OfferUpsertEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"OfferUpsertEvent","servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferUpsertEvent","exampleIds":["paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"pointer":"OfferUpsertEvent","href":"webhooks/offerupsertevent","openApiOperationId":"OfferUpsertEvent","summary":"Give information about a created or updated offer"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"schemaId":"components/schemas/OfferUpsertEvent","exampleIds":["paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferUpsertEvent","exampleIds":["paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{},{},{}]}]}]}]},"httpPath":"OfferUpsertEvent"},{"label":"Performs an action on an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/content/product/connect-channel-platform/webhooks/webhook/webhooks/orderactionevent","routeSlug":"/content/product/connect-channel-platform/webhooks/webhook/webhooks/orderactionevent","metadata":{"seo":{"title":"Performs an action on an order","description":"Command to perform an action on an order. This event is processed by the channel technology connector"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OrderActionEvent","name":"Performs an action on an order","isWebhook":true,"pointer":"/paths/OrderActionEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Performs an action on an order","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Command to perform an action on an order. This event is processed by the channel technology connector"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderActionEvent","exampleIds":["paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-2","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-3","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-4","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-5","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-6","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-7","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-8","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-9","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/OrderActionEvent","exampleIds":["paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-2","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-3","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-4","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-5","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-6","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-7","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-8","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-9","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/OrderActionEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"OrderActionEvent","servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderActionEvent","exampleIds":["paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-2","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-3","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-4","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-5","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-6","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-7","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-8","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-9","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"pointer":"OrderActionEvent","href":"webhooks/orderactionevent","openApiOperationId":"OrderActionEvent","summary":"Performs an action on an order"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"schemaId":"components/schemas/OrderActionEvent","exampleIds":["paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-2","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-3","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-4","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-5","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-6","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-7","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-8","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-9","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderActionEvent","exampleIds":["paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-2","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-3","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-4","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-5","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-6","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-7","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-8","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-9","paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{}]}]}]}]},"httpPath":"OrderActionEvent"},{"label":"Give information about a price stock upsert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/content/product/connect-channel-platform/webhooks/webhook/webhooks/pricestockupsertevent","routeSlug":"/content/product/connect-channel-platform/webhooks/webhook/webhooks/pricestockupsertevent","metadata":{"seo":{"title":"Give information about a price stock upsert","description":"The price stock upsert event received by third parties"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PriceStockUpsertEvent","name":"Give information about a price stock upsert","isWebhook":true,"pointer":"/paths/PriceStockUpsertEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Give information about a price stock upsert","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The price stock upsert event received by third parties"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PriceStockUpsertEvent","exampleIds":["paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-2","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-3","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-4","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/PriceStockUpsertEvent","exampleIds":["paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-2","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-3","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-4","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/PriceStockUpsertEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"PriceStockUpsertEvent","servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PriceStockUpsertEvent","exampleIds":["paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-2","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-3","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-4","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"pointer":"PriceStockUpsertEvent","href":"webhooks/pricestockupsertevent","openApiOperationId":"PriceStockUpsertEvent","summary":"Give information about a price stock upsert"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"schemaId":"components/schemas/PriceStockUpsertEvent","exampleIds":["paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-2","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-3","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-4","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PriceStockUpsertEvent","exampleIds":["paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-2","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-3","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-4","paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{},{},{},{},{},{}]}]}]}]},"httpPath":"PriceStockUpsertEvent"},{"label":"Give information about a created or updated product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/content/product/connect-channel-platform/webhooks/webhook/webhooks/productupsertevent","routeSlug":"/content/product/connect-channel-platform/webhooks/webhook/webhooks/productupsertevent","metadata":{"seo":{"title":"Give information about a created or updated product","description":"The product upsert event received by third parties"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProductUpsertEvent","name":"Give information about a created or updated product","isWebhook":true,"pointer":"/paths/ProductUpsertEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Give information about a created or updated product","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The product upsert event received by third parties"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductUpsertEvent","exampleIds":["paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/ProductUpsertEvent","exampleIds":["paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/ProductUpsertEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"ProductUpsertEvent","servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ProductUpsertEvent","exampleIds":["paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"pointer":"ProductUpsertEvent","href":"webhooks/productupsertevent","openApiOperationId":"ProductUpsertEvent","summary":"Give information about a created or updated product"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"schemaId":"components/schemas/ProductUpsertEvent","exampleIds":["paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductUpsertEvent","exampleIds":["paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0","paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{},{}]}]}]}]},"httpPath":"ProductUpsertEvent"},{"label":"Manage features for a given store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/content/product/connect-channel-platform/webhooks/webhook/webhooks/storemanagementfeatureevent","routeSlug":"/content/product/connect-channel-platform/webhooks/webhook/webhooks/storemanagementfeatureevent","metadata":{"seo":{"title":"Manage features for a given store","description":"The store feature event is sent when a feature configuration is updated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"StoreManagementFeatureEvent","name":"Manage features for a given store","isWebhook":true,"pointer":"/paths/StoreManagementFeatureEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manage features for a given store","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The store feature event is sent when a feature configuration is updated"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StoreManagementFeatureEvent","exampleIds":["paths/StoreManagementFeatureEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"schemaId":"components/schemas/StoreManagementFeatureEvent","exampleIds":["paths/StoreManagementFeatureEvent/post/requestBody/content/application~1json/examples/application~1json-auto"],"pointer":"/paths/StoreManagementFeatureEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"StoreManagementFeatureEvent","servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/StoreManagementFeatureEvent","exampleIds":["paths/StoreManagementFeatureEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"pointer":"StoreManagementFeatureEvent","href":"webhooks/storemanagementfeatureevent","openApiOperationId":"StoreManagementFeatureEvent","summary":"Manage features for a given store"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"schemaId":"components/schemas/StoreManagementFeatureEvent","exampleIds":["paths/StoreManagementFeatureEvent/post/requestBody/content/application~1json/examples/application~1json-auto"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StoreManagementFeatureEvent","exampleIds":["paths/StoreManagementFeatureEvent/post/requestBody/content/application~1json/examples/application~1json-auto"]}},"examples":[{}]}]}]}]},"httpPath":"StoreManagementFeatureEvent"}],"content":{"contentType":"group","meta":{"name":"webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"webhooks","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"OfferUpsertEvent","summary":"Give information about a created or updated offer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/offerupsertevent","deprecated":false},{"title":"OrderActionEvent","summary":"Performs an action on an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/orderactionevent","deprecated":false},{"title":"PriceStockUpsertEvent","summary":"Give information about a price stock upsert","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/pricestockupsertevent","deprecated":false},{"title":"ProductUpsertEvent","summary":"Give information about a created or updated product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/productupsertevent","deprecated":false},{"title":"StoreManagementFeatureEvent","summary":"Manage features for a given store","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/storemanagementfeatureevent","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AcknowledgeReturnReceptionCommandEvent":{"id":"components/schemas/AcknowledgeReturnReceptionCommandEvent","kind":"json-schema","title":"ACKNOWLEDGE_RETURN_RECEPTION","data":{"description":"Acknowledge return reception payload command, used to marked return as received","properties":{"action_id":{"type":"string","description":"A unique identifier for the order action request. Will be used by the connector to update the order action status. see updateActionStatus"},"channel_id":{"type":"string","description":"The channel id"},"channel_order_id":{"type":"string","description":"The order id on the channel"},"channel_return_id":{"type":"string","description":"The return id on the channel"},"channel_store_id":{"type":"string","description":"The store id on the channel"},"sub_channel_code":{"type":"string","description":"The sub-channel code"}},"required":["action_id","channel_id","channel_order_id","channel_return_id","channel_store_id"],"title":"ACKNOWLEDGE_RETURN_RECEPTION"}},"components/schemas/ActionPayload":{"id":"components/schemas/ActionPayload","kind":"json-schema","title":"ActionPayload","data":{"description":"Event payload details for the specific action type","oneOf":[{"$ref":"#/components/schemas/OrderRefundCommandEvent"},{"$ref":"#/components/schemas/OrderCancelationCommandEvent"},{"$ref":"#/components/schemas/OrderAcceptanceCommandEvent"},{"$ref":"#/components/schemas/OrderShipmentCommandEvent"},{"$ref":"#/components/schemas/ReturnAcceptanceCommandEvent"},{"$ref":"#/components/schemas/ReturnTrackingInformationUpdateCommandEvent"},{"$ref":"#/components/schemas/AcknowledgeReturnReceptionCommandEvent"},{"$ref":"#/components/schemas/CloseReturnCommandEvent"},{"$ref":"#/components/schemas/DocumentUploadCommandEvent"}]}},"components/schemas/Attribute":{"id":"components/schemas/Attribute","kind":"json-schema","title":"Attribute","data":{"description":"An attribute of the product.","properties":{"id":{"type":"string","description":"Id of the attribute, in the channel's format."},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For localized attribute, locale used for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"Format can be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<ISO-639>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<ISO-639>_<ISO-3166>"},"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":"This "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is only present when Catalog Transformer detected a locale for this attribute's value, it is omitted otherwise (never "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor empty)."},"children":[]}]}]}]},"value":{"type":"string","description":"Value of the attribute, in the channel's format."}},"required":["id"]}},"components/schemas/CloseReturnCommandEvent":{"id":"components/schemas/CloseReturnCommandEvent","kind":"json-schema","title":"CLOSE_RETURN","data":{"description":"Close return payload command, used to marked return as closed","properties":{"action_id":{"type":"string","description":"A unique identifier for the order action request. Will be used by the connector to update the order action status. see updateActionStatus"},"channel_id":{"type":"string","description":"The channel id"},"channel_order_id":{"type":"string","description":"The order id on the channel"},"channel_return_id":{"type":"string","description":"The return id on the channel"},"channel_store_id":{"type":"string","description":"The store id on the channel"},"sub_channel_code":{"type":"string","description":"The sub-channel code"}},"required":["action_id","channel_id","channel_order_id","channel_return_id","channel_store_id"],"title":"CLOSE_RETURN"}},"components/schemas/DeliveryPartner":{"id":"components/schemas/DeliveryPartner","kind":"json-schema","title":"DeliveryPartner","data":{"properties":{"name":{"type":"string"}}}},"components/schemas/DiscountPriceUpsert":{"id":"components/schemas/DiscountPriceUpsert","kind":"json-schema","title":"DiscountPriceUpsert","data":{"properties":{"action_type":{"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":"\"UPDATE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DELETE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"IGNORE\""},"children":[]}]}]}]},"end_date":{"type":"string","format":"date-time"},"price":{"$ref":"#/components/schemas/Price"},"start_date":{"type":"string","format":"date-time"}}}},"components/schemas/DocumentUploadCommandEvent":{"id":"components/schemas/DocumentUploadCommandEvent","kind":"json-schema","title":"UPLOAD_DOCUMENT","data":{"description":"Order Document Upload payload command, used to upload a document on an order or its related entities (e.g. returns)","properties":{"action_id":{"type":"string","description":"A unique identifier for the order action request. Will be used by the connector to update the order action status. see updateActionStatus"},"channel_id":{"type":"string","description":"The channel id"},"channel_order_id":{"type":"string","description":"The order id on the channel"},"channel_store_id":{"type":"string","description":"The store id on the channel"},"document_download_url":{"type":"string","description":"Presigned URL from which the document can be downloaded by the connector. This link has an expiration date"},"document_entity":{"$ref":"#/components/schemas/UploadOrderDocumentEntityEvent","description":"Entity to which the order document is linked when its needed."},"document_name":{"type":"string","description":"Name of the document to upload"},"document_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 to upload"},"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":[]}]}]}]},"sub_channel_code":{"type":"string","description":"The sub-channel code"}},"required":["action_id","channel_id","channel_order_id","channel_store_id","document_download_url","document_name","document_type"],"title":"UPLOAD_DOCUMENT"}},"components/schemas/EnableStatusFeatureConfigurationPayload":{"id":"components/schemas/EnableStatusFeatureConfigurationPayload","kind":"json-schema","title":"business-information-sync","data":{"properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the feature, either enabled or disabled"},"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":"\"enabled\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"disabled\""},"children":[]}]}]}]}},"required":["status"],"title":"business-information-sync"}},"components/schemas/FulfillmentPartnerStock":{"id":"components/schemas/FulfillmentPartnerStock","kind":"json-schema","title":"FulfillmentPartnerStock","data":{"allOf":[{"$ref":"#/components/schemas/StockDetail"},{"type":"object","properties":{"partner":{"$ref":"#/components/schemas/Partner"},"quantity":{"type":"integer","format":"int32","description":"Quantity available for this stock"}}}],"required":["quantity","type"]}},"components/schemas/InventoryUpsert":{"id":"components/schemas/InventoryUpsert","kind":"json-schema","title":"InventoryUpsert","data":{"properties":{"action_type":{"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":"\"UPDATE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DELETE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"IGNORE\""},"children":[]}]}]}]},"delivery_partner":{"$ref":"#/components/schemas/DeliveryPartner"},"quantity":{"type":"integer","format":"int32"}}}},"components/schemas/LinkStatusFeatureConfigurationPayload":{"id":"components/schemas/LinkStatusFeatureConfigurationPayload","kind":"json-schema","title":"store-linking","data":{"properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the feature, either linked or unlinked"},"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":"\"linked\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"unlinked\""},"children":[]}]}]}]}},"required":["status"],"title":"store-linking"}},"components/schemas/ListValue":{"id":"components/schemas/ListValue","kind":"json-schema","title":"ListValue","data":{"properties":{"value":{"type":"string"}}}},"components/schemas/OfferUpsertEvent":{"id":"components/schemas/OfferUpsertEvent","kind":"json-schema","title":"OfferUpsertEvent","data":{"properties":{"data":{"$ref":"#/components/schemas/OfferUpsertEventData","description":"Domain-specific business data"},"id":{"type":"string","description":"Unique identifier for the payload in ULID format"},"time":{"type":"string","format":"date-time","description":"Event creation date"},"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 payload which defines the data"},"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_UPSERT\""},"children":[]}]}]}]}},"required":["data","id","time","type"]}},"components/schemas/OfferUpsertEventData":{"id":"components/schemas/OfferUpsertEventData","kind":"json-schema","title":"OfferUpsertEventData","data":{"properties":{"channel_id":{"type":"string","description":"Identifier of the channel to be notified"},"discount_price":{"$ref":"#/components/schemas/DiscountPriceUpsert","description":"Discount price"},"identifier":{"$ref":"#/components/schemas/ProductIdentifierDTO","deprecated":true,"description":"Deprecated: Use 'identifiers' instead. This field will be removed in a future version."},"identifiers":{"type":"array","description":"Product identifiers","items":{"$ref":"#/components/schemas/ProductIdentifierDTO"}},"inventory":{"$ref":"#/components/schemas/InventoryUpsert","description":"Aggregated stock, kept for backward compatibility"},"offer_attributes":{"type":"array","description":"Offer attributes","items":{"$ref":"#/components/schemas/ProductOfferAttribute"}},"product_id":{"type":"string","description":"Reference of the product"},"standard_price":{"$ref":"#/components/schemas/StandardPriceUpsert","description":"Standard price"},"stock":{"$ref":"#/components/schemas/StockUpsert","description":"Stock breakdown per warehouse and per logistic partner"},"store_id":{"type":"string","description":"Store id of the marketplace to be notified"},"sub_channel_prices":{"type":"array","deprecated":true,"description":"Deprecated: internal-only field added to address a specific issue. Not intended for integration and may be removed without notice.","items":{"$ref":"#/components/schemas/SubChannelPrice"}},"use_case":{"type":"string","description":"Use case for the event"}},"required":["channel_id","discount_price","inventory","product_id","standard_price","stock","store_id","use_case"]}},"components/schemas/OrderAcceptanceCommandEvent":{"id":"components/schemas/OrderAcceptanceCommandEvent","kind":"json-schema","title":"ACCEPT","data":{"description":"Order Acceptance payload command, Used to accept or decline order","properties":{"action_id":{"type":"string","description":"A unique identifier for the order action request. Will be used by the connector to update the order action status. see updateActionStatus"},"channel_id":{"type":"string","description":"The channel id"},"channel_order_id":{"type":"string","description":"The order id on the channel"},"channel_store_id":{"type":"string","description":"The store id on the channel"},"order_lines":{"type":"array","description":"List of acceptance order line items","items":{"$ref":"#/components/schemas/OrderLineAcceptancePayload"}},"sub_channel_code":{"type":"string","description":"The sub-channel code"}},"required":["action_id","channel_id","channel_order_id","channel_store_id","order_lines"],"title":"ACCEPT"}},"components/schemas/OrderActionEvent":{"id":"components/schemas/OrderActionEvent","kind":"json-schema","title":"OrderActionEvent","data":{"description":"Command to perform an action on an order. This event is processed by the channel technology connector","properties":{"data":{"$ref":"#/components/schemas/ActionPayload","description":""},"id":{"type":"string","description":"Unique identifier for the payload in ULID format"},"time":{"type":"string","format":"date-time","description":"Event creation date"},"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 action to perform on the order, acts as a discriminator for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"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":"\"ACCEPT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CREATE_SHIPMENT\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"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":"\"CANCEL\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ACCEPT_RETURN\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"UPDATE_RETURN_TRACKING_INFORMATION\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ACKNOWLEDGE_RETURN_RECEPTION\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CLOSE_RETURN\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"UPLOAD_DOCUMENT\""},"children":[]}]}]}]}},"required":["id","time","type"]}},"components/schemas/OrderCancelationCommandEvent":{"id":"components/schemas/OrderCancelationCommandEvent","kind":"json-schema","title":"CANCEL","data":{"description":"Order Cancellation payload command, used to process full or partial order cancellation","properties":{"action_id":{"type":"string","description":"A unique identifier for the order action request. Will be used by the connector to update the order action status. see updateActionStatus"},"cancelations":{"type":"array","description":"List of cancellation order line items","items":{"$ref":"#/components/schemas/OrderLineCancelationPayload"}},"channel_id":{"type":"string","description":"The channel id"},"channel_order_id":{"type":"string","description":"The order id on the channel"},"channel_store_id":{"type":"string","description":"The store id on the channel"},"sub_channel_code":{"type":"string","description":"The sub-channel code"}},"required":["action_id","cancelations","channel_id","channel_order_id","channel_store_id"],"title":"CANCEL"}},"components/schemas/OrderLineAcceptancePayload":{"id":"components/schemas/OrderLineAcceptancePayload","kind":"json-schema","title":"OrderLineAcceptancePayload","data":{"description":"Acceptance order line payload","properties":{"accepted":{"type":"boolean","description":"Indicates if an order line is accepted (true) or refused (false).","example":true},"channel_order_line_id":{"type":"string","description":"The order line identified as defined by the channel. ID of the order line to accept or refuse.","example":"0002_3202630-A-2"}},"required":["accepted","channel_order_line_id"]}},"components/schemas/OrderLineCancelationPayload":{"id":"components/schemas/OrderLineCancelationPayload","kind":"json-schema","title":"OrderLineCancelationPayload","data":{"description":"Cancelation order line payload","properties":{"channel_order_line_id":{"type":"string","description":"The order line identified as defined by the channel. ID of the order line to cancel.","example":"0002_3202630-A-2"},"price":{"$ref":"#/components/schemas/PricePayload","description":"Product price to cancel, excluding taxes and shipping price"},"product_id":{"type":"string","description":"Seller product identifier on the channel"},"quantity":{"type":"integer","format":"int32","description":"Product quantity to cancel","example":10,"minimum":0},"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 code for the cancellation"},"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/PricePayload","description":"Shipping price to cancel, excluding shipping taxes"},"shipping_taxes":{"type":"array","description":"List of shipping taxes to cancel","items":{"$ref":"#/components/schemas/TaxPayload"}},"taxes":{"type":"array","description":"List of taxes to cancel","items":{"$ref":"#/components/schemas/TaxPayload"}}},"required":["channel_order_line_id","price","product_id","quantity","reason","shipping_price"]}},"components/schemas/OrderLineRefundPayload":{"id":"components/schemas/OrderLineRefundPayload","kind":"json-schema","title":"OrderLineRefundPayload","data":{"properties":{"channel_order_line_id":{"type":"string","description":"The order line identified as defined by the channel. ID of the order line to refund.","example":"0002_3202630-A-2"},"price":{"$ref":"#/components/schemas/PricePayload","description":"Product price to refund, excluding taxes and shipping price"},"product_id":{"type":"string","description":"Seller product identifier on the channel","example":"SELLER_ID_1"},"quantity":{"type":"integer","format":"int32","description":"Product quantity to refund","example":10},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the order line is refunded"},"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/PricePayload","description":"Shipping price to refund, excluding shipping taxes"},"shipping_taxes":{"type":"array","description":"List of shipping taxes to refund","items":{"$ref":"#/components/schemas/TaxPayload"}},"taxes":{"type":"array","description":"List of taxes to refund","items":{"$ref":"#/components/schemas/TaxPayload"}}},"required":["channel_order_line_id","price","product_id","quantity","reason","shipping_price"]}},"components/schemas/OrderRefundCommandEvent":{"id":"components/schemas/OrderRefundCommandEvent","kind":"json-schema","title":"REFUND","data":{"description":"Order Refund payload command, Used to refund order","properties":{"action_id":{"type":"string","description":"A unique identifier for the order action request. Will be used by the connector to update the order action status. see updateActionStatus"},"channel_id":{"type":"string","description":"The channel id"},"channel_order_id":{"type":"string","description":"The order id on the channel"},"channel_store_id":{"type":"string","description":"The store id on the channel"},"refunds":{"type":"array","description":"List of order line refund actions, detailing each line item to be refunded","items":{"$ref":"#/components/schemas/OrderLineRefundPayload"}},"sub_channel_code":{"type":"string","description":"The sub-channel code"}},"required":["action_id","channel_id","channel_order_id","channel_store_id"],"title":"REFUND"}},"components/schemas/OrderShipmentCommandEvent":{"id":"components/schemas/OrderShipmentCommandEvent","kind":"json-schema","title":"CREATE_SHIPMENT","data":{"description":"Order Shipment payload command, Used to create a shipment for an order","properties":{"action_id":{"type":"string","description":"A unique identifier for the order action request. Will be used by the connector to update the order action status. see updateActionStatus"},"carrier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the carrier responsible for the shipment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"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":"UPS"},"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":"DHL Express"},"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":"Amazon Logistics UK"},"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":"FedEx"},"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":"China Post"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]}]}],"example":"DHL Express"},"channel_id":{"type":"string","description":"The channel id"},"channel_order_id":{"type":"string","description":"The order id on the channel"},"channel_store_id":{"type":"string","description":"The store id on the channel"},"items":{"type":"array","description":"List of items included in the shipment, detailing each item being shipped","items":{"$ref":"#/components/schemas/OrderShipmentItemPayload"}},"return_tracking_number":{"type":"string","description":"The return tracking number. This field is only required for marketplaces that expect return tracking information at shipment creation.","example":"1Z999AA1234567891"},"sub_channel_code":{"type":"string","description":"The sub-channel code"},"tracking_number":{"type":"string","description":"The tracking number assigned for this shipment","example":"1Z999AA1234567890"},"tracking_url":{"type":"string","description":"The URL provided for shipment tracking","example":"https://tracking.carrier.com/123456"},"warehouse_id":{"type":"string","description":"Identifier of the warehouse from which the items are shipped. Ignore this field if your channel does not require it.","example":"WH-001"}},"required":["action_id","channel_id","channel_order_id","channel_store_id"],"title":"CREATE_SHIPMENT"}},"components/schemas/OrderShipmentItemPayload":{"id":"components/schemas/OrderShipmentItemPayload","kind":"json-schema","title":"OrderShipmentItemPayload","data":{"description":"Order Shipment Item payload","properties":{"channel_order_line_id":{"type":"string","description":"The order line identified as defined by the channel. ID of the order line to ship.","example":"0002_3202630-A-2"},"id":{"type":"string","description":"Seller product identifier","example":"SELLER_ID_1"},"quantity":{"type":"integer","format":"int32","description":"Product quantity to ship","example":10}},"required":["channel_order_line_id","id","quantity"]}},"components/schemas/Partner":{"id":"components/schemas/Partner","kind":"json-schema","title":"Partner","data":{"properties":{"id":{"type":"string","description":"Id of the fulfillment partner"}},"required":["id"]}},"components/schemas/Price":{"id":"components/schemas/Price","kind":"json-schema","title":"Price","data":{"properties":{"amount":{"type":"number","format":"with decimals"},"currency":{"type":"string"}}}},"components/schemas/PricePayload":{"id":"components/schemas/PricePayload","kind":"json-schema","title":"PricePayload","data":{"description":"Price payload","properties":{"amount":{"type":"number","format":"with decimals","description":"Price amount","example":1234.56},"currency":{"type":"string","description":"Currency ISO code","example":"EUR"}},"required":["amount","currency"]}},"components/schemas/PriceStockUpsertEvent":{"id":"components/schemas/PriceStockUpsertEvent","kind":"json-schema","title":"PriceStockUpsertEvent","data":{"properties":{"data":{"$ref":"#/components/schemas/PriceStockUpsertEventData","description":"Domain-specific business data"},"id":{"type":"string","description":"Unique identifier for the payload in ULID format"},"time":{"type":"string","format":"date-time","description":"Event creation date"},"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 payload which defines the data"},"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":"\"PRICE_STOCK_UPSERT\""},"children":[]}]}]}]}},"required":["data","id","time","type"]}},"components/schemas/PriceStockUpsertEventData":{"id":"components/schemas/PriceStockUpsertEventData","kind":"json-schema","title":"PriceStockUpsertEventData","data":{"properties":{"channel_id":{"type":"string","description":"Identifier of the channel to be notified"},"discount_price":{"$ref":"#/components/schemas/DiscountPriceUpsert","description":"Discount price (store-level)"},"identifiers":{"type":"array","description":"Product identifiers","items":{"$ref":"#/components/schemas/ProductIdentifierDTO"}},"inventory":{"$ref":"#/components/schemas/InventoryUpsert","description":"Aggregated stock, kept for backward compatibility"},"offer_attributes":{"type":"array","description":"Offer attributes","items":{"$ref":"#/components/schemas/ProductOfferAttribute"}},"product_id":{"type":"string","description":"Reference of the product"},"standard_price":{"$ref":"#/components/schemas/StandardPriceUpsert","description":"Standard price (store-level)"},"stock":{"$ref":"#/components/schemas/StockUpsert","description":"Stock breakdown per warehouse and per logistic partner"},"store_id":{"type":"string","description":"Store id of the marketplace to be notified"},"sub_channel":{"$ref":"#/components/schemas/SubChannelData","description":"Sub-channel"}},"required":["channel_id","inventory","offer_attributes","product_id","stock","store_id"]}},"components/schemas/ProductIdentifierDTO":{"id":"components/schemas/ProductIdentifierDTO","kind":"json-schema","title":"ProductIdentifierDTO","data":{"properties":{"type":{"type":"string","description":"Product identifier type","example":"GTIN"},"value":{"type":"string","description":"Product identifier value","example":"12345678"}},"required":["type","value"]}},"components/schemas/ProductOfferAttribute":{"id":"components/schemas/ProductOfferAttribute","kind":"json-schema","title":"ProductOfferAttribute","data":{"discriminator":{"mapping":{"BOOLEAN":"#/components/schemas/ProductOfferBooleanAttribute","LIST":"#/components/schemas/ProductOfferListAttribute","NUMERIC":"#/components/schemas/ProductOfferNumericAttribute","TEXT":"#/components/schemas/ProductOfferTextAttribute"},"propertyName":"type"},"properties":{"id":{"type":"string","description":"Id of the attribute"},"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 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":"\"BOOLEAN\""},"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":"\"NUMERIC\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TEXT\""},"children":[]}]}]}]}},"required":["id","type"]}},"components/schemas/ProductOfferBooleanAttribute":{"id":"components/schemas/ProductOfferBooleanAttribute","kind":"json-schema","title":"ProductOfferBooleanAttribute","data":{"allOf":[{"$ref":"#/components/schemas/ProductOfferAttribute"},{"type":"object","properties":{"value":{"type":"boolean","description":"Boolean value of the attribute"}}}],"required":["id","type"]}},"components/schemas/ProductOfferListAttribute":{"id":"components/schemas/ProductOfferListAttribute","kind":"json-schema","title":"ProductOfferListAttribute","data":{"allOf":[{"$ref":"#/components/schemas/ProductOfferAttribute"},{"type":"object","properties":{"values":{"type":"array","description":"List of values for the attribute","items":{"$ref":"#/components/schemas/ListValue"}}}}],"required":["id","type"]}},"components/schemas/ProductOfferNumericAttribute":{"id":"components/schemas/ProductOfferNumericAttribute","kind":"json-schema","title":"ProductOfferNumericAttribute","data":{"allOf":[{"$ref":"#/components/schemas/ProductOfferAttribute"},{"type":"object","properties":{"value":{"type":"number","format":"with decimals","description":"Numeric value of the attribute"}}}],"required":["id","type"]}},"components/schemas/ProductOfferTextAttribute":{"id":"components/schemas/ProductOfferTextAttribute","kind":"json-schema","title":"ProductOfferTextAttribute","data":{"allOf":[{"$ref":"#/components/schemas/ProductOfferAttribute"},{"type":"object","properties":{"value":{"type":"string","description":"Text value of the attribute"}}}],"required":["id","type"]}},"components/schemas/ProductUpsertEvent":{"id":"components/schemas/ProductUpsertEvent","kind":"json-schema","title":"ProductUpsertEvent","data":{"properties":{"data":{"$ref":"#/components/schemas/ProductUpsertEventData","description":"Domain-specific business data"},"id":{"type":"string","description":"Unique identifier for the payload in ULID format"},"sequence":{"type":"integer","format":"int64","description":"Sequence number of the payload, used to order payloads of the same source"},"sequenceSize":{"type":"integer","format":"int64","description":"Total number of payloads of the same source"},"sequenceType":{"type":"string","description":"Type of sequencing applied to this payload (for now it's always PROGRESS)"},"source":{"type":"string","description":"Source of the payload"},"time":{"type":"string","format":"date-time","description":"Event creation date"},"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 payload which defines the data"},"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_UPSERT\""},"children":[]}]}]}]}},"required":["data","id","time","type"]}},"components/schemas/ProductUpsertEventData":{"id":"components/schemas/ProductUpsertEventData","kind":"json-schema","title":"ProductUpsertEventData","data":{"properties":{"attributes":{"type":"array","description":"All the attributes of the product, in the expected format for the channel","items":{"$ref":"#/components/schemas/Attribute"}},"channel_id":{"type":"string","description":"The channel id where to create the product.","example":"12032"},"discount_price":{"$ref":"#/components/schemas/DiscountPriceUpsert","description":"Discount price"},"identifier":{"$ref":"#/components/schemas/ProductIdentifierDTO","deprecated":true,"description":"Deprecated: Use 'identifiers' instead. This field will be removed in a future version."},"identifiers":{"type":"array","description":"Product identifiers","items":{"$ref":"#/components/schemas/ProductIdentifierDTO"}},"inventory":{"$ref":"#/components/schemas/InventoryUpsert","description":"Aggregated stock, kept for backward compatibility"},"offer_attributes":{"type":"array","description":"Offer attributes","items":{"$ref":"#/components/schemas/ProductOfferAttribute"}},"product_id":{"type":"string","description":"The product id in the seller's system. This id is unique for the seller across all his stores."},"product_type_id":{"type":"string","description":"The product type id in the channel's format."},"standard_price":{"$ref":"#/components/schemas/StandardPriceUpsert","description":"Standard price"},"stock":{"$ref":"#/components/schemas/StockUpsert","description":"Stock breakdown per warehouse and per logistic partner"},"store_id":{"type":"string","description":"The store id on this channel.","example":"1234"}},"required":["attributes","channel_id","discount_price","inventory","offer_attributes","product_id","product_type_id","standard_price","stock","store_id"]}},"components/schemas/ReturnAcceptanceCommandEvent":{"id":"components/schemas/ReturnAcceptanceCommandEvent","kind":"json-schema","title":"ACCEPT_RETURN","data":{"description":"Return Acceptance payload command, used to process return acceptance or refusal","properties":{"accepted":{"type":"boolean","description":"Indicates if a return is accepted (true) or refused (false)."},"action_id":{"type":"string","description":"A unique identifier for the order action request. Will be used by the connector to update the order action status. see updateActionStatus"},"channel_id":{"type":"string","description":"The channel id"},"channel_order_id":{"type":"string","description":"The order id on the channel"},"channel_return_id":{"type":"string","description":"The return id on the channel"},"channel_store_id":{"type":"string","description":"The store id on the 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 code for the refusal"},"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":[]}]}]}]},"sub_channel_code":{"type":"string","description":"The sub-channel code"}},"required":["accepted","action_id","channel_id","channel_order_id","channel_return_id","channel_store_id"],"title":"ACCEPT_RETURN"}},"components/schemas/ReturnTrackingInformationUpdateCommandEvent":{"id":"components/schemas/ReturnTrackingInformationUpdateCommandEvent","kind":"json-schema","title":"UPDATE_RETURN_TRACKING_INFORMATION","data":{"description":"Return tracking information update payload command, used to process return tracking information updates","properties":{"action_id":{"type":"string","description":"A unique identifier for the order action request. Will be used by the connector to update the order action status. see updateActionStatus"},"channel_id":{"type":"string","description":"The channel id"},"channel_order_id":{"type":"string","description":"The order id on the channel"},"channel_return_id":{"type":"string","description":"The return id on the channel"},"channel_store_id":{"type":"string","description":"The store id on the channel"},"label_url":{"type":"string","description":"The URL provided by the carrier that allows the customer to download/print the return label","example":"https://gls-group.eu/GROUP/en/parcel-tracking?match=ABP4IVBG"},"rma_id":{"type":"string","description":"RMA ID (Return Merchandise Authorization)","example":"CR117B72FEF5E8391187"},"sub_channel_code":{"type":"string","description":"The sub-channel code"},"tracking":{"$ref":"#/components/schemas/Tracking","description":"Object that contains all the information concerning the return tracking"}},"required":["action_id","channel_id","channel_order_id","channel_return_id","channel_store_id"],"title":"UPDATE_RETURN_TRACKING_INFORMATION"}},"components/schemas/SellerCentralizedStock":{"id":"components/schemas/SellerCentralizedStock","kind":"json-schema","title":"SellerCentralizedStock","data":{"allOf":[{"$ref":"#/components/schemas/StockDetail"},{"type":"object","properties":{"quantity":{"type":"integer","format":"int32","description":"Quantity available for this stock"}}}],"required":["quantity","type"]}},"components/schemas/SellerWarehouseStock":{"id":"components/schemas/SellerWarehouseStock","kind":"json-schema","title":"SellerWarehouseStock","data":{"allOf":[{"$ref":"#/components/schemas/StockDetail"},{"type":"object","properties":{"quantity":{"type":"integer","format":"int32","description":"Quantity available for this stock"},"warehouse":{"$ref":"#/components/schemas/Warehouse"}}}],"required":["quantity","type"]}},"components/schemas/StandardPriceUpsert":{"id":"components/schemas/StandardPriceUpsert","kind":"json-schema","title":"StandardPriceUpsert","data":{"properties":{"action_type":{"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":"\"UPDATE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DELETE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"IGNORE\""},"children":[]}]}]}]},"price":{"$ref":"#/components/schemas/Price"}}}},"components/schemas/StatusFeatureConfigurationPayload":{"id":"components/schemas/StatusFeatureConfigurationPayload","kind":"json-schema","title":"StatusFeatureConfigurationPayload","data":{"description":"Parameterized configuration of the feature","discriminator":{"mapping":{"business-information-sync":"#/components/schemas/EnableStatusFeatureConfigurationPayload","store-linking":"#/components/schemas/LinkStatusFeatureConfigurationPayload"},"propertyName":"feature"},"oneOf":[{"$ref":"#/components/schemas/EnableStatusFeatureConfigurationPayload"},{"$ref":"#/components/schemas/LinkStatusFeatureConfigurationPayload"}],"properties":{"feature":{"type":"string","description":"Name of the feature"}}}},"components/schemas/StockDetail":{"id":"components/schemas/StockDetail","kind":"json-schema","title":"StockDetail","data":{"discriminator":{"mapping":{"FULFILLMENT_PARTNER":"#/components/schemas/FulfillmentPartnerStock","SELLER_CENTRALIZED":"#/components/schemas/SellerCentralizedStock","SELLER_WAREHOUSE":"#/components/schemas/SellerWarehouseStock"},"propertyName":"type"},"properties":{"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 stock"},"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":"\"SELLER_CENTRALIZED\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"SELLER_WAREHOUSE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FULFILLMENT_PARTNER\""},"children":[]}]}]}]}},"required":["type"]}},"components/schemas/StockUpsert":{"id":"components/schemas/StockUpsert","kind":"json-schema","title":"StockUpsert","data":{"properties":{"action_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action to apply on the stock"},"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":"\"UPDATE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DELETE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"IGNORE\""},"children":[]}]}]}]},"breakdown":{"type":"array","description":"Stock breakdown per seller-centralized stock, seller warehouse and logistic partner; null unless actionType is UPDATE","items":{"$ref":"#/components/schemas/StockDetail"}}},"required":["action_type"]}},"components/schemas/StoreFeatureDataStatusFeatureConfigurationPayload":{"id":"components/schemas/StoreFeatureDataStatusFeatureConfigurationPayload","kind":"json-schema","title":"StoreFeatureDataStatusFeatureConfigurationPayload","data":{"properties":{"channel_id":{"type":"string","description":"Identifier of the channel to be notified"},"configuration":{"$ref":"#/components/schemas/StatusFeatureConfigurationPayload","description":"Parameterized configuration of the feature"},"feature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the feature"},"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":"\"business-information-sync\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"store-linking\""},"children":[]}]}]}]},"store_id":{"type":"string","description":"Store id of the marketplace to be notified"},"trigger_date":{"type":"string","format":"date-time","description":"Date of the trigger for the action on the feature"}},"required":["channel_id","configuration","feature","store_id","trigger_date"]}},"components/schemas/StoreManagementFeatureEvent":{"id":"components/schemas/StoreManagementFeatureEvent","kind":"json-schema","title":"StoreManagementFeatureEvent","data":{"examples":[{"data":{"channel_id":"001","configuration":{"status":"enabled"},"feature":"business-information-sync","store_id":"2005","trigger_date":"2024-05-20T10:15:30.500Z"},"id":"01jv299c9wxxfg4b7vvzzq3c3y","time":"2024-05-20T10:15:30.500Z","type":"STORE_FEATURE"},{"data":{"channel_id":"001","configuration":{"status":"linked"},"feature":"store-linking","store_id":"2005","trigger_date":"2024-05-20T10:15:30.500Z"},"id":"01jv299c9wxxfg4b7vvzzq3c3y","time":"2024-05-20T10:15:30.500Z","type":"STORE_FEATURE"}],"properties":{"data":{"$ref":"#/components/schemas/StoreFeatureDataStatusFeatureConfigurationPayload","description":"Domain-specific business data"},"id":{"type":"string","description":"Unique identifier for the payload in ULID format"},"time":{"type":"string","format":"date-time","description":"Event creation date"},"type":{"type":"string","description":"Type of the payload which defines the data"}},"required":["data","id","time","type"]}},"components/schemas/SubChannelData":{"id":"components/schemas/SubChannelData","kind":"json-schema","title":"SubChannelData","data":{"properties":{"code":{"type":"string","description":"Sub-channel code"},"discount_price":{"$ref":"#/components/schemas/DiscountPriceUpsert","description":"Sub-channel discount price"},"standard_price":{"$ref":"#/components/schemas/StandardPriceUpsert","description":"Sub-channel standard price"},"stock":{"$ref":"#/components/schemas/StockUpsert","description":"Sub-channel stock"}},"required":["code","discount_price","standard_price","stock"]}},"components/schemas/SubChannelPrice":{"id":"components/schemas/SubChannelPrice","kind":"json-schema","title":"SubChannelPrice","data":{"deprecated":true,"description":"Deprecated: internal-only type. Not intended for integration and may be removed without notice.","properties":{"code":{"type":"string","description":"Sub-channel code"},"discount_price":{"$ref":"#/components/schemas/DiscountPriceUpsert","description":"Sub-channel discount price"},"standard_price":{"$ref":"#/components/schemas/StandardPriceUpsert","description":"Sub-channel standard price"}},"required":["code","discount_price","standard_price"]}},"components/schemas/TaxPayload":{"id":"components/schemas/TaxPayload","kind":"json-schema","title":"TaxPayload","data":{"description":"Tax payload","properties":{"amount":{"$ref":"#/components/schemas/PricePayload","description":"Canceled tax amount"},"code":{"type":"string","description":"Tax code on the sales channel"}},"required":["amount","code"]}},"components/schemas/Tracking":{"id":"components/schemas/Tracking","kind":"json-schema","title":"Tracking","data":{"properties":{"carrier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the carrier responsible for the return."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"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":"UPS"},"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":"DHL Express"},"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":"Amazon Logistics UK"},"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":"FedEx"},"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":"China Post"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]}]}],"example":"DHL Express"},"tracking_number":{"type":"string","description":"The tracking number assigned by the carrier for this return","example":"781234567890"},"tracking_url":{"type":"string","description":"The URL provided by the carrier for return tracking","example":"https://www.fedex.com/fedextrack/?trknbr=781234567890"}}}},"components/schemas/UploadOrderDocumentEntityEvent":{"id":"components/schemas/UploadOrderDocumentEntityEvent","kind":"json-schema","title":"UploadOrderDocumentEntityEvent","data":{"properties":{"id":{"type":"string","description":"Identifier of the entity to which the order document is linked."},"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 entity to which the order document is linked."},"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"]}},"components/schemas/Warehouse":{"id":"components/schemas/Warehouse","kind":"json-schema","title":"Warehouse","data":{"properties":{"id":{"type":"string","description":"Unique id of the warehouse"}},"required":["id"]}}},"exampleStore":{"paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0":{"value":{"data":{"channel_id":"001","discount_price":{"action_type":"UPDATE","end_date":"2024-06-20T10:15:30.500Z","price":{"amount":24.99,"currency":"EUR"},"start_date":"2024-05-20T10:15:30.500Z"},"identifier":{"type":"GTIN","value":"1234567890123"},"identifiers":[{"type":"GTIN","value":"1234567890123"}],"inventory":{"action_type":"UPDATE","delivery_partner":{"name":"__self__"},"quantity":500},"offer_attributes":[{"id":"label","type":"TEXT","value":"My first SKU"},{"id":"warranty","type":"NUMERIC","value":12},{"id":"color","type":"LIST","values":[{"value":"red"},{"value":"blue"}]}],"product_id":"SKU_123456","standard_price":{"action_type":"UPDATE","price":{"amount":29.99,"currency":"EUR"}},"stock":{"action_type":"UPDATE","breakdown":[{"quantity":300,"type":"SELLER_WAREHOUSE","warehouse":{"id":"WH_PARIS"}},{"quantity":200,"type":"SELLER_WAREHOUSE","warehouse":{"id":"WH_LYON"}}]},"store_id":"2005","use_case":"OFFER_CREATION"},"id":"01jt31mw7wy3x4zs55kawgg1xe","time":"2024-05-20T10:15:30.500Z","type":"OFFER_UPSERT"},"key":"application/json-0","summary":"Offer Creation Example","id":"paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0"},"paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1":{"value":{"data":{"channel_id":"001","discount_price":{"action_type":"IGNORE","end_date":null,"price":null,"start_date":null},"identifier":{"type":"GTIN","value":"1234567890123"},"identifiers":[{"type":"GTIN","value":"1234567890123"}],"inventory":{"action_type":"IGNORE","delivery_partner":null,"quantity":null},"offer_attributes":[{"id":"label","type":"TEXT","value":"My first SKU - Updated"},{"id":"warranty","type":"NUMERIC","value":24},{"id":"color","type":"LIST","values":[{"value":"red"},{"value":"blue"},{"value":"green"}]}],"product_id":"SKU_123456","standard_price":{"action_type":"IGNORE","price":null},"stock":{"action_type":"IGNORE","breakdown":null},"store_id":"2005","use_case":"OFFER_UPDATE"},"id":"01jt31mw7x97v452wfy03ajbsq","time":"2024-06-20T10:15:30.500Z","type":"OFFER_UPSERT"},"key":"application/json-1","summary":"Offer Update Example","id":"paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1"},"paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"data":{"channel_id":"string","discount_price":{"action_type":"UPDATE","end_date":"2023-03-28T09:34:42Z","price":{"amount":0,"currency":"string"},"start_date":"2023-03-28T09:34:42Z"},"identifier":{"type":"GTIN","value":"12345678"},"identifiers":[{"type":"GTIN","value":"12345678"}],"inventory":{"action_type":"UPDATE","delivery_partner":{"name":"string"},"quantity":0},"offer_attributes":[{"id":"string","type":"BOOLEAN"}],"product_id":"string","standard_price":{"action_type":"UPDATE","price":{"amount":0,"currency":"string"}},"stock":{"action_type":"UPDATE","breakdown":[{"type":"SELLER_CENTRALIZED"}]},"store_id":"string","sub_channel_prices":[{"code":"string","discount_price":{"action_type":"UPDATE","end_date":"2023-03-28T09:34:42Z","price":{"amount":0,"currency":"string"},"start_date":"2023-03-28T09:34:42Z"},"standard_price":{"action_type":"UPDATE","price":{"amount":0,"currency":"string"}}}],"use_case":"string"},"id":"string","time":"2023-03-28T09:34:42Z","type":"OFFER_UPSERT"},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/OfferUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-0":{"value":{"data":{"action_id":"refund-action-123","channel_id":"marketplace_channel","channel_order_id":"ORDER-12345","channel_store_id":"main_store","refunds":[{"order_line_id":"0002_3202630-A-1","price":{"amount":15,"currency":"USD"},"product_id":"10000","quantity":1,"reason":"ITEM_NOT_RECEIVED","shipping_price":{"amount":8,"currency":"USD"},"shipping_taxes":[{"amount":{"amount":3,"currency":"USD"},"code":"ShippingTax1"},{"amount":{"amount":4,"currency":"USD"},"code":"ShippingTax2"}],"taxes":[{"amount":{"amount":1,"currency":"USD"},"code":"Tax1"},{"amount":{"amount":2,"currency":"USD"},"code":"Tax2"}]}],"sub_channel_code":"FR"},"id":"01HGXNJ6VTZR5KJBBQT28YZ2PB","time":"2024-05-20T10:15:30.500Z","type":"REFUND"},"key":"application/json-0","summary":"Refund order example","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-0"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-1":{"value":{"data":{"action_id":"cancel-action-123","cancelations":[{"channel_order_line_id":"0002_3202630-A-1","price":{"amount":15,"currency":"USD"},"product_id":"10000","quantity":1,"reason":"CUSTOMER_CANCELATION","shipping_price":{"amount":8,"currency":"USD"},"shipping_taxes":[{"amount":{"amount":3,"currency":"USD"},"code":"ShippingTax1"},{"amount":{"amount":4,"currency":"USD"},"code":"ShippingTax2"}],"taxes":[{"amount":{"amount":1,"currency":"USD"},"code":"Tax1"},{"amount":{"amount":2,"currency":"USD"},"code":"Tax2"}]}],"channel_id":"marketplace_channel","channel_order_id":"ORDER-12345","channel_store_id":"main_store","sub_channel_code":"FR"},"id":"01HGXNJ6VTZR5KJBBQT28YZ2PA","time":"2024-05-20T10:15:30.500Z","type":"CANCEL"},"key":"application/json-1","summary":"Cancel order example","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-1"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-2":{"value":{"data":{"action_id":"accept-action-123","channel_id":"marketplace_channel","channel_order_id":"ORDER-12345","channel_store_id":"main_store","order_lines":[{"accepted":true,"channel_order_line_id":"0002_3202630-A-1"},{"accepted":false,"channel_order_line_id":"0002_3202630-A-2"}],"sub_channel_code":"FR"},"id":"01HGXNJ6VTZR5KJBBQT28YZ2PC","time":"2024-05-20T10:15:30.500Z","type":"ACCEPT"},"key":"application/json-2","summary":"Accept order example","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-2"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-3":{"value":{"data":{"action_id":"shipment-action-123","carrier":"UPS","channel_id":"marketplace_channel","channel_order_id":"ORDER-12345","channel_store_id":"main_store","items":[{"channel_order_line_id":"0024_COMMERCIAL_ID-A-1","id":"SELLER_ID_1","quantity":10}],"sub_channel_code":"FR","tracking_number":"123456","tracking_url":"https://wwwapps.ups.com/WebTracking/track","warehouse_id":"WH-001"},"id":"01HGXNJ6VTZR5KJBBQT28YZ2PD","time":"2024-05-20T10:15:30.500Z","type":"CREATE_SHIPMENT"},"key":"application/json-3","summary":"Create shipment example","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-3"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-4":{"value":{"data":{"accepted":true,"action_id":"return-action-123","channel_id":"marketplace_channel","channel_order_id":"ORDER-12345","channel_return_id":"RETURN-67890","channel_store_id":"main_store","rejection_reason":null,"sub_channel_code":"FR"},"id":"01HGXNJ6VTZR5KJBBQT28YZ2PE","time":"2024-05-20T10:15:30.500Z","type":"ACCEPT_RETURN"},"key":"application/json-4","summary":"Accept return example","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-4"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-5":{"value":{"data":{"accepted":false,"action_id":"return-action-123","channel_id":"marketplace_channel","channel_order_id":"ORDER-12345","channel_return_id":"RETURN-67890","channel_store_id":"main_store","rejection_reason":"NOT_ELIGIBLE_FOR_RETURN","sub_channel_code":"FR"},"id":"01HGXNJ6VTZR5KJBBQT28YZ2PE","time":"2024-05-20T10:15:30.500Z","type":"ACCEPT_RETURN"},"key":"application/json-5","summary":"Refuse return example","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-5"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-6":{"value":{"data":{"action_id":"26e8f69c-5af0-4469-bde5-cf49bc024334","channel_id":"marketplace_channel","channel_order_id":"ORDER-12345","channel_return_id":"RETURN-67890","channel_store_id":"main_store","label_url":"https://shipping.ups.com/returns/labels/d290f1ee-6c54-4b01-90e6-d701748f0851.pdf","rma_id":"CR117B72FEF5E8391187","sub_channel_code":"FR","tracking":{"carrier":"FedEx","tracking_number":"123456","tracking_url":"https://www.fedex.com/fedextrack/?trknbr=123456"}},"id":"01HGXNJ6VTZR5KJBBQT28YZ2PE","time":"2024-05-20T10:15:30.500Z","type":"UPDATE_RETURN_TRACKING_INFORMATION"},"key":"application/json-6","summary":"Update return tracking information example","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-6"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-7":{"value":{"data":{"action_id":"26e8f69c-5af0-4469-bde5-cf49bc024334","channel_id":"marketplace_channel","channel_order_id":"ORDER-12345","channel_return_id":"RETURN-67890","channel_store_id":"main_store","sub_channel_code":"FR"},"id":"01HGXNJ6VTZR5KJBBQT28YZ2PE","time":"2024-05-20T10:15:30.500Z","type":"ACKNOWLEDGE_RETURN_RECEPTION"},"key":"application/json-7","summary":"Acknowledge return reception example","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-7"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-8":{"value":{"data":{"action_id":"26e8f69c-5af0-4469-bde5-cf49bc024334","channel_id":"marketplace_channel","channel_order_id":"ORDER-12345","channel_return_id":"RETURN-67890","channel_store_id":"main_store","sub_channel_code":"FR"},"id":"01HGXNJ6VTZR5KJBBQT28YZ2PE","time":"2024-05-20T10:15:30.500Z","type":"CLOSE_RETURN"},"key":"application/json-8","summary":"Close return example","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-8"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-9":{"value":{"data":{"action_id":"26e8f69c-5af0-4469-bde5-cf49bc024334","channel_id":"marketplace_channel","channel_order_id":"ORDER-12345","channel_store_id":"main_store","document_download_url":"https://storage.googleapis.com/mirakl-connectsm4-test/connect-order/uploadOrderDocument/order/fadce61d899d311be697146b60221ed71fc81ab63af57d4f4f2a8d2de1421966_TEST_UPLOAD_ORDER_DOCUMENT-A/document/4f690afa-6543-4f4b-a89f-81934e65ddd5?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount.com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T181309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f169edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa8496def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dcc1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c20580e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b133447032ea7abedc098d2eb14a7","document_entity_id":"f3eb7305-e629-4087-ae31-6e2d7c199283","document_entity_type":"RETURN","document_name":"汉chinese字_return_label.pdf","document_type":"RETURN_LABEL","sub_channel_code":"FR"},"id":"01HGXNJ6VTZR5KJBBQT28YZ2PE","time":"2024-05-20T10:15:30.500Z","type":"UPLOAD_DOCUMENT"},"key":"application/json-9","summary":"Upload a document on an order example","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-9"},"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"data":"object","id":"string","time":"2023-03-28T09:34:42Z","type":"ACCEPT"},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/OrderActionEvent/post/requestBody/content/application~1json/examples/application~1json-auto"},"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0":{"value":{"data":{"channel_id":"001","discount_price":{"action_type":"IGNORE","end_date":null,"price":null,"start_date":null},"identifiers":[{"type":"GTIN","value":"1234567890123"}],"inventory":{"action_type":"IGNORE","delivery_partner":null,"quantity":null},"product_id":"SKU_123456","standard_price":{"action_type":"UPDATE","price":{"amount":29.99,"currency":"EUR"}},"stock":{"action_type":"IGNORE","breakdown":null},"store_id":"2005"},"id":"01jv299c9w8jcv2d0tpb0tfpg0","time":"2024-05-20T10:15:30.500Z","type":"PRICE_STOCK_UPSERT"},"key":"application/json-0","summary":"Price Only Update Example","id":"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0"},"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1":{"value":{"data":{"channel_id":"001","discount_price":{"action_type":"IGNORE","end_date":null,"price":null,"start_date":null},"identifiers":[{"type":"GTIN","value":"1234567890123"}],"inventory":{"action_type":"UPDATE","delivery_partner":{"name":"__self__"},"quantity":500},"product_id":"SKU_123456","standard_price":{"action_type":"IGNORE","price":null},"stock":{"action_type":"UPDATE","breakdown":[{"quantity":200,"type":"SELLER_WAREHOUSE","warehouse":{"id":"WH_PARIS"}},{"partner":{"id":"AMAZON_FBA"},"quantity":300,"type":"FULFILLMENT_PARTNER"}]},"store_id":"2005"},"id":"01jv299c9wxxfg4b7vvzzq3c3y","time":"2024-05-20T10:15:30.500Z","type":"PRICE_STOCK_UPSERT"},"key":"application/json-1","summary":"Stock Only Update Example","id":"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-1"},"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-2":{"value":{"data":{"channel_id":"001","discount_price":{"action_type":"UPDATE","end_date":"2024-06-20T10:15:30.500Z","price":{"amount":24.99,"currency":"EUR"},"start_date":"2024-05-20T10:15:30.500Z"},"identifiers":[{"type":"GTIN","value":"1234567890123"}],"inventory":{"action_type":"UPDATE","delivery_partner":{"name":"__self__"},"quantity":500},"product_id":"SKU_123456","standard_price":{"action_type":"UPDATE","price":{"amount":29.99,"currency":"EUR"}},"stock":{"action_type":"UPDATE","breakdown":[{"quantity":300,"type":"SELLER_WAREHOUSE","warehouse":{"id":"WH_PARIS"}},{"quantity":200,"type":"SELLER_WAREHOUSE","warehouse":{"id":"WH_LYON"}}]},"store_id":"2005"},"id":"01jv299c9vvxkrjbq1cf58fn1v","time":"2024-05-20T10:15:30.500Z","type":"PRICE_STOCK_UPSERT"},"key":"application/json-2","summary":"Price and Stock Update Example","id":"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-2"},"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-3":{"value":{"data":{"channel_id":"001","inventory":{"action_type":"UPDATE","delivery_partner":{"name":"__self__"},"quantity":500},"product_id":"SKU_123456","standard_price":{"action_type":"UPDATE","price":{"amount":29.99,"currency":"EUR"}},"store_id":"2005","sub_channel":{"code":"FR","discount_price":{"action_type":"IGNORE"},"standard_price":{"action_type":"UPDATE","price":{"amount":34.99,"currency":"EUR"}},"stock":{"action_type":"IGNORE"}}},"id":"01jv299c9vvxkrjbq1cf58fn1v","time":"2024-05-20T10:15:30.500Z","type":"PRICE_STOCK_UPSERT"},"key":"application/json-3","summary":"Price and Stock Update (Sub-channel) Example","id":"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-3"},"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-4":{"value":{"data":{"channel_id":"001","inventory":{"action_type":"IGNORE"},"product_id":"SKU_123456","standard_price":{"action_type":"UPDATE","price":{"amount":29.99,"currency":"EUR"}},"store_id":"2005","sub_channel":{"code":"FR","discount_price":{"action_type":"IGNORE"},"standard_price":{"action_type":"IGNORE"},"stock":{"action_type":"UPDATE","breakdown":[{"quantity":300,"type":"SELLER_WAREHOUSE","warehouse":{"id":"WH1"}},{"quantity":200,"type":"SELLER_WAREHOUSE","warehouse":{"id":"WH2"}}]}}},"id":"01jv299c9vvxkrjbq1cf58fn1v","time":"2024-05-20T10:15:30.500Z","type":"PRICE_STOCK_UPSERT"},"key":"application/json-4","summary":"Stock Update (Sub-channel) Example","id":"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-4"},"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"data":{"channel_id":"string","discount_price":{"action_type":"UPDATE","end_date":"2023-03-28T09:34:42Z","price":{"amount":0,"currency":"string"},"start_date":"2023-03-28T09:34:42Z"},"identifiers":[{"type":"GTIN","value":"12345678"}],"inventory":{"action_type":"UPDATE","delivery_partner":{"name":"string"},"quantity":0},"offer_attributes":[{"id":"string","type":"BOOLEAN"}],"product_id":"string","standard_price":{"action_type":"UPDATE","price":{"amount":0,"currency":"string"}},"stock":{"action_type":"UPDATE","breakdown":[{"type":"SELLER_CENTRALIZED"}]},"store_id":"string","sub_channel":{"code":"string","discount_price":{"action_type":"UPDATE","end_date":"2023-03-28T09:34:42Z","price":{"amount":0,"currency":"string"},"start_date":"2023-03-28T09:34:42Z"},"standard_price":{"action_type":"UPDATE","price":{"amount":0,"currency":"string"}},"stock":{"action_type":"UPDATE","breakdown":[{"type":"SELLER_CENTRALIZED"}]}}},"id":"string","time":"2023-03-28T09:34:42Z","type":"PRICE_STOCK_UPSERT"},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/PriceStockUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"},"paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0":{"value":{"data":{"attributes":[{"id":"product_name","value":"iPhone 14"},{"id":"battery","value":"3279 mAh"},{"id":"display","value":"6.1 inches"},{"id":"storage","value":"128 GB"},{"id":"color","value":"red"}],"channel_id":"001","discount_price":{"action_type":"UPDATE","end_date":"2024-06-20T10:15:30.500Z","price":{"amount":859.99,"currency":"EUR"},"start_date":"2024-05-20T10:15:30.500Z"},"identifier":{"type":"GTIN","value":"1234567890123"},"identifiers":[{"type":"GTIN","value":"1234567890123"}],"inventory":{"action_type":"UPDATE","delivery_partner":{"name":"__self__"},"quantity":500},"offer_attributes":[{"id":"label","type":"TEXT","value":"iPhone 14 - Good Condition"}],"product_id":"SKU_123456","product_type_id":"Cell Phones","standard_price":{"action_type":"UPDATE","price":{"amount":899.99,"currency":"EUR"}},"stock":{"action_type":"UPDATE","breakdown":[{"quantity":500,"type":"SELLER_WAREHOUSE","warehouse":{"id":"WH_PARIS"}}]},"store_id":"2005"},"id":"01jt31mw7wy3x4zs55kawgg1xe","time":"2024-05-20T10:15:30.500Z","type":"PRODUCT_UPSERT"},"key":"application/json-0","summary":"Product Creation Example","id":"paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-0"},"paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"data":{"attributes":[{"id":"string","locale":"string","value":"string"}],"channel_id":"12032","discount_price":{"action_type":"UPDATE","end_date":"2023-03-28T09:34:42Z","price":{"amount":0,"currency":"string"},"start_date":"2023-03-28T09:34:42Z"},"identifier":{"type":"GTIN","value":"12345678"},"identifiers":[{"type":"GTIN","value":"12345678"}],"inventory":{"action_type":"UPDATE","delivery_partner":{"name":"string"},"quantity":0},"offer_attributes":[{"id":"string","type":"BOOLEAN"}],"product_id":"string","product_type_id":"string","standard_price":{"action_type":"UPDATE","price":{"amount":0,"currency":"string"}},"stock":{"action_type":"UPDATE","breakdown":[{"type":"SELLER_CENTRALIZED"}]},"store_id":"1234"},"id":"string","sequence":0,"sequenceSize":0,"sequenceType":"string","source":"string","time":"2023-03-28T09:34:42Z","type":"PRODUCT_UPSERT"},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/ProductUpsertEvent/post/requestBody/content/application~1json/examples/application~1json-auto"},"paths/StoreManagementFeatureEvent/post/requestBody/content/application~1json/examples/application~1json-auto":{"value":{"data":{"channel_id":"string","configuration":{"feature":"string"},"feature":"business-information-sync","store_id":"string","trigger_date":"2023-03-28T09:34:42Z"},"id":"string","time":"2023-03-28T09:34:42Z","type":"string"},"key":"application/json-auto","summary":"Complete example with value types (application/json)","id":"paths/StoreManagementFeatureEvent/post/requestBody/content/application~1json/examples/application~1json-auto"}},"securitySchemeStore":{},"servers":[{"url":"https://your-service.mirakl.net","description":"The URL of your server"}],"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/webhooks/webhook.json?download"},{"url":"/_bundle/content/product/connect-channel-platform/webhooks/webhook.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Mirakl Connect Channel Platform Webhooks","description":"{% partial file=\"/partial-content/product/connect-channel-platform/webhooks/common/openapi-description.md\" /%}"}},"baseSlug":"/content/product/connect-channel-platform/webhooks/webhook","routesMapping":{}}