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 Front API integration access tokens documentation page for more information.

Languages
Servers
Shopify production endpoint.

https://operator-shpy.mirakl.net/

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

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": [ {}, {} ] }

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

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": [ {}, {} ] }
Operations