v2-reportOrderActions - Log order action results and errors
Changed onUse this API to report to Connect the results of actions performed on orders in your system, such as synchronizing back orders. This enables enhanced error tracking while providing a centralized view of all order actions and errors within the Connect interface.
We recommend integrating this API when developing a connector, such as for a CMS, to ensure comprehensive tracking of order actions and errors. This integration is optional if you process orders directly via the Connect API without using a connector.
<div class="api-description-extension"> <div class="extension-title">Call Frequency</div> <div class="recommended-call-frequency">Recommended usage: Every 5 minutes</div> <div class="max-call-frequency">Maximum usage: Once per minute</div> </div>Request
- Base URLhttps://miraklconnect.com/api
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"actions": [
{
"executed_at": "2025-06-30T16:46:00Z"
}
]
}Response
Action successfully created
Example response
{
"actions": [
{
"action_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4"
}
]
}Changes
- breaking
request property
//was restricted to a list of enum values - breaking
request property
////was restricted to a list of enum values - breaking
request property
//was restricted to a list of enum values - breaking
request property
//was restricted to a list of enum values - info
added the new
ACTION_NOT_SUPPORTEDenum value to the request property//// - info
added the new
DATA_NOT_FOUNDenum value to the request property//// - info
added the new
FAILEDenum value to the request property// - info
added the new
INVALID_INPUTenum value to the request property//// - info
added the new
INVALID_PRODUCT_IDenum value to the request property//// - info
added the new
ORDERenum value to the request property// - info
added the new
ORDER_IN_WRONG_STATEenum value to the request property//// - info
added the new
OTHERenum value to the request property//// - info
added the new
OUT_OF_STOCKenum value to the request property//// - info
added the new
RETURN_IN_WRONG_STATEenum value to the request property//// - info
added the new
SUCCESSenum value to the request property// - info
added the new
SYNCHRONIZE_ORDERenum value to the request property// - info
added the new
SYNCHRONIZE_ORDER_UPDATEenum value to the request property// - info
added the new
TOO_MANY_REQUESTenum value to the request property//// - info
added the new
UNAVAILABLEenum value to the request property//// - info
added the new
UNEXPECTEDenum value to the request property////
- breaking