Mirakl Mirakl Connect Channel Platform Webhooks API
The Mirakl Connect Channel Platform Webhooks API from Mirakl — 0 operation(s) for mirakl connect channel platform webhooks.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/mirakl-mirakl-connect-channel-platform-webhooks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
description: '{% partial file="/partial-content/product/connect-channel-platform/webhooks/common/openapi-description.md" /%}'
title: Mirakl Connect Channel Platform Webhooks API
version: ''
servers:
- description: The URL of your server
url: https://your-service.mirakl.net
tags:
- name: Mirakl Connect Channel Platform Webhooks
paths: {}
webhooks:
OfferUpsertEvent:
post:
description: The offer upsert event received by third parties
operationId: OfferUpsertEvent
requestBody:
content:
application/json:
examples:
application/json-0:
summary: Offer Creation Example
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
application/json-1:
summary: Offer Update Example
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
application/json-auto:
summary: Complete example with value types (application/json)
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
schema:
$ref: '#/components/schemas/OfferUpsertEvent'
summary: Give information about a created or updated offer
tags:
- Mirakl Connect Channel Platform Webhooks
OrderActionEvent:
post:
description: Command to perform an action on an order. This event is processed by the channel technology connector
operationId: OrderActionEvent
requestBody:
content:
application/json:
examples:
application/json-0:
summary: Refund order example
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
application/json-1:
summary: Cancel order example
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
application/json-2:
summary: Accept order example
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
application/json-3:
summary: Create shipment example
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
application/json-4:
summary: Accept return example
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
application/json-5:
summary: Refuse return example
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
application/json-6:
summary: Update return tracking information example
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
application/json-7:
summary: Acknowledge return reception example
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
application/json-8:
summary: Close return example
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
application/json-9:
summary: Upload a document on an order example
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
application/json-auto:
summary: Complete example with value types (application/json)
value:
data: object
id: string
time: '2023-03-28T09:34:42Z'
type: ACCEPT
schema:
$ref: '#/components/schemas/OrderActionEvent'
summary: Performs an action on an order
tags:
- Mirakl Connect Channel Platform Webhooks
PriceStockUpsertEvent:
post:
description: The price stock upsert event received by third parties
operationId: PriceStockUpsertEvent
requestBody:
content:
application/json:
examples:
application/json-0:
summary: Price Only Update Example
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
application/json-1:
summary: Stock Only Update Example
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
application/json-2:
summary: Price and Stock Update Example
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
application/json-3:
summary: Price and Stock Update (Sub-channel) Example
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
application/json-4:
summary: Stock Update (Sub-channel) Example
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
application/json-auto:
summary: Complete example with value types (application/json)
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
schema:
$ref: '#/components/schemas/PriceStockUpsertEvent'
summary: Give information about a price stock upsert
tags:
- Mirakl Connect Channel Platform Webhooks
ProductUpsertEvent:
post:
description: The product upsert event received by third parties
operationId: ProductUpsertEvent
requestBody:
content:
application/json:
examples:
application/json-0:
summary: Product Creation Example
value:
data:
attributes:
- code: product_name
id: product_name
value: iPhone 14
- code: battery
id: battery
value: 3279 mAh
- code: display
id: display
value: 6.1 inches
- code: storage
id: storage
value: 128 GB
- code: color
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
application/json-auto:
summary: Complete example with value types (application/json)
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
schema:
$ref: '#/components/schemas/ProductUpsertEvent'
summary: Give information about a created or updated product
tags:
- Mirakl Connect Channel Platform Webhooks
StoreManagementFeatureEvent:
post:
description: The store feature event is sent when a feature configuration is updated
operationId: StoreManagementFeatureEvent
requestBody:
content:
application/json:
examples:
application/json-auto:
summary: Complete example with value types (application/json)
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
schema:
$ref: '#/components/schemas/StoreManagementFeatureEvent'
summary: Manage features for a given store
tags:
- Mirakl Connect Channel Platform Webhooks
components:
schemas:
TaxPayload:
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
UploadOrderDocumentEntityEvent:
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-mirakl-connect-channel-platform-webhooks-api-openapi.yml