Skip to content

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

GetConnection - Get the information of the connection between a Shopify store an a Mirakl instance

Request

Call Frequency
curl -i -X GET \
  https://operator-shpy.mirakl.net/api/environment

Responses

OK

Bodyapplication/json
createdAtstring(date-time)

The creation date of the environment

enabledboolean

Enabled status of the environment

idstring

Unique identifier for the environment

miraklApiEndpointstring

Mirakl API endpoint

miraklTenantstring

The Mirakl tenant identifier

shopifyShopDomainstring

The domain of the Shopify shop

updatedAtstring(date-time)

The last update date of the environment

Response
application/json
{ "createdAt": "2024-08-22T16:38:23.691537Z", "enabled": true, "id": "720817da-16b4-41cb-8321-b490063ce844", "miraklApiEndpoint": "https://tenant-test.mirakl.net/api", "miraklTenant": "shopify-op-test", "shopifyShopDomain": "mirakl-connector-test.myshopify.com", "updatedAt": "2024-09-20T12:00:00.691539Z" }

HardDeleteConnectionDev - Hard delete environment for dev/test only

Request

curl -i -X DELETE \
  https://operator-shpy.mirakl.net/api/environment-dev

Responses

OK

Checkout

Operations

Synchronization Errors

Operations

Public

Operations

Settings

Operations

Setup

Operations

Synchronization

Operations