# UpdateSettings - Update connector settings

Description

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

Endpoint: PATCH /api/settings

## Request fields (application/json):

  - `additionalLocales` (array)
    Additional locales configuration, aside the primary language of the store

  - `additionalLocales.locale` (string)
    Locale code, language without region (e.g., 'fr', 'de', 'es')
    Example: "fr"

  - `categories` (object)
    Configuration for category filtering during taxonomy export

  - `categories.excludes` (array)
    List of category IDs to exclude from the export (excludes all subcategories automatically)

  - `categories.includes` (array)
    List of category IDs to include in the export (includes all subcategories automatically)

  - `customAppClientSecret` (string)
    Client secret used to verify the signature of JWT tokens send in CustomerUI API call

  - `customCarrierDescription` (string)
    Description for the custom carrier

  - `customCarrierTitle` (string)
    Title for the custom carrier

  - `fraudCheck` (object)
    Fraud check

  - `fraudCheck.analysisFactDescription` (string)

  - `fraudCheck.strategy` (string)
    Enum: "CUSTOM_ASSESSMENT", "NO_CHECK", "SHOPIFY_RECOMMENDATION"

  - `imageAttributes` (array)
    List of image attributes exported when taxonomy is synchronized in Mirakl

  - `imageAttributes.code` (string)
    The unique code for the image attribute

  - `imageAttributes.isMainImage` (boolean)
    Indicates if this is the main image

  - `imageAttributes.label` (string)
    The label describing the image attribute

  - `jobs` (object)
    The job settings

  - `lastDeletedMiraklProductSync` (string)
    Timestamp of the last synchronization of Mirakl deleted products to Shopify

  - `lastMiraklToShopifyProductSync` (string)
    Timestamp of the last Mirakl to Shopify product synchronization

  - `lastMiraklToShopifyShipmentSync` (string)
    Timestamp of the last Mirakl to Shopify shipment synchronization

  - `lastOfferSync` (string)
    Timestamp of the last offer synchronization

  - `lastOrderSync` (string)
    Timestamp of the last order synchronization

  - `lastReturnSync` (string)
    Timestamp of the last return synchronization

  - `lastShopSync` (string)
    Timestamp of the last shop synchronization

  - `lastShopifyToMiraklProductSync` (string)
    Timestamp of the last Shopify to Mirakl product synchronization

  - `miraklMasterMode` (object)
    Mirakl Master Mode settings

  - `miraklPayout` (object)
    Mirakl payout settings

  - `miraklPayout.payinPspId` (string)
    Pay-in PSP to use to process payments

  - `offer` (object)
    Offer settings

  - `offer.synchronizeAdvancedPricing` (boolean)
    Enabled status of the advanced pricing synchronization

  - `order` (object)
    Order settings

  - `order.miraklExportCustomerOrganization` (object)
    Settings for exporting customer organization data to Mirakl

  - `order.miraklExportCustomerOrganization.mode` (string)
    The mode for exporting customer organization data to Mirakl (Default: INACTIVE)

Enum: "INACTIVE", "ID", "FULL"

  - `order.orderMetafields` (array)
    List of order metafield mappings

  - `order.orderMetafields.miraklCustomFieldCode` (string, required)
    The Mirakl custom field code

  - `order.orderMetafields.shopifyKey` (string, required)
    The Shopify metafield key

  - `order.orderMetafields.shopifyNamespace` (string, required)
    The Shopify metafield namespace

  - `payment` (object)
    Payment settings

  - `payment.confirmCaptureToMirakl` (boolean)
    Whether to confirm captures to Mirakl

  - `payment.confirmRefundToMirakl` (boolean)
    Whether to confirm refunds to Mirakl

  - `payment.create3PCaptureInShopify` (boolean)
    Whether to create third-party captures in Shopify

  - `payment.create3PRefundInShopify` (boolean)
    Whether to create third-party refunds in Shopify

  - `payment.miraklPaymentWorkflow` (string)
    Workflow for handling order payments

