Mirakl Platform for Services Front APIs
The Mirakl Platform for Services (MPS) Front API — 22 paths for storefront-facing service-offer discovery, ordering and post-sale flows. Front bearer token, front API key or OAuth 2.0.
OpenAPI Specification
components:
schemas:
AF01_Response_200:
type: object
properties:
additional_fields:
type: array
items:
$ref: '#/components/schemas/AF01_Response_200_AdditionalFields'
total_count:
type: integer
format: int32
deprecated: true
required:
- additional_fields
- total_count
AF01_Response_200_AdditionalFields:
type: object
properties:
accepted_values:
type: array
description: >-
The list of accepted values for this additional field. This field is
only present for additional fields of type 'LIST'
items:
type: string
channels:
type: array
description: >-
The list of channels using this additional field. This field is only
present for additional fields linked to a 'SHOP' entity.
items:
type: string
code:
type: string
description: Additional field code
default_value:
type: string
deprecated: true
description:
type: string
description: The description of the additional field.
entity:
type: string
description: |
The object on which the additional field applies
Enum: `"SHOP"`, `"OFFER"`, `"ORDER_LINE"`, `"ORDER"`
label:
type: string
description: >-
<span>Additional field label </span><span title="This field is
localized: its value uses the locale provided in the parameters"
class="flag"></span>
models:
type: array
description: >-
The list of platform models using this additional field. This field
is only present for additional fields linked to a 'SHOP' entity.
items:
type: string
description: |
Enum: `"MARKETPLACE"`, `"DROPSHIP"`, `"ONE_CREDITOR"`
regex:
type: string
description: >-
The regular expression that is used to validate the value value of
this field.<br/>This field is only present for additional fields of
type 'REGEX'.
required:
type: boolean
description: Whether or not this additionnal field will be required
shop_permission:
type: string
description: >
The shop permission field determines how Shops are allowed to use a
Custom field.<ul><li><strong>INVISIBLE</strong>: the field is
visible only for the operator and front users. Shops cannot update
its value.</li><li><strong>READ_WRITE</strong>: all users can see
and update the value of the field, provided they have access to the
entity associated with the field.</li></ul>
Enum: `"INVISIBLE"`, `"READ_ONLY"`, `"READ_WRITE"`
type:
type: string
description: >
Additional field type:<ul><li><strong>STRING</strong> chain of
characters (up to 2000 characters)</li><li><strong>DATE</strong>
date in yyyy-mm-dd format</li><li><strong>NUMERIC</strong> decimal
value (eg 52.63)</li><li><strong>BOOLEAN</strong> true or
false</li><li><strong>LINK</strong> valid
URL</li><li><strong>LIST</strong> list of values. Valid values are
specified in accepted_values field</li><li><strong>REGEX</strong>
regular expression. The regex that is used to validate the value of
this field is specified in the regex
field</li><li><strong>TEXTAREA</strong> long chain of characters (up
to 5000 characters). May have multiple lines</li></ul>
Enum: `"STRING"`, `"DATE"`, `"NUMERIC"`, `"BOOLEAN"`, `"LINK"`,
`"REGEX"`, `"TEXTAREA"`, `"LIST"`, `"MULTIPLE_VALUES_LIST"`
required:
- code
- label
- required
- shop_permission
- type
AN01_Response_200:
type: object
properties:
anonymizable:
type: boolean
description: Can the customer be anonymized?
message:
type: string
description: Anonymization status message
AN01_Response_404:
type: object
properties:
message:
type: string
status:
type: integer
format: int32
CH11_Response_200:
type: object
properties:
channels:
type: array
description: List of channels
items:
$ref: '#/components/schemas/CH11_Response_200_Channels'
CH11_Response_200_Channels:
type: object
properties:
code:
type: string
description: Channel code
description:
type: string
description: Channel description
label:
type: string
description: >-
<span>Channel label </span><span title="This field is localized: its
value uses the locale provided in the parameters"
class="flag"></span>
required:
- code
- description
- label
CUR01_Response_200:
type: object
properties:
currencies:
type: array
description: List of currencies
items:
$ref: '#/components/schemas/CUR01_Response_200_Currencies'
required:
- currencies
CUR01_Response_200_Currencies:
type: object
properties:
code:
type: string
description: Currency code
label:
type: string
description: Currency label
platform_default:
type: boolean
description: Default currency of the platform
required:
- code
- label
DO01_Response_200:
type: object
properties:
documents:
type: array
description: Document types
items:
$ref: '#/components/schemas/DO01_Response_200_Documents'
required:
- documents
DO01_Response_200_Documents:
type: object
properties:
code:
type: string
description: Type code
description:
type: string
description: Type description
entity:
type: string
description: |
Entity type linked to the document type
Enum: `"ORDER"`, `"SHOP"`
label:
type: string
description: >-
<span>Type label </span><span title="This field is localized: its
value uses the locale provided in the parameters"
class="flag"></span>
mime_types:
type: array
description: Authorized mime types
items:
type: string
models:
type: array
description: >-
The list of platform models on which this document type is
available. This field is only present for document types linked to a
'SHOP' entity.
items:
type: string
description: |
Enum: `"MARKETPLACE"`, `"DROPSHIP"`, `"ONE_CREDITOR"`
required:
- code
- description
- entity
- label
EV01_Response_200:
type: object
properties:
assessments:
type: array
description: Assessments list
items:
$ref: '#/components/schemas/EV01_Response_200_Assessments'
total_count:
type: integer
format: int32
deprecated: true
description: <p>Total count</p><p>Do not use, since there is no pagination</p>
required:
- assessments
- total_count
EV01_Response_200_Assessments:
type: object
properties:
code:
type: string
description: Assessment code
label:
type: string
description: >-
<span>Assessment label </span><span title="This field is localized:
its value uses the locale provided in the parameters"
class="flag"></span>
type:
type: string
description: |
Assessment type
Enum: `"GRADE"`, `"BOOLEAN"`
required:
- code
- label
- type
IV01_Response_200:
type: object
properties:
invoices:
type: array
description: Accounting documents
items:
$ref: '#/components/schemas/IV01_Response_200_Invoices'
total_count:
type: integer
format: int64
description: Accounting documents total count
IV01_Response_200_Invoices:
type: object
discriminator:
mapping:
AUTO_INVOICE: '#/components/schemas/IV01_Response_200_Invoices_AutoInvoice'
MANUAL_CREDIT: '#/components/schemas/IV01_Response_200_Invoices_ManualCredit'
MANUAL_INVOICE: '#/components/schemas/IV01_Response_200_Invoices_ManualInvoice'
propertyName: type
properties:
currency_iso_code:
type: string
description: >
The currency of the shop
Enum: `"AED"`, `"ARS"`, `"AUD"`, `"BAM"`, `"BGN"`, `"BHD"`, `"BRL"`,
`"CAD"`, `"CHF"`, `"CLP"`, `"CNY"`, `"COP"`, `"CZK"`, `"DKK"`,
`"EGP"`, `"EUR"`, `"GBP"`, `"GEL"`, `"GTQ"`, `"HKD"`, `"HRK"`,
`"HUF"`, `"IDR"`, `"ILS"`, `"INR"`, `"IQD"`, `"JOD"`, `"JPY"`,
`"KES"`, `"KRW"`, `"KWD"`, `"LKR"`, `"MAD"`, `"MGA"`, `"MXN"`,
`"MYR"`, `"NGN"`, `"NOK"`, `"NZD"`, `"OMR"`, `"PEN"`, `"PHP"`,
`"PKR"`, `"PLN"`, `"QAR"`, `"RON"`, `"RSD"`, `"RUB"`, `"SAR"`,
`"SEK"`, `"SGD"`, `"TND"`, `"TRY"`, `"THB"`, `"TWD"`, `"UAH"`,
`"USD"`, `"UYU"`, `"UZS"`, `"VND"`, `"ZAR"`
date_created:
type: string
format: date-time
description: Accounting document creation date
details:
type: array
description: Accounting details
items:
$ref: '#/components/schemas/IV01_Response_200_Invoices_Details'
due_date:
type: string
format: date-time
description: Due date for the payment of the accounting document
id:
type: string
description: Accounting document identifier (use it for draft document)
invoice_id:
type: integer
format: int64
description: >-
Accounting document identifier (present if the accounting document
is issued)
issue_date:
type: string
format: date-time
description: Issue date of an accounting document
issuing_user:
$ref: '#/components/schemas/IV01_Response_200_Invoices_IssuingUser'
description: Accounting document issuing user
pay_out_psp_code:
type: string
description: >
PSP code for Pay-out
Enum: `"NOT_SPECIFIED"`, `"MANGOPAY"`, `"MIRAKL_PAYOUT"`,
`"OPERATOR"`
payment:
$ref: '#/components/schemas/IV01_Response_200_Invoices_Payment'
description: Accounting document payment details
payment_voucher_number:
type: string
description: The payment voucher number
shop_address:
$ref: '#/components/schemas/IV01_Response_200_Invoices_ShopAddress'
description: Shop address
shop_corporate_name:
type: string
description: Shop corporate name if it is a professional shop
shop_id:
type: integer
format: int64
description: Shop id
shop_model:
type: string
description: |
Shop model
Enum: `"MARKETPLACE"`, `"DROPSHIP"`, `"ONE_CREDITOR"`
shop_name:
type: string
description: Shop name
shop_operator_internal_id:
type: string
description: Operator internal id for the shop
shop_tax_number:
type: string
description: Shop tax number if it is a professional shop
state:
type: string
description: Accounting document state
total_amount_excl_taxes:
type: number
format: with decimals
description: Total amount charged to the shop (excluding taxes)
total_amount_incl_taxes:
type: number
format: with decimals
description: Total amount charged to the shop (including taxes)
total_charged_amount:
type: number
format: with decimals
deprecated: true
description: Use “total_amount_incl_taxes” attribute instead
total_taxes:
type: array
description: Total taxes
items:
$ref: '#/components/schemas/IV01_Response_200_Invoices_TotalTaxes'
type:
type: string
description: >
Accounting document type
Enum: `"ALL"`, `"AUTO_INVOICE"`, `"MANUAL_INVOICE"`,
`"MANUAL_CREDIT"`
IV01_Response_200_Invoices_AutoInvoice:
type: object
allOf:
- $ref: '#/components/schemas/IV01_Response_200_Invoices'
description: Automatic accounting document
properties:
end_time:
type: string
format: date-time
description: >-
Ending date of the period for accounting document of type
<code>AUTO_INVOICE</code>
payment_info:
$ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
description: Shop payment information
seller_billing_cycle_id:
type: string
description: The seller billing cycle identifier
start_time:
type: string
format: date-time
description: >-
Starting date of the period for accounting document of type
<code>AUTO_INVOICE</code>
summary:
$ref: '#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_Summary'
description: Summary for automatic accounting document
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo:
type: object
discriminator:
mapping:
ABA: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aba
AUBSB: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aubsb
BRAZILIAN: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Brazilian
CANADIAN: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Canadian
COLOMBIAN: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Colombian
GUATEMALAN: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Guatemalan
HK: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Hk
IBAN: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Iban
INDIAN: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Indian
ISRAELI: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Israeli
JAPANESE: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Japanese
MEXICAN: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Mexican
NUBAN: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nuban
NZBSB: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nzbsb
PAYOUT: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Payout
PHILIPPINES: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Philippines
SERBIAN: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Serbian
SG: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Sg
TAIWANESE: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Taiwanese
THAI: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Thai
UK: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uk
URUGUAYAN: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uruguayan
VIETNAMESE: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Vietnamese
propertyName: type
properties:
'@type':
type: string
description: >
Enum: `"IBAN"`, `"NUBAN"`, `"AUBSB"`, `"NZBSB"`, `"ABA"`, `"HK"`,
`"CANADIAN"`, `"MEXICAN"`, `"JAPANESE"`, `"BRAZILIAN"`,
`"TAIWANESE"`, `"THAI"`, `"INDIAN"`, `"UK"`, `"URUGUAYAN"`,
`"COLOMBIAN"`, `"SG"`, `"PHILIPPINES"`, `"PAYOUT"`, `"ISRAELI"`,
`"VIETNAMESE"`, `"GUATEMALAN"`, `"SERBIAN"`
bank_city:
type: string
description: Bank city
bank_name:
type: string
description: Bank name
bank_street:
type: string
description: Bank street name
bank_zip:
type: string
description: Bank zip code
owner:
type: string
description: Name of the owner of the payment information
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aba:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Bank Account Number
bic:
type: string
description: Bank account BIC code (aka Swift Code)
routing_number:
type: string
description: Routing Number of the bank, (aka ABA code)
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aubsb:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
auban:
type: string
description: Bank account number
aubsb:
type: string
description: Bank state branch code
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Brazilian:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
account_number:
type: string
description: Account number
bank_account_type:
type: string
description: |
Account type
<br>
<ul>
<li><code>C</code> : Checking account</li>
<li><code>P</code> : Savings account</li>
</ul>
Enum: `"C"`, `"P"`
bank_code:
type: string
description: Bank code
branch_code:
type: string
description: Branch code
pix_key:
type: string
description: Pix key
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Canadian:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Bank account number
institution_number:
type: string
description: Bank institution number
swift_code:
type: string
description: Bank account swift code
transit_number:
type: string
description: Bank transit number
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Colombian:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
account_number:
type: string
description: Account number
bank_account_type:
type: string
description: |
Account type
<br>
<ul>
<li><code>C</code> : Checking account</li>
<li><code>P</code> : Savings account</li>
</ul>
Enum: `"C"`, `"P"`
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Guatemalan:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
account_number:
type: string
description: Account number
bank_account_type:
type: string
description: |
Account type
<br>
<ul>
<li><code>C</code> : Checking account</li>
<li><code>P</code> : Savings account</li>
</ul>
Enum: `"C"`, `"P"`
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Hk:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Bank account number
swift_code:
type: string
description: Bank account swift code
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Iban:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bic:
type: string
description: Bank account BIC code
iban:
type: string
description: Bank account IBAN
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Indian:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
account_number:
type: string
description: Account number
indian_financial_system_code:
type: string
description: Indian financial system code
swift_code:
type: string
description: Bank account swift code
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Israeli:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Account number
bank_code:
type: string
description: Bank code
branch_name:
type: string
description: Branch name
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Japanese:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Bank account number
bank_account_type:
type: string
description: |
Account type
<br>
<ul>
<li><code>C</code> : Checking account</li>
<li><code>P</code> : Savings account</li>
</ul>
Enum: `"C"`, `"P"`
bank_code:
type: string
description: Bank code
branch_code:
type: string
description: Branch code
branch_name:
type: string
description: Branch name
swift_code:
type: string
description: Bank account swift code
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Mexican:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Bank account number
clabe:
type: string
description: Clave Bancaria Estandarizada
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nuban:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
nuban:
type: string
description: The bank account NUBAN code
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nzbsb:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
nzban:
type: string
description: Bank Account Number
nzbsb:
type: string
description: Bank State Branch code.
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Payout:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Account number
bic:
type: string
description: BIC
iban:
type: string
description: IBAN
payout_format:
type: string
description: |
Payout format
Enum: `"LOCAL_IBAN"`, `"LOCAL_UK"`, `"INTERNATIONAL"`
sort_code:
type: string
description: Sort code
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Philippines:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Account number
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Serbian:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Bank account number
bank_branch_number:
type: string
description: Bank branch number
bic:
type: string
description: Bank account BIC code
iban:
type: string
description: Bank account IBAN
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Sg:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Account number
bank_key:
type: string
description: Bank key
swift_code:
type: string
description: Swift code
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Taiwanese:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
account_number:
type: string
description: Account number
bank_code:
type: string
description: Bank code
branch_code:
type: string
description: Branch code
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Thai:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
account_number:
type: string
description: Account number
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uk:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Account number
sort_code:
type: string
description: Sort code
swift_code:
type: string
description: Swift code
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uruguayan:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
account_number:
type: string
description: Account number
bank_account_type:
type: string
description: |
Account type
<br>
<ul>
<li><code>C</code> : Checking account</li>
<li><code>P</code> : Savings account</li>
</ul>
Enum: `"C"`, `"P"`
branch_code:
type: string
description: Branch code
IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Vietnamese:
type: object
allOf:
- $ref: >-
#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo
properties:
bank_account_number:
type: string
description: Account number
branch_name:
type: string
description: Branch name
IV01_Response_200_Invoices_AutoInvoice_Summary:
type: object
properties:
amount_transferred:
type: number
format: with decimals
description: Total amount to be transferred to the seller
amount_transferred_to_operator:
type: number
format: with decimals
description: Total amount to be transferred to the operator
reserve_funding:
type: number
format: with decimals
description: Amount set aside for the seller reserve
reserve_settlement:
type: number
format: with decimals
description: Amount paid out from the seller reserve
total_commissions_excl_tax:
type: number
format: with decimals
description: Total amount of commissions (excluding taxes on orders)
total_commissions_incl_tax:
type: number
format: with decimals
description: Total amount of commissions (including taxes on orders)
total_fee_excl_tax:
type: number
format: with decimals
description: Total amount of fees (excluding taxes on orders)
total_fee_incl_tax:
type: number
format: with decimals
description: Total amount of fees (including taxes on orders)
total_fee_operator_remitted_excl_tax:
type: number
format: with decimals
description: >-
Total amount of fees remitted by the operator (excluding taxes on
orders)
total_fee_operator_remitted_incl_tax:
type: number
format: with decimals
description: >-
Total amount of fees remitted by the operator (including taxes on
orders)
total_mirakl_ads_credit_excl_tax:
type: number
format: with decimals
description: >-
Total amount for Mirakl Ads credits of a payment cycle (excluding
taxes on stores)
total_mirakl_ads_credit_incl_tax:
type: number
format: with decimals
description: >-
Total amount for Mirakl Ads credits of a payment cycle (including
taxes on stores)
total_mirakl_ads_debit_excl_tax:
type: number
format: with decimals
description: >-
Total amount for Mirakl Ads debits of a payment cycle (excluding
taxes on stores)
total_mirakl_ads_debit_incl_tax:
type: number
format: with decimals
description: >-
Total amount for Mirakl Ads debits of a payment cycle (including
taxes on stores)
total_non_payable_orders_excl_tax:
type: number
format: with decimals
description: >-
Total amount for non payable orders (including shipping charges and
excluding taxes on orders)
total_non_payable_orders_incl_tax:
type: number
format: with decimals
description: >-
Total amount for non payable orders (including shipping charges and
taxes on orders)
total_operator_paid_shipping_charges_excl_tax:
# --- truncated at 32 KB (944 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/_original/mirakl-mms-front-openapi.yaml