Maximum usage:"
},
{
"info": {
"name": "H11 - List Catalog categories (parents and children) related to a Catalog category",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/hierarchies",
"params": [
{
"name": "hierarchy",
"value": "",
"type": "query",
"description": "Catalog category code"
},
{
"name": "max_level",
"value": "",
"type": "query",
"description": "Number of children catalog category levels to retrieve. If not specified, all child catalog categories are retrieved"
}
]
},
"docs": "
\n
Call Frequency
\n\n
Recommended usage: Every hour
\n
Maximum usage: Every hour
\n
"
},
{
"info": {
"name": "P51 - Get information about product import statuses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/products/imports",
"params": [
{
"name": "last_request_date",
"value": "",
"type": "query",
"description": "Return only product imports that have changed since this date"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Product import status. One of
CANCELLED,
WAITING,
RUNNING,
SENT,
COMPLETE,
FAILED"
},
{
"name": "has_transformed_file",
"value": "",
"type": "query",
"description": "If
true returns only product import trackings with transformed file"
},
{
"name": "shop_id",
"value": "",
"type": "query",
"description": "Shop identifier"
}
]
},
"docs": "
Description
\n\nIf the last_request_date param is not set the api returns all product imports.\n\n
\n
Call Frequency
\n\n
Recommended usage: Every 5 minutes
\n
Maximum usage: Once per minute
\n
Read More
\n\n
\n\nReturns the import identifier to track the status of the import\n\n
\n
Call Frequency
\n\n
Recommended usage: Every hour, for each seller
\n
Maximum usage: Every 15 minutes, for each seller
\n
Read More
\n\n
"
},
{
"info": {
"name": "P44 - Get the error report file for a product import (\"Non-integrated products report\")",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/products/imports/:import/error_report",
"params": [
{
"name": "import",
"value": "",
"type": "path",
"description": "Import identifier"
}
]
},
"docs": "
Description
\n\nThis API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).\n\n
\n
Call Frequency
\n\n
Recommended usage: Each time an error report is needed
\n
Maximum usage: Each time an error report is needed
\n
Read More
\n\n
\n\nThis API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).\n\n
\n
Call Frequency
\n\n
Recommended usage: Each time an integration report is needed
\n
Maximum usage: Each time an integration report is needed
\n
"
},
{
"info": {
"name": "P46 - Get the transformed file for a product import (\"File in operator format\")",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/products/imports/:import/transformed_file",
"params": [
{
"name": "import",
"value": "",
"type": "path",
"description": "Import identifier"
}
]
},
"docs": "
Description
\n\nThis API returns a CSV file.\n\n
\n
Call Frequency
\n\n
Recommended usage: Each time a transformed file is available
\n
Maximum usage: Each time a transformed file is available
\n
"
},
{
"info": {
"name": "P47 - Get the transformation error report file for a product import (\"Source file error report\")",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/products/imports/:import/transformation_error_report",
"params": [
{
"name": "import",
"value": "",
"type": "path",
"description": "Import identifier"
}
]
},
"docs": "
Description
\n\nThis API returns a CSV, XLSX or XML file, depending on the file format provided by the seller.\n\n
\n
Call Frequency
\n\n
Recommended usage: Each time an error report is needed
\n
Maximum usage: Each time an error report is needed
\n
"
},
{
"info": {
"name": "PM11 - Get the product attribute configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/products/attributes",
"params": [
{
"name": "hierarchy",
"value": "",
"type": "query",
"description": "Code of the hierarchy (category) for which to retrieve the attributes. If not specified, all attributes are retrieved."
},
{
"name": "max_level",
"value": "",
"type": "query",
"description": "Number of children hierarchy (category) levels to retrieve. If not specified, attributes from all children hierarchies are retrieved."
},
{
"name": "channels",
"value": "",
"type": "query",
"description": "List of channel codes"
},
{
"name": "with_roles",
"value": "",
"type": "query",
"description": "Set to \"
true\" to get only the attributes that have roles."
}
]
},
"docs": "
Description
\n\nRetrieves all attributes for parents and children of the requested hierarchy\n\n
\n
Call Frequency
\n\n
Recommended usage: Every hour
\n
Maximum usage: Every hour
\n
"
},
{
"info": {
"name": "VL11 - Get information about operator's value lists",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/values_lists",
"params": [
{
"name": "code",
"value": "",
"type": "query",
"description": "The operator's values list code. If not specified, all values lists are retrieved"
}
]
},
"docs": "
\n
Call Frequency
\n\n
Recommended usage: Every hour
\n
Maximum usage: Every hour
\n
"
},
{
"info": {
"name": "P31 - Get products for a list of product references",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/products",
"params": [
{
"name": "product_references",
"value": "",
"type": "query",
"description": "List of the product's identifiers with type, _(structure: \"`product_references=
|,|, ...`\")_\nwhere accepted `` are operator’s product references, like `EAN` or `UPC` for example.\n\nNote that `SHOP_SKU` or `SKU` are invalid `` for this API.\n"
},
{
"name": "products",
"value": "",
"type": "query",
"description": "List of the product's identifiers with type, _(structure: \"`products=|,|, ...`\")_\nwhere accepted `` are operator’s product references, like `EAN` or `UPC` for example.\n\nNote that `SHOP_SKU` or `SKU` are invalid `` for this API.\n"
}
]
},
"docs": "Description
\n\nNote: this resource returns 100 products maximum
Results are sorted by product sku asc, then by product identifier type asc and then by product identifier asc\n\n\n
Call Frequency
\n\n
Recommended usage: At each product page display
\n
Maximum usage: At each product page display
\n