Enum: "PAY_ON_ACCEPTANCE", "PAY_ON_DELIVERY", "PAY_ON_DUE_DATE", "PAY_ON_SHIPMENT", "NO_CUSTOMER_PAYMENT_CONFIRMATION"

  - `payment.useMiraklPayout` (boolean)
    Whether to use Mirakl payout

  - `payment.useTransactionNumberForCaptureFromMetafield` (boolean)
    Whether to use transaction number from order metafield for capture

  - `payment.useTransactionNumberForRefundFromMetafield` (boolean)
    Whether to use transaction number from order metafield for refund

  - `product` (object)
    Product settings

  - `product.skuGenerations` (array)
    Ordered list of SKU generation strategies

  - `product.skuGenerations.strategy` (string)
    Enum: "MIRAKL_PRODUCT_ID_BASED", "UNIQUE_IDENTIFIER_BASED"

  - `publicationIds` (array)
    The Shopify publication ids in which the third-party products and collections will be published

  - `rootAttributes` (object)
    Settings of the root attributes and their Mirakl attribute codes. Only relevant when miraklMasterMode is enabled. If not provided, defaults to preset values.

  - `shippingZoneMapping` (object)
    Mapping to compute Mirakl shipping zone code from customer address

  - `shippingZoneMapping.countries` (array)
    List of countries who override the default shipping zone code

  - `shippingZoneMapping.countries.iso2Code` (string)
    The ISO 2 code for the country

  - `shippingZoneMapping.countries.provinces` (array)
    List of province who override the shipping zone code (not checked if override is found in zips list)

  - `shippingZoneMapping.countries.provinces.code` (string)
    The code

  - `shippingZoneMapping.countries.provinces.shippingZone` (string)
    The shipping zone code

  - `shippingZoneMapping.countries.shippingZone` (string)
    The shipping zone for the country

  - `shippingZoneMapping.countries.zips` (array)
    List of zip who override the shipping zone code. The code must match the beginning of customer the zip code (ex: K2 and K2P will match the customer zip code K2P-2L8 but K2P will be prioritized)

  - `shippingZoneMapping.countries.zips.code` (string)
    The code

  - `shippingZoneMapping.countries.zips.shippingZone` (string)
    The shipping zone code

  - `shippingZoneMapping.shippingZone` (string)
    The default shipping zone code

  - `shop` (object)
    Shop settings

  - `shop.shopMiraklCustomFields` (array)
    List of Mirakl shop custom attributes to map

  - `shop.shopMiraklCustomFields.code` (string)
    The Mirakl custom field code

  - `syncMiraklToShopifyProductWithTags` (array)
    List of all tags used to mark Mirakl products imported into Shopify.

  - `syncShopifyToMiraklProductWithTags` (array)
    List of all tags used to synchronize Shopify products to Mirakl. No product are exported if null or empty

  - `taxonomyMetafields` (array)
    List of all Shopify Metafields exported when taxonomy is synchronized in Mirakl

  - `taxonomyMetafields.key` (string)
    The unique identifier for the metafield definition within its namespace

  - `taxonomyMetafields.localizable` (boolean)
    Whether this metafield can be translated

  - `taxonomyMetafields.namespace` (string)
    The namespace for the metafield definition

  - `taxonomyMetafields.ownerType` (string)
    The resource type that the metafield definition is attached to (PRODUCT or PRODUCTVARIANT)

  - `vendorAsValueList` (boolean)
    Export Shopify vendor attribute as a LIST attribute instead of TEXT

## Response 200 fields (application/json):

  - `additionalLocales` (array)
    Additional locales configuration, aside the primary language of the store

  - `additionalLocales.locale` (string)
    Locale code, language without region (e.g., 'fr', 'de', 'es')
    Example: "fr"

  - `categories` (object)
    Configuration for category filtering during taxonomy export

  - `categories.excludes` (array)
    List of category IDs to exclude from the export (excludes all subcategories automatically)

  - `categories.includes` (array)
    List of category IDs to include in the export (includes all subcategories automatically)

  - `customAppClientSecret` (string)
    Client secret used to verify the signature of JWT tokens send in CustomerUI API call

  - `customCarrierDescription` (string)
    Description for the custom carrier

  - `customCarrierTitle` (string)
    Title for the custom carrier

  - `fraudCheck` (object)
    Fraud check

  - `fraudCheck.analysisFactDescription` (string)

  - `fraudCheck.strategy` (string)
    Enum: "CUSTOM_ASSESSMENT", "NO_CHECK", "SHOPIFY_RECOMMENDATION"

  - `imageAttributes` (array)
    List of image attributes exported when taxonomy is synchronized in Mirakl

  - `imageAttributes.code` (string)
    The unique code for the image attribute

  - `imageAttributes.isMainImage` (boolean)
    Indicates if this is the main image

  - `imageAttributes.label` (string)
    The label describing the image attribute

  - `jobs` (object)
    The job settings

  - `lastDeletedMiraklProductSync` (string)
    Timestamp of the last synchronization of Mirakl deleted products to Shopify

  - `lastMiraklToShopifyProductSync` (string)
    Timestamp of the last Mirakl to Shopify product synchronization

  - `lastMiraklToShopifyShipmentSync` (string)
    Timestamp of the last Mirakl to Shopify shipment synchronization

  - `lastOfferSync` (string)
    Timestamp of the last offer synchronization

  - `lastOrderSync` (string)
    Timestamp of the last order synchronization

  - `lastReturnSync` (string)
    Timestamp of the last return synchronization

  - `lastShopSync` (string)
    Timestamp of the last shop synchronization

  - `lastShopifyToMiraklProductSync` (string)
    Timestamp of the last Shopify to Mirakl product synchronization

  - `miraklMasterMode` (object)
    Mirakl Master Mode settings

  - `miraklMasterMode.enabled` (boolean)
    Indicates if Mirakl is master on the taxonomy.

  - `miraklMasterMode.useShopifyCategories` (boolean)
    Indicates if Shopify categories should be used when Mirakl is master on the taxonomy.

  - `miraklPayout` (object)
    Mirakl payout settings

  - `miraklPayout.payinPspId` (string)
    Pay-in PSP to use to process payments

  - `offer` (object)
    Offer settings

  - `offer.synchronizeAdvancedPricing` (boolean)
    Enabled status of the advanced pricing synchronization

  - `order` (object)
    Order settings

  - `order.miraklExportCustomerOrganization` (object)
    Settings for exporting customer organization data to Mirakl

  - `order.miraklExportCustomerOrganization.mode` (string)
    The mode for exporting customer organization data to Mirakl (Default: INACTIVE)

