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."
}
}
},
"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_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",
"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" : 3
}
}
},
"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."
}
}
},
"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",
"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" : 3
}
}
},
"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."
}
}
},
"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",
"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" : 3
}
}
},
"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."
}
}
},
"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.true or false"
}
}
},
"PM11_Response_200_Attributes_Channels" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Channel code"
}
}
},
"PM11_Response_200_Attributes_DescriptionTranslations" : {
"type" : "object",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Locale"
},
"value" : {
"type" : "string",
"description" : "Translation"
}
}
},
"PM11_Response_200_Attributes_LabelTranslations" : {
"type" : "object",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Locale"
},
"value" : {
"type" : "string",
"description" : "Translation"
}
}
},
"PM11_Response_200_Attributes_Roles" : {
"type" : "object",
"properties" : {
"parameters" : {
"type" : "array",
"description" : "Attribute role parameters",
"items" : {
"$ref" : "#/components/schemas/PM11_Response_200_Attributes_Roles_Parameters"
}
},
"type" : {
"type" : "string",
"description" : "Role type of the attribute"
}
}
},
"PM11_Response_200_Attributes_Roles_Parameters" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the parameter"
},
"value" : {
"type" : "string",
"description" : "Value of the parameter"
}
}
},
"PM11_Response_200_Attributes_TypeParameters" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the parameter"
},
"value" : {
"type" : "string",
"description" : "Value of the parameter"
}
}
},
"PM11_Response_200_Attributes_Values" : {
"type" : "object",
"deprecated" : true,
"properties" : {
"code" : {
"type" : "string",
"description" : "Value code"
}
}
},
"RO02_Response_200" : {
"type" : "object",
"properties" : {
"roles" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RO02_Response_200_Roles"
}
}
}
},
"RO02_Response_200_Roles" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
},
"S30_Response_200" : {
"type" : "object",
"properties" : {
"shop_documents" : {
"type" : "array",
"description" : "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"
}
}
},
"VL11_Response_200" : {
"type" : "object",
"properties" : {
"values_lists" : {
"type" : "array",
"description" : "List of values list",
"items" : {
"$ref" : "#/components/schemas/VL11_Response_200_ValuesLists"
}
}
}
},
"VL11_Response_200_ValuesLists" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Value list code"
},
"label" : {
"type" : "string",
"description" : "Value list label"
},
"label_translations" : {
"type" : "array",
"description" : "Value list translations",
"items" : {
"$ref" : "#/components/schemas/VL11_Response_200_ValuesLists_LabelTranslations"
}
},
"values" : {
"type" : "array",
"description" : "Value list's of value list",
"items" : {
"$ref" : "#/components/schemas/VL11_Response_200_ValuesLists_Values"
}
}
}
},
"VL11_Response_200_ValuesLists_LabelTranslations" : {
"type" : "object",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Locale"
},
"value" : {
"type" : "string",
"description" : "Translation"
}
}
},
"VL11_Response_200_ValuesLists_Values" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Value code"
},
"label" : {
"type" : "string",
"description" : "Value label"
},
"label_translations" : {
"type" : "array",
"description" : "Value label translation",
"items" : {
"$ref" : "#/components/schemas/VL11_Response_200_ValuesLists_Values_LabelTranslations"
}
}
}
},
"VL11_Response_200_ValuesLists_Values_LabelTranslations" : {
"type" : "object",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Locale"
},
"value" : {
"type" : "string",
"description" : "Translation"
}
}
}
},
"securitySchemes" : {
"shop_api_key" : {
"in" : "header",
"name" : "Authorization",
"type" : "apiKey"
}
}
},
"info" : {
"title" : "Mirakl Catalog Manager APIs",
"version" : "latest-release"
},
"openapi" : "3.0.1",
"paths" : {
"/api/account" : {
"get" : {
"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"
}
},
"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"
}
},
"summary" : "Update shop information",
"tags" : [ "Stores" ]
}
},
"/api/account/statistics" : {
"get" : {
"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"
}
},
"summary" : "Get shop statistics",
"tags" : [ "Stores" ]
}
},
"/api/additional_fields" : {
"get" : {
"operationId" : "AF01",
"parameters" : [ {
"description" : "A comma separated list of entities on which the additional fields must apply. Accepted values are OFFER, SHOP, ORDER and ORDER_LINE. Ex: OFFER,SHOP.",
"explode" : true,
"in" : "query",
"name" : "entities",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "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"
}
},
"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"
}
},
"summary" : "List all enabled channels",
"tags" : [ "Platform Settings" ]
}
},
"/api/mcm/products/sources/status/export" : {
"get" : {
"description" : "Delta export of the source product data sheet status in JSON format.\n\nDefine a cron job in your system that periodically calls this API and sets the previous\nrequest date as the `updated_since` query parameter.",
"operationId" : "CM11",
"parameters" : [ {
"description" : "Export start date. Given date must respect ISO-8601 format and must be URL encoded",
"explode" : true,
"in" : "query",
"name" : "updated_since",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Export end date. Given date must respect ISO-8601 format and must be URL encoded",
"explode" : true,
"in" : "query",
"name" : "updated_to",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "The status of the product : LIVE / NOT_LIVE",
"explode" : true,
"in" : "query",
"name" : "status",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "The provider unique identifier of the product",
"explode" : true,
"in" : "query",
"name" : "provider_unique_identifier",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"maxLength" : 100,
"minLength" : 0
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "The unique identifier of the product with type (structure: \\\"unique_identifier=&UniqueIdentifierType1|UniqueIdentifierID1,UniqueIdentifierType2|UniqueIdentifierID2, ...\\\").",
"explode" : true,
"in" : "query",
"name" : "unique_identifier",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"maxLength" : 100,
"minLength" : 0
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "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" : "string",
"format" : "binary"
}
}
},
"description" : "Export success"
},
"204" : {
"description" : "No source product data sheet status to export"
}
},
"summary" : "Export Source Product Data Sheet status",
"tags" : [ "Products" ]
}
},
"/api/currencies" : {
"get" : {
"description" : "List currency codes and labels activated on the platform",
"operationId" : "CUR01",
"parameters" : [ {
"description" : "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"
}
},
"summary" : "List currency codes and labels",
"tags" : [ "Platform Settings" ]
}
},
"/api/documents" : {
"get" : {
"operationId" : "DO01",
"parameters" : [ {
"description" : "A comma separated list of values, representing the type of entities the document type should be related to. Accepted values are ORDER, SHOP. Ex: ORDER,SHOP",
"explode" : true,
"in" : "query",
"name" : "entities",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "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"
}
},
"summary" : "List all document types",
"tags" : [ "Platform Settings" ]
}
},
"/api/hierarchies" : {
"get" : {
"operationId" : "H11",
"parameters" : [ {
"description" : "Catalog category code",
"explode" : true,
"in" : "query",
"name" : "hierarchy",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Number of children catalog category levels to retrieve. If not specified, all child catalog categories are retrieved",
"explode" : true,
"in" : "query",
"name" : "max_level",
"schema" : {
"type" : "integer",
"format" : "int32"
},
"style" : "form"
}, {
"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/H11_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List Catalog categories (parents and children) related to a Catalog category",
"tags" : [ "Products" ]
}
},
"/api/locales" : {
"get" : {
"description" : "List locale codes and labels from your platform to automate product format exports (API H01, PM01, VL01) from your PIM system",
"operationId" : "L01",
"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"
}
},
"summary" : "List locale codes and labels",
"tags" : [ "Platform Settings" ]
}
},
"/api/products/imports/{import}" : {
"get" : {
"operationId" : "P42",
"parameters" : [ {
"description" : "Import identifier",
"explode" : false,
"in" : "path",
"name" : "import",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
},
"style" : "simple"
}, {
"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/P42_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get the import status for a product import",
"tags" : [ "Products" ]
}
},
"/api/products/imports/{import}/error_report" : {
"get" : {
"description" : "This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).",
"operationId" : "P44",
"parameters" : [ {
"description" : "Import identifier",
"explode" : false,
"in" : "path",
"name" : "import",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
},
"style" : "simple"
}, {
"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"
}
},
"summary" : "Get the error report file for a product import (\"Non-integrated products report\")",
"tags" : [ "Products" ]
}
},
"/api/products/imports/{import}/new_product_report" : {
"get" : {
"description" : "This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).",
"operationId" : "P45",
"parameters" : [ {
"description" : "Import identifier",
"explode" : false,
"in" : "path",
"name" : "import",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
},
"style" : "simple"
}, {
"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"
}
},
"summary" : "Get the product integration report file for a product import (\"Added products report\")",
"tags" : [ "Products" ]
}
},
"/api/products/imports/{import}/transformed_file" : {
"get" : {
"description" : "This API returns a CSV file.",
"operationId" : "P46",
"parameters" : [ {
"description" : "Import identifier",
"explode" : false,
"in" : "path",
"name" : "import",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
},
"style" : "simple"
}, {
"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" : {
"text/csv" : {
"schema" : {
"type" : "string",
"format" : "binary"
}
}
},
"description" : "OK"
}
},
"summary" : "Get the transformed file for a product import (\"File in operator format\")",
"tags" : [ "Products" ]
}
},
"/api/products/imports/{import}/transformation_error_report" : {
"get" : {
"description" : "This API returns a CSV, XLSX or XML file, depending on the file format provided by the seller.",
"operationId" : "P47",
"parameters" : [ {
"description" : "Import identifier",
"explode" : false,
"in" : "path",
"name" : "import",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
},
"style" : "simple"
}, {
"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"
}
},
"summary" : "Get the transformation error report file for a product import (\"Source file error report\")",
"tags" : [ "Products" ]
}
},
"/api/products/imports" : {
"get" : {
"description" : "If the last_request_date param is not set the api returns all product imports.",
"operationId" : "P51",
"parameters" : [ {
"description" : "Return only product imports that have changed since this date",
"explode" : true,
"in" : "query",
"name" : "last_request_date",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Product import status. One of CANCELLED, WAITING, RUNNING, SENT, COMPLETE, FAILED",
"explode" : true,
"in" : "query",
"name" : "status",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "If true returns only product import trackings with transformed file",
"explode" : true,
"in" : "query",
"name" : "has_transformed_file",
"schema" : {
"type" : "boolean"
},
"style" : "form"
}, {
"description" : "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/P51_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get information about product import statuses",
"tags" : [ "Products" ]
}
},
"/api/platform/configuration" : {
"get" : {
"description" : "List platform configurations such as general information, modules and features activated.true\" to get all the operator attributes.",
"explode" : true,
"in" : "query",
"name" : "all_operator_attributes",
"schema" : {
"type" : "boolean",
"default" : false
},
"style" : "form"
}, {
"description" : "Set to \"true\" to get only the attributes that have roles.",
"explode" : true,
"in" : "query",
"name" : "with_roles",
"schema" : {
"type" : "boolean",
"default" : false
},
"style" : "form"
}, {
"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/PM11_Response_200"
}
},
"text/csv" : {
"schema" : {
"type" : "string",
"format" : "binary"
}
}
},
"description" : "Export success"
}
},
"summary" : "Get the product attribute configuration",
"tags" : [ "Products" ]
}
},
"/api/users/shops/roles" : {
"get" : {
"operationId" : "RO02",
"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/RO02_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List shop roles",
"tags" : [ "Users" ]
}
},
"/api/shops/documents" : {
"get" : {
"description" : "You must specify at least one of the following parameters: shop_ids, updated_since",
"operationId" : "S30",
"parameters" : [ {
"description" : "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"
}
},
"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"
}
},
"summary" : "Download documents for one or multiple shops",
"tags" : [ "Stores" ]
}
},
"/api/shops/documents/{document_id}" : {
"delete" : {
"operationId" : "S33",
"parameters" : [ {
"description" : "Document identifier to delete",
"explode" : false,
"in" : "path",
"name" : "document_id",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
},
"style" : "simple"
}, {
"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 shop document",
"tags" : [ "Stores" ]
}
},
"/api/version" : {
"get" : {
"description" : "Use this endpoint to check that Mirakl Platform is up.