Recommended usage: Once per day and as many times as there are billing cycle pages returned
Maximum usage: Once per day and as many times as there are billing cycle "
},
{
"info": {
"name": "TL02 - List transaction lines",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/sellerpayment/transactions_logs",
"params": [
{
"name": "seller_billing_cycle_id",
"value": "",
"type": "query",
"description": "Seller billing cycle IDs for filtering. This parameter can be supplied multiple times or be a comma-separated list."
},
{
"name": "date_created_from",
"value": "",
"type": "query",
"description": "Creation date"
},
{
"name": "date_created_to",
"value": "",
"type": "query",
"description": "Creation date"
},
{
"name": "transaction_date_from",
"value": "",
"type": "query",
"description": "Transaction date"
},
{
"name": "transaction_date_to",
"value": "",
"type": "query",
"description": "Transaction date"
},
{
"name": "last_updated_from",
"value": "",
"type": "query",
"description": "Last updated date"
},
{
"name": "payment_state",
"value": "",
"type": "query",
"description": "Payment state. This parameter can be supplied multiple times."
},
{
"name": "transaction_type",
"value": "",
"type": "query",
"description": "Transaction type. This parameter can be supplied multiple times."
},
{
"name": "accounting_document_number",
"value": "",
"type": "query",
"description": "Accounting document number"
},
{
"name": "order_id",
"value": "",
"type": "query",
"description": "Order id. This parameter can be supplied multiple times."
},
{
"name": "order_line_id",
"value": "",
"type": "query",
"description": "Order line id. This parameter can be supplied multiple times."
},
{
"name": "order_reference_for_customer",
"value": "",
"type": "query",
"description": "A comma-separated list of order references for customer."
},
{
"name": "order_reference_for_seller",
"value": "",
"type": "query",
"description": "A comma-separated list of order references for seller."
},
{
"name": "accounting_document_id",
"value": "",
"type": "query",
"description": "Accounting document request id. This parameter filters on documents requests with these entity types:
SHOP_BILLING_CYCLE_PURCHASE_ORDER,
FEES or
ONE_OFF_FEES."
},
{
"name": "shop_model",
"value": "",
"type": "query",
"description": "Shop model. This parameter can be supplied multiple times."
},
{
"name": "pay_out_psp_codes",
"value": "",
"type": "query",
"description": "A comma-separated list of pay-out PSP codes. This parameter requires the Hybrid pay-out PSP feature to be enabled."
},
{
"name": "other_reference",
"value": "",
"type": "query",
"description": "An external reference for one-off transactions that are not tied to a Mirakl order. This parameter can be supplied multiple times."
},
{
"name": "shop_id",
"value": "",
"type": "query",
"description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used."
}
]
},
"docs": "
Description
\n\nThis resource uses seek pagination. The maximum allowed value for parameter
limit is
2000.\n\n
\n
Call Frequency
\n\n
Recommended usage: 20 times per day
\n
Maximum usage: 20 times per min, 60 times per hour
\n
Pagination
\n\n
This resource supports"
},
{
"info": {
"name": "TL03 - Export transaction lines JSON file asynchronously",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://miraklconnect.com/api/channel-platform/api/sellerpayment/transactions_logs/async",
"params": [
{
"name": "shop_id",
"value": "",
"type": "query",
"description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Description
\n\nThe export is asynchronous. Export status can be retrieved by calling TL04.\n\n
\n
Call Frequency
\n\n
Recommended usage:
once per day
\n
Maximum usage:
once per day
\n
"
},
{
"info": {
"name": "TL04 - Poll the status of an asynchronous transaction log export (TL03)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/sellerpayment/transactions_logs/async/status/:tracking_id",
"params": [
{
"name": "tracking_id",
"value": "",
"type": "path",
"description": "The asynchronous transaction log export id"
},
{
"name": "shop_id",
"value": "",
"type": "query",
"description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used."
}
]
},
"docs": "
Description
\n\nRetrieve the status for an TL03 transaction log export.
\nWhen the export is complete, the URLs to retrieve the files are returned.\n\n\n
\n
Call Frequency
\n\n
Recommended usage: Once per minute until you get an error or a success
\n
Maximum usage: Every 10 seconds
\n
"
},
{
"info": {
"name": "TL05 - Retrieve transaction logs files once asynchronous transaction logs export is complete (TL04)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/dynamic-url/The+URL+is+retrieved+from+TL04+output/TL05",
"params": [
{
"name": "tracking_id",
"value": "",
"type": "path",
"description": "The asynchronous transaction log export id"
},
{
"name": "file",
"value": "",
"type": "query",
"description": "The asynchronous transaction log export chunk file"
},
{
"name": "shop_id",
"value": "",
"type": "query",
"description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used."
}
]
},
"docs": "
Description
\n\nRetrieve each chunk of an transaction logs export file via the URL generated once the asynchronous transaction logs export is complete\n\n
\n
"
}
]
}
],
"bundled": true
}