### GET /api/products/attributes Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/products.md Get the product attribute configuration. ```APIDOC ## GET /api/products/attributes ### Description Retrieves all attributes for parents and children of the requested hierarchy. ### Method GET ### Endpoint /api/products/attributes ``` -------------------------------- ### GET /api/offers Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3.md List offers of a shop. ```APIDOC ## GET /api/offers ### Description List offers of a shop. ### Method GET ### Endpoint /api/offers ``` -------------------------------- ### GET /api/picklists Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3.md Retrieves a list of picklists. ```APIDOC ## GET /api/picklists ### Description Retrieves a list of picklists. This resource supports seek pagination. ### Method GET ### Endpoint /api/picklists ### Parameters #### Query Parameters - **sort** (string) - Optional - Sort field. Values: pickupDate (Default). ``` -------------------------------- ### GET /api/products/imports/{import} Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3.md Get the import status for a product import. ```APIDOC ## GET /api/products/imports/{import} ### Description Get the import status for a specific product import. ### Method GET ### Endpoint /api/products/imports/{import} ### Parameters #### Path Parameters - **import** (string) - Required - The import identifier ``` -------------------------------- ### GET /api/offers/imports/{import} Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3.md Get information and statistics about a specific offer import. ```APIDOC ## GET /api/offers/imports/{import} ### Description Get information and statistics about a specific offer import. ### Method GET ### Endpoint /api/offers/imports/{import} ### Parameters #### Path Parameters - **import** (string) - Required - The import identifier. ``` -------------------------------- ### GET /api/products/offers Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/offers.md Lists offers associated with specific products. ```APIDOC ## GET /api/products/offers ### Description List offers for each given product. This resource supports offset pagination and locale parameters. ### Method GET ### Endpoint /api/products/offers ``` -------------------------------- ### GET /api/offers/pricing/imports Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers.md Get information and statistics about an offer pricing import. ```APIDOC ## GET /api/offers/pricing/imports ### Description Retrieve information and statistics regarding offer pricing imports. This resource supports seek pagination and sorting by dateCreated. ### Method GET ### Endpoint /api/offers/pricing/imports ``` -------------------------------- ### GET /api/account Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/stores.md Retrieves shop information. ```APIDOC ## GET /api/account ### Description Retrieves shop information. ### Method GET ### Endpoint /api/account ``` -------------------------------- ### GET /api/offers/{offer} Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/offers.md Retrieves detailed information about a specific offer. ```APIDOC ## GET /api/offers/{offer} ### Description Get information about an offer. Recommended usage is at each offer page display. ### Method GET ### Endpoint /api/offers/{offer} ### Parameters #### Path Parameters - **offer** (string) - Required - The identifier of the offer. ``` -------------------------------- ### GET /dynamic-url/OF54 Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3.md Retrieve offer files once asynchronous offer export is complete. ```APIDOC ## GET /dynamic-url/OF54 ### Description Retrieve each chunk of an offer export file via the URL generated once the asynchronous offer export is complete. ### Method GET ### Endpoint /dynamic-url/{url_from_OF53}/OF54 ``` -------------------------------- ### POST /api/products/imports Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/products/p41 Imports a product file to the operator information system and returns an import identifier. ```APIDOC ## POST /api/products/imports ### Description Imports a product file to the operator information system. Returns the import identifier to track the status of the import. ### Method POST ### Endpoint /api/products/imports ### Parameters #### Request Body (multipart/form-data) - **file** (string) - Required - Import file (CSV or XML or XLSX) to upload. - **shop** (integer) - Required - Shop identifier. - **operator_format** (boolean) - Optional - Force the use of the operator product format. - **conversion_type** (string) - Optional - Product file conversion type (Enum: "AI_CONVERTER", "STANDARD"). - **conversion_options** (object) - Optional - Options used for product file conversion when conversion_type is AI_CONVERTER. - **ai_enrichment.status** (string) - Optional - Enable AI enrichment (Enum: "ENABLED", "DISABLED"). - **ai_rewrite.status** (string) - Optional - Enable AI rewrite (Enum: "ENABLED", "DISABLED"). - **ai_translation.status** (string) - Optional - Enable AI translation (Enum: "ENABLED", "DISABLED"). ### Response #### Success Response (201) - **import_id** (integer) - Import identifier ``` -------------------------------- ### GET /api/products/imports Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/products.md Get information about product import statuses. ```APIDOC ## GET /api/products/imports ### Description Get information about product import statuses. If the last_request_date param is not set the api returns all product imports. ### Method GET ### Endpoint /api/products/imports ``` -------------------------------- ### GET /api/products Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/products/p31 Retrieves a list of products based on provided product references. ```APIDOC ## GET /api/products ### Description Retrieves a list of products based on a list of product references. This resource returns a maximum of 100 products, sorted by product SKU, identifier type, and identifier. ### Method GET ### Endpoint /api/products ### Parameters #### Query Parameters - **product_references** (string) - Required - List of the product's identifiers with type (structure: "product_references=type|value,type|value, ..."). Note: SHOP_SKU or SKU are invalid types. - **products** (string) - Optional - List of the product's identifiers with type (structure: "products=type|value,type|value, ..."). Note: SHOP_SKU or SKU are invalid types. ### Response #### Success Response (200) - **products** (array) - List of products - **products.authorized_shop_ids** (array) - List of shop IDs allowed to sell the product - **products.category_code** (string) - Product category code - **products.category_label** (string) - Product category label - **products.product_id** (string) - Product ID - **products.product_id_type** (string) - Product ID type - **products.product_sku** (string) - Product SKU - **products.product_title** (string) - Product title - **total_count** (integer) - Total count of products ``` -------------------------------- ### POST /api/promotions Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/promotions.md Creates a new promotion. ```APIDOC ## POST /api/promotions ### Description Creates a new promotion in the system. ### Method POST ### Endpoint /api/promotions ``` -------------------------------- ### GET /api/platform/configuration Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/platform-settings/pc01 Retrieves the current platform configuration, including activated features and module settings. ```APIDOC ## GET /api/platform/configuration ### Description List platform configurations such as general information, modules and features activated. ### Method GET ### Endpoint /api/platform/configuration ### Response #### Success Response (200) - **features** (object) - Features activated on the platform - **features.catalog** (object) - Catalog related features - **features.catalog.allow_shop_contribution_to_all_channels** (boolean) - Allows shops to contribute data to all sales channels when enabled - **features.catalog.exclude_invalid_products** (boolean) - When enabled, products with validation errors will be excluded from product imports - **features.catalog.list_of_multiple_values_separator** (string) - Character used to separate values in the 'Multiple Values List' type attributes - **features.catalog.product_acceptance_by_channel** (boolean) - Allows operators to accept or reject products according to sales channels - **features.catalog.product_data_validation_by_channel** (boolean) - Facilitates the management of attributes in a multilingual context - **features.catalog.product_import_only_on_leaf** (boolean) - Prevents the import of products into non-leaf categories - **features.circular_economy_data_collection** (boolean) - Allows operators to collect data related to the circular economy regulation - **features.competitive_pricing_tool** (boolean) - The competitive pricing tool allows stores to view and possibly match competing Marketplace offers - **features.direct_payment_customer_store** (object) - Allows transactions taking place outside of Mirakl between customers and sellers - **features.direct_payment_customer_store.activated** (boolean) - Direct payment customer store activated - **features.direct_payment_customer_store.refund_cancel_authorized** (boolean) - Allows refund and cancelation for transactions taking place outside of Mirakl - **features.disable_seller_alternative_carrier** (boolean) - Prevent stores from specifying alternatives carriers outside those predefined by the operator - **features.dropship** (object) - Dropship related features - **features.dropship.retail_pricing_edition_enabled** (string) - Retail pricing edition enabled (Enum: "YES", "NO", "YES_PER_STORE") - **features.dropship.retail_pricing_enabled** (boolean) - Retail pricing activated on dropship offers - **features.kyc_status_per_seller** (boolean) - Allows PSPs to provide operators with seller KYC statuses - **features.lead_time_to_ship_by_sellers_enabled** (string) - Allows sellers to override the default lead time to ship (Enum: "YES", "NO", "YES_PER_STORE") - **features.multi_currency** (boolean) - Defines if platform support multi currencies - **features.multi_payout_psp_per_seller** (boolean) - Allows the operator to use Hybrid pay-out PSP feature - **features.no_reply_needed** (boolean) - Allows to end order-related conversations when the last message sent from customer does not specifically require a reply - **features.offer_prices_decimals** (string) - Defines maximum number of decimals in offer prices - **features.operator_csv_delimiter** (string) - The delimiter used in the CSV files exported from the back office (Enum: "COMMA", "SEMICOLON") - **features.order_conditions** (object) - Order conditions related features activated - **features.order_conditions.maximum_order_quantity** (boolean) - Allows sellers to request for a maximum order quantity - **features.order_conditions.minimum_order_quantity** (boolean) - Allows sellers to request for a minimum order quantity - **features.order_conditions.package_order_quantity** (boolean) - Allows sellers to set an order quantity increment - **features.order_conditions.lead_time_to_ship** (boolean) - Allows sellers to inform a lead time to ship on their offers - **features.order_tax_mode** (string) - Prices with tax included or excluded in order-related APIs (Enum: "TAX_INCLUDED", "TAX_EXCLUDED") - **features.order_workflows** (object) - Order workflows activated ``` -------------------------------- ### GET /api/picklists Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/picklists.md Retrieves a list of picklists. Recommended usage is every 15 minutes, with a maximum frequency of every 5 minutes. ```APIDOC ## GET /api/picklists ### Description Retrieves a list of picklists. This resource supports seek pagination and sorting. ### Method GET ### Endpoint /api/picklists ### Parameters #### Query Parameters - **sort** (string) - Optional - Sort field. Available values: pickupDate (Default). Sorts by pickup date (asc by default). ``` -------------------------------- ### POST /api/offers/imports Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of01 Uploads an offer import file to create, update, or delete offers. ```APIDOC ## POST /api/offers/imports ### Description Returns the import identifier to track the status of the import. Recommended usage is every 5 minutes for offers only, or every hour for offers and products, per seller. ### Method POST ### Endpoint /api/offers/imports ### Parameters #### Request Body (multipart/form-data) - **file** (string) - Required - Import file (CSV or XML or XLSX) to upload. - **import_mode** (string) - Required - Enum: "NORMAL", "REPLACE". - **operator_format** (boolean) - Optional - Force the use of the operator product format. - **shop** (integer) - Required - Shop Identifier. - **with_products** (boolean) - Optional - This file also contains product information. ### Response #### Success Response (201) - **import_id** (integer) - Offer import identifier. If Mirakl detects a duplicate import request, the API will return the import_id of the existing import. - **product_import_id** (integer) - Product import identifier. ``` -------------------------------- ### POST /api/offers/stock/imports Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/sto01 Import a .csv file to update stock for offers, either globally or per warehouse. ```APIDOC ## POST /api/offers/stock/imports ### Description Import a .csv file to update stock for offers, either globally or per warehouse. Returns an import identifier to track the status of the import. ### Method POST ### Endpoint /api/offers/stock/imports ### Parameters #### Request Body (multipart/form-data) - **file** (string) - Required - Import CSV file to upload. - **shop_id** (integer) - Required - Shop Identifier ### Response #### Success Response (201) - **import_id** (string) - Offer stock import identifier ``` -------------------------------- ### GET /api/shipping/logistic_classes Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3.md Retrieves a list of all logistic classes. ```APIDOC ## GET /api/shipping/logistic_classes ### Description List all logistic classes. Results are sorted by index, set in the back-office. ### Method GET ### Endpoint /api/shipping/logistic_classes ``` -------------------------------- ### GET /api/channels Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/platform-settings/ch11 Retrieves a list of all enabled channels. ```APIDOC ## GET /api/channels ### Description Retrieves a list of all enabled channels. Results are sorted by channel code. ### Method GET ### Endpoint /api/channels ### Response #### Success Response (200) - **channels** (array) - List of channels - **channels.code** (string) - Channel code - **channels.description** (string) - Channel description - **channels.label** (string) - Channel label ``` -------------------------------- ### PUT /api/shipments/ready_for_pick_up Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/multiple-shipments.md Validates shipments as ready to pick up. Limited to 1000 shipments at a time. ```APIDOC ## PUT /api/shipments/ready_for_pick_up ### Description Validates shipments as ready to pick up. Limited to 1000 shipments at a time. ``` -------------------------------- ### GET /api/products/imports/{import}/new_product_report Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/products/p45 Retrieves the integration report file for a specific product import. ```APIDOC ## GET /api/products/imports/{import}/new_product_report ### Description This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled) for a specific product import. ### Method GET ### Endpoint /api/products/imports/{import}/new_product_report ### Parameters #### Path Parameters - **import** (integer) - Required - Import identifier ``` -------------------------------- ### GET /api/offers/export Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/offers.md Synchronous export of offers (Deprecated). ```APIDOC ## GET /api/offers/export ### Description Get a CSV file that includes the offers updated and deleted since the last request date. This endpoint is deprecated; please use the asynchronous export APIs instead. ### Method GET ### Endpoint /api/offers/export ``` -------------------------------- ### GET /api/shipping/types Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/sh12 Retrieves a list of all active shipping methods. ```APIDOC ## GET /api/shipping/types ### Description List all active shipping methods. Results are sorted by index, as set in the back-office. ### Method GET ### Endpoint /api/shipping/types ### Response #### Success Response (200) - **shipping_types** (array) - List of shipping types - **shipping_types.click_and_collect** (boolean) - Shipping type corresponds to “click&collect” - **shipping_types.code** (string) - Shipping type code - **shipping_types.delivery_by_operator** (boolean) - Shipping type is managed by operator on behalf of shops - **shipping_types.description** (string) - Shipping type description - **shipping_types.ignore_lead_time_to_ship** (boolean) - When true, the lead time to ship is ignored for shipping deadline computation - **shipping_types.label** (string) - Shipping type label - **shipping_types.mandatory_tracking** (boolean) - Shops must provide tracking details before confirming shipment for a given shipping type - **shipping_types.standard_code** (string) - Shipping type standard code ``` -------------------------------- ### GET /dynamic-url/The+URL+is+retrieved+from+OF53+output/OF54 Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/offers/of54 Retrieve each chunk of an offer export file via the URL generated once the asynchronous offer export is complete. ```APIDOC ## GET /dynamic-url/The+URL+is+retrieved+from+OF53+output/OF54 ### Description Retrieve each chunk of an offer export file via the URL generated once the asynchronous offer export is complete. ### Method GET ### Endpoint /dynamic-url/The+URL+is+retrieved+from+OF53+output/OF54 ### Parameters #### Path Parameters - **tracking_id** (string) - Required - The asynchronous offer export id ### Response #### Success Response (200) - **active** (boolean) - Indicates if the offer is active or inactive - **allow_quote_requests** (boolean) - Allow customers to request quotes on this offer - **available_end_date** (string) - The date when the offer will be deactivated - **available_start_date** (string) - The date when the offer will be activated - **channels** (array) - List of channel codes on which the offer can be sold - **currency_iso_code** (string) - ISO code of the currency - **date_created** (string) - Date and time of the offer creation - **deleted** (boolean) - Indicates whether the offer exists or is deleted - **description** (string) - Offer description - **eco_contributions** (array) - Eco-contributions of the offer - **eco_contributions.eco_contribution_amount** (number) - List of eco-contribution amounts - **eco_contributions.epr_category_code** (string) - Required - Extended Producer Responsibility (EPR) category code - **eco_contributions.producer_id** (string) - List of producer identifiers - **favorite_rank** (integer) - If present, indicates that the offer is a favorite offer ranked - **fulfillment** (object) - The fulfillment information tied to the offer - **fulfillment.center** (object) - The fulfillment center - **fulfillment.center.code** (string) - Code of the fullfilment center - **is_professional** (boolean) - Indicates if the store is professional or not - **last_updated** (string) - Date and time of the last update of the offer - **leadtime_to_ship** (integer) - The lead time to ship corresponding to the offer - **logistic_class** (object) - The logistic class associated to the offer - **logistic_class.code** (string) - Code for the logistic class linked to the offer - **max_order_quantity** (integer) - The maximum order quantity customers must select - **measurement** (object) - Measurement of the product - **measurement.total_measurement_of_product** (number) - The product measurement - **measurement.unit** (string) - The product unit - **min_order_quantity** (integer) - The minimum order quantity customers must select - **min_shipping_price** (number) - Minimum shipping charges for the offer - **min_shipping_price_additional** (number) - Additional shipping charges for the offer - **min_shipping_type** (string) - Shipping method with the minimum shipping charges - **min_shipping_zone** (string) - Shipping zone with the minimum shipping charges - **model** (string) - The platform model of the seller account - **msrp** (number) - The retail price recommendation - **offer_additional_fields** (array) - Custom fields of the offer - **offer_additional_fields.code** (string) - The custom field's code - **offer_additional_fields.type** (string) - The custom field's type - **offer_additional_fields.value** (string) - The custom field's value - **offer_id** (integer) - Unique offer identifier assigned by Mirakl ``` -------------------------------- ### GET /api/invoices Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/invoicing-and-accounting.md Retrieves a paginated list of accounting invoices. ```APIDOC ## GET /api/invoices ### Description Retrieves a list of invoices using offset pagination. ### Method GET ### Endpoint /api/invoices ``` -------------------------------- ### GET /api/offers Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers.md Retrieve a list of offers for a shop with support for pagination, sorting, and localization. ```APIDOC ## GET /api/offers ### Description List offers of a shop. Recommended usage is on each shop's offers page view. ### Method GET ### Endpoint /api/offers ### Parameters #### Query Parameters - **sort** (string) - Optional - Sort by totalPrice (default), price, or productTitle. - **locale** (string) - Optional - Localization parameter for output fields. ``` -------------------------------- ### GET /api/shipping/zones Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/platform-settings/sh11 Retrieves a list of all active shipping zones. ```APIDOC ## GET /api/shipping/zones ### Description Retrieves a list of all active shipping zones. Results are sorted by the index set in the back-office. ### Method GET ### Endpoint /api/shipping/zones ### Response #### Success Response (200) - **shipping_zones** (array) - List of shipping zones - **shipping_zones.code** (string) - Shipping zone code - **shipping_zones.description** (string) - Shipping zone description - **shipping_zones.label** (string) - Shipping zone label ``` -------------------------------- ### POST /api/returns Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/returns/rt01 Creates a new return request for an order. ```APIDOC ## POST /api/returns ### Description Creates a new return request. Limited to 200 returns per call. ### Method POST ### Endpoint /api/returns ### Parameters #### Request Body - **returns** (array) - Required - Returns list - **returns.accepted** (boolean) - Optional - If true, the return is automatically accepted after its creation. - **returns.description** (string) - Optional - Description - **returns.label_url** (string) - Optional - Label URL - **returns.method_code** (string) - Required - Return method code. Enum: "RETURN_METHOD_BY_MAIL", "RETURN_METHOD_DROP_OFF_POINT", "RETURN_METHOD_HOME_PICKUP", "RETURN_METHOD_IN_STORE", "RETURN_METHOD_RETURNLESS" - **returns.order_commercial_id** (string) - Required - Order commercial id - **returns.reason_code** (string) - Optional - Return reason code. - **returns.return_lines** (array) - Required - Return lines - **returns.return_lines.order_line_id** (string) - Required - Return order line id - **returns.return_lines.quantity** (integer) - Required - Quantity to return - **returns.return_lines.reason_code** (string) - Required - Return reason code - **returns.rma** (string) - Optional - Return RMA ``` -------------------------------- ### GET /api/orders Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders.md Retrieve a list of orders with pagination enabled by default. ```APIDOC ## GET /api/orders ### Description Pagination is enabled by default. For large requests, use asynchronous order export APIs OR13, OR14 and OR15 instead. ### Method GET ### Endpoint /api/orders ### Parameters #### Query Parameters - **sort** (string) - Optional - Sort by creation date (dateCreated) and then by order identifier. - **locale** (string) - Optional - Localization parameter for output fields. ``` -------------------------------- ### GET /api/returns/items_to_return Source: https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/returns/rt12 Retrieves a paginated list of items that can be returned by the customer. ```APIDOC ## GET /api/returns/items_to_return ### Description Retrieves a list of items available for return. This resource supports seek pagination. ### Method GET ### Endpoint /api/returns/items_to_return ### Parameters #### Query Parameters - **order_commercial_id** (array) - Optional - Order commercial id for filtering. Can be supplied multiple times. - **order_line_id** (array) - Optional - Order line id for filtering. Can be supplied multiple times. - **shop_id** (integer) - Optional - Use this parameter when your user has access to several shops. ### Response #### Success Response (200) - **data** (array) - Page of data - **data.available_return_methods** (array) - Available return methods to return items - **data.available_return_reasons** (array) - Available return reasons to return items - **data.order_commercial_id** (string) - Order commercial id - **data.order_line_id** (string) - Order line id - **data.return_window** (integer) - Items must be returned during the return window - **data.returnable_quantity** (integer) - Item quantity available to be returned - **next_page_token** (string) - Token to access the next page - **previous_page_token** (string) - Token to access the previous page ``` -------------------------------- ### GET /api/orders/{order_id}/messages Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/orders.md List messages of an order (deprecated). ```APIDOC ## GET /api/orders/{order_id}/messages ### Description List messages of an order. By default, all sent, received and unarchived messages are listed. This endpoint is deprecated and will be removed in a future update; please use M10 and M11 instead. ### Method GET ### Endpoint /api/orders/{order_id}/messages ### Parameters #### Path Parameters - **order_id** (string) - Required - The unique identifier of the order. #### Query Parameters - **sort** (string) - Optional - Sort field. Values: dateCreated (Default). ``` -------------------------------- ### POST /api/returns Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/returns.md Creates new returns. Limited to 200 returns at a time. ```APIDOC ## POST /api/returns ### Description Creates new returns. Limited to 200 returns at a time. ### Method POST ### Endpoint /api/returns ``` -------------------------------- ### GET /api/shipments Source: https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/multiple-shipments/st11 Retrieves a list of shipments based on provided filters. ```APIDOC ## GET /api/shipments ### Description Retrieves a list of shipments. This resource supports seek pagination and sorting by creation date. ### Method GET ### Endpoint /api/shipments ### Parameters #### Query Parameters - **order_id** (array) - Optional - Order id for filtering. Can be supplied multiple times. - **shipment_state_code** (array) - Optional - Shipment state code for filtering. Can be supplied multiple times. - **shipment_customer_debit_state_code** (array) - Optional - Shipment customer debit state code for filtering. Can be supplied multiple times. - **last_updated_from** (string) - Optional - Filter shipments updated after the given date. - **last_updated_to** (string) - Optional - Filter shipments updated before the given date. ### Response #### Success Response (200) - **data** (array) - Page of data - **data.created_date** (string) - Shipment's creation date - **data.id** (string) - Shipment id - **data.status** (string) - Shipment status - **data.status_customer_debit** (string) - Shipment debit status ``` -------------------------------- ### GET /api/documents Source: https://developer.mirakl.com/content/product/mmp/rest/front/openapi3/platform-settings.md Retrieves a list of all document types available on the platform. ```APIDOC ## GET /api/documents ### Description Retrieves a list of all document types available on the platform. This resource supports the locale parameter. ### Method GET ### Endpoint /api/documents ```