Articles in this section

Available Mirakl APIs

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

Business intelligence

Get the business intelligence file from your platform

X

Catalog

Delete products in bulk from your Mirakl Connect catalog

X

List products from your Mirakl Connect catalog

X

Create or update your Mirakl Connect catalog

X

Catalog configuration

Configure catalog capabilities for a channel

X

Channel

Create or update channels

X

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

Incidents

Mark an incident as resolved

X

Invoicing and accounting

List accounting documents

X

List transaction lines

X

Poll the status of an asynchronous transaction log export (TL03)

X

Confirm the payment of accounting documents

X

Export transaction lines JSON file asynchronously

X

Download accounting documents

X

List accounting documents requests

X

List of document request lines

X

Upload accounting documents

X

List accounting documents

X

Download an accounting document

X

List accounting documents requests

X

List of document request lines

X

Download accounting documents

X

Upload accounting documents

X

List accounting documents

X

Download an accounting document

X

List transaction lines

X

Export transaction lines JSON file asynchronously

X

Poll the status of an asynchronous transaction log export (TL03)

X

Messages

Front: Retrieve a thread

X

Operator: Retrieve a thread

X

Front: List all threads

X

Operator: List all threads

X

Reply to a thread

X

Download an attachment

X

Send a message to a seller

X

Create a thread on an order

X

Create a thread with a seller

X

Create a thread on a service

X

Create a thread on a service order

X

Retrieve a thread

X

List all threads

X

Create a thread with the operator

X

Reply to a thread

X

Download an attachment

X

Create a thread on an order

X

Create a thread on a service

X

Create a thread on a service order

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

Update shipment shipping origin

X

Update shipment additional information

X

Create shipments

X

Update shipment shipping origin

X

List shipments

X

Delete shipments

X

List items to ship

X

Update carrier tracking information for shipments

X

Validate shipments as shipped

X

Validate shipments as ready to pick up

X

Update shipment additional information

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

Get offers CSV file

X

Import a file to add offers

X

Get information and statistics about offer imports

X

Get information and statistics about an offer import

X

Get the error report file for an offer import

X

Create, update, or delete offers

X

Import a price file

X

Get information and statistics about an offer pricing import

X

Get the error report for a price import in CSV format

X

Import a stock file

X

Get information and statistics about an offer stock import

X

Get the error report for a stock import in CSV format

X

Import a file to add offers

X

Get information and statistics about offer imports

X

Get information and statistics about an offer import

X

Get the error report file for an offer import

X

List offers of a shop

X

Create, update, or delete offers

X

Get information about an offer

X

Export offers CSV or JSON file asynchronously

X

Poll the status of an asynchronous offer export (OF52)

X

List offers for each given product

X

Import a price file

X

Get information and statistics about an offer pricing import

X

Get the error report for a price import in CSV format

X

Import a stock file

X

Get information and statistics about an offer stock import

X

Get the error report for a stock import in CSV format

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 cancellations 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

Update the custom fields of an order and its order lines

X

Dispute incident

X

Download one or multiple documents attached to one or multiple orders

X

Upload documents to attach to an order

X

Export orders asynchronously

X

Get the status of an asynchronous order export

X

Perform refunds on order lines

X

Adjust order line

X

Update an order

X

Accept an order in waiting acceptance state

X

Refuse an order in waiting acceptance state

X

Consume an order in order pending state

X

Request refund on order

X

Get the evaluation of an order

X

Patch update orders

X

List orders

X

Update order line shipping origin

X

Export orders asynchronously

X

Get the status of an asynchronous order export

X

Accept or refuse order lines

X

Update carrier tracking information for a specific order

X

Validate the shipment of an order

X

Perform refunds on order lines

X

Perform a full cancellation of an order

X

Perform cancellations on order lines

X

Update the custom fields of an order and its order lines

X

Adjust order line

X

Get the evaluation of an order

X

Lists order's documents

X

Download one or multiple documents attached to one or multiple orders

X

Upload documents to attach to an order

X

List all the order taxes available on the platform

X

Delete an order document

X

Update an order

X

List orders

X

Accept an order in waiting acceptance state

