Mirakl Settings API
The Settings API from Mirakl — 1 operation(s) for settings.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/mirakl-settings-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
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 Settings API
version: ''
servers:
- description: Shopify production endpoint.
url: https://operator-shpy.mirakl.net
tags:
- name: Settings
paths:
/api/settings:
get:
description: '<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: <br/>- When you are required to read your environment settings</div>
<div class="extension-title">Read More</div>
<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/integration_guide/shopify_setting.html">More context (shopify middleware setting)</a></li></ul></div>'
operationId: ListSettings
parameters: []
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
additionalLocales: []
categories:
excludes: []
includes: []
customAppClientSecret: 79●●●●●●●●●●●●●●●●●●●●●●●●●●●●36
customCarrierDescription: For convenience, your marketplace orders are grouped
customCarrierTitle: Marketplace orders
fraudCheck:
analysisFactDescription: null
strategy: NO_CHECK
imageAttributes:
- code: image_1
isMainImage: true
label: Main Image
jobs:
SyncFirstPartyProducts:
scheduled: false
SyncOffers:
scheduled: false
SyncOrders:
scheduled: false
SyncPromotions:
scheduled: false
SyncReturns:
scheduled: false
SyncShipments:
scheduled: false
SyncShops:
scheduled: false
SyncThirdPartyProducts:
scheduled: false
lastDeletedMiraklProductSync: '2025-08-01T22:04:00Z'
lastMiraklToShopifyProductSync: '2024-09-20T10:00:00Z'
lastMiraklToShopifyShipmentSync: '2025-07-16T15:45:23Z'
lastOfferSync: '2024-09-01T10:20:30Z'
lastOrderSync: '2024-11-01T10:20:30Z'
lastPromotionSync: '2026-06-19T09:00:00Z'
lastReturnSync: '2025-12-10T14:30:00Z'
lastShopSync: '2024-09-01T10:20:30Z'
lastShopifyToMiraklProductSync: '2024-09-20T10:00:00Z'
miraklMasterMode:
enabled: false
useShopifyCategories: false
miraklPayout:
payinPspId: null
offer:
synchronizeAdditionalFields: false
synchronizeAdvancedPricing: false
synchronizeShippingTypes: false
order:
miraklExportCustomerOrganization:
mode: INACTIVE
orderMetafields:
- miraklCustomFieldCode: mirakl_vat_code
shopifyKey: vat_code
shopifyNamespace: custom
- miraklCustomFieldCode: mirakl_tax_id
shopifyKey: tax_id
shopifyNamespace: billing
payment:
confirmCaptureToMirakl: false
confirmRefundToMirakl: false
create3PCaptureInShopify: false
create3PRefundInShopify: false
miraklPaymentWorkflow: PAY_ON_ACCEPTANCE
pspTransactionReferenceSource: null
useMiraklPayout: false
useTransactionNumberForCaptureFromMetafield: false
useTransactionNumberForRefundFromMetafield: false
product:
skuGenerations:
- attributeCode: barcode
strategy: UNIQUE_IDENTIFIER_BASED
- attributeCode: ean
strategy: UNIQUE_IDENTIFIER_BASED
- prefix: mp-
strategy: MIRAKL_PRODUCT_ID_BASED
publicationIds:
- gid://shopify/Publication/220528771398
rootAttributes:
BARCODE:
code: barcode
CATEGORY:
code: category
DESCRIPTION:
code: description
SHOP_SKU:
code: shop_sku
TITLE:
code: title
VARIANT_GROUP_CODE:
code: variant_group_code
VENDOR:
code: vendor
WEIGHT:
code: weight
shippingZoneMapping:
countries:
- iso2Code: CA
provinces: null
shippingZone: CANADA
zips: null
shippingZone: INT
shop:
shopMiraklCustomFields:
- code: customer-care-phone
- code: shipping-policy
syncMiraklToShopifyProductWithTags:
- from_mirakl
syncShopifyToMiraklProductWithTags:
- mirakl_sync
taxonomyMetafields:
- key: materials
localizable: false
namespace: custom
ownerType: PRODUCT
vendorAsValueList: false
application/json-auto:
summary: Complete example with value types (application/json)
value:
additionalLocales:
- locale: fr
categories:
excludes:
- string
includes:
- string
customAppClientSecret: string
customCarrierDescription: string
customCarrierTitle: string
fraudCheck:
analysisFactDescription: string
strategy: CUSTOM_ASSESSMENT
imageAttributes:
- code: string
isMainImage: true
label: string
jobs: object
lastDeletedMiraklProductSync: '2023-03-28T09:34:42Z'
lastMiraklToShopifyProductSync: '2023-03-28T09:34:42Z'
lastMiraklToShopifyShipmentSync: '2023-03-28T09:34:42Z'
lastOfferSync: '2023-03-28T09:34:42Z'
lastOrderSync: '2023-03-28T09:34:42Z'
lastPromotionSync: '2023-03-28T09:34:42Z'
lastReturnSync: '2023-03-28T09:34:42Z'
lastShopSync: '2023-03-28T09:34:42Z'
lastShopifyToMiraklProductSync: '2023-03-28T09:34:42Z'
miraklMasterMode:
enabled: true
useShopifyCategories: true
miraklPayout:
payinPspId: string
offer:
synchronizeAdditionalFields: true
synchronizeAdvancedPricing: true
synchronizeShippingTypes: true
order:
miraklExportCustomerOrganization:
mode: INACTIVE
orderMetafields:
- miraklCustomFieldCode: string
shopifyKey: string
shopifyNamespace: string
payment:
confirmCaptureToMirakl: true
confirmRefundToMirakl: true
create3PCaptureInShopify: true
create3PRefundInShopify: true
miraklPaymentWorkflow: PAY_ON_ACCEPTANCE
pspTransactionReferenceSource: string
useMiraklPayout: true
useTransactionNumberForCaptureFromMetafield: true
useTransactionNumberForRefundFromMetafield: true
product:
skuGenerations:
- strategy: MIRAKL_PRODUCT_ID_BASED
publicationIds:
- string
rootAttributes: object
shippingZoneMapping:
countries:
- iso2Code: string
provinces:
- code: string
shippingZone: string
shippingZone: string
zips:
- code: string
shippingZone: string
shippingZone: string
shop:
shopMiraklCustomFields:
- code: string
syncMiraklToShopifyProductWithTags:
- string
syncShopifyToMiraklProductWithTags:
- string
taxonomyMetafields:
- key: string
localizable: true
namespace: string
ownerType: string
vendorAsValueList: true
schema:
type: object
$ref: '#/components/schemas/ListSettings_Response_200'
description: OK
summary: ListSettings - List connector settings
tags:
- Settings
patch:
description: '<div class="extension-title">Description</div>
Update your environment settings information field by field: unspecified fields will not be updated.
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: <br/>- When you are required to update the settings</div>
</div>'
operationId: UpdateSettings
parameters: []
requestBody:
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
additionalLocales:
- locale: fr
- locale: it
- locale: zh-CN
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
SyncPromotions:
scheduled: false
SyncShipments:
scheduled: true
SyncShops:
scheduled: true
SyncThirdPartyProducts:
scheduled: true
lastDeletedMiraklProductSync: '2025-08-01T22:04:00Z'
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'
miraklMasterMode:
enabled: true
useShopifyCategories: false
miraklPayout:
payinPspId: PAYIN-EUR
offer:
synchronizeAdditionalFields: true
synchronizeAdvancedPricing: true
synchronizeShippingTypes: true
order:
miraklExportCustomerOrganization:
mode: FULL
orderMetafields:
- miraklCustomFieldCode: mirakl_customer_type
shopifyKey: customer_type
shopifyNamespace: custom
payment:
confirmCaptureToMirakl: true
confirmRefundToMirakl: true
create3PCaptureInShopify: true
create3PRefundInShopify: true
miraklPaymentWorkflow: PAY_ON_SHIPMENT
useMiraklPayout: true
useTransactionNumberForCaptureFromMetafield: true
useTransactionNumberForRefundFromMetafield: true
product:
skuGenerations:
- attributeCode: barcode
strategy: UNIQUE_IDENTIFIER_BASED
- attributeCode: ean
strategy: UNIQUE_IDENTIFIER_BASED
- prefix: mp-
strategy: MIRAKL_PRODUCT_ID_BASED
publicationIds:
- gid://shopify/Publication/220528771398
rootAttributes:
BARCODE:
code: barcode
CATEGORY:
code: category
DESCRIPTION:
code: description
SHOP_SKU:
code: shop_sku
TITLE:
code: title
VARIANT_GROUP_CODE:
code: variant_group_code
VENDOR:
code: vendor
WEIGHT:
code: weight
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
shop:
shopMiraklCustomFields:
- code: customer-care-phone
- code: customer-care-email
- code: shipping-policy
taxonomyMetafields:
- key: materials
localizable: false
namespace: custom
ownerType: PRODUCT
- key: boolean
localizable: false
namespace: test
ownerType: PRODUCTVARIANT
vendorAsValueList: true
application/json-auto:
summary: Complete example with value types (application/json)
value:
additionalLocales:
- locale: fr
categories:
excludes:
- string
includes:
- string
customAppClientSecret: string
customCarrierDescription: string
customCarrierTitle: string
fraudCheck:
analysisFactDescription: string
strategy: CUSTOM_ASSESSMENT
imageAttributes:
- code: string
isMainImage: true
label: string
jobs: object
lastDeletedMiraklProductSync: '2023-03-28T09:34:42Z'
lastMiraklToShopifyProductSync: '2023-03-28T09:34:42Z'
lastMiraklToShopifyShipmentSync: '2023-03-28T09:34:42Z'
lastOfferSync: '2023-03-28T09:34:42Z'
lastOrderSync: '2023-03-28T09:34:42Z'
lastPromotionSync: '2023-03-28T09:34:42Z'
lastReturnSync: '2023-03-28T09:34:42Z'
lastShopSync: '2023-03-28T09:34:42Z'
lastShopifyToMiraklProductSync: '2023-03-28T09:34:42Z'
miraklMasterMode: object
miraklPayout:
payinPspId: string
offer:
synchronizeAdditionalFields: true
synchronizeAdvancedPricing: true
synchronizeShippingTypes: true
order:
miraklExportCustomerOrganization:
mode: INACTIVE
orderMetafields:
- miraklCustomFieldCode: string
shopifyKey: string
shopifyNamespace: string
payment:
confirmCaptureToMirakl: true
confirmRefundToMirakl: true
create3PCaptureInShopify: true
create3PRefundInShopify: true
miraklPaymentWorkflow: PAY_ON_ACCEPTANCE
pspTransactionReferenceSource: string
useMiraklPayout: true
useTransactionNumberForCaptureFromMetafield: true
useTransactionNumberForRefundFromMetafield: true
product:
skuGenerations:
- strategy: MIRAKL_PRODUCT_ID_BASED
publicationIds:
- string
rootAttributes: object
shippingZoneMapping:
countries:
- iso2Code: string
provinces:
- code: string
shippingZone: string
shippingZone: string
zips:
- code: string
shippingZone: string
shippingZone: string
shop:
shopMiraklCustomFields:
- code: string
syncMiraklToShopifyProductWithTags:
- string
syncShopifyToMiraklProductWithTags:
- string
taxonomyMetafields:
- key: string
localizable: true
namespace: string
ownerType: string
vendorAsValueList: true
schema:
$ref: '#/components/schemas/UpdateSettings_Request'
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
additionalLocales:
- locale: it
- locale: fr
- locale: zh-CN
categories:
excludes:
- gid://shopify/TaxonomyCategory/sg-4-17-3
includes:
- gid://shopify/TaxonomyCategory/sg-4-17
customAppClientSecret: 01●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●23
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
SyncPromotions:
scheduled: false
SyncShipments:
scheduled: true
SyncShops:
scheduled: true
SyncThirdPartyProducts:
scheduled: true
lastDeletedMiraklProductSync: '2025-08-01T22:04:00Z'
lastMiraklToShopifyProductSync: '2024-09-01T12:00:00Z'
lastMiraklToShopifyShipmentSync: '2025-07-16T15:45:23Z'
lastOfferSync: '2024-09-01T09:20:30Z'
lastOrderSync: '2024-11-01T10:20:30Z'
lastPromotionSync: '2026-06-19T09:00:00Z'
lastReturnSync: '2025-12-10T14:30:00Z'
lastShopSync: '2024-09-01T10:20:30Z'
lastShopifyToMiraklProductSync: '2024-09-01T12:00:00Z'
miraklMasterMode:
enabled: true
useShopifyCategories: false
miraklPayout:
payinPspId: PAYIN-EUR
offer:
synchronizeAdditionalFields: true
synchronizeAdvancedPricing: true
synchronizeShippingTypes: true
order:
miraklExportCustomerOrganization:
mode: FULL
orderMetafields:
- miraklCustomFieldCode: mirakl_customer_type
shopifyKey: customer_type
shopifyNamespace: custom
payment:
confirmCaptureToMirakl: true
confirmRefundToMirakl: true
create3PCaptureInShopify: true
create3PRefundInShopify: true
miraklPaymentWorkflow: PAY_ON_SHIPMENT
pspTransactionReferenceSource: null
useMiraklPayout: true
useTransactionNumberForCaptureFromMetafield: true
useTransactionNumberForRefundFromMetafield: true
product:
skuGenerations:
- attributeCode: barcode
strategy: UNIQUE_IDENTIFIER_BASED
- attributeCode: ean
strategy: UNIQUE_IDENTIFIER_BASED
- prefix: mp-
strategy: MIRAKL_PRODUCT_ID_BASED
publicationIds:
- gid://shopify/Publication/220528771398
rootAttributes:
BARCODE:
code: barcode
CATEGORY:
code: category
DESCRIPTION:
code: description
SHOP_SKU:
code: shop_sku
TITLE:
code: title
VARIANT_GROUP_CODE:
code: variant_group_code
VENDOR:
code: vendor
WEIGHT:
code: weight
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
shop:
shopMiraklCustomFields:
- code: customer-care-phone
- code: customer-care-email
- code: shipping-policy
syncMiraklToShopifyProductWithTags:
- from_mirakl
syncShopifyToMiraklProductWithTags:
- mirakl_sync
taxonomyMetafields:
- key: materials
localizable: false
namespace: custom
ownerType: PRODUCT
- key: boolean
localizable: false
namespace: test
ownerType: PRODUCTVARIANT
vendorAsValueList: true
application/json-auto:
summary: Complete example with value types (application/json)
value:
additionalLocales:
- locale: fr
categories:
excludes:
- string
includes:
- string
customAppClientSecret: string
customCarrierDescription: string
customCarrierTitle: string
fraudCheck:
analysisFactDescription: string
strategy: CUSTOM_ASSESSMENT
imageAttributes:
- code: string
isMainImage: true
label: string
jobs: object
lastDeletedMiraklProductSync: '2023-03-28T09:34:42Z'
lastMiraklToShopifyProductSync: '2023-03-28T09:34:42Z'
lastMiraklToShopifyShipmentSync: '2023-03-28T09:34:42Z'
lastOfferSync: '2023-03-28T09:34:42Z'
lastOrderSync: '2023-03-28T09:34:42Z'
lastPromotionSync: '2023-03-28T09:34:42Z'
lastReturnSync: '2023-03-28T09:34:42Z'
lastShopSync: '2023-03-28T09:34:42Z'
lastShopifyToMiraklProductSync: '2023-03-28T09:34:42Z'
miraklMasterMode:
enabled: true
useShopifyCategories: true
miraklPayout:
payinPspId: string
offer:
synchronizeAdditionalFields: true
synchronizeAdvancedPricing: true
synchronizeShippingTypes: true
order:
miraklExportCustomerOrganization:
mode: INACTIVE
orderMetafields:
- miraklCustomFieldCode: string
shopifyKey: string
shopifyNamespace: string
payment:
confirmCaptureToMirakl: true
confirmRefundToMirakl: true
create3PCaptureInShopify: true
create3PRefundInShopify: true
miraklPaymentWorkflow: PAY_ON_ACCEPTANCE
pspTransactionReferenceSource: string
useMiraklPayout: true
useTransactionNumberForCaptureFromMetafield: true
useTransactionNumberForRefundFromMetafield: true
product:
skuGenerations:
- strategy: MIRAKL_PRODUCT_ID_BASED
publicationIds:
- string
rootAttributes: object
shippingZoneMapping:
countries:
- iso2Code: string
provinces:
- code: string
shippingZone: string
shippingZone: string
zips:
- code: string
shippingZone: string
shippingZone: string
shop:
shopMiraklCustomFields:
- code: string
syncMiraklToShopifyProductWithTags:
- string
syncShopifyToMiraklProductWithTags:
- string
taxonomyMetafields:
- key: string
localizable: true
namespace: string
ownerType: string
vendorAsValueList: true
schema:
type: object
$ref: '#/components/schemas/UpdateSettings_Response_200'
description: OK
summary: UpdateSettings - Update connector settings
tags:
- Settings
components:
schemas:
UpdateSettings_Response_200_ShippingZoneMapping_Countries_Zips:
type: object
properties:
code:
type: string
description: The code
shippingZone:
type: string
description: The shipping zone code
UpdateSettings_Request_Jobs:
type: object
description: The job settings
properties:
scheduled:
type: boolean
description: Indicates if the job is scheduled
ListSettings_Response_200_Order:
type: object
description: Order sync settings response
properties:
miraklExportCustomerOrganization:
$ref: '#/components/schemas/ListSettings_Response_200_Order_MiraklExportCustomerOrganization'
description: Settings for exporting customer organization data to Mirakl
orderMetafields:
type: array
description: List of order metafield mappings
items:
$ref: '#/components/schemas/ListSettings_Response_200_Order_OrderMetafields'
UpdateSettings_Response_200_Shop:
type: object
description: Shop settings response
properties:
shopMiraklCustomFields:
type: array
description: List of Mirakl shop custom attributes to map
items:
$ref: '#/components/schemas/UpdateSettings_Response_200_Shop_ShopMiraklCustomFields'
UpdateSettings_Request_Offer:
type: object
description: Request object to update offer sync settings
properties:
synchronizeAdditionalFields:
type: boolean
description: Enabled status of the additional fields synchronization
synchronizeAdvancedPricing:
type: boolean
description: Enabled status of the advanced pricing synchronization
synchronizeShippingTypes:
type: boolean
description: Enabled status of the shipping types synchronization
ListSettings_Response_200_Shop:
type: object
description: Shop settings response
properties:
shopMiraklCustomFields:
type: array
description: List of Mirakl shop custom attributes to map
items:
$ref: '#/components/schemas/Lis
# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-settings-api-openapi.yml