Enum: "INACTIVE", "ID", "FULL"

  - `order.orderMetafields` (array)
    List of order metafield mappings

  - `order.orderMetafields.miraklCustomFieldCode` (string)
    The Mirakl custom field code

  - `order.orderMetafields.shopifyKey` (string)
    The Shopify metafield key

  - `order.orderMetafields.shopifyNamespace` (string)
    The Shopify metafield namespace

  - `payment` (object)
    Payment settings

  - `payment.confirmCaptureToMirakl` (boolean)
    Whether to confirm captures to Mirakl

  - `payment.confirmRefundToMirakl` (boolean)
    Whether to confirm refunds to Mirakl

  - `payment.create3PCaptureInShopify` (boolean)
    Whether to create third-party captures in Shopify

  - `payment.create3PRefundInShopify` (boolean)
    Whether to create third-party refunds in Shopify

  - `payment.miraklPaymentWorkflow` (string)
    Workflow for handling order payments

Enum: "PAY_ON_ACCEPTANCE", "PAY_ON_DELIVERY", "PAY_ON_DUE_DATE", "PAY_ON_SHIPMENT", "NO_CUSTOMER_PAYMENT_CONFIRMATION"

  - `payment.useMiraklPayout` (boolean)
    Whether to use Mirakl payout

  - `payment.useTransactionNumberForCaptureFromMetafield` (boolean)
    Whether to use transaction number from order metafield for capture

  - `payment.useTransactionNumberForRefundFromMetafield` (boolean)
    Whether to use transaction number from order metafield for refund

  - `product` (object)
    Product settings

  - `product.skuGenerations` (array)
    Ordered list of SKU generation strategies

  - `product.skuGenerations.strategy` (string)
    Enum: "MIRAKL_PRODUCT_ID_BASED", "UNIQUE_IDENTIFIER_BASED"

  - `publicationIds` (array)
    The Shopify publication ids in which the third-party products and collections will be published

  - `rootAttributes` (object)
    Settings of the root attributes and their Mirakl attribute codes. Only relevant when miraklMasterMode is enabled. If empty, defaults to preset values.

  - `shippingZoneMapping` (object)
    Mapping to compute Mirakl shipping zone code from customer address

  - `shippingZoneMapping.countries` (array)
    List of countries who override the default shipping zone code

  - `shippingZoneMapping.countries.iso2Code` (string)
    The ISO 2 code for the country

  - `shippingZoneMapping.countries.provinces` (array)
    List of province who override the shipping zone code (not checked if override is found in zips list)

  - `shippingZoneMapping.countries.provinces.code` (string)
    The code

  - `shippingZoneMapping.countries.provinces.shippingZone` (string)
    The shipping zone code

  - `shippingZoneMapping.countries.shippingZone` (string)
    The shipping zone for the country

  - `shippingZoneMapping.countries.zips` (array)
    List of zip who override the shipping zone code. The code must match the beginning of customer the zip code (ex: K2 and K2P will match the customer zip code K2P-2L8 but K2P will be prioritized)

  - `shippingZoneMapping.countries.zips.code` (string)
    The code

  - `shippingZoneMapping.countries.zips.shippingZone` (string)
    The shipping zone code

  - `shippingZoneMapping.shippingZone` (string)
    The default shipping zone code

  - `shop` (object)
    Shop settings

  - `shop.shopMiraklCustomFields` (array)
    List of Mirakl shop custom attributes to map

  - `shop.shopMiraklCustomFields.code` (string)
    The Mirakl custom field code

  - `syncMiraklToShopifyProductWithTags` (array)
    List of all tags used to mark Mirakl products imported into Shopify.

  - `syncShopifyToMiraklProductWithTags` (array)
    List of all tags used to synchronize Shopify products to Mirakl. No product are exported if null or empty

  - `taxonomyMetafields` (array)
    List of all Shopify Metafields exported when taxonomy is synchronized in Mirakl

  - `taxonomyMetafields.key` (string)
    The unique identifier for the metafield definition within its namespace

  - `taxonomyMetafields.localizable` (boolean)
    Whether this metafield can be translated

  - `taxonomyMetafields.namespace` (string)
    The namespace for the metafield definition

  - `taxonomyMetafields.ownerType` (string)
    The resource type that the metafield definition is attached to (PRODUCT or PRODUCTVARIANT)

  - `vendorAsValueList` (boolean)
    Export Shopify vendor attribute as a LIST attribute instead of TEXT