{ "opencollection": "1.0.0", "info": { "name": "Mirakl Connect Channel Platform APIs Carriers Offers API", "version": "1.0" }, "items": [ { "info": { "name": "Offers", "type": "folder" }, "items": [ { "info": { "name": "OF04 - Get information and statistics about offer imports", "type": "http" }, "http": { "method": "GET", "url": "https://miraklconnect.com/api/channel-platform/api/offers/imports", "params": [ { "name": "shop_id", "value": "", "type": "query", "description": "Shop identifier" }, { "name": "start_date", "value": "", "type": "query", "description": "Start creation date for filtering" }, { "name": "end_date", "value": "", "type": "query", "description": "End creation date for filtering" }, { "name": "status", "value": "", "type": "query", "description": "Offer import status" }, { "name": "mode", "value": "", "type": "query", "description": "Offer import mode" }, { "name": "origins", "value": "", "type": "query", "description": "List of offer import origins for filtering. This parameter can be supplied multiple times (origins=API&origins=FTP...)." } ] }, "docs": "
\n
Call Frequency
\n\n
Recommended usage: Every 5 minutes
\n
Maximum usage: Once per minute
\n
Pagination
\n\n

This resource supports seek pagination (see documentation)

\n\n
Sort fields
\n\nsort field can have the following va" }, { "info": { "name": "OF01 - Import a file to create, update or delete offers", "type": "http" }, "http": { "method": "POST", "url": "https://miraklconnect.com/api/channel-platform/api/offers/imports", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "import_mode", "type": "text", "value": "" }, { "name": "operator_format", "type": "text", "value": "" }, { "name": "shop", "type": "text", "value": "" }, { "name": "with_products", "type": "text", "value": "" } ] } }, "docs": "
Description
\n\nReturns the import identifier to track the status of the import.\n\n
\n
Call Frequency
\n\n
Recommended usage: Every 5 minutes with offers only, every hour with offers and products, for each seller
\n
Maximum usage: Once per minute with offers only, once every 15 minutes with offers and products, for each selle" }, { "info": { "name": "OF02 - Get information and statistics about an offer import", "type": "http" }, "http": { "method": "GET", "url": "https://miraklconnect.com/api/channel-platform/api/offers/imports/:import", "params": [ { "name": "import", "value": "", "type": "path", "description": "Import identifier" } ] }, "docs": "
\n
Call Frequency
\n\n
Recommended usage: After each OF01 call, every 5 minutes
\n
Maximum usage: Once per minute
\n
" }, { "info": { "name": "OF03 - Get the error report file for an offer import", "type": "http" }, "http": { "method": "GET", "url": "https://miraklconnect.com/api/channel-platform/api/offers/imports/:import/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: After each OF02 call, every 5 minutes
\n
Maximum usage: Once per minute
\n
" }, { "info": { "name": "OF22 - Get information about an offer", "type": "http" }, "http": { "method": "GET", "url": "https://miraklconnect.com/api/channel-platform/api/offers/:offer", "params": [ { "name": "offer", "value": "", "type": "path", "description": "Offer identifier" }, { "name": "pricing_channel_code", "value": "", "type": "query", "description": "Filter used to pick prices on a specific channel" }, { "name": "pricing_customer_organization_id", "value": "", "type": "query", "description": "For Customer Pricing users only. Customer identifier code the API will use to return all prices and applicable price for this organization. Ignored if value does not exist." } ] }, "docs": "
\n
Call Frequency
\n\n
Recommended usage: At each offer page display
\n
Maximum usage: At each offer page display
\n
Read More
\n\n