The MMP Front API surface — machine-to-machine operations designed for storefront and CMS integration with a Mirakl marketplace instance (78 paths across orders, offers, products, returns, messaging and platform settings). Front bearer token or OAuth 2.0.
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
CA01_Response_201:
type: object
properties:
synchro_id:
type: integer
format: int64
description: Synchro identifier
required:
- synchro_id
CA02_Response_200:
type: object
properties:
category_deleted:
type: integer
format: int32
description: Number of deleted categories
category_inserted:
type: integer
format: int32
description: Number of inserted categories
category_updated:
type: integer
format: int32
description: Number of updated categories
date_created:
type: string
format: date-time
description: Creation date of the import
has_error_report:
type: boolean
description: Indicate if an error report exists
lines_in_error:
type: integer
format: int32
description: Number of lines in error
lines_in_success:
type: integer
format: int32
description: Number of lines in success
lines_read:
type: integer
format: int32
description: Number of lines read
status:
type: string
description: >
Synchro status
Enum: `"WAITING"`, `"QUEUED"`, `"RUNNING"`, `"COMPLETE"`,
`"FAILED"`, `"CANCELLED"`
synchro_id:
type: integer
format: int64
description: Synchro identifier
required:
- category_deleted
- category_inserted
- category_updated
- date_created
- has_error_report
- lines_in_error
- lines_in_success
- lines_read
- status
- synchro_id
CA11_Response_200:
type: object
properties:
categories:
type: array
description: List of categories
items:
$ref: '#/components/schemas/CA11_Response_200_Categories'
required:
- categories
CA11_Response_200_Categories:
type: object
properties:
category_code:
type: string
description: Category code
category_label:
type: string
description: >-
<span>Category label </span><span title="This field is localized:
its value uses the locale provided in the parameters"
class="flag"></span>
category_label_translations:
type: array
description: Category translations
items:
$ref: >-
#/components/schemas/CA11_Response_200_Categories_CategoryLabelTranslations
description:
type: string
description: Category description
description_translations:
type: array
description: Category description translations
items:
$ref: >-
#/components/schemas/CA11_Response_200_Categories_DescriptionTranslations
logistic_class:
type: string
description: Category logistic class
parent_code:
type: string
description: Category parent code
required:
- category_code
- category_label
- category_label_translations
- parent_code
CA11_Response_200_Categories_CategoryLabelTranslations:
type: object
properties:
locale:
type: string
description: Locale
value:
type: string
description: Translation
CA11_Response_200_Categories_DescriptionTranslations:
type: object
properties:
locale:
type: string
description: Locale
value:
type: string
description: Translation
CA11_Response_200_TextCsv:
type: object
properties:
categories:
type: array
description: List of categories
items:
$ref: '#/components/schemas/CA11_Response_200_TextCsv_Categories'
required:
- categories
CA11_Response_200_TextCsv_Categories:
type: object
properties:
category_code:
type: string
description: Category code
category_label:
type: string
description: >-
<span>Category label </span><span title="This field is localized:
its value uses the locale provided in the parameters"
class="flag"></span>
category_label_translations:
type: array
description: Category translations
items:
$ref: >-
#/components/schemas/CA11_Response_200_TextCsv_Categories_CategoryLabelTranslations
description:
type: string
description: Category description
description_translations:
type: array
description: Category description translations
items:
$ref: >-
#/components/schemas/CA11_Response_200_TextCsv_Categories_DescriptionTranslations
logistic_class:
type: string
description: Category logistic class
parent_code:
type: string
description: Category parent code
required:
- category_code
- category_label
- category_label_translations
- parent_code
CA11_Response_200_TextCsv_Categories_CategoryLabelTranslations:
type: object
properties:
locale:
type: string
description: Locale
value:
type: string
description: Translation
CA11_Response_200_TextCsv_Categories_DescriptionTranslations:
type: object
properties:
locale:
type: string
description: Locale
value:
type: string
description: Translation
CG01_Request:
type: object
properties:
customer_groups:
type: array
description: List of customer groups to create or update
items:
$ref: '#/components/schemas/CG01_Request_CustomerGroups'
required:
- customer_groups
CG01_Request_CustomerGroups:
type: object
description: List of customer groups to create or update
properties:
active:
type: boolean
description: Status of the customer group (active or not)
description:
type: string
description: Customer group description
maxLength: 200
id:
type: string
description: Customer group id
maxLength: 36
label:
type: string
description: Customer group label
maxLength: 150
required:
- id
CG01_Response_200:
type: object
properties:
customer_group_errors:
type: array
description: List of customer groups in error
items:
$ref: '#/components/schemas/CG01_Response_200_CustomerGroupErrors'
customer_group_success:
type: array
description: List of customer groups successfully updated or created
items:
$ref: '#/components/schemas/CG01_Response_200_CustomerGroupSuccess'
CG01_Response_200_CustomerGroupErrors:
type: object
properties:
id:
type: string
description: Id of the group in error
message:
type: string
description: Error message
CG01_Response_200_CustomerGroupSuccess:
type: object
properties:
active:
type: boolean
description: Status of the customer group (active or not)
description:
type: string
description: Customer group description
maxLength: 200
id:
type: string
description: Customer group id
maxLength: 36
label:
type: string
description: Customer group label
maxLength: 150
required:
- id
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
CO01_Request:
type: object
properties:
customer_organizations:
type: array
description: Customer Organizations list
items:
$ref: '#/components/schemas/CO01_Request_CustomerOrganizations'
maxItems: 1000
minItems: 1
required:
- customer_organizations
CO01_Request_CustomerOrganizations:
type: object
description: Customer Organizations list
properties:
address:
$ref: '#/components/schemas/CO01_Request_CustomerOrganizations_Address'
description: >-
Address of the customer organization. Required for new
organizations.
id:
type: string
description: Customer organization id (from the operator's system)
maxLength: 50
identification_number:
type: string
description: >-
Number used to identify the customer organization as an established
business in a country. E.g: SIRET number in France, NIF in Spain.
Required for new organizations.
maxLength: 255
name:
type: string
description: Customer organization name. Required for new organizations.
maxLength: 255
tax_identification_number:
type: string
description: Tax identification number of the customer organization
maxLength: 255
required:
- id
CO01_Request_CustomerOrganizations_Address:
type: object
description: Customer organization address
maxLength: 255
properties:
city:
type: string
description: City
maxLength: 255
country_iso_code:
type: string
description: >
Country ISO 3166-1 code of the address
Enum: `"AFG"`, `"ALA"`, `"ALB"`, `"DZA"`, `"ASM"`, `"AND"`, `"AGO"`,
`"AIA"`, `"ATA"`, `"ATG"`, `"ARG"`, `"ARM"`, `"ABW"`, `"AUS"`,
`"AUT"`, `"AZE"`, `"BHS"`, `"BHR"`, `"BGD"`, `"BRB"`, `"BLR"`,
`"BEL"`, `"BLZ"`, `"BEN"`, `"BMU"`, `"BTN"`, `"BOL"`, `"BES"`,
`"BIH"`, `"BWA"`, `"BVT"`, `"BRA"`, `"IOT"`, `"BRN"`, `"BGR"`,
`"BFA"`, `"BDI"`, `"KHM"`, `"CMR"`, `"CAN"`, `"CPV"`, `"CYM"`,
`"CAF"`, `"TCD"`, `"CHL"`, `"CHN"`, `"CXR"`, `"CCK"`, `"COL"`,
`"COM"`, `"COG"`, `"COD"`, `"COK"`, `"CRI"`, `"CIV"`, `"HRV"`,
`"CUB"`, `"CUW"`, `"CYP"`, `"CZE"`, `"DNK"`, `"DJI"`, `"DMA"`,
`"DOM"`, `"ECU"`, `"EGY"`, `"SLV"`, `"GNQ"`, `"ERI"`, `"EST"`,
`"ETH"`, `"FLK"`, `"FRO"`, `"FJI"`, `"FIN"`, `"FRA"`, `"GUF"`,
`"PYF"`, `"ATF"`, `"GAB"`, `"GMB"`, `"GEO"`, `"DEU"`, `"GHA"`,
`"GIB"`, `"GRC"`, `"GRL"`, `"GRD"`, `"GLP"`, `"GUM"`, `"GTM"`,
`"GGY"`, `"GIN"`, `"GNB"`, `"GUY"`, `"HTI"`, `"HMD"`, `"VAT"`,
`"HND"`, `"HKG"`, `"HUN"`, `"ISL"`, `"IND"`, `"IDN"`, `"IRQ"`,
`"IRL"`, `"IMN"`, `"ISR"`, `"ITA"`, `"JAM"`, `"JPN"`, `"JEY"`,
`"JOR"`, `"KAZ"`, `"KEN"`, `"KIR"`, `"KOR"`, `"KWT"`, `"KGZ"`,
`"LAO"`, `"LVA"`, `"LBN"`, `"LSO"`, `"LBR"`, `"LBY"`, `"LIE"`,
`"LTU"`, `"LUX"`, `"MAC"`, `"MKD"`, `"MDG"`, `"MWI"`, `"MYS"`,
`"MDV"`, `"MLI"`, `"MLT"`, `"MHL"`, `"MTQ"`, `"MRT"`, `"MUS"`,
`"MYT"`, `"MEX"`, `"FSM"`, `"MDA"`, `"MCO"`, `"MNG"`, `"MNE"`,
`"MSR"`, `"MAR"`, `"MOZ"`, `"MMR"`, `"NAM"`, `"NRU"`, `"NPL"`,
`"NLD"`, `"NCL"`, `"NZL"`, `"NIC"`, `"NER"`, `"NGA"`, `"NIU"`,
`"NFK"`, `"MNP"`, `"NOR"`, `"OMN"`, `"PAK"`, `"PLW"`, `"PSE"`,
`"PAN"`, `"PNG"`, `"PRY"`, `"PER"`, `"PHL"`, `"PCN"`, `"POL"`,
`"PRT"`, `"PRI"`, `"QAT"`, `"REU"`, `"ROU"`, `"RUS"`, `"RWA"`,
`"BLM"`, `"SHN"`, `"KNA"`, `"LCA"`, `"MAF"`, `"SPM"`, `"VCT"`,
`"WSM"`, `"SMR"`, `"STP"`, `"SAU"`, `"SEN"`, `"SRB"`, `"SYC"`,
`"SLE"`, `"SGP"`, `"SXM"`, `"SVK"`, `"SVN"`, `"SLB"`, `"SOM"`,
`"ZAF"`, `"SGS"`, `"SSD"`, `"ESP"`, `"LKA"`, `"SUR"`, `"SJM"`,
`"SWZ"`, `"SWE"`, `"CHE"`, `"TWN"`, `"TJK"`, `"TZA"`, `"THA"`,
`"TLS"`, `"TGO"`, `"TKL"`, `"TON"`, `"TTO"`, `"TUN"`, `"TUR"`,
`"TKM"`, `"TCA"`, `"TUV"`, `"UGA"`, `"UKR"`, `"ARE"`, `"GBR"`,
`"USA"`, `"UMI"`, `"URY"`, `"UZB"`, `"VUT"`, `"VEN"`, `"VNM"`,
`"VGB"`, `"VIR"`, `"WLF"`, `"YEM"`, `"ZMB"`, `"ZWE"`
state:
type: string
description: State
maxLength: 255
street_1:
type: string
description: Street details 1
maxLength: 255
street_2:
type: string
description: Street details 2
maxLength: 255
zip_code:
type: string
description: Zip code
maxLength: 255
CO01_Response_200:
type: object
properties:
customer_organization_errors:
type: array
description: Customer organization creation errors
items:
$ref: '#/components/schemas/CO01_Response_200_CustomerOrganizationErrors'
customer_organization_success:
type: array
description: Customer organization creation success
items:
$ref: '#/components/schemas/CO01_Response_200_CustomerOrganizationSuccess'
CO01_Response_200_CustomerOrganizationErrors:
type: object
properties:
customer_organization_id:
type: string
description: Customer organization id of the customer organization creation error
message:
type: string
description: Customer organization error creation message
CO01_Response_200_CustomerOrganizationSuccess:
type: object
description: Customer organization information
properties:
address:
$ref: >-
#/components/schemas/CO01_Response_200_CustomerOrganizationSuccess_Address
description: Address of the customer organization
id:
type: string
description: Customer organization id (from the operator's system)
maxLength: 50
identification_number:
type: string
description: >-
Number used to identify the customer organization as an established
business in a country. E.g: SIRET number in France, NIF in Spain.
maxLength: 255
name:
type: string
description: Name of the customer organization
maxLength: 255
tax_identification_number:
type: string
description: Tax identification number of the customer organization
maxLength: 255
required:
- address
- id
- identification_number
- name
- tax_identification_number
CO01_Response_200_CustomerOrganizationSuccess_Address:
type: object
description: Customer organization address
properties:
city:
type: string
description: City
maxLength: 255
country_iso_code:
type: string
description: >
Country ISO 3166-1 code of the address
Enum: `"AFG"`, `"ALA"`, `"ALB"`, `"DZA"`, `"ASM"`, `"AND"`, `"AGO"`,
`"AIA"`, `"ATA"`, `"ATG"`, `"ARG"`, `"ARM"`, `"ABW"`, `"AUS"`,
`"AUT"`, `"AZE"`, `"BHS"`, `"BHR"`, `"BGD"`, `"BRB"`, `"BLR"`,
`"BEL"`, `"BLZ"`, `"BEN"`, `"BMU"`, `"BTN"`, `"BOL"`, `"BES"`,
`"BIH"`, `"BWA"`, `"BVT"`, `"BRA"`, `"IOT"`, `"BRN"`, `"BGR"`,
`"BFA"`, `"BDI"`, `"KHM"`, `"CMR"`, `"CAN"`, `"CPV"`, `"CYM"`,
`"CAF"`, `"TCD"`, `"CHL"`, `"CHN"`, `"CXR"`, `"CCK"`, `"COL"`,
`"COM"`, `"COG"`, `"COD"`, `"COK"`, `"CRI"`, `"CIV"`, `"HRV"`,
`"CUB"`, `"CUW"`, `"CYP"`, `"CZE"`, `"DNK"`, `"DJI"`, `"DMA"`,
`"DOM"`, `"ECU"`, `"EGY"`, `"SLV"`, `"GNQ"`, `"ERI"`, `"EST"`,
`"ETH"`, `"FLK"`, `"FRO"`, `"FJI"`, `"FIN"`, `"FRA"`, `"GUF"`,
`"PYF"`, `"ATF"`, `"GAB"`, `"GMB"`, `"GEO"`, `"DEU"`, `"GHA"`,
`"GIB"`, `"GRC"`, `"GRL"`, `"GRD"`, `"GLP"`, `"GUM"`, `"GTM"`,
`"GGY"`, `"GIN"`, `"GNB"`, `"GUY"`, `"HTI"`, `"HMD"`, `"VAT"`,
`"HND"`, `"HKG"`, `"HUN"`, `"ISL"`, `"IND"`, `"IDN"`, `"IRQ"`,
`"IRL"`, `"IMN"`, `"ISR"`, `"ITA"`, `"JAM"`, `"JPN"`, `"JEY"`,
`"JOR"`, `"KAZ"`, `"KEN"`, `"KIR"`, `"KOR"`, `"KWT"`, `"KGZ"`,
`"LAO"`, `"LVA"`, `"LBN"`, `"LSO"`, `"LBR"`, `"LBY"`, `"LIE"`,
`"LTU"`, `"LUX"`, `"MAC"`, `"MKD"`, `"MDG"`, `"MWI"`, `"MYS"`,
`"MDV"`, `"MLI"`, `"MLT"`, `"MHL"`, `"MTQ"`, `"MRT"`, `"MUS"`,
`"MYT"`, `"MEX"`, `"FSM"`, `"MDA"`, `"MCO"`, `"MNG"`, `"MNE"`,
`"MSR"`, `"MAR"`, `"MOZ"`, `"MMR"`, `"NAM"`, `"NRU"`, `"NPL"`,
`"NLD"`, `"NCL"`, `"NZL"`, `"NIC"`, `"NER"`, `"NGA"`, `"NIU"`,
`"NFK"`, `"MNP"`, `"NOR"`, `"OMN"`, `"PAK"`, `"PLW"`, `"PSE"`,
`"PAN"`, `"PNG"`, `"PRY"`, `"PER"`, `"PHL"`, `"PCN"`, `"POL"`,
`"PRT"`, `"PRI"`, `"QAT"`, `"REU"`, `"ROU"`, `"RUS"`, `"RWA"`,
`"BLM"`, `"SHN"`, `"KNA"`, `"LCA"`, `"MAF"`, `"SPM"`, `"VCT"`,
`"WSM"`, `"SMR"`, `"STP"`, `"SAU"`, `"SEN"`, `"SRB"`, `"SYC"`,
`"SLE"`, `"SGP"`, `"SXM"`, `"SVK"`, `"SVN"`, `"SLB"`, `"SOM"`,
`"ZAF"`, `"SGS"`, `"SSD"`, `"ESP"`, `"LKA"`, `"SUR"`, `"SJM"`,
`"SWZ"`, `"SWE"`, `"CHE"`, `"TWN"`, `"TJK"`, `"TZA"`, `"THA"`,
`"TLS"`, `"TGO"`, `"TKL"`, `"TON"`, `"TTO"`, `"TUN"`, `"TUR"`,
`"TKM"`, `"TCA"`, `"TUV"`, `"UGA"`, `"UKR"`, `"ARE"`, `"GBR"`,
`"USA"`, `"UMI"`, `"URY"`, `"UZB"`, `"VUT"`, `"VEN"`, `"VNM"`,
`"VGB"`, `"VIR"`, `"WLF"`, `"YEM"`, `"ZMB"`, `"ZWE"`
country_iso_code_as_string:
type: string
state:
type: string
description: State
maxLength: 255
street_1:
type: string
description: Street details 1
maxLength: 255
street_2:
type: string
description: Street details 2
maxLength: 255
zip_code:
type: string
description: Zip code
maxLength: 255
CO02_Request:
type: object
properties:
customer_organization_group_associations:
type: array
description: Customer organization / customer groups associations
items:
$ref: >-
#/components/schemas/CO02_Request_CustomerOrganizationGroupAssociations
maxItems: 1000
minItems: 1
required:
- customer_organization_group_associations
CO02_Request_CustomerOrganizationGroupAssociations:
type: object
description: Customer organization / customer groups associations
properties:
customer_group_ids:
type: array
description: List of customer group ids to link to the customer organization
items:
type: string
maxItems: 50
minItems: 0
customer_organization_id:
type: string
description: Customer organization id
required:
- customer_group_ids
- customer_organization_id
CO02_Response_200:
type: object
properties:
customer_organization_group_association_errors:
type: array
items:
$ref: >-
#/components/schemas/CO02_Response_200_CustomerOrganizationGroupAssociationErrors
customer_organization_group_association_success:
type: array
items:
$ref: >-
#/components/schemas/CO02_Response_200_CustomerOrganizationGroupAssociationSuccess
CO02_Response_200_CustomerOrganizationGroupAssociationErrors:
type: object
properties:
customer_group_ids:
type: array
items:
type: string
customer_organization_id:
type: string
message:
type: string
description: Error message
CO02_Response_200_CustomerOrganizationGroupAssociationSuccess:
type: object
properties:
customer_group_ids:
type: array
description: List of customer group ids to link to the customer organization
items:
type: string
maxItems: 50
minItems: 0
customer_organization_id:
type: string
description: Customer organization id
required:
- customer_group_ids
- customer_organization_id
CU01_Request:
type: object
properties:
customers:
type: array
description: A list of customers to create or update
items:
$ref: '#/components/schemas/CU01_Request_Customers'
maxItems: 1000
maxLength: 1000
minItems: 0
required:
- customers
CU01_Request_Customers:
type: object
description: A list of customers to create or update
maxLength: 1000
properties:
civility:
type: string
description: Customer's civility
maxLength: 20
customer_organization_id:
type: string
description: >-
Customer's organization id. Mandatory if corresponding platform
setting requires it.
maxLength: 50
email:
type: string
description: Customer's email (required when creating a new customer)
maxLength: 255
firstname:
type: string
description: Customer's firstname (required when creating a new customer)
maxLength: 255
id:
type: string
description: Customer's id (from the operator system)
maxLength: 50
lastname:
type: string
description: Customer's lastname (required when creating a new customer)
maxLength: 255
locale:
type: string
description: Customer's locale
maxLength: 5
required:
- id
CU01_Response_200:
type: object
properties:
customers_errors:
type: array
description: Ids of customers in error
items:
$ref: '#/components/schemas/CU01_Response_200_CustomersErrors'
customers_success:
type: array
description: List of customers successfully updated or created
items:
$ref: '#/components/schemas/CU01_Response_200_CustomersSuccess'
CU01_Response_200_CustomersErrors:
type: object
properties:
id:
type: string
description: Id of the customer in error
message:
type: string
description: Error message
CU01_Response_200_CustomersSuccess:
type: object
properties:
civility:
type: string
description: Customer's civility
customer_organization_id:
type: string
description: Customer's organization id
email:
type: string
description: Email
firstname:
type: string
description: Customer's firstname
id:
type: string
description: Customer's id (from the operator system)
lastname:
type: string
description: Customer's lastname
locale:
type: string
description: Customer's locale
required:
- id
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
DR07_Request:
type: object
properties:
accounting_documents:
type: array
description: >-
Accounting documents for which you want to confirm payment. 100
documents maximum.
items:
$ref: '#/components/schemas/DR07_Request_AccountingDocuments'
maxItems: 100
minItems: 0
required:
- accounting_documents
DR07_Request_AccountingDocuments:
type: object
description: >-
Accounting documents for which you want to confirm payment. 100
documents maximum.
properties:
amount:
type: number
format: with decimals
description: >-
Amount of the accounting document for which you want to confirm
payment
currency_iso_code:
type: string
description: >
Currency of the accounting document for which you want to confirm
payment
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"`
document_id:
type: string
description: >-
Th
# --- truncated at 32 KB (2696 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/_original/mirakl-mmp-front-openapi.yaml