{ "components" : { "schemas" : { "AF01_Response_200" : { "type" : "object", "properties" : { "additional_fields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AF01_Response_200_AdditionalFields" } } } }, "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" }, "description" : { "type" : "string", "description" : "The description of the additional field." }, "entity" : { "type" : "string", "description" : "The object on which the additional field applies" }, "label" : { "type" : "string", "description" : "Additional field label" }, "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" } }, "regex" : { "type" : "string", "description" : "The regular expression that is used to validate the value value of this field.
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." }, "type" : { "type" : "string", "description" : "Additional field type:" } } }, "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" : "Channel label" } } }, "CUR01_Response_200" : { "type" : "object", "properties" : { "currencies" : { "type" : "array", "description" : "List of currencies", "items" : { "$ref" : "#/components/schemas/CUR01_Response_200_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" } } }, "DO01_Response_200" : { "type" : "object", "properties" : { "documents" : { "type" : "array", "description" : "Document types", "items" : { "$ref" : "#/components/schemas/DO01_Response_200_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" }, "label" : { "type" : "string", "description" : "Type label" }, "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" } } } }, "H11_Response_200" : { "type" : "object", "properties" : { "hierarchies" : { "type" : "array", "description" : "List of hierarchies", "items" : { "$ref" : "#/components/schemas/H11_Response_200_Hierarchies" } } } }, "H11_Response_200_Hierarchies" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Hierarchy code" }, "label" : { "type" : "string", "description" : "Hierarchy label" }, "label_translations" : { "type" : "array", "description" : "Hierarchy label translation", "items" : { "$ref" : "#/components/schemas/H11_Response_200_Hierarchies_LabelTranslations" } }, "level" : { "type" : "integer", "format" : "int32", "description" : "Hierarchy level" }, "parent_code" : { "type" : "string", "description" : "Parent Hierarchy code" } } }, "H11_Response_200_Hierarchies_LabelTranslations" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Locale" }, "value" : { "type" : "string", "description" : "Translation" } } }, "L01_Response_200" : { "type" : "object", "properties" : { "locales" : { "type" : "array", "description" : "List of locales", "items" : { "$ref" : "#/components/schemas/L01_Response_200_Locales" } } } }, "L01_Response_200_Locales" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Locale code" }, "label" : { "type" : "string", "description" : "Locale label" }, "platform_default" : { "type" : "boolean", "description" : "Default locale of the platform" } } }, "P42_Response_200" : { "type" : "object", "properties" : { "conversion_options" : { "$ref" : "#/components/schemas/P42_Response_200_ConversionOptions", "description" : "Options used for the conversion" }, "conversion_type" : { "type" : "string", "description" : "Type of conversion applied on products" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Import creation date" }, "has_error_report" : { "type" : "boolean", "description" : "Returns true if error report is available. Value is filled when the import is completed" }, "has_new_product_report" : { "type" : "boolean", "description" : "Returns true if new product report is available. Value is filled when the import is completed" }, "has_transformation_error_report" : { "type" : "boolean", "description" : "Returns true if transformation error report is available. Value is filled when the import is completed" }, "has_transformed_file" : { "type" : "boolean", "description" : "Returns true if transformed file is available. Value is filled when the import is completed" }, "import_id" : { "type" : "integer", "format" : "int64", "description" : "Import identifier" }, "import_status" : { "type" : "string", "description" : "Import status" }, "integration_details" : { "$ref" : "#/components/schemas/P42_Response_200_IntegrationDetails", "description" : "Integration details" }, "reason_status" : { "type" : "string", "description" : "A message explaining the reason of the import status, if relevant" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop identifier" }, "transform_lines_in_error" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines in error" }, "transform_lines_in_success" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines in success" }, "transform_lines_read" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines read" }, "transform_lines_with_warning" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines with warning" } } }, "P42_Response_200_ConversionOptions" : { "type" : "object", "properties" : { "ai_enrichment" : { "$ref" : "#/components/schemas/P42_Response_200_ConversionOptions_AiEnrichment", "description" : "Enable AI enrichment" }, "ai_rewrite" : { "$ref" : "#/components/schemas/P42_Response_200_ConversionOptions_AiRewrite", "description" : "Enable AI rewrite" } } }, "P42_Response_200_ConversionOptions_AiEnrichment" : { "type" : "object", "properties" : { "status" : { "type" : "string" } } }, "P42_Response_200_ConversionOptions_AiRewrite" : { "type" : "object", "properties" : { "status" : { "type" : "string" } } }, "P42_Response_200_IntegrationDetails" : { "type" : "object", "properties" : { "invalid_products" : { "type" : "integer", "format" : "int64", "description" : "Number of invalid products" }, "products_not_accepted_in_time" : { "type" : "integer", "format" : "int64", "description" : "Number of products that haven't been accepted in the required time" }, "products_not_synchronized_in_time" : { "type" : "integer", "format" : "int64", "description" : "Number of products that haven't been synchronized in the required time" }, "products_reimported" : { "type" : "integer", "format" : "int64", "description" : "Number of products that have been reimported in a more recent file" }, "products_successfully_synchronized" : { "type" : "integer", "format" : "int64", "description" : "Number of products successfully synchronized on operator system" }, "products_with_synchronization_issues" : { "type" : "integer", "format" : "int64", "description" : "Number of products having synchronization issues with operator system" }, "products_with_wrong_identifiers" : { "type" : "integer", "format" : "int64", "description" : "Number of products having wrong identifiers" }, "rejected_products" : { "type" : "integer", "format" : "int64", "description" : "Number of rejected products by operator system" } } }, "P51_Response_200" : { "type" : "object", "properties" : { "product_import_trackings" : { "type" : "array", "description" : "List of product import status information", "items" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings" } }, "total_count" : { "type" : "integer", "format" : "int32", "description" : "Total count of product import status information" } } }, "P51_Response_200_ProductImportTrackings" : { "type" : "object", "properties" : { "conversion_options" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions", "description" : "Options used for the conversion" }, "conversion_type" : { "type" : "string", "description" : "Type of conversion applied on products" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Import creation date" }, "has_error_report" : { "type" : "boolean", "description" : "Returns true if error report is available. Value is filled when the import is completed" }, "has_new_product_report" : { "type" : "boolean", "description" : "Returns true if new product report is available. Value is filled when the import is completed" }, "has_transformation_error_report" : { "type" : "boolean", "description" : "Returns true if transformation error report is available. Value is filled when the import is completed" }, "has_transformed_file" : { "type" : "boolean", "description" : "Returns true if transformed file is available. Value is filled when the import is completed" }, "import_id" : { "type" : "integer", "format" : "int64", "description" : "Import identifier" }, "import_status" : { "type" : "string", "description" : "Import status" }, "integration_details" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_IntegrationDetails", "description" : "Integration details" }, "reason_status" : { "type" : "string", "description" : "A message explaining the reason of the import status, if relevant" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop identifier" }, "transform_lines_in_error" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines in error" }, "transform_lines_in_success" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines in success" }, "transform_lines_read" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines read" }, "transform_lines_with_warning" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines with warning" } } }, "P51_Response_200_ProductImportTrackings_ConversionOptions" : { "type" : "object", "properties" : { "ai_enrichment" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiEnrichment", "description" : "Enable AI enrichment" }, "ai_rewrite" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiRewrite", "description" : "Enable AI rewrite" } } }, "P51_Response_200_ProductImportTrackings_ConversionOptions_AiEnrichment" : { "type" : "object", "properties" : { "status" : { "type" : "string" } } }, "P51_Response_200_ProductImportTrackings_ConversionOptions_AiRewrite" : { "type" : "object", "properties" : { "status" : { "type" : "string" } } }, "P51_Response_200_ProductImportTrackings_IntegrationDetails" : { "type" : "object", "properties" : { "invalid_products" : { "type" : "integer", "format" : "int64", "description" : "Number of invalid products" }, "products_not_accepted_in_time" : { "type" : "integer", "format" : "int64", "description" : "Number of products that haven't been accepted in the required time" }, "products_not_synchronized_in_time" : { "type" : "integer", "format" : "int64", "description" : "Number of products that haven't been synchronized in the required time" }, "products_reimported" : { "type" : "integer", "format" : "int64", "description" : "Number of products that have been reimported in a more recent file" }, "products_successfully_synchronized" : { "type" : "integer", "format" : "int64", "description" : "Number of products successfully synchronized on operator system" }, "products_with_synchronization_issues" : { "type" : "integer", "format" : "int64", "description" : "Number of products having synchronization issues with operator system" }, "products_with_wrong_identifiers" : { "type" : "integer", "format" : "int64", "description" : "Number of products having wrong identifiers" }, "rejected_products" : { "type" : "integer", "format" : "int64", "description" : "Number of rejected products by operator system" } } }, "PC01_Response_200" : { "type" : "object", "properties" : { "features" : { "$ref" : "#/components/schemas/PC01_Response_200_Features", "description" : "Features activated on the platform" }, "modules" : { "$ref" : "#/components/schemas/PC01_Response_200_Modules", "description" : "Modules activated on the platform" }, "platform_configuration" : { "$ref" : "#/components/schemas/PC01_Response_200_PlatformConfiguration", "description" : "High level platform configurations" }, "platform_name" : { "type" : "string", "description" : "Operator platform name" }, "tenant_name" : { "type" : "string", "description" : "Tenant platform name" }, "timezone" : { "type" : "string", "description" : "Platform timezone" } } }, "PC01_Response_200_Features" : { "type" : "object", "properties" : { "catalog" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Catalog", "description" : "Catalog related features" }, "circular_economy_data_collection" : { "type" : "boolean", "description" : "Allows operators to collect data related to the circular economy regulation" }, "competitive_pricing_tool" : { "type" : "boolean", "description" : "The competitive pricing tool allows stores to view and possibly match competing Marketplace offers" }, "direct_payment_customer_store" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_DirectPaymentCustomerStore", "description" : "Allows transactions taking place outside of Mirakl between customers and sellers" }, "disable_seller_alternative_carrier" : { "type" : "boolean", "description" : "Prevent stores from specifying alternatives carriers outside those predefined by the operator" }, "kyc_status_per_seller" : { "type" : "boolean", "description" : "Allows PSPs to provide operators with seller KYC statuses" }, "lead_time_to_ship_by_sellers_enabled" : { "type" : "string", "description" : "Allows sellers to override the default lead time to ship" }, "multi_currency" : { "type" : "boolean", "description" : "Defines if platform support multi currencies" }, "multi_payout_psp_per_seller" : { "type" : "boolean", "description" : "Allows the operator to use Hybrid pay-out PSP feature" }, "no_reply_needed" : { "type" : "boolean", "description" : "Allows to end order-related conversations when the last message sent from customer does not specifically require a reply" }, "offer_prices_decimals" : { "type" : "string", "description" : "Defines maximum number of decimals in offer prices" }, "operator_csv_delimiter" : { "type" : "string", "description" : "The delimiter used in the CSV files exported from the back office. COMMA: ',' delimiter. SEMICOLON: ';' delimiter." }, "order_conditions" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_OrderConditions", "description" : "Order conditions related features activated" }, "order_tax_mode" : { "type" : "string", "description" : "Prices with tax included or excluded in order-related APIs. TAX_INCLUDED: Prices with tax included. TAX_EXCLUDED: Prices with tax excluded." }, "order_workflows" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_OrderWorkflows", "description" : "Order workflows activated" }, "payment_confirmation" : { "type" : "boolean", "description" : "Allows the operator to mark an accounting document as \"Paid\" when the corresponding amount is confirmed to be paid to the seller" }, "pricing" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Pricing", "description" : "Pricing related features activated" }, "product_data_validation_by_channel" : { "type" : "boolean", "deprecated" : true, "description" : "Facilitates the management of attributes in a multilingual context" }, "promotion" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Promotion", "description" : "Promotion related features activated" }, "returns" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Returns", "description" : "Returns management feature activated" }, "shipment" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Shipment", "description" : "Shipment related features activated" }, "shop_tax_options" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_ShopTaxOptions", "description" : "Tax-related options for professional shops" }, "tax_collection" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_TaxCollection", "description" : "Allows the collection of information required to calculate taxes, with or without the tax connector" }, "tax_id_number" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_TaxIdNumber", "description" : "Unique identifier used to conduct tax-related formalities" }, "warehouses" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Warehouses", "description" : "Allows operators to apply specific configuration on store account warehouses" } } }, "PC01_Response_200_Features_Catalog" : { "type" : "object", "properties" : { "allow_shop_contribution_to_all_channels" : { "type" : "boolean", "description" : "Allows shops to contribute data to all sales channels when enabled; otherwise, data can only be pushed to channels the shop belongs to" }, "exclude_invalid_products" : { "type" : "boolean", "description" : "When enabled, products with validation errors will be excluded from product imports and won't be transmitted to MCM" }, "list_of_multiple_values_separator" : { "type" : "string", "description" : "Character used to separate values in the 'Multiple Values List' type attributes" }, "product_acceptance_by_channel" : { "type" : "boolean", "description" : "Allows operators to accept or reject products according to sales channels" }, "product_data_validation_by_channel" : { "type" : "boolean", "description" : "Facilitates the management of attributes in a multilingual context" }, "product_import_only_on_leaf" : { "type" : "boolean", "description" : "Prevents the import of products into non-leaf categories" } } }, "PC01_Response_200_Features_DirectPaymentCustomerStore" : { "type" : "object", "properties" : { "activated" : { "type" : "boolean", "description" : "Direct payment customer store activated" }, "refund_cancel_authorized" : { "type" : "boolean", "description" : "Allows refund and cancelation for transactions taking place outside of Mirakl between customers and sellers" } } }, "PC01_Response_200_Features_OrderConditions" : { "type" : "object", "properties" : { "lead_time_to_ship" : { "type" : "boolean", "deprecated" : true, "description" : "Allows sellers to inform a lead time to ship on their offers" }, "maximum_order_quantity" : { "type" : "boolean", "description" : "Allows sellers to request for a maximum order quantity" }, "minimum_order_quantity" : { "type" : "boolean", "description" : "Allows sellers to request for a minimum order quantity" }, "package_order_quantity" : { "type" : "boolean", "description" : "Allows sellers to set an order quantity increment" } } }, "PC01_Response_200_Features_OrderWorkflows" : { "type" : "object", "properties" : { "no_customer_payment_confirmation" : { "type" : "boolean", "description" : "Allows seller payments to be completely separated from customer debits" }, "order_acceptance" : { "type" : "string", "description" : "Indicate if shop accounts must accept new orders and take responsibility for the transaction. NOT_AUTOMATIC: All shop accounts must accept their orders manually. AUTOMATIC: Orders are automatically accepted. BOTH: AUTOMATIC or NOT_AUTOMATIC mode depending on the store account" }, "pause_debit_workflow" : { "type" : "boolean", "description" : "Pause the order debit workflow when taxes must be recalculated" }, "pay_on_due_date" : { "type" : "boolean", "description" : "Allows professionals to pay their orders after the receipt of the items or an explicit invoice" }, "pay_on_shipment" : { "type" : "boolean", "description" : "Allows operators to debit orders before they have been fully shipped" }, "sellers_edit_shipping_origin" : { "type" : "boolean", "description" : "Allow shop accounts to edit shipping origin to ensures accurate tax calculations with shipping origin data" }, "shipping_and_billing_details_before_acceptance" : { "type" : "boolean", "description" : "Indicate if shipping and billing details are displayed before order acceptance" } } }, "PC01_Response_200_Features_Pricing" : { "type" : "object", "properties" : { "channel_pricing" : { "type" : "string", "description" : "Allows sellers to create prices applicable on the operator’s different storefronts materialized as sales channels in Mirakl. DISABLED: No channel pricing. SINGLE: Allows sellers to create one price per channel. MULTI: Allows sellers to create multiple prices per channel." }, "discount_period_required" : { "type" : "boolean", "description" : "Requires sellers to set start and end dates when creating or updating discounts on default and specific prices." }, "discount_price_creation_in_the_past_blocked" : { "type" : "boolean", "description" : "Prevents sellers from setting discount end dates in the past for their default and specific prices." }, "scheduled_pricing" : { "type" : "boolean", "description" : "Allows sellers to set up multiple prices in advance" }, "volume_discount" : { "type" : "boolean", "description" : "Allows discounts for bulk purchases" }, "volume_pricing" : { "type" : "boolean", "description" : "Allows pricing for bulk purchases" } } }, "PC01_Response_200_Features_Promotion" : { "type" : "object", "properties" : { "cart_promotion_campaign" : { "type" : "boolean", "description" : "Allows the operator to create cart promotion campaigns." }, "discount_campaign" : { "type" : "boolean", "description" : "Allows the operator to create discount campaigns." }, "seller_promotion" : { "type" : "boolean", "description" : "Allows stores to create promotions." } } }, "PC01_Response_200_Features_Returns" : { "type" : "object", "properties" : { "drop_ship" : { "type" : "boolean", "description" : "Enables returns management in Drop ship" }, "marketplace" : { "type" : "boolean", "description" : "Enables returns management in Marketplace" }, "one_creditor" : { "type" : "boolean", "description" : "Enables returns management in One creditor" } } }, "PC01_Response_200_Features_Shipment" : { "type" : "object", "properties" : { "multi_part_item_shipment" : { "type" : "boolean", "description" : "Allows sellers to create several packages for a same item in an order" }, "multi_shipment" : { "type" : "boolean", "description" : "Allows sellers to create several shipments for a same order" } } }, "PC01_Response_200_Features_ShopTaxOptions" : { "type" : "object", "properties" : { "local_tax_number" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_ShopTaxOptions_LocalTaxNumber", "description" : "The VAT/GST number of a seller billing information and fiscal representative" }, "tax_identification_number" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_ShopTaxOptions_TaxIdentificationNumber", "description" : "The tax identification number of a seller billing information" } } }, "PC01_Response_200_Features_ShopTaxOptions_LocalTaxNumber" : { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "description" : "Defines if the VAT/GST number is mandatory" }, "validation_regex" : { "type" : "string", "description" : "Regular expression that the VAT/GST number must match" } } }, "PC01_Response_200_Features_ShopTaxOptions_TaxIdentificationNumber" : { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "description" : "Defines if the tax identification number is mandatory" }, "validation_regex" : { "type" : "string", "description" : "Regular expression that the tax identification number must match" } } }, "PC01_Response_200_Features_TaxCollection" : { "type" : "object", "properties" : { "activated" : { "type" : "string", "description" : "Tax collection activated. NO: Not activated. YES: Activated for all stores. YES_PER_STORE: Activated for some stores." }, "product_tax_code_mandatory" : { "type" : "boolean", "description" : "Product tax code mandatory at offer level" }, "tax_collection_by_operator" : { "type" : "boolean", "description" : "Operator in charge of tax collection on behalf of sellers" } } }, "PC01_Response_200_Features_TaxIdNumber" : { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "description" : "Tax ID number mandatory" }, "validation_regex" : { "type" : "string", "description" : "Regular expression to match for sellers tax number ID" } } }, "PC01_Response_200_Features_Warehouses" : { "type" : "object", "properties" : { "geolocation" : { "type" : "boolean", "description" : "Geolocation on warehouses activated" }, "restricted_countries" : { "type" : "array", "description" : "The list of the restricted countries applying on warehouses. Format ISO 3166-1 alpha-3 code (3 letters country code). Possible values : 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", "items" : { "type" : "string" } } } }, "PC01_Response_200_Modules" : { "type" : "object", "properties" : { "mirakl_catalog_integrator" : { "type" : "boolean", "description" : "Mirakl Catalog integrator activated. Allows operator to manage catalog structure into Mirakl." }, "mirakl_catalog_manager" : { "type" : "boolean", "description" : "Mirakl Catalog Manager activated. Allows operator to remove the complexity of integrating catalogs from multiple sources." }, "mirakl_catalog_transformer" : { "type" : "boolean", "description" : "Mirakl Catalog Transformer activated." }, "mirakl_platform_services" : { "type" : "boolean", "description" : "Mirakl Platform for Services activated. Specific module for services management: separated from the product management module." }, "offer_management" : { "type" : "boolean", "description" : "Offer management available on the platform" }, "offer_management_mode" : { "type" : "string", "description" : "Offer management mode on the platform: SIMPLE: All shops can push offers. HYBRID: The operator decides whether a shop can push offers on the platform." }, "order_management" : { "type" : "boolean", "description" : "Order management available on the platform" }, "order_management_mode" : { "type" : "string", "description" : "Order management mode on the platform: SIMPLE: All shops can process orders. HYBRID: The operator decides whether a shop can process orders on the platform." }, "promotions" : { "type" : "boolean", "description" : "Promotion module activated" }, "quotes" : { "type" : "boolean", "description" : "Quote module activated" }, "tax_manager" : { "$ref" : "#/components/schemas/PC01_Response_200_Modules_TaxManager", "deprecated" : true, "description" : "Allows operator to be connected with a tax calculation provider" } } }, "PC01_Response_200_Modules_TaxManager" : { "type" : "object", "deprecated" : true, "properties" : { "activated" : { "type" : "boolean", "description" : "Tax Manager activated" }, "tax_provider" : { "$ref" : "#/components/schemas/PC01_Response_200_Modules_TaxManager_TaxProvider", "description" : "The tax provider processing tax estimation" } } }, "PC01_Response_200_Modules_TaxManager_TaxProvider" : { "type" : "object", "properties" : { "avalara" : { "type" : "boolean", "description" : "Avalara configured as tax provider" }, "vertex" : { "type" : "boolean", "description" : "Vertex configured as tax provider" } } }, "PC01_Response_200_PlatformConfiguration" : { "type" : "object", "properties" : { "customer_model" : { "$ref" : "#/components/schemas/PC01_Response_200_PlatformConfiguration_CustomerModel", "description" : "The customer organization activation on the platform" }, "platform_model" : { "$ref" : "#/components/schemas/PC01_Response_200_PlatformConfiguration_PlatformModel", "description" : "The platform models activated on the platform " } } }, "PC01_Response_200_PlatformConfiguration_CustomerModel" : { "type" : "object", "properties" : { "b2b" : { "type" : "boolean", "description" : "Customer model Business to Business is enabled: if true, customers can be linked to a customer organization" }, "b2c" : { "type" : "boolean", "description" : "Customer model Business to Customer is enabled: if true, customers can be created without being linked to a customer organization" } } }, "PC01_Response_200_PlatformConfiguration_PlatformModel" : { "type" : "object", "properties" : { "drop_ship" : { "type" : "boolean", "description" : "Drop ship platform model activated" }, "marketplace" : { "type" : "boolean", "description" : "Marketplace platform model activated" }, "one_creditor" : { "type" : "boolean", "description" : "One creditor platform model activated" } } }, "PM11_Response_200" : { "type" : "object", "description" : "JSON output", "properties" : { "attributes" : { "type" : "array", "description" : "List of attributes", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes" } } } }, "PM11_Response_200_Attributes" : { "type" : "object", "properties" : { "channels" : { "type" : "array", "description" : "Channels", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_Channels" } }, "code" : { "type" : "string", "description" : "Attribute code" }, "default_value" : { "type" : "string", "deprecated" : true, "description" : "Default value for value list type attributes" }, "description" : { "type" : "string", "description" : "Attribute description" }, "description_translations" : { "type" : "array", "description" : "Translations of the attribute description", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_DescriptionTranslations" } }, "example" : { "type" : "string", "description" : "Attribute example to help sellers when they fill the product creation form" }, "hierarchy_code" : { "type" : "string", "description" : "The code of the hierarchy (category) this attribute belongs to. If this field is empty, the attribute is shared among all hierarchies." }, "label" : { "type" : "string", "description" : "Attribute label" }, "label_translations" : { "type" : "array", "description" : "Translations of the attribute label", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_LabelTranslations" } }, "locale" : { "type" : "string", "description" : "Attribute localization.\n\nThe language format can either be:\n- ISO-639 (E.g. \"en\")\n- ISO-639_ISO-3166 (E.g. \"en_US\")\n" }, "required" : { "type" : "boolean", "deprecated" : true, "description" : "Whether or not the attribute is required" }, "requirement_level" : { "type" : "string", "description" : "Requirement level of the attribute" }, "roles" : { "type" : "array", "description" : "Attribute roles", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_Roles" } }, "transformations" : { "type" : "string", "description" : "Transformations applied to the attribute (a list of transformations separated by commas)" }, "type" : { "type" : "string", "description" : "Attribute type" }, "type_parameter" : { "type" : "string", "deprecated" : true, "description" : "Type parameter" }, "type_parameters" : { "type" : "array", "description" : "Specificities of the attribute type, for example the date format, or the maximum size of a media", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_TypeParameters" } }, "unique_code" : { "type" : "string", "description" : "Unique code of the attribute" }, "validations" : { "type" : "string", "description" : "Validations applied to the attribute (a list of validations separated by commas)" }, "values" : { "type" : "array", "deprecated" : true, "description" : "A list of authorized values for this attribute", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_Values" } }, "values_list" : { "type" : "string", "deprecated" : true, "description" : "This code points to the list defining the authorized values for this attribute." }, "variant" : { "type" : "boolean", "description" : "Whether or not the attribute is a variation axis. Possible values: true or false" } } }, "PM11_Response_200_Attributes_Channels" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Channel code" } } }, "PM11_Response_200_Attributes_DescriptionTranslations" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Locale" }, "value" : { "type" : "string", "description" : "Translation" } } }, "PM11_Response_200_Attributes_LabelTranslations" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Locale" }, "value" : { "type" : "string", "description" : "Translation" } } }, "PM11_Response_200_Attributes_Roles" : { "type" : "object", "properties" : { "parameters" : { "type" : "array", "description" : "Attribute role parameters", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_Roles_Parameters" } }, "type" : { "type" : "string", "description" : "Role type of the attribute" } } }, "PM11_Response_200_Attributes_Roles_Parameters" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of the parameter" }, "value" : { "type" : "string", "description" : "Value of the parameter" } } }, "PM11_Response_200_Attributes_TypeParameters" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of the parameter" }, "value" : { "type" : "string", "description" : "Value of the parameter" } } }, "PM11_Response_200_Attributes_Values" : { "type" : "object", "deprecated" : true, "properties" : { "code" : { "type" : "string", "description" : "Value code" } } }, "RO02_Response_200" : { "type" : "object", "properties" : { "roles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RO02_Response_200_Roles" } } } }, "RO02_Response_200_Roles" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "description" : { "type" : "string" } } }, "S30_Response_200" : { "type" : "object", "properties" : { "shop_documents" : { "type" : "array", "description" : "The document details", "items" : { "$ref" : "#/components/schemas/S30_Response_200_ShopDocuments" } } } }, "S30_Response_200_ShopDocuments" : { "type" : "object", "properties" : { "date_deleted" : { "type" : "string", "format" : "date-time", "description" : "Document deleted date" }, "date_uploaded" : { "type" : "string", "format" : "date-time", "description" : "Document uploaded date" }, "file_name" : { "type" : "string", "description" : "Document file name" }, "id" : { "type" : "integer", "format" : "int64", "description" : "Document identifier" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "The id of the shop owning the document" }, "type" : { "type" : "string", "description" : "Document type code" } } }, "VL11_Response_200" : { "type" : "object", "properties" : { "values_lists" : { "type" : "array", "description" : "List of values list", "items" : { "$ref" : "#/components/schemas/VL11_Response_200_ValuesLists" } } } }, "VL11_Response_200_ValuesLists" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Value list code" }, "label" : { "type" : "string", "description" : "Value list label" }, "label_translations" : { "type" : "array", "description" : "Value list translations", "items" : { "$ref" : "#/components/schemas/VL11_Response_200_ValuesLists_LabelTranslations" } }, "values" : { "type" : "array", "description" : "Value list's of value list", "items" : { "$ref" : "#/components/schemas/VL11_Response_200_ValuesLists_Values" } } } }, "VL11_Response_200_ValuesLists_LabelTranslations" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Locale" }, "value" : { "type" : "string", "description" : "Translation" } } }, "VL11_Response_200_ValuesLists_Values" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Value code" }, "label" : { "type" : "string", "description" : "Value label" }, "label_translations" : { "type" : "array", "description" : "Value label translation", "items" : { "$ref" : "#/components/schemas/VL11_Response_200_ValuesLists_Values_LabelTranslations" } } } }, "VL11_Response_200_ValuesLists_Values_LabelTranslations" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Locale" }, "value" : { "type" : "string", "description" : "Translation" } } } }, "securitySchemes" : { "operator_api_key" : { "in" : "header", "name" : "Authorization", "type" : "apiKey" }, "operator_bearer_token" : { "bearerFormat" : "JWT", "scheme" : "bearer", "type" : "http" } } }, "info" : { "title" : "Mirakl Catalog Manager APIs", "version" : "latest-release" }, "openapi" : "3.0.1", "paths" : { "/api/additional_fields" : { "get" : { "operationId" : "AF01", "parameters" : [ { "description" : "A comma separated list of entities on which the additional fields must apply. Accepted values are OFFER, SHOP, ORDER and ORDER_LINE. Ex: OFFER,SHOP.", "explode" : true, "in" : "query", "name" : "entities", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/AF01_Response_200" } } }, "description" : "OK" } }, "summary" : "List all custom fields", "tags" : [ "Platform Settings" ] } }, "/api/channels" : { "get" : { "description" : "Results are sorted by code", "operationId" : "CH11", "parameters" : [ { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/CH11_Response_200" } } }, "description" : "OK" } }, "summary" : "List all enabled channels", "tags" : [ "Platform Settings" ] } }, "/api/mcm/products/sources/status/export" : { "get" : { "description" : "Delta export of the source product data sheet status in JSON format.\n\nDefine a cron job in your system that periodically calls this API and sets the previous\nrequest date as the `updated_since` query parameter.", "operationId" : "CM11", "parameters" : [ { "description" : "Export start date. Given date must respect ISO-8601 format and must be URL encoded", "explode" : true, "in" : "query", "name" : "updated_since", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Export end date. Given date must respect ISO-8601 format and must be URL encoded", "explode" : true, "in" : "query", "name" : "updated_to", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "The status of the product : LIVE / NOT_LIVE", "explode" : true, "in" : "query", "name" : "status", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "The provider unique identifier of the product", "explode" : true, "in" : "query", "name" : "provider_unique_identifier", "schema" : { "type" : "array", "items" : { "type" : "string", "maxLength" : 100, "minLength" : 0 }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "The unique identifier of the product with type (structure: \\\"unique_identifier=&UniqueIdentifierType1|UniqueIdentifierID1,UniqueIdentifierType2|UniqueIdentifierID2, ...\\\").", "explode" : true, "in" : "query", "name" : "unique_identifier", "schema" : { "type" : "array", "items" : { "type" : "string", "maxLength" : 100, "minLength" : 0 }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "The provider id", "explode" : true, "in" : "query", "name" : "provider_id", "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "Export success" }, "204" : { "description" : "No source product data sheet status to export" } }, "summary" : "Export Source Product Data Sheet status", "tags" : [ "Products" ] } }, "/api/currencies" : { "get" : { "description" : "List currency codes and labels activated on the platform", "operationId" : "CUR01", "parameters" : [ { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/CUR01_Response_200" } } }, "description" : "OK" } }, "summary" : "List currency codes and labels", "tags" : [ "Platform Settings" ] } }, "/api/documents" : { "get" : { "operationId" : "DO01", "parameters" : [ { "description" : "A comma separated list of values, representing the type of entities the document type should be related to. Accepted values are ORDER, SHOP. Ex: ORDER,SHOP", "explode" : true, "in" : "query", "name" : "entities", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/DO01_Response_200" } } }, "description" : "OK" } }, "summary" : "List all document types", "tags" : [ "Platform Settings" ] } }, "/api/hierarchies" : { "get" : { "operationId" : "H11", "parameters" : [ { "description" : "Catalog category code", "explode" : true, "in" : "query", "name" : "hierarchy", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Number of children catalog category levels to retrieve. If not specified, all child catalog categories are retrieved", "explode" : true, "in" : "query", "name" : "max_level", "schema" : { "type" : "integer", "format" : "int32" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/H11_Response_200" } } }, "description" : "OK" } }, "summary" : "List Catalog categories (parents and children) related to a Catalog category", "tags" : [ "Products" ] } }, "/api/locales" : { "get" : { "description" : "List locale codes and labels from your platform to automate product format exports (API H01, PM01, VL01) from your PIM system", "operationId" : "L01", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/L01_Response_200" } } }, "description" : "OK" } }, "summary" : "List locale codes and labels", "tags" : [ "Platform Settings" ] } }, "/api/products/imports/{import}" : { "get" : { "operationId" : "P42", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/P42_Response_200" } } }, "description" : "OK" } }, "summary" : "Get the import status for a product import", "tags" : [ "Products" ] } }, "/api/products/imports/{import}/error_report" : { "get" : { "description" : "This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).", "operationId" : "P44", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "summary" : "Get the error report file for a product import (\"Non-integrated products report\")", "tags" : [ "Products" ] } }, "/api/products/imports/{import}/new_product_report" : { "get" : { "description" : "This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).", "operationId" : "P45", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "summary" : "Get the product integration report file for a product import (\"Added products report\")", "tags" : [ "Products" ] } }, "/api/products/imports/{import}/transformed_file" : { "get" : { "description" : "This API returns a CSV file.", "operationId" : "P46", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "text/csv" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "summary" : "Get the transformed file for a product import (\"File in operator format\")", "tags" : [ "Products" ] } }, "/api/products/imports/{import}/transformation_error_report" : { "get" : { "description" : "This API returns a CSV, XLSX or XML file, depending on the file format provided by the seller.", "operationId" : "P47", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "summary" : "Get the transformation error report file for a product import (\"Source file error report\")", "tags" : [ "Products" ] } }, "/api/products/imports" : { "get" : { "description" : "If the last_request_date param is not set the api returns all product imports.", "operationId" : "P51", "parameters" : [ { "description" : "Return only product imports that have changed since this date", "explode" : true, "in" : "query", "name" : "last_request_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Product import status. One of CANCELLED, WAITING, RUNNING, SENT, COMPLETE, FAILED", "explode" : true, "in" : "query", "name" : "status", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "If true returns only product import trackings with transformed file", "explode" : true, "in" : "query", "name" : "has_transformed_file", "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "Shop identifier", "explode" : true, "in" : "query", "name" : "shop_id", "schema" : { "type" : "integer", "format" : "int64" }, "style" : "form" }, { "description" : "Maximum number of items returned per page", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Index of the first item (among all the results) in the returned page", "in" : "query", "name" : "offset", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "How the results should be sorted", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } }, { "description" : "Sort direction", "in" : "query", "name" : "order", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/P51_Response_200" } } }, "description" : "OK" } }, "summary" : "Get information about product import statuses", "tags" : [ "Products" ] } }, "/api/platform/configuration" : { "get" : { "description" : "List platform configurations such as general information, modules and features activated.
\n
\nNote: This configuration represents modules and major features enabled during platform setup. This differs from the PC02 API which export the platform business settings configurable by the operator in the back office.\n", "operationId" : "PC01", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/PC01_Response_200" } } }, "description" : "OK" } }, "summary" : "List platform configurations", "tags" : [ "Platform Settings" ] } }, "/api/products/attributes" : { "get" : { "description" : "Retrieves all attributes for parents and children of the requested hierarchy", "operationId" : "PM11", "parameters" : [ { "description" : "Code of the hierarchy (category) for which to retrieve the attributes. If not specified, all attributes are retrieved.", "explode" : true, "in" : "query", "name" : "hierarchy", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Number of children hierarchy (category) levels to retrieve. If not specified, attributes from all children hierarchies are retrieved.", "explode" : true, "in" : "query", "name" : "max_level", "schema" : { "type" : "integer", "format" : "int32" }, "style" : "form" }, { "description" : "List of channel codes", "explode" : true, "in" : "query", "name" : "channels", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Set to \"true\" to get only the attributes that have roles.", "explode" : true, "in" : "query", "name" : "with_roles", "schema" : { "type" : "boolean", "default" : false }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/PM11_Response_200" } }, "text/csv" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "Export success" } }, "summary" : "Get the product attribute configuration", "tags" : [ "Products" ] } }, "/api/users/shops/roles" : { "get" : { "operationId" : "RO02", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RO02_Response_200" } } }, "description" : "OK" } }, "summary" : "List shop roles", "tags" : [ "Users" ] } }, "/api/shops/documents" : { "get" : { "description" : "You must specify at least one of the following parameters: shop_ids, updated_since", "operationId" : "S30", "parameters" : [ { "description" : "A list of shop identifiers", "explode" : true, "in" : "query", "name" : "shop_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "True to include deleted documents, false to remove them", "explode" : true, "in" : "query", "name" : "include_deleted", "schema" : { "type" : "boolean", "default" : false }, "style" : "form" }, { "description" : "Retrieve shop documents modified at or after this date. The time period cannot exceed 90 days", "explode" : true, "in" : "query", "name" : "updated_since", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/S30_Response_200" } } }, "description" : "OK" } }, "summary" : "List shop's documents", "tags" : [ "Stores" ] } }, "/api/shops/documents/download" : { "get" : { "description" : "

When documents are retrieved, they're wrapped into a ZIP archive except when only one document id is specified. The tree structure of this archive is as follow:

\ndocuments-timestamp.zip\n|\n|__ shop_id_x/\n|   |__ foo.txt\n|   |__ bar.txt\n|   |__ baz.pdf\n|\n|__ shop_id_y/\n|   |__ image.png\n|   |__ image(1).png\n

Returns a 404 if at least one document id, one shop id or one document type code is invalid

", "operationId" : "S31", "parameters" : [ { "description" : "A list of shop identifiers (separated by a comma). It is mandatory to specify either the shop_ids or the document_ids", "explode" : true, "in" : "query", "name" : "shop_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "A list of document identifiers (separated by a comma). It is mandatory to specify either the shop_ids or the document_ids", "explode" : true, "in" : "query", "name" : "document_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "A list of document type codes (separated by a comma)", "explode" : true, "in" : "query", "name" : "type_codes", "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "summary" : "Download documents for one or multiple shops", "tags" : [ "Stores" ] } }, "/api/shops/documents/{document_id}" : { "delete" : { "operationId" : "S33", "parameters" : [ { "description" : "Document identifier to delete", "explode" : false, "in" : "path", "name" : "document_id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "No Content" } }, "summary" : "Delete a shop document", "tags" : [ "Stores" ] } }, "/api/values_lists" : { "get" : { "operationId" : "VL11", "parameters" : [ { "description" : "The operator's values list code. If not specified, all values lists are retrieved", "explode" : true, "in" : "query", "name" : "code", "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/VL11_Response_200" } } }, "description" : "OK" } }, "summary" : "Get information about operator's value lists", "tags" : [ "Products" ] } } }, "servers" : [ { "description" : "URL to be replaced by your Mirakl instance URL", "url" : "https://your-instance.mirakl.net" } ], "x-group-parameters" : true }