Skip to content
Connectors
/
Platform Operators
/
Shopify
/
APIs
/
Settings

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/

Connection

Operations

Checkout

Operations

Synchronization Errors

Operations

Public

Operations

Settings

Operations

ListSettings - List connector settings

Request

Call Frequency
Recommended usage:
- When you are required to read your environment settings
Read More
curl -i -X GET \
  https://operator-shpy.mirakl.net/api/settings

Responses

OK

Bodyapplication/json
categoriesobject

Configuration for category filtering during taxonomy export

customAppClientSecretstring

Client secret used to verify the signature of JWT tokens send in CustomerUI API call

customCarrierDescriptionstring

Description for the custom carrier

customCarrierTitlestring

Title for the custom carrier

fraudCheckobject

Fraud check

imageAttributesArray of objects

List of image attributes exported when taxonomy is synchronized in Mirakl

jobsobject

The job settings

lastMiraklToShopifyProductSyncstring(date-time)

Timestamp of the last Mirakl to Shopify product synchronization

lastMiraklToShopifyShipmentSyncstring(date-time)

Timestamp of the last Mirakl to Shopify shipment synchronization

lastOfferSyncstring(date-time)

Timestamp of the last offer synchronization

lastOrderSyncstring(date-time)

Timestamp of the last order synchronization

lastShopSyncstring(date-time)

Timestamp of the last shop synchronization

lastShopifyToMiraklProductSyncstring(date-time)

Timestamp of the last Shopify to Mirakl product synchronization

publicationIdsArray of stringsunique

The Shopify publication ids in which the third-party products and collections will be published

shippingZoneMappingobject

Mapping to compute Mirakl shipping zone code from customer address

syncMiraklToShopifyProductWithTagsArray of strings

List of all tags used to mark Mirakl products imported into Shopify.

syncShopifyToMiraklProductWithTagsArray of strings

List of all tags used to synchronize Shopify products to Mirakl. No product are exported if null or empty

taxonomyMetafieldsArray of objects

List of all Shopify Metafields exported when taxonomy is synchronized in Mirakl

Response
application/json
{
  "categories": {
    "excludes": [],
    "includes": []
  },
  "customAppClientSecret": "79●●●●●●●●●●●●●●●●●●●●●●●●●●●●36",
  "customCarrierDescription": "For convenience, your marketplace orders are grouped",
  "customCarrierTitle": "Marketplace orders",
  "fraudCheck": {
    "analysisFactDescription": null,
    "strategy": "NO_CHECK"
  },
  "imageAttributes": [
    { … }
  ],
  "jobs": {
    "SyncFirstPartyProducts": { … },
    "SyncOffers": { … },
    "SyncOrders": { … },
    "SyncShipments": { … },
    "SyncShops": { … },
    "SyncThirdPartyProducts": { … }
  },
  "lastMiraklToShopifyProductSync": "2024-09-20T10:00:00Z",
  "lastMiraklToShopifyShipmentSync": "2025-07-16T15:45:23Z",
  "lastOfferSync": "2024-09-01T10:20:30Z",
  "lastOrderSync": "2024-11-01T10:20:30Z",
  "lastShopSync": "2024-09-01T10:20:30Z",
  "lastShopifyToMiraklProductSync": "2024-09-20T10:00:00Z",
  "publicationIds": [
    "gid://shopify/Publication/220528771398"
  ],
  "shippingZoneMapping": {
    "countries": [ … ],
    "shippingZone": "INT"
  },
  "syncMiraklToShopifyProductWithTags": [
    "from_mirakl"
  ],
  "syncShopifyToMiraklProductWithTags": [
    "mirakl_sync"
  ],
  "taxonomyMetafields": [
    { … }
  ]
}

UpdateSettings - Update connector settings

Request

Update your environment settings information field by field: unspecified fields will not be updated.

Call Frequency
Recommended usage:
- When you are required to update the settings

Bodyapplication/json
categoriesobject

Configuration for category filtering during taxonomy export

customAppClientSecretstring

Client secret used to verify the signature of JWT tokens send in CustomerUI API call

customCarrierDescriptionstring

Description for the custom carrier

customCarrierTitlestring

Title for the custom carrier

fraudCheckobject

Fraud check

imageAttributesArray of objects

List of image attributes exported when taxonomy is synchronized in Mirakl

jobsobject

The job settings

lastMiraklToShopifyProductSyncstring(date-time)

Timestamp of the last Mirakl to Shopify product synchronization

lastMiraklToShopifyShipmentSyncstring(date-time)

Timestamp of the last Mirakl to Shopify shipment synchronization

lastOfferSyncstring(date-time)

Timestamp of the last offer synchronization

lastOrderSyncstring(date-time)

Timestamp of the last order synchronization

lastShopSyncstring(date-time)

Timestamp of the last shop synchronization

lastShopifyToMiraklProductSyncstring(date-time)

Timestamp of the last Shopify to Mirakl product synchronization

publicationIdsArray of stringsunique

The Shopify publication ids in which the third-party products and collections will be published

shippingZoneMappingobject

Mapping to compute Mirakl shipping zone code from customer address

syncMiraklToShopifyProductWithTagsArray of strings

List of all tags used to mark Mirakl products imported into Shopify.

syncShopifyToMiraklProductWithTagsArray of strings

List of all tags used to synchronize Shopify products to Mirakl. No product are exported if null or empty

taxonomyMetafieldsArray of objects

List of all Shopify Metafields exported when taxonomy is synchronized in Mirakl

