Mirakl Platform Settings API
The Platform Settings API from Mirakl — 19 operation(s) for platform settings.
OpenAPI Specification
openapi: 3.1.0
info:
description: '{% partial file="/partial-content/product/connect-channel-platform/rest/connect/openapi-description.md" /%}'
title: Mirakl Connect Channel Platform APIs Carriers Platform Settings API
version: ''
servers:
- description: Connect Channel Platform API
url: https://miraklconnect.com/api/channel-platform
tags:
- name: Platform Settings
paths:
/api/additional_fields:
get:
description: '<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: Once per day</div>
<div class="max-call-frequency">Maximum usage: Once per day</div>
<div class="extension-title">Read More</div>
<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/mmp/Operator/config_custom_fields/config_custom_fields.html">More context</a></li></ul><div class="extension-title">Localization</div>
<p>This resource supports <code>locale</code> parameter (<a href="#section/Locale">see documentation</a>)</p><p>Localized output fields will be highlighted with an icon: <span class="flag"></span></p></div>'
operationId: AF01
parameters:
- description: 'A comma separated list of entities on which the additional fields must apply. Accepted values are <code>OFFER</code>, <code>SHOP</code>, <code>ORDER</code> and <code>ORDER_LINE</code>. Ex: <code>OFFER,SHOP</code>.'
explode: true
in: query
name: entities
required: false
schema:
type: string
style: form
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
additional_fields:
- code: ecotax
description: The amount of the price to be collected as Eco tax.
entity: OFFER
label: Eco tax
required: false
type: NUMERIC
- code: gift-message
description: Message to send with the order.
entity: ORDER_LINE
label: Gift Message
required: false
shop_permission: READ_WRITE
type: STRING
- channels:
- US
- FR
code: customer-care-phone
description: Phone number to contact customer care service.
entity: SHOP
label: Customer care phone number
models:
- MARKETPLACE
required: false
shop_permission: READ_WRITE
type: STRING
- accepted_values:
- Opt-In
- Headhunted
- Contact-Form
code: recruitment
description: How the shop has been recruited on the platform.
entity: SHOP
label: Recruitment Method
required: false
shop_permission: READ_WRITE
type: LIST
application/json-auto:
summary: Complete example with value types (application/json)
value:
additional_fields:
- accepted_values:
- string
channels:
- string
code: string
default_value: string
description: string
entity: SHOP
label: string
models:
- MARKETPLACE
regex: string
required: true
shop_permission: INVISIBLE
type: STRING
total_count: 0
schema:
type: object
$ref: '#/components/schemas/AF01_Response_200'
description: OK
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: AF01 - List all custom fields
tags:
- Platform Settings
/api/channels:
get:
description: '<div class="extension-title">Description</div>
Results are sorted by code
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: Once per day</div>
<div class="max-call-frequency">Maximum usage: Once per day</div>
<div class="extension-title">Localization</div>
<p>This resource supports <code>locale</code> parameter (<a href="#section/Locale">see documentation</a>)</p><p>Localized output fields will be highlighted with an icon: <span class="flag"></span></p></div>'
operationId: CH11
parameters: []
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
channels:
- code: BFR
description: Black Friday
label: Black Friday
- code: CA
description: Website CA
label: Website CA
- code: CHR
description: Christmas
label: Christmas
- code: FR
description: Website FR
label: Website FR
- code: US
description: Website US
label: Website US
application/json-auto:
summary: Complete example with value types (application/json)
value:
channels:
- code: string
description: string
label: string
schema:
type: object
$ref: '#/components/schemas/CH11_Response_200'
description: OK
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: CH11 - List all enabled channels
tags:
- Platform Settings
/api/currencies:
get:
description: '<div class="extension-title">Description</div>
List currency codes and labels activated on the platform
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: Once per day</div>
<div class="max-call-frequency">Maximum usage: Once per day</div>
<div class="extension-title">Localization</div>
<p>This resource supports <code>locale</code> parameter (<a href="#section/Locale">see documentation</a>)</p><p>Localized output fields will be highlighted with an icon: <span class="flag"></span></p></div>'
operationId: CUR01
parameters: []
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
currencies:
- code: EUR
label: Euro
platform_default: true
- code: JPY
label: Japanese Yen
- code: USD
label: US Dollar
application/json-auto:
summary: Complete example with value types (application/json)
value:
currencies:
- code: string
label: string
platform_default: true
schema:
type: object
$ref: '#/components/schemas/CUR01_Response_200'
description: OK
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: CUR01 - List currency codes and labels
tags:
- Platform Settings
/api/documents:
get:
description: '<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: Once per day</div>
<div class="max-call-frequency">Maximum usage: Once per day</div>
<div class="extension-title">Read More</div>
<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/mmp/Operator/manage_docs/manage_order_and_seller_docs/display_order_documents_on_front.html">More context</a></li></ul><div class="extension-title">Localization</div>
<p>This resource supports <code>locale</code> parameter (<a href="#section/Locale">see documentation</a>)</p><p>Localized output fields will be highlighted with an icon: <span class="flag"></span></p></div>'
operationId: DO01
parameters:
- description: 'A comma separated list of values, representing the type of entities the document type should be related to. Accepted values are <code>ORDER</code>, <code>SHOP</code>. Ex: <code>ORDER,SHOP</code>'
explode: true
in: query
name: entities
required: false
schema:
type: string
style: form
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
documents:
- code: SYSTEM_DELIVERY_BILL
description: Delivery slip
entity: ORDER
label: Delivery slip
- code: CUSTOMER_INVOICE
description: Invoice
entity: ORDER
label: Invoice
- code: LEGAL_DOC
description: Legal documents
entity: SHOP
label: Legal documents
models:
- MARKETPLACE
- code: ID_CARD
description: General Manager ID card
entity: SHOP
label: General Manager ID card
models:
- MARKETPLACE
application/json-auto:
summary: Complete example with value types (application/json)
value:
documents:
- code: string
description: string
entity: ORDER
label: string
mime_types:
- string
models:
- MARKETPLACE
schema:
type: object
$ref: '#/components/schemas/DO01_Response_200'
description: OK
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: DO01 - List all document types
tags:
- Platform Settings
/api/locales:
get:
description: '<div class="extension-title">Description</div>
List locale codes and labels from your platform to automate product format exports (API H01, PM01, VL01) from your PIM system
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: Once per day</div>
<div class="max-call-frequency">Maximum usage: Once per day</div>
</div>'
operationId: L01
parameters: []
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
locales:
- code: de_DE
label: Deutsch
- code: en_US
label: English - US
platform_default: true
- code: es_ES
label: Español
- code: fr_FR
label: Français
- code: it_IT
label: Italiano
- code: nl_NL
label: Nederlands
application/json-auto:
summary: Complete example with value types (application/json)
value:
locales:
- code: string
label: string
platform_default: true
schema:
type: object
$ref: '#/components/schemas/L01_Response_200'
description: OK
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: L01 - List locale codes and labels
tags:
- Platform Settings
/api/platform/configuration:
get:
description: '<div class="extension-title">Description</div>
List platform configurations such as general information, modules and features activated.<br/>
<br/>
Note: This configuration represents modules and major features enabled during platform setup. This differs from the PC02 API which export the platform business settings configurable by the operator in the back office.
<div class="api-description-extension">
</div>'
operationId: PC01
parameters: []
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
features:
catalog:
allow_shop_contribution_to_all_channels: true
exclude_invalid_products: true
list_of_multiple_values_separator: '|'
product_acceptance_by_channel: true
product_data_validation_by_channel: true
product_import_only_on_leaf: true
circular_economy_data_collection: false
competitive_pricing_tool: false
direct_payment_customer_store:
activated: false
refund_cancel_authorized: false
disable_seller_alternative_carrier: false
lead_time_to_ship_by_sellers_enabled: 'YES'
multi_currency: true
no_reply_needed: true
offer_prices_decimals: '2'
operator_csv_delimiter: SEMICOLON
order_conditions:
lead_time_to_ship: true
maximum_order_quantity: false
minimum_order_quantity: false
package_order_quantity: false
order_tax_mode: TAX_EXCLUDED
order_workflows:
no_customer_payment_confirmation: true
order_acceptance: NOT_AUTOMATIC
pause_debit_workflow: false
pay_on_due_date: true
pay_on_shipment: true
sellers_edit_shipping_origin: false
shipping_and_billing_details_before_acceptance: false
pricing:
channel_pricing: DISABLED
scheduled_pricing: false
volume_discount: true
volume_pricing: false
product_data_validation_by_channel: true
shipment:
multi_part_item_shipment: true
multi_shipment: true
shop_tax_options:
local_tax_number:
mandatory: true
validation_regex: regex_local_tax_number
tax_identification_number:
mandatory: true
validation_regex: regex_tax_identification_number
tax_collection:
activated: 'NO'
product_tax_code_mandatory: true
tax_collection_by_operator: false
tax_id_number:
mandatory: false
warehouses:
geolocation: true
restricted_countries:
- FRA
- USA
modules:
mirakl_catalog_integrator: true
mirakl_catalog_manager: false
mirakl_catalog_transformer: true
mirakl_platform_services: false
offer_management: true
order_management: true
promotions: true
quotes: true
tax_manager:
activated: false
tax_provider:
avalara: false
vertex: false
platform_configuration:
customer_model:
b2b: false
b2c: true
platform_model:
drop_ship: true
marketplace: true
one_creditor: true
platform_name: ''
tenant_name: tenantname-prod
timezone: Europe/Paris
application/json-auto:
summary: Complete example with value types (application/json)
value:
features:
catalog:
allow_shop_contribution_to_all_channels: true
exclude_invalid_products: true
list_of_multiple_values_separator: string
product_acceptance_by_channel: true
product_data_validation_by_channel: true
product_import_only_on_leaf: true
circular_economy_data_collection: true
competitive_pricing_tool: true
direct_payment_customer_store:
activated: true
refund_cancel_authorized: true
disable_seller_alternative_carrier: true
dropship:
retail_pricing_edition_enabled: 'YES'
retail_pricing_enabled: true
kyc_status_per_seller: true
lead_time_to_ship_by_sellers_enabled: 'YES'
multi_currency: true
multi_payout_psp_per_seller: true
no_reply_needed: true
offer_prices_decimals: string
operator_csv_delimiter: COMMA
order_conditions:
lead_time_to_ship: true
maximum_order_quantity: true
minimum_order_quantity: true
package_order_quantity: true
order_tax_mode: TAX_INCLUDED
order_workflows:
no_customer_payment_confirmation: true
order_acceptance: AUTOMATIC
pause_debit_workflow: true
pay_on_due_date: true
pay_on_shipment: true
sellers_edit_shipping_origin: true
shipping_and_billing_details_before_acceptance: true
payment_confirmation: true
pricing:
channel_pricing: MULTI
discount_period_required: true
discount_price_creation_in_the_past_blocked: true
scheduled_pricing: true
volume_discount: true
volume_pricing: true
product_data_validation_by_channel: true
promotion:
cart_promotion_campaign: true
discount_campaign: true
seller_promotion: true
returns:
drop_ship: true
marketplace: true
one_creditor: true
shipment:
multi_part_item_shipment: true
multi_shipment: true
shop_tax_options:
local_tax_number:
mandatory: true
validation_regex: string
tax_identification_number:
mandatory: true
validation_regex: string
tax_collection:
activated: 'YES'
product_tax_code_mandatory: true
tax_collection_by_operator: true
tax_id_number:
mandatory: true
validation_regex: string
warehouses:
geolocation: true
restricted_countries:
- AFG
modules:
mirakl_catalog_integrator: true
mirakl_catalog_manager: true
mirakl_catalog_transformer: true
mirakl_platform_services: true
offer_management: true
offer_management_mode: string
order_management: true
order_management_mode: string
promotions: true
quotes: true
tax_manager:
activated: true
tax_provider:
avalara: true
vertex: true
platform_configuration:
customer_model:
b2b: true
b2c: true
enhanced_seller_invoicing:
enabled: true
platform_model:
drop_ship: true
marketplace: true
one_creditor: true
platform_name: string
tenant_name: string
timezone: string
schema:
type: object
$ref: '#/components/schemas/PC01_Response_200'
description: OK
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: PC01 - List platform configurations
tags:
- Platform Settings
/api/version:
get:
description: '<div class="extension-title">Description</div>
Use this endpoint to check that Mirakl Platform is up.<br/>You can ignore the response body that is subject to change, checking the response code is enough.
<div class="api-description-extension">
</div>'
operationId: V01
parameters:
- description: Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.
explode: true
in: query
name: shop_id
required: false
schema:
type: integer
format: int64
style: form
responses:
'200':
description: OK
summary: V01 - Health Check endpoint
tags:
- Platform Settings
/api/offers/states:
get:
description: '<div class="extension-title">Description</div>
Sorted by sort index, set in the back-office
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: Once per day</div>
<div class="max-call-frequency">Maximum usage: Once per day</div>
<div class="extension-title">Localization</div>
<p>This resource supports <code>locale</code> parameter (<a href="#section/Locale">see documentation</a>)</p><p>Localized output fields will be highlighted with an icon: <span class="flag"></span></p></div>'
operationId: OF61
parameters:
- description: Filter offer condition on their active status. If true, only active offer conditions are returned. If false, only inactive offer conditions are returned. If not specified, all offer conditions are returned.
explode: true
in: query
name: active
required: false
schema:
type: boolean
style: form
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
offer_states:
- active: false
code: '8'
label: Collectors - Acceptable Condition
- active: true
code: '10'
label: Refurbished
total_count: 2
application/json-auto:
summary: Complete example with value types (application/json)
value:
offer_states:
- active: true
code: string
label: string
total_count: 0
schema:
type: object
$ref: '#/components/schemas/OF61_Response_200'
description: OK
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: OF61 - List offer conditions
tags:
- Platform Settings
/api/reasons:
get:
description: '<div class="extension-title">Description</div>
This API returns cancellation, refund, incident, and message reasons.<br>Reasons are sorted by type then sort index (set in the back-office)
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: Each time a page must display a list of reasons</div>
<div class="max-call-frequency">Maximum usage: Each time a page must display a list of reasons</div>
<div class="extension-title">Read More</div>
<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/integration_guide/display_order_details_and_features.html">More context</a></li></ul><div class="extension-title">Localization</div>
<p>This resource supports <code>locale</code> parameter (<a href="#section/Locale">see documentation</a>)</p><p>Localized output fields will be highlighted with an icon: <span class="flag"></span></p></div>'
operationId: RE01
parameters: []
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
reasons:
- code: '1'
is_customer_right: true
is_operator_right: true
is_shop_right: false
label: Item not received
type: INCIDENT_OPEN
- code: '10'
is_customer_right: true
is_operator_right: true
is_shop_right: false
label: Replacement item received
type: INCIDENT_CLOSE
- code: '15'
is_customer_right: false
is_operator_right: true
is_shop_right: true
label: Out of stock
type: REFUND
- code: '26'
is_customer_right: true
is_operator_right: true
is_shop_right: true
label: Other question
type: ORDER_MESSAGING
- code: '33'
is_customer_right: true
is_operator_right: false
is_shop_right: true
label: Other question
type: OFFER_MESSAGING
- code: '34'
is_customer_right: true
is_operator_right: true
is_shop_right: true
label: Cancelled by the client prior to shipping
type: CANCELATION
- code: MMP_SELLER_MESSAGING_ONBOARDING
is_customer_right: false
is_operator_right: true
is_shop_right: true
label: Onboarding
type: MMP_SELLER_MESSAGING
- code: MPS_SELLER_MESSAGING_ONBOARDING
is_customer_right: false
is_operator_right: true
is_shop_right: true
label: Onboarding
type: MPS_SELLER_MESSAGING
application/json-auto:
summary: Complete example with value types (application/json)
value:
reasons:
- code: string
is_customer_right: true
is_operator_right: true
is_shop_right: true
label: string
type: INCIDENT_OPEN
total_count: 0
schema:
type: object
$ref: '#/components/schemas/RE01_Response_200'
description: OK
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: RE01 - List reasons
tags:
- Platform Settings
/api/reasons/{reason_type}:
get:
deprecated: true
description: '<div class="extension-title">Deprecated endpoint</div>
This API is going to be removed in future update. Consider using RE01.
<div class="extension-title">Description</div>
This API returns cancellation, refund, incident, and message reasons.<br>Reasons are sorted by sort index (set in the back-office)
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: Each time a page must display a list of reasons</div>
<div class="max-call-frequency">Maximum usage: Each time a page must display a list of reasons</div>
<div class="extension-title">Localization</div>
<p>This resource supports <code>locale</code> parameter (<a href="#section/Locale">see documentation</a>)</p><p>Localized output fields will be highlighted with an icon: <span class="flag"></span></p></div>'
operationId: RE02
parameters:
- description: Reason type
explode: false
in: path
name: reason_type
required: true
schema:
type: string
enum:
- INCIDENT_OPEN
- MPS_INCIDENT_OPEN
- INCIDENT_CLOSE
- MPS_INCIDENT_CLOSE
- REFUND
- MPS_REFUND
- MESSAGING
- ORDER_MESSAGING
- MPS_ORDER_MESSAGING
- MPS_OFFER_MESSAGING
- CANCELATION
style: simple
responses:
'200':
content:
application/json
# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-platform-settings-api-openapi.yml