{ "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" } } } }, "IV01_Response_200" : { "type" : "object", "properties" : { "invoices" : { "type" : "array", "description" : "Accounting documents", "items" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices" } }, "total_count" : { "type" : "integer", "format" : "int64", "description" : "Accounting documents total count" } } }, "IV01_Response_200_Invoices" : { "type" : "object", "discriminator" : { "mapping" : { "AUTO_INVOICE" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice", "MANUAL_CREDIT" : "#/components/schemas/IV01_Response_200_Invoices_ManualCredit", "MANUAL_INVOICE" : "#/components/schemas/IV01_Response_200_Invoices_ManualInvoice" }, "propertyName" : "type" }, "properties" : { "currency_iso_code" : { "type" : "string", "description" : "The currency of the shop" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Accounting document creation date" }, "details" : { "type" : "array", "description" : "Accounting details", "items" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_Details" } }, "due_date" : { "type" : "string", "format" : "date-time", "description" : "Due date for the payment of the accounting document" }, "id" : { "type" : "string", "description" : "Accounting document identifier (use it for draft document)" }, "invoice_id" : { "type" : "integer", "format" : "int64", "description" : "Accounting document identifier (present if the accounting document is issued)" }, "issue_date" : { "type" : "string", "format" : "date-time", "description" : "Issue date of an accounting document" }, "issuing_user" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_IssuingUser", "description" : "Accounting document issuing user" }, "pay_out_psp_code" : { "type" : "string", "description" : "PSP code for Pay-out" }, "payment" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_Payment", "description" : "Accounting document payment details" }, "payment_voucher_number" : { "type" : "string", "description" : "The payment voucher number" }, "shop_address" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_ShopAddress", "description" : "Shop address" }, "shop_corporate_name" : { "type" : "string", "description" : "Shop corporate name if it is a professional shop" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop id" }, "shop_model" : { "type" : "string", "description" : "Shop model" }, "shop_name" : { "type" : "string", "description" : "Shop name" }, "shop_operator_internal_id" : { "type" : "string", "description" : "Operator internal id for the shop" }, "shop_tax_number" : { "type" : "string", "description" : "Shop tax number if it is a professional shop" }, "state" : { "type" : "string", "description" : "Accounting document state" }, "total_amount_excl_taxes" : { "type" : "number", "description" : "Total amount charged to the shop (excluding taxes)" }, "total_amount_incl_taxes" : { "type" : "number", "description" : "Total amount charged to the shop (including taxes)" }, "total_taxes" : { "type" : "array", "description" : "Total taxes", "items" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_TotalTaxes" } }, "type" : { "type" : "string", "description" : "Accounting document type" } } }, "IV01_Response_200_Invoices_AutoInvoice" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices" } ], "description" : "Automatic accounting document", "properties" : { "end_time" : { "type" : "string", "format" : "date-time", "description" : "Ending date of the period for accounting document of type AUTO_INVOICE" }, "payment_info" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo", "description" : "Shop payment information" }, "seller_billing_cycle_id" : { "type" : "string", "description" : "The seller billing cycle identifier" }, "start_time" : { "type" : "string", "format" : "date-time", "description" : "Starting date of the period for accounting document of type AUTO_INVOICE" }, "summary" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_Summary", "description" : "Summary for automatic accounting document" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" : { "type" : "object", "discriminator" : { "mapping" : { "ABA" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aba", "AUBSB" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aubsb", "BRAZILIAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Brazilian", "CANADIAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Canadian", "COLOMBIAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Colombian", "GUATEMALAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Guatemalan", "HK" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Hk", "IBAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Iban", "INDIAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Indian", "ISRAELI" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Israeli", "JAPANESE" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Japanese", "MEXICAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Mexican", "NUBAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nuban", "NZBSB" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nzbsb", "PAYOUT" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Payout", "PHILIPPINES" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Philippines", "SERBIAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Serbian", "SG" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Sg", "TAIWANESE" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Taiwanese", "THAI" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Thai", "UK" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uk", "URUGUAYAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uruguayan", "VIETNAMESE" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Vietnamese" }, "propertyName" : "type" }, "properties" : { "@type" : { "type" : "string" }, "bank_city" : { "type" : "string", "description" : "Bank city" }, "bank_name" : { "type" : "string", "description" : "Bank name" }, "bank_street" : { "type" : "string", "description" : "Bank street name" }, "bank_zip" : { "type" : "string", "description" : "Bank zip code" }, "owner" : { "type" : "string", "description" : "Name of the owner of the payment information" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aba" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank Account Number" }, "bic" : { "type" : "string", "description" : "Bank account BIC code (aka Swift Code)" }, "routing_number" : { "type" : "string", "description" : "Routing Number of the bank, (aka ABA code)" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aubsb" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "auban" : { "type" : "string", "description" : "Bank account number" }, "aubsb" : { "type" : "string", "description" : "Bank state branch code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Brazilian" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "bank_account_type" : { "type" : "string", "description" : "Account type\n
\n\n" }, "bank_code" : { "type" : "string", "description" : "Bank code" }, "branch_code" : { "type" : "string", "description" : "Branch code" }, "pix_key" : { "type" : "string", "description" : "Pix key" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Canadian" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank account number" }, "institution_number" : { "type" : "string", "description" : "Bank institution number" }, "swift_code" : { "type" : "string", "description" : "Bank account swift code" }, "transit_number" : { "type" : "string", "description" : "Bank transit number" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Colombian" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "bank_account_type" : { "type" : "string", "description" : "Account type\n
\n\n" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Guatemalan" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "bank_account_type" : { "type" : "string", "description" : "Account type\n
\n\n" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Hk" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank account number" }, "swift_code" : { "type" : "string", "description" : "Bank account swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Iban" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bic" : { "type" : "string", "description" : "Bank account BIC code" }, "iban" : { "type" : "string", "description" : "Bank account IBAN" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Indian" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "indian_financial_system_code" : { "type" : "string", "description" : "Indian financial system code" }, "swift_code" : { "type" : "string", "description" : "Bank account swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Israeli" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" }, "bank_code" : { "type" : "string", "description" : "Bank code" }, "branch_name" : { "type" : "string", "description" : "Branch name" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Japanese" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank account number" }, "bank_account_type" : { "type" : "string", "description" : "Account type\n
\n\n" }, "bank_code" : { "type" : "string", "description" : "Bank code" }, "branch_code" : { "type" : "string", "description" : "Branch code" }, "branch_name" : { "type" : "string", "description" : "Branch name" }, "swift_code" : { "type" : "string", "description" : "Bank account swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Mexican" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank account number" }, "clabe" : { "type" : "string", "description" : "Clave Bancaria Estandarizada" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nuban" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "nuban" : { "type" : "string", "description" : "The bank account NUBAN code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nzbsb" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "nzban" : { "type" : "string", "description" : "Bank Account Number" }, "nzbsb" : { "type" : "string", "description" : "Bank State Branch code." } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Payout" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" }, "bic" : { "type" : "string", "description" : "BIC" }, "iban" : { "type" : "string", "description" : "IBAN" }, "payout_format" : { "type" : "string", "description" : "Payout format" }, "sort_code" : { "type" : "string", "description" : "Sort code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Philippines" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Serbian" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank account number" }, "bank_branch_number" : { "type" : "string", "description" : "Bank branch number" }, "bic" : { "type" : "string", "description" : "Bank account BIC code" }, "iban" : { "type" : "string", "description" : "Bank account IBAN" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Sg" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" }, "bank_key" : { "type" : "string", "description" : "Bank key" }, "swift_code" : { "type" : "string", "description" : "Swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Taiwanese" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "bank_code" : { "type" : "string", "description" : "Bank code" }, "branch_code" : { "type" : "string", "description" : "Branch code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Thai" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uk" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" }, "sort_code" : { "type" : "string", "description" : "Sort code" }, "swift_code" : { "type" : "string", "description" : "Swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uruguayan" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "bank_account_type" : { "type" : "string", "description" : "Account type\n
\n\n" }, "branch_code" : { "type" : "string", "description" : "Branch code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Vietnamese" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" }, "branch_name" : { "type" : "string", "description" : "Branch name" } } }, "IV01_Response_200_Invoices_AutoInvoice_Summary" : { "type" : "object", "properties" : { "amount_transferred" : { "type" : "number", "description" : "Total amount to be transferred to the seller" }, "amount_transferred_to_operator" : { "type" : "number", "description" : "Total amount to be transferred to the operator" }, "reserve_funding" : { "type" : "number", "description" : "Amount set aside for the seller reserve" }, "reserve_settlement" : { "type" : "number", "description" : "Amount paid out from the seller reserve" }, "total_commissions_excl_tax" : { "type" : "number", "description" : "Total amount of commissions (excluding taxes on orders)" }, "total_commissions_incl_tax" : { "type" : "number", "description" : "Total amount of commissions (including taxes on orders)" }, "total_fee_excl_tax" : { "type" : "number", "description" : "Total amount of fees (excluding taxes on orders)" }, "total_fee_incl_tax" : { "type" : "number", "description" : "Total amount of fees (including taxes on orders)" }, "total_fee_operator_remitted_excl_tax" : { "type" : "number", "description" : "Total amount of fees remitted by the operator (excluding taxes on orders)" }, "total_fee_operator_remitted_incl_tax" : { "type" : "number", "description" : "Total amount of fees remitted by the operator (including taxes on orders)" }, "total_mirakl_ads_credit_excl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads credits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_credit_incl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads credits of a payment cycle (including taxes on stores)" }, "total_mirakl_ads_debit_excl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads debits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_debit_incl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads debits of a payment cycle (including taxes on stores)" }, "total_non_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount for non payable orders (including shipping charges and excluding taxes on orders)" }, "total_non_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount for non payable orders (including shipping charges and taxes on orders)" }, "total_operator_paid_shipping_charges_excl_tax" : { "type" : "number", "description" : "Total amount of shipping charges paid by the operator (excluding taxes on orders)" }, "total_operator_paid_shipping_charges_incl_tax" : { "type" : "number", "description" : "Total amount of shipping charges paid by the operator (including taxes on orders)" }, "total_operator_remitted_taxes" : { "type" : "number", "description" : "Total amount for order taxes remitted by the operator" }, "total_other_credits_excl_tax" : { "type" : "number", "description" : "Total amount for other manual credits of a payment cycle (excluding taxes on stores)" }, "total_other_credits_incl_tax" : { "type" : "number", "description" : "Total amount for other manual credits of a payment cycle (including taxes on stores)" }, "total_other_invoices_excl_tax" : { "type" : "number", "description" : "Total amount for other manual invoices of a payment cycle (excluding taxes on stores)" }, "total_other_invoices_incl_tax" : { "type" : "number", "description" : "Total amount for other manual invoices of a payment cycle (including taxes on stores)" }, "total_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount for payable orders including shipping charges (excluding taxes on orders)" }, "total_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount for payable orders including taxes (including taxes on orders)" }, "total_purchase_taxes" : { "type" : "number", "description" : "Total amount for purchase taxes" }, "total_refund_commissions_excl_tax" : { "type" : "number", "description" : "Total amount of refunded commissions (excluding taxes on orders)" }, "total_refund_commissions_incl_tax" : { "type" : "number", "description" : "Total amount of refunded commissions (including taxes on orders)" }, "total_refund_fee_excl_tax" : { "type" : "number", "description" : "Total amount of refunded fees (excluding taxes on orders)" }, "total_refund_fee_incl_tax" : { "type" : "number", "description" : "Total amount of refunded fees (including taxes on orders)" }, "total_refund_fee_operator_remitted_excl_tax" : { "type" : "number", "description" : "Total amount of refunded fees remitted by the operator (excluding taxes on orders)" }, "total_refund_fee_operator_remitted_incl_tax" : { "type" : "number", "description" : "Total amount of refunded fees remitted by the operator (including taxes on orders)" }, "total_refund_non_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount refunded for non payable orders (including shipping charges and excluding taxes on orders)" }, "total_refund_non_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount refunded for non payable orders (excluding shipping charges and including taxes on orders)" }, "total_refund_operator_paid_shipping_charges_excl_tax" : { "type" : "number", "description" : "Total amount of refunded shipping charges paid by the operator (excluding taxes on orders)" }, "total_refund_operator_paid_shipping_charges_incl_tax" : { "type" : "number", "description" : "Total amount of refunded shipping charges paid by the operator (including taxes on orders)" }, "total_refund_operator_remitted_taxes" : { "type" : "number", "description" : "Total amount of refunded taxes remitted by the operator" }, "total_refund_orders_excl_tax" : { "type" : "number", "description" : "Total amount of refunded orders (excluding all refunded taxes)" }, "total_refund_orders_incl_tax" : { "type" : "number", "description" : "Total amount of refunded orders (including all refunded taxes)" }, "total_refund_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount refunded for payable orders (excluding taxes on orders)" }, "total_refund_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount refunded for payable orders (including taxes on orders)" }, "total_refund_purchase_taxes" : { "type" : "number", "description" : "Total amount of refunded purchase taxes" }, "total_seller_fees_on_orders_excl_tax" : { "type" : "number", "description" : "Total amount of seller fees on orders (excluding taxes on orders)" }, "total_seller_fees_on_orders_incl_tax" : { "type" : "number", "description" : "Total amount of seller fees on orders (including taxes on orders)" }, "total_seller_penalty_fees_excl_tax" : { "type" : "number", "description" : "Total amount of seller penalty fees (excluding taxes on orders)" }, "total_seller_penalty_fees_incl_tax" : { "type" : "number", "description" : "Total amount of seller penalty fees (including taxes on orders)" }, "total_subscription_excl_tax" : { "type" : "number", "description" : "Total amount of subscription fees (excluding taxes on stores)" }, "total_subscription_incl_tax" : { "type" : "number", "description" : "Total amount of subscription taxes (including taxes on stores)" } } }, "IV01_Response_200_Invoices_Details" : { "type" : "object", "properties" : { "amount_excl_taxes" : { "type" : "number", "description" : "Amount excluding taxes" }, "description" : { "type" : "string", "description" : "Description" }, "operation_date" : { "type" : "string", "format" : "date-time", "description" : "Operation date for MANUAL_INVOICE or MANUAL_CREDIT type" }, "order_id" : { "type" : "string", "description" : "Associated order id. Only for MANUAL_INVOICE or MANUAL_CREDIT type" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity" }, "taxes" : { "type" : "array", "description" : "Taxes", "items" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_Details_Taxes" } } } }, "IV01_Response_200_Invoices_Details_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax code" } } }, "IV01_Response_200_Invoices_IssuingUser" : { "type" : "object", "properties" : { "information" : { "type" : "string", "description" : "User name if user type is OPERATOR or PARTNER, \"Automatic action\" if user type is BATCH" }, "type" : { "type" : "string", "description" : "User type (OPERATOR, BATCH or PARTNER)" } } }, "IV01_Response_200_Invoices_ManualCredit" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices" } ], "description" : "Manual accounting document", "properties" : { "seller_billing_cycle_id" : { "type" : "string", "description" : "The seller billing cycle identifier" } } }, "IV01_Response_200_Invoices_ManualInvoice" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices" } ], "description" : "Manual accounting document", "properties" : { "seller_billing_cycle_id" : { "type" : "string", "description" : "The seller billing cycle identifier" } } }, "IV01_Response_200_Invoices_Payment" : { "type" : "object", "properties" : { "failure_reason" : { "type" : "string", "description" : "Failure reason" }, "reference" : { "type" : "string", "description" : "Transaction reference" }, "state" : { "type" : "string", "description" : "Payment status" }, "transaction_date" : { "type" : "string", "format" : "date-time", "description" : "Transaction date" } } }, "IV01_Response_200_Invoices_ShopAddress" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "Shop contact address city" }, "civility" : { "type" : "string", "description" : "Shop contact civility" }, "country" : { "type" : "string", "description" : "Shop contact country (Formatted in ISO 3166-1). Used by Mirakl to format the address (back office, delivery bill, invoices...) and to adapt the address validation to the country (see zip_code field)" }, "firstname" : { "type" : "string", "description" : "Shop contact first name" }, "lastname" : { "type" : "string", "description" : "Shop contact last name" }, "phone" : { "type" : "string", "description" : "Shop contact phone number" }, "phone_secondary" : { "type" : "string", "description" : "Shop contact secondary phone number" }, "state" : { "type" : "string", "description" : "Shop contact address state" }, "street1" : { "type" : "string", "description" : "Shop contact address first line" }, "street2" : { "type" : "string", "description" : "Shop contact address second line" }, "zip_code" : { "type" : "string", "description" : "Shop contact address zip code. Mandatory (unless the country_iso_code corresponds to Chile or Peru)" } } }, "IV01_Response_200_Invoices_TotalTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax code" } } }, "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" } } }, "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" }, "dropship" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Dropship", "description" : "Dropship related features" }, "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_Dropship" : { "type" : "object", "properties" : { "retail_pricing_edition_enabled" : { "type" : "string", "description" : "Retail pricing edition enabled" }, "retail_pricing_enabled" : { "type" : "boolean", "description" : "Retail pricing activated on dropship offers" } } }, "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", "deprecated" : true, "description" : "Deprecated: Promotion availability is now controlled by operator settings (cart_promotion_campaign and seller_promotion)." }, "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" }, "enhanced_seller_invoicing" : { "$ref" : "#/components/schemas/PC01_Response_200_PlatformConfiguration_EnhancedSellerInvoicing", "description" : "Enhanced seller invoicing 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_EnhancedSellerInvoicing" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "description" : "Enhanced seller invoicing activated." } } }, "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" } } }, "RE01_Response_200" : { "type" : "object", "properties" : { "reasons" : { "type" : "array", "description" : "List of reasons detailed", "items" : { "$ref" : "#/components/schemas/RE01_Response_200_Reasons" } } } }, "RE01_Response_200_Reasons" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Reason code" }, "is_customer_right" : { "type" : "boolean", "description" : "Indicate if reason is enabled to the customer" }, "is_operator_right" : { "type" : "boolean", "description" : "Indicate if reason is enabled to the operator" }, "is_shop_right" : { "type" : "boolean", "description" : "Indicate if reason is enabled to the shop" }, "label" : { "type" : "string", "description" : "Reason label" }, "type" : { "type" : "string", "description" : "Type of the reason" } } }, "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" } } }, "SBC11_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/SBC11_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "SBC11_Response_200_Data" : { "type" : "object", "properties" : { "amount_transferred_to_operator" : { "type" : "number", "description" : "Total amount to be transferred to the operator" }, "amount_transferred_to_seller" : { "type" : "number", "description" : "Total amount to be transferred to the seller" }, "currency_iso_code" : { "type" : "string", "description" : "The currency of the shop" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Seller billing cycle creation date" }, "id" : { "type" : "string", "description" : "Seller billing cycle identifier" }, "pay_out" : { "$ref" : "#/components/schemas/SBC11_Response_200_Data_PayOut", "description" : "Pay-out details" }, "pay_out_psp_code" : { "type" : "string", "description" : "PSP code for Pay-out" }, "payment_voucher_number" : { "type" : "string", "description" : "The payment voucher number" }, "shop" : { "$ref" : "#/components/schemas/SBC11_Response_200_Data_Shop", "description" : "Shop information" }, "summary" : { "$ref" : "#/components/schemas/SBC11_Response_200_Data_Summary", "description" : "Financial summary of the billing cycle" } } }, "SBC11_Response_200_Data_PayOut" : { "type" : "object", "properties" : { "failure_reason" : { "type" : "string", "description" : "Pay-out failure reason, present only when state is FAILED" }, "reference" : { "type" : "string", "description" : "Pay-out reference, present only when state is PAID" }, "state" : { "type" : "string", "description" : "Pay-out state" }, "transaction_date" : { "type" : "string", "format" : "date-time", "description" : "Pay-out transaction date, present only when state is PAID" } } }, "SBC11_Response_200_Data_Shop" : { "type" : "object", "properties" : { "shop_corporate_name" : { "type" : "string", "description" : "Shop corporate name" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop identifier" }, "shop_model" : { "type" : "string", "description" : "Shop model" }, "shop_name" : { "type" : "string", "description" : "Shop name" }, "shop_operator_internal_id" : { "type" : "string", "description" : "Operator internal id for the shop" } } }, "SBC11_Response_200_Data_Summary" : { "type" : "object", "properties" : { "total_commissions_excl_tax" : { "type" : "number", "description" : "Total amount of commissions (excluding taxes on orders)" }, "total_commissions_incl_tax" : { "type" : "number", "description" : "Total amount of commissions (including taxes on orders)" }, "total_fee_excl_tax" : { "type" : "number", "description" : "Total amount of fees (excluding taxes on orders)" }, "total_fee_incl_tax" : { "type" : "number", "description" : "Total amount of fees (including taxes on orders)" }, "total_fee_operator_remitted_excl_tax" : { "type" : "number", "description" : "Total amount of fees remitted by the operator (excluding taxes on orders)" }, "total_fee_operator_remitted_incl_tax" : { "type" : "number", "description" : "Total amount of fees remitted by the operator (including taxes on orders)" }, "total_mirakl_ads_credit_excl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads credits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_credit_incl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads credits of a payment cycle (including taxes on stores)" }, "total_mirakl_ads_debit_excl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads debits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_debit_incl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads debits of a payment cycle (including taxes on stores)" }, "total_non_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount for non payable orders (including shipping charges and excluding taxes on orders)" }, "total_non_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount for non payable orders (including shipping charges and taxes on orders)" }, "total_operator_paid_shipping_charges_excl_tax" : { "type" : "number", "description" : "Total amount of shipping charges paid by the operator (excluding taxes on orders)" }, "total_operator_paid_shipping_charges_incl_tax" : { "type" : "number", "description" : "Total amount of shipping charges paid by the operator (including taxes on orders)" }, "total_operator_remitted_taxes" : { "type" : "number", "description" : "Total amount for order taxes remitted by the operator" }, "total_other_credits_excl_tax" : { "type" : "number", "description" : "Total amount for other manual credits of a payment cycle (excluding taxes on stores)" }, "total_other_credits_incl_tax" : { "type" : "number", "description" : "Total amount for other manual credits of a payment cycle (including taxes on stores)" }, "total_other_invoices_excl_tax" : { "type" : "number", "description" : "Total amount for other manual invoices of a payment cycle (excluding taxes on stores)" }, "total_other_invoices_incl_tax" : { "type" : "number", "description" : "Total amount for other manual invoices of a payment cycle (including taxes on stores)" }, "total_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount for payable orders including shipping charges (excluding taxes on orders)" }, "total_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount for payable orders including taxes (including taxes on orders)" }, "total_purchase_taxes" : { "type" : "number", "description" : "Total amount for purchase taxes" }, "total_refund_commissions_excl_tax" : { "type" : "number", "description" : "Total amount of refunded commissions (excluding taxes on orders)" }, "total_refund_commissions_incl_tax" : { "type" : "number", "description" : "Total amount of refunded commissions (including taxes on orders)" }, "total_refund_fee_excl_tax" : { "type" : "number", "description" : "Total amount of refunded fees (excluding taxes on orders)" }, "total_refund_fee_incl_tax" : { "type" : "number", "description" : "Total amount of refunded fees (including taxes on orders)" }, "total_refund_fee_operator_remitted_excl_tax" : { "type" : "number", "description" : "Total amount of refunded fees remitted by the operator (excluding taxes on orders)" }, "total_refund_fee_operator_remitted_incl_tax" : { "type" : "number", "description" : "Total amount of refunded fees remitted by the operator (including taxes on orders)" }, "total_refund_non_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount refunded for non payable orders (including shipping charges and excluding taxes on orders)" }, "total_refund_non_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount refunded for non payable orders (excluding shipping charges and including taxes on orders)" }, "total_refund_operator_paid_shipping_charges_excl_tax" : { "type" : "number", "description" : "Total amount of refunded shipping charges paid by the operator (excluding taxes on orders)" }, "total_refund_operator_paid_shipping_charges_incl_tax" : { "type" : "number", "description" : "Total amount of refunded shipping charges paid by the operator (including taxes on orders)" }, "total_refund_operator_remitted_taxes" : { "type" : "number", "description" : "Total amount of refunded taxes remitted by the operator" }, "total_refund_orders_excl_tax" : { "type" : "number", "description" : "Total amount of refunded orders (excluding all refunded taxes)" }, "total_refund_orders_incl_tax" : { "type" : "number", "description" : "Total amount of refunded orders (including all refunded taxes)" }, "total_refund_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount refunded for payable orders (excluding taxes on orders)" }, "total_refund_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount refunded for payable orders (including taxes on orders)" }, "total_refund_purchase_taxes" : { "type" : "number", "description" : "Total amount of refunded purchase taxes" }, "total_seller_fees_on_orders_excl_tax" : { "type" : "number", "description" : "Total amount of seller fees on orders (excluding taxes on orders)" }, "total_seller_fees_on_orders_incl_tax" : { "type" : "number", "description" : "Total amount of seller fees on orders (including taxes on orders)" }, "total_seller_penalty_fees_excl_tax" : { "type" : "number", "description" : "Total amount of seller penalty fees (excluding taxes on orders)" }, "total_seller_penalty_fees_incl_tax" : { "type" : "number", "description" : "Total amount of seller penalty fees (including taxes on orders)" }, "total_subscription_excl_tax" : { "type" : "number", "description" : "Total amount of subscription fees (excluding taxes on stores)" }, "total_subscription_incl_tax" : { "type" : "number", "description" : "Total amount of subscription taxes (including taxes on stores)" } } }, "SM11_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/SM11_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "SM11_Response_200_Data" : { "type" : "object", "properties" : { "booking" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Booking", "description" : "Indicates the booking method for services based on the model" }, "categories" : { "type" : "array", "description" : "Service model categories", "items" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Categories" } }, "code" : { "type" : "string", "description" : "Service model code" }, "consumption" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Consumption", "description" : "Indicates the consumption method for services based on the model" }, "custom_attributes" : { "type" : "array", "description" : "Service model custom attributes. The list is ordered as configured by the operator.", "items" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes" } }, "description" : { "type" : "string", "description" : "Service model description" }, "location" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Location", "description" : "Indicates the location method for services based on the model" }, "pricing" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing", "description" : "Indicates the pricing method for services based on the model" }, "quantity" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Quantity", "description" : "Indicate the quantity fields requirements for services based on the model" }, "title" : { "type" : "string", "description" : "Service model title" } } }, "SM11_Response_200_Data_Booking" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Booking type" } } }, "SM11_Response_200_Data_Categories" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Category code" }, "label" : { "type" : "string", "description" : "Category label" } } }, "SM11_Response_200_Data_Consumption" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Consumption type" } } }, "SM11_Response_200_Data_CustomAttributes" : { "type" : "object", "discriminator" : { "mapping" : { "BOOLEAN" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes", "DATE_TIME" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes", "DECIMAL" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes_Decimal", "INTEGER" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes", "LINK" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes", "LONG_TEXT" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes", "TEXT" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes", "VALUE_LIST" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes_ValueList", "VIDEO" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "Custom attribute code" }, "label" : { "type" : "string", "description" : "Custom attribute label" }, "order_configuration" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes_OrderConfiguration", "description" : "Custom attribute order configuration. Absent when the attribute is not applicable to orders." }, "service_configuration" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes_ServiceConfiguration", "description" : "Custom attribute service configuration. Absent when the attribute is not applicable to services." }, "type" : { "type" : "string", "description" : "Custom attribute type" } } }, "SM11_Response_200_Data_CustomAttributes_Decimal" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes" } ], "properties" : { "precision" : { "type" : "integer", "format" : "int32", "description" : "Precision of the decimal value" } } }, "SM11_Response_200_Data_CustomAttributes_OrderConfiguration" : { "type" : "object", "properties" : { "maximum_number_of_elements" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of elements. Present only for ValueLists. Absent when no limit." }, "shop_permission" : { "type" : "string", "description" : "Determines how Shops are allowed to use the custom attribute" } } }, "SM11_Response_200_Data_CustomAttributes_ServiceConfiguration" : { "type" : "object", "properties" : { "maximum_number_of_elements" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of elements. Present only for ValueLists. Absent when no limit." }, "minimum_number_of_elements" : { "type" : "integer", "format" : "int32", "description" : "Minimum number of elements. Equals to 0 if element is optional." } } }, "SM11_Response_200_Data_CustomAttributes_ValueList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes" } ], "properties" : { "available_values" : { "type" : "array", "description" : "Values of the list", "items" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_CustomAttributes_ValueList_AvailableValues" } } } }, "SM11_Response_200_Data_CustomAttributes_ValueList_AvailableValues" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Value list code" }, "label" : { "type" : "string", "description" : "Value list label" } } }, "SM11_Response_200_Data_Location" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Location type" } } }, "SM11_Response_200_Data_Pricing" : { "type" : "object", "properties" : { "options" : { "type" : "array", "description" : "Service model pricing options. The list is ordered as configured by the operator.", "items" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_Options" } }, "price_per_unit_options" : { "type" : "array", "description" : "Service model price per unit options. Always present if pricing is multi price.", "items" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_PricePerUnitOptions" } }, "type" : { "type" : "string", "description" : "Pricing type
When the price type is FIXED_PRICE, the price defined when placing an order is final. The price cannot be modified.
When the price type is ESTIMATED_PRICE, the price can be negotiated between the seller and the customer. The price can be updated by editing the pricing options of the order.
When the price type is FIXED_PRICE_MULTI, the price defined when placing an order is final. The price cannot be modified. The price has multiple possibilities.
When the price type is ESTIMATED_PRICE_MULTI, the price can be negotiated between the seller and the customer. The price can be updated by editing the pricing options of the order. The price has multiple possibilities.
" } } }, "SM11_Response_200_Data_Pricing_Options" : { "type" : "object", "discriminator" : { "mapping" : { "BOOLEAN" : "#/components/schemas/SM11_Response_200_Data_Pricing_Options_Boolean", "VALUE_LIST" : "#/components/schemas/SM11_Response_200_Data_Pricing_Options_ValueList" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "Option code" }, "label" : { "type" : "string", "description" : "Option label" }, "order_configuration" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_Options_OrderConfiguration", "description" : "Option order configuration" }, "type" : { "type" : "string" } } }, "SM11_Response_200_Data_Pricing_Options_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_Options" } ], "properties" : { "service_configuration" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_Options_Boolean_ServiceConfiguration", "description" : "Option service configuration" }, "type" : { "type" : "string", "description" : "" } } }, "SM11_Response_200_Data_Pricing_Options_Boolean_ServiceConfiguration" : { "type" : "object", "properties" : { "maximum_number_of_elements" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of elements. Present only for ValueLists. Absent when no limit." }, "minimum_number_of_elements" : { "type" : "integer", "format" : "int32", "description" : "Minimum number of elements. Equals to 0 if element is optional." } } }, "SM11_Response_200_Data_Pricing_Options_OrderConfiguration" : { "type" : "object", "properties" : { "maximum_number_of_elements" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of selectable elements. Present only for value lists. Absent when no limit." } } }, "SM11_Response_200_Data_Pricing_Options_ValueList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_Options" } ], "properties" : { "available_values" : { "type" : "array", "description" : "Values of the list", "items" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_Options_ValueList_AvailableValues" } }, "service_configuration" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_Options_ValueList_ServiceConfiguration", "description" : "Option service configuration" }, "type" : { "type" : "string", "description" : "" } } }, "SM11_Response_200_Data_Pricing_Options_ValueList_AvailableValues" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Value list code" }, "label" : { "type" : "string", "description" : "Value list label" } } }, "SM11_Response_200_Data_Pricing_Options_ValueList_ServiceConfiguration" : { "type" : "object", "properties" : { "maximum_number_of_elements" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of elements. Present only for ValueLists. Absent when no limit." }, "minimum_number_of_elements" : { "type" : "integer", "format" : "int32", "description" : "Minimum number of elements. Equals to 0 if element is optional." } } }, "SM11_Response_200_Data_Pricing_PricePerUnitOptions" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Code" }, "label" : { "type" : "string", "description" : "Label" }, "order_configuration" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_PricePerUnitOptions_OrderConfiguration" }, "service_configuration" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_PricePerUnitOptions_ServiceConfiguration" }, "type" : { "type" : "string", "description" : "" }, "values" : { "type" : "array", "description" : "Values of the list", "items" : { "$ref" : "#/components/schemas/SM11_Response_200_Data_Pricing_PricePerUnitOptions_Values" } } } }, "SM11_Response_200_Data_Pricing_PricePerUnitOptions_OrderConfiguration" : { "type" : "object", "properties" : { "minimum_number_of_elements" : { "type" : "integer", "format" : "int32", "description" : "Minimum number of elements." } } }, "SM11_Response_200_Data_Pricing_PricePerUnitOptions_ServiceConfiguration" : { "type" : "object", "properties" : { "minimum_number_of_elements" : { "type" : "integer", "format" : "int32", "description" : "Minimum number of elements." } } }, "SM11_Response_200_Data_Pricing_PricePerUnitOptions_Values" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Code" }, "label" : { "type" : "string", "description" : "Label" } } }, "SM11_Response_200_Data_Quantity" : { "type" : "object", "properties" : { "on_marketplace" : { "type" : "array", "description" : "Quantity requirements on the marketplace", "items" : { "type" : "string" } }, "per_order" : { "type" : "array", "description" : "Quantity requirements per order", "items" : { "type" : "string" } } } }, "SOR04_Request" : { "type" : "object", "properties" : { "booking" : { "$ref" : "#/components/schemas/SOR04_Request_Booking", "description" : "Booking information to update for this order." }, "custom_attribute_values" : { "type" : "array", "description" : "Order custom attribute values to update.
Only specified custom attribute values will be updated. In order to delete a custom attribute value, set it to null.", "items" : { "$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues" } }, "price" : { "$ref" : "#/components/schemas/SOR04_Request_Price", "description" : "New price for this order." } } }, "SOR04_Request_Booking" : { "type" : "object", "description" : "Booking information to update for this order.", "discriminator" : { "mapping" : { "DATETIME_REQUEST" : "#/components/schemas/SOR04_Request_Booking_DatetimeRequest", "NO_BOOKING" : "#/components/schemas/SOR04_Request_Booking_NoBooking", "SCHEDULED_EVENTS" : "#/components/schemas/SOR04_Request_Booking_ScheduledEvents" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string" } } }, "SOR04_Request_Booking_DatetimeRequest" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_Booking" } ], "properties" : { "confirmed_time_slots" : { "type" : "array", "description" : "List of time slots confirmed for this order. An order can only have one confirmed time slots for now.", "items" : { "$ref" : "#/components/schemas/SOR04_Request_Booking_DatetimeRequest_ConfirmedTimeSlots" }, "maxItems" : 1, "minItems" : 0 }, "type" : { "type" : "string", "description" : "" } } }, "SOR04_Request_Booking_DatetimeRequest_ConfirmedTimeSlots" : { "type" : "object", "properties" : { "from" : { "type" : "string", "format" : "date-time-without-timezone", "description" : "Date of Service start" }, "to" : { "type" : "string", "format" : "date-time-without-timezone", "description" : "Date of Service end" } } }, "SOR04_Request_Booking_NoBooking" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_Booking" } ], "properties" : { "type" : { "type" : "string", "description" : "" } } }, "SOR04_Request_Booking_ScheduledEvents" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_Booking" } ], "properties" : { "session" : { "$ref" : "#/components/schemas/SOR04_Request_Booking_ScheduledEvents_Session", "description" : "Session information to update for this order." }, "type" : { "type" : "string", "description" : "" } } }, "SOR04_Request_Booking_ScheduledEvents_Session" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Id of the session" } } }, "SOR04_Request_CustomAttributeValues" : { "type" : "object", "description" : "Order custom attribute values to update.
Only specified custom attribute values will be updated. In order to delete a custom attribute value, set it to null.", "discriminator" : { "mapping" : { "BOOLEAN" : "#/components/schemas/SOR04_Request_CustomAttributeValues_Boolean", "DATE_TIME" : "#/components/schemas/SOR04_Request_CustomAttributeValues_DateTime", "DECIMAL" : "#/components/schemas/SOR04_Request_CustomAttributeValues_Decimal", "INTEGER" : "#/components/schemas/SOR04_Request_CustomAttributeValues_Integer", "LINK" : "#/components/schemas/SOR04_Request_CustomAttributeValues_Link", "LONG_TEXT" : "#/components/schemas/SOR04_Request_CustomAttributeValues_LongText", "TEXT" : "#/components/schemas/SOR04_Request_CustomAttributeValues_Text", "VALUE_LIST" : "#/components/schemas/SOR04_Request_CustomAttributeValues_ValueList", "VIDEO" : "#/components/schemas/SOR04_Request_CustomAttributeValues_Video" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "Custom attribute code" }, "type" : { "type" : "string", "description" : "Custom attribute field type" }, "value" : { "type" : "object", "description" : "Custom attribute value" } } }, "SOR04_Request_CustomAttributeValues_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "boolean", "description" : "Custom attribute value" } } }, "SOR04_Request_CustomAttributeValues_DateTime" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "format" : "date-time", "description" : "Custom attribute value" } } }, "SOR04_Request_CustomAttributeValues_Decimal" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "number", "description" : "Custom attribute value" } } }, "SOR04_Request_CustomAttributeValues_Integer" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "integer", "format" : "int32", "description" : "Custom attribute value" } } }, "SOR04_Request_CustomAttributeValues_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute value" } } }, "SOR04_Request_CustomAttributeValues_LongText" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute value" } } }, "SOR04_Request_CustomAttributeValues_Text" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute value" } } }, "SOR04_Request_CustomAttributeValues_ValueList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "array", "description" : "Custom attribute value", "items" : { "type" : "string" } } } }, "SOR04_Request_CustomAttributeValues_Video" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute value" } } }, "SOR04_Request_Price" : { "type" : "object", "description" : "New price for this order.", "properties" : { "options" : { "type" : "array", "description" : "Order pricing options to update. Only specified pricing options will be updated (non specified pricing option will be ignored).
Please note that pricing options cannot be updated after the order is accepted (excluded).", "items" : { "$ref" : "#/components/schemas/SOR04_Request_Price_Options" } } } }, "SOR04_Request_Price_Options" : { "type" : "object", "description" : "Order pricing options to update. Only specified pricing options will be updated (non specified pricing option will be ignored).
Please note that pricing options cannot be updated after the order is accepted (excluded).", "discriminator" : { "mapping" : { "BOOLEAN" : "#/components/schemas/SOR04_Request_Price_Options_Boolean", "VALUE_LIST" : "#/components/schemas/SOR04_Request_Price_Options_ValueList" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "Option code" }, "type" : { "type" : "string" } } }, "SOR04_Request_Price_Options_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_Price_Options" } ], "properties" : { "amount" : { "type" : "number", "description" : "Amount of the pricing option to update. Required if value is present. In order to delete a pricing option, set it to null (along with value).", "maximum" : 1000000000, "minimum" : 0 }, "taxes" : { "type" : "array", "description" : "Tax amounts to update.
If the taxes node is provided, all previous tax information on this pricing option will be replaced by the new ones. So, in order to delete all the taxes, set the taxes node to null.", "items" : { "$ref" : "#/components/schemas/SOR04_Request_Price_Options_Boolean_Taxes" } }, "type" : { "type" : "string", "description" : "" }, "value" : { "type" : "boolean", "description" : "Value of the pricing option to update. Required if amount is present. In order to delete a pricing option, set it to null (along with amount)." } } }, "SOR04_Request_Price_Options_Boolean_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount of the tax", "maximum" : 1000000000, "minimum" : 0 }, "code" : { "type" : "string", "description" : "Code of the tax" } } }, "SOR04_Request_Price_Options_ValueList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Request_Price_Options" } ], "properties" : { "values" : { "type" : "array", "description" : "Values of the pricing option to update.
If the values node is provided, all previous values on this pricing option will be replaced by the new ones. In order to delete a pricing option, set the values node to null.", "items" : { "$ref" : "#/components/schemas/SOR04_Request_Price_Options_ValueList_Values" } } } }, "SOR04_Request_Price_Options_ValueList_Values" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount of the item", "maximum" : 1000000000, "minimum" : 0 }, "code" : { "type" : "string", "description" : "Code of the item" }, "taxes" : { "type" : "array", "description" : "Tax amounts to update.
If the taxes node is provided, all previous tax information on this pricing option will be replaced by the new ones. So, in order to delete all the taxes, set the taxes node to null.", "items" : { "$ref" : "#/components/schemas/SOR04_Request_Price_Options_ValueList_Values_Taxes" } } } }, "SOR04_Request_Price_Options_ValueList_Values_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount of the tax", "maximum" : 1000000000, "minimum" : 0 }, "code" : { "type" : "string", "description" : "Code of the tax" } } }, "SOR04_Response_200" : { "type" : "object", "properties" : { "booking" : { "$ref" : "#/components/schemas/SOR04_Response_200_Booking", "description" : "Order booking information" }, "can_evaluate" : { "type" : "boolean", "description" : "Indicates if the order can be evaluated by the customer" }, "commercial_order_id" : { "type" : "string", "description" : "Order commercial ID" }, "commission" : { "$ref" : "#/components/schemas/SOR04_Response_200_Commission", "description" : "Order commission" }, "consumption" : { "$ref" : "#/components/schemas/SOR04_Response_200_Consumption", "description" : "Order consumption information" }, "currency_code" : { "type" : "string", "description" : "Order currency ISO Code" }, "custom_attribute_values" : { "type" : "array", "description" : "Custom attribute values defined on the order", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues" } }, "customer" : { "$ref" : "#/components/schemas/SOR04_Response_200_Customer", "description" : "Customer who purchased the service" }, "date_accepted" : { "type" : "string", "format" : "date-time", "description" : "Order acceptance date" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Order creation date" }, "date_updated" : { "type" : "string", "format" : "date-time", "description" : "Order last modification date" }, "has_open_incident" : { "type" : "boolean", "description" : "true if order has an incident open" }, "id" : { "type" : "string", "description" : "Order ID" }, "imprint_number" : { "type" : "string", "description" : "Order imprint number" }, "location" : { "$ref" : "#/components/schemas/SOR04_Response_200_Location", "description" : "Order location" }, "payment_type" : { "type" : "string", "description" : "Order payment type" }, "price" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price", "description" : "Order price" }, "refunds" : { "type" : "array", "description" : "The list of refunds, sorted by creation date in ascending order", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Refunds" } }, "service" : { "$ref" : "#/components/schemas/SOR04_Response_200_Service", "description" : "The service that was purchased" }, "shop" : { "$ref" : "#/components/schemas/SOR04_Response_200_Shop", "description" : "Order shop" }, "state" : { "type" : "string", "description" : "Order state" }, "warnings" : { "type" : "array", "description" : "A list of warnings that should be checked before validating the order", "items" : { "type" : "string" } }, "workflow" : { "$ref" : "#/components/schemas/SOR04_Response_200_Workflow", "description" : "Order workflow" } } }, "SOR04_Response_200_Booking" : { "type" : "object", "discriminator" : { "mapping" : { "DATETIME_REQUEST" : "#/components/schemas/SOR04_Response_200_Booking_DatetimeRequest", "NO_BOOKING" : "#/components/schemas/SOR04_Response_200_Booking_NoBooking", "SCHEDULED_EVENT" : "#/components/schemas/SOR04_Response_200_Booking_ScheduledEvent" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "description" : "" } } }, "SOR04_Response_200_Booking_DatetimeRequest" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Booking" } ], "properties" : { "confirmed_time_slots" : { "type" : "array", "description" : "Confirmed time slots by the shop", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Booking_DatetimeRequest_ConfirmedTimeSlots" } }, "contact_additional_info" : { "type" : "string", "description" : "Additional customer contact information" }, "contact_info" : { "type" : "string", "description" : "Customer contact information that will be used by the shop" }, "time_slots" : { "type" : "array", "description" : "Preferred time slots selected by the customer", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Booking_DatetimeRequest_TimeSlots" } } } }, "SOR04_Response_200_Booking_DatetimeRequest_ConfirmedTimeSlots" : { "type" : "object", "properties" : { "from" : { "type" : "string", "format" : "date-time-without-timezone", "description" : "Date of Service start" }, "to" : { "type" : "string", "format" : "date-time-without-timezone", "description" : "Date of Service end" } } }, "SOR04_Response_200_Booking_DatetimeRequest_TimeSlots" : { "type" : "object", "properties" : { "from" : { "type" : "string", "format" : "date-time-without-timezone", "description" : "Date of Service start" }, "to" : { "type" : "string", "format" : "date-time-without-timezone", "description" : "Date of Service end" } } }, "SOR04_Response_200_Booking_NoBooking" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Booking" } ] }, "SOR04_Response_200_Booking_ScheduledEvent" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Booking" } ], "properties" : { "contact_additional_info" : { "type" : "string", "description" : "Additional customer contact information" }, "contact_info" : { "type" : "string", "description" : "Customer contact information that will be used by the shop" }, "session" : { "$ref" : "#/components/schemas/SOR04_Response_200_Booking_ScheduledEvent_Session", "description" : "Session ordered by the customer" } } }, "SOR04_Response_200_Booking_ScheduledEvent_Session" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Session id" }, "timeslot" : { "$ref" : "#/components/schemas/SOR04_Response_200_Booking_ScheduledEvent_Session_Timeslot", "description" : "Session timeslot" } } }, "SOR04_Response_200_Booking_ScheduledEvent_Session_Timeslot" : { "type" : "object", "properties" : { "end" : { "type" : "string", "format" : "date-time", "description" : "End date of the timeslot" }, "start" : { "type" : "string", "format" : "date-time", "description" : "Start date of the timeslot" } } }, "SOR04_Response_200_Commission" : { "type" : "object", "properties" : { "amount_excluding_taxes" : { "type" : "number", "description" : "Order commission amount, shop taxes excluded" }, "amount_including_taxes" : { "type" : "number", "description" : "Order commission amount, shop taxes included" }, "commission_taxes" : { "type" : "array", "description" : "Shop commission taxes", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Commission_CommissionTaxes" } } } }, "SOR04_Response_200_Commission_CommissionTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax code" } } }, "SOR04_Response_200_Consumption" : { "type" : "object", "discriminator" : { "mapping" : { "CONFIRMATION_BY_SHOP" : "#/components/schemas/SOR04_Response_200_Consumption_ConfirmationByShop", "VOUCHER" : "#/components/schemas/SOR04_Response_200_Consumption_Voucher" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "description" : "" } } }, "SOR04_Response_200_Consumption_ConfirmationByShop" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Consumption" } ], "properties" : { "date_consumed" : { "type" : "string", "format" : "date-time", "description" : "Order consumption date" }, "date_expiration" : { "type" : "string", "format" : "date-time", "description" : "Order consumption expiration date" } } }, "SOR04_Response_200_Consumption_Voucher" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Consumption" } ], "properties" : { "date_consumed" : { "type" : "string", "format" : "date-time", "description" : "Voucher consumption date" }, "date_expiration" : { "type" : "string", "format" : "date-time", "description" : "Voucher expiration date" }, "voucher_code" : { "type" : "string", "description" : "Voucher code" } } }, "SOR04_Response_200_CustomAttributeValues" : { "type" : "object", "discriminator" : { "mapping" : { "BOOLEAN" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues_Boolean", "DATE_TIME" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues_DateTime", "DECIMAL" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues_Decimal", "INTEGER" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues_Integer", "LINK" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues_Link", "LONG_TEXT" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues_LongText", "TEXT" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues_Text", "VALUE_LIST" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues_ValueList", "VIDEO" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues_Video" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "Custom attribute code" }, "label" : { "type" : "string", "description" : "Custom attribute label" }, "type" : { "type" : "string", "description" : "Custom attribute field type" }, "value" : { "type" : "object", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_CustomAttributeValues_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "boolean", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_CustomAttributeValues_DateTime" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "format" : "date-time", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_CustomAttributeValues_Decimal" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "number", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_CustomAttributeValues_Integer" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "integer", "format" : "int32", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_CustomAttributeValues_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_CustomAttributeValues_LongText" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_CustomAttributeValues_Text" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_CustomAttributeValues_ValueList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "array", "description" : "Custom attribute field value", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues_ValueList_Value" } } } }, "SOR04_Response_200_CustomAttributeValues_ValueList_Value" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Code of the item" }, "label" : { "type" : "string", "description" : "Label of the item" } } }, "SOR04_Response_200_CustomAttributeValues_Video" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_Customer" : { "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/SOR04_Response_200_Customer_BillingAddress", "description" : "Billing address of the customer" }, "civility" : { "type" : "string", "description" : "Civility of the customer" }, "email" : { "type" : "string", "description" : "Email of the customer" }, "first_name" : { "type" : "string", "description" : "First name of the customer" }, "id" : { "type" : "string", "description" : "Identifier of the customer" }, "last_name" : { "type" : "string", "description" : "Last name of the customer" }, "locale" : { "type" : "string", "description" : "RFC 3066 code of the customer's locale" }, "phone_number" : { "type" : "string", "description" : "Phone number of the customer" } } }, "SOR04_Response_200_Customer_BillingAddress" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "City of the address", "maxLength" : 255, "minLength" : 0 }, "civility" : { "type" : "string", "description" : "Civility of the person associated with the address", "maxLength" : 20, "minLength" : 0 }, "company" : { "type" : "string", "description" : "Company of the person associated with the address", "maxLength" : 255, "minLength" : 0 }, "complementary" : { "type" : "string", "description" : "Complementary information line of the street of the address" }, "country" : { "type" : "string", "description" : "Country of the address", "maxLength" : 255, "minLength" : 0 }, "country_code" : { "type" : "string", "description" : "Country ISO 3166-1 alpha-3 code of the address, used by Mirakl to format the address (back-office, delivery bill, invoices...)" }, "first_name" : { "type" : "string", "description" : "First name of the person associated with the address", "maxLength" : 255, "minLength" : 0 }, "last_name" : { "type" : "string", "description" : "Last name of the person associated with the address", "maxLength" : 255, "minLength" : 0 }, "state" : { "type" : "string", "description" : "State of the address", "maxLength" : 255, "minLength" : 0 }, "street1" : { "type" : "string", "description" : "First information line of the street of the address", "maxLength" : 255, "minLength" : 0 }, "street2" : { "type" : "string", "description" : "Second information line of the street of the address", "maxLength" : 255, "minLength" : 0 }, "zip_code" : { "type" : "string", "description" : "Zip code of the address", "maxLength" : 255, "minLength" : 0 } } }, "SOR04_Response_200_Location" : { "type" : "object", "discriminator" : { "mapping" : { "AT_CUSTOMER_LOCATION" : "#/components/schemas/SOR04_Response_200_Location_AtCustomerLocation", "AT_SHOP_LOCATION" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation", "NO_LOCATION" : "#/components/schemas/SOR04_Response_200_Location_NoLocation" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "description" : "" } } }, "SOR04_Response_200_Location_AtCustomerLocation" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Location" } ], "description" : "The Service is provided at customer location", "properties" : { "customer_address" : { "$ref" : "#/components/schemas/SOR04_Response_200_Location_AtCustomerLocation_CustomerAddress", "description" : "Customer's address" } } }, "SOR04_Response_200_Location_AtCustomerLocation_CustomerAddress" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "City of the address", "maxLength" : 255, "minLength" : 0 }, "civility" : { "type" : "string", "description" : "Civility of the person associated with the address", "maxLength" : 20, "minLength" : 0 }, "company" : { "type" : "string", "description" : "Company of the person associated with the address", "maxLength" : 255, "minLength" : 0 }, "complementary" : { "type" : "string", "description" : "Complementary information line of the street of the address" }, "country" : { "type" : "string", "description" : "Country of the address", "maxLength" : 255, "minLength" : 0 }, "country_code" : { "type" : "string", "description" : "Country ISO 3166-1 alpha-3 code of the address, used by Mirakl to format the address (back-office, delivery bill, invoices...)" }, "first_name" : { "type" : "string", "description" : "First name of the person associated with the address", "maxLength" : 255, "minLength" : 0 }, "last_name" : { "type" : "string", "description" : "Last name of the person associated with the address", "maxLength" : 255, "minLength" : 0 }, "state" : { "type" : "string", "description" : "State of the address", "maxLength" : 255, "minLength" : 0 }, "street1" : { "type" : "string", "description" : "First information line of the street of the address", "maxLength" : 255, "minLength" : 0 }, "street2" : { "type" : "string", "description" : "Second information line of the street of the address", "maxLength" : 255, "minLength" : 0 }, "zip_code" : { "type" : "string", "description" : "Zip code of the address", "maxLength" : 255, "minLength" : 0 } } }, "SOR04_Response_200_Location_AtShopLocation" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Location" } ], "description" : "The Service takes place at shop location", "properties" : { "shop_locations" : { "type" : "array", "description" : "Locations where the service can be provided", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations" } } } }, "SOR04_Response_200_Location_AtShopLocation_ShopLocations" : { "type" : "object", "properties" : { "geography" : { "$ref" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography", "description" : "Geographic information of the location" }, "id" : { "type" : "string", "description" : "Location ID" }, "label" : { "type" : "string", "description" : "Location label" } } }, "SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography" : { "type" : "object", "discriminator" : { "mapping" : { "CIRCLE" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_Circle", "POINT" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_Point", "ZONE_REFERENCES" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_ZoneReferences" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string" } } }, "SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_Circle" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography" } ], "properties" : { "center" : { "$ref" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_Circle_Center", "description" : "Center of the area covered by the location" }, "radius" : { "type" : "integer", "format" : "int32", "description" : "Radius covered from the center, in meters" } } }, "SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_Circle_Center" : { "type" : "object", "properties" : { "latitude" : { "type" : "number", "format" : "double", "description" : "WSG84 latitude of the point" }, "longitude" : { "type" : "number", "format" : "double", "description" : "WSG84 longitude of the point" } } }, "SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_Point" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography" } ], "properties" : { "distance" : { "type" : "integer", "format" : "int32", "description" : "Distance from the search center in meters. Null if no search center was used in request." }, "geocode" : { "$ref" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_Point_Geocode", "description" : "Geocode of the location" } } }, "SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_Point_Geocode" : { "type" : "object", "properties" : { "latitude" : { "type" : "number", "format" : "double", "description" : "WSG84 latitude of the point" }, "longitude" : { "type" : "number", "format" : "double", "description" : "WSG84 longitude of the point" } } }, "SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_ZoneReferences" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography" } ], "properties" : { "zone_references" : { "type" : "array", "description" : "ZoneReferences covered by this location", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_ZoneReferences_ZoneReferences" } } } }, "SOR04_Response_200_Location_AtShopLocation_ShopLocations_Geography_ZoneReferences_ZoneReferences" : { "type" : "object", "description" : "Reference to an administrative division", "properties" : { "formatted_address" : { "type" : "string", "description" : "Formatted address of the zone reference." }, "reference_id" : { "type" : "string", "description" : "Id of the zone reference." } } }, "SOR04_Response_200_Location_NoLocation" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Location" } ], "description" : "The Service is provided remotely (hence has no location)" }, "SOR04_Response_200_Price" : { "type" : "object", "discriminator" : { "mapping" : { "ESTIMATED_PRICE" : "#/components/schemas/SOR04_Response_200_Price_EstimatedPrice", "ESTIMATED_PRICE_MULTI" : "#/components/schemas/SOR04_Response_200_Price_EstimatedPriceMulti", "FIXED_PRICE" : "#/components/schemas/SOR04_Response_200_Price_FixedPrice", "FIXED_PRICE_MULTI" : "#/components/schemas/SOR04_Response_200_Price_FixedPriceMulti" }, "propertyName" : "type" }, "properties" : { "options" : { "type" : "array", "description" : "Order pricing options. The list is ordered as configured by the operator at the time of the order.", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price_Options" } }, "type" : { "type" : "string", "description" : "" } } }, "SOR04_Response_200_Price_EstimatedPrice" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Price" } ], "properties" : { "amount" : { "type" : "number", "description" : "Amount which will be paid by the Customer for one item (unit price). If taxes or options are also given, this amount is considered as 'excluding taxes and options' and the total amount of the order can be determined by adding this amount, all tax amounts and all options amounts." }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Order quantity" }, "taxes" : { "type" : "array", "description" : "Order tax amounts", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price_EstimatedPrice_Taxes" } } } }, "SOR04_Response_200_Price_EstimatedPriceMulti" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Price" } ], "properties" : { "ordered_service_units" : { "type" : "array", "description" : "Ordered service units", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price_EstimatedPriceMulti_OrderedServiceUnits" } } } }, "SOR04_Response_200_Price_EstimatedPriceMulti_OrderedServiceUnits" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Code" }, "label" : { "type" : "string", "description" : "Label" }, "type" : { "type" : "string", "description" : "Type" }, "values" : { "type" : "array", "description" : "Values", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price_EstimatedPriceMulti_OrderedServiceUnits_Values" } } } }, "SOR04_Response_200_Price_EstimatedPriceMulti_OrderedServiceUnits_Values" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount" }, "code" : { "type" : "string", "description" : "Code" }, "ordered_quantity" : { "type" : "integer", "format" : "int32", "description" : "Ordered quantity" } } }, "SOR04_Response_200_Price_EstimatedPrice_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount of the tax", "maximum" : 1000000000, "minimum" : 0 }, "code" : { "type" : "string", "description" : "Code of the tax" } } }, "SOR04_Response_200_Price_FixedPrice" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Price" } ], "properties" : { "amount" : { "type" : "number", "description" : "Amount which will be paid by the Customer for one item (unit price). If taxes or options are also given, this amount is considered as 'excluding taxes and options' and the total amount of the order can be determined by adding this amount, all tax amounts and all options amounts." }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Order quantity" }, "taxes" : { "type" : "array", "description" : "Order tax amounts", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price_FixedPrice_Taxes" } } } }, "SOR04_Response_200_Price_FixedPriceMulti" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Price" } ], "properties" : { "ordered_service_units" : { "type" : "array", "description" : "Ordered service units", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price_FixedPriceMulti_OrderedServiceUnits" } } } }, "SOR04_Response_200_Price_FixedPriceMulti_OrderedServiceUnits" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Code" }, "label" : { "type" : "string", "description" : "Label" }, "type" : { "type" : "string", "description" : "Type" }, "values" : { "type" : "array", "description" : "Values", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price_FixedPriceMulti_OrderedServiceUnits_Values" } } } }, "SOR04_Response_200_Price_FixedPriceMulti_OrderedServiceUnits_Values" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount" }, "code" : { "type" : "string", "description" : "Code" }, "ordered_quantity" : { "type" : "integer", "format" : "int32", "description" : "Ordered quantity" } } }, "SOR04_Response_200_Price_FixedPrice_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount of the tax", "maximum" : 1000000000, "minimum" : 0 }, "code" : { "type" : "string", "description" : "Code of the tax" } } }, "SOR04_Response_200_Price_Options" : { "type" : "object", "discriminator" : { "mapping" : { "BOOLEAN" : "#/components/schemas/SOR04_Response_200_Price_Options_Boolean", "VALUE_LIST" : "#/components/schemas/SOR04_Response_200_Price_Options_ValueList" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "Option code" }, "label" : { "type" : "string", "description" : "Option label" }, "type" : { "type" : "string" } } }, "SOR04_Response_200_Price_Options_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Price_Options" } ], "properties" : { "amount" : { "type" : "number", "description" : "Option amount" }, "taxes" : { "type" : "array", "description" : "Option tax amounts", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price_Options_Boolean_Taxes" } }, "type" : { "type" : "string", "description" : "" }, "value" : { "type" : "boolean", "description" : "Option value" } } }, "SOR04_Response_200_Price_Options_Boolean_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount of the tax", "maximum" : 1000000000, "minimum" : 0 }, "code" : { "type" : "string", "description" : "Code of the tax" } } }, "SOR04_Response_200_Price_Options_ValueList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Price_Options" } ], "properties" : { "type" : { "type" : "string", "description" : "" }, "values" : { "type" : "array", "description" : "", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price_Options_ValueList_Values" } } } }, "SOR04_Response_200_Price_Options_ValueList_Values" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Value list item amount" }, "code" : { "type" : "string", "description" : "Value list item code" }, "label" : { "type" : "string", "description" : "Value list item label" }, "taxes" : { "type" : "array", "description" : "Value list item tax amounts", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Price_Options_ValueList_Values_Taxes" } } } }, "SOR04_Response_200_Price_Options_ValueList_Values_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount of the tax", "maximum" : 1000000000, "minimum" : 0 }, "code" : { "type" : "string", "description" : "Code of the tax" } } }, "SOR04_Response_200_Refunds" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount which was refunded. If taxes or options are also present, this amount is considered as 'excluding taxes and options' and the total amount of the refund can be determined by adding this amount, all tax amounts and all options amounts." }, "commission" : { "$ref" : "#/components/schemas/SOR04_Response_200_Refunds_Commission", "description" : "Refunded commission" }, "creation_date" : { "type" : "string", "format" : "date-time", "description" : "Refund creation date" }, "id" : { "type" : "string", "description" : "Refund ID" }, "options" : { "type" : "array", "description" : "Pricing options", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Refunds_Options" } }, "reason_code" : { "type" : "string", "description" : "Refund reason code" }, "state" : { "type" : "string", "description" : "Refund state" }, "taxes" : { "type" : "array", "description" : "Tax amounts", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Refunds_Taxes" } }, "transaction_date" : { "type" : "string", "format" : "date-time", "description" : "Transaction number/code" }, "transaction_number" : { "type" : "string", "description" : "Transaction date" } } }, "SOR04_Response_200_Refunds_Commission" : { "type" : "object", "properties" : { "amount_excluding_taxes" : { "type" : "number", "description" : "Order commission amount, shop taxes excluded" }, "amount_including_taxes" : { "type" : "number", "description" : "Order commission amount, shop taxes included" }, "commission_taxes" : { "type" : "array", "description" : "Shop commission taxes", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Refunds_Commission_CommissionTaxes" } } } }, "SOR04_Response_200_Refunds_Commission_CommissionTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax code" } } }, "SOR04_Response_200_Refunds_Options" : { "type" : "object", "discriminator" : { "mapping" : { "BOOLEAN" : "#/components/schemas/SOR04_Response_200_Refunds_Options_Boolean", "VALUE_LIST" : "#/components/schemas/SOR04_Response_200_Refunds_Options_ValueList" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "Option code" }, "label" : { "type" : "string", "description" : "Option label" }, "type" : { "type" : "string" } } }, "SOR04_Response_200_Refunds_Options_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Refunds_Options" } ], "properties" : { "amount" : { "type" : "number", "description" : "Option amount" }, "taxes" : { "type" : "array", "description" : "Option tax amounts", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Refunds_Options_Boolean_Taxes" } }, "type" : { "type" : "string", "description" : "" }, "value" : { "type" : "boolean", "description" : "Option value" } } }, "SOR04_Response_200_Refunds_Options_Boolean_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount of the tax", "maximum" : 1000000000, "minimum" : 0 }, "code" : { "type" : "string", "description" : "Code of the tax" } } }, "SOR04_Response_200_Refunds_Options_ValueList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Refunds_Options" } ], "properties" : { "type" : { "type" : "string", "description" : "" }, "values" : { "type" : "array", "description" : "", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Refunds_Options_ValueList_Values" } } } }, "SOR04_Response_200_Refunds_Options_ValueList_Values" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Value list item amount" }, "code" : { "type" : "string", "description" : "Value list item code" }, "label" : { "type" : "string", "description" : "Value list item label" }, "taxes" : { "type" : "array", "description" : "Value list item tax amounts", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Refunds_Options_ValueList_Values_Taxes" } } } }, "SOR04_Response_200_Refunds_Options_ValueList_Values_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount of the tax", "maximum" : 1000000000, "minimum" : 0 }, "code" : { "type" : "string", "description" : "Code of the tax" } } }, "SOR04_Response_200_Refunds_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Amount of the tax", "maximum" : 1000000000, "minimum" : 0 }, "code" : { "type" : "string", "description" : "Code of the tax" } } }, "SOR04_Response_200_Service" : { "type" : "object", "properties" : { "category" : { "$ref" : "#/components/schemas/SOR04_Response_200_Service_Category", "description" : "Service category" }, "code" : { "type" : "string", "description" : "Service code" }, "custom_attribute_values" : { "type" : "array", "description" : "Custom attribute values defined on the service", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues" } }, "description" : { "type" : "string", "description" : "Service description" }, "medias" : { "type" : "array", "description" : "Service medias", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Service_Medias" } }, "model" : { "$ref" : "#/components/schemas/SOR04_Response_200_Service_Model", "description" : "Service model" }, "title" : { "type" : "string", "description" : "Service title" } } }, "SOR04_Response_200_Service_Category" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Category code" }, "label" : { "type" : "string", "description" : "Category label" } } }, "SOR04_Response_200_Service_CustomAttributeValues" : { "type" : "object", "discriminator" : { "mapping" : { "BOOLEAN" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues_Boolean", "DATE_TIME" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues_DateTime", "DECIMAL" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues_Decimal", "INTEGER" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues_Integer", "LINK" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues_Link", "LONG_TEXT" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues_LongText", "TEXT" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues_Text", "VALUE_LIST" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues_ValueList", "VIDEO" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues_Video" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "Custom attribute code" }, "label" : { "type" : "string", "description" : "Custom attribute label" }, "type" : { "type" : "string", "description" : "Custom attribute field type" }, "value" : { "type" : "object", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_Service_CustomAttributeValues_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "boolean", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_Service_CustomAttributeValues_DateTime" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "format" : "date-time", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_Service_CustomAttributeValues_Decimal" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "number", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_Service_CustomAttributeValues_Integer" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "integer", "format" : "int32", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_Service_CustomAttributeValues_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_Service_CustomAttributeValues_LongText" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_Service_CustomAttributeValues_Text" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_Service_CustomAttributeValues_ValueList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "array", "description" : "Custom attribute field value", "items" : { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues_ValueList_Value" } } } }, "SOR04_Response_200_Service_CustomAttributeValues_ValueList_Value" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Code of the item" }, "label" : { "type" : "string", "description" : "Label of the item" } } }, "SOR04_Response_200_Service_CustomAttributeValues_Video" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/SOR04_Response_200_Service_CustomAttributeValues" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom attribute field value" } } }, "SOR04_Response_200_Service_Medias" : { "type" : "object", "properties" : { "mime_type" : { "type" : "string", "description" : "Media Mime type" }, "url" : { "type" : "string", "description" : "Media URL" } } }, "SOR04_Response_200_Service_Model" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Service model code" }, "label" : { "type" : "string", "description" : "Service model label" } } }, "SOR04_Response_200_Shop" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "description" : "Shop ID" }, "name" : { "type" : "string", "description" : "Shop name" } } }, "SOR04_Response_200_Workflow" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Order workflow type" } } }, "SOR25_Request" : { "type" : "object", "properties" : { "date_consumed" : { "type" : "string", "format" : "date-time", "description" : "Service consumption date. Required only when the Order consumption must be confirmed by Shop" }, "voucher_code" : { "type" : "string", "description" : "Service voucher code. Required only when the Order consumption requires a voucher" } } }, "SOR51_Response_200" : { "type" : "object", "properties" : { "assessments" : { "type" : "array", "description" : "List of assessments", "items" : { "$ref" : "#/components/schemas/SOR51_Response_200_Assessments" } }, "comment" : { "type" : "string", "description" : "Evaluation comment" }, "customer_id" : { "type" : "string", "description" : "Identifier of the customer who posted the evaluation" }, "date" : { "type" : "string", "format" : "date-time", "description" : "Evaluation creation date" }, "firstname" : { "type" : "string", "description" : "First name of the customer who posted the evaluation" }, "grade" : { "type" : "integer", "format" : "int32", "description" : "Evaluation grade" }, "last_updated_date" : { "type" : "string", "format" : "date-time", "description" : "Evaluation last updated date" }, "lastname" : { "type" : "string", "description" : "Last name of the customer who posted the evaluation" }, "reply" : { "$ref" : "#/components/schemas/SOR51_Response_200_Reply", "description" : "Reply of a shop or operator on an evaluation" }, "visible" : { "type" : "boolean", "description" : "Whether the evaluation is visible or not" } } }, "SOR51_Response_200_Assessments" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Assessment code" }, "label" : { "type" : "string", "description" : "Assessment label" }, "response" : { "type" : "string", "description" : "Response associated with the assessment" } } }, "SOR51_Response_200_Reply" : { "type" : "object", "properties" : { "comment" : { "type" : "string", "description" : "Text of the reply", "maxLength" : 1000, "minLength" : 1 }, "date" : { "type" : "string", "format" : "date-time", "description" : "Reply date" }, "type" : { "type" : "string", "description" : "Type of user who replied" } } } }, "securitySchemes" : { "Front-Bearer-Token" : { "bearerFormat" : "JWT", "scheme" : "bearer", "type" : "http" }, "OAuth-2" : { "description" : "For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partners_integration/authentication_system.htm)", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://auth.mirakl.net/authorize", "refreshUrl" : "https://auth.mirakl.net/oauth/token", "scopes" : { }, "tokenUrl" : "https://auth.mirakl.net/oauth/token" } }, "type" : "oauth2" }, "front_api_key" : { "in" : "header", "name" : "Authorization", "type" : "apiKey" } } }, "info" : { "title" : "Mirakl Platform for Services APIs", "version" : "latest-release" }, "openapi" : "3.0.1", "paths" : { "/api/additional_fields" : { "get" : { "description" : "", "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" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "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" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List all enabled channels", "tags" : [ "Platform Settings" ] } }, "/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" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List currency codes and labels", "tags" : [ "Platform Settings" ] } }, "/api/documents" : { "get" : { "description" : "", "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" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List all document types", "tags" : [ "Platform Settings" ] } }, "/api/invoices" : { "get" : { "description" : "⚠️ Note: When the Enhanced Seller Invoicing toggle is enabled, IV01 will contain no new data. Use the SBC11 and DR11 APIs instead.", "operationId" : "IV01", "parameters" : [ { "description" : "Currency code for filtering", "explode" : true, "in" : "query", "name" : "currency", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Creation date for filtering", "explode" : true, "in" : "query", "name" : "end_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Invoice IDs for filtering. This parameter can be supplied multiple times or be a comma-separated list.", "explode" : true, "in" : "query", "name" : "invoice_id", "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" }, "maxItems" : 100 }, "style" : "form" }, { "description" : "A comma separated list of issuing user type for filtering. By default all types are returned", "explode" : true, "in" : "query", "name" : "issuing_user_types", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "A comma-separated list of pay-out PSP codes for filtering. This parameter requires the Hybrid pay-out PSP feature to be enabled.", "explode" : true, "in" : "query", "name" : "pay_out_psp_codes", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Accounting document payment state", "explode" : true, "in" : "query", "name" : "payment_status", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Payment voucher for filtering", "explode" : true, "in" : "query", "name" : "payment_voucher_number", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Seller billing cycle IDs for filtering. This parameter can be supplied multiple times or be a comma-separated list.", "explode" : true, "in" : "query", "name" : "seller_billing_cycle_id", "schema" : { "type" : "array", "items" : { "type" : "string", "maxLength" : 36, "minLength" : 36 }, "maxItems" : 100 }, "style" : "form" }, { "description" : "Shop identifier for filtering", "explode" : true, "in" : "query", "name" : "shop", "schema" : { "type" : "integer", "format" : "int64" }, "style" : "form" }, { "description" : "A comma separated list of shop model for filtering", "explode" : true, "in" : "query", "name" : "shop_model", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Operator internal id of the shop for filtering", "explode" : true, "in" : "query", "name" : "shop_operator_internal_id", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Creation date for filtering", "explode" : true, "in" : "query", "name" : "start_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "A comma separated list of state of the accounting document for filtering", "explode" : true, "in" : "query", "name" : "states", "schema" : { "type" : "array", "default" : [ "GENERATED", "COMPLETE" ], "items" : { "type" : "string", "default" : "GENERATED,COMPLETE" } }, "style" : "form" }, { "description" : "Accounting document type for filtering. By default only invoices by the shop payment process are returned.", "explode" : true, "in" : "query", "name" : "type", "schema" : { "type" : "string", "default" : "AUTO_INVOICE" }, "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/IV01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List accounting documents", "tags" : [ "Invoicing and Accounting" ] } }, "/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", "parameters" : [ ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/L01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List locale codes and labels", "tags" : [ "Platform Settings" ] } }, "/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", "parameters" : [ ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/PC01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List platform configurations", "tags" : [ "Platform Settings" ] } }, "/api/reasons" : { "get" : { "description" : "This API returns cancellation, refund, incident, and message reasons.
Reasons are sorted by type then sort index (set in the back-office)", "operationId" : "RE01", "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/RE01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List reasons", "tags" : [ "Platform Settings" ] } }, "/api/users/shops/roles" : { "get" : { "description" : "", "operationId" : "RO02", "parameters" : [ ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RO02_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "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" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "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" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Download documents for one or multiple shops", "tags" : [ "Stores" ] } }, "/api/shops/documents/{document_id}" : { "delete" : { "description" : "", "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" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Delete a shop document", "tags" : [ "Stores" ] } }, "/api/seller-billing-cycles" : { "get" : { "description" : "This resource uses seek pagination. The maximum allowed value for parameter limit is 1000.", "operationId" : "SBC11", "parameters" : [ { "description" : "Currency for filtering. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "currency", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Creation date used as the maximum value for filtering (inclusive)", "explode" : true, "in" : "query", "name" : "end_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Seller billing cycle IDs for filtering. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "id", "schema" : { "type" : "array", "items" : { "type" : "string", "maxLength" : 36, "minLength" : 36 }, "maxItems" : 100 }, "style" : "form" }, { "description" : "A comma-separated list of pay-out PSP codes for filtering. This parameter requires the Hybrid pay-out PSP feature to be enabled.", "explode" : true, "in" : "query", "name" : "pay_out_psp_code", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Pay-out state for filtering. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "pay_out_state", "schema" : { "type" : "array", "default" : [ "TO_PAY", "FAILED", "PAID" ], "items" : { "type" : "string", "default" : "TO_PAY,FAILED,PAID" } }, "style" : "form" }, { "description" : "Payment voucher numbers for filtering. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "payment_voucher_number", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Shop ID for filtering. This parameter can be supplied multiple times. Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode" : true, "in" : "query", "name" : "shop_id", "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "style" : "form" }, { "description" : "Creation date used as the minimum value for filtering (inclusive)", "explode" : true, "in" : "query", "name" : "start_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/SBC11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List seller billing cycles", "tags" : [ "Invoicing and Accounting" ] } }, "/api/mms/models" : { "get" : { "description" : "", "operationId" : "SM11", "parameters" : [ { "description" : "Category codes to include in result. (default: include all)", "explode" : true, "in" : "query", "name" : "category_code", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Model codes to include in result. (default: include all)", "explode" : true, "in" : "query", "name" : "model_code", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Location types to include in result. (default: include all)", "explode" : true, "in" : "query", "name" : "location_type", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Booking types to include in result. (default: include all)", "explode" : true, "in" : "query", "name" : "booking_type", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Consumption types to include in result. (default: include all)", "explode" : true, "in" : "query", "name" : "consumption_type", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/SM11_Response_200" } } }, "description" : "OK" } }, "summary" : "List service models", "tags" : [ "Services" ] } }, "/api/mms/orders/{order_id}" : { "put" : { "description" : "Note: closed or cancelled order cannot be updated.", "operationId" : "SOR04", "parameters" : [ { "description" : "The identifier of the order to be updated", "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SOR04_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/SOR04_Response_200" } } }, "description" : "OK" } }, "summary" : "Update an order", "tags" : [ "Orders" ] } }, "/api/mms/orders/{order_id}/accept" : { "put" : { "description" : "Accept an order in WAITING_ACCEPTANCE state", "operationId" : "SOR21", "parameters" : [ { "description" : "The identifier of the order to be accepted.", "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "No Content" } }, "summary" : "Accept an order", "tags" : [ "Orders" ] } }, "/api/mms/orders/{order_id}/refuse" : { "put" : { "description" : "Refuse an order in WAITING_ACCEPTANCE state", "operationId" : "SOR22", "parameters" : [ { "description" : "The identifier of the order to be refused.", "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "No Content" } }, "summary" : "Refuse an order", "tags" : [ "Orders" ] } }, "/api/mms/orders/{order_id}/consume" : { "put" : { "description" : "Consumer an order in ORDER_PENDING state", "operationId" : "SOR25", "parameters" : [ { "description" : "The identifier of the order to be consumed.", "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SOR25_Request" } } } }, "responses" : { "204" : { "description" : "No Content" } }, "summary" : "Consume an order", "tags" : [ "Orders" ] } }, "/api/mms/orders/{order_id}/evaluation" : { "get" : { "description" : "", "operationId" : "SOR51", "parameters" : [ { "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "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/SOR51_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Front-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the evaluation of an order", "tags" : [ "Orders" ] } } }, "servers" : [ { "description" : "URL to be replaced by your Mirakl instance URL", "url" : "https://your-instance.mirakl.net" } ], "x-group-parameters" : true }