Skip to content
Connectors
/
/
/Setup

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

SetupCheckConsistency - Check initialized data

Request

Description: Verifies whether the data initialized during the application's installation is still up to date. It compares the currently used data with the initial or expected version and returns an update status indicator. This ensures data consistency and helps detect potential refresh needs.

Call Frequency
Recommended usage:
- When you need to check initialized data

curl -i -X GET \
  https://operator-shpy.mirakl.net/api/setup/check-consistency

Responses

OK

Bodyapplication/json
checkedElementsArray of objects

List of checked components

Response
application/json
{
  "checkedElements": [
    { … },
    { … }
  ]
}

SetupCheckPermissions - Check Shopify permissions

Request

Verify Shopify App has all the required permissions granted.

Call Frequency
Recommended usage:
- When you need to check Shopify permissions

curl -i -X GET \
  https://operator-shpy.mirakl.net/api/setup/check-permissions

Responses

OK

Bodyapplication/json
missingPermissionsArray of strings

List of missing permissions

Response
application/json
{
  "missingPermissions": [
    "read_products",
    "write_products",
    "read_customers"
  ]
}

SetupUpdate - Update initialized data

Request

Updates all the data that was initialized during the application's installation. It ensures that the latest versions of the required data are applied, maintaining consistency and preventing outdated information from affecting the system's functionality.

Call Frequency
Recommended usage:
- When you need to update initialized data

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/setup/update

Responses

OK

Bodyapplication/json
updatedElementsArray of objects

List of updated components

Response
application/json
{
  "updatedElements": [
    { … },
    { … }
  ]
}

Synchronization

Operations