last_updated date:\norders_countoffers_countevaluations_countgradeapproval_rateapproval_delayorder_messages_response_delayMARKETPLACEDROPSHIPONE_CREDITORprofessional\n",
"items" : {
"$ref" : "#/components/schemas/A01_Response_200_SpecificBillingInformations"
}
},
"suspension_type" : {
"type" : "string",
"description" : "Shop suspension type, current possible values:MANUAL: Shop account has been manually suspended in the back-officePENDING_APPROVAL: Shop account has been suspended at creationAUTOMATIC_SUSPENSION: Shop account has been suspended by Mirakl Quality ControlINCOMPLETE_PROFILE: Shop account is suspended because some mandatory fields are missing in its profileprofessional\n"
},
"default_language" : {
"type" : "string",
"description" : "The default language of the shop, for invoicing purposes"
},
"fiscal_information" : {
"$ref" : "#/components/schemas/A01_Response_200_DefaultBillingInformation_FiscalInformation",
"description" : "The fiscal information of the shop.\nprofessional\n"
},
"fiscal_representative" : {
"$ref" : "#/components/schemas/A01_Response_200_DefaultBillingInformation_FiscalRepresentative",
"description" : "The fiscal representative associated to the billing information.\nprofessional\n"
},
"id" : {
"type" : "string",
"description" : "The unique identifier of the default billing information."
},
"personal_information" : {
"$ref" : "#/components/schemas/A01_Response_200_DefaultBillingInformation_PersonalInformation",
"description" : "The personal information of the shop owner.\nnon professional or professional sole trader\n"
},
"registration_address" : {
"$ref" : "#/components/schemas/A01_Response_200_DefaultBillingInformation_RegistrationAddress",
"description" : "The complete registration address of the shop."
}
}
},
"A01_Response_200_DefaultBillingInformation_CorporateInformation" : {
"type" : "object",
"properties" : {
"company_registration_name" : {
"type" : "string",
"description" : "The name of the shop company, as registered in the business registry of the shop country"
},
"company_registration_number" : {
"type" : "string",
"description" : "The unique code used to identify the shop company and verify its legal existence as an incorporated entity"
},
"complementary_information" : {
"$ref" : "#/components/schemas/A01_Response_200_DefaultBillingInformation_CorporateInformation_ComplementaryInformation",
"description" : "The complementary information of the shop, as requested by local regulations."
},
"electronic_address" : {
"type" : "string",
"description" : "The electronic address (e-invoicing routing code) of the billing entity, used for e-invoice routing and transmission"
},
"phone_number" : {
"type" : "string",
"description" : "The phone number of the billing entity, used for e-invoicing purposes"
}
}
},
"A01_Response_200_DefaultBillingInformation_CorporateInformation_ComplementaryInformation" : {
"type" : "object",
"properties" : {
"business_activity_code" : {
"type" : "string",
"description" : "The business activity code of the company, known as APE code in France.\nEU, and the seller is registered in France.\n"
},
"company_registration_city" : {
"type" : "string",
"description" : "The city of the company's registry office.\nEU and the seller is registered in France or Luxembourg.\n"
},
"company_registration_province" : {
"type" : "string",
"description" : "The initials of the company’s registry office province. Known as Ufficio in Italy.\nEU and the seller is registered in Italy.\n"
},
"company_shareholders" : {
"type" : "string",
"description" : "Indicates if there is a single shareholder or several shareholders. Known as Socio Unico in Italy.\nEU and the seller is registered in Italy.\n"
},
"is_in_liquidation" : {
"type" : "boolean",
"description" : "Indicates whether the company is in liquidation or not.\nEU\n"
},
"legal_form" : {
"type" : "string",
"description" : "The legal form of the company.\nEU\n"
},
"share_capital" : {
"type" : "number",
"description" : "The share capital of the company.\nEU\n"
},
"share_capital_currency" : {
"type" : "string",
"description" : "The share capital currency of the company.\nEU\n"
},
"sole_trader" : {
"type" : "boolean",
"description" : "Defines if the shop is a sole trader. When this option is set to true, additional information is asked to the shop. Applies only when the operator is registered in the EU"
}
}
},
"A01_Response_200_DefaultBillingInformation_FiscalInformation" : {
"type" : "object",
"properties" : {
"local_tax_number" : {
"type" : "string",
"description" : "The VAT or GST number of the shop"
},
"tax_identification_country" : {
"type" : "string",
"description" : "The country of issuance of the tax identification number"
},
"tax_identification_number" : {
"type" : "string",
"description" : "The identifying number issued by the tax administration of the shop country"
}
}
},
"A01_Response_200_DefaultBillingInformation_FiscalRepresentative" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "The city where the fiscal representative is located."
},
"civility" : {
"type" : "string",
"description" : "Civility of the fiscal representative"
},
"company_registration_name" : {
"type" : "string",
"description" : "The name of the fiscal representative, as registered if the business registry of the fiscal representative's country"
},
"company_registration_number" : {
"type" : "string",
"description" : "The unique code used to identify the fiscal representative and verify its legal existence as an incorporated entity"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the fiscal representative address"
},
"first_name" : {
"type" : "string",
"description" : "First name of the fiscal representative"
},
"last_name" : {
"type" : "string",
"description" : "Last name of the fiscal representative"
},
"local_tax_number" : {
"type" : "string",
"description" : "The identifying number of the fiscal representative for VAT or GST purposes"
},
"state" : {
"type" : "string",
"description" : "The state/province/region where the fiscal representative is located."
},
"street_1" : {
"type" : "string",
"description" : "The first line of address of the fiscal representative"
},
"street_2" : {
"type" : "string",
"description" : "The second line of address of the fiscal representative"
},
"zip_code" : {
"type" : "string",
"description" : "The Zip/Postal code corresponding to the fiscal representative location"
}
}
},
"A01_Response_200_DefaultBillingInformation_PersonalInformation" : {
"type" : "object",
"properties" : {
"birth_city" : {
"type" : "string",
"description" : "The city of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_country" : {
"type" : "string",
"description" : "The country of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_date" : {
"type" : "string",
"format" : "date",
"description" : "The birth date of the shop owner.\nnon professional or professional sole trader.\n"
},
"civility" : {
"type" : "string",
"description" : "The civility of the shop owner.\nnon professional or professional sole trader.\n"
},
"first_name" : {
"type" : "string",
"description" : "The first name of the shop owner.\nnon professional or professional sole trader.\n"
},
"last_name" : {
"type" : "string",
"description" : "The last name of the shop owner.\nnon professional or professional sole trader.\n"
}
}
},
"A01_Response_200_DefaultBillingInformation_RegistrationAddress" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "The city where the shop company is located."
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the shop company address"
},
"state" : {
"type" : "string",
"description" : "The state/province/region where the shop company is located."
},
"street_1" : {
"type" : "string",
"description" : "The first line of the address of the shop company"
},
"street_2" : {
"type" : "string",
"description" : "The second line of the address of the shop company"
},
"zip_code" : {
"type" : "string",
"description" : "The Zip/Postal code corresponding to the shop company location"
}
}
},
"A01_Response_200_Dropship" : {
"type" : "object",
"properties" : {
"retail_pricing_edition_enabled" : {
"type" : "boolean",
"description" : "Retail pricing edition enabled"
}
}
},
"A01_Response_200_Kyc" : {
"type" : "object",
"properties" : {
"reason" : {
"type" : "string",
"description" : "KYC refusal reason"
},
"status" : {
"type" : "string",
"description" : "KYC status"
}
}
},
"A01_Response_200_PaymentDetails" : {
"type" : "object",
"properties" : {
"paid_balance" : {
"type" : "number",
"description" : "Paid balance"
},
"payable_balance" : {
"type" : "number",
"description" : "Payable balance"
},
"pending_balance" : {
"type" : "number",
"description" : "Pending balance"
},
"reserve_balance" : {
"type" : "number",
"description" : "Current reserve balance"
},
"reserve_target" : {
"type" : "number",
"description" : "Configured reserve target"
},
"sub_balances" : {
"type" : "array",
"description" : "Store sub-balances by pay-out PSP. Requires the feature Hybrid pay-out PSP to be enabled on the platform",
"items" : {
"$ref" : "#/components/schemas/A01_Response_200_PaymentDetails_SubBalances"
}
}
}
},
"A01_Response_200_PaymentDetails_SubBalances" : {
"type" : "object",
"properties" : {
"paid" : {
"type" : "number",
"description" : "Paid balance"
},
"pay_out_psp_code" : {
"type" : "string",
"description" : "Code of the Payment Service Provider (PSP)"
},
"payable" : {
"type" : "number",
"description" : "Payable balance"
},
"pending" : {
"type" : "number",
"description" : "Pending balance"
}
}
},
"A01_Response_200_PaymentInfo" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"ABA" : "#/components/schemas/A01_Response_200_PaymentInfo_Aba",
"AUBSB" : "#/components/schemas/A01_Response_200_PaymentInfo_Aubsb",
"BRAZILIAN" : "#/components/schemas/A01_Response_200_PaymentInfo_Brazilian",
"CANADIAN" : "#/components/schemas/A01_Response_200_PaymentInfo_Canadian",
"COLOMBIAN" : "#/components/schemas/A01_Response_200_PaymentInfo_Colombian",
"GUATEMALAN" : "#/components/schemas/A01_Response_200_PaymentInfo_Guatemalan",
"HK" : "#/components/schemas/A01_Response_200_PaymentInfo_Hk",
"IBAN" : "#/components/schemas/A01_Response_200_PaymentInfo_Iban",
"INDIAN" : "#/components/schemas/A01_Response_200_PaymentInfo_Indian",
"ISRAELI" : "#/components/schemas/A01_Response_200_PaymentInfo_Israeli",
"JAPANESE" : "#/components/schemas/A01_Response_200_PaymentInfo_Japanese",
"MEXICAN" : "#/components/schemas/A01_Response_200_PaymentInfo_Mexican",
"NUBAN" : "#/components/schemas/A01_Response_200_PaymentInfo_Nuban",
"NZBSB" : "#/components/schemas/A01_Response_200_PaymentInfo_Nzbsb",
"PAYOUT" : "#/components/schemas/A01_Response_200_PaymentInfo_Payout",
"PHILIPPINES" : "#/components/schemas/A01_Response_200_PaymentInfo_Philippines",
"SERBIAN" : "#/components/schemas/A01_Response_200_PaymentInfo_Serbian",
"SG" : "#/components/schemas/A01_Response_200_PaymentInfo_Sg",
"TAIWANESE" : "#/components/schemas/A01_Response_200_PaymentInfo_Taiwanese",
"THAI" : "#/components/schemas/A01_Response_200_PaymentInfo_Thai",
"UK" : "#/components/schemas/A01_Response_200_PaymentInfo_Uk",
"URUGUAYAN" : "#/components/schemas/A01_Response_200_PaymentInfo_Uruguayan",
"VIETNAMESE" : "#/components/schemas/A01_Response_200_PaymentInfo_Vietnamese"
},
"propertyName" : "@type"
},
"properties" : {
"@type" : {
"type" : "string"
},
"owner" : {
"type" : "string",
"description" : "Name of the owner of the payment information",
"maxLength" : 100,
"minLength" : 1
}
}
},
"A01_Response_200_PaymentInfo_Aba" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/A01_Response_200_PaymentInfo"
} ],
"properties" : {
"bank_account_number" : {
"type" : "string",
"description" : "Bank Account Number",
"maxLength" : 17,
"minLength" : 3,
"pattern" : "[0-9]+"
},
"bank_city" : {
"type" : "string",
"description" : "Bank city",
"maxLength" : 100,
"minLength" : 3
},
"bank_name" : {
"type" : "string",
"description" : "Bank name",
"maxLength" : 255,
"minLength" : 0
},
"bank_street" : {
"type" : "string",
"description" : "Bank street name",
"maxLength" : 100,
"minLength" : 3
},
"bank_zip" : {
"type" : "string",
"description" : "Bank zip code",
"maxLength" : 255,
"minLength" : 0
},
"bic" : {
"type" : "string",
"description" : "Bank account BIC code (aka Swift Code)"
},
"routing_number" : {
"type" : "string",
"description" : "Routing Number of the bank, (aka ABA code)",
"pattern" : "[0-9]+"
}
}
},
"A01_Response_200_PaymentInfo_Aubsb" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/A01_Response_200_PaymentInfo"
} ],
"properties" : {
"auban" : {
"type" : "string",
"description" : "Bank account number",
"maxLength" : 10,
"minLength" : 6,
"pattern" : "[0-9]+"
},
"aubsb" : {
"type" : "string",
"description" : "Bank state branch code",
"pattern" : "[0-9]+"
},
"bank_city" : {
"type" : "string",
"description" : "Bank city",
"maxLength" : 100,
"minLength" : 3
},
"bank_name" : {
"type" : "string",
"description" : "Bank name",
"maxLength" : 255,
"minLength" : 0
},
"bank_street" : {
"type" : "string",
"description" : "Bank street name",
"maxLength" : 100,
"minLength" : 3
},
"bank_zip" : {
"type" : "string",
"description" : "Bank zip code",
"maxLength" : 255,
"minLength" : 0
}
}
},
"A01_Response_200_PaymentInfo_Brazilian" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/A01_Response_200_PaymentInfo"
} ],
"properties" : {
"account_number" : {
"type" : "string",
"description" : "Account number",
"maxLength" : 11,
"minLength" : 10,
"pattern" : "[0-9]+"
},
"bank_account_type" : {
"type" : "string",
"description" : "Account typeC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Current accountP : Savings accountC : Checking accountP : Savings accountprofessional\n"
},
"fiscal_information" : {
"$ref" : "#/components/schemas/A01_Response_200_SpecificBillingInformations_FiscalInformation",
"description" : "The fiscal information of the shop.\nprofessional\n"
},
"fiscal_representative" : {
"$ref" : "#/components/schemas/A01_Response_200_SpecificBillingInformations_FiscalRepresentative",
"description" : "The fiscal representative associated to the billing information.\nprofessional\n"
},
"id" : {
"type" : "string",
"description" : "The unique identifier of the specific billing information."
},
"personal_information" : {
"$ref" : "#/components/schemas/A01_Response_200_SpecificBillingInformations_PersonalInformation",
"description" : "The personal information of the shop owner.\nnon professional or professional sole trader\n"
},
"registration_address" : {
"$ref" : "#/components/schemas/A01_Response_200_SpecificBillingInformations_RegistrationAddress",
"description" : "The complete registration address of the shop."
}
}
},
"A01_Response_200_SpecificBillingInformations_CorporateInformation" : {
"type" : "object",
"properties" : {
"company_registration_name" : {
"type" : "string",
"description" : "The name of the shop company, as registered in the business registry of the shop country"
},
"company_registration_number" : {
"type" : "string",
"description" : "The unique code used to identify the shop company and verify its legal existence as an incorporated entity"
},
"complementary_information" : {
"$ref" : "#/components/schemas/A01_Response_200_SpecificBillingInformations_CorporateInformation_ComplementaryInformation",
"description" : "The complementary information of the shop, as requested by local regulations."
},
"electronic_address" : {
"type" : "string",
"description" : "The electronic address (e-invoicing routing code) of the billing entity, used for e-invoice routing and transmission"
},
"phone_number" : {
"type" : "string",
"description" : "The phone number of the billing entity, used for e-invoicing purposes"
}
}
},
"A01_Response_200_SpecificBillingInformations_CorporateInformation_ComplementaryInformation" : {
"type" : "object",
"properties" : {
"business_activity_code" : {
"type" : "string",
"description" : "The business activity code of the company, known as APE code in France.\nEU, and the seller is registered in France.\n"
},
"company_registration_city" : {
"type" : "string",
"description" : "The city of the company's registry office.\nEU and the seller is registered in France or Luxembourg.\n"
},
"company_registration_province" : {
"type" : "string",
"description" : "The initials of the company’s registry office province. Known as Ufficio in Italy.\nEU and the seller is registered in Italy.\n"
},
"company_shareholders" : {
"type" : "string",
"description" : "Indicates if there is a single shareholder or several shareholders. Known as Socio Unico in Italy.\nEU and the seller is registered in Italy.\n"
},
"is_in_liquidation" : {
"type" : "boolean",
"description" : "Indicates whether the company is in liquidation or not.\nEU\n"
},
"legal_form" : {
"type" : "string",
"description" : "The legal form of the company.\nEU\n"
},
"share_capital" : {
"type" : "number",
"description" : "The share capital of the company.\nEU\n"
},
"share_capital_currency" : {
"type" : "string",
"description" : "The share capital currency of the company.\nEU\n"
},
"sole_trader" : {
"type" : "boolean",
"description" : "Defines if the shop is a sole trader. When this option is set to true, additional information is asked to the shop. Applies only when the operator is registered in the EU"
}
}
},
"A01_Response_200_SpecificBillingInformations_FiscalInformation" : {
"type" : "object",
"properties" : {
"local_tax_number" : {
"type" : "string",
"description" : "The VAT or GST number of the shop"
},
"tax_identification_country" : {
"type" : "string",
"description" : "The country of issuance of the tax identification number"
},
"tax_identification_number" : {
"type" : "string",
"description" : "The identifying number issued by the tax administration of the shop country"
}
}
},
"A01_Response_200_SpecificBillingInformations_FiscalRepresentative" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "The city where the fiscal representative is located."
},
"civility" : {
"type" : "string",
"description" : "Civility of the fiscal representative"
},
"company_registration_name" : {
"type" : "string",
"description" : "The name of the fiscal representative, as registered if the business registry of the fiscal representative's country"
},
"company_registration_number" : {
"type" : "string",
"description" : "The unique code used to identify the fiscal representative and verify its legal existence as an incorporated entity"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the fiscal representative address"
},
"first_name" : {
"type" : "string",
"description" : "First name of the fiscal representative"
},
"last_name" : {
"type" : "string",
"description" : "Last name of the fiscal representative"
},
"local_tax_number" : {
"type" : "string",
"description" : "The identifying number of the fiscal representative for VAT or GST purposes"
},
"state" : {
"type" : "string",
"description" : "The state/province/region where the fiscal representative is located."
},
"street_1" : {
"type" : "string",
"description" : "The first line of address of the fiscal representative"
},
"street_2" : {
"type" : "string",
"description" : "The second line of address of the fiscal representative"
},
"zip_code" : {
"type" : "string",
"description" : "The Zip/Postal code corresponding to the fiscal representative location"
}
}
},
"A01_Response_200_SpecificBillingInformations_PersonalInformation" : {
"type" : "object",
"properties" : {
"birth_city" : {
"type" : "string",
"description" : "The city of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_country" : {
"type" : "string",
"description" : "The country of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_date" : {
"type" : "string",
"format" : "date",
"description" : "The birth date of the shop owner.\nnon professional or professional sole trader.\n"
},
"civility" : {
"type" : "string",
"description" : "The civility of the shop owner.\nnon professional or professional sole trader.\n"
},
"first_name" : {
"type" : "string",
"description" : "The first name of the shop owner.\nnon professional or professional sole trader.\n"
},
"last_name" : {
"type" : "string",
"description" : "The last name of the shop owner.\nnon professional or professional sole trader.\n"
}
}
},
"A01_Response_200_SpecificBillingInformations_RegistrationAddress" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "The city where the shop company is located."
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the shop company address"
},
"state" : {
"type" : "string",
"description" : "The state/province/region where the shop company is located."
},
"street_1" : {
"type" : "string",
"description" : "The first line of the address of the shop company"
},
"street_2" : {
"type" : "string",
"description" : "The second line of the address of the shop company"
},
"zip_code" : {
"type" : "string",
"description" : "The Zip/Postal code corresponding to the shop company location"
}
}
},
"A02_Request" : {
"type" : "object",
"properties" : {
"address" : {
"$ref" : "#/components/schemas/A02_Request_Address",
"description" : "The address of the shop. Cannot be null."
},
"channels" : {
"type" : "array",
"description" : "List of the channel codes associated to the shop. If new channel is associated without providing values for the required shop_additional_fields, default values will be set.",
"items" : {
"type" : "string"
}
},
"closed_from" : {
"type" : "string",
"format" : "date-time",
"description" : "Date: if defined, this shop will be closed on this date. Nullable."
},
"closed_to" : {
"type" : "string",
"format" : "date-time",
"description" : "Date: if defined, this shop will be reopened on this date. Nullable."
},
"description" : {
"type" : "string",
"description" : "Description of the shop. Nullable."
},
"email" : {
"type" : "string",
"description" : "Email of the shop. Cannot be null."
},
"fax" : {
"type" : "string",
"description" : "Fax of the shop. Nullable."
},
"is_professional" : {
"type" : "boolean",
"description" : "Whether or not the shop is professional. Cannot be null."
},
"payment_info" : {
"$ref" : "#/components/schemas/A02_Request_PaymentInfo",
"description" : "Payment information of the shop. Nullable."
},
"pro_details" : {
"$ref" : "#/components/schemas/A02_Request_ProDetails",
"description" : "Professional details of the shop. Updated and not nullable if shop is declared as professional."
},
"producer_identifiers" : {
"type" : "array",
"description" : "List of shop’s producer identifiers per Extended Producer Responsibility (EPR) categories. Only available if the operator setting Activate data collection related to circular economy regulations is enabled.",
"items" : {
"$ref" : "#/components/schemas/A02_Request_ProducerIdentifiers"
},
"maxItems" : 50,
"minItems" : 0
},
"recycling_policy" : {
"type" : "string",
"description" : "Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.",
"maxLength" : 5000
},
"return_policy" : {
"type" : "string",
"description" : "Return policy of the shop. Nullable."
},
"shipping_country" : {
"type" : "string",
"description" : "Shipping country of the shop. Nullable."
},
"shop_additional_fields" : {
"type" : "array",
"description" : "Additional fields of the shop. Note that if the 'value' field in the child structure is absent, the corresponding additional field value will be removed for this shop. Nullable.",
"items" : {
"$ref" : "#/components/schemas/A02_Request_ShopAdditionalFields"
}
},
"shop_name" : {
"type" : "string",
"description" : "The name of the shop. Cannot be null."
},
"web_site" : {
"type" : "string",
"description" : "Website of the shop. Nullable."
}
}
},
"A02_Request_Address" : {
"type" : "object",
"description" : "The address of the shop. Cannot be null.",
"properties" : {
"city" : {
"type" : "string",
"description" : "City of the shop contact. Cannot be null."
},
"civility" : {
"type" : "string",
"description" : "Civility of the shop contact. Cannot be null."
},
"country" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the shop contact, 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). Cannot be null."
},
"firstname" : {
"type" : "string",
"description" : "First name of the shop contact. Cannot be null."
},
"lastname" : {
"type" : "string",
"description" : "Last name of the shop contact. Cannot be null."
},
"phone" : {
"type" : "string",
"description" : "Phone of the shop contact. Nullable."
},
"phone_secondary" : {
"type" : "string",
"description" : "Secondary phone of the shop contact. Nullable."
},
"state" : {
"type" : "string",
"description" : "State (address) of the shop contact. Nullable."
},
"street1" : {
"type" : "string",
"description" : "First line of the address of the shop contact. Cannot be null."
},
"street2" : {
"type" : "string",
"description" : "Second line of the address of the shop contact. Nullable."
},
"zip_code" : {
"type" : "string",
"description" : "Zip code of the shop contact, mandatory except for: Bahrain, Chile, Egypt, Hong-Kong, Kuwait, Oman, Peru, Qatar, Saudi Arabia, United Arab Emirates or Uruguay."
}
}
},
"A02_Request_PaymentInfo" : {
"type" : "object",
"description" : "Payment information of the shop. Nullable.",
"discriminator" : {
"mapping" : {
"ABA" : "#/components/schemas/A02_Request_PaymentInfo_Aba",
"AUBSB" : "#/components/schemas/A02_Request_PaymentInfo_Aubsb",
"BRAZILIAN" : "#/components/schemas/A02_Request_PaymentInfo_Brazilian",
"CANADIAN" : "#/components/schemas/A02_Request_PaymentInfo_Canadian",
"COLOMBIAN" : "#/components/schemas/A02_Request_PaymentInfo_Colombian",
"GUATEMALAN" : "#/components/schemas/A02_Request_PaymentInfo_Guatemalan",
"HK" : "#/components/schemas/A02_Request_PaymentInfo_Hk",
"IBAN" : "#/components/schemas/A02_Request_PaymentInfo_Iban",
"INDIAN" : "#/components/schemas/A02_Request_PaymentInfo_Indian",
"ISRAELI" : "#/components/schemas/A02_Request_PaymentInfo_Israeli",
"JAPANESE" : "#/components/schemas/A02_Request_PaymentInfo_Japanese",
"MEXICAN" : "#/components/schemas/A02_Request_PaymentInfo_Mexican",
"NUBAN" : "#/components/schemas/A02_Request_PaymentInfo_Nuban",
"NZBSB" : "#/components/schemas/A02_Request_PaymentInfo_Nzbsb",
"PAYOUT" : "#/components/schemas/A02_Request_PaymentInfo_Payout",
"PHILIPPINES" : "#/components/schemas/A02_Request_PaymentInfo_Philippines",
"SERBIAN" : "#/components/schemas/A02_Request_PaymentInfo_Serbian",
"SG" : "#/components/schemas/A02_Request_PaymentInfo_Sg",
"TAIWANESE" : "#/components/schemas/A02_Request_PaymentInfo_Taiwanese",
"THAI" : "#/components/schemas/A02_Request_PaymentInfo_Thai",
"UK" : "#/components/schemas/A02_Request_PaymentInfo_Uk",
"URUGUAYAN" : "#/components/schemas/A02_Request_PaymentInfo_Uruguayan",
"VIETNAMESE" : "#/components/schemas/A02_Request_PaymentInfo_Vietnamese"
},
"propertyName" : "@type"
},
"properties" : {
"@type" : {
"type" : "string"
},
"owner" : {
"type" : "string",
"description" : "Name of the owner of the payment information",
"maxLength" : 100,
"minLength" : 1
}
}
},
"A02_Request_PaymentInfo_Aba" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/A02_Request_PaymentInfo"
} ],
"properties" : {
"bank_account_number" : {
"type" : "string",
"description" : "Bank Account Number",
"maxLength" : 17,
"minLength" : 3,
"pattern" : "[0-9]+"
},
"bank_city" : {
"type" : "string",
"description" : "Bank city",
"maxLength" : 100,
"minLength" : 3
},
"bank_name" : {
"type" : "string",
"description" : "Bank name",
"maxLength" : 255,
"minLength" : 0
},
"bank_street" : {
"type" : "string",
"description" : "Bank street name",
"maxLength" : 100,
"minLength" : 3
},
"bank_zip" : {
"type" : "string",
"description" : "Bank zip code",
"maxLength" : 255,
"minLength" : 0
},
"bic" : {
"type" : "string",
"description" : "Bank account BIC code (aka Swift Code)"
},
"routing_number" : {
"type" : "string",
"description" : "Routing Number of the bank, (aka ABA code)",
"pattern" : "[0-9]+"
}
}
},
"A02_Request_PaymentInfo_Aubsb" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/A02_Request_PaymentInfo"
} ],
"properties" : {
"auban" : {
"type" : "string",
"description" : "Bank account number",
"maxLength" : 10,
"minLength" : 6,
"pattern" : "[0-9]+"
},
"aubsb" : {
"type" : "string",
"description" : "Bank state branch code",
"pattern" : "[0-9]+"
},
"bank_city" : {
"type" : "string",
"description" : "Bank city",
"maxLength" : 100,
"minLength" : 3
},
"bank_name" : {
"type" : "string",
"description" : "Bank name",
"maxLength" : 255,
"minLength" : 0
},
"bank_street" : {
"type" : "string",
"description" : "Bank street name",
"maxLength" : 100,
"minLength" : 3
},
"bank_zip" : {
"type" : "string",
"description" : "Bank zip code",
"maxLength" : 255,
"minLength" : 0
}
}
},
"A02_Request_PaymentInfo_Brazilian" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/A02_Request_PaymentInfo"
} ],
"properties" : {
"account_number" : {
"type" : "string",
"description" : "Account number",
"maxLength" : 11,
"minLength" : 10,
"pattern" : "[0-9]+"
},
"bank_account_type" : {
"type" : "string",
"description" : "Account typeC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Current accountP : Savings accountC : Checking accountP : Savings accountMARKETPLACEDROPSHIPONE_CREDITORprofessional\n",
"items" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_SpecificBillingInformations"
}
},
"web_site" : {
"type" : "string",
"description" : "Shop website"
}
}
},
"A02_Response_200_Updated_Address" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "City of the shop contact"
},
"civility" : {
"type" : "string",
"description" : "Civility of the shop contact"
},
"country" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the shop contact"
},
"firstname" : {
"type" : "string",
"description" : "First name of the shop contact"
},
"lastname" : {
"type" : "string",
"description" : "Last name of the shop contact"
},
"phone" : {
"type" : "string",
"description" : "Phone of the shop contact"
},
"phone_secondary" : {
"type" : "string",
"description" : "Secondary phone of the shop contact"
},
"state" : {
"type" : "string",
"description" : "State (address) of the shop contact"
},
"street1" : {
"type" : "string",
"description" : "First line of the address of the shop contact"
},
"street2" : {
"type" : "string",
"description" : "Second line of the address of the shop contact"
},
"zip_code" : {
"type" : "string",
"description" : "Zip code of the shop contact"
}
}
},
"A02_Response_200_Updated_DefaultBillingInformation" : {
"type" : "object",
"properties" : {
"corporate_information" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_DefaultBillingInformation_CorporateInformation",
"description" : "The corporate information of the shop.\nprofessional\n"
},
"default_language" : {
"type" : "string",
"description" : "The default language of the shop, for invoicing purposes"
},
"fiscal_information" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_DefaultBillingInformation_FiscalInformation",
"description" : "The fiscal information of the shop.\nprofessional\n"
},
"fiscal_representative" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_DefaultBillingInformation_FiscalRepresentative",
"description" : "The fiscal representative associated to the billing information.\nprofessional\n"
},
"id" : {
"type" : "string",
"description" : "The unique identifier of the default billing information."
},
"personal_information" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_DefaultBillingInformation_PersonalInformation",
"description" : "The personal information of the shop owner.\nnon professional or professional sole trader\n"
},
"registration_address" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_DefaultBillingInformation_RegistrationAddress",
"description" : "The complete registration address of the shop."
}
}
},
"A02_Response_200_Updated_DefaultBillingInformation_CorporateInformation" : {
"type" : "object",
"properties" : {
"company_registration_name" : {
"type" : "string",
"description" : "The name of the shop company, as registered in the business registry of the shop country"
},
"company_registration_number" : {
"type" : "string",
"description" : "The unique code used to identify the shop company and verify its legal existence as an incorporated entity"
},
"complementary_information" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_DefaultBillingInformation_CorporateInformation_ComplementaryInformation",
"description" : "The complementary information of the shop, as requested by local regulations."
},
"electronic_address" : {
"type" : "string",
"description" : "The electronic address (e-invoicing routing code) of the billing entity, used for e-invoice routing and transmission"
},
"phone_number" : {
"type" : "string",
"description" : "The phone number of the billing entity, used for e-invoicing purposes"
}
}
},
"A02_Response_200_Updated_DefaultBillingInformation_CorporateInformation_ComplementaryInformation" : {
"type" : "object",
"properties" : {
"business_activity_code" : {
"type" : "string",
"description" : "The business activity code of the company, known as APE code in France.\nEU, and the seller is registered in France.\n"
},
"company_registration_city" : {
"type" : "string",
"description" : "The city of the company's registry office.\nEU and the seller is registered in France or Luxembourg.\n"
},
"company_registration_province" : {
"type" : "string",
"description" : "The initials of the company’s registry office province. Known as Ufficio in Italy.\nEU and the seller is registered in Italy.\n"
},
"company_shareholders" : {
"type" : "string",
"description" : "Indicates if there is a single shareholder or several shareholders. Known as Socio Unico in Italy.\nEU and the seller is registered in Italy.\n"
},
"is_in_liquidation" : {
"type" : "boolean",
"description" : "Indicates whether the company is in liquidation or not.\nEU\n"
},
"legal_form" : {
"type" : "string",
"description" : "The legal form of the company.\nEU\n"
},
"share_capital" : {
"type" : "number",
"description" : "The share capital of the company.\nEU\n"
},
"share_capital_currency" : {
"type" : "string",
"description" : "The share capital currency of the company.\nEU\n"
},
"sole_trader" : {
"type" : "boolean",
"description" : "Defines if the shop is a sole trader. When this option is set to true, additional information is asked to the shop. Applies only when the operator is registered in the EU"
}
}
},
"A02_Response_200_Updated_DefaultBillingInformation_FiscalInformation" : {
"type" : "object",
"properties" : {
"local_tax_number" : {
"type" : "string",
"description" : "The VAT or GST number of the shop"
},
"tax_identification_country" : {
"type" : "string",
"description" : "The country of issuance of the tax identification number"
},
"tax_identification_number" : {
"type" : "string",
"description" : "The identifying number issued by the tax administration of the shop country"
}
}
},
"A02_Response_200_Updated_DefaultBillingInformation_FiscalRepresentative" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "The city where the fiscal representative is located."
},
"civility" : {
"type" : "string",
"description" : "Civility of the fiscal representative"
},
"company_registration_name" : {
"type" : "string",
"description" : "The name of the fiscal representative, as registered if the business registry of the fiscal representative's country"
},
"company_registration_number" : {
"type" : "string",
"description" : "The unique code used to identify the fiscal representative and verify its legal existence as an incorporated entity"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the fiscal representative address"
},
"first_name" : {
"type" : "string",
"description" : "First name of the fiscal representative"
},
"last_name" : {
"type" : "string",
"description" : "Last name of the fiscal representative"
},
"local_tax_number" : {
"type" : "string",
"description" : "The identifying number of the fiscal representative for VAT or GST purposes"
},
"state" : {
"type" : "string",
"description" : "The state/province/region where the fiscal representative is located."
},
"street_1" : {
"type" : "string",
"description" : "The first line of address of the fiscal representative"
},
"street_2" : {
"type" : "string",
"description" : "The second line of address of the fiscal representative"
},
"zip_code" : {
"type" : "string",
"description" : "The Zip/Postal code corresponding to the fiscal representative location"
}
}
},
"A02_Response_200_Updated_DefaultBillingInformation_PersonalInformation" : {
"type" : "object",
"properties" : {
"birth_city" : {
"type" : "string",
"description" : "The city of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_country" : {
"type" : "string",
"description" : "The country of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_date" : {
"type" : "string",
"format" : "date",
"description" : "The birth date of the shop owner.\nnon professional or professional sole trader.\n"
},
"civility" : {
"type" : "string",
"description" : "The civility of the shop owner.\nnon professional or professional sole trader.\n"
},
"first_name" : {
"type" : "string",
"description" : "The first name of the shop owner.\nnon professional or professional sole trader.\n"
},
"last_name" : {
"type" : "string",
"description" : "The last name of the shop owner.\nnon professional or professional sole trader.\n"
}
}
},
"A02_Response_200_Updated_DefaultBillingInformation_RegistrationAddress" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "The city where the shop company is located."
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the shop company address"
},
"state" : {
"type" : "string",
"description" : "The state/province/region where the shop company is located."
},
"street_1" : {
"type" : "string",
"description" : "The first line of the address of the shop company"
},
"street_2" : {
"type" : "string",
"description" : "The second line of the address of the shop company"
},
"zip_code" : {
"type" : "string",
"description" : "The Zip/Postal code corresponding to the shop company location"
}
}
},
"A02_Response_200_Updated_PaymentInfo" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"ABA" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Aba",
"AUBSB" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Aubsb",
"BRAZILIAN" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Brazilian",
"CANADIAN" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Canadian",
"COLOMBIAN" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Colombian",
"GUATEMALAN" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Guatemalan",
"HK" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Hk",
"IBAN" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Iban",
"INDIAN" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Indian",
"ISRAELI" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Israeli",
"JAPANESE" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Japanese",
"MEXICAN" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Mexican",
"NUBAN" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Nuban",
"NZBSB" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Nzbsb",
"PAYOUT" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Payout",
"PHILIPPINES" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Philippines",
"SERBIAN" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Serbian",
"SG" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Sg",
"TAIWANESE" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Taiwanese",
"THAI" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Thai",
"UK" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Uk",
"URUGUAYAN" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Uruguayan",
"VIETNAMESE" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo_Vietnamese"
},
"propertyName" : "@type"
},
"properties" : {
"@type" : {
"type" : "string"
},
"owner" : {
"type" : "string",
"description" : "Name of the owner of the payment information",
"maxLength" : 100,
"minLength" : 1
}
}
},
"A02_Response_200_Updated_PaymentInfo_Aba" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo"
} ],
"properties" : {
"bank_account_number" : {
"type" : "string",
"description" : "Bank Account Number",
"maxLength" : 17,
"minLength" : 3,
"pattern" : "[0-9]+"
},
"bank_city" : {
"type" : "string",
"description" : "Bank city",
"maxLength" : 100,
"minLength" : 3
},
"bank_name" : {
"type" : "string",
"description" : "Bank name",
"maxLength" : 255,
"minLength" : 0
},
"bank_street" : {
"type" : "string",
"description" : "Bank street name",
"maxLength" : 100,
"minLength" : 3
},
"bank_zip" : {
"type" : "string",
"description" : "Bank zip code",
"maxLength" : 255,
"minLength" : 0
},
"bic" : {
"type" : "string",
"description" : "Bank account BIC code (aka Swift Code)"
},
"routing_number" : {
"type" : "string",
"description" : "Routing Number of the bank, (aka ABA code)",
"pattern" : "[0-9]+"
}
}
},
"A02_Response_200_Updated_PaymentInfo_Aubsb" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo"
} ],
"properties" : {
"auban" : {
"type" : "string",
"description" : "Bank account number",
"maxLength" : 10,
"minLength" : 6,
"pattern" : "[0-9]+"
},
"aubsb" : {
"type" : "string",
"description" : "Bank state branch code",
"pattern" : "[0-9]+"
},
"bank_city" : {
"type" : "string",
"description" : "Bank city",
"maxLength" : 100,
"minLength" : 3
},
"bank_name" : {
"type" : "string",
"description" : "Bank name",
"maxLength" : 255,
"minLength" : 0
},
"bank_street" : {
"type" : "string",
"description" : "Bank street name",
"maxLength" : 100,
"minLength" : 3
},
"bank_zip" : {
"type" : "string",
"description" : "Bank zip code",
"maxLength" : 255,
"minLength" : 0
}
}
},
"A02_Response_200_Updated_PaymentInfo_Brazilian" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/A02_Response_200_Updated_PaymentInfo"
} ],
"properties" : {
"account_number" : {
"type" : "string",
"description" : "Account number",
"maxLength" : 11,
"minLength" : 10,
"pattern" : "[0-9]+"
},
"bank_account_type" : {
"type" : "string",
"description" : "Account typeC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Current accountP : Savings accountC : Checking accountP : Savings accountprofessional\n"
},
"fiscal_information" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_SpecificBillingInformations_FiscalInformation",
"description" : "The fiscal information of the shop.\nprofessional\n"
},
"fiscal_representative" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_SpecificBillingInformations_FiscalRepresentative",
"description" : "The fiscal representative associated to the billing information.\nprofessional\n"
},
"id" : {
"type" : "string",
"description" : "The unique identifier of the specific billing information."
},
"personal_information" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_SpecificBillingInformations_PersonalInformation",
"description" : "The personal information of the shop owner.\nnon professional or professional sole trader\n"
},
"registration_address" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_SpecificBillingInformations_RegistrationAddress",
"description" : "The complete registration address of the shop."
}
}
},
"A02_Response_200_Updated_SpecificBillingInformations_CorporateInformation" : {
"type" : "object",
"properties" : {
"company_registration_name" : {
"type" : "string",
"description" : "The name of the shop company, as registered in the business registry of the shop country"
},
"company_registration_number" : {
"type" : "string",
"description" : "The unique code used to identify the shop company and verify its legal existence as an incorporated entity"
},
"complementary_information" : {
"$ref" : "#/components/schemas/A02_Response_200_Updated_SpecificBillingInformations_CorporateInformation_ComplementaryInformation",
"description" : "The complementary information of the shop, as requested by local regulations."
},
"electronic_address" : {
"type" : "string",
"description" : "The electronic address (e-invoicing routing code) of the billing entity, used for e-invoice routing and transmission"
},
"phone_number" : {
"type" : "string",
"description" : "The phone number of the billing entity, used for e-invoicing purposes"
}
}
},
"A02_Response_200_Updated_SpecificBillingInformations_CorporateInformation_ComplementaryInformation" : {
"type" : "object",
"properties" : {
"business_activity_code" : {
"type" : "string",
"description" : "The business activity code of the company, known as APE code in France.\nEU, and the seller is registered in France.\n"
},
"company_registration_city" : {
"type" : "string",
"description" : "The city of the company's registry office.\nEU and the seller is registered in France or Luxembourg.\n"
},
"company_registration_province" : {
"type" : "string",
"description" : "The initials of the company’s registry office province. Known as Ufficio in Italy.\nEU and the seller is registered in Italy.\n"
},
"company_shareholders" : {
"type" : "string",
"description" : "Indicates if there is a single shareholder or several shareholders. Known as Socio Unico in Italy.\nEU and the seller is registered in Italy.\n"
},
"is_in_liquidation" : {
"type" : "boolean",
"description" : "Indicates whether the company is in liquidation or not.\nEU\n"
},
"legal_form" : {
"type" : "string",
"description" : "The legal form of the company.\nEU\n"
},
"share_capital" : {
"type" : "number",
"description" : "The share capital of the company.\nEU\n"
},
"share_capital_currency" : {
"type" : "string",
"description" : "The share capital currency of the company.\nEU\n"
},
"sole_trader" : {
"type" : "boolean",
"description" : "Defines if the shop is a sole trader. When this option is set to true, additional information is asked to the shop. Applies only when the operator is registered in the EU"
}
}
},
"A02_Response_200_Updated_SpecificBillingInformations_FiscalInformation" : {
"type" : "object",
"properties" : {
"local_tax_number" : {
"type" : "string",
"description" : "The VAT or GST number of the shop"
},
"tax_identification_country" : {
"type" : "string",
"description" : "The country of issuance of the tax identification number"
},
"tax_identification_number" : {
"type" : "string",
"description" : "The identifying number issued by the tax administration of the shop country"
}
}
},
"A02_Response_200_Updated_SpecificBillingInformations_FiscalRepresentative" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "The city where the fiscal representative is located."
},
"civility" : {
"type" : "string",
"description" : "Civility of the fiscal representative"
},
"company_registration_name" : {
"type" : "string",
"description" : "The name of the fiscal representative, as registered if the business registry of the fiscal representative's country"
},
"company_registration_number" : {
"type" : "string",
"description" : "The unique code used to identify the fiscal representative and verify its legal existence as an incorporated entity"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the fiscal representative address"
},
"first_name" : {
"type" : "string",
"description" : "First name of the fiscal representative"
},
"last_name" : {
"type" : "string",
"description" : "Last name of the fiscal representative"
},
"local_tax_number" : {
"type" : "string",
"description" : "The identifying number of the fiscal representative for VAT or GST purposes"
},
"state" : {
"type" : "string",
"description" : "The state/province/region where the fiscal representative is located."
},
"street_1" : {
"type" : "string",
"description" : "The first line of address of the fiscal representative"
},
"street_2" : {
"type" : "string",
"description" : "The second line of address of the fiscal representative"
},
"zip_code" : {
"type" : "string",
"description" : "The Zip/Postal code corresponding to the fiscal representative location"
}
}
},
"A02_Response_200_Updated_SpecificBillingInformations_PersonalInformation" : {
"type" : "object",
"properties" : {
"birth_city" : {
"type" : "string",
"description" : "The city of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_country" : {
"type" : "string",
"description" : "The country of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_date" : {
"type" : "string",
"format" : "date",
"description" : "The birth date of the shop owner.\nnon professional or professional sole trader.\n"
},
"civility" : {
"type" : "string",
"description" : "The civility of the shop owner.\nnon professional or professional sole trader.\n"
},
"first_name" : {
"type" : "string",
"description" : "The first name of the shop owner.\nnon professional or professional sole trader.\n"
},
"last_name" : {
"type" : "string",
"description" : "The last name of the shop owner.\nnon professional or professional sole trader.\n"
}
}
},
"A02_Response_200_Updated_SpecificBillingInformations_RegistrationAddress" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "The city where the shop company is located."
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the shop company address"
},
"state" : {
"type" : "string",
"description" : "The state/province/region where the shop company is located."
},
"street_1" : {
"type" : "string",
"description" : "The first line of the address of the shop company"
},
"street_2" : {
"type" : "string",
"description" : "The second line of the address of the shop company"
},
"zip_code" : {
"type" : "string",
"description" : "The Zip/Postal code corresponding to the shop company location"
}
}
},
"A21_Response_200" : {
"type" : "object",
"properties" : {
"approval_delay" : {
"type" : "array",
"description" : "The average time period (in seconds) between when an order notification is sent to the shop and when the order is accepted.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_ApprovalDelay"
}
},
"approval_rate" : {
"type" : "array",
"description" : "The number of accepted order lines divided by the total number of accepted and rejected order lines.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_ApprovalRate"
}
},
"auto_refused_rate" : {
"type" : "array",
"description" : "The number of automatically rejected order lines divided by the total number of order lines submitted for approval.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_AutoRefusedRate"
}
},
"average_cart" : {
"type" : "array",
"description" : "Total of accepted order sales amount (tax included) divided by total accepted orders.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_AverageCart"
}
},
"average_cart_with_shipping" : {
"type" : "array",
"description" : "Total of accepted order sales amount (tax included) with shipping divided by total accepted orders.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_AverageCartWithShipping"
}
},
"cancelation_rate" : {
"type" : "array",
"description" : "The number of accepted order lines with at least one cancelation divided by the total number of accepted order lines.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_CancelationRate"
}
},
"channel" : {
"type" : "string",
"description" : "Channel code. If no channel is specified in the query params, this field is null"
},
"consecutive_refused_orders_count" : {
"type" : "array",
"description" : "Number of consecutive orders refused by the shop. Only present when the channelCode filter is not present.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_ConsecutiveRefusedOrdersCount"
}
},
"evaluations_count" : {
"type" : "array",
"description" : "Number of shop evaluations",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_EvaluationsCount"
}
},
"grade" : {
"type" : "array",
"description" : "Global grade of the shop",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_Grade"
}
},
"incident_rate" : {
"type" : "array",
"description" : "The number of order lines with at least one incident divided by the total number of accepted order lines.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_IncidentRate"
}
},
"last_updated_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Date and time when these statistics were last calculated."
},
"late_shipment_rate" : {
"type" : "array",
"description" : "The number of orders shipped later than the shipping deadline divided by the total number of orders.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_LateShipmentRate"
}
},
"offers_count" : {
"type" : "array",
"description" : "Total count of active offers of the shop. Only present when the channelCode filter is not present.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_OffersCount"
}
},
"order_messages_response_delay" : {
"type" : "array",
"description" : "The average time period (in seconds) in which the shop responds to a customer's order-related message.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_OrderMessagesResponseDelay"
}
},
"orders_count" : {
"type" : "array",
"description" : "Total count of debited orders. Includes accepted orders for Pay on Delivery payment method.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_OrdersCount"
}
},
"refund_rate" : {
"type" : "array",
"description" : "The number of order lines with at least one refund divided by the total number of accepted order lines.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_RefundRate"
}
},
"return_rate" : {
"type" : "array",
"description" : "The number of order lines with at least one return divided by the total number of returnable order lines.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_ReturnRate"
}
},
"shipping_delay" : {
"type" : "array",
"description" : "The average time period (in seconds) in which an order with the \"Awaiting shipment\" status is shipped.",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_ShippingDelay"
}
},
"shop_id" : {
"type" : "integer",
"format" : "int64",
"description" : "The identifier of the shop"
},
"total_revenue" : {
"type" : "array",
"description" : "Total shop revenue",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_TotalRevenue"
}
},
"valid_tracking_rate" : {
"type" : "array",
"description" : "The number of orders with a valid tracking divided by the total number of orders minus orders having an uncovered shipment. Return null if Mirakl Delivery Manager is not activated",
"items" : {
"$ref" : "#/components/schemas/A21_Response_200_ValidTrackingRate"
}
}
}
},
"A21_Response_200_ApprovalDelay" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "integer",
"format" : "int64",
"description" : "The statistic value"
}
}
},
"A21_Response_200_ApprovalRate" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_AutoRefusedRate" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_AverageCart" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_AverageCartWithShipping" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_CancelationRate" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_ConsecutiveRefusedOrdersCount" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "integer",
"format" : "int64",
"description" : "The statistic value"
}
}
},
"A21_Response_200_EvaluationsCount" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "integer",
"format" : "int64",
"description" : "The statistic value"
}
}
},
"A21_Response_200_Grade" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_IncidentRate" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_LateShipmentRate" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_OffersCount" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "integer",
"format" : "int64",
"description" : "The statistic value"
}
}
},
"A21_Response_200_OrderMessagesResponseDelay" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "integer",
"format" : "int64",
"description" : "The statistic value"
}
}
},
"A21_Response_200_OrdersCount" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "integer",
"format" : "int64",
"description" : "The statistic value"
}
}
},
"A21_Response_200_RefundRate" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_ReturnRate" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_ShippingDelay" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "integer",
"format" : "int64",
"description" : "The statistic value"
}
}
},
"A21_Response_200_TotalRevenue" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"A21_Response_200_ValidTrackingRate" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "The statistic period"
},
"value" : {
"type" : "number",
"description" : "The statistic value"
}
}
},
"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"
}
},
"code" : {
"type" : "string",
"description" : "Additional field code"
},
"description" : {
"type" : "string",
"description" : "The description of the additional field."
},
"editable" : {
"type" : "boolean",
"description" : "Whether or not the additional field will be editable"
},
"entity" : {
"type" : "string",
"description" : "The object on which the additional field applies"
},
"label" : {
"type" : "string",
"description" : "Additional field label"
},
"regex" : {
"type" : "string",
"description" : "The regular expression that is used to validate the value value of this field.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\nC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Checking accountP : Savings accountMANUAL_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_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" : "Document details",
"items" : {
"$ref" : "#/components/schemas/S30_Response_200_ShopDocuments"
}
}
}
},
"S30_Response_200_ShopDocuments" : {
"type" : "object",
"properties" : {
"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"
},
"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)"
}
}
},
"SL01_Request" : {
"type" : "object",
"properties" : {
"contact_info" : {
"$ref" : "#/components/schemas/SL01_Request_ContactInfo",
"description" : "Location contact information"
},
"description" : {
"type" : "string",
"description" : "Location description",
"maxLength" : 2000,
"minLength" : 0
},
"geography" : {
"$ref" : "#/components/schemas/SL01_Request_Geography",
"description" : "Geographic information for this location"
},
"label" : {
"type" : "string",
"description" : "Location label",
"maxLength" : 150,
"minLength" : 3
},
"opening_hours" : {
"$ref" : "#/components/schemas/SL01_Request_OpeningHours",
"description" : "Location opening hours"
}
}
},
"SL01_Request_ContactInfo" : {
"type" : "object",
"description" : "Location contact information",
"properties" : {
"email" : {
"type" : "string",
"description" : "Contact E-mail",
"maxLength" : 255,
"minLength" : 0
},
"phone" : {
"type" : "string",
"description" : "Contact phone number",
"maxLength" : 50,
"minLength" : 0
}
}
},
"SL01_Request_Geography" : {
"type" : "object",
"description" : "Geographic information for this location",
"discriminator" : {
"mapping" : {
"CIRCLE" : "#/components/schemas/SL01_Request_Geography_Circle",
"POINT" : "#/components/schemas/SL01_Request_Geography_Point",
"ZONE_REFERENCES" : "#/components/schemas/SL01_Request_Geography_ZoneReferences"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SL01_Request_Geography_Circle" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SL01_Request_Geography"
} ],
"properties" : {
"address" : {
"$ref" : "#/components/schemas/SL01_Request_Geography_Circle_Address",
"description" : "Address of the location"
},
"radius" : {
"type" : "integer",
"format" : "int32",
"description" : "Radius covered from the center, in meters rounded to the nearest km",
"maximum" : 1000000,
"minimum" : 1000
}
}
},
"SL01_Request_Geography_Circle_Address" : {
"type" : "object",
"properties" : {
"formatted_address" : {
"type" : "string",
"description" : "Address formatted to Google Maps API format"
}
}
},
"SL01_Request_Geography_Point" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SL01_Request_Geography"
} ],
"properties" : {
"address" : {
"$ref" : "#/components/schemas/SL01_Request_Geography_Point_Address",
"description" : "Address of the location"
}
}
},
"SL01_Request_Geography_Point_Address" : {
"type" : "object",
"properties" : {
"formatted_address" : {
"type" : "string",
"description" : "Address formatted to Google Maps API format"
}
}
},
"SL01_Request_Geography_ZoneReferences" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SL01_Request_Geography"
} ],
"properties" : {
"zone_references" : {
"type" : "array",
"description" : "Zone references covered by this location",
"items" : {
"$ref" : "#/components/schemas/SL01_Request_Geography_ZoneReferences_ZoneReferences"
}
}
}
},
"SL01_Request_Geography_ZoneReferences_ZoneReferences" : {
"type" : "object",
"properties" : {
"reference_id" : {
"type" : "string",
"description" : "Id of the zone reference"
}
}
},
"SL01_Request_OpeningHours" : {
"type" : "object",
"description" : "Location opening hours",
"properties" : {
"friday" : {
"type" : "array",
"description" : "Friday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Request_OpeningHours_Friday"
}
},
"monday" : {
"type" : "array",
"description" : "Monday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Request_OpeningHours_Monday"
}
},
"saturday" : {
"type" : "array",
"description" : "Saturday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Request_OpeningHours_Saturday"
}
},
"sunday" : {
"type" : "array",
"description" : "Sunday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Request_OpeningHours_Sunday"
}
},
"thursday" : {
"type" : "array",
"description" : "Thursday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Request_OpeningHours_Thursday"
}
},
"tuesday" : {
"type" : "array",
"description" : "Tuesday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Request_OpeningHours_Tuesday"
}
},
"wednesday" : {
"type" : "array",
"description" : "Wednesday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Request_OpeningHours_Wednesday"
}
}
}
},
"SL01_Request_OpeningHours_Friday" : {
"type" : "object",
"description" : "Sunday opening hours",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Request_OpeningHours_Monday" : {
"type" : "object",
"description" : "Sunday opening hours",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Request_OpeningHours_Saturday" : {
"type" : "object",
"description" : "Sunday opening hours",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Request_OpeningHours_Sunday" : {
"type" : "object",
"description" : "Sunday opening hours",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Request_OpeningHours_Thursday" : {
"type" : "object",
"description" : "Sunday opening hours",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Request_OpeningHours_Tuesday" : {
"type" : "object",
"description" : "Sunday opening hours",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Request_OpeningHours_Wednesday" : {
"type" : "object",
"description" : "Sunday opening hours",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201" : {
"type" : "object",
"properties" : {
"contact_info" : {
"$ref" : "#/components/schemas/SL01_Response_201_ContactInfo",
"description" : "Location contact information"
},
"description" : {
"type" : "string",
"description" : "Location description"
},
"geography" : {
"$ref" : "#/components/schemas/SL01_Response_201_Geography",
"description" : "Geographic information for this location"
},
"id" : {
"type" : "string",
"description" : "Location ID"
},
"label" : {
"type" : "string",
"description" : "Location label"
},
"medias" : {
"type" : "array",
"description" : "Medias associated to the location",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_Medias"
}
},
"opening_hours" : {
"$ref" : "#/components/schemas/SL01_Response_201_OpeningHours",
"description" : "Location opening hours"
},
"overridden_opening_hours" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours",
"description" : "Overridden opening hours. Only available for an operator location"
}
}
},
"SL01_Response_201_ContactInfo" : {
"type" : "object",
"properties" : {
"email" : {
"type" : "string",
"description" : "Contact E-mail"
},
"phone" : {
"type" : "string",
"description" : "Contact phone number"
}
}
},
"SL01_Response_201_Geography" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"CIRCLE" : "#/components/schemas/SL01_Response_201_Geography_Circle",
"POINT" : "#/components/schemas/SL01_Response_201_Geography_Point",
"ZONE_REFERENCES" : "#/components/schemas/SL01_Response_201_Geography_ZoneReferences"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string"
}
}
},
"SL01_Response_201_Geography_Circle" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SL01_Response_201_Geography"
} ],
"properties" : {
"address" : {
"$ref" : "#/components/schemas/SL01_Response_201_Geography_Circle_Address",
"description" : "Address of the location"
},
"center" : {
"$ref" : "#/components/schemas/SL01_Response_201_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"
}
}
},
"SL01_Response_201_Geography_Circle_Address" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "Address city"
},
"company" : {
"type" : "string",
"description" : "Company associated with the address"
},
"complementary" : {
"type" : "string",
"description" : "Address street complementary information line"
},
"country_code" : {
"type" : "string",
"description" : "Address country ISO 3166-1 alpha-3 code"
},
"formatted_address" : {
"type" : "string",
"description" : "Address formatted by Google Maps API"
},
"state" : {
"type" : "string",
"description" : "Address state"
},
"street1" : {
"type" : "string",
"description" : "Address street first information line"
},
"street2" : {
"type" : "string",
"description" : "Address street second information line"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"SL01_Response_201_Geography_Circle_Center" : {
"type" : "object",
"properties" : {
"latitude" : {
"type" : "number",
"format" : "double",
"description" : "Location latitude"
},
"longitude" : {
"type" : "number",
"format" : "double",
"description" : "Location longitude"
}
}
},
"SL01_Response_201_Geography_Point" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SL01_Response_201_Geography"
} ],
"properties" : {
"address" : {
"$ref" : "#/components/schemas/SL01_Response_201_Geography_Point_Address",
"description" : "Address of the location"
},
"geocode" : {
"$ref" : "#/components/schemas/SL01_Response_201_Geography_Point_Geocode",
"description" : "Geocode of the location"
}
}
},
"SL01_Response_201_Geography_Point_Address" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "Address city"
},
"company" : {
"type" : "string",
"description" : "Company associated with the address"
},
"complementary" : {
"type" : "string",
"description" : "Address street complementary information line"
},
"country_code" : {
"type" : "string",
"description" : "Address country ISO 3166-1 alpha-3 code"
},
"formatted_address" : {
"type" : "string",
"description" : "Address formatted by Google Maps API"
},
"state" : {
"type" : "string",
"description" : "Address state"
},
"street1" : {
"type" : "string",
"description" : "Address street first information line"
},
"street2" : {
"type" : "string",
"description" : "Address street second information line"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"SL01_Response_201_Geography_Point_Geocode" : {
"type" : "object",
"properties" : {
"latitude" : {
"type" : "number",
"format" : "double",
"description" : "Location latitude"
},
"longitude" : {
"type" : "number",
"format" : "double",
"description" : "Location longitude"
}
}
},
"SL01_Response_201_Geography_ZoneReferences" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SL01_Response_201_Geography"
} ],
"properties" : {
"zone_references" : {
"type" : "array",
"description" : "ZoneReferences covered by this location",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_Geography_ZoneReferences_ZoneReferences"
}
}
}
},
"SL01_Response_201_Geography_ZoneReferences_ZoneReferences" : {
"type" : "object",
"properties" : {
"address" : {
"$ref" : "#/components/schemas/SL01_Response_201_Geography_ZoneReferences_ZoneReferences_Address",
"description" : "Address of the zone reference."
},
"reference_id" : {
"type" : "string",
"description" : "Id of the zone reference."
}
}
},
"SL01_Response_201_Geography_ZoneReferences_ZoneReferences_Address" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "Address city"
},
"company" : {
"type" : "string",
"description" : "Company associated with the address"
},
"complementary" : {
"type" : "string",
"description" : "Address street complementary information line"
},
"country_code" : {
"type" : "string",
"description" : "Address country ISO 3166-1 alpha-3 code"
},
"formatted_address" : {
"type" : "string",
"description" : "Address formatted by Google Maps API"
},
"state" : {
"type" : "string",
"description" : "Address state"
},
"street1" : {
"type" : "string",
"description" : "Address street first information line"
},
"street2" : {
"type" : "string",
"description" : "Address street second information line"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"SL01_Response_201_Medias" : {
"type" : "object",
"properties" : {
"mime_type" : {
"type" : "string",
"description" : "Media Mime type"
},
"url" : {
"type" : "string",
"description" : "Media URL"
}
}
},
"SL01_Response_201_OpeningHours" : {
"type" : "object",
"properties" : {
"friday" : {
"type" : "array",
"description" : "Friday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OpeningHours_Friday"
}
},
"monday" : {
"type" : "array",
"description" : "Monday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OpeningHours_Monday"
}
},
"saturday" : {
"type" : "array",
"description" : "Saturday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OpeningHours_Saturday"
}
},
"sunday" : {
"type" : "array",
"description" : "Sunday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OpeningHours_Sunday"
}
},
"thursday" : {
"type" : "array",
"description" : "Thursday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OpeningHours_Thursday"
}
},
"tuesday" : {
"type" : "array",
"description" : "Tuesday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OpeningHours_Tuesday"
}
},
"wednesday" : {
"type" : "array",
"description" : "Wednesday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OpeningHours_Wednesday"
}
}
}
},
"SL01_Response_201_OpeningHours_Friday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OpeningHours_Monday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OpeningHours_Saturday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OpeningHours_Sunday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OpeningHours_Thursday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OpeningHours_Tuesday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OpeningHours_Wednesday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OverriddenOpeningHours" : {
"type" : "object",
"properties" : {
"friday" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Friday",
"description" : "Friday opening hours"
},
"monday" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Monday",
"description" : "Monday opening hours"
},
"saturday" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Saturday",
"description" : "Saturday opening hours"
},
"sunday" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Sunday",
"description" : "Sunday opening hours"
},
"thursday" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Thursday",
"description" : "Thursday opening hours"
},
"tuesday" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Tuesday",
"description" : "Tuesday opening hours"
},
"wednesday" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Wednesday",
"description" : "Wednesday opening hours"
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Friday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Friday_OpeningHours"
}
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Friday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Monday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Monday_OpeningHours"
}
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Monday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Saturday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Saturday_OpeningHours"
}
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Saturday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Sunday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Sunday_OpeningHours"
}
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Sunday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Thursday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Thursday_OpeningHours"
}
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Thursday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Tuesday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Tuesday_OpeningHours"
}
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Tuesday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Wednesday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL01_Response_201_OverriddenOpeningHours_Wednesday_OpeningHours"
}
}
}
},
"SL01_Response_201_OverriddenOpeningHours_Wednesday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/SL12_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."
}
}
},
"SL12_Response_200_Data" : {
"type" : "object",
"properties" : {
"contact_info" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_ContactInfo",
"description" : "Location contact information"
},
"description" : {
"type" : "string",
"description" : "Location description"
},
"geography" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_Geography",
"description" : "Geographic information for this location"
},
"id" : {
"type" : "string",
"description" : "Location ID"
},
"label" : {
"type" : "string",
"description" : "Location label"
},
"medias" : {
"type" : "array",
"description" : "Medias associated to the location",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_Medias"
}
},
"opening_hours" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OpeningHours",
"description" : "Location opening hours"
},
"overridden_opening_hours" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours",
"description" : "Overridden opening hours. Only available for an operator location"
}
}
},
"SL12_Response_200_Data_ContactInfo" : {
"type" : "object",
"properties" : {
"email" : {
"type" : "string",
"description" : "Contact E-mail"
},
"phone" : {
"type" : "string",
"description" : "Contact phone number"
}
}
},
"SL12_Response_200_Data_Geography" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"CIRCLE" : "#/components/schemas/SL12_Response_200_Data_Geography_Circle",
"POINT" : "#/components/schemas/SL12_Response_200_Data_Geography_Point",
"ZONE_REFERENCES" : "#/components/schemas/SL12_Response_200_Data_Geography_ZoneReferences"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string"
}
}
},
"SL12_Response_200_Data_Geography_Circle" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SL12_Response_200_Data_Geography"
} ],
"properties" : {
"address" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_Geography_Circle_Address",
"description" : "Address of the location"
},
"center" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_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"
}
}
},
"SL12_Response_200_Data_Geography_Circle_Address" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "Address city"
},
"company" : {
"type" : "string",
"description" : "Company associated with the address"
},
"complementary" : {
"type" : "string",
"description" : "Address street complementary information line"
},
"country_code" : {
"type" : "string",
"description" : "Address country ISO 3166-1 alpha-3 code"
},
"formatted_address" : {
"type" : "string",
"description" : "Address formatted by Google Maps API"
},
"state" : {
"type" : "string",
"description" : "Address state"
},
"street1" : {
"type" : "string",
"description" : "Address street first information line"
},
"street2" : {
"type" : "string",
"description" : "Address street second information line"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"SL12_Response_200_Data_Geography_Circle_Center" : {
"type" : "object",
"properties" : {
"latitude" : {
"type" : "number",
"format" : "double",
"description" : "Location latitude"
},
"longitude" : {
"type" : "number",
"format" : "double",
"description" : "Location longitude"
}
}
},
"SL12_Response_200_Data_Geography_Point" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SL12_Response_200_Data_Geography"
} ],
"properties" : {
"address" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_Geography_Point_Address",
"description" : "Address of the location"
},
"geocode" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_Geography_Point_Geocode",
"description" : "Geocode of the location"
}
}
},
"SL12_Response_200_Data_Geography_Point_Address" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "Address city"
},
"company" : {
"type" : "string",
"description" : "Company associated with the address"
},
"complementary" : {
"type" : "string",
"description" : "Address street complementary information line"
},
"country_code" : {
"type" : "string",
"description" : "Address country ISO 3166-1 alpha-3 code"
},
"formatted_address" : {
"type" : "string",
"description" : "Address formatted by Google Maps API"
},
"state" : {
"type" : "string",
"description" : "Address state"
},
"street1" : {
"type" : "string",
"description" : "Address street first information line"
},
"street2" : {
"type" : "string",
"description" : "Address street second information line"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"SL12_Response_200_Data_Geography_Point_Geocode" : {
"type" : "object",
"properties" : {
"latitude" : {
"type" : "number",
"format" : "double",
"description" : "Location latitude"
},
"longitude" : {
"type" : "number",
"format" : "double",
"description" : "Location longitude"
}
}
},
"SL12_Response_200_Data_Geography_ZoneReferences" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SL12_Response_200_Data_Geography"
} ],
"properties" : {
"zone_references" : {
"type" : "array",
"description" : "ZoneReferences covered by this location",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_Geography_ZoneReferences_ZoneReferences"
}
}
}
},
"SL12_Response_200_Data_Geography_ZoneReferences_ZoneReferences" : {
"type" : "object",
"properties" : {
"address" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_Geography_ZoneReferences_ZoneReferences_Address",
"description" : "Address of the zone reference."
},
"reference_id" : {
"type" : "string",
"description" : "Id of the zone reference."
}
}
},
"SL12_Response_200_Data_Geography_ZoneReferences_ZoneReferences_Address" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "Address city"
},
"company" : {
"type" : "string",
"description" : "Company associated with the address"
},
"complementary" : {
"type" : "string",
"description" : "Address street complementary information line"
},
"country_code" : {
"type" : "string",
"description" : "Address country ISO 3166-1 alpha-3 code"
},
"formatted_address" : {
"type" : "string",
"description" : "Address formatted by Google Maps API"
},
"state" : {
"type" : "string",
"description" : "Address state"
},
"street1" : {
"type" : "string",
"description" : "Address street first information line"
},
"street2" : {
"type" : "string",
"description" : "Address street second information line"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"SL12_Response_200_Data_Medias" : {
"type" : "object",
"properties" : {
"mime_type" : {
"type" : "string",
"description" : "Media Mime type"
},
"url" : {
"type" : "string",
"description" : "Media URL"
}
}
},
"SL12_Response_200_Data_OpeningHours" : {
"type" : "object",
"properties" : {
"friday" : {
"type" : "array",
"description" : "Friday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OpeningHours_Friday"
}
},
"monday" : {
"type" : "array",
"description" : "Monday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OpeningHours_Monday"
}
},
"saturday" : {
"type" : "array",
"description" : "Saturday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OpeningHours_Saturday"
}
},
"sunday" : {
"type" : "array",
"description" : "Sunday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OpeningHours_Sunday"
}
},
"thursday" : {
"type" : "array",
"description" : "Thursday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OpeningHours_Thursday"
}
},
"tuesday" : {
"type" : "array",
"description" : "Tuesday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OpeningHours_Tuesday"
}
},
"wednesday" : {
"type" : "array",
"description" : "Wednesday opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OpeningHours_Wednesday"
}
}
}
},
"SL12_Response_200_Data_OpeningHours_Friday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OpeningHours_Monday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OpeningHours_Saturday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OpeningHours_Sunday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OpeningHours_Thursday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OpeningHours_Tuesday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OpeningHours_Wednesday" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours" : {
"type" : "object",
"properties" : {
"friday" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Friday",
"description" : "Friday opening hours"
},
"monday" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Monday",
"description" : "Monday opening hours"
},
"saturday" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Saturday",
"description" : "Saturday opening hours"
},
"sunday" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Sunday",
"description" : "Sunday opening hours"
},
"thursday" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Thursday",
"description" : "Thursday opening hours"
},
"tuesday" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Tuesday",
"description" : "Tuesday opening hours"
},
"wednesday" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Wednesday",
"description" : "Wednesday opening hours"
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Friday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Friday_OpeningHours"
}
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Friday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Monday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Monday_OpeningHours"
}
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Monday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Saturday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Saturday_OpeningHours"
}
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Saturday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Sunday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Sunday_OpeningHours"
}
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Sunday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Thursday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Thursday_OpeningHours"
}
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Thursday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Tuesday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Tuesday_OpeningHours"
}
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Tuesday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Wednesday" : {
"type" : "object",
"properties" : {
"availability" : {
"type" : "string",
"description" : "Availability of the overridden hours. Either OVERRIDDEN_HOURS or NOT_AVAILABLE"
},
"opening_hours" : {
"type" : "array",
"description" : "Opening hours",
"items" : {
"$ref" : "#/components/schemas/SL12_Response_200_Data_OverriddenOpeningHours_Wednesday_OpeningHours"
}
}
}
},
"SL12_Response_200_Data_OverriddenOpeningHours_Wednesday_OpeningHours" : {
"type" : "object",
"properties" : {
"closing_time" : {
"type" : "string",
"description" : "Closing time in hh:mm format"
},
"opening_time" : {
"type" : "string",
"description" : "Opening time in hh:mm format"
}
}
},
"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"
},
"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_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 typeFIXED_PRICE, the price defined when placing an order is final. The price cannot be modified.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.FIXED_PRICE_MULTI, the price defined when placing an order is final. The price cannot be modified. The price has multiple possibilities.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.PT1H15M stands for Period of Time of 1 Hour and 15 MinutesPT3OM stands for Period of Time of 30 MinutesPT1H15M stands for Period of Time of 1 Hour and 15 MinutesPT3OM stands for Period of Time of 30 MinutesFIXED_PRICE, the price defined when placing an order is final. The price cannot be modified.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.FIXED_PRICE_MULTI, the price defined when placing an order is final. The price cannot be modified. The price has multiple possibilities.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.booking will be of type NO_BOOKING."
},
"category" : {
"$ref" : "#/components/schemas/SOF25_Request_Category",
"description" : "Service category"
},
"custom_attribute_values" : {
"type" : "array",
"description" : "Service custom attributes values",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues"
}
},
"date_availability_end" : {
"type" : "string",
"format" : "date-time",
"description" : "Date when the service ends being available"
},
"date_availability_start" : {
"type" : "string",
"format" : "date-time",
"description" : "Date when the service starts being available"
},
"description" : {
"type" : "string",
"description" : "Service description",
"maxLength" : 2000,
"minLength" : 0
},
"inactive_reasons" : {
"type" : "array",
"description" : "Reason why the service is inactive.",
"items" : {
"type" : "string"
}
},
"location" : {
"$ref" : "#/components/schemas/SOF25_Request_Location",
"description" : "Service location method. The type of the location must reflect the associated Model's location. By default, location will be of type NO_LOCATION."
},
"model" : {
"$ref" : "#/components/schemas/SOF25_Request_Model",
"description" : "Service model"
},
"pricing" : {
"$ref" : "#/components/schemas/SOF25_Request_Pricing",
"description" : "Service pricing method"
},
"quantity" : {
"$ref" : "#/components/schemas/SOF25_Request_Quantity",
"description" : "Service quantity method. By default, quantity will be of type NO_QUANTITY."
},
"service_tax_code" : {
"type" : "string",
"description" : "Service tax code"
},
"title" : {
"type" : "string",
"description" : "Service title",
"maxLength" : 150,
"minLength" : 3
}
}
},
"SOF25_Request_Booking" : {
"type" : "object",
"description" : "Service booking method. The type of the booking must reflect the associated Model's booking. By default, booking will be of type NO_BOOKING.",
"discriminator" : {
"mapping" : {
"DATETIME_REQUEST" : "#/components/schemas/SOF25_Request_Booking_DatetimeRequest",
"NO_BOOKING" : "#/components/schemas/SOF25_Request_Booking_NoBooking",
"SCHEDULED_EVENTS" : "#/components/schemas/SOF25_Request_Booking_ScheduledEvents"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOF25_Request_Booking_DatetimeRequest" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Booking"
} ],
"properties" : {
"duration" : {
"type" : "string",
"description" : "Value of the field. Follows ISO-8601 duration format. Ex: PT1H30M"
}
}
},
"SOF25_Request_Booking_NoBooking" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Booking"
} ]
},
"SOF25_Request_Booking_ScheduledEvents" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Booking"
} ],
"properties" : {
"duration" : {
"type" : "string",
"description" : "Value of the field. Follows ISO-8601 duration format. Ex: PT1H30M"
},
"sessions" : {
"type" : "array",
"description" : "List of sessions",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_Booking_ScheduledEvents_Sessions"
},
"maxItems" : 300,
"minItems" : 1
}
}
},
"SOF25_Request_Booking_ScheduledEvents_Sessions" : {
"type" : "object",
"properties" : {
"available_units" : {
"type" : "integer",
"format" : "int32",
"description" : "Available units",
"minimum" : 0
},
"time_slot" : {
"$ref" : "#/components/schemas/SOF25_Request_Booking_ScheduledEvents_Sessions_TimeSlot",
"description" : "Timeslot of the session"
}
}
},
"SOF25_Request_Booking_ScheduledEvents_Sessions_TimeSlot" : {
"type" : "object",
"properties" : {
"start" : {
"type" : "string",
"format" : "date-time",
"description" : "Starting date of the timeslot"
}
}
},
"SOF25_Request_Category" : {
"type" : "object",
"description" : "Service category",
"properties" : {
"code" : {
"type" : "string",
"description" : "Service category code. The category must exist in the configuration."
}
}
},
"SOF25_Request_CustomAttributeValues" : {
"type" : "object",
"description" : "Service custom attributes values",
"discriminator" : {
"mapping" : {
"BOOLEAN" : "#/components/schemas/SOF25_Request_CustomAttributeValues_Boolean",
"DATE_TIME" : "#/components/schemas/SOF25_Request_CustomAttributeValues_DateTime",
"DECIMAL" : "#/components/schemas/SOF25_Request_CustomAttributeValues_Decimal",
"INTEGER" : "#/components/schemas/SOF25_Request_CustomAttributeValues_Integer",
"LINK" : "#/components/schemas/SOF25_Request_CustomAttributeValues_Link",
"LONG_TEXT" : "#/components/schemas/SOF25_Request_CustomAttributeValues_LongText",
"TEXT" : "#/components/schemas/SOF25_Request_CustomAttributeValues_Text",
"VALUE_LIST" : "#/components/schemas/SOF25_Request_CustomAttributeValues_ValueList",
"VIDEO" : "#/components/schemas/SOF25_Request_CustomAttributeValues_Video"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "Custom attribute code. The attribute must exist in the configuration."
},
"type" : {
"type" : "string",
"description" : "Custom attribute type"
},
"value" : {
"type" : "object"
}
}
},
"SOF25_Request_CustomAttributeValues_Boolean" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "boolean",
"description" : "Custom attribute value"
}
}
},
"SOF25_Request_CustomAttributeValues_DateTime" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"format" : "date-time",
"description" : "Custom attribute value"
}
}
},
"SOF25_Request_CustomAttributeValues_Decimal" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "number",
"description" : "Custom attribute value"
}
}
},
"SOF25_Request_CustomAttributeValues_Integer" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "integer",
"format" : "int32",
"description" : "Custom attribute value"
}
}
},
"SOF25_Request_CustomAttributeValues_Link" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute value"
}
}
},
"SOF25_Request_CustomAttributeValues_LongText" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute value"
}
}
},
"SOF25_Request_CustomAttributeValues_Text" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute value"
}
}
},
"SOF25_Request_CustomAttributeValues_ValueList" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "array",
"description" : "Value list items",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues_ValueList_Value"
}
}
}
},
"SOF25_Request_CustomAttributeValues_ValueList_Value" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Code of the item"
}
}
},
"SOF25_Request_CustomAttributeValues_Video" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute value"
}
}
},
"SOF25_Request_Location" : {
"type" : "object",
"description" : "Service location method. The type of the location must reflect the associated Model's location. By default, location will be of type NO_LOCATION.",
"discriminator" : {
"mapping" : {
"AT_CUSTOMER_LOCATION" : "#/components/schemas/SOF25_Request_Location_AtCustomerLocation",
"AT_SHOP_LOCATION" : "#/components/schemas/SOF25_Request_Location_AtShopLocation",
"NO_LOCATION" : "#/components/schemas/SOF25_Request_Location_NoLocation"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOF25_Request_Location_AtCustomerLocation" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Location"
} ],
"properties" : {
"shop_locations" : {
"type" : "array",
"description" : "Locations where the service can be provided. The location type must be compatible with the model.",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_Location_AtCustomerLocation_ShopLocations"
},
"maxItems" : 65,
"minItems" : 1
}
}
},
"SOF25_Request_Location_AtCustomerLocation_ShopLocations" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Location ID. The location must belong to the shop."
}
}
},
"SOF25_Request_Location_AtShopLocation" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Location"
} ],
"properties" : {
"shop_locations" : {
"type" : "array",
"description" : "Locations where the service can be provided. The location type must be compatible with the model.",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_Location_AtShopLocation_ShopLocations"
},
"maxItems" : 65,
"minItems" : 1
}
}
},
"SOF25_Request_Location_AtShopLocation_ShopLocations" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Location ID. The location must belong to the shop."
}
}
},
"SOF25_Request_Location_NoLocation" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Location"
} ]
},
"SOF25_Request_Model" : {
"type" : "object",
"description" : "Service model",
"properties" : {
"code" : {
"type" : "string",
"description" : "Service model code"
}
}
},
"SOF25_Request_Pricing" : {
"type" : "object",
"description" : "Service pricing method",
"discriminator" : {
"mapping" : {
"ESTIMATED_PRICE" : "#/components/schemas/SOF25_Request_Pricing_EstimatedPrice",
"ESTIMATED_PRICE_MULTI" : "#/components/schemas/SOF25_Request_Pricing_EstimatedPriceMulti",
"FIXED_PRICE" : "#/components/schemas/SOF25_Request_Pricing_FixedPrice",
"FIXED_PRICE_MULTI" : "#/components/schemas/SOF25_Request_Pricing_FixedPriceMulti"
},
"propertyName" : "type"
},
"properties" : {
"options" : {
"type" : "array",
"description" : "Service pricing options.",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_Pricing_Options"
}
},
"type" : {
"type" : "string",
"description" : "Price type. It must be equal to the price type in the Model configuration."
}
}
},
"SOF25_Request_Pricing_EstimatedPrice" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Pricing"
} ],
"properties" : {
"price_per_unit" : {
"type" : "number",
"description" : "Price at which the service will be provided. It's a price per unit.",
"maximum" : 1000000000,
"minimum" : 0
}
}
},
"SOF25_Request_Pricing_EstimatedPriceMulti" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Pricing"
} ],
"properties" : {
"price_per_unit_options" : {
"type" : "array",
"description" : "Service price per unit options.",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_Pricing_EstimatedPriceMulti_PricePerUnitOptions"
},
"maxItems" : 1,
"minItems" : 0
}
}
},
"SOF25_Request_Pricing_EstimatedPriceMulti_PricePerUnitOptions" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Price per unit options code."
},
"type" : {
"type" : "string",
"description" : "Price per unit options type. Must be VALUE_LIST."
},
"values" : {
"type" : "array",
"description" : "Price per unit options values.",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_Pricing_EstimatedPriceMulti_PricePerUnitOptions_Values"
}
}
}
},
"SOF25_Request_Pricing_EstimatedPriceMulti_PricePerUnitOptions_Values" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Price per unit option amount"
},
"code" : {
"type" : "string",
"description" : "Price per unit option code"
}
}
},
"SOF25_Request_Pricing_FixedPrice" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Pricing"
} ],
"properties" : {
"price_per_unit" : {
"type" : "number",
"description" : "Price at which the service will be provided. It's a price per unit.",
"maximum" : 1000000000,
"minimum" : 0
}
}
},
"SOF25_Request_Pricing_FixedPriceMulti" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Pricing"
} ],
"properties" : {
"price_per_unit_options" : {
"type" : "array",
"description" : "Service price per unit options.",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_Pricing_FixedPriceMulti_PricePerUnitOptions"
},
"maxItems" : 1,
"minItems" : 0
}
}
},
"SOF25_Request_Pricing_FixedPriceMulti_PricePerUnitOptions" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Price per unit options code."
},
"type" : {
"type" : "string",
"description" : "Price per unit options type. Must be VALUE_LIST."
},
"values" : {
"type" : "array",
"description" : "Price per unit options values.",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_Pricing_FixedPriceMulti_PricePerUnitOptions_Values"
}
}
}
},
"SOF25_Request_Pricing_FixedPriceMulti_PricePerUnitOptions_Values" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Price per unit option amount"
},
"code" : {
"type" : "string",
"description" : "Price per unit option code"
}
}
},
"SOF25_Request_Pricing_Options" : {
"type" : "object",
"description" : "Service pricing options.",
"discriminator" : {
"mapping" : {
"BOOLEAN" : "#/components/schemas/SOF25_Request_Pricing_Options_Boolean",
"VALUE_LIST" : "#/components/schemas/SOF25_Request_Pricing_Options_ValueList"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "Pricing option identifier"
},
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOF25_Request_Pricing_Options_Boolean" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Pricing_Options"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "Pricing option values",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_Pricing_Options_Boolean_Values"
}
}
}
},
"SOF25_Request_Pricing_Options_Boolean_Values" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Pricing option amount",
"maximum" : 1000000000,
"minimum" : 0
},
"value" : {
"type" : "boolean",
"description" : "Pricing option value"
}
}
},
"SOF25_Request_Pricing_Options_ValueList" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Pricing_Options"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "Pricing option values",
"items" : {
"$ref" : "#/components/schemas/SOF25_Request_Pricing_Options_ValueList_Values"
}
}
}
},
"SOF25_Request_Pricing_Options_ValueList_Values" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Pricing option amount",
"maximum" : 1000000000,
"minimum" : 0
},
"code" : {
"type" : "string",
"description" : "Pricing option value identifier"
}
}
},
"SOF25_Request_Quantity" : {
"type" : "object",
"description" : "Service quantity method. By default, quantity will be of type NO_QUANTITY.",
"discriminator" : {
"mapping" : {
"LIMITED" : "#/components/schemas/SOF25_Request_Quantity_Limited",
"NO_QUANTITY" : "#/components/schemas/SOF25_Request_Quantity_NoQuantity"
},
"propertyName" : "type"
},
"properties" : {
"max_per_order" : {
"type" : "integer",
"format" : "int32",
"description" : "Maximum quantity per order",
"maximum" : 1000,
"minimum" : 1
},
"type" : {
"type" : "string"
}
}
},
"SOF25_Request_Quantity_Limited" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Quantity"
} ],
"description" : "The service has a limited quantity",
"properties" : {
"available" : {
"type" : "integer",
"format" : "int32",
"description" : "Service volume the shop is able to provide",
"maximum" : 1000000000,
"minimum" : 0
},
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOF25_Request_Quantity_NoQuantity" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Request_Quantity"
} ],
"description" : "The service has no quantity",
"properties" : {
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOF25_Response_201" : {
"type" : "object",
"properties" : {
"booking" : {
"$ref" : "#/components/schemas/SOF25_Response_201_Booking",
"description" : "Service booking method"
},
"category" : {
"$ref" : "#/components/schemas/SOF25_Response_201_Category",
"description" : "Service category"
},
"code" : {
"type" : "string",
"description" : "Service code"
},
"consumption" : {
"$ref" : "#/components/schemas/SOF25_Response_201_Consumption",
"description" : "Service consumption method: how will the service be consumed ?"
},
"custom_attribute_values" : {
"type" : "array",
"description" : "Service custom attributes values",
"items" : {
"$ref" : "#/components/schemas/SOF25_Response_201_CustomAttributeValues"
}
},
"date_availability_end" : {
"type" : "string",
"format" : "date-time",
"description" : "Date when the service ends being available"
},
"date_availability_start" : {
"type" : "string",
"format" : "date-time",
"description" : "Date when the service starts being available"
},
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Service creation date"
},
"date_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Service update date"
},
"description" : {
"type" : "string",
"description" : "Service description"
},
"inactive_reasons" : {
"type" : "array",
"description" : "List of reasons why the service is inactive. If the service is active, this list is empty",
"items" : {
"type" : "string"
}
},
"location" : {
"$ref" : "#/components/schemas/SOF25_Response_201_Location",
"description" : "Service location method: where the service will be provided ?"
},
"medias" : {
"type" : "array",
"description" : "All the medias associated to a service",
"items" : {
"$ref" : "#/components/schemas/SOF25_Response_201_Medias"
}
},
"model" : {
"$ref" : "#/components/schemas/SOF25_Response_201_Model",
"description" : "Service model"
},
"pricing" : {
"$ref" : "#/components/schemas/SOF25_Response_201_Pricing",
"description" : "Service pricing method"
},
"quantity" : {
"$ref" : "#/components/schemas/SOF25_Response_201_Quantity",
"description" : "Service quantity method"
},
"service_tax_code" : {
"type" : "string",
"description" : "Service tax code"
},
"title" : {
"type" : "string",
"description" : "Service title"
}
}
},
"SOF25_Response_201_Booking" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"DATETIME_REQUEST" : "#/components/schemas/SOF25_Response_201_Booking_DatetimeRequest",
"NO_BOOKING" : "#/components/schemas/SOF25_Response_201_Booking_NoBooking",
"SCHEDULED_EVENTS" : "#/components/schemas/SOF25_Response_201_Booking_ScheduledEvents"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string"
}
}
},
"SOF25_Response_201_Booking_DatetimeRequest" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF25_Response_201_Booking"
} ],
"description" : "The service has a duration",
"properties" : {
"duration" : {
"type" : "string",
"description" : "Service duration, using the ISO-8601 Duration Standard.PT1H15M stands for Period of Time of 1 Hour and 15 MinutesPT3OM stands for Period of Time of 30 MinutesPT1H15M stands for Period of Time of 1 Hour and 15 MinutesPT3OM stands for Period of Time of 30 MinutesFIXED_PRICE, the price defined when placing an order is final. The price cannot be modified.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.FIXED_PRICE_MULTI, the price defined when placing an order is final. The price cannot be modified. The price has multiple possibilities.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.null to remove the date."
},
"date_availability_start" : {
"type" : "string",
"format" : "date-time",
"description" : "Date when the service starts being available. Set value to null to remove the date."
},
"description" : {
"type" : "string",
"description" : "Service description. Set value to null to remove the description.",
"maxLength" : 2000
},
"inactive_reasons" : {
"type" : "array",
"description" : "Reason why the service is inactive. If equals to [] or null, then remove all reasons that are manually removable.",
"items" : {
"type" : "string"
},
"maxItems" : 1,
"minItems" : 0
},
"location" : {
"$ref" : "#/components/schemas/SOF26_Request_Location",
"description" : "Service location method. The location type must be equal to the location type in the Model configuration."
},
"model" : {
"$ref" : "#/components/schemas/SOF26_Request_Model",
"description" : "Service model"
},
"pricing" : {
"$ref" : "#/components/schemas/SOF26_Request_Pricing",
"description" : "Service pricing method"
},
"quantity" : {
"$ref" : "#/components/schemas/SOF26_Request_Quantity",
"description" : "Service quantity method."
},
"service_tax_code" : {
"type" : "string",
"description" : "Service tax code"
},
"title" : {
"type" : "string",
"description" : "Service title",
"maxLength" : 150,
"minLength" : 3
}
}
},
"SOF26_Request_Booking" : {
"type" : "object",
"description" : "Service booking method. The booking type must be equal to the booking type in the Model configuration.",
"discriminator" : {
"mapping" : {
"DATETIME_REQUEST" : "#/components/schemas/SOF26_Request_Booking_DatetimeRequest",
"NO_BOOKING" : "#/components/schemas/SOF26_Request_Booking_NoBooking",
"SCHEDULED_EVENTS" : "#/components/schemas/SOF26_Request_Booking_ScheduledEvents"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : "The booking type must be equal to the booking type in the Model configuration."
}
}
},
"SOF26_Request_Booking_DatetimeRequest" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Booking"
} ],
"properties" : {
"duration" : {
"type" : "string",
"description" : "Value of the field. Follows ISO-8601 duration format. Ex: PT1H30M"
}
}
},
"SOF26_Request_Booking_NoBooking" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Booking"
} ]
},
"SOF26_Request_Booking_ScheduledEvents" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Booking"
} ],
"properties" : {
"duration" : {
"type" : "string",
"description" : "Value of the field. Follows ISO-8601 duration format. Ex: PT1H30M"
},
"sessions" : {
"type" : "array",
"description" : "List of sessions. Set to [] to remove values.",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_Booking_ScheduledEvents_Sessions"
},
"maxItems" : 300,
"minItems" : 0
}
}
},
"SOF26_Request_Booking_ScheduledEvents_Sessions" : {
"type" : "object",
"properties" : {
"available_units" : {
"type" : "integer",
"format" : "int32",
"description" : "Available units",
"minimum" : 0
},
"id" : {
"type" : "string",
"description" : "Id of the session to update. Do not set the value when creating a new session."
},
"time_slot" : {
"$ref" : "#/components/schemas/SOF26_Request_Booking_ScheduledEvents_Sessions_TimeSlot",
"description" : "Timeslot of the session"
}
}
},
"SOF26_Request_Booking_ScheduledEvents_Sessions_TimeSlot" : {
"type" : "object",
"properties" : {
"start" : {
"type" : "string",
"format" : "date-time",
"description" : "Starting date of the timeslot"
}
}
},
"SOF26_Request_Category" : {
"type" : "object",
"description" : "Service category",
"properties" : {
"code" : {
"type" : "string",
"description" : "Service category code. The category must exist in the configuration."
}
}
},
"SOF26_Request_CustomAttributeValues" : {
"type" : "object",
"description" : "Service custom attributes values",
"discriminator" : {
"mapping" : {
"BOOLEAN" : "#/components/schemas/SOF26_Request_CustomAttributeValues_Boolean",
"DATE_TIME" : "#/components/schemas/SOF26_Request_CustomAttributeValues_DateTime",
"DECIMAL" : "#/components/schemas/SOF26_Request_CustomAttributeValues_Decimal",
"INTEGER" : "#/components/schemas/SOF26_Request_CustomAttributeValues_Integer",
"LINK" : "#/components/schemas/SOF26_Request_CustomAttributeValues_Link",
"LONG_TEXT" : "#/components/schemas/SOF26_Request_CustomAttributeValues_LongText",
"TEXT" : "#/components/schemas/SOF26_Request_CustomAttributeValues_Text",
"VALUE_LIST" : "#/components/schemas/SOF26_Request_CustomAttributeValues_ValueList",
"VIDEO" : "#/components/schemas/SOF26_Request_CustomAttributeValues_Video"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "Custom attribute code. The attribute must exist in the configuration."
},
"type" : {
"type" : "string",
"description" : "Custom attribute type"
},
"value" : {
"type" : "object",
"description" : "Custom attribute value. Value is removed if not set or set to null."
}
}
},
"SOF26_Request_CustomAttributeValues_Boolean" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "boolean",
"description" : "Custom attribute value. Value is removed if not set or set to null."
}
}
},
"SOF26_Request_CustomAttributeValues_DateTime" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"format" : "date-time",
"description" : "Custom attribute value. Value is removed if not set or set to null."
}
}
},
"SOF26_Request_CustomAttributeValues_Decimal" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "number",
"description" : "Custom attribute value. Value is removed if not set or set to null."
}
}
},
"SOF26_Request_CustomAttributeValues_Integer" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "integer",
"format" : "int32",
"description" : "Custom attribute value. Value is removed if not set or set to null."
}
}
},
"SOF26_Request_CustomAttributeValues_Link" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute value. Value is removed if not set or set to null."
}
}
},
"SOF26_Request_CustomAttributeValues_LongText" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute value. Value is removed if not set or set to null."
}
}
},
"SOF26_Request_CustomAttributeValues_Text" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute value. Value is removed if not set or set to null."
}
}
},
"SOF26_Request_CustomAttributeValues_ValueList" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "array",
"description" : "Value list items. The list is removed if not set, set to null or set to [].",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_CustomAttributeValues_ValueList_Value"
}
}
}
},
"SOF26_Request_CustomAttributeValues_ValueList_Value" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Code of the item"
}
}
},
"SOF26_Request_CustomAttributeValues_Video" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute value. Value is removed if not set or set to null."
}
}
},
"SOF26_Request_Location" : {
"type" : "object",
"description" : "Service location method. The location type must be equal to the location type in the Model configuration.",
"discriminator" : {
"mapping" : {
"AT_CUSTOMER_LOCATION" : "#/components/schemas/SOF26_Request_Location_AtCustomerLocation",
"AT_SHOP_LOCATION" : "#/components/schemas/SOF26_Request_Location_AtShopLocation",
"NO_LOCATION" : "#/components/schemas/SOF26_Request_Location_NoLocation"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : "Location type. The location type must be equal to the location type in the Model configuration."
}
}
},
"SOF26_Request_Location_AtCustomerLocation" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Location"
} ],
"properties" : {
"shop_locations" : {
"type" : "array",
"description" : "Locations where the service can be provided. The location type must be compatible with the model.",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_Location_AtCustomerLocation_ShopLocations"
},
"maxItems" : 65,
"minItems" : 1
}
}
},
"SOF26_Request_Location_AtCustomerLocation_ShopLocations" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Location ID. The location must belong to the shop."
}
}
},
"SOF26_Request_Location_AtShopLocation" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Location"
} ],
"properties" : {
"shop_locations" : {
"type" : "array",
"description" : "Locations where the service can be provided. The location type must be compatible with the model.",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_Location_AtShopLocation_ShopLocations"
},
"maxItems" : 65,
"minItems" : 1
}
}
},
"SOF26_Request_Location_AtShopLocation_ShopLocations" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Location ID. The location must belong to the shop."
}
}
},
"SOF26_Request_Location_NoLocation" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Location"
} ]
},
"SOF26_Request_Model" : {
"type" : "object",
"description" : "Service model",
"properties" : {
"code" : {
"type" : "string",
"description" : "Service model code. Must be equal to the service's model code."
}
}
},
"SOF26_Request_Pricing" : {
"type" : "object",
"description" : "Service pricing method",
"discriminator" : {
"mapping" : {
"ESTIMATED_PRICE" : "#/components/schemas/SOF26_Request_Pricing_EstimatedPrice",
"ESTIMATED_PRICE_MULTI" : "#/components/schemas/SOF26_Request_Pricing_EstimatedPriceMulti",
"FIXED_PRICE" : "#/components/schemas/SOF26_Request_Pricing_FixedPrice",
"FIXED_PRICE_MULTI" : "#/components/schemas/SOF26_Request_Pricing_FixedPriceMulti"
},
"propertyName" : "type"
},
"properties" : {
"options" : {
"type" : "array",
"description" : "Service pricing options.",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_Pricing_Options"
}
},
"type" : {
"type" : "string",
"description" : "Price type. It must be equal to the price type in the Model configuration."
}
}
},
"SOF26_Request_Pricing_EstimatedPrice" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Pricing"
} ],
"properties" : {
"price_per_unit" : {
"type" : "number",
"description" : "Price at which the service will be provided. It's a price per unit.",
"maximum" : 1000000000,
"minimum" : 0
}
}
},
"SOF26_Request_Pricing_EstimatedPriceMulti" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Pricing"
} ],
"properties" : {
"price_per_unit_options" : {
"type" : "array",
"description" : "Service price per unit options.",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_Pricing_EstimatedPriceMulti_PricePerUnitOptions"
},
"maxItems" : 1,
"minItems" : 0
}
}
},
"SOF26_Request_Pricing_EstimatedPriceMulti_PricePerUnitOptions" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Price per unit options code."
},
"type" : {
"type" : "string",
"description" : "Price per unit options type. Must be VALUE_LIST."
},
"values" : {
"type" : "array",
"description" : "Price per unit options values.",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_Pricing_EstimatedPriceMulti_PricePerUnitOptions_Values"
}
}
}
},
"SOF26_Request_Pricing_EstimatedPriceMulti_PricePerUnitOptions_Values" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Price per unit option amount"
},
"code" : {
"type" : "string",
"description" : "Price per unit option code"
}
}
},
"SOF26_Request_Pricing_FixedPrice" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Pricing"
} ],
"properties" : {
"price_per_unit" : {
"type" : "number",
"description" : "Price at which the service will be provided. It's a price per unit.",
"maximum" : 1000000000,
"minimum" : 0
}
}
},
"SOF26_Request_Pricing_FixedPriceMulti" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Pricing"
} ],
"properties" : {
"price_per_unit_options" : {
"type" : "array",
"description" : "Service price per unit options.",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_Pricing_FixedPriceMulti_PricePerUnitOptions"
},
"maxItems" : 1,
"minItems" : 0
}
}
},
"SOF26_Request_Pricing_FixedPriceMulti_PricePerUnitOptions" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Price per unit options code."
},
"type" : {
"type" : "string",
"description" : "Price per unit options type. Must be VALUE_LIST."
},
"values" : {
"type" : "array",
"description" : "Price per unit options values.",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_Pricing_FixedPriceMulti_PricePerUnitOptions_Values"
}
}
}
},
"SOF26_Request_Pricing_FixedPriceMulti_PricePerUnitOptions_Values" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Price per unit option amount"
},
"code" : {
"type" : "string",
"description" : "Price per unit option code"
}
}
},
"SOF26_Request_Pricing_Options" : {
"type" : "object",
"description" : "Service pricing options.",
"discriminator" : {
"mapping" : {
"BOOLEAN" : "#/components/schemas/SOF26_Request_Pricing_Options_Boolean",
"VALUE_LIST" : "#/components/schemas/SOF26_Request_Pricing_Options_ValueList"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "Pricing option identifier"
},
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOF26_Request_Pricing_Options_Boolean" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Pricing_Options"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "Pricing option values. The values are removed if the list is not set or set to null or [].",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_Pricing_Options_Boolean_Values"
}
}
}
},
"SOF26_Request_Pricing_Options_Boolean_Values" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Pricing option amount",
"maximum" : 1000000000,
"minimum" : 0
},
"value" : {
"type" : "boolean",
"description" : "Pricing option value"
}
}
},
"SOF26_Request_Pricing_Options_ValueList" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Pricing_Options"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "Pricing option values. Do not set or set to null or [] to remove values on non required option.",
"items" : {
"$ref" : "#/components/schemas/SOF26_Request_Pricing_Options_ValueList_Values"
}
}
}
},
"SOF26_Request_Pricing_Options_ValueList_Values" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Pricing option amount",
"maximum" : 1000000000,
"minimum" : 0
},
"code" : {
"type" : "string",
"description" : "Pricing option value identifier"
}
}
},
"SOF26_Request_Quantity" : {
"type" : "object",
"description" : "Service quantity method.",
"discriminator" : {
"mapping" : {
"LIMITED" : "#/components/schemas/SOF26_Request_Quantity_Limited",
"NO_QUANTITY" : "#/components/schemas/SOF26_Request_Quantity_NoQuantity"
},
"propertyName" : "type"
},
"properties" : {
"max_per_order" : {
"type" : "integer",
"format" : "int32",
"description" : "Maximum quantity per order",
"maximum" : 1000,
"minimum" : 1
},
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOF26_Request_Quantity_Limited" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Quantity"
} ],
"description" : "The service has a limited quantity",
"properties" : {
"available" : {
"type" : "integer",
"format" : "int32",
"description" : "Service volume the shop is able to provide",
"maximum" : 1000000000,
"minimum" : 0
}
}
},
"SOF26_Request_Quantity_NoQuantity" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Request_Quantity"
} ],
"description" : "The service has no quantity"
},
"SOF26_Response_200" : {
"type" : "object",
"properties" : {
"booking" : {
"$ref" : "#/components/schemas/SOF26_Response_200_Booking",
"description" : "Service booking method"
},
"category" : {
"$ref" : "#/components/schemas/SOF26_Response_200_Category",
"description" : "Service category"
},
"code" : {
"type" : "string",
"description" : "Service code"
},
"consumption" : {
"$ref" : "#/components/schemas/SOF26_Response_200_Consumption",
"description" : "Service consumption method: how will the service be consumed ?"
},
"custom_attribute_values" : {
"type" : "array",
"description" : "Service custom attributes values",
"items" : {
"$ref" : "#/components/schemas/SOF26_Response_200_CustomAttributeValues"
}
},
"date_availability_end" : {
"type" : "string",
"format" : "date-time",
"description" : "Date when the service ends being available"
},
"date_availability_start" : {
"type" : "string",
"format" : "date-time",
"description" : "Date when the service starts being available"
},
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Service creation date"
},
"date_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Service update date"
},
"description" : {
"type" : "string",
"description" : "Service description"
},
"inactive_reasons" : {
"type" : "array",
"description" : "List of reasons why the service is inactive. If the service is active, this list is empty",
"items" : {
"type" : "string"
}
},
"location" : {
"$ref" : "#/components/schemas/SOF26_Response_200_Location",
"description" : "Service location method: where the service will be provided ?"
},
"medias" : {
"type" : "array",
"description" : "All the medias associated to a service",
"items" : {
"$ref" : "#/components/schemas/SOF26_Response_200_Medias"
}
},
"model" : {
"$ref" : "#/components/schemas/SOF26_Response_200_Model",
"description" : "Service model"
},
"pricing" : {
"$ref" : "#/components/schemas/SOF26_Response_200_Pricing",
"description" : "Service pricing method"
},
"quantity" : {
"$ref" : "#/components/schemas/SOF26_Response_200_Quantity",
"description" : "Service quantity method"
},
"service_tax_code" : {
"type" : "string",
"description" : "Service tax code"
},
"title" : {
"type" : "string",
"description" : "Service title"
}
}
},
"SOF26_Response_200_Booking" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"DATETIME_REQUEST" : "#/components/schemas/SOF26_Response_200_Booking_DatetimeRequest",
"NO_BOOKING" : "#/components/schemas/SOF26_Response_200_Booking_NoBooking",
"SCHEDULED_EVENTS" : "#/components/schemas/SOF26_Response_200_Booking_ScheduledEvents"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string"
}
}
},
"SOF26_Response_200_Booking_DatetimeRequest" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOF26_Response_200_Booking"
} ],
"description" : "The service has a duration",
"properties" : {
"duration" : {
"type" : "string",
"description" : "Service duration, using the ISO-8601 Duration Standard.PT1H15M stands for Period of Time of 1 Hour and 15 MinutesPT3OM stands for Period of Time of 30 MinutesPT1H15M stands for Period of Time of 1 Hour and 15 MinutesPT3OM stands for Period of Time of 30 MinutesFIXED_PRICE, the price defined when placing an order is final. The price cannot be modified.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.FIXED_PRICE_MULTI, the price defined when placing an order is final. The price cannot be modified. The price has multiple possibilities.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.null.",
"items" : {
"$ref" : "#/components/schemas/SOR04_Request_CustomAttributeValues"
}
},
"price" : {
"$ref" : "#/components/schemas/SOR04_Request_Price",
"description" : "New price for this order.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.null (along with value).",
"maximum" : 1000000000,
"minimum" : 0
},
"taxes" : {
"type" : "array",
"description" : "Tax amounts to update.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.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.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.customer is not present when: true if order has an incident open"
},
"id" : {
"type" : "string",
"description" : "Order ID"
},
"location" : {
"$ref" : "#/components/schemas/SOR04_Response_200_Location",
"description" : "Order location"
},
"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"
},
"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"
}
}
},
"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"
},
"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_Workflow" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Order workflow type"
}
}
},
"SOR11_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/SOR11_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."
}
}
},
"SOR11_Response_200_Data" : {
"type" : "object",
"properties" : {
"booking" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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/SOR11_Response_200_Data_Commission",
"description" : "Order commission"
},
"consumption" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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/SOR11_Response_200_Data_CustomAttributeValues"
}
},
"customer" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Customer",
"description" : "Customer who purchased the service.customer is not present when: true if order has an incident open"
},
"id" : {
"type" : "string",
"description" : "Order ID"
},
"location" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Location",
"description" : "Order location"
},
"price" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Price",
"description" : "Order price"
},
"refunds" : {
"type" : "array",
"description" : "The list of refunds, sorted by creation date in ascending order",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Refunds"
}
},
"service" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service",
"description" : "The service that was purchased"
},
"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/SOR11_Response_200_Data_Workflow",
"description" : "Order workflow"
}
}
},
"SOR11_Response_200_Data_Booking" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"DATETIME_REQUEST" : "#/components/schemas/SOR11_Response_200_Data_Booking_DatetimeRequest",
"NO_BOOKING" : "#/components/schemas/SOR11_Response_200_Data_Booking_NoBooking",
"SCHEDULED_EVENT" : "#/components/schemas/SOR11_Response_200_Data_Booking_ScheduledEvent"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOR11_Response_200_Data_Booking_DatetimeRequest" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Booking"
} ],
"properties" : {
"confirmed_time_slots" : {
"type" : "array",
"description" : "Confirmed time slots by the shop",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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/SOR11_Response_200_Data_Booking_DatetimeRequest_TimeSlots"
}
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_Booking_NoBooking" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Booking"
} ]
},
"SOR11_Response_200_Data_Booking_ScheduledEvent" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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/SOR11_Response_200_Data_Booking_ScheduledEvent_Session",
"description" : "Session ordered by the customer"
}
}
},
"SOR11_Response_200_Data_Booking_ScheduledEvent_Session" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Session id"
},
"timeslot" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Booking_ScheduledEvent_Session_Timeslot",
"description" : "Session timeslot"
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_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/SOR11_Response_200_Data_Commission_CommissionTaxes"
}
}
}
},
"SOR11_Response_200_Data_Commission_CommissionTaxes" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Tax amount"
},
"code" : {
"type" : "string",
"description" : "Tax code"
}
}
},
"SOR11_Response_200_Data_Consumption" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"CONFIRMATION_BY_SHOP" : "#/components/schemas/SOR11_Response_200_Data_Consumption_ConfirmationByShop",
"VOUCHER" : "#/components/schemas/SOR11_Response_200_Data_Consumption_Voucher"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOR11_Response_200_Data_Consumption_ConfirmationByShop" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_Consumption_Voucher" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Consumption"
} ],
"properties" : {
"date_consumed" : {
"type" : "string",
"format" : "date-time",
"description" : "Voucher consumption date"
},
"date_expiration" : {
"type" : "string",
"format" : "date-time",
"description" : "Voucher expiration date"
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"BOOLEAN" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues_Boolean",
"DATE_TIME" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues_DateTime",
"DECIMAL" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues_Decimal",
"INTEGER" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues_Integer",
"LINK" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues_Link",
"LONG_TEXT" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues_LongText",
"TEXT" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues_Text",
"VALUE_LIST" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues_ValueList",
"VIDEO" : "#/components/schemas/SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues_Boolean" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "boolean",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues_DateTime" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"format" : "date-time",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues_Decimal" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "number",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues_Integer" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "integer",
"format" : "int32",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues_Link" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues_LongText" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues_Text" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues_ValueList" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "array",
"description" : "Custom attribute field value",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues_ValueList_Value"
}
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues_ValueList_Value" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Code of the item"
},
"label" : {
"type" : "string",
"description" : "Label of the item"
}
}
},
"SOR11_Response_200_Data_CustomAttributeValues_Video" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_Customer" : {
"type" : "object",
"properties" : {
"billing_address" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Customer_BillingAddress",
"description" : "Billing address of the customer"
},
"civility" : {
"type" : "string",
"description" : "Civility 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"
}
}
},
"SOR11_Response_200_Data_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
}
}
},
"SOR11_Response_200_Data_Location" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"AT_CUSTOMER_LOCATION" : "#/components/schemas/SOR11_Response_200_Data_Location_AtCustomerLocation",
"AT_SHOP_LOCATION" : "#/components/schemas/SOR11_Response_200_Data_Location_AtShopLocation",
"NO_LOCATION" : "#/components/schemas/SOR11_Response_200_Data_Location_NoLocation"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOR11_Response_200_Data_Location_AtCustomerLocation" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Location"
} ],
"description" : "The Service is provided at customer location",
"properties" : {
"customer_address" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Location_AtCustomerLocation_CustomerAddress",
"description" : "Customer's address"
}
}
},
"SOR11_Response_200_Data_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
}
}
},
"SOR11_Response_200_Data_Location_AtShopLocation" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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/SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations"
}
}
}
},
"SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations" : {
"type" : "object",
"properties" : {
"geography" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography",
"description" : "Geographic information of the location"
},
"id" : {
"type" : "string",
"description" : "Location ID"
},
"label" : {
"type" : "string",
"description" : "Location label"
}
}
},
"SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"CIRCLE" : "#/components/schemas/SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography_Circle",
"POINT" : "#/components/schemas/SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography_Point",
"ZONE_REFERENCES" : "#/components/schemas/SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography_ZoneReferences"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string"
}
}
},
"SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography_Circle" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography"
} ],
"properties" : {
"center" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography_Point" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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/SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography_Point_Geocode",
"description" : "Geocode of the location"
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography_ZoneReferences" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography"
} ],
"properties" : {
"zone_references" : {
"type" : "array",
"description" : "ZoneReferences covered by this location",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Location_AtShopLocation_ShopLocations_Geography_ZoneReferences_ZoneReferences"
}
}
}
},
"SOR11_Response_200_Data_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."
}
}
},
"SOR11_Response_200_Data_Location_NoLocation" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Location"
} ],
"description" : "The Service is provided remotely (hence has no location)"
},
"SOR11_Response_200_Data_Price" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"ESTIMATED_PRICE" : "#/components/schemas/SOR11_Response_200_Data_Price_EstimatedPrice",
"ESTIMATED_PRICE_MULTI" : "#/components/schemas/SOR11_Response_200_Data_Price_EstimatedPriceMulti",
"FIXED_PRICE" : "#/components/schemas/SOR11_Response_200_Data_Price_FixedPrice",
"FIXED_PRICE_MULTI" : "#/components/schemas/SOR11_Response_200_Data_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/SOR11_Response_200_Data_Price_Options"
}
},
"type" : {
"type" : "string",
"description" : ""
}
}
},
"SOR11_Response_200_Data_Price_EstimatedPrice" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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/SOR11_Response_200_Data_Price_EstimatedPrice_Taxes"
}
}
}
},
"SOR11_Response_200_Data_Price_EstimatedPriceMulti" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Price"
} ],
"properties" : {
"ordered_service_units" : {
"type" : "array",
"description" : "Ordered service units",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Price_EstimatedPriceMulti_OrderedServiceUnits"
}
}
}
},
"SOR11_Response_200_Data_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/SOR11_Response_200_Data_Price_EstimatedPriceMulti_OrderedServiceUnits_Values"
}
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_Price_FixedPrice" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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/SOR11_Response_200_Data_Price_FixedPrice_Taxes"
}
}
}
},
"SOR11_Response_200_Data_Price_FixedPriceMulti" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Price"
} ],
"properties" : {
"ordered_service_units" : {
"type" : "array",
"description" : "Ordered service units",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Price_FixedPriceMulti_OrderedServiceUnits"
}
}
}
},
"SOR11_Response_200_Data_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/SOR11_Response_200_Data_Price_FixedPriceMulti_OrderedServiceUnits_Values"
}
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_Price_Options" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"BOOLEAN" : "#/components/schemas/SOR11_Response_200_Data_Price_Options_Boolean",
"VALUE_LIST" : "#/components/schemas/SOR11_Response_200_Data_Price_Options_ValueList"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "Option code"
},
"label" : {
"type" : "string",
"description" : "Option label"
},
"type" : {
"type" : "string"
}
}
},
"SOR11_Response_200_Data_Price_Options_Boolean" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Price_Options"
} ],
"properties" : {
"amount" : {
"type" : "number",
"description" : "Option amount"
},
"taxes" : {
"type" : "array",
"description" : "Option tax amounts",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Price_Options_Boolean_Taxes"
}
},
"type" : {
"type" : "string",
"description" : ""
},
"value" : {
"type" : "boolean",
"description" : "Option value"
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_Price_Options_ValueList" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Price_Options"
} ],
"properties" : {
"type" : {
"type" : "string",
"description" : ""
},
"values" : {
"type" : "array",
"description" : "",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Price_Options_ValueList_Values"
}
}
}
},
"SOR11_Response_200_Data_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/SOR11_Response_200_Data_Price_Options_ValueList_Values_Taxes"
}
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_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/SOR11_Response_200_Data_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/SOR11_Response_200_Data_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/SOR11_Response_200_Data_Refunds_Taxes"
}
},
"transaction_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Transaction number/code"
},
"transaction_number" : {
"type" : "string",
"description" : "Transaction date"
}
}
},
"SOR11_Response_200_Data_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/SOR11_Response_200_Data_Refunds_Commission_CommissionTaxes"
}
}
}
},
"SOR11_Response_200_Data_Refunds_Commission_CommissionTaxes" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Tax amount"
},
"code" : {
"type" : "string",
"description" : "Tax code"
}
}
},
"SOR11_Response_200_Data_Refunds_Options" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"BOOLEAN" : "#/components/schemas/SOR11_Response_200_Data_Refunds_Options_Boolean",
"VALUE_LIST" : "#/components/schemas/SOR11_Response_200_Data_Refunds_Options_ValueList"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "Option code"
},
"label" : {
"type" : "string",
"description" : "Option label"
},
"type" : {
"type" : "string"
}
}
},
"SOR11_Response_200_Data_Refunds_Options_Boolean" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Refunds_Options"
} ],
"properties" : {
"amount" : {
"type" : "number",
"description" : "Option amount"
},
"taxes" : {
"type" : "array",
"description" : "Option tax amounts",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Refunds_Options_Boolean_Taxes"
}
},
"type" : {
"type" : "string",
"description" : ""
},
"value" : {
"type" : "boolean",
"description" : "Option value"
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_Refunds_Options_ValueList" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Refunds_Options"
} ],
"properties" : {
"type" : {
"type" : "string",
"description" : ""
},
"values" : {
"type" : "array",
"description" : "",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Refunds_Options_ValueList_Values"
}
}
}
},
"SOR11_Response_200_Data_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/SOR11_Response_200_Data_Refunds_Options_ValueList_Values_Taxes"
}
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_Service" : {
"type" : "object",
"properties" : {
"category" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_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/SOR11_Response_200_Data_Service_CustomAttributeValues"
}
},
"description" : {
"type" : "string",
"description" : "Service description"
},
"medias" : {
"type" : "array",
"description" : "Service medias",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_Medias"
}
},
"model" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_Model",
"description" : "Service model"
},
"title" : {
"type" : "string",
"description" : "Service title"
}
}
},
"SOR11_Response_200_Data_Service_Category" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Category code"
},
"label" : {
"type" : "string",
"description" : "Category label"
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"BOOLEAN" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues_Boolean",
"DATE_TIME" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues_DateTime",
"DECIMAL" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues_Decimal",
"INTEGER" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues_Integer",
"LINK" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues_Link",
"LONG_TEXT" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues_LongText",
"TEXT" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues_Text",
"VALUE_LIST" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues_ValueList",
"VIDEO" : "#/components/schemas/SOR11_Response_200_Data_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"
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues_Boolean" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "boolean",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues_DateTime" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"format" : "date-time",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues_Decimal" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "number",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues_Integer" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "integer",
"format" : "int32",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues_Link" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues_LongText" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues_Text" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues_ValueList" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "array",
"description" : "Custom attribute field value",
"items" : {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues_ValueList_Value"
}
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues_ValueList_Value" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Code of the item"
},
"label" : {
"type" : "string",
"description" : "Label of the item"
}
}
},
"SOR11_Response_200_Data_Service_CustomAttributeValues_Video" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR11_Response_200_Data_Service_CustomAttributeValues"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Custom attribute field value"
}
}
},
"SOR11_Response_200_Data_Service_Medias" : {
"type" : "object",
"properties" : {
"mime_type" : {
"type" : "string",
"description" : "Media Mime type"
},
"url" : {
"type" : "string",
"description" : "Media URL"
}
}
},
"SOR11_Response_200_Data_Service_Model" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Service model code"
},
"label" : {
"type" : "string",
"description" : "Service model label"
}
}
},
"SOR11_Response_200_Data_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"
}
}
},
"SOR28_Request" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "The amount to be refunded"
},
"currency_code" : {
"type" : "string",
"description" : "The currency used by the shop (iso format)"
},
"options" : {
"type" : "array",
"description" : "The options to be refunded. This field is required if the order has options.",
"items" : {
"$ref" : "#/components/schemas/SOR28_Request_Options"
}
},
"reason_code" : {
"type" : "string",
"description" : "The reason code of the refund"
},
"taxes" : {
"type" : "array",
"description" : "The taxes to be refunded. This field is required if the order has taxes.",
"items" : {
"$ref" : "#/components/schemas/SOR28_Request_Taxes"
}
}
}
},
"SOR28_Request_Options" : {
"type" : "object",
"description" : "The options to be refunded. This field is required if the order has options.",
"discriminator" : {
"mapping" : {
"BOOLEAN" : "#/components/schemas/SOR28_Request_Options_Boolean",
"VALUE_LIST" : "#/components/schemas/SOR28_Request_Options_ValueList"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "Option code"
},
"type" : {
"type" : "string"
}
}
},
"SOR28_Request_Options_Boolean" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR28_Request_Options"
} ],
"properties" : {
"amount" : {
"type" : "number",
"description" : "Amount of the boolean pricing option chosen by the customer. Required if value is present.",
"maximum" : 1000000000,
"minimum" : 0
},
"taxes" : {
"type" : "array",
"description" : "Pricing option tax amounts",
"items" : {
"$ref" : "#/components/schemas/SOR28_Request_Options_Boolean_Taxes"
}
},
"type" : {
"type" : "string",
"description" : ""
},
"value" : {
"type" : "boolean",
"description" : "Value of the boolean pricing option chosen by the customer. Required if amount is present."
}
}
},
"SOR28_Request_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"
}
}
},
"SOR28_Request_Options_ValueList" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/SOR28_Request_Options"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "Values chosen by the customer.",
"items" : {
"$ref" : "#/components/schemas/SOR28_Request_Options_ValueList_Values"
}
}
}
},
"SOR28_Request_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" : "Pricing option tax amounts",
"items" : {
"$ref" : "#/components/schemas/SOR28_Request_Options_ValueList_Values_Taxes"
}
}
}
},
"SOR28_Request_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"
}
}
},
"SOR28_Request_Taxes" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Amount of the tax",
"maximum" : 1000000000,
"minimum" : 0
},
"code" : {
"type" : "string",
"description" : "Code of the tax"
}
}
},
"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"
}
}
},
"TL02_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/TL02_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."
}
}
},
"TL02_Response_200_Data" : {
"type" : "object",
"properties" : {
"accounting_document_creation_date" : {
"type" : "string",
"format" : "date-time",
"description" : "The related accounting document creation date.\n\nThis field is only available when the referenced accounting document is an automatic invoice or a manual document.\n"
},
"accounting_document_id" : {
"type" : "string",
"description" : "The related accounting document id.\n\nThis field is only available when the referenced accounting document is a seller or purchase document request."
},
"accounting_document_number" : {
"type" : "string",
"description" : "The related accounting document number.\n\nThis field is only available when the referenced accounting document is:\n- an automatic invoice or a manual document,\n- an **issued** seller or purchase document request."
},
"amount" : {
"type" : "number",
"description" : "The amount."
},
"amount_credited" : {
"type" : "number",
"description" : "The amount credited."
},
"amount_debited" : {
"type" : "number",
"description" : "The amount debited."
},
"balance" : {
"type" : "number",
"description" : "The balance of the transaction."
},
"currency_iso_code" : {
"type" : "string",
"description" : "The currency of the shop (iso format)"
},
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Creation date of the transaction line"
},
"entities" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities",
"description" : "Node containing additional information depending on type of the transaction and the domain."
},
"id" : {
"type" : "string",
"description" : "Identifier of the transaction"
},
"last_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Date of last update of the transaction line"
},
"pay_out_psp_code" : {
"type" : "string",
"description" : "Pay-out PSP code associated with the transaction."
},
"payment_state" : {
"type" : "string",
"description" : "The payment state of the transaction."
},
"psp_balance" : {
"type" : "number",
"description" : "The Pay-out balance of the transaction."
},
"seller_billing_cycle_id" : {
"type" : "string",
"description" : "The Seller Billing Cycle ID associated with the transaction."
},
"type" : {
"type" : "string",
"description" : "Type of transaction (refund, transaction fee, etc ...)"
}
}
},
"TL02_Response_200_Data_Entities" : {
"type" : "object",
"properties" : {
"channel" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_Channel",
"description" : "A node containing channel information"
},
"debit" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_Debit",
"description" : "A node containing debit information if any"
},
"domain" : {
"type" : "string",
"description" : "The domain of the entities related to the transaction line (PRODUCT or SERVICE)"
},
"fee" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_Fee",
"description" : "A node containing seller additional fee information if any"
},
"manual_accounting_document" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_ManualAccountingDocument",
"description" : "A node containing manual accounting document information if any"
},
"one_off_item" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_OneOffItem",
"description" : "A node containing invoiceable one-off item information if any"
},
"order" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_Order",
"description" : "A node containing order information if any"
},
"order_fee" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_OrderFee",
"description" : "A node containing order fee information if any"
},
"order_line" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_OrderLine",
"description" : "A node containing order line information if any"
},
"order_tax" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_OrderTax",
"description" : "A node containing order tax information if any"
},
"refund" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_Refund",
"description" : "A node containing refund information if any"
},
"shipment" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_Shipment",
"description" : "A node containing shipment information if any"
},
"shop_tax" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_ShopTax",
"description" : "A node containing shop tax information if any"
},
"transaction_info" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_TransactionInfo",
"description" : "A node containing transaction information if any"
}
}
},
"TL02_Response_200_Data_Entities_Channel" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The channel code"
}
}
},
"TL02_Response_200_Data_Entities_Debit" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The debit id"
}
}
},
"TL02_Response_200_Data_Entities_Fee" : {
"type" : "object",
"properties" : {
"cancelations" : {
"type" : "array",
"description" : "The list of cancelations information if any",
"items" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_Fee_Cancelations"
}
},
"code" : {
"type" : "string",
"description" : "The code of the seller additional fee"
},
"refunds" : {
"type" : "array",
"description" : "The list of refunds information if any",
"items" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_Fee_Refunds"
}
}
}
},
"TL02_Response_200_Data_Entities_Fee_Cancelations" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The Cancelation id if the transaction log is relative to a cancelation"
}
}
},
"TL02_Response_200_Data_Entities_Fee_Refunds" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The refund id if the transaction log is relative to a refund"
}
}
},
"TL02_Response_200_Data_Entities_ManualAccountingDocument" : {
"type" : "object",
"properties" : {
"number" : {
"type" : "string",
"description" : "The manual accounting document number."
}
}
},
"TL02_Response_200_Data_Entities_OneOffItem" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "string",
"description" : "The description of the invoiceable one-off item"
},
"operation_date" : {
"type" : "string",
"format" : "date",
"description" : "The operation date of the invoiceable one-off item"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "The quantity of the invoiceable one-off item"
},
"references" : {
"type" : "array",
"description" : "The references of the invoiceable one-off item",
"items" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_OneOffItem_References"
}
},
"unit_price" : {
"type" : "number",
"description" : "The unit price of the invoiceable one-off item"
}
}
},
"TL02_Response_200_Data_Entities_OneOffItem_References" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "The type of the reference"
},
"value" : {
"type" : "string",
"description" : "The value of the reference"
}
}
},
"TL02_Response_200_Data_Entities_Order" : {
"type" : "object",
"properties" : {
"commercial_id" : {
"type" : "string",
"description" : "The order commercial id"
},
"creation_date" : {
"type" : "string",
"format" : "date-time",
"description" : "The order creation date"
},
"id" : {
"type" : "string",
"description" : "The order id"
},
"payment_info" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_Order_PaymentInfo",
"description" : "A node containing payment information"
},
"references" : {
"$ref" : "#/components/schemas/TL02_Response_200_Data_Entities_Order_References",
"description" : "A node containing order references"
}
}
},
"TL02_Response_200_Data_Entities_OrderFee" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code of the transaction log fee"
}
}
},
"TL02_Response_200_Data_Entities_OrderLine" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The order line id"
}
}
},
"TL02_Response_200_Data_Entities_OrderTax" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code of the transaction log tax"
},
"rate" : {
"type" : "number",
"description" : "Tax rate"
}
}
},
"TL02_Response_200_Data_Entities_Order_PaymentInfo" : {
"type" : "object",
"properties" : {
"imprint_number" : {
"type" : "string",
"description" : "The payment imprint number received by OR01 or SOR01"
},
"payment_type" : {
"type" : "string",
"description" : "The payment's type used by the customer to pay this order"
}
}
},
"TL02_Response_200_Data_Entities_Order_References" : {
"type" : "object",
"properties" : {
"order_reference_for_customer" : {
"type" : "string",
"description" : "Order reference for customer."
},
"order_reference_for_seller" : {
"type" : "string",
"description" : "Order reference for seller."
}
}
},
"TL02_Response_200_Data_Entities_Refund" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The refund id if the transaction log is relative to a refund"
}
}
},
"TL02_Response_200_Data_Entities_Shipment" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The shipment id if the transaction log is relative to a shipment"
}
}
},
"TL02_Response_200_Data_Entities_ShopTax" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code of the shop tax applied. COMMISSION_VAT, MANUAL_CREDIT_VAT, MANUAL_INVOICE_VAT, REFUND_COMMISSION_VAT, SUBSCRIPTION_VAT"
},
"rate" : {
"type" : "number",
"description" : "Shop tax rate applied COMMISSION_VAT, MANUAL_CREDIT_VAT, MANUAL_INVOICE_VAT, REFUND_COMMISSION_VAT, SUBSCRIPTION_VATCOMMISSION_FEE with the rate of the first taxapplied to the shop. In this case, the value should be ignored."
}
}
},
"TL02_Response_200_Data_Entities_TransactionInfo" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date-time",
"description" : "The transaction date."
},
"number" : {
"type" : "string",
"description" : "Transaction number"
}
}
},
"TL03_Request" : {
"type" : "object",
"properties" : {
"accounting_document_id" : {
"type" : "string",
"description" : "Accounting document request id. This parameter filters on documents requests with these entity types: SHOP_BILLING_CYCLE_PURCHASE_ORDER, FEES or ONE_OFF_FEES."
},
"accounting_document_number" : {
"type" : "string",
"description" : "Accounting document number"
},
"date_created_from" : {
"type" : "string",
"format" : "date-time",
"description" : "Creation date"
},
"date_created_to" : {
"type" : "string",
"format" : "date-time",
"description" : "Creation date"
},
"format" : {
"type" : "string",
"description" : "The format of the exported file in TL05. Default value JSON."
},
"items_per_chunk" : {
"type" : "integer",
"format" : "int64",
"description" : "The maximum number of items per chunk."
},
"last_updated_from" : {
"type" : "string",
"format" : "date-time",
"description" : "Last updated date"
},
"megabytes_per_chunk" : {
"type" : "integer",
"format" : "int64",
"description" : "The maximum size in megabytes of a chunk."
},
"order_id" : {
"type" : "array",
"description" : "Order id. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"order_line_id" : {
"type" : "array",
"description" : "Order line id. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"order_reference_for_customer" : {
"type" : "array",
"description" : "A comma-separated list of order references for customer.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"order_reference_for_seller" : {
"type" : "array",
"description" : "A comma-separated list of order references for seller.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"other_reference" : {
"type" : "array",
"description" : "An external reference for one-off transactions that are not tied to a Mirakl order. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"pay_out_psp_codes" : {
"type" : "array",
"description" : "A comma-separated list of pay-out PSP codes. This parameter requires the Hybrid pay-out PSP feature to be enabled.",
"items" : {
"type" : "string"
}
},
"payment_state" : {
"type" : "array",
"description" : "Payment state. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"payment_voucher_number" : {
"type" : "string",
"description" : "Payment voucher"
},
"seller_billing_cycle_id" : {
"type" : "array",
"description" : "Seller billing cycle ID (UUID format). This parameter can be supplied multiple times.",
"items" : {
"type" : "string",
"pattern" : "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"
},
"maxItems" : 100,
"minItems" : 0
},
"shop_domain" : {
"type" : "array",
"description" : "A shop domain. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"shop_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Shop identifier"
},
"shop_model" : {
"type" : "array",
"description" : "Shop model. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
}
},
"transaction_date_from" : {
"type" : "string",
"format" : "date-time",
"description" : "Transaction date"
},
"transaction_date_to" : {
"type" : "string",
"format" : "date-time",
"description" : "Transaction date"
},
"transaction_type" : {
"type" : "array",
"description" : "Transaction type. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
}
}
},
"TL03_Response_200" : {
"type" : "object",
"properties" : {
"tracking_id" : {
"type" : "string",
"description" : "The asynchronous transaction log export id"
}
}
},
"TL04_Response_200" : {
"type" : "object",
"properties" : {
"error" : {
"$ref" : "#/components/schemas/TL04_Response_200_Error",
"description" : "Specific error if the status is 'FAILED"
},
"last_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "The last updated date of the export"
},
"status" : {
"type" : "string",
"description" : "Current status of the export, can be 'PENDING', 'FAILED', 'CANCELED', or 'COMPLETED'"
},
"urls" : {
"type" : "array",
"description" : "List of generated urls to call to download each generated chunks",
"items" : {
"type" : "string"
}
}
}
},
"TL04_Response_200_Error" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The error code"
},
"detail" : {
"type" : "string",
"description" : "The error message"
}
}
}
},
"securitySchemes" : {
"Shop-API-Key" : {
"in" : "header",
"name" : "Authorization",
"type" : "apiKey"
},
"shop_api_key" : {
"in" : "header",
"name" : "Authorization",
"type" : "apiKey"
}
}
},
"info" : {
"title" : "Mirakl Platform for Services APIs",
"version" : "latest-release"
},
"openapi" : "3.0.1",
"paths" : {
"/api/account" : {
"get" : {
"description" : "",
"operationId" : "A01",
"parameters" : [ {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/A01_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_READ" ]
} ],
"summary" : "Get shop information",
"tags" : [ "Stores" ]
},
"put" : {
"description" : "Depending on the operator's configuration, some fields might not be editable.",
"operationId" : "A02",
"parameters" : [ {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/A02_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/A02_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_UPDATE" ]
} ],
"summary" : "Update shop information",
"tags" : [ "Stores" ]
}
},
"/api/account/statistics" : {
"get" : {
"description" : "",
"operationId" : "A21",
"parameters" : [ {
"description" : "List of periods using a comma (,) as a separator. Accepted values are ALL_SINCE_BEGINNING, LAST_MONTH, LAST_THREE_MONTHS, LAST_SIX_MONTHS, LAST_YEAR. If specified, only statistics for the given periods will be returned. If not, all statistics will be returned.",
"explode" : true,
"in" : "query",
"name" : "periods",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "The code of the channel to filter statistics on. If not specified, the overall statistics will be returned.",
"explode" : true,
"in" : "query",
"name" : "channel_code",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/A21_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_READ" ]
} ],
"summary" : "Get shop statistics",
"tags" : [ "Stores" ]
}
},
"/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" : "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" : "integer",
"format" : "int64"
},
"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" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SETTINGS_READ", "ROLE_PARTNER_OFFER_SETTINGS_READ", "ROLE_PARTNER_SHOP_SETTINGS_READ" ]
} ],
"summary" : "List all custom fields",
"tags" : [ "Platform Settings" ]
}
},
"/api/channels" : {
"get" : {
"description" : "Results are sorted by code",
"operationId" : "CH11",
"parameters" : [ {
"description" : "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" : "integer",
"format" : "int64"
},
"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/CH11_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_CHANNEL_READ" ]
} ],
"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" : "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" : "integer",
"format" : "int64"
},
"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/CUR01_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_CURRENCY_SETTINGS_READ" ]
} ],
"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" : "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" : "integer",
"format" : "int64"
},
"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" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SETTINGS_READ" ]
} ],
"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" : "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" : "Creation date for filtering",
"explode" : true,
"in" : "query",
"name" : "start_date",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"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" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
}, {
"description" : "Maximum number of items returned per page",
"in" : "query",
"name" : "max",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "Index of the first item (among all the results) in the returned page",
"in" : "query",
"name" : "offset",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "How the results should be sorted",
"in" : "query",
"name" : "sort",
"schema" : {
"type" : "string"
}
}, {
"description" : "Sort direction",
"in" : "query",
"name" : "order",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/IV01_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ACCOUNTING_DOCUMENT_READ", "ROLE_PARTNER_OWN_ACCOUNTING_DOCUMENT_READ" ]
} ],
"summary" : "List accounting documents",
"tags" : [ "Invoicing and Accounting" ]
}
},
"/api/invoices/{accounting_document_id}" : {
"get" : {
"description" : "⚠️ Note: When the Enhanced Seller Invoicing toggle is enabled, the DR73 API should be used. Only documents created prior to the toggle activation remain downloadable via this API.",
"operationId" : "IV02",
"parameters" : [ {
"description" : "Accounting document identifier",
"explode" : false,
"in" : "path",
"name" : "accounting_document_id",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
},
"style" : "simple"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/octet-stream" : {
"schema" : {
"type" : "string",
"format" : "binary"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ACCOUNTING_DOCUMENT_READ", "ROLE_PARTNER_OWN_ACCOUNTING_DOCUMENT_READ" ]
} ],
"summary" : "Download an accounting document",
"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" : [ {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/L01_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_I18N_SETTINGS_READ" ]
} ],
"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.shop_ids, updated_since",
"operationId" : "S30",
"parameters" : [ {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/S30_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_DOCUMENT_READ" ]
} ],
"summary" : "List shop's documents",
"tags" : [ "Stores" ]
}
},
"/api/shops/documents/download" : {
"get" : {
"description" : " shop_ids or the document_ids.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|__ shop_id/\n| |__ image.png\n| |__ image(1).png\n| |__ foo.txt\n
Returns a 404 if at least one document id or one document type code is invalid
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"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/octet-stream" : {
"schema" : {
"type" : "string",
"format" : "binary"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_DOCUMENT_READ" ]
} ],
"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"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_DOCUMENT_DELETE" ]
} ],
"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" : "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" : "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" : "integer",
"format" : "int64"
},
"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" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SELLER_BILLING_CYCLE_READ", "ROLE_PARTNER_ACCOUNTING_DOCUMENT_READ" ]
} ],
"summary" : "List seller billing cycles",
"tags" : [ "Invoicing and Accounting" ]
}
},
"/api/mms/locations" : {
"post" : {
"description" : "",
"operationId" : "SL01",
"parameters" : [ {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SL01_Request"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/SL01_Response_201"
}
}
},
"description" : "Created"
}
},
"summary" : "Create a location",
"tags" : [ "Services" ]
},
"get" : {
"description" : "",
"operationId" : "SL12",
"parameters" : [ {
"description" : "Service Location IDs to include in result. (default: include all)",
"explode" : true,
"in" : "query",
"name" : "location_id",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Service Location type to include in result. (default: include all)",
"explode" : true,
"in" : "query",
"name" : "location_type",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"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/SL12_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List locations",
"tags" : [ "Services" ]
}
},
"/api/mms/locations/{location_id}" : {
"delete" : {
"description" : "",
"operationId" : "SL06",
"parameters" : [ {
"description" : "Id of the location to delete.",
"explode" : false,
"in" : "path",
"name" : "location_id",
"required" : true,
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
},
"summary" : "Delete a location",
"tags" : [ "Services" ]
}
},
"/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" : "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" : "integer",
"format" : "int64"
},
"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/services" : {
"get" : {
"description" : "",
"operationId" : "SOF11",
"parameters" : [ {
"description" : "Category codes to include in result. Children categories of the specified codes are also included. (default: include all)",
"explode" : true,
"in" : "query",
"name" : "category_code",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Service codes to include in result. (default: include all)",
"explode" : true,
"in" : "query",
"name" : "service_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" : "Service state to include in result. (default: include all)",
"explode" : true,
"in" : "query",
"name" : "state",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"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/SOF11_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List services",
"tags" : [ "Services" ]
},
"post" : {
"description" : "",
"operationId" : "SOF25",
"parameters" : [ {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SOF25_Request"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/SOF25_Response_201"
}
}
},
"description" : "Created"
}
},
"summary" : "Create a service",
"tags" : [ "Services" ]
}
},
"/api/mms/services/{service_code}" : {
"put" : {
"description" : "",
"operationId" : "SOF26",
"parameters" : [ {
"description" : "Code of the service to update.",
"explode" : false,
"in" : "path",
"name" : "service_code",
"required" : true,
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SOF26_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/SOF26_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Update a service",
"tags" : [ "Services" ]
},
"delete" : {
"description" : "",
"operationId" : "SOF27",
"parameters" : [ {
"description" : "Code of the service to delete.",
"explode" : false,
"in" : "path",
"name" : "service_code",
"required" : true,
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
},
"summary" : "Delete a service",
"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"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"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" : {
"get" : {
"description" : "",
"operationId" : "SOR11",
"parameters" : [ {
"description" : "Order ids to include in result.",
"explode" : true,
"in" : "query",
"name" : "order_id",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Order commercial ids to include in result.",
"explode" : true,
"in" : "query",
"name" : "commercial_order_id",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Order states to include in result.",
"explode" : true,
"in" : "query",
"name" : "state",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Order customer ids to include in result.",
"explode" : true,
"in" : "query",
"name" : "customer_id",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Order services codes to include in result.",
"explode" : true,
"in" : "query",
"name" : "service_code",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Creation date to start from.",
"explode" : true,
"in" : "query",
"name" : "date_created_start",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Creation date to end with.",
"explode" : true,
"in" : "query",
"name" : "date_created_end",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Last modification date to start from.",
"explode" : true,
"in" : "query",
"name" : "date_updated_start",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Last modification date to end with.",
"explode" : true,
"in" : "query",
"name" : "date_updated_end",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Refund completion.",
"explode" : true,
"in" : "query",
"name" : "refunded",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Refund reason codes",
"explode" : true,
"in" : "query",
"name" : "refund_reason_code",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "If true returns only orders with open incidents, if false returns orders without open incidents. Default to all",
"explode" : true,
"in" : "query",
"name" : "has_open_incident",
"schema" : {
"type" : "boolean"
},
"style" : "form"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"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/SOR11_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List orders",
"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"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"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"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"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"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"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}/refund" : {
"put" : {
"description" : "",
"operationId" : "SOR28",
"parameters" : [ {
"description" : "The identifier of the order to be refunded.",
"explode" : false,
"in" : "path",
"name" : "order_id",
"required" : true,
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SOR28_Request"
}
}
}
},
"responses" : {
"201" : {
"description" : "Created"
}
},
"summary" : "Request refund on 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" : "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" : "integer",
"format" : "int64"
},
"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/SOR51_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_EVALUATION_READ" ]
} ],
"summary" : "Get the evaluation of an order",
"tags" : [ "Orders" ]
}
},
"/api/sellerpayment/transactions_logs" : {
"get" : {
"description" : "This resource uses seek pagination. The maximum allowed value for parameter limit is 2000.",
"operationId" : "TL02",
"parameters" : [ {
"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" : "Creation date",
"explode" : true,
"in" : "query",
"name" : "date_created_from",
"schema" : {
"type" : "string",
"format" : "date-time",
"description" : "Creation date"
},
"style" : "form"
}, {
"description" : "Creation date",
"explode" : true,
"in" : "query",
"name" : "date_created_to",
"schema" : {
"type" : "string",
"format" : "date-time",
"description" : "Creation date"
},
"style" : "form"
}, {
"description" : "Transaction date",
"explode" : true,
"in" : "query",
"name" : "transaction_date_from",
"schema" : {
"type" : "string",
"format" : "date-time",
"description" : "Transaction date"
},
"style" : "form"
}, {
"description" : "Transaction date",
"explode" : true,
"in" : "query",
"name" : "transaction_date_to",
"schema" : {
"type" : "string",
"format" : "date-time",
"description" : "Transaction date"
},
"style" : "form"
}, {
"description" : "Last updated date",
"explode" : true,
"in" : "query",
"name" : "last_updated_from",
"schema" : {
"type" : "string",
"format" : "date-time",
"description" : "Last updated date"
},
"style" : "form"
}, {
"description" : "Payment state. This parameter can be supplied multiple times.",
"explode" : true,
"in" : "query",
"name" : "payment_state",
"schema" : {
"type" : "array",
"description" : "Payment state. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "Transaction type. This parameter can be supplied multiple times.",
"explode" : true,
"in" : "query",
"name" : "transaction_type",
"schema" : {
"type" : "array",
"description" : "Transaction type. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "Accounting document number",
"explode" : true,
"in" : "query",
"name" : "accounting_document_number",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Order id. This parameter can be supplied multiple times.",
"explode" : true,
"in" : "query",
"name" : "order_id",
"schema" : {
"type" : "array",
"description" : "Order id. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "Order line id. This parameter can be supplied multiple times.",
"explode" : true,
"in" : "query",
"name" : "order_line_id",
"schema" : {
"type" : "array",
"description" : "Order line id. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "A comma-separated list of order references for customer.",
"explode" : true,
"in" : "query",
"name" : "order_reference_for_customer",
"schema" : {
"type" : "array",
"description" : "A comma-separated list of order references for customer.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "A comma-separated list of order references for seller.",
"explode" : true,
"in" : "query",
"name" : "order_reference_for_seller",
"schema" : {
"type" : "array",
"description" : "A comma-separated list of order references for seller.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "Accounting document request id. This parameter filters on documents requests with these entity types: SHOP_BILLING_CYCLE_PURCHASE_ORDER, FEES or ONE_OFF_FEES.",
"explode" : true,
"in" : "query",
"name" : "accounting_document_id",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Shop model. This parameter can be supplied multiple times.",
"explode" : true,
"in" : "query",
"name" : "shop_model",
"schema" : {
"type" : "array",
"description" : "Shop model. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "A comma-separated list of pay-out PSP codes. This parameter requires the Hybrid pay-out PSP feature to be enabled.",
"explode" : true,
"in" : "query",
"name" : "pay_out_psp_codes",
"schema" : {
"type" : "array",
"description" : "A comma-separated list of pay-out PSP codes. This parameter requires the Hybrid pay-out PSP feature to be enabled.",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "An external reference for one-off transactions that are not tied to a Mirakl order. This parameter can be supplied multiple times.",
"explode" : true,
"in" : "query",
"name" : "other_reference",
"schema" : {
"type" : "array",
"description" : "An external reference for one-off transactions that are not tied to a Mirakl order. This parameter can be supplied multiple times.",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "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" : "integer",
"format" : "int64"
},
"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/TL02_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ACCOUNTANCY", "ROLE_PARTNER_TRANSACTION_LOG_READ" ]
} ],
"summary" : "List transaction lines",
"tags" : [ "Invoicing and Accounting" ]
}
},
"/api/sellerpayment/transactions_logs/async" : {
"post" : {
"description" : "The export is asynchronous. Export status can be retrieved by calling TL04.",
"operationId" : "TL03",
"parameters" : [ {
"description" : "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" : "integer",
"format" : "int64"
},
"style" : "form"
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TL03_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/TL03_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ACCOUNTANCY", "ROLE_PARTNER_TRANSACTION_LOG_READ" ]
} ],
"summary" : "Export transaction lines JSON file asynchronously",
"tags" : [ "Invoicing and Accounting" ]
}
},
"/api/sellerpayment/transactions_logs/async/status/{tracking_id}" : {
"get" : {
"description" : "Retrieve the status for an TL03 transaction log export.