Mirakl

Mirakl Setup API

The Setup API from Mirakl — 3 operation(s) for setup.

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/setup/check-consistency Check whether installed app data is current · SetupCheckConsistency - Check initialized data #
Ask an LLM
“Is the data set up when I installed the app still up to date?”
“How can I tell if my Mirakl app's initialized data needs refreshing?”
Tell an agent
Check the consistency of the app's initialized data.
Tell me if the setup data is outdated.
GET /api/setup/check-permissions Check the Shopify app permissions · SetupCheckPermissions - Check Shopify permissions #
Ask an LLM
“Does the Shopify app have all the permissions it needs?”
“Which Shopify permissions is the Mirakl app missing?”
Tell an agent
Check the Shopify app permissions.
Verify every required Shopify scope is granted.
POST /api/setup/update Refresh the app's initialized data · SetupUpdate - Update initialized data #
Ask an LLM
“How do I update the data created during the app installation?”
“Can I apply the latest versions of the setup data?”
Tell an agent
Update the initialized setup data.
Apply the latest setup data versions now.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-setup-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mirakl:mirakl-setup-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mirakl-setup-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: '{% partial file="/partial-content/connector/operator/shopify/app-operator-shopify/rest/public/openapi-description.md" /%}'
  title: Shopify Operator Connector Setup API
  version: ''
servers:
- description: Shopify production endpoint.
  url: https://operator-shpy.mirakl.net
tags:
- name: Setup
paths:
  /api/setup/check-consistency:
    get:
      description: 'Description


        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'
      operationId: SetupCheckConsistency
      parameters: []
      responses:
        '200':
          content:
            application/json:
              examples:
                application/json-0:
                  summary: Example with business values (application/json)
                  value:
                    checkedElements:
                    - code: METAOBJECT_DEFINITION
                      name: Metaobject Definition
                      status:
                      - key: OFFER_CONDITION
                        message: null
                        status: INITIALIZED
                    - code: METAFIELD_DEFINITION
                      name: Metafield Definition
                      status:
                      - key: COLLECTION.mirakl.shop_data
                        message: null
                        status: INITIALIZED
                      - key: COLLECTION.mirakl.shop_banner
                        message: null
                        status: MISSING
                      - key: COLLECTION.mirakl.shop_logo
                        message: null
                        status: MISSING
                application/json-auto:
                  summary: Complete example with value types (application/json)
                  value:
                    checkedElements:
                    - code: string
                      name: string
                      status:
                      - key: string
                        message: string
                        status: INITIALIZED
              schema:
                type: object
                $ref: '#/components/schemas/SetupCheckConsistency_Response_200'
          description: OK
      summary: SetupCheckConsistency - Check initialized data
      tags:
      - Setup
  /api/setup/check-permissions:
    get:
      description: 'Description


        Verify Shopify App has all the required permissions granted.


        Call Frequency


        Recommended usage:

        - When you need to check Shopify permissions'
      operationId: SetupCheckPermissions
      parameters: []
      responses:
        '200':
          content:
            application/json:
              examples:
                application/json-0:
                  summary: Example with business values (application/json)
                  value:
                    missingPermissions:
                    - read_products
                    - write_products
                    - read_customers
                application/json-auto:
                  summary: Complete example with value types (application/json)
                  value:
                    missingPermissions:
                    - string
              schema:
                type: object
                $ref: '#/components/schemas/SetupCheckPermissions_Response_200'
          description: OK
      summary: SetupCheckPermissions - Check Shopify permissions
      tags:
      - Setup
  /api/setup/update:
    post:
      description: '> ⚠️ **Content-length header**

        >

        > The Content-Length header must be present with value 0, even when there is no request body.


        Description


        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'
      operationId: SetupUpdate
      parameters: []
      responses:
        '200':
          content:
            application/json:
              examples:
                application/json-0:
                  summary: Example with business values (application/json)
                  value:
                    updatedElements:
                    - code: METAOBJECT_DEFINITION
                      name: Metaobject Definition
                      status:
                      - key: OFFER_CONDITION
                        message: null
                        status: UP_TO_DATE
                    - code: METAFIELD_DEFINITION
                      name: Metafield Definition
                      status:
                      - key: COLLECTION.mirakl.shop_data
                        message: null
                        status: SKIPPED
                      - key: COLLECTION.mirakl.shop_banner
                        message: null
                        status: CREATED
                      - key: COLLECTION.mirakl.shop_logo
                        message: Error updating metaobject definition "Offer condition" / [LIMIT_EXCEEDED] The maximum limit of definitions per owner type has exceeded.
                        status: ERROR
                application/json-auto:
                  summary: Complete example with value types (application/json)
                  value:
                    updatedElements:
                    - code: string
                      name: string
                      status:
                      - key: string
                        message: string
                        status: CREATED
              schema:
                type: object
                $ref: '#/components/schemas/SetupUpdate_Response_200'
          description: OK
      summary: SetupUpdate - Update initialized data
      tags:
      - Setup
components:
  schemas:
    SetupUpdate_Response_200_UpdatedElements:
      type: object
      description: Component updated
      properties:
        code:
          type: string
          description: Code of the component
        name:
          type: string
          description: Name of the component
        status:
          type: array
          description: Status for each element
          items:
            $ref: '#/components/schemas/SetupUpdate_Response_200_UpdatedElements_Status'
    SetupUpdate_Response_200_UpdatedElements_Status:
      type: object
      description: Element updated
      properties:
        key:
          type: string
          description: Key of the element
        message:
          type: string
          description: A message related to the status
        status:
          type: string
          description: 'Status of the element


            Enum: `"CREATED"`, `"UPDATED"`, `"UP_TO_DATE"`, `"SKIPPED"`, `"ERROR"`

            '
    SetupCheckConsistency_Response_200_CheckedElements_Status:
      type: object
      description: Element checked
      properties:
        key:
          type: string
          description: Key of the element
        message:
          type: string
          description: A message related to the status
        status:
          type: string
          description: 'Status of the element


            Enum: `"INITIALIZED"`, `"MISSING"`, `"UPDATE_REQUIRED"`, `"ERROR"`

            '
    SetupCheckPermissions_Response_200:
      type: object
      description: Check permissions response
      properties:
        missingPermissions:
          type: array
          description: List of missing permissions
          items:
            type: string
    SetupCheckConsistency_Response_200_CheckedElements:
      type: object
      description: Component checked
      properties:
        code:
          type: string
          description: Code of the component
        name:
          type: string
          description: Name of the component
        status:
          type: array
          description: Status for each element
          items:
            $ref: '#/components/schemas/SetupCheckConsistency_Response_200_CheckedElements_Status'
    SetupUpdate_Response_200:
      type: object
      description: Updated setup data response
      properties:
        updatedElements:
          type: array
          description: List of updated components
          items:
            $ref: '#/components/schemas/SetupUpdate_Response_200_UpdatedElements'
    SetupCheckConsistency_Response_200:
      type: object
      description: Checked setup data response
      properties:
        checkedElements:
          type: array
          description: List of checked components
          items:
            $ref: '#/components/schemas/SetupCheckConsistency_Response_200_CheckedElements'
  securitySchemes:
    Bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http
x-group-parameters: true