curl -i -X PATCH \
  https://operator-shpy.mirakl.net/api/settings \
  -H 'Content-Type: application/json' \
  -d '{
    "categories": {
      "excludes": [
        "gid://shopify/TaxonomyCategory/sg-4-17-3"
      ],
      "includes": [
        "gid://shopify/TaxonomyCategory/sg-4-17"
      ]
    },
    "customAppClientSecret": "0123456789abcdef0123456789abcdef0123",
    "customCarrierDescription": "My custom carrier description",
    "customCarrierTitle": "My custom carrier title",
    "fraudCheck": {
      "analysisFactDescription": "validated",
      "strategy": "CUSTOM_ASSESSMENT"
    },
    "imageAttributes": [
      {
        "code": "main_image_1",
        "isMainImage": true,
        "label": "Main Image"
      },
      {
        "code": "swatch",
        "isMainImage": false,
        "label": "Swatch"
      }
    ],
    "jobs": {
      "SyncFirstPartyProducts": {
        "scheduled": false
      },
      "SyncOffers": {
        "scheduled": true
      },
      "SyncOrders": {
        "scheduled": true
      },
      "SyncShipments": {
        "scheduled": true
      },
      "SyncShops": {
        "scheduled": true
      },
      "SyncThirdPartyProducts": {
        "scheduled": true
      }
    },
    "lastMiraklToShopifyProductSync": "2024-09-01T12:00:00Z",
    "lastMiraklToShopifyShipmentSync": "2025-07-16T15:45:23Z",
    "lastOfferSync": "2024-09-01T09:20:30Z",
    "lastOrderSync": "2024-11-01T10:20:30Z",
    "lastShopifyToMiraklProductSync": "2024-09-01T12:00:00Z",
    "publicationIds": [
      "gid://shopify/Publication/220528771398"
    ],
    "shippingZoneMapping": {
      "countries": [
        {
          "iso2Code": "US",
          "provinces": [
            {
              "code": "MA",
              "shippingZone": "MASSACHUSETTS"
            }
          ],
          "shippingZone": "USA",
          "zips": null
        },
        {
          "iso2Code": "FR",
          "provinces": null,
          "shippingZone": "FRANCE",
          "zips": [
            {
              "code": "75",
              "shippingZone": "PARIS"
            }
          ]
        }
      ],
      "shippingZone": "INT"
    },
    "taxonomyMetafields": [
      {
        "key": "materials",
        "namespace": "custom",
        "ownerType": "PRODUCT"
      },
      {
        "key": "boolean",
        "namespace": "test",
        "ownerType": "PRODUCTVARIANT"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
categoriesobject

Configuration for category filtering during taxonomy export

customAppClientSecretstring

Client secret used to verify the signature of JWT tokens send in CustomerUI API call

customCarrierDescriptionstring

Description for the custom carrier

customCarrierTitlestring

Title for the custom carrier

fraudCheckobject

Fraud check

imageAttributesArray of objects

List of image attributes exported when taxonomy is synchronized in Mirakl

jobsobject

The job settings

lastMiraklToShopifyProductSyncstring(date-time)

Timestamp of the last Mirakl to Shopify product synchronization

lastMiraklToShopifyShipmentSyncstring(date-time)

Timestamp of the last Mirakl to Shopify shipment synchronization

lastOfferSyncstring(date-time)

Timestamp of the last offer synchronization

lastOrderSyncstring(date-time)

Timestamp of the last order synchronization

lastShopSyncstring(date-time)

Timestamp of the last shop synchronization

lastShopifyToMiraklProductSyncstring(date-time)

Timestamp of the last Shopify to Mirakl product synchronization

publicationIdsArray of stringsunique

The Shopify publication ids in which the third-party products and collections will be published

shippingZoneMappingobject

Mapping to compute Mirakl shipping zone code from customer address

syncMiraklToShopifyProductWithTagsArray of strings

List of all tags used to mark Mirakl products imported into Shopify.

syncShopifyToMiraklProductWithTagsArray of strings

List of all tags used to synchronize Shopify products to Mirakl. No product are exported if null or empty

taxonomyMetafieldsArray of objects

List of all Shopify Metafields exported when taxonomy is synchronized in Mirakl

Response
application/json
{
  "categories": {
    "excludes": [ … ],
    "includes": [ … ]
  },
  "customAppClientSecret": "01●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●23",
  "customCarrierDescription": "My custom carrier description",
  "customCarrierTitle": "My custom carrier title",
  "fraudCheck": {
    "analysisFactDescription": "validated",
    "strategy": "CUSTOM_ASSESSMENT"
  },
  "imageAttributes": [
    { … },
    { … }
  ],
  "jobs": {
    "SyncFirstPartyProducts": { … },
    "SyncOffers": { … },
    "SyncOrders": { … },
    "SyncShipments": { … },
    "SyncShops": { … },
    "SyncThirdPartyProducts": { … }
  },
  "lastMiraklToShopifyProductSync": "2024-09-01T12:00:00Z",
  "lastMiraklToShopifyShipmentSync": "2025-07-16T15:45:23Z",
  "lastOfferSync": "2024-09-01T09:20:30Z",
  "lastOrderSync": "2024-11-01T10:20:30Z",
  "lastShopSync": "2024-09-01T10:20:30Z",
  "lastShopifyToMiraklProductSync": "2024-09-01T12:00:00Z",
  "publicationIds": [
    "gid://shopify/Publication/220528771398"
  ],
  "shippingZoneMapping": {
    "countries": [ … ],
    "shippingZone": "INT"
  },
  "syncMiraklToShopifyProductWithTags": [
    "from_mirakl"
  ],
  "syncShopifyToMiraklProductWithTags": [
    "mirakl_sync"
  ],
  "taxonomyMetafields": [
    { … },
    { … }
  ]
}

Storefront

Operations

Setup

Operations

Synchronization

Operations