Available Mirakl APIs

Naga Sri Hari Gonaboyina

Updated November 21, 2024 18:07

When you configure an export, import, or other type of flow step using the prebuilt Mirakl connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Mirakl API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Checkout and shipping	List shipping charges of each offer grouped by orders	X
	List all active shipping methods	X
	List all carriers	X
Customers	Create or update customer groups		X
	Create or update customer organizations		X
	Associate customer organizations with customer groups		X
	Create or update customers		X
Invoicing and accounting	List accounting documents	X
	List transaction lines	X
	Poll the status of an asynchronous transaction log export	X
	Confirm the payment of accounting documents		X
	Export transaction lines JSON file asynchronously		X
Multiple shipments	List shipments	X
	List items to ship	X
	Create shipments		X
	Delete shipments in shipping status		X
	Update carrier tracking information for shipments		X
	Validate shipments as shipped		X
	Validate shipments as received		X
	Validate shipments as ready to pick up		X
	Validate the receipt of shipments in an operator store		X
Offers	Get information about an offer	X
	Poll the status of an asynchronous offer export	X
	List offers for each given product	X
	Export offers CSV or JSON file asynchronously		X
Orders	List orders	X
	Get the evaluation of an order	X
	Lists order's documents	X
	List all the order taxes available on the platform	X
	Create an order		X
	Patch update orders		X
	Validate a commercial order		X
	Invalidate a commercial order		X
	Update order line shipping origin		X
	Accept or refuse order lines		X
	Update carrier tracking information for a specific order		X
	Validate the shipment of an order		X
	Validate the receipt of an order		X
	Validate the receipt of an order in an operator's store		X
	Cancel an order not yet debited from the customer		X
	Request cancelations on order lines		X
	Post an evaluation on an order		X
	Post an incident on an order line		X
	Close an incident on an order line		X
	Delete an order document		X
Payment	List pending order debits	X
	List pending order refunds	X
	Validate or invalidate the payment of an order		X
	Validate or invalidate the refund of order lines		X
Products	Export all products	X
	Get the status of a product synchronization	X
	Get the error report file for a product synchronization	X
	Get products for a list of product references	X
	Get information about product import statuses	X
	Get the import status for a product import	X
	Get the error report file for a product import	X
	Get the product integration report file for a product import	X
	Get the transformed file for a product import	X
	Get the transformation error report file for a product import	X
	Get information about an operator attributes import	X
	Get the error report file for an operator attributes import	X
	Get the product attribute configuration	X
	Get information about a value lists import	X
	Get the error report file for a value lists import	X
	Get information about operator's value lists	X