### GET /api/platform/configuration Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3 Lists platform configurations such as general information, modules and features activated. Represents modules and major features enabled during platform setup. ```APIDOC ## GET /api/platform/configuration ### Description Lists platform configurations such as general information, modules and features activated. ### Method GET ### Endpoint /api/platform/configuration ### Response #### Success Response (200) - **general_info** (object) - General platform information - **modules** (array) - List of activated modules - **features** (array) - List of activated features #### Response Example { "general_info": { "platform_name": "Mirakl Platform" }, "modules": ["catalog", "order"], "features": ["multi_language", "multi_currency"] } ``` -------------------------------- ### GET /api/products Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3.md Get products for a list of product references. ```APIDOC ## GET /api/products ### Description Get products for a list of product references. Returns 100 products maximum. ### Method GET ### Endpoint /api/products ``` -------------------------------- ### GET /api/products Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3 Retrieves a list of products from the marketplace. ```APIDOC ## GET /api/products ### Description Retrieves a list of products available in the marketplace. ### Method GET ### Endpoint /api/products ``` -------------------------------- ### GET /api/products/offers Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers Retrieve a list of offers for a given product. ```APIDOC ## GET /api/products/offers ### Description Retrieves a list of offers for each given product. Recommended for use on product pages. ### Method GET ### Endpoint /api/products/offers ### Parameters #### Query Parameters - **sort** (string) - Optional - Sort fields: bestPrice (default), bestEvaluation. - **locale** (string) - Optional - Localization support. ``` -------------------------------- ### GET /websites/developer_mirakl_content_product Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or11 Retrieves order details and associated information. ```APIDOC ## GET /websites/developer_mirakl_content_product ### Description Retrieves a list of orders with detailed information about each order, including customer data, billing address, and channel specifics. ### Method GET ### Endpoint /websites/developer_mirakl_content_product ### Response #### Success Response (200) (application/json) - **orders** (array, required) - List of orders - **orders.acceptance_decision_date** (string) - The date when the shop decided to accept or refuse the order. Null when the order was automatically refused or accepted. - **orders.can_cancel** (boolean, required) - Indicates if the order can be cancelled. - **orders.can_shop_ship** (boolean, required) - Indicates if shops can or cannot ship orders. - **orders.channel** (object) - The channel of the commercial's order. - **orders.channel.code** (string, required) - Channel code. - **orders.channel.label** (string, required) - Channel label. - **orders.commercial_id** (string, required) - Commercial order's identifier. - **orders.created_date** (string, required) - Order's creation date. - **orders.currency_iso_code** (string, required) - Shop's currency (ISO format). 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" - **orders.customer** (object, required) - Information of the customer who ordered. - **orders.customer.accounting_contact** (object) - Data related to the accounting contact in the organization. Null before shipping (or acceptance, depending on platform setting). - **orders.customer.accounting_contact.civility** (string) - Customer contact's civility. - **orders.customer.accounting_contact.customer_id** (string, required) - Customer contact's identifier. - **orders.customer.accounting_contact.firstname** (string, required) - Customer contact's firstname. - **orders.customer.accounting_contact.lastname** (string, required) - Customer contact's lastname. - **orders.customer.accounting_contact.locale** (string) - Customer contact's locale. - **orders.customer.billing_address** (object, required) - Customer's billing address. Null before shipping (or acceptance, depending on platform setting). - **orders.customer.billing_address.city** (string, required) - Address city. - **orders.customer.billing_address.civility** (string) - Civility of the person associated with the address. - **orders.customer.billing_address.company** (string) - Company of the person associated with the address. - **orders.customer.billing_address.company_2** (string) - Second company information of the person associated with the address. - **orders.customer.billing_address.country** (string, required) - Address country. - **orders.customer.billing_address.country_iso_code** (string, required) - 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" - **orders.customer.billing_address.firstname** (string) - First name of the person associated with the address. - **orders.customer.billing_address.lastname** (string, required) - Last name of the person associated with the address. - **orders.customer.billing_address.phone** (string) - Phone. - **orders.customer.billing_address.phone_secondary** (string) - Phone secondary. #### Response Example ```json { "orders": [ { "acceptance_decision_date": "2023-10-27T10:00:00Z", "can_cancel": true, "can_shop_ship": true, "channel": { "code": "ECOMMERCE", "label": "E-Commerce" }, "commercial_id": "ORD123456", "created_date": "2023-10-26T09:00:00Z", "currency_iso_code": "EUR", "customer": { "accounting_contact": { "civility": "Mr", "customer_id": "CUST987", "firstname": "John", "lastname": "Doe", "locale": "en_US" }, "billing_address": { "city": "Paris", "civility": "Mr", "company": "Example Corp", "company_2": "", "country": "France", "country_iso_code": "FRA", "firstname": "John", "lastname": "Doe", "phone": "+33123456789", "phone_secondary": "" } } } ] } ``` ``` -------------------------------- ### P11 - List offers for each given product Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3.md Retrieves a list of offers associated with specific products. Supports pagination, sorting by various criteria, and localized output. ```APIDOC ## GET /api/products/offers ### Description List offers for each given product. If the "Price approval" option is activated, read this pagePrice prioritization for Advanced PricingAdvanced Pricing in P11Pagination This resource supports offset pagination (see documentation) Sort fields sort field can have the following values:bestPrice (Default) - Sorts by product sku and then by total price, premium information, shop grade (asc by default)bestEvaluation - Sorts by product sku and then by shop grade, total price, premium information (asc by default) Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### Call Frequency Recommended usage: At each product page display Maximum usage: At each product page display ``` -------------------------------- ### GET /api/promotions Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/promotions Retrieves a list of promotions. Supports pagination and sorting by start date, end date, or creation date. ```APIDOC ## GET /api/promotions ### Description Retrieves a list of promotions. This endpoint supports offset pagination and allows sorting by various date fields. ### Method GET ### Endpoint /api/promotions ### Query Parameters - **offset** (integer) - Optional - The number of promotions to skip before starting to collect the result set. - **limit** (integer) - Optional - The maximum number of promotions to return. Defaults to 50. - **sort** (string) - Optional - The field to sort the promotions by. Allowed values: `startDate`, `endDate`, `dateCreated`. Default is `startDate`. - **sort_order** (string) - Optional - The order to sort the promotions. Allowed values: `asc`, `desc`. Default is `desc`. ### Response #### Success Response (200) - **promotions** (array) - A list of promotion objects. - **id** (integer) - The unique identifier of the promotion. - **name** (string) - The name of the promotion. - **startDate** (string) - The start date of the promotion in ISO 8601 format. - **endDate** (string) - The end date of the promotion in ISO 8601 format. - **dateCreated** (string) - The date the promotion was created in ISO 8601 format. #### Response Example { "promotions": [ { "id": 1, "name": "Summer Sale", "startDate": "2023-06-01T00:00:00Z", "endDate": "2023-08-31T23:59:59Z", "dateCreated": "2023-05-15T10:00:00Z" } ] } ``` -------------------------------- ### GET /api/promotions Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/promotions/pr01 Retrieves a list of promotions based on specified filters. Supports offset pagination and sorting by start date, end date, or creation date. ```APIDOC ## GET /api/promotions ### Description Retrieve a list of promotions. Recommended for use on promotion list pages or offer detail pages. ### Method GET ### Endpoint /api/promotions ### Parameters #### Query Parameters - **ids** (string) - Optional - A comma separated list of identifiers for a promotion - **types** (string) - Optional - A comma separated list of types [AMOUNT_OFF|FREE_ITEMS|PERCENTAGE_OFF|REDUCED_UNIT_PRICE] - **states** (string) - Optional - A comma separated list of states [PENDING|ACTIVE|EXPIRED|PENDING_APPROVAL|REJECTED|ALL] - **ending_after** (string) - Optional - Returns promotions which ended or will end after this date - **starting_before** (string) - Optional - Returns promotions which started or will start before this date - **date_created_from** (string) - Optional - Filter promotion creation date lower limit - **date_created_to** (string) - Optional - Filter promotion creation date upper limit - **last_request_date** (string) - Optional - Last request date and time - **locale** (string) - Optional - The locale to filter the medias and the public descriptions - **trigger_offer_ids** (string) - Optional - Promotion-triggering offer ids, separated by commas - **reward_offer_ids** (string) - Optional - Promotion reward offer ids, separated by commas - **channel_codes** (string) - Optional - Channel codes on which promotions apply, separated by commas - **shop_id** (integer) - Optional - Shop identifier ``` -------------------------------- ### POST /api/products/imports Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3 Initiates a product import process. ```APIDOC ## POST /api/products/imports ### Description Initiates a new product import operation. ### Method POST ### Endpoint /api/products/imports ``` -------------------------------- ### GET /api/promotions - List Promotions Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/promotions Retrieves a list of promotions. This endpoint supports offset pagination and sorting by start date, end date, or creation date. ```APIDOC ## GET /api/promotions ### Description Retrieves a list of promotions. Recommended usage is at each display of a promotions list page or on-promo offer detail page. ### Method GET ### Endpoint /api/promotions ### Query Parameters - **offset** (integer) - Optional - The number of promotions to skip. Used for pagination. - **limit** (integer) - Optional - The maximum number of promotions to return. Used for pagination. - **sort** (string) - Optional - The field to sort promotions by. Allowed values: startDate (default), endDate, dateCreated. ### Response #### Success Response (200) - **promotions** (array) - A list of promotion objects. - **id** (integer) - The unique identifier of the promotion. - **name** (string) - The name of the promotion. - **startDate** (string) - The start date of the promotion activity. - **endDate** (string) - The end date of the promotion activity. - **dateCreated** (string) - The date the promotion was created. #### Response Example ```json { "promotions": [ { "id": 1, "name": "Summer Sale", "startDate": "2023-06-01T00:00:00Z", "endDate": "2023-08-31T23:59:59Z", "dateCreated": "2023-05-15T10:00:00Z" } ] } ``` ``` -------------------------------- ### GET /websites/developer_mirakl_content_product Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/products/p51 Retrieves a list of product import tracking information for a given project. ```APIDOC ## GET /websites/developer_mirakl_content_product ### Description Retrieves a list of product import tracking information. ### Method GET ### Endpoint /websites/developer_mirakl_content_product ### Response #### Success Response (200) - **product_import_trackings** (array) - List of product import status information - **product_import_trackings.conversion_options** (object) - Options used for the conversion - **product_import_trackings.conversion_options.ai_enrichment** (object) - Enable AI enrichment - **product_import_trackings.conversion_options.ai_enrichment.status** (string) - Enum: "ENABLED", "DISABLED" - **product_import_trackings.conversion_options.ai_rewrite** (object) - Enable AI rewrite - **product_import_trackings.conversion_options.ai_rewrite.status** (string) - Enum: "ENABLED", "DISABLED" - **product_import_trackings.conversion_options.ai_translation** (object) - Enable AI translation - **product_import_trackings.conversion_options.ai_translation.status** (string) - Enum: "ENABLED", "DISABLED" - **product_import_trackings.conversion_type** (string) - Type of conversion applied on products. Enum: "AI_CONVERTER" - **product_import_trackings.date_created** (string, required) - Import creation date - **product_import_trackings.has_error_report** (boolean, required) - Returns true if error report is available. Value is filled when the import status is COMPLETE. - **product_import_trackings.has_new_product_report** (boolean, required) - Returns true if new product report is available. Value is filled when the import status is COMPLETE. - **product_import_trackings.has_transformation_error_report** (boolean) - Returns true if transformation error report is available. Value is filled when the import status is SENT or COMPLETE. - **product_import_trackings.has_transformed_file** (boolean, required) - Returns true if transformed file is available. Value is filled when the import status is SENT or COMPLETE. - **product_import_trackings.import_id** (integer, required) - Import identifier - **product_import_trackings.import_status** (string, required) - Import status. Enum: "TRANSFORMATION_WAITING", "TRANSFORMATION_RUNNING", "TRANSFORMATION_FAILED", "WAITING", "RUNNING", "SENT", "COMPLETE", "CANCELLED", "FAILED" - **product_import_trackings.integration_details** (object) - Integration details - **product_import_trackings.integration_details.invalid_products** (integer) - Number of invalid products - **product_import_trackings.integration_details.products_not_accepted_in_time** (integer) - Number of products that haven't been accepted in the required time - **product_import_trackings.integration_details.products_not_synchronized_in_time** (integer) - Number of products that haven't been synchronized in the required time - **product_import_trackings.integration_details.products_reimported** (integer) - Number of products that have been reimported in a more recent file - **product_import_trackings.integration_details.products_successfully_synchronized** (integer) - Number of products successfully synchronized on operator system - **product_import_trackings.integration_details.products_with_synchronization_issues** (integer) - Number of products having synchronization issues with operator system - **product_import_trackings.integration_details.products_with_wrong_identifiers** (integer) - Number of products having wrong identifiers - **product_import_trackings.integration_details.rejected_products** (integer) - Number of rejected products by operator system - **product_import_trackings.reason_status** (string) - A message explaining the reason of the import status, if relevant - **product_import_trackings.shop_id** (integer, required) - Shop identifier - **product_import_trackings.transform_lines_in_error** (integer, required) - Total count of transformed lines in error - **product_import_trackings.transform_lines_in_success** (integer, required) - Total count of transformed lines in success - **product_import_trackings.transform_lines_read** (integer, required) - Total count of transformed lines read - **product_import_trackings.transform_lines_with_warning** (integer, required) - Total count of transformed lines with warning - **total_count** (integer, required) - Total count of product import status information #### Response Example { "product_import_trackings": [ { "conversion_options": { "ai_enrichment": { "status": "ENABLED" }, "ai_rewrite": { "status": "DISABLED" }, "ai_translation": { "status": "ENABLED" } }, "conversion_type": "AI_CONVERTER", "date_created": "2023-10-27T10:00:00Z", "has_error_report": true, "has_new_product_report": true, "has_transformation_error_report": false, "has_transformed_file": true, "import_id": 12345, "import_status": "COMPLETE", "integration_details": { "invalid_products": 0, "products_not_accepted_in_time": 0, "products_not_synchronized_in_time": 0, "products_reimported": 0, "products_successfully_synchronized": 100, "products_with_synchronization_issues": 0, "products_with_wrong_identifiers": 0, "rejected_products": 0 }, "reason_status": "Import completed successfully.", "shop_id": 1, "transform_lines_in_error": 0, "transform_lines_in_success": 100, "transform_lines_read": 100, "transform_lines_with_warning": 0 } ], "total_count": 1 } ``` -------------------------------- ### GET /websites/developer_mirakl_content_product Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of21 Retrieves product and offer details, including pricing information. ```APIDOC ## GET /websites/developer_mirakl_content_product ### Description Retrieves detailed information about products and their associated offers, including various pricing structures and availability. ### Method GET ### Endpoint /websites/developer_mirakl_content_product ### Response #### Success Response (200) - **offers** (array, required) - Offers for a shop - **offers.active** (boolean, required) - Is the offer active - **offers.all_prices** (array, required) - All prices for the offer For Dropship specifically: the list of purchasing prices of the offer, also referred to as costs or wholesale prices - **offers.all_prices.context** (object) - The context is not returned for default prices. - **offers.all_prices.context.channel_codes** (array) - The channel codes on which a specific price applies. - **offers.all_prices.context.customer_group_ids** (array) - The customer group ids on which a specific price applies. - **offers.all_prices.context.customer_organization_ids** (array) - The customer organization ids on which a specific price applies. - **offers.all_prices.context.end_date** (string) - The end date of a specific price. - **offers.all_prices.context.start_date** (string) - The start date of a specific price. - **offers.all_prices.discount_end_date** (string) - End date of the discount, or null if no discount exists or if the discount does not have an end date. - **offers.all_prices.discount_start_date** (string) - Start date of the discount, or null if no discount exists or if the discount does not have a start date. - **offers.all_prices.price** (number, required) - Price of the offer. For Dropship specifically: the purchasing price of the offer If a discount is defined and is currently active (within the validity interval), it represents the unit_discount_price. In other cases, it represents the unit_origin_price. - **offers.all_prices.unit_discount_price** (number) - Discount price for a quantity of one, i.e. the discount price for a quantity of one. For Dropship specifically: the discount purchasing price for a quantity of one Set to null if no discount is defined or if no discount price for a quantity of one is defined. - **offers.all_prices.unit_origin_price** (number, required) - Original price for a quantity of one, i.e. the price for a quantity of one regardless of the discounts. For Dropship specifically: the purchasing price for a quantity of one, also referred to as cost or wholesale price - **offers.all_prices.volume_prices** (array, required) - Volume prices for each quantity threshold. Returns at least the price for a quantity threshold of one. - **offers.all_prices.volume_prices.price** (number, required) - Price of the offer. If the discount is currently active, it represents the unit discount price. Otherwise it is the original price. - **offers.all_prices.volume_prices.quantity_threshold** (integer, required) - Quantity threshold of this price range - **offers.all_prices.volume_prices.unit_discount_price** (number, required) - Unit discount price for this quantity threshold - **offers.all_prices.volume_prices.unit_origin_price** (number, required) - Unit price for this quantity threshold - **offers.all_prices.channel_code** (string) - Single Channel Pricing users: The channel code on which a specific price applies. This is the pricing_channel_code supplied as input in the API if prices are defined for this channel. If no pricing is defined for this channel, or no pricing_channel_code is supplied, it falls back on the default prices. channel_code is set to null for the default prices. Multi Channel Pricing users: returned null. Refer to context > channel_codes in order to retrieve the channel codes for which the price apply. - **offers.allow_quote_requests** (boolean) - Whether the offer is eligible for quotation - **offers.applicable_pricing** (object) - Pricing defined for the offer, including the prices for the selected channel if available For Dropship specifically: the list of applicable purchasing prices of the offer, also referred to as costs or wholesale prices. - **offers.applicable_pricing.context** (object) - The context is not returned for default prices. - **offers.applicable_pricing.context.channel_codes** (array) - The channel codes on which a specific price applies. - **offers.applicable_pricing.context.customer_group_ids** (array) - The customer group ids on which a specific price applies. - **offers.applicable_pricing.context.customer_organization_ids** (array) - The customer organization ids on which a specific price applies. - **offers.applicable_pricing.context.end_date** (string) - The end date of a specific price. - **offers.applicable_pricing.context.start_date** (string) - The start date of a specific price. - **offers.applicable_pricing.discount_end_date** (string) - End date of the discount, or null if no discount exists or if the discount does not have an end date. - **offers.applicable_pricing.discount_start_date** (string) - Start date of the discount, or null if no discount exists or if the discount does not have a start date. - **offers.applicable_pricing.price** (number, required) - Price of the offer. ``` -------------------------------- ### GET /api/promotions - List Promotions Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/promotions.md Retrieves a list of promotions. This endpoint supports offset pagination and can be sorted by start date, end date, or date created. Recommended for use on promotion list pages and offer detail pages. ```APIDOC ## GET /api/promotions ### Description Retrieves a list of promotions. This endpoint supports offset pagination and can be sorted by start date, end date, or date created. ### Method GET ### Endpoint /api/promotions ### Query Parameters - **offset** (integer) - Optional - The number of records to skip for pagination. - **limit** (integer) - Optional - The maximum number of records to return. - **sort** (string) - Optional - The field to sort the results by. Allowed values: `startDate` (default), `endDate`, `dateCreated`. - **sort_order** (string) - Optional - The order to sort the results. Allowed values: `asc`, `desc` (default). ### Response #### Success Response (200) - **promotions** (array) - A list of promotion objects. - **id** (integer) - The unique identifier of the promotion. - **name** (string) - The name of the promotion. - **startDate** (string) - The start date of the promotion (ISO 8601 format). - **endDate** (string) - The end date of the promotion (ISO 8601 format). - **dateCreated** (string) - The date the promotion was created (ISO 8601 format). #### Response Example { "promotions": [ { "id": 1, "name": "Summer Sale", "startDate": "2023-06-01T00:00:00Z", "endDate": "2023-08-31T23:59:59Z", "dateCreated": "2023-05-15T10:00:00Z" } ] } ``` -------------------------------- ### GET /api/shipping/configuration/shop Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings.md Get shop shipping configuration. ```APIDOC ## GET /api/shipping/configuration/shop ### Description Get shop shipping configuration. ### Method GET ### Endpoint /api/shipping/configuration/shop ``` -------------------------------- ### GET /products Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/offers/p11 Retrieves a list of products including their category information, measurements, and detailed offer pricing data. ```APIDOC ## GET /products ### Description Retrieves a list of products with their associated offers, including pricing details, volume thresholds, and context-specific channel information. ### Method GET ### Endpoint /products ### Response #### Success Response (200) - **products** (array) - List of products information with their offers - **products.category_code** (string) - Code of the product category - **products.category_label** (string) - Label of the product category - **products.measurement** (object) - Measurement of the product - **products.measurement.total_measurement_of_product** (number) - Product total measurement - **products.measurement.unit** (string) - Product measurement unit - **products.offers** (array) - List of offers for the product - **products.offers.active** (boolean) - Is the offer active - **products.offers.all_prices** (array) - All prices for the offer - **products.offers.all_prices.price** (number) - Price of the offer - **products.offers.all_prices.unit_discount_price** (number) - Discount price for a quantity of one - **products.offers.all_prices.unit_origin_price** (number) - Original price for a quantity of one - **products.offers.all_prices.volume_prices** (array) - Volume prices for each quantity threshold - **products.offers.all_prices.volume_prices.price** (number) - Price of the offer - **products.offers.all_prices.volume_prices.quantity_threshold** (integer) - Quantity threshold of this price range - **products.offers.all_prices.volume_prices.unit_discount_price** (number) - Unit discount price for this quantity threshold - **products.offers.all_prices.volume_prices.unit_origin_price** (number) - Unit price for this quantity threshold ``` -------------------------------- ### Platform Settings - List All Custom Fields Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3.md Lists all custom fields available on the platform. Supports locale parameter for localized output. ```APIDOC ## GET /api/additional_fields ### Description Lists all custom fields available on the platform. This resource supports the `locale` parameter for localized output. ### Method GET ### Endpoint /api/additional_fields ### Parameters #### Query Parameters - **locale** (string) - Optional - The locale for localized field names (e.g., 'en_US'). ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **custom_fields** (array) - A list of custom field objects, each with properties like `field_id`, `field_name`, `field_type`, and potentially localized names. #### Response Example { "example": "{ \"custom_fields\": [ { \"field_id\": 1, \"field_name\": \"Custom Field 1\", \"field_type\": \"text\" } ] }" } ``` -------------------------------- ### GET /websites/developer_mirakl_content_product Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/p51 Retrieves a list of product import tracking information for a given shop. ```APIDOC ## GET /websites/developer_mirakl_content_product ### Description Retrieves a list of product import tracking information. ### Method GET ### Endpoint /websites/developer_mirakl_content_product ### Query Parameters - **shop_id** (integer) - Required - The identifier of the shop. ### Response #### Success Response (200) - **product_import_trackings** (array) - List of product import status information. - **product_import_trackings.conversion_options** (object) - Options used for the conversion. - **product_import_trackings.conversion_options.ai_enrichment** (object) - Enable AI enrichment. - **product_import_trackings.conversion_options.ai_enrichment.status** (string) - Enum: "ENABLED", "DISABLED" - **product_import_trackings.conversion_options.ai_rewrite** (object) - Enable AI rewrite. - **product_import_trackings.conversion_options.ai_rewrite.status** (string) - Enum: "ENABLED", "DISABLED" - **product_import_trackings.conversion_options.ai_translation** (object) - Enable AI translation. - **product_import_trackings.conversion_options.ai_translation.status** (string) - Enum: "ENABLED", "DISABLED" - **product_import_trackings.conversion_type** (string) - Type of conversion applied on products. Enum: "AI_CONVERTER" - **product_import_trackings.date_created** (string, required) - Import creation date. - **product_import_trackings.has_error_report** (boolean, required) - Returns true if error report is available. Value is filled when the import status is COMPLETE. - **product_import_trackings.has_new_product_report** (boolean, required) - Returns true if new product report is available. Value is filled when the import status is COMPLETE. - **product_import_trackings.has_transformation_error_report** (boolean) - Returns true if transformation error report is available. Value is filled when the import status is SENT or COMPLETE. - **product_import_trackings.has_transformed_file** (boolean, required) - Returns true if transformed file is available. Value is filled when the import status is SENT or COMPLETE. - **product_import_trackings.import_id** (integer, required) - Import identifier. - **product_import_trackings.import_status** (string, required) - Import status. Enum: "TRANSFORMATION_WAITING", "TRANSFORMATION_RUNNING", "TRANSFORMATION_FAILED", "WAITING", "RUNNING", "SENT", "COMPLETE", "CANCELLED", "FAILED" - **product_import_trackings.integration_details** (object) - Integration details. - **product_import_trackings.integration_details.invalid_products** (integer) - Number of invalid products. - **product_import_trackings.integration_details.products_not_accepted_in_time** (integer) - Number of products that haven't been accepted in the required time. - **product_import_trackings.integration_details.products_not_synchronized_in_time** (integer) - Number of products that haven't been synchronized in the required time. - **product_import_trackings.integration_details.products_reimported** (integer) - Number of products that have been reimported in a more recent file. - **product_import_trackings.integration_details.products_successfully_synchronized** (integer) - Number of products successfully synchronized on operator system. - **product_import_trackings.integration_details.products_with_synchronization_issues** (integer) - Number of products having synchronization issues with operator system. - **product_import_trackings.integration_details.products_with_wrong_identifiers** (integer) - Number of products having wrong identifiers. - **product_import_trackings.integration_details.rejected_products** (integer) - Number of rejected products by operator system. - **product_import_trackings.reason_status** (string) - A message explaining the reason of the import status, if relevant. - **product_import_trackings.shop_id** (integer, required) - Shop identifier. - **product_import_trackings.transform_lines_in_error** (integer, required) - Total count of transformed lines in error. - **product_import_trackings.transform_lines_in_success** (integer, required) - Total count of transformed lines in success. - **product_import_trackings.transform_lines_read** (integer, required) - Total count of transformed lines read. - **product_import_trackings.transform_lines_with_warning** (integer, required) - Total count of transformed lines with warning. - **total_count** (integer, required) - Total count of product import status information. #### Response Example { "product_import_trackings": [ { "conversion_options": { "ai_enrichment": { "status": "ENABLED" }, "ai_rewrite": { "status": "DISABLED" }, "ai_translation": { "status": "ENABLED" } }, "conversion_type": "AI_CONVERTER", "date_created": "2023-10-27T10:00:00Z", "has_error_report": true, "has_new_product_report": true, "has_transformation_error_report": false, "has_transformed_file": true, "import_id": 12345, "import_status": "COMPLETE", "integration_details": { "invalid_products": 0, "products_not_accepted_in_time": 0, "products_not_synchronized_in_time": 0, "products_reimported": 0, "products_successfully_synchronized": 100, "products_with_synchronization_issues": 0, "products_with_wrong_identifiers": 0, "rejected_products": 0 }, "reason_status": "Import completed successfully.", "shop_id": 1, "transform_lines_in_error": 0, "transform_lines_in_success": 100, "transform_lines_read": 100, "transform_lines_with_warning": 0 } ], "total_count": 1 } ``` -------------------------------- ### GET /api/offers/pricing/imports Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers Get information and statistics about an offer pricing import. ```APIDOC ## GET /api/offers/pricing/imports ### Description Retrieve information and statistics regarding a specific offer pricing import. ### Method GET ### Endpoint /api/offers/pricing/imports ### Parameters #### Query Parameters - **sort** (string) - Optional - Sort field: dateCreated (default). ``` -------------------------------- ### GET /api/account/statistics - Get Shop Statistics Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/stores Retrieves statistics for the seller's shop. Recommended usage is once per day. ```APIDOC ## GET /api/account/statistics ### Description Retrieves statistics for the seller's shop. ### Method GET ### Endpoint /api/account/statistics ### Parameters None ### Request Example None ### Response #### Success Response (200) - **statistics** (object) - Contains various statistics for the shop. #### Response Example { "statistics": { "total_sales": 1500, "average_order_value": 75, "number_of_orders": 20 } } ``` -------------------------------- ### GET /offers Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of21 Retrieves a list of product offers including their SKU, pricing, warehouse availability, and discount information. ```APIDOC ## GET /offers ### Description Retrieves product offer details including shop SKU, state code, pricing, and warehouse inventory breakdown. ### Method GET ### Endpoint /offers ### Response #### Success Response (200) - **offers.shop_sku** (string) - The offer's shop SKU - **offers.state_code** (string) - Offer condition - **offers.total_price** (number) - Total price of the offer (price + minimum shipping rate) - **offers.warehouses** (array) - The breakdown of the available quantities of the offer in each warehouse - **offers.warehouses.code** (string) - The code of the warehouse - **offers.warehouses.quantity** (integer) - The available quantity of the offer for the warehouse - **offers.discount** (object) - Discount of the offer - **offers.discount.discount_price** (number) - Discount price - **offers.discount.end_date** (string) - Discount end date - **offers.discount.origin_price** (number) - Origin price - **offers.discount.ranges** (array) - Discount ranges - **offers.discount.ranges.price** (number) - Price of the offer if the quantity threshold is reached - **offers.discount.ranges.quantity_threshold** (integer) - Minimum quantity to order for the given price to be applied - **offers.discount.start_date** (string) - Discount start date - **total_count** (integer) - Offer total count ``` -------------------------------- ### GET /api/account - Get Shop Information Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/stores Retrieves information about the seller's shop. Recommended usage is once per day. ```APIDOC ## GET /api/account ### Description Retrieves information about the seller's shop. ### Method GET ### Endpoint /api/account ### Parameters None ### Request Example None ### Response #### Success Response (200) - **shop_info** (object) - Contains detailed shop information. #### Response Example { "shop_info": { "shop_id": 123, "shop_name": "Example Shop", "contact_email": "contact@example.com" } } ``` -------------------------------- ### GET /websites/developer_mirakl_content_product Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/messages/m11 Retrieves developer content and product information. The 'no_store_reply_needed' actions are present if the 'with_messages' query parameter is set to true. ```APIDOC ## GET /websites/developer_mirakl_content_product ### Description Retrieves developer content and product information. The 'no_store_reply_needed' actions are present if the 'with_messages' query parameter is set to true. ### Method GET ### Endpoint /websites/developer_mirakl_content_product ### Query Parameters - **with_messages** (boolean) - Optional - If set to true, includes 'no_store_reply_needed' actions. ### Response #### Success Response (200) - **data.no_store_reply_needed.date** (string) - No store reply needed action date - **data.no_store_reply_needed.user_type** (string) - Entity that operated "no store reply needed" action. Enum: "OPERATOR", "SHOP" - **data.topic** (object) - Thread topic - **data.topic.type** (string) - Topic type. Enum: "FREE_TEXT", "REASON_CODE" - **data.topic.value** (string) - Topic value - **next_page_token** (string) - Token to access the next page. Absent if the current page is the last one. - **previous_page_token** (string) - Token to access the previous page. Absent if the current page is the first one. #### Response Example { "data": { "no_store_reply_needed": { "date": "2023-10-27T10:00:00Z", "user_type": "OPERATOR" }, "topic": { "type": "FREE_TEXT", "value": "Inquiry about product availability" } }, "next_page_token": "next123", "previous_page_token": "prev456" } ```