X

Refuse an order in waiting acceptance state

X

Consume an order in order pending state

X

Request refund on order

X

Get the evaluation of an order

X

Accept or refuse order lines

X

Cancel order lines

X

Track an asynchronous action request

X

List Mirakl Connect orders

X

Refund order lines

X

Log order action results and errors

X

Update asynchronous action status

X

Update anonymization date for orders

X

Upsert orders

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

Picklists

List picklists

X

List picklists

X

Platform settings

List all carriers

X

List all custom fields

X

List all enabled channels

X

List currency codes and labels

X

List all document types

X

List rating types on your platform

X

List locale codes and labels

X

List offer conditions

X

List reasons

X

List all active shipping zones

X

List all active shipping methods

X

List all logistic classes

X

Health check endpoint

X

List platform configurations

X

List all custom fields

X

List all enabled channels

X

List currency codes and labels

X

List all document types

X

List locale codes and labels

X

List offer conditions

X

List platform configurations

X

List reasons

X

List all active shipping zones

X

List all active shipping methods

X

List all carriers

X

List all logistic classes

X

Health check endpoint

X

Product feedback

Update store catalog items for a given channel

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

Synchronize marketplace categories from the operator information system with Mirakl

X

Get the status of a marketplace categories synchronization

X

Get the error report file for a marketplace categories synchronization

X

Get all marketplace categories from your platform

X

Import a file to add operator's catalog categories to Mirakl

X

Get the status of a catalog categories import

X

Get the error report file for a catalog categories import

X

List catalog categories (parents and children) related to a catalog category

X

Synchronize products from the operator information system with Mirakl

X

Import products to the operator information system

X

Upload product integration and error reports from the operator information system

X

Import operator attributes to Mirakl

X

Send a file to create, update, or delete value lists

X

Export source product data sheet status

X

List catalog categories (parents and children) related to a catalog category

X

Get products for a list of product references

X

Import products to the operator information system

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 ('non-integrated products report')

X

Get the product integration report file for a product import ('added products report')

X

Get the transformed file for a product import ('file in operator format')

X

Get the transformation error report file for a product import ('source file error report')

X

Get the product attribute configuration

X

Get information about operator's value lists

X

Export source product data sheet status

X

Promotions

List promotions

X

Get details of a promotion

X

Get a CSV file listing the promotions associated with offers

X

List promotions

X

Quotes

Create one or multiple quote requests

X

Validate a quote request

X

Invalidate a quote request

X

Get the list of quote requests

X

Add a message to a shop quote request

X

Download documents attached to a quote request or a shop quote request message

X

Create orders from a quote

X

Returns

Patch update returns

X

List returns

X

Accept or refuse a return request

X

Validate returns as received

X

Mark a return as compliant or non-compliant

X

Mark a return as closed

X

Mark a return as canceled

X

Patch update returns

X

List returns

X

Accept or refuse a return request

X

Validate returns as received

X

Mark a return as compliant or non compliant

X

Mark a return as closed

X

Mark a return as canceled

X

Accept or refuse return

X

Mark return as received

X

Mark return as closed

X

List mirakl connect returns

X

Update return tracking information

X

Upsert returns

X

Services

Create a location

X

List locations

X

Delete a location

X

List service models

X

Create a service

X

Update a service

X

Delete a service

X

Create a location

X

List locations

X

Delete a location

X

List service models

X

List services

X

Create a service

X

Update a service

X

Delete a service

X

Shipments

Ship items of a connect order

X

Store

Update business information of a store

X

Create stores and link them to a user

X

Update store

X

Stores

List evaluations of a shop

X

List offers of a shop

X

List all shops

X

Create shops

X

Associate shops with customer groups

X

List shop's documents

X

Upload business documents to associate with a shop

X

Download documents for one or multiple shops

X

Delete a shop document

X

List shop US tax locations

X

Get shop information

X

Update shop information

X

List shop's documents

X

Upload business documents to associate with a shop

X

Download documents for one or multiple shops

X

Delete a shop document

X

Taxonomy

Create or update a product type

X

Users

List shop roles

X

List shop roles

X