Skip to content
Connectors
/
/
/Synchronization

Shopify Operator Connector APIs

General Notes

Authentication with OAuth 2.0

You must authenticate with a bearer token that can be generated from your Mirakl Platform back office. Refer to Generating API integration access tokens documentation page for more information.

Rate limits

Mirakl APIs are protected by rate limits. Each API has a dedicated section displaying its rate limit.

If you make too many calls, you might receive an HTTP 429 "Too Many Requests" error. The response will contain a Retry-After header that specifies the number of seconds to wait before making a new request.

Languages
Servers
Shopify production endpoint.
https://operator-shpy.mirakl.net

Storefront

Operations

Connection

Operations

Checkout

Operations

Synchronization Errors

Operations

Public

Operations

Settings

Operations

Setup

Operations

Synchronization

Operations

SyncCatalogStructure - Synchronize your Shopify catalog structure to Mirakl

Request

Synchronize categories and attributes from Shopify to Mirakl. This operation is asynchronous.

Call Frequency
Recommended usage:
- When you are required to synchronize your taxonomy
Maximum usage:
- You can run only one taxonomy synchronization at a time

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/sync/taxonomy

Responses

A taxonomy synchronization task has been created.

SyncDeletedMiraklProducts - Synchronize deleted products from Mirakl to Shopify

Request

Deletes third-party (3P) products from Shopify that have been deleted in Mirakl. This operation also cleans up the middleware by deleting the corresponding product bindings for both third-party (3P) and first-party (1P) products. The operation is asynchronous and scheduled to run periodically, so manual triggering is typically not required.

Call Frequency
Recommended usage:
- Only when you need to trigger the synchronization manually.
Maximum usage:
- You can run only one Mirakl deleted products synchronization at a time

Bodyapplication/json
deletedSincestring(date-time)

Sync Mirakl deleted products to Shopify since this date

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/sync/deleted-mirakl-products \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

A deleted Mirakl products synchronization to Shopify has successfully been scheduled.

SyncFirstPartyProducts - Synchronize first-party products from Shopify to Mirakl

Request

Synchronize products from Shopify to Mirakl. This operation is asynchronous.

Call Frequency
Recommended usage:
- When you are required to manually run the synchronization
Maximum usage:
- You can run only one synchronization at a time

Bodyapplication/json
sinceDatestring(date-time)

Timestamp of the last product synchronization

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/sync/product-shopify-to-mirakl \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

A product synchronization from Shopify to Mirak has successfully been scheduled.

SyncOfferConditions - Synchronize offer conditions from Mirakl to Shopify

Request

Synchronizes offer conditions from Mirakl to Shopify.

Call Frequency
Recommended usage:
- When you need to synchronize offer conditions

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/sync/offer-conditions

Responses

Synchronization completed successfully

SyncOffers - Sync Offers

Request

Import offers from Mirakl into Shopify. This operation is asynchronous and is scheduled to run periodically, so in most cases, you don't need to trigger it manually.

Call Frequency
Recommended usage:
- Only when you need to trigger the import manually.
Maximum usage:
- You can run only one offer synchronization at a time

Bodyapplication/json
sinceDatestring(date-time)

Timestamp of the last offer import into Shopify

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/sync/offers \
  -H 'Content-Type: application/json' \
  -d '{
    "sinceDate": null
  }'

Responses

An offer synchronization task has been created.

SyncOrders - Synchronize orders between Mirakl and Shopify

Request

Synchronize orders between Mirakl and Shopify. This operation is asynchronous.

Call Frequency
Recommended usage:
- When you are required to synchronize your orders
Maximum usage:
- You can run only one order synchronization at a time

Bodyapplication/json
sinceDatestring(date-time)

Timestamp of the last order synchronization

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/sync/orders \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

An order synchronization task has been created.

SyncShipments - Synchronize shipments from Mirakl to Shopify

Request

Synchronize shipments from Mirakl to Shopify. This operation is asynchronous.

Call Frequency
Recommended usage:
- When you are required to synchronize your shipments
Maximum usage:
- You can run only one shipment synchronization at a time

Bodyapplication/json
sinceDatestring(date-time)

Timestamp of the last shipment synchronization

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/sync/shipment-mirakl-to-shopify \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

An order synchronization task has been created.

SyncShops - Synchronize shops from Mirakl to Shopify

Request

Synchronizes shops from Mirakl to Shopify. This operation is asynchronous.

Call Frequency
Recommended usage:
- When you want to synchronizes shops on demand
Maximum usage:
- You can run only one shop synchronization at a time

Bodyapplication/json
sinceDatestring(date-time)

Date threshold: only syncs shops modified after this date

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/sync/shops \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

A shop synchronization has successfully been scheduled.

SyncThirdPartyProducts - Synchronize third-party products from Mirakl to Shopify

Request

Import products from Mirakl into Shopify. This operation is asynchronous and is scheduled to run periodically, so in most cases, you don't need to trigger it manually.

Call Frequency
Recommended usage:
- Only when you need to trigger the import manually.
Maximum usage:
- You can run only one product synchronization at a time

Bodyapplication/json
sinceDatestring(date-time)

Timestamp of the last product import into Shopify

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/sync/product-mirakl-to-shopify \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

A product synchronization from Mirakl to Shopify has successfully been scheduled.