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"
}
}
},
"M10_Response_200" : {
"type" : "object",
"properties" : {
"authorized_participants" : {
"type" : "array",
"description" : "Thread authorized participantsauthorized_participants\n",
"items" : {
"$ref" : "#/components/schemas/M10_Response_200_CurrentParticipants"
}
},
"customer_organization" : {
"$ref" : "#/components/schemas/M10_Response_200_CustomerOrganization",
"description" : "Data related to the customer organization (B2B transactions)"
},
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Thread created date"
},
"date_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Thread updated date"
},
"entities" : {
"type" : "array",
"description" : "Thread entities",
"items" : {
"$ref" : "#/components/schemas/M10_Response_200_Entities"
}
},
"id" : {
"type" : "string",
"description" : "Thread id"
},
"messages" : {
"type" : "array",
"description" : "Thread messages",
"items" : {
"$ref" : "#/components/schemas/M10_Response_200_Messages"
}
},
"metadata" : {
"$ref" : "#/components/schemas/M10_Response_200_Metadata",
"description" : "Thread metadata"
},
"no_store_reply_needed" : {
"type" : "array",
"description" : " Thread \"no store reply needed\" actions.\n",
"items" : {
"$ref" : "#/components/schemas/M10_Response_200_NoStoreReplyNeeded"
}
},
"topic" : {
"$ref" : "#/components/schemas/M10_Response_200_Topic",
"description" : "Thread topic"
}
}
},
"M10_Response_200_AuthorizedParticipants" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Participant display name"
},
"id" : {
"type" : "string",
"description" : "Participant idtype equals OPERATOR, no id will be returned."
},
"type" : {
"type" : "string",
"description" : "Participant type"
}
}
},
"M10_Response_200_CurrentParticipants" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Participant display name"
},
"id" : {
"type" : "string",
"description" : "Participant idtype equals OPERATOR, no id will be returned."
},
"type" : {
"type" : "string",
"description" : "Participant type"
}
}
},
"M10_Response_200_CustomerOrganization" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Customer organization name"
},
"id" : {
"type" : "string",
"description" : "Customer organization id"
}
}
},
"M10_Response_200_Entities" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Entity id"
},
"label" : {
"type" : "string",
"description" : "Entity label"
},
"type" : {
"type" : "string",
"description" : "Entity type"
}
}
},
"M10_Response_200_Messages" : {
"type" : "object",
"properties" : {
"attachments" : {
"type" : "array",
"description" : "Message attachments",
"items" : {
"$ref" : "#/components/schemas/M10_Response_200_Messages_Attachments"
}
},
"body" : {
"type" : "string",
"description" : "Message body"
},
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Message creation date"
},
"from" : {
"$ref" : "#/components/schemas/M10_Response_200_Messages_From",
"description" : "Message sender"
},
"id" : {
"type" : "string",
"description" : "Message id"
},
"to" : {
"type" : "array",
"description" : "Message recipients",
"items" : {
"$ref" : "#/components/schemas/M10_Response_200_Messages_To"
}
}
}
},
"M10_Response_200_Messages_Attachments" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Attachment id"
},
"name" : {
"type" : "string",
"description" : "Attachment file name"
},
"size" : {
"type" : "integer",
"format" : "int64",
"description" : "Attachment size"
}
}
},
"M10_Response_200_Messages_From" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Sender display name"
},
"organization_details" : {
"$ref" : "#/components/schemas/M10_Response_200_Messages_From_OrganizationDetails",
"description" : "Organization details of the sender"
},
"type" : {
"type" : "string",
"description" : "Sender type"
}
}
},
"M10_Response_200_Messages_From_OrganizationDetails" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Participant display name"
},
"id" : {
"type" : "string",
"description" : "Participant idtype equals OPERATOR, no id will be returned."
},
"type" : {
"type" : "string",
"description" : "Participant type"
}
}
},
"M10_Response_200_Messages_To" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Participant display name"
},
"id" : {
"type" : "string",
"description" : "Participant idtype equals OPERATOR, no id will be returned."
},
"type" : {
"type" : "string",
"description" : "Participant type"
}
}
},
"M10_Response_200_Metadata" : {
"type" : "object",
"properties" : {
"last_message_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Date of the last message"
},
"last_sender" : {
"$ref" : "#/components/schemas/M10_Response_200_Metadata_LastSender",
"description" : "Last message sender"
},
"shop_reply_needed_since" : {
"type" : "string",
"format" : "date-time",
"description" : "Date since the latest unanswered message awaiting a shop reply. Null when the shop has replied."
},
"total_count" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of messages in the thread"
}
}
},
"M10_Response_200_Metadata_LastSender" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Sender display name"
},
"organization_details" : {
"$ref" : "#/components/schemas/M10_Response_200_Metadata_LastSender_OrganizationDetails",
"description" : "Organization details of the sender"
},
"type" : {
"type" : "string",
"description" : "Sender type"
}
}
},
"M10_Response_200_Metadata_LastSender_OrganizationDetails" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Participant display name"
},
"id" : {
"type" : "string",
"description" : "Participant idtype equals OPERATOR, no id will be returned."
},
"type" : {
"type" : "string",
"description" : "Participant type"
}
}
},
"M10_Response_200_NoStoreReplyNeeded" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date-time",
"description" : "No store reply needed action date"
},
"user_type" : {
"type" : "string",
"description" : "Entity that operated \"no store reply needed\" action.\n"
}
}
},
"M10_Response_200_Topic" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Topic type"
},
"value" : {
"type" : "string",
"description" : "Topic value"
}
}
},
"M11_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/M11_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."
}
}
},
"M11_Response_200_Data" : {
"type" : "object",
"properties" : {
"authorized_participants" : {
"type" : "array",
"description" : "Thread authorized participantsauthorized_participants\n",
"items" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_CurrentParticipants"
}
},
"customer_organization" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_CustomerOrganization",
"description" : "Data related to the customer organization (B2B transactions)"
},
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Thread created date"
},
"date_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Thread updated date"
},
"entities" : {
"type" : "array",
"description" : "Thread entities",
"items" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_Entities"
}
},
"id" : {
"type" : "string",
"description" : "Thread id"
},
"messages" : {
"type" : "array",
"description" : "Thread messages. Limited to the last 100 messages of the thread. Present if with_messages query parameter has been set to true",
"items" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_Messages"
}
},
"metadata" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_Metadata",
"description" : "Thread metadata"
},
"no_store_reply_needed" : {
"type" : "array",
"description" : " Thread \"no store reply needed\" actions. Present if \"with_messages\" query parameter has been set to true.\n",
"items" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_NoStoreReplyNeeded"
}
},
"topic" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_Topic",
"description" : "Thread topic"
}
}
},
"M11_Response_200_Data_AuthorizedParticipants" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Participant display name"
},
"id" : {
"type" : "string",
"description" : "Participant idtype equals OPERATOR, no id will be returned."
},
"type" : {
"type" : "string",
"description" : "Participant type"
}
}
},
"M11_Response_200_Data_CurrentParticipants" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Participant display name"
},
"id" : {
"type" : "string",
"description" : "Participant idtype equals OPERATOR, no id will be returned."
},
"type" : {
"type" : "string",
"description" : "Participant type"
}
}
},
"M11_Response_200_Data_CustomerOrganization" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Customer organization name"
},
"id" : {
"type" : "string",
"description" : "Customer organization id"
}
}
},
"M11_Response_200_Data_Entities" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Entity id"
},
"label" : {
"type" : "string",
"description" : "Entity label"
},
"type" : {
"type" : "string",
"description" : "Entity type"
}
}
},
"M11_Response_200_Data_Messages" : {
"type" : "object",
"properties" : {
"attachments" : {
"type" : "array",
"description" : "Message attachments",
"items" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_Messages_Attachments"
}
},
"body" : {
"type" : "string",
"description" : "Message body"
},
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Message creation date"
},
"from" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_Messages_From",
"description" : "Message sender"
},
"id" : {
"type" : "string",
"description" : "Message id"
},
"to" : {
"type" : "array",
"description" : "Message recipients",
"items" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_Messages_To"
}
}
}
},
"M11_Response_200_Data_Messages_Attachments" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Attachment id"
},
"name" : {
"type" : "string",
"description" : "Attachment file name"
},
"size" : {
"type" : "integer",
"format" : "int64",
"description" : "Attachment size"
}
}
},
"M11_Response_200_Data_Messages_From" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Sender display name"
},
"organization_details" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_Messages_From_OrganizationDetails",
"description" : "Organization details of the sender"
},
"type" : {
"type" : "string",
"description" : "Sender type"
}
}
},
"M11_Response_200_Data_Messages_From_OrganizationDetails" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Participant display name"
},
"id" : {
"type" : "string",
"description" : "Participant idtype equals OPERATOR, no id will be returned."
},
"type" : {
"type" : "string",
"description" : "Participant type"
}
}
},
"M11_Response_200_Data_Messages_To" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Participant display name"
},
"id" : {
"type" : "string",
"description" : "Participant idtype equals OPERATOR, no id will be returned."
},
"type" : {
"type" : "string",
"description" : "Participant type"
}
}
},
"M11_Response_200_Data_Metadata" : {
"type" : "object",
"properties" : {
"last_message_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Date of the last message"
},
"last_sender" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_Metadata_LastSender",
"description" : "Last message sender"
},
"shop_reply_needed_since" : {
"type" : "string",
"format" : "date-time",
"description" : "Date since the latest unanswered message awaiting a shop reply. Null when the shop has replied."
},
"total_count" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of messages in the thread"
}
}
},
"M11_Response_200_Data_Metadata_LastSender" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Sender display name"
},
"organization_details" : {
"$ref" : "#/components/schemas/M11_Response_200_Data_Metadata_LastSender_OrganizationDetails",
"description" : "Organization details of the sender"
},
"type" : {
"type" : "string",
"description" : "Sender type"
}
}
},
"M11_Response_200_Data_Metadata_LastSender_OrganizationDetails" : {
"type" : "object",
"properties" : {
"display_name" : {
"type" : "string",
"description" : "Participant display name"
},
"id" : {
"type" : "string",
"description" : "Participant idtype equals OPERATOR, no id will be returned."
},
"type" : {
"type" : "string",
"description" : "Participant type"
}
}
},
"M11_Response_200_Data_NoStoreReplyNeeded" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date-time",
"description" : "No store reply needed action date"
},
"user_type" : {
"type" : "string",
"description" : "Entity that operated \"no store reply needed\" action.\n"
}
}
},
"M11_Response_200_Data_Topic" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Topic type"
},
"value" : {
"type" : "string",
"description" : "Topic value"
}
}
},
"OF01_Response_201" : {
"type" : "object",
"properties" : {
"import_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Offer import identifier. If Mirakl detects a duplicate import request, the API will return the import_id of the existing import rather than creating a new one."
},
"product_import_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Product import identifier"
}
}
},
"OF02_Response_200" : {
"type" : "object",
"properties" : {
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Import creation date"
},
"has_error_report" : {
"type" : "boolean",
"description" : "Indicate if an error report exists"
},
"import_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Import ID"
},
"lines_in_error" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines in error"
},
"lines_in_pending" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines in pending"
},
"lines_in_success" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines in success"
},
"lines_read" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines read"
},
"mode" : {
"type" : "string",
"description" : "Import mode"
},
"offer_deleted" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of deleted offers"
},
"offer_inserted" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of inserted offers"
},
"offer_updated" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of updated offers"
},
"reason_status" : {
"type" : "string",
"description" : "Import status reason"
},
"status" : {
"type" : "string",
"description" : "Import status"
},
"type" : {
"type" : "string",
"deprecated" : true,
"description" : "Will be remove in a future version"
}
}
},
"OF04_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/OF04_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."
}
}
},
"OF04_Response_200_Data" : {
"type" : "object",
"properties" : {
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Import creation date"
},
"has_error_report" : {
"type" : "boolean",
"description" : "Indicate if an error report exists"
},
"import_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Import ID"
},
"lines_in_error" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines in error"
},
"lines_in_pending" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines in pending"
},
"lines_in_success" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines in success"
},
"lines_read" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines read"
},
"mode" : {
"type" : "string",
"description" : "Import mode"
},
"offer_deleted" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of deleted offers"
},
"offer_inserted" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of inserted offers"
},
"offer_updated" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of updated offers"
},
"origin" : {
"type" : "string",
"description" : "Import origin"
},
"reason_status" : {
"type" : "string",
"description" : "Import status reason"
},
"shop_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Shop identifier"
},
"status" : {
"type" : "string",
"description" : "Import status"
}
}
},
"OF21_Response_200" : {
"type" : "object",
"properties" : {
"offers" : {
"type" : "array",
"description" : "Offers for a shop",
"items" : {
"$ref" : "#/components/schemas/OF21_Response_200_Offers"
}
},
"total_count" : {
"type" : "integer",
"format" : "int32",
"description" : "Offer total count"
}
}
},
"OF21_Response_200_Offers" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"description" : "Is the offer active"
},
"all_prices" : {
"type" : "array",
"description" : "All prices for the offer\ntext/csv or application/json). Default to text/csv."
},
"include_fields" : {
"type" : "array",
"description" : "Specify which columns (CSV) or fields (JSON) will be returned. If specified, only the listed columns/fields will be returned, otherwise all will be returned. If combined with rename_fields, include_fields must use the original header/field names.",
"items" : {
"type" : "string"
}
},
"include_inactive_offers" : {
"type" : "boolean",
"default" : false,
"description" : "When calling the API in full mode (i.e. when no last_request_date is provided), inactive offers are not returned. To retrieve both active and inactive offers, set this field to true.{\"offer-id\": \"offerId\", \"shop-name\":\"shopName\"}"
},
"shipping_zones" : {
"type" : "array",
"description" : "If the setting Export shipping charges and delivery times has been enabled, list of the shipping zones codes to filter with. If specified, only shipping information linked to the given zones will be returned. Otherwise, all shipping information for all zones will be returned.",
"items" : {
"type" : "string"
}
}
}
},
"OF52_Response_200" : {
"type" : "object",
"properties" : {
"tracking_id" : {
"type" : "string",
"description" : "The offer export tracking Id. If Mirakl detects a duplicate export request, the API will return the tracking_id of the existing export rather than creating a new one."
}
}
},
"OF53_Response_200" : {
"type" : "object",
"properties" : {
"error" : {
"$ref" : "#/components/schemas/OF53_Response_200_Error",
"description" : "Specific error if the status is FAILED"
},
"last_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "The last update date of the export"
},
"status" : {
"type" : "string",
"description" : "Current status of the export, can be PENDING, FAILED or COMPLETED"
},
"urls" : {
"type" : "array",
"description" : "List of generated urls to call to download each generated chunks",
"items" : {
"type" : "string"
}
}
}
},
"OF53_Response_200_Error" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The error code"
},
"detail" : {
"type" : "string",
"description" : "The error detail"
}
}
},
"OF61_Response_200" : {
"type" : "object",
"properties" : {
"offer_states" : {
"type" : "array",
"description" : "Offer conditions",
"items" : {
"$ref" : "#/components/schemas/OF61_Response_200_OfferStates"
}
}
}
},
"OF61_Response_200_OfferStates" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Offer condition code"
},
"label" : {
"type" : "string",
"description" : "Offer condition label"
}
}
},
"OR04_Request" : {
"type" : "object",
"properties" : {
"orders" : {
"type" : "array",
"description" : "Orders to be updated, maximum number of orders per call: 100",
"items" : {
"$ref" : "#/components/schemas/OR04_Request_Orders"
},
"maxItems" : 100,
"minItems" : 1
}
}
},
"OR04_Request_Orders" : {
"type" : "object",
"description" : "Orders to be updated, maximum number of orders per call: 100",
"properties" : {
"order_id" : {
"type" : "string",
"description" : "Order identifier"
},
"order_lines" : {
"type" : "array",
"description" : "Order lines to be updated",
"items" : {
"$ref" : "#/components/schemas/OR04_Request_Orders_OrderLines"
}
},
"references" : {
"$ref" : "#/components/schemas/OR04_Request_Orders_References",
"description" : "Order references"
}
}
},
"OR04_Request_Orders_OrderLines" : {
"type" : "object",
"description" : "Order lines to be updated",
"properties" : {
"eco_contributions" : {
"type" : "array",
"description" : "Eco-contributions to add or update on the order line - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.",
"items" : {
"$ref" : "#/components/schemas/OR04_Request_Orders_OrderLines_EcoContributions"
}
},
"order_line_id" : {
"type" : "string",
"description" : "Order line's identifier"
}
}
},
"OR04_Request_Orders_OrderLines_EcoContributions" : {
"type" : "object",
"description" : "Eco-contributions to add or update on the order line - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.",
"properties" : {
"epr_category_code" : {
"type" : "string",
"description" : "Extended Producer Responsibility category"
},
"producer_id" : {
"type" : "string",
"description" : "Producer identifier of the eco-contribution",
"maxLength" : 255,
"minLength" : 0
},
"unit_amount" : {
"type" : "number",
"description" : "Unit amount of the eco-contribution",
"maximum" : 100000000000000000,
"minimum" : 0
}
}
},
"OR04_Request_Orders_References" : {
"type" : "object",
"description" : "Order references",
"properties" : {
"order_reference_for_seller" : {
"type" : "string",
"description" : "Order reference for seller. May not be blank.",
"maxLength" : 2000,
"minLength" : 1
}
}
},
"OR04_Response_200" : {
"type" : "object",
"properties" : {
"updated_orders" : {
"type" : "array",
"description" : "A list of updated orders and orders in error objects",
"items" : {
"$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders"
}
}
}
},
"OR04_Response_200_UpdatedOrders" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"description" : "List of errors encountered when updating order",
"items" : {
"$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Errors"
}
},
"order_id" : {
"type" : "string",
"description" : "Order identifier"
},
"updated" : {
"$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated",
"description" : "Details of the modified order"
}
}
},
"OR04_Response_200_UpdatedOrders_Errors" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Error code"
},
"field" : {
"type" : "string",
"description" : "Name of the field on the input object. Can be composed, e.g.: address.zip_code"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"OR04_Response_200_UpdatedOrders_Updated" : {
"type" : "object",
"properties" : {
"order_lines" : {
"type" : "array",
"description" : "Details of the modified order line",
"items" : {
"$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_OrderLines"
}
},
"references" : {
"$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_References",
"description" : "Order references"
}
}
},
"OR04_Response_200_UpdatedOrders_Updated_OrderLines" : {
"type" : "object",
"properties" : {
"cancelations" : {
"type" : "array",
"description" : "List of the cancelations",
"items" : {
"$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_OrderLines_Cancelations"
}
},
"eco_contributions" : {
"type" : "array",
"description" : "List of eco-contribution amounts and corresponding producer identifiers, if applicable",
"items" : {
"$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_OrderLines_EcoContributions"
}
},
"order_line_id" : {
"type" : "string",
"description" : "Order line's identifier"
},
"refunds" : {
"type" : "array",
"description" : "List of the refunds",
"items" : {
"$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_OrderLines_Refunds"
}
}
}
},
"OR04_Response_200_UpdatedOrders_Updated_OrderLines_Cancelations" : {
"type" : "object",
"properties" : {
"cancelation_id" : {
"type" : "string",
"description" : "Cancelation identifier"
},
"eco_contributions" : {
"type" : "array",
"description" : "List of eco-contribution amounts and corresponding producer identifiers, if applicable",
"items" : {
"$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_OrderLines_Cancelations_EcoContributions"
}
}
}
},
"OR04_Response_200_UpdatedOrders_Updated_OrderLines_Cancelations_EcoContributions" : {
"type" : "object",
"properties" : {
"epr_category_code" : {
"type" : "string",
"description" : "Extended Producer Responsibility category"
},
"producer_id" : {
"type" : "string",
"description" : "Producer identifier of the eco-contribution.TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) are expressed without tax (taxes should be added to these prices in order to get the full amount including taxes).TAX_INCLUDED: the price fields include the tax amount. PAY_ON_DUE_DATE orders, null otherwise.zip_code field)"
},
"state" : {
"type" : "string",
"description" : "Address state",
"maxLength" : 255
},
"street_1" : {
"type" : "string",
"description" : "First information line of the address street",
"maxLength" : 255
},
"street_2" : {
"type" : "string",
"description" : "Second information line of the address street",
"maxLength" : 255
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code, mandatory except for: Bahrain, Chile, Egypt, Hong-Kong, Kuwait, Oman, Peru, Qatar, Saudi Arabia, United Arab Emirates or Uruguay",
"maxLength" : 255
}
}
},
"OR11_Response_200_Orders_Customer_ShippingAddress" : {
"type" : "object",
"properties" : {
"additional_info" : {
"type" : "string",
"description" : "Additional information for the shipping address"
},
"city" : {
"type" : "string",
"description" : "Address city"
},
"civility" : {
"type" : "string",
"description" : "Civility of the person associated with the address"
},
"company" : {
"type" : "string",
"description" : "Company of the person associated with the address"
},
"company_2" : {
"type" : "string",
"description" : "Second company information of the person associated with the address"
},
"country" : {
"type" : "string",
"description" : "Address country"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the address"
},
"firstname" : {
"type" : "string",
"description" : "First name of the person associated with the address"
},
"lastname" : {
"type" : "string",
"description" : "Last name of the person associated with the address"
},
"phone" : {
"type" : "string",
"description" : "Phone"
},
"phone_secondary" : {
"type" : "string",
"description" : "Phone secondary"
},
"state" : {
"type" : "string",
"description" : "Address state"
},
"street_1" : {
"type" : "string",
"description" : "First information line of the address street"
},
"street_2" : {
"type" : "string",
"description" : "Second information line of the address street"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"OR11_Response_200_Orders_DeliveryDate" : {
"type" : "object",
"properties" : {
"earliest" : {
"type" : "string",
"format" : "date-time",
"description" : "Earliest order delivery date"
},
"latest" : {
"type" : "string",
"format" : "date-time",
"description" : "Latest order delivery date"
}
}
},
"OR11_Response_200_Orders_DiscountCampaigns" : {
"type" : "object",
"properties" : {
"identifier" : {
"type" : "string",
"description" : "The unique identifier of the discount campaign"
}
}
},
"OR11_Response_200_Orders_Fulfillment" : {
"type" : "object",
"properties" : {
"center" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_Fulfillment_Center",
"description" : "Fulfillment center code"
}
}
},
"OR11_Response_200_Orders_Fulfillment_Center" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Center code"
}
}
},
"OR11_Response_200_Orders_InvoiceDetails" : {
"type" : "object",
"properties" : {
"document_details" : {
"type" : "array",
"description" : "Invoice document information",
"items" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_InvoiceDetails_DocumentDetails"
}
},
"payment_terms" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_InvoiceDetails_PaymentTerms",
"description" : "Payment terms"
}
}
},
"OR11_Response_200_Orders_InvoiceDetails_DocumentDetails" : {
"type" : "object",
"properties" : {
"format" : {
"type" : "string",
"description" : "Accounting document format"
}
}
},
"OR11_Response_200_Orders_InvoiceDetails_PaymentTerms" : {
"type" : "object",
"properties" : {
"days" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of days"
},
"type" : {
"type" : "string",
"description" : "Payment terms type.END_OF_MONTH: payment is due after a number of calendar days following the invoice issue date, at the end of the given month. NET: payment is due after a number of calendar days following the invoice issue date. true when the promotion's reward amount is divided and allocated proportionally to multiple order lines.false when the entire reward amount is allocated to one order line, or when the same discount percentage is applied to several order lines (one-step percentage off promotions)."
},
"campaign" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Promotions_Campaign",
"description" : "Promotion campaign information, when applicable."
},
"configuration" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Promotions_Configuration",
"description" : "Configuration used to calculate the applied promotion"
},
"deduced_amount" : {
"type" : "number",
"description" : "Promotion's amount for this line."
},
"id" : {
"type" : "string",
"description" : "Promotion's id, defined by the shop"
},
"offered_quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "The quantity of free items offered by the promotion for this line. FREE_ITEMS, null otherwise."
},
"promo_code" : {
"type" : "string",
"description" : "Promo code associated to the promotion"
}
}
},
"OR11_Response_200_Orders_OrderLines_Promotions_Campaign" : {
"type" : "object",
"properties" : {
"identifier" : {
"type" : "string",
"description" : "The identifier of the promotion campaign."
}
}
},
"OR11_Response_200_Orders_OrderLines_Promotions_Configuration" : {
"type" : "object",
"properties" : {
"amount_off" : {
"type" : "number",
"description" : "The amount off of the promotion. AMOUNT_OFF, null otherwise."
},
"free_items_quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "The free item target quantity of the promotion. FREE_ITEMS, null otherwise."
},
"internal_description" : {
"type" : "string",
"description" : "Promotion's Internal description, set by the shop at creation"
},
"percentage_off" : {
"type" : "number",
"description" : "The percentage off of the promotion. PERCENTAGE_OFF, null otherwise."
},
"reduced_unit_price" : {
"type" : "number",
"description" : "The new offer’s unit price triggered by the promotion. REDUCED_UNIT_PRICE, null otherwise."
},
"type" : {
"type" : "string",
"description" : "Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET)"
}
}
},
"OR11_Response_200_Orders_OrderLines_PurchaseInformation" : {
"type" : "object",
"properties" : {
"purchase_commission_on_fees" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseCommissionOnFees",
"description" : "Purchase order line’s commission on fees"
},
"purchase_commission_on_price" : {
"type" : "number",
"description" : "Purchase order line’s commission amount"
},
"purchase_commission_on_shipping" : {
"type" : "number",
"description" : "Purchase order line’s commission amount on shipping"
},
"purchase_fee_amount" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseFeeAmount",
"description" : "Purchase order line’s fees"
},
"purchase_price" : {
"type" : "number",
"description" : "Purchase order line’s price excluding shipping charges and fees"
},
"purchase_shipping_price" : {
"type" : "number",
"description" : "Purchase order line’s shipping charges"
},
"purchase_unit_price" : {
"type" : "number",
"description" : "Purchase unit price computed from the given offer price"
}
}
},
"OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseCommissionOnFees" : {
"type" : "object",
"properties" : {
"total_amount" : {
"type" : "number",
"description" : "Purchase order line’s commission total amount on fees"
}
}
},
"OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseFeeAmount" : {
"type" : "object",
"properties" : {
"total_amount" : {
"type" : "number",
"description" : "Purchase order line’s fee total amount"
}
}
},
"OR11_Response_200_Orders_OrderLines_Refunds" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Refund's amount"
},
"amount_breakdown" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_AmountBreakdown",
"description" : "The breakdown of the refund's amount, only available when advanced features are enabled"
},
"commission_amount" : {
"type" : "number",
"description" : "Refund's commission amount"
},
"commission_taxes" : {
"type" : "array",
"description" : "Refund's commission taxes",
"items" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_CommissionTaxes"
}
},
"commission_total_amount" : {
"type" : "number",
"description" : "The total commission amount of the refund (commission amount + commission taxes)"
},
"created_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Refund's creation date"
},
"eco_contributions" : {
"type" : "array",
"description" : "List of eco-contribution amounts and corresponding producer identifiers, if applicabletrue when the promotion's reward amount is divided and allocated proportionally to multiple order lines.false when the entire reward amount is allocated to one order line, or when the same discount percentage is applied to several order lines (one-step percentage off promotions)."
},
"campaign" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_Promotions_AppliedPromotions_Campaign",
"description" : "Promotion campaign information, when applicable."
},
"configuration" : {
"$ref" : "#/components/schemas/OR11_Response_200_Orders_Promotions_AppliedPromotions_Configuration",
"description" : "Configuration used to calculate the applied promotion"
},
"deduced_amount" : {
"type" : "number",
"description" : "Promotion's amount for this line."
},
"id" : {
"type" : "string",
"description" : "Promotion's id, defined by the shop"
},
"offered_quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "The quantity of free items offered by the promotion for this line. FREE_ITEMS, null otherwise."
},
"promo_code" : {
"type" : "string",
"description" : "Promo code associated to the promotion"
}
}
},
"OR11_Response_200_Orders_Promotions_AppliedPromotions_Campaign" : {
"type" : "object",
"properties" : {
"identifier" : {
"type" : "string",
"description" : "The identifier of the promotion campaign."
}
}
},
"OR11_Response_200_Orders_Promotions_AppliedPromotions_Configuration" : {
"type" : "object",
"properties" : {
"amount_off" : {
"type" : "number",
"description" : "The amount off of the promotion. AMOUNT_OFF, null otherwise."
},
"free_items_quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "The free item target quantity of the promotion. FREE_ITEMS, null otherwise."
},
"internal_description" : {
"type" : "string",
"description" : "Promotion's Internal description, set by the shop at creation"
},
"percentage_off" : {
"type" : "number",
"description" : "The percentage off of the promotion. PERCENTAGE_OFF, null otherwise."
},
"reduced_unit_price" : {
"type" : "number",
"description" : "The new offer’s unit price triggered by the promotion. REDUCED_UNIT_PRICE, null otherwise."
},
"type" : {
"type" : "string",
"description" : "Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET)"
}
}
},
"OR11_Response_200_Orders_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"
}
}
},
"OR13_Request" : {
"type" : "object",
"properties" : {
"channel_codes" : {
"type" : "array",
"description" : "A list of channel codes",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"end_date" : {
"type" : "string",
"format" : "date-time",
"description" : "End order creation date for filtering. Must be used with start_date."
},
"end_update_date" : {
"type" : "string",
"format" : "date-time",
"description" : "End order update date for filtering. Must be used with start_update_date."
},
"fulfillment_center_codes" : {
"type" : "string",
"description" : "Code of the fulfillment center",
"maxLength" : 100,
"minLength" : 0
},
"items_per_chunk" : {
"type" : "integer",
"format" : "int64",
"default" : 1000000,
"description" : "Maximum number of items included in the generated files",
"maximum" : 1000000,
"minimum" : 10000
},
"megabytes_per_chunk" : {
"type" : "integer",
"format" : "int64",
"default" : 512,
"description" : "Maximum mega bytes weight for generated files",
"maximum" : 1024,
"minimum" : 10
},
"only_null_channel" : {
"type" : "boolean",
"default" : false,
"description" : "Return only orders without channel. If true, ignore the channel_codes"
},
"order_state_codes" : {
"type" : "array",
"description" : "A list of order state's codes",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"order_tax_mode" : {
"type" : "string",
"description" : "Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) do not include taxes.TAX_INCLUDED: the price fields include the tax amount. end_date."
},
"start_update_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Start order update date for filtering. Mirakl will subtract a time delta to ensure no orders are missed due to network and/or software latency. Must be used with end_update_date."
}
}
},
"OR13_Response_200" : {
"type" : "object",
"properties" : {
"tracking_id" : {
"type" : "string",
"description" : "Id to poll in order to track the export's progress"
}
}
},
"OR14_Response_200" : {
"type" : "object",
"properties" : {
"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', or 'COMPLETED'"
},
"urls" : {
"type" : "array",
"description" : "List of generated URLs to call to download each generated chunks",
"items" : {
"type" : "string"
}
}
}
},
"OR21_Request" : {
"type" : "object",
"properties" : {
"order_lines" : {
"type" : "array",
"description" : "List of representations of order line for acceptance",
"items" : {
"$ref" : "#/components/schemas/OR21_Request_OrderLines"
}
}
}
},
"OR21_Request_OrderLines" : {
"type" : "object",
"description" : "List of representations of order line for acceptance",
"properties" : {
"accepted" : {
"type" : "boolean",
"description" : "Boolean indicating if the order line is accepted or refused"
},
"id" : {
"type" : "string",
"description" : "Order line's identifier"
}
}
},
"OR23_Request" : {
"type" : "object",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "The code of a carrier. This information is mandatory for a registered carrier."
},
"carrier_name" : {
"type" : "string",
"description" : "The name of a carrier. This information is mandatory for an unregistered carrier."
},
"carrier_standard_code" : {
"type" : "string",
"description" : "Carrier standard code"
},
"carrier_url" : {
"type" : "string",
"description" : "The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers."
},
"tracking_number" : {
"type" : "string",
"description" : "The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number."
}
}
},
"OR28_Request" : {
"type" : "object",
"properties" : {
"order_tax_mode" : {
"type" : "string",
"description" : "Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.TAX_EXCLUDED: the price fields (price, unit price, shipping price and order total prices) do not include taxes.TAX_INCLUDED: the price fields include the tax amounts. TAX_EXCLUDED: the price fields (amount, shipping amount) are expressed without tax (taxes should be added to these prices in order to get the full amount including taxes).TAX_INCLUDED: the price fields include the tax amount. TAX_EXCLUDED: the price fields (amount, shipping amount) are expressed without tax (taxes should be added to these prices in order to get the full amount including taxes).TAX_INCLUDED: the price fields include the tax amount. media_url"
},
"media_url" : {
"type" : "string",
"description" : "Media URL"
},
"type" : {
"type" : "string",
"description" : "Media TYPE (small, large...)"
}
}
},
"P11_Response_200_Products_ProductReferences" : {
"type" : "object",
"properties" : {
"reference" : {
"type" : "string",
"description" : "Value of the reference"
},
"reference_type" : {
"type" : "string",
"description" : "Type of the reference"
}
}
},
"P31_Response_200" : {
"type" : "object",
"properties" : {
"products" : {
"type" : "array",
"description" : "Products list",
"items" : {
"$ref" : "#/components/schemas/P31_Response_200_Products"
}
}
}
},
"P31_Response_200_Products" : {
"type" : "object",
"properties" : {
"category_code" : {
"type" : "string",
"description" : "Product category code"
},
"category_label" : {
"type" : "string",
"description" : "Product category label"
},
"product_id" : {
"type" : "string",
"description" : "Product ID"
},
"product_id_type" : {
"type" : "string",
"description" : "Product ID type"
},
"product_sku" : {
"type" : "string",
"description" : "Product SKU"
},
"product_title" : {
"type" : "string",
"description" : "Product title"
}
}
},
"P42_Response_200" : {
"type" : "object",
"properties" : {
"conversion_options" : {
"$ref" : "#/components/schemas/P42_Response_200_ConversionOptions",
"description" : "Options used for the conversion"
},
"conversion_type" : {
"type" : "string",
"description" : "Type of conversion applied on products"
},
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Import creation date"
},
"has_error_report" : {
"type" : "boolean",
"description" : "Returns true if error report is available. Value is filled when the import status is COMPLETE."
},
"has_new_product_report" : {
"type" : "boolean",
"description" : "Returns true if new product report is available. Value is filled when the import status is COMPLETE."
},
"has_transformation_error_report" : {
"type" : "boolean",
"description" : "Returns true if transformation error report is available. Value is filled when the import status is SENT or COMPLETE."
},
"has_transformed_file" : {
"type" : "boolean",
"description" : "Returns true if transformed file is available. Value is filled when the import status is SENT or COMPLETE."
},
"import_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Import identifier"
},
"import_status" : {
"type" : "string",
"description" : "Import status"
},
"integration_details" : {
"$ref" : "#/components/schemas/P42_Response_200_IntegrationDetails",
"description" : "Integration details"
},
"reason_status" : {
"type" : "string",
"description" : "A message explaining the reason of the import status, if relevant"
},
"shop_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Shop identifier"
},
"transform_lines_in_error" : {
"type" : "integer",
"format" : "int64",
"description" : "Total count of transformed lines in error"
},
"transform_lines_in_success" : {
"type" : "integer",
"format" : "int64",
"description" : "Total count of transformed lines in success"
},
"transform_lines_read" : {
"type" : "integer",
"format" : "int64",
"description" : "Total count of transformed lines read"
},
"transform_lines_with_warning" : {
"type" : "integer",
"format" : "int64",
"description" : "Total count of transformed lines with warning"
}
}
},
"P42_Response_200_ConversionOptions" : {
"type" : "object",
"properties" : {
"ai_enrichment" : {
"$ref" : "#/components/schemas/P42_Response_200_ConversionOptions_AiEnrichment",
"description" : "Enable AI enrichment"
},
"ai_rewrite" : {
"$ref" : "#/components/schemas/P42_Response_200_ConversionOptions_AiRewrite",
"description" : "Enable AI rewrite"
},
"ai_translation" : {
"$ref" : "#/components/schemas/P42_Response_200_ConversionOptions_AiTranslation",
"description" : "Enable AI translation"
}
}
},
"P42_Response_200_ConversionOptions_AiEnrichment" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string"
}
}
},
"P42_Response_200_ConversionOptions_AiRewrite" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string"
}
}
},
"P42_Response_200_ConversionOptions_AiTranslation" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string"
}
}
},
"P42_Response_200_IntegrationDetails" : {
"type" : "object",
"properties" : {
"invalid_products" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of invalid products"
},
"products_not_accepted_in_time" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products that haven't been accepted in the required time"
},
"products_not_synchronized_in_time" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products that haven't been synchronized in the required time"
},
"products_reimported" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products that have been reimported in a more recent file"
},
"products_successfully_synchronized" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products successfully synchronized on operator system"
},
"products_with_synchronization_issues" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products having synchronization issues with operator system"
},
"products_with_wrong_identifiers" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products having wrong identifiers"
},
"rejected_products" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of rejected products by operator system"
}
}
},
"P51_Response_200" : {
"type" : "object",
"properties" : {
"product_import_trackings" : {
"type" : "array",
"description" : "List of product import status information",
"items" : {
"$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings"
}
},
"total_count" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of product import status information"
}
}
},
"P51_Response_200_ProductImportTrackings" : {
"type" : "object",
"properties" : {
"conversion_options" : {
"$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions",
"description" : "Options used for the conversion"
},
"conversion_type" : {
"type" : "string",
"description" : "Type of conversion applied on products"
},
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Import creation date"
},
"has_error_report" : {
"type" : "boolean",
"description" : "Returns true if error report is available. Value is filled when the import status is COMPLETE."
},
"has_new_product_report" : {
"type" : "boolean",
"description" : "Returns true if new product report is available. Value is filled when the import status is COMPLETE."
},
"has_transformation_error_report" : {
"type" : "boolean",
"description" : "Returns true if transformation error report is available. Value is filled when the import status is SENT or COMPLETE."
},
"has_transformed_file" : {
"type" : "boolean",
"description" : "Returns true if transformed file is available. Value is filled when the import status is SENT or COMPLETE."
},
"import_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Import identifier"
},
"import_status" : {
"type" : "string",
"description" : "Import status"
},
"integration_details" : {
"$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_IntegrationDetails",
"description" : "Integration details"
},
"reason_status" : {
"type" : "string",
"description" : "A message explaining the reason of the import status, if relevant"
},
"shop_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Shop identifier"
},
"transform_lines_in_error" : {
"type" : "integer",
"format" : "int64",
"description" : "Total count of transformed lines in error"
},
"transform_lines_in_success" : {
"type" : "integer",
"format" : "int64",
"description" : "Total count of transformed lines in success"
},
"transform_lines_read" : {
"type" : "integer",
"format" : "int64",
"description" : "Total count of transformed lines read"
},
"transform_lines_with_warning" : {
"type" : "integer",
"format" : "int64",
"description" : "Total count of transformed lines with warning"
}
}
},
"P51_Response_200_ProductImportTrackings_ConversionOptions" : {
"type" : "object",
"properties" : {
"ai_enrichment" : {
"$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiEnrichment",
"description" : "Enable AI enrichment"
},
"ai_rewrite" : {
"$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiRewrite",
"description" : "Enable AI rewrite"
},
"ai_translation" : {
"$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiTranslation",
"description" : "Enable AI translation"
}
}
},
"P51_Response_200_ProductImportTrackings_ConversionOptions_AiEnrichment" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string"
}
}
},
"P51_Response_200_ProductImportTrackings_ConversionOptions_AiRewrite" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string"
}
}
},
"P51_Response_200_ProductImportTrackings_ConversionOptions_AiTranslation" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string"
}
}
},
"P51_Response_200_ProductImportTrackings_IntegrationDetails" : {
"type" : "object",
"properties" : {
"invalid_products" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of invalid products"
},
"products_not_accepted_in_time" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products that haven't been accepted in the required time"
},
"products_not_synchronized_in_time" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products that haven't been synchronized in the required time"
},
"products_reimported" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products that have been reimported in a more recent file"
},
"products_successfully_synchronized" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products successfully synchronized on operator system"
},
"products_with_synchronization_issues" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products having synchronization issues with operator system"
},
"products_with_wrong_identifiers" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of products having wrong identifiers"
},
"rejected_products" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of rejected products by operator system"
}
}
},
"PC01_Response_200" : {
"type" : "object",
"properties" : {
"features" : {
"$ref" : "#/components/schemas/PC01_Response_200_Features",
"description" : "Features activated on the platform"
},
"modules" : {
"$ref" : "#/components/schemas/PC01_Response_200_Modules",
"description" : "Modules activated on the platform"
},
"platform_configuration" : {
"$ref" : "#/components/schemas/PC01_Response_200_PlatformConfiguration",
"description" : "High level platform configurations"
},
"platform_name" : {
"type" : "string",
"description" : "Operator platform name"
},
"tenant_name" : {
"type" : "string",
"description" : "Tenant platform name"
},
"timezone" : {
"type" : "string",
"description" : "Platform timezone"
}
}
},
"PC01_Response_200_Features" : {
"type" : "object",
"properties" : {
"catalog" : {
"$ref" : "#/components/schemas/PC01_Response_200_Features_Catalog",
"description" : "Catalog related features"
},
"circular_economy_data_collection" : {
"type" : "boolean",
"description" : "Allows operators to collect data related to the circular economy regulation"
},
"competitive_pricing_tool" : {
"type" : "boolean",
"description" : "The competitive pricing tool allows stores to view and possibly match competing Marketplace offers"
},
"direct_payment_customer_store" : {
"$ref" : "#/components/schemas/PC01_Response_200_Features_DirectPaymentCustomerStore",
"description" : "Allows transactions taking place outside of Mirakl between customers and sellers"
},
"disable_seller_alternative_carrier" : {
"type" : "boolean",
"description" : "Prevent stores from specifying alternatives carriers outside those predefined by the operator"
},
"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"
}
}
},
"PL11_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/PL11_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."
}
}
},
"PL11_Response_200_Data" : {
"type" : "object",
"properties" : {
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Picklist creation date"
},
"id" : {
"type" : "string",
"description" : "Picklist identifier"
},
"last_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Picklist last update date"
},
"order_lines" : {
"type" : "array",
"description" : "Picklist order line identifiers",
"items" : {
"$ref" : "#/components/schemas/PL11_Response_200_Data_OrderLines"
}
},
"picklist_lines" : {
"type" : "array",
"description" : "Picklist lines",
"items" : {
"$ref" : "#/components/schemas/PL11_Response_200_Data_PicklistLines"
}
},
"pickrun_code" : {
"type" : "string",
"description" : "Pickrun code"
},
"pickup_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Pickup date"
},
"shop_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Picklist shop identifier"
},
"state" : {
"type" : "string",
"description" : "Picklist state"
}
}
},
"PL11_Response_200_Data_OrderLines" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Picklist order line id"
}
}
},
"PL11_Response_200_Data_PicklistLines" : {
"type" : "object",
"properties" : {
"offer_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Identifier of the offer to pick"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity of offers to pick"
}
}
},
"PM11_Response_200" : {
"type" : "object",
"description" : "JSON output",
"properties" : {
"attributes" : {
"type" : "array",
"description" : "List of attributes",
"items" : {
"$ref" : "#/components/schemas/PM11_Response_200_Attributes"
}
}
}
},
"PM11_Response_200_Attributes" : {
"type" : "object",
"properties" : {
"channels" : {
"type" : "array",
"description" : "Channels",
"items" : {
"$ref" : "#/components/schemas/PM11_Response_200_Attributes_Channels"
}
},
"code" : {
"type" : "string",
"description" : "Attribute code"
},
"default_value" : {
"type" : "string",
"deprecated" : true,
"description" : "Default value for value list type attributes"
},
"description" : {
"type" : "string",
"description" : "Attribute description"
},
"description_translations" : {
"type" : "array",
"description" : "Translations of the attribute description",
"items" : {
"$ref" : "#/components/schemas/PM11_Response_200_Attributes_DescriptionTranslations"
}
},
"example" : {
"type" : "string",
"description" : "Attribute example to help sellers when they fill the product creation form"
},
"hierarchy_code" : {
"type" : "string",
"description" : "The code of the hierarchy (category) this attribute belongs to. If this field is empty, the attribute is shared among all hierarchies."
},
"label" : {
"type" : "string",
"description" : "Attribute label"
},
"label_translations" : {
"type" : "array",
"description" : "Translations of the attribute label",
"items" : {
"$ref" : "#/components/schemas/PM11_Response_200_Attributes_LabelTranslations"
}
},
"locale" : {
"type" : "string",
"description" : "Attribute localization.\n\nThe language format can either be:\n- ISO-639 (E.g. \"en\")\n- ISO-639_ISO-3166 (E.g. \"en_US\")\n"
},
"required" : {
"type" : "boolean",
"deprecated" : true,
"description" : "Whether or not the attribute is required"
},
"requirement_level" : {
"type" : "string",
"description" : "Requirement level of the attribute"
},
"roles" : {
"type" : "array",
"description" : "Attribute roles",
"items" : {
"$ref" : "#/components/schemas/PM11_Response_200_Attributes_Roles"
}
},
"transformations" : {
"type" : "string",
"description" : "Transformations applied to the attribute (a list of transformations separated by commas)"
},
"type" : {
"type" : "string",
"description" : "Attribute type"
},
"type_parameter" : {
"type" : "string",
"deprecated" : true,
"description" : "Type parameter"
},
"type_parameters" : {
"type" : "array",
"description" : "Specificities of the attribute type, for example the date format, or the maximum size of a media",
"items" : {
"$ref" : "#/components/schemas/PM11_Response_200_Attributes_TypeParameters"
}
},
"unique_code" : {
"type" : "string",
"description" : "Unique code of the attribute"
},
"validations" : {
"type" : "string",
"description" : "Validations applied to the attribute (a list of validations separated by commas)"
},
"values" : {
"type" : "array",
"deprecated" : true,
"description" : "A list of authorized values for this attribute",
"items" : {
"$ref" : "#/components/schemas/PM11_Response_200_Attributes_Values"
}
},
"values_list" : {
"type" : "string",
"deprecated" : true,
"description" : "This code points to the list defining the authorized values for this attribute."
},
"variant" : {
"type" : "boolean",
"description" : "Whether or not the attribute is a variation axis. Possible values: true or false"
}
}
},
"PM11_Response_200_Attributes_Channels" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Channel code"
}
}
},
"PM11_Response_200_Attributes_DescriptionTranslations" : {
"type" : "object",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Locale"
},
"value" : {
"type" : "string",
"description" : "Translation"
}
}
},
"PM11_Response_200_Attributes_LabelTranslations" : {
"type" : "object",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Locale"
},
"value" : {
"type" : "string",
"description" : "Translation"
}
}
},
"PM11_Response_200_Attributes_Roles" : {
"type" : "object",
"properties" : {
"parameters" : {
"type" : "array",
"description" : "Attribute role parameters",
"items" : {
"$ref" : "#/components/schemas/PM11_Response_200_Attributes_Roles_Parameters"
}
},
"type" : {
"type" : "string",
"description" : "Role type of the attribute"
}
}
},
"PM11_Response_200_Attributes_Roles_Parameters" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the parameter"
},
"value" : {
"type" : "string",
"description" : "Value of the parameter"
}
}
},
"PM11_Response_200_Attributes_TypeParameters" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the parameter"
},
"value" : {
"type" : "string",
"description" : "Value of the parameter"
}
}
},
"PM11_Response_200_Attributes_Values" : {
"type" : "object",
"deprecated" : true,
"properties" : {
"code" : {
"type" : "string",
"description" : "Value code"
}
}
},
"PR01_Response_200" : {
"type" : "object",
"properties" : {
"promotions" : {
"type" : "array",
"description" : "List of promotions",
"items" : {
"$ref" : "#/components/schemas/PR01_Response_200_Promotions"
}
},
"total_count" : {
"type" : "integer",
"format" : "int32"
}
}
},
"PR01_Response_200_Promotions" : {
"type" : "object",
"properties" : {
"amount_off" : {
"type" : "number",
"description" : "The amount off of the promotion. AMOUNT_OFF, null otherwise"
},
"application_to_cart" : {
"type" : "array",
"description" : "If applicable, returns promo code associated to the promotion",
"items" : {
"$ref" : "#/components/schemas/PR01_Response_200_Promotions_ApplicationToCart"
}
},
"campaign" : {
"$ref" : "#/components/schemas/PR01_Response_200_Promotions_Campaign",
"description" : "Campaign information, if applicable"
},
"channels" : {
"type" : "array",
"description" : "Channels on which the promotion is applied. If none, promotion applied on all channels",
"items" : {
"$ref" : "#/components/schemas/PR01_Response_200_Promotions_Channels"
}
},
"customer_group_ids" : {
"type" : "array",
"description" : "The customer groups on which the promotion is applied. If none, promotion applies to all customer groups.",
"items" : {
"type" : "string"
}
},
"customer_organization_ids" : {
"type" : "array",
"description" : "The customer organizations on which the promotion is applied. If none, promotion applies to all customer organizations.",
"items" : {
"type" : "string"
}
},
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Creation date of the promotion"
},
"end_date" : {
"type" : "string",
"format" : "date-time",
"description" : "End date of the promotion period of activity"
},
"free_items_quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "The free item target quantity of the promotion. FREE_ITEMS, null otherwise"
},
"internal_description" : {
"type" : "string",
"description" : "Internal description of the promotion, set by the shop"
},
"internal_id" : {
"type" : "string",
"description" : "Promotion identifier"
},
"last_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Last update date of the promotion"
},
"max_quantity_to_discount" : {
"type" : "integer",
"format" : "int32",
"description" : "Maximum quantity of items on which a percentage off discount applies. Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise"
},
"medias" : {
"type" : "array",
"description" : "The medias associated with this promotion, with the locales they apply to",
"items" : {
"$ref" : "#/components/schemas/PR01_Response_200_Promotions_Medias"
}
},
"percentage_off" : {
"type" : "number",
"description" : "The percentage off of the promotion. PERCENTAGE_OFF, null otherwise"
},
"public_descriptions" : {
"type" : "array",
"description" : "The public descriptions of the promotion, with the locales they apply to",
"items" : {
"$ref" : "#/components/schemas/PR01_Response_200_Promotions_PublicDescriptions"
}
},
"reduced_unit_price" : {
"type" : "number",
"description" : "The new offer’s unit price triggered by the promotion. REDUCED_UNIT_PRICE, null otherwise."
},
"reward_offer_ids" : {
"type" : "array",
"description" : "Offers used as reward in the promotion, according to the requested reward_offer_ids",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"reward_on_purchased_items" : {
"type" : "boolean",
"description" : "Specifies if the promotion's reward applies to purchased items or to a specific selection"
},
"start_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Start date of the promotion period of activity"
},
"state" : {
"type" : "string",
"description" : "Promotion state"
},
"trigger_offer_ids" : {
"type" : "array",
"description" : "Offers which trigger the promotion, according to the requested trigger_offer_ids",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"triggers" : {
"type" : "array",
"description" : "Triggers of the promotion",
"items" : {
"$ref" : "#/components/schemas/PR01_Response_200_Promotions_Triggers"
}
},
"type" : {
"type" : "string",
"description" : "Promotion type"
}
}
},
"PR01_Response_200_Promotions_ApplicationToCart" : {
"type" : "object",
"properties" : {
"promo_code" : {
"type" : "string",
"description" : "Promo code associated to the promotion"
}
}
},
"PR01_Response_200_Promotions_Campaign" : {
"type" : "object",
"properties" : {
"identifier" : {
"type" : "string",
"description" : "Identifier of the campaign"
}
}
},
"PR01_Response_200_Promotions_Channels" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Channel code"
},
"label" : {
"type" : "string",
"description" : "Channel label"
}
}
},
"PR01_Response_200_Promotions_Medias" : {
"type" : "object",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Media's locale"
},
"url" : {
"type" : "string",
"description" : "Url to download the media"
}
}
},
"PR01_Response_200_Promotions_PublicDescriptions" : {
"type" : "object",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Description's locale"
},
"value" : {
"type" : "string",
"description" : "The description itself"
}
}
},
"PR01_Response_200_Promotions_Triggers" : {
"type" : "object",
"properties" : {
"amount_purchased" : {
"type" : "number",
"description" : "Amount that triggers the promotion. Available for minimum_amount or every_amount type triggers."
},
"quantity_purchased" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity of items that triggers the promotion. Available for minimum_quantity or every_quantity type triggers."
},
"same_item_purchased" : {
"type" : "boolean",
"description" : "Whether the promotion requires the same item to be triggered or not. Available for minimum_quantity or every_quantity type triggers."
},
"type" : {
"type" : "string",
"description" : "Type of promotion trigger"
}
}
},
"PR03_Request" : {
"type" : "object",
"properties" : {
"application_to_cart" : {
"type" : "array",
"description" : "If applicable, promo code to associate to the promotion",
"items" : {
"$ref" : "#/components/schemas/PR03_Request_ApplicationToCart"
}
},
"channel_codes" : {
"type" : "array",
"description" : "Channels on which the promotion is applied. If none, promotion applied on all channels",
"items" : {
"type" : "string"
}
},
"customer_group_ids" : {
"type" : "array",
"description" : "The customer groups on which the promotion is applied. If none, promotion applies to all customer groups.",
"items" : {
"type" : "string"
}
},
"customer_organization_ids" : {
"type" : "array",
"description" : "The customer organizations on which the promotion is applied. If none, promotion applies to all customer organizations.",
"items" : {
"type" : "string"
}
},
"end_date" : {
"type" : "string",
"format" : "date-time",
"description" : "End date of the promotion period of activity"
},
"internal_description" : {
"type" : "string",
"description" : "Internal description of the promotion, set by the shop"
},
"internal_id" : {
"type" : "string",
"description" : "Promotion identifier"
},
"public_descriptions" : {
"type" : "array",
"description" : "The public descriptions of the promotion, with the locales they apply to",
"items" : {
"$ref" : "#/components/schemas/PR03_Request_PublicDescriptions"
}
},
"reward" : {
"$ref" : "#/components/schemas/PR03_Request_Reward",
"description" : "Defines the reward applied when promotion is triggered"
},
"start_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Start date of the promotion period of activity"
},
"trigger" : {
"$ref" : "#/components/schemas/PR03_Request_Trigger",
"description" : "Trigger of the promotion"
}
}
},
"PR03_Request_ApplicationToCart" : {
"type" : "object",
"description" : "If applicable, promo code to associate to the promotion",
"properties" : {
"promo_code" : {
"type" : "string",
"description" : "Promo code associated to the promotion"
}
}
},
"PR03_Request_PublicDescriptions" : {
"type" : "object",
"description" : "The public descriptions of the promotion, with the locales they apply to",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Description's locale"
},
"value" : {
"type" : "string",
"description" : "The description itself"
}
}
},
"PR03_Request_Reward" : {
"type" : "object",
"description" : "Defines the reward applied when promotion is triggered",
"discriminator" : {
"mapping" : {
"AMOUNT_OFF" : "#/components/schemas/PR03_Request_Reward_AmountOff",
"FREE_ITEMS" : "#/components/schemas/PR03_Request_Reward_FreeItems",
"PERCENTAGE_OFF" : "#/components/schemas/PR03_Request_Reward_PercentageOff",
"REDUCED_UNIT_PRICE" : "#/components/schemas/PR03_Request_Reward_ReducedUnitPrice"
},
"propertyName" : "type"
},
"properties" : {
"selection" : {
"$ref" : "#/components/schemas/PR03_Request_Reward_Selection",
"description" : "The product assortment receiving the reward"
},
"type" : {
"type" : "string",
"description" : "Type of promotion reward"
}
}
},
"PR03_Request_Reward_AmountOff" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Reward"
} ],
"properties" : {
"amount_off" : {
"type" : "number",
"description" : "The amount off of the promotion."
}
}
},
"PR03_Request_Reward_FreeItems" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Reward"
} ],
"properties" : {
"free_items_quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "The free item target quantity of the promotion."
}
}
},
"PR03_Request_Reward_PercentageOff" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Reward"
} ],
"properties" : {
"max_quantity_to_discount" : {
"type" : "integer",
"format" : "int32",
"description" : "Maximum quantity of items on which a percentage off discount applies."
},
"percentage_off" : {
"type" : "number",
"description" : "The percentage off of the promotion."
}
}
},
"PR03_Request_Reward_ReducedUnitPrice" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Reward"
} ],
"properties" : {
"max_quantity_to_discount" : {
"type" : "integer",
"format" : "int32",
"description" : "Maximum quantity of items on which a reduced unit price discount applies."
},
"reduced_unit_price" : {
"type" : "number",
"description" : "The new offer's unit price triggered by the promotion."
}
}
},
"PR03_Request_Reward_Selection" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"BRAND" : "#/components/schemas/PR03_Request_Reward_Selection_Brand",
"CATEGORY" : "#/components/schemas/PR03_Request_Reward_Selection_Category",
"OFFER" : "#/components/schemas/PR03_Request_Reward_Selection_Offer",
"PRODUCT" : "#/components/schemas/PR03_Request_Reward_Selection_Product",
"PURCHASED_ITEMS" : "#/components/schemas/PR03_Request_Reward_Selection_PurchasedItems"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : "The type of assortment selection for the reward"
}
}
},
"PR03_Request_Reward_Selection_Brand" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Reward_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR03_Request_Reward_Selection_Category" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Reward_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR03_Request_Reward_Selection_Offer" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Reward_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR03_Request_Reward_Selection_Product" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Reward_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"$ref" : "#/components/schemas/PR03_Request_Reward_Selection_Product_Values"
}
}
}
},
"PR03_Request_Reward_Selection_Product_Values" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Reference type (e.g., SKU, EAN, UPC)"
},
"value" : {
"type" : "string",
"description" : "Reference value"
}
}
},
"PR03_Request_Reward_Selection_PurchasedItems" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Reward_Selection"
} ]
},
"PR03_Request_Trigger" : {
"type" : "object",
"description" : "Trigger of the promotion",
"discriminator" : {
"mapping" : {
"EVERY_AMOUNT" : "#/components/schemas/PR03_Request_Trigger_EveryAmount",
"EVERY_QUANTITY" : "#/components/schemas/PR03_Request_Trigger_EveryQuantity",
"MINIMUM_AMOUNT" : "#/components/schemas/PR03_Request_Trigger_MinimumAmount",
"MINIMUM_QUANTITY" : "#/components/schemas/PR03_Request_Trigger_MinimumQuantity"
},
"propertyName" : "type"
},
"properties" : {
"selection" : {
"$ref" : "#/components/schemas/PR03_Request_Trigger_Selection",
"description" : "The product assortment triggering the promotion"
},
"type" : {
"type" : "string",
"description" : "Type of promotion trigger"
}
}
},
"PR03_Request_Trigger_EveryAmount" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Trigger"
} ],
"properties" : {
"amount_purchased" : {
"type" : "number",
"description" : "Amount that triggers the promotion. Available for minimum_amount or every_amount type triggers."
}
}
},
"PR03_Request_Trigger_EveryQuantity" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Trigger"
} ],
"properties" : {
"quantity_purchased" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity of items that triggers the promotion. Available for minimum_quantity or every_quantity type triggers."
},
"same_item_purchased" : {
"type" : "boolean",
"description" : "Whether the promotion requires the same item to be triggered or not. Available for minimum_quantity or every_quantity type triggers."
}
}
},
"PR03_Request_Trigger_MinimumAmount" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Trigger"
} ],
"properties" : {
"amount_purchased" : {
"type" : "number",
"description" : "Amount that triggers the promotion. Available for minimum_amount or every_amount type triggers."
}
}
},
"PR03_Request_Trigger_MinimumQuantity" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Trigger"
} ],
"properties" : {
"quantity_purchased" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity of items that triggers the promotion. Available for minimum_quantity or every_quantity type triggers."
},
"same_item_purchased" : {
"type" : "boolean",
"description" : "Whether the promotion requires the same item to be triggered or not. Available for minimum_quantity or every_quantity type triggers."
}
}
},
"PR03_Request_Trigger_Selection" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"ALL" : "#/components/schemas/PR03_Request_Trigger_Selection_All",
"BRAND" : "#/components/schemas/PR03_Request_Trigger_Selection_Brand",
"CATEGORY" : "#/components/schemas/PR03_Request_Trigger_Selection_Category",
"OFFER" : "#/components/schemas/PR03_Request_Trigger_Selection_Offer",
"PRODUCT" : "#/components/schemas/PR03_Request_Trigger_Selection_Product"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : "The type of assortment selection for the trigger"
}
}
},
"PR03_Request_Trigger_Selection_All" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Trigger_Selection"
} ]
},
"PR03_Request_Trigger_Selection_Brand" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Trigger_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR03_Request_Trigger_Selection_Category" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Trigger_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR03_Request_Trigger_Selection_Offer" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Trigger_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR03_Request_Trigger_Selection_Product" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR03_Request_Trigger_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"$ref" : "#/components/schemas/PR03_Request_Trigger_Selection_Product_Values"
}
}
}
},
"PR03_Request_Trigger_Selection_Product_Values" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Reference type (e.g., SKU, EAN, UPC)"
},
"value" : {
"type" : "string",
"description" : "Reference value"
}
}
},
"PR04_Request" : {
"type" : "object",
"properties" : {
"application_to_cart" : {
"type" : "array",
"description" : "If applicable, promo code associated to the promotion. Only editable if promotion is upcoming.",
"items" : {
"$ref" : "#/components/schemas/PR04_Request_ApplicationToCart"
}
},
"channel_codes" : {
"type" : "array",
"description" : "Channels on which the promotion is applied. If none, promotion applied on all channels",
"items" : {
"type" : "string"
}
},
"customer_group_ids" : {
"type" : "array",
"description" : "The customer groups on which the promotion is applied. If none, promotion applies to all customer groups.",
"items" : {
"type" : "string"
}
},
"customer_organization_ids" : {
"type" : "array",
"description" : "The customer organizations on which the promotion is applied. If none, promotion applies to all customer organizations.",
"items" : {
"type" : "string"
}
},
"end_date" : {
"type" : "string",
"format" : "date-time",
"description" : "End date of the promotion period of activity"
},
"internal_description" : {
"type" : "string",
"description" : "Internal description of the promotion, set by the shop"
},
"public_descriptions" : {
"type" : "array",
"description" : "The public descriptions of the promotion, with the locales they apply to",
"items" : {
"$ref" : "#/components/schemas/PR04_Request_PublicDescriptions"
}
},
"reward" : {
"$ref" : "#/components/schemas/PR04_Request_Reward",
"description" : "Defines the reward applied when promotion is triggered"
},
"start_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Start date of the promotion period of activity. Only editable if promotion is upcoming."
},
"trigger" : {
"$ref" : "#/components/schemas/PR04_Request_Trigger",
"description" : "Trigger of the promotion"
}
}
},
"PR04_Request_ApplicationToCart" : {
"type" : "object",
"description" : "If applicable, promo code associated to the promotion. Only editable if promotion is upcoming.",
"properties" : {
"promo_code" : {
"type" : "string",
"description" : "Promo code associated to the promotion"
}
}
},
"PR04_Request_PublicDescriptions" : {
"type" : "object",
"description" : "The public descriptions of the promotion, with the locales they apply to",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Description's locale"
},
"value" : {
"type" : "string",
"description" : "The description itself"
}
}
},
"PR04_Request_Reward" : {
"type" : "object",
"description" : "Defines the reward applied when promotion is triggered",
"properties" : {
"selection" : {
"$ref" : "#/components/schemas/PR04_Request_Reward_Selection",
"description" : "The product assortment receiving the reward"
}
}
},
"PR04_Request_Reward_Selection" : {
"type" : "object",
"description" : "The product assortment receiving the reward",
"discriminator" : {
"mapping" : {
"BRAND" : "#/components/schemas/PR04_Request_Reward_Selection_Brand",
"CATEGORY" : "#/components/schemas/PR04_Request_Reward_Selection_Category",
"OFFER" : "#/components/schemas/PR04_Request_Reward_Selection_Offer",
"PRODUCT" : "#/components/schemas/PR04_Request_Reward_Selection_Product",
"PURCHASED_ITEMS" : "#/components/schemas/PR04_Request_Reward_Selection_PurchasedItems"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : "The type of assortment selection for the reward"
}
}
},
"PR04_Request_Reward_Selection_Brand" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR04_Request_Reward_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR04_Request_Reward_Selection_Category" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR04_Request_Reward_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR04_Request_Reward_Selection_Offer" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR04_Request_Reward_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR04_Request_Reward_Selection_Product" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR04_Request_Reward_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"$ref" : "#/components/schemas/PR04_Request_Reward_Selection_Product_Values"
}
}
}
},
"PR04_Request_Reward_Selection_Product_Values" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Reference type (e.g., SKU, EAN, UPC)"
},
"value" : {
"type" : "string",
"description" : "Reference value"
}
}
},
"PR04_Request_Reward_Selection_PurchasedItems" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR04_Request_Reward_Selection"
} ]
},
"PR04_Request_Trigger" : {
"type" : "object",
"description" : "Trigger of the promotion",
"properties" : {
"selection" : {
"$ref" : "#/components/schemas/PR04_Request_Trigger_Selection",
"description" : "The product assortment triggering the promotion"
}
}
},
"PR04_Request_Trigger_Selection" : {
"type" : "object",
"description" : "The product assortment triggering the promotion",
"discriminator" : {
"mapping" : {
"ALL" : "#/components/schemas/PR04_Request_Trigger_Selection_All",
"BRAND" : "#/components/schemas/PR04_Request_Trigger_Selection_Brand",
"CATEGORY" : "#/components/schemas/PR04_Request_Trigger_Selection_Category",
"OFFER" : "#/components/schemas/PR04_Request_Trigger_Selection_Offer",
"PRODUCT" : "#/components/schemas/PR04_Request_Trigger_Selection_Product"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string",
"description" : "The type of assortment selection for the trigger"
}
}
},
"PR04_Request_Trigger_Selection_All" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR04_Request_Trigger_Selection"
} ]
},
"PR04_Request_Trigger_Selection_Brand" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR04_Request_Trigger_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR04_Request_Trigger_Selection_Category" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR04_Request_Trigger_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR04_Request_Trigger_Selection_Offer" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR04_Request_Trigger_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"type" : "string"
}
}
}
},
"PR04_Request_Trigger_Selection_Product" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/PR04_Request_Trigger_Selection"
} ],
"properties" : {
"values" : {
"type" : "array",
"description" : "The list of values corresponding to the assortment selection.",
"items" : {
"$ref" : "#/components/schemas/PR04_Request_Trigger_Selection_Product_Values"
}
}
}
},
"PR04_Request_Trigger_Selection_Product_Values" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Reference type (e.g., SKU, EAN, UPC)"
},
"value" : {
"type" : "string",
"description" : "Reference value"
}
}
},
"PRI01_Response_201" : {
"type" : "object",
"properties" : {
"import_id" : {
"type" : "string",
"description" : "Offer pricing import identifier"
}
}
},
"PRI02_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/PRI02_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."
}
}
},
"PRI02_Response_200_Data" : {
"type" : "object",
"properties" : {
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Import creation date"
},
"has_error_report" : {
"type" : "boolean",
"description" : "Indicate if an error report exists"
},
"import_id" : {
"type" : "string",
"description" : "Import ID"
},
"lines_in_error" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines in error"
},
"lines_in_success" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines in success"
},
"offers_in_error" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of offers in error"
},
"offers_updated" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of updated offers"
},
"origin" : {
"type" : "string",
"description" : "Import origin"
},
"reason_status" : {
"type" : "string",
"description" : "Import status reason"
},
"shop_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Shop identifier"
},
"status" : {
"type" : "string",
"description" : "Import status"
}
}
},
"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"
}
}
},
"RT01_Request" : {
"type" : "object",
"properties" : {
"returns" : {
"type" : "array",
"description" : "Returns list",
"items" : {
"$ref" : "#/components/schemas/RT01_Request_Returns"
},
"maxItems" : 200,
"minItems" : 1
}
}
},
"RT01_Request_Returns" : {
"type" : "object",
"description" : "Returns list",
"properties" : {
"accepted" : {
"type" : "boolean",
"description" : "If true, the return is automatically accepted after its creation. If false, the return cannot be accepted automatically. If empty, the returns configuration is taken into account to set the value."
},
"description" : {
"type" : "string",
"description" : "Description",
"maxLength" : 2000,
"minLength" : 0
},
"label_url" : {
"type" : "string",
"description" : "Label URL",
"maxLength" : 2000,
"minLength" : 1
},
"method_code" : {
"type" : "string",
"description" : "Return method code"
},
"order_commercial_id" : {
"type" : "string",
"description" : "Order commercial id"
},
"reason_code" : {
"type" : "string",
"description" : "Return reason code"
},
"return_lines" : {
"type" : "array",
"description" : "Return lines",
"items" : {
"$ref" : "#/components/schemas/RT01_Request_Returns_ReturnLines"
},
"maxItems" : 200,
"minItems" : 1
},
"rma" : {
"type" : "string",
"description" : "Return RMA",
"maxLength" : 100,
"minLength" : 1,
"pattern" : "[0-9a-zA-Z_-]+"
}
}
},
"RT01_Request_Returns_ReturnLines" : {
"type" : "object",
"description" : "Return lines",
"properties" : {
"order_line_id" : {
"type" : "string",
"description" : "Return order line id"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity to return",
"minimum" : 1
},
"reason_code" : {
"type" : "string",
"description" : "Return reason code."
}
}
},
"RT01_Response_200" : {
"type" : "object",
"properties" : {
"return_errors" : {
"type" : "array",
"description" : "Return creation errors",
"items" : {
"$ref" : "#/components/schemas/RT01_Response_200_ReturnErrors"
}
},
"return_success" : {
"type" : "array",
"description" : "Return creation success",
"items" : {
"$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess"
}
}
}
},
"RT01_Response_200_ReturnErrors" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"description" : "Return creation error message"
},
"order_commercial_id" : {
"type" : "string",
"description" : "Order commercial id of failed return creations"
}
}
},
"RT01_Response_200_ReturnSuccess" : {
"type" : "object",
"properties" : {
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Return creation date"
},
"description" : {
"type" : "string",
"description" : "Description"
},
"documents" : {
"type" : "array",
"description" : "Return documents",
"items" : {
"$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess_Documents"
}
},
"id" : {
"type" : "string",
"description" : "Return id"
},
"label_url" : {
"type" : "string",
"description" : "Label URL"
},
"last_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Return last updated date"
},
"method_code" : {
"type" : "string",
"description" : "Return method code"
},
"order_commercial_id" : {
"type" : "string",
"description" : "Order commercial id"
},
"order_id" : {
"type" : "string",
"description" : "Order id"
},
"reason_code" : {
"type" : "string",
"description" : "Return reason code"
},
"rejection_reason_code" : {
"type" : "string",
"description" : "Return rejection reason code"
},
"return_address" : {
"$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess_ReturnAddress",
"description" : "The address where items must be returned"
},
"return_lines" : {
"type" : "array",
"description" : "Return lines",
"items" : {
"$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess_ReturnLines"
}
},
"rma" : {
"type" : "string",
"description" : "Return RMA"
},
"state" : {
"type" : "string",
"description" : "Return state"
},
"tracking" : {
"$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess_Tracking",
"description" : "Return tracking details"
}
}
},
"RT01_Response_200_ReturnSuccess_Documents" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"description" : "Return document id"
},
"type" : {
"type" : "string",
"description" : "Return document type"
}
}
},
"RT01_Response_200_ReturnSuccess_ReturnAddress" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "City"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO code"
},
"state" : {
"type" : "string",
"description" : "State"
},
"street1" : {
"type" : "string",
"description" : "First line of the return address"
},
"street2" : {
"type" : "string",
"description" : "Second line of the return address"
},
"zip_code" : {
"type" : "string",
"description" : "Zip code"
}
}
},
"RT01_Response_200_ReturnSuccess_ReturnLines" : {
"type" : "object",
"properties" : {
"compliance" : {
"type" : "array",
"description" : "Compliance",
"items" : {
"$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess_ReturnLines_Compliance"
}
},
"order_line_id" : {
"type" : "string",
"description" : "Order line id"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity"
},
"reason_code" : {
"type" : "string",
"description" : "Return reason code for this line."
}
}
},
"RT01_Response_200_ReturnSuccess_ReturnLines_Compliance" : {
"type" : "object",
"properties" : {
"compliant" : {
"type" : "boolean",
"description" : "Compliant"
},
"non_compliance_additional_info" : {
"type" : "string",
"description" : "Non compliance additional info"
},
"non_compliance_reason_code" : {
"type" : "string",
"description" : "Non compliance reason code"
}
}
},
"RT01_Response_200_ReturnSuccess_Tracking" : {
"type" : "object",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "Carrier code"
},
"carrier_name" : {
"type" : "string",
"description" : "Carrier name"
},
"carrier_standard_code" : {
"type" : "string",
"description" : "Carrier standard code"
},
"tracking_number" : {
"type" : "string",
"description" : "Tracking number"
},
"tracking_url" : {
"type" : "string",
"description" : "Return tracking URL"
}
}
},
"RT04_Request" : {
"type" : "object",
"properties" : {
"returns" : {
"type" : "array",
"description" : "Returns to be updated, maximum number of returns per call: 100",
"items" : {
"$ref" : "#/components/schemas/RT04_Request_Returns"
},
"maxItems" : 100,
"minItems" : 1
}
}
},
"RT04_Request_Returns" : {
"type" : "object",
"description" : "Returns to be updated, maximum number of returns per call: 100",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id"
},
"label_url" : {
"type" : "string",
"description" : "Return label URL",
"maxLength" : 2000
},
"method_code" : {
"type" : "string",
"description" : "Return method code. Can be provided only when the setting Allow store accounts to update the return method before acceptance is enabled."
},
"return_address" : {
"$ref" : "#/components/schemas/RT04_Request_Returns_ReturnAddress",
"description" : "The address where items must be returned"
},
"rma" : {
"type" : "string",
"description" : "Return RMA"
},
"tracking" : {
"$ref" : "#/components/schemas/RT04_Request_Returns_Tracking",
"description" : "Tracking information"
}
}
},
"RT04_Request_Returns_ReturnAddress" : {
"type" : "object",
"description" : "The address where items must be returned",
"properties" : {
"address" : {
"$ref" : "#/components/schemas/RT04_Request_Returns_ReturnAddress_Address",
"description" : "The return address details"
}
}
},
"RT04_Request_Returns_ReturnAddress_Address" : {
"type" : "object",
"description" : "The return address details",
"properties" : {
"city" : {
"type" : "string",
"description" : "City",
"maxLength" : 255,
"minLength" : 0
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO code"
},
"state" : {
"type" : "string",
"description" : "State",
"maxLength" : 255,
"minLength" : 0
},
"street1" : {
"type" : "string",
"description" : "First line of the return address",
"maxLength" : 255,
"minLength" : 0
},
"street2" : {
"type" : "string",
"description" : "Second line of the return address",
"maxLength" : 255,
"minLength" : 0
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code, mandatory except for: Bahrain, Chile, Egypt, Hong-Kong, Kuwait, Oman, Peru, Qatar, Saudi Arabia, United Arab Emirates or Uruguay",
"maxLength" : 255,
"minLength" : 0
}
}
},
"RT04_Request_Returns_Tracking" : {
"type" : "object",
"description" : "Tracking information",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "Carrier Code"
},
"carrier_name" : {
"type" : "string",
"description" : "Carrier name"
},
"carrier_standard_code" : {
"type" : "string",
"description" : "Carrier Standard Code"
},
"tracking_number" : {
"type" : "string",
"description" : "Tracking number"
},
"tracking_url" : {
"type" : "string",
"description" : "Url tracking",
"maxLength" : 2000
}
}
},
"RT04_Response_200" : {
"type" : "object",
"properties" : {
"return_errors" : {
"type" : "array",
"description" : "Returns update errors",
"items" : {
"$ref" : "#/components/schemas/RT04_Response_200_ReturnErrors"
}
},
"return_success" : {
"type" : "array",
"description" : "Returns update success",
"items" : {
"$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess"
}
}
}
},
"RT04_Response_200_ReturnErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"RT04_Response_200_ReturnSuccess" : {
"type" : "object",
"properties" : {
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Return creation date"
},
"description" : {
"type" : "string",
"description" : "Description"
},
"documents" : {
"type" : "array",
"description" : "Return documents",
"items" : {
"$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess_Documents"
}
},
"id" : {
"type" : "string",
"description" : "Return id"
},
"label_url" : {
"type" : "string",
"description" : "Label URL"
},
"last_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Return last updated date"
},
"method_code" : {
"type" : "string",
"description" : "Return method code"
},
"order_commercial_id" : {
"type" : "string",
"description" : "Order commercial id"
},
"order_id" : {
"type" : "string",
"description" : "Order id"
},
"reason_code" : {
"type" : "string",
"description" : "Return reason code"
},
"rejection_reason_code" : {
"type" : "string",
"description" : "Return rejection reason code"
},
"return_address" : {
"$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess_ReturnAddress",
"description" : "The address where items must be returned"
},
"return_lines" : {
"type" : "array",
"description" : "Return lines",
"items" : {
"$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess_ReturnLines"
}
},
"rma" : {
"type" : "string",
"description" : "Return RMA"
},
"state" : {
"type" : "string",
"description" : "Return state"
},
"tracking" : {
"$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess_Tracking",
"description" : "Return tracking details"
}
}
},
"RT04_Response_200_ReturnSuccess_Documents" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"description" : "Return document id"
},
"type" : {
"type" : "string",
"description" : "Return document type"
}
}
},
"RT04_Response_200_ReturnSuccess_ReturnAddress" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "City"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO code"
},
"state" : {
"type" : "string",
"description" : "State"
},
"street1" : {
"type" : "string",
"description" : "First line of the return address"
},
"street2" : {
"type" : "string",
"description" : "Second line of the return address"
},
"zip_code" : {
"type" : "string",
"description" : "Zip code"
}
}
},
"RT04_Response_200_ReturnSuccess_ReturnLines" : {
"type" : "object",
"properties" : {
"compliance" : {
"type" : "array",
"description" : "Compliance",
"items" : {
"$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess_ReturnLines_Compliance"
}
},
"order_line_id" : {
"type" : "string",
"description" : "Order line id"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity"
},
"reason_code" : {
"type" : "string",
"description" : "Return reason code for this line."
}
}
},
"RT04_Response_200_ReturnSuccess_ReturnLines_Compliance" : {
"type" : "object",
"properties" : {
"compliant" : {
"type" : "boolean",
"description" : "Compliant"
},
"non_compliance_additional_info" : {
"type" : "string",
"description" : "Non compliance additional info"
},
"non_compliance_reason_code" : {
"type" : "string",
"description" : "Non compliance reason code"
}
}
},
"RT04_Response_200_ReturnSuccess_Tracking" : {
"type" : "object",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "Carrier code"
},
"carrier_name" : {
"type" : "string",
"description" : "Carrier name"
},
"carrier_standard_code" : {
"type" : "string",
"description" : "Carrier standard code"
},
"tracking_number" : {
"type" : "string",
"description" : "Tracking number"
},
"tracking_url" : {
"type" : "string",
"description" : "Return tracking URL"
}
}
},
"RT11_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/RT11_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."
}
}
},
"RT11_Response_200_Data" : {
"type" : "object",
"properties" : {
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Return creation date"
},
"description" : {
"type" : "string",
"description" : "Description"
},
"documents" : {
"type" : "array",
"description" : "Return documents",
"items" : {
"$ref" : "#/components/schemas/RT11_Response_200_Data_Documents"
}
},
"id" : {
"type" : "string",
"description" : "Return id"
},
"label_url" : {
"type" : "string",
"description" : "Label URL"
},
"last_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Return last updated date"
},
"method_code" : {
"type" : "string",
"description" : "Return method code"
},
"order_commercial_id" : {
"type" : "string",
"description" : "Order commercial id"
},
"order_id" : {
"type" : "string",
"description" : "Order id"
},
"reason_code" : {
"type" : "string",
"description" : "Return reason code"
},
"rejection_reason_code" : {
"type" : "string",
"description" : "Return rejection reason code"
},
"return_address" : {
"$ref" : "#/components/schemas/RT11_Response_200_Data_ReturnAddress",
"description" : "The address where items must be returned"
},
"return_lines" : {
"type" : "array",
"description" : "Return lines",
"items" : {
"$ref" : "#/components/schemas/RT11_Response_200_Data_ReturnLines"
}
},
"rma" : {
"type" : "string",
"description" : "Return RMA"
},
"state" : {
"type" : "string",
"description" : "Return state"
},
"tracking" : {
"$ref" : "#/components/schemas/RT11_Response_200_Data_Tracking",
"description" : "Return tracking details"
}
}
},
"RT11_Response_200_Data_Documents" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"description" : "Return document id"
},
"type" : {
"type" : "string",
"description" : "Return document type"
}
}
},
"RT11_Response_200_Data_ReturnAddress" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "City"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO code"
},
"state" : {
"type" : "string",
"description" : "State"
},
"street1" : {
"type" : "string",
"description" : "First line of the return address"
},
"street2" : {
"type" : "string",
"description" : "Second line of the return address"
},
"zip_code" : {
"type" : "string",
"description" : "Zip code"
}
}
},
"RT11_Response_200_Data_ReturnLines" : {
"type" : "object",
"properties" : {
"compliance" : {
"type" : "array",
"description" : "Compliance",
"items" : {
"$ref" : "#/components/schemas/RT11_Response_200_Data_ReturnLines_Compliance"
}
},
"order_line_id" : {
"type" : "string",
"description" : "Order line id"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity"
},
"reason_code" : {
"type" : "string",
"description" : "Return reason code for this line."
}
}
},
"RT11_Response_200_Data_ReturnLines_Compliance" : {
"type" : "object",
"properties" : {
"compliant" : {
"type" : "boolean",
"description" : "Compliant"
},
"non_compliance_additional_info" : {
"type" : "string",
"description" : "Non compliance additional info"
},
"non_compliance_reason_code" : {
"type" : "string",
"description" : "Non compliance reason code"
}
}
},
"RT11_Response_200_Data_Tracking" : {
"type" : "object",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "Carrier code"
},
"carrier_name" : {
"type" : "string",
"description" : "Carrier name"
},
"carrier_standard_code" : {
"type" : "string",
"description" : "Carrier standard code"
},
"tracking_number" : {
"type" : "string",
"description" : "Tracking number"
},
"tracking_url" : {
"type" : "string",
"description" : "Return tracking URL"
}
}
},
"RT12_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/RT12_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."
}
}
},
"RT12_Response_200_Data" : {
"type" : "object",
"properties" : {
"available_return_methods" : {
"type" : "array",
"description" : "Available return methods to return items",
"items" : {
"type" : "string"
}
},
"available_return_reasons" : {
"type" : "array",
"description" : "Available return reasons to return items",
"items" : {
"type" : "string"
}
},
"order_commercial_id" : {
"type" : "string",
"description" : "Order commercial id"
},
"order_line_id" : {
"type" : "string",
"description" : "Order line id"
},
"return_window" : {
"type" : "integer",
"format" : "int32",
"description" : "Items must be returned during the return window"
},
"return_window_end_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Return window end date for the items of the order line"
},
"return_window_start_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Return window start date for the items of the order line"
},
"returnable_quantity" : {
"type" : "integer",
"format" : "int64",
"description" : "Item quantity available to be returned"
}
}
},
"RT21_Request" : {
"type" : "object",
"properties" : {
"returns" : {
"type" : "array",
"description" : "Returns to be accepted, maximum number of returns per call: 100",
"items" : {
"$ref" : "#/components/schemas/RT21_Request_Returns"
},
"maxItems" : 100,
"minItems" : 1
}
}
},
"RT21_Request_Returns" : {
"type" : "object",
"description" : "Returns to be accepted, maximum number of returns per call: 100",
"properties" : {
"accepted" : {
"type" : "boolean",
"description" : "Boolean indicating if the return is accepted or refused"
},
"id" : {
"type" : "string",
"description" : "Return id"
},
"rejection_reason_code" : {
"type" : "string",
"description" : "Return rejection reason code"
}
}
},
"RT21_Response_200" : {
"type" : "object",
"properties" : {
"return_errors" : {
"type" : "array",
"description" : "Returns update errors",
"items" : {
"$ref" : "#/components/schemas/RT21_Response_200_ReturnErrors"
}
},
"return_success" : {
"type" : "array",
"description" : "Returns update success",
"items" : {
"$ref" : "#/components/schemas/RT21_Response_200_ReturnSuccess"
}
}
}
},
"RT21_Response_200_ReturnErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"RT21_Response_200_ReturnSuccess" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id, must be a valid UUID",
"maxLength" : 36,
"minLength" : 0
}
}
},
"RT25_Request" : {
"type" : "object",
"properties" : {
"returns" : {
"type" : "array",
"description" : "Return ids",
"items" : {
"$ref" : "#/components/schemas/RT25_Request_Returns"
},
"maxItems" : 100,
"minItems" : 1
}
}
},
"RT25_Request_Returns" : {
"type" : "object",
"description" : "Return ids",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id, must be a valid UUID",
"maxLength" : 36,
"minLength" : 0
}
}
},
"RT25_Response_200" : {
"type" : "object",
"properties" : {
"return_errors" : {
"type" : "array",
"description" : "Returns update errors",
"items" : {
"$ref" : "#/components/schemas/RT25_Response_200_ReturnErrors"
}
},
"return_success" : {
"type" : "array",
"description" : "Returns update success",
"items" : {
"$ref" : "#/components/schemas/RT25_Response_200_ReturnSuccess"
}
}
}
},
"RT25_Response_200_ReturnErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"RT25_Response_200_ReturnSuccess" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id, must be a valid UUID",
"maxLength" : 36,
"minLength" : 0
}
}
},
"RT26_Request" : {
"type" : "object",
"properties" : {
"returns" : {
"type" : "array",
"description" : "Mark returns as compliant or non-compliant, maximum number of returns per call: 100",
"items" : {
"$ref" : "#/components/schemas/RT26_Request_Returns"
},
"maxItems" : 100,
"minItems" : 1
}
}
},
"RT26_Request_Returns" : {
"type" : "object",
"description" : "Mark returns as compliant or non-compliant, maximum number of returns per call: 100",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id"
},
"return_lines" : {
"type" : "array",
"description" : "Return lines",
"items" : {
"$ref" : "#/components/schemas/RT26_Request_Returns_ReturnLines"
},
"maxItems" : 200,
"minItems" : 1
}
}
},
"RT26_Request_Returns_ReturnLines" : {
"type" : "object",
"description" : "Return lines",
"properties" : {
"compliant" : {
"type" : "boolean",
"description" : "Compliant"
},
"non_compliance_additional_info" : {
"type" : "string",
"description" : "Non-compliance additional information",
"maxLength" : 2000,
"minLength" : 0
},
"non_compliance_reason_code" : {
"type" : "string",
"description" : "Non-compliance reason code"
},
"order_line_id" : {
"type" : "string",
"description" : "Order line id"
}
}
},
"RT26_Response_200" : {
"type" : "object",
"properties" : {
"return_errors" : {
"type" : "array",
"description" : "Returns update errors",
"items" : {
"$ref" : "#/components/schemas/RT26_Response_200_ReturnErrors"
}
},
"return_success" : {
"type" : "array",
"description" : "Returns update success",
"items" : {
"$ref" : "#/components/schemas/RT26_Response_200_ReturnSuccess"
}
}
}
},
"RT26_Response_200_ReturnErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"RT26_Response_200_ReturnSuccess" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id, must be a valid UUID",
"maxLength" : 36,
"minLength" : 0
}
}
},
"RT27_Request" : {
"type" : "object",
"properties" : {
"returns" : {
"type" : "array",
"description" : "Return ids",
"items" : {
"$ref" : "#/components/schemas/RT27_Request_Returns"
},
"maxItems" : 100,
"minItems" : 1
}
}
},
"RT27_Request_Returns" : {
"type" : "object",
"description" : "Return ids",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id, must be a valid UUID",
"maxLength" : 36,
"minLength" : 0
}
}
},
"RT27_Response_200" : {
"type" : "object",
"properties" : {
"return_errors" : {
"type" : "array",
"description" : "Returns update errors",
"items" : {
"$ref" : "#/components/schemas/RT27_Response_200_ReturnErrors"
}
},
"return_success" : {
"type" : "array",
"description" : "Returns update success",
"items" : {
"$ref" : "#/components/schemas/RT27_Response_200_ReturnSuccess"
}
}
}
},
"RT27_Response_200_ReturnErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"RT27_Response_200_ReturnSuccess" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id, must be a valid UUID",
"maxLength" : 36,
"minLength" : 0
}
}
},
"RT29_Request" : {
"type" : "object",
"properties" : {
"returns" : {
"type" : "array",
"description" : "Return ids",
"items" : {
"$ref" : "#/components/schemas/RT29_Request_Returns"
},
"maxItems" : 100,
"minItems" : 1
}
}
},
"RT29_Request_Returns" : {
"type" : "object",
"description" : "Return ids",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id, must be a valid UUID",
"maxLength" : 36,
"minLength" : 0
}
}
},
"RT29_Response_200" : {
"type" : "object",
"properties" : {
"return_errors" : {
"type" : "array",
"description" : "Returns update errors",
"items" : {
"$ref" : "#/components/schemas/RT29_Response_200_ReturnErrors"
}
},
"return_success" : {
"type" : "array",
"description" : "Returns update success",
"items" : {
"$ref" : "#/components/schemas/RT29_Response_200_ReturnSuccess"
}
}
}
},
"RT29_Response_200_ReturnErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"RT29_Response_200_ReturnSuccess" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Return id, must be a valid UUID",
"maxLength" : 36,
"minLength" : 0
}
}
},
"RT51_Request" : {
"type" : "object",
"properties" : {
"return_labels" : {
"type" : "array",
"description" : "Returns list",
"items" : {
"$ref" : "#/components/schemas/RT51_Request_ReturnLabels"
},
"maxItems" : 200,
"minItems" : 0
}
}
},
"RT51_Request_ReturnLabels" : {
"type" : "object",
"description" : "Returns list",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "Carrier code to be used to generate the label. Required if no label_selection_mode is provided."
},
"carrier_service_code" : {
"type" : "string",
"description" : "Specific code of the service to be used for a given carrier. If not provided, the default service of the carrier will be used. carrier_code needs to be provided in order to use this field."
},
"label_options" : {
"$ref" : "#/components/schemas/RT51_Request_ReturnLabels_LabelOptions",
"description" : "Specific options applying on label generation"
},
"label_selection_mode" : {
"type" : "string",
"description" : "Indicate whether an automatic selection of a label should be made. Required if no carrier_code is provided. If no carrier code is provided, the requested option from all connected carriers will be selected. If a carrier code is provided, the requested option for the specified carrier will be selected."
},
"package" : {
"$ref" : "#/components/schemas/RT51_Request_ReturnLabels_Package",
"description" : "Details of the package containing the returned items"
},
"return_id" : {
"type" : "string",
"description" : "Return ID"
},
"shipping_from" : {
"$ref" : "#/components/schemas/RT51_Request_ReturnLabels_ShippingFrom",
"description" : "Custom pickup address for the return (e.g. store address for in-store returns). If not provided, the initial shipping address of the related order will be used."
}
}
},
"RT51_Request_ReturnLabels_LabelOptions" : {
"type" : "object",
"description" : "Specific options applying on label generation",
"properties" : {
"qr_code" : {
"type" : "boolean",
"description" : "Whether to generate a QR code alongside the PDF label. Default false"
}
}
},
"RT51_Request_ReturnLabels_Package" : {
"type" : "object",
"description" : "Details of the package containing the returned items",
"properties" : {
"dimensions" : {
"$ref" : "#/components/schemas/RT51_Request_ReturnLabels_Package_Dimensions",
"description" : "Physical dimensions of the package"
},
"weight" : {
"$ref" : "#/components/schemas/RT51_Request_ReturnLabels_Package_Weight",
"description" : "Weight of the package"
}
}
},
"RT51_Request_ReturnLabels_Package_Dimensions" : {
"type" : "object",
"description" : "Physical dimensions of the package",
"properties" : {
"height" : {
"type" : "number",
"description" : "package height",
"minimum" : 0
},
"length" : {
"type" : "number",
"description" : "package length",
"minimum" : 0
},
"unit" : {
"type" : "string",
"description" : "Dimension unit",
"pattern" : "^(in|cm)$"
},
"width" : {
"type" : "number",
"description" : "package width",
"minimum" : 0
}
}
},
"RT51_Request_ReturnLabels_Package_Weight" : {
"type" : "object",
"description" : "Weight of the package",
"properties" : {
"unit" : {
"type" : "string",
"description" : "Weight unit",
"pattern" : "^(lb|kg)$"
},
"value" : {
"type" : "number",
"description" : "Numeric weight value",
"minimum" : 0
}
}
},
"RT51_Request_ReturnLabels_ShippingFrom" : {
"type" : "object",
"description" : "Custom pickup address for the return (e.g. store address for in-store returns). If not provided, the initial shipping address of the related order will be used.",
"properties" : {
"city" : {
"type" : "string",
"description" : "City"
},
"contact_name" : {
"type" : "string",
"description" : "Contact name"
},
"contact_phone" : {
"type" : "string",
"description" : "Contact phone"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO code"
},
"state" : {
"type" : "string",
"description" : "State"
},
"street_1" : {
"type" : "string",
"description" : "First line of the address"
},
"street_2" : {
"type" : "string",
"description" : "Second line of the address"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code, mandatory except for: Bahrain, Chile, Egypt, Hong-Kong, Kuwait, Oman, Peru, Qatar, Saudi Arabia, United Arab Emirates or Uruguay"
}
}
},
"RT51_Response_200" : {
"type" : "object",
"properties" : {
"return_label_errors" : {
"type" : "array",
"description" : "Returns for which label creation failed, with per-item error messages",
"items" : {
"$ref" : "#/components/schemas/RT51_Response_200_ReturnLabelErrors"
}
},
"return_label_successes" : {
"type" : "array",
"description" : "Returns for which a label was successfully created",
"items" : {
"$ref" : "#/components/schemas/RT51_Response_200_ReturnLabelSuccesses"
}
}
}
},
"RT51_Response_200_ReturnLabelErrors" : {
"type" : "object",
"properties" : {
"error_message" : {
"type" : "string",
"description" : "Error description"
},
"return_id" : {
"type" : "string",
"description" : "Return ID"
}
}
},
"RT51_Response_200_ReturnLabelSuccesses" : {
"type" : "object",
"properties" : {
"return_id" : {
"type" : "string",
"description" : "Return ID"
}
}
},
"RT52_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/RT52_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."
}
}
},
"RT52_Response_200_Data" : {
"type" : "object",
"properties" : {
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Return label creation date"
},
"errors" : {
"type" : "array",
"description" : "Specific information related to the state of the label. Available only when label_state is FAILED",
"items" : {
"$ref" : "#/components/schemas/RT52_Response_200_Data_Errors"
}
},
"estimated_cost" : {
"$ref" : "#/components/schemas/RT52_Response_200_Data_EstimatedCost",
"description" : "Estimated cost of the label from the carrier"
},
"files" : {
"$ref" : "#/components/schemas/RT52_Response_200_Data_Files",
"description" : "Container for label file(s)"
},
"label_state" : {
"type" : "string",
"description" : "Current state of the label"
},
"last_updated" : {
"type" : "string",
"format" : "date-time",
"description" : "Return label last updated date"
},
"return_id" : {
"type" : "string",
"description" : "Return ID"
},
"tracking" : {
"$ref" : "#/components/schemas/RT52_Response_200_Data_Tracking",
"description" : "Return label tracking details"
}
}
},
"RT52_Response_200_Data_Errors" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Code of the error"
},
"message" : {
"type" : "string",
"description" : "Message of the error"
}
}
},
"RT52_Response_200_Data_EstimatedCost" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Label cost amount"
},
"currency_iso_code" : {
"type" : "string",
"description" : "Label currency (iso format)"
}
}
},
"RT52_Response_200_Data_Files" : {
"type" : "object",
"properties" : {
"label" : {
"$ref" : "#/components/schemas/RT52_Response_200_Data_Files_Label",
"description" : "Label file"
},
"qr_code" : {
"$ref" : "#/components/schemas/RT52_Response_200_Data_Files_QrCode",
"description" : "QR code file"
}
}
},
"RT52_Response_200_Data_Files_Label" : {
"type" : "object",
"properties" : {
"file_type" : {
"type" : "string",
"description" : "File format"
},
"url" : {
"type" : "string",
"description" : "Download URL"
}
}
},
"RT52_Response_200_Data_Files_QrCode" : {
"type" : "object",
"properties" : {
"file_type" : {
"type" : "string",
"description" : "File format"
},
"url" : {
"type" : "string",
"description" : "Download URL"
}
}
},
"RT52_Response_200_Data_Tracking" : {
"type" : "object",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "Code of a carrier"
},
"carrier_name" : {
"type" : "string",
"description" : "Name of a carrier"
},
"carrier_service_code" : {
"type" : "string",
"description" : "Carrier’s service code used to generate the label"
},
"carrier_standard_code" : {
"type" : "string",
"description" : "Standard code of a carrier based on Mirakl carrier referential"
},
"tracking_number" : {
"type" : "string",
"description" : "Tracking number"
},
"tracking_url" : {
"type" : "string",
"description" : "Tracking url of a carrier"
}
}
},
"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)"
}
}
},
"SH11_Response_200" : {
"type" : "object",
"properties" : {
"shipping_zones" : {
"type" : "array",
"description" : "List of shipping zones",
"items" : {
"$ref" : "#/components/schemas/SH11_Response_200_ShippingZones"
}
}
}
},
"SH11_Response_200_ShippingZones" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Shipping zone code"
},
"description" : {
"type" : "string",
"description" : "Shipping zone description"
},
"label" : {
"type" : "string",
"description" : "Shipping zone label"
}
}
},
"SH12_Response_200" : {
"type" : "object",
"properties" : {
"shipping_types" : {
"type" : "array",
"description" : "List of shipping types",
"items" : {
"$ref" : "#/components/schemas/SH12_Response_200_ShippingTypes"
}
}
}
},
"SH12_Response_200_ShippingTypes" : {
"type" : "object",
"properties" : {
"click_and_collect" : {
"type" : "boolean",
"description" : "Shipping type corresponds to “click&collect”"
},
"code" : {
"type" : "string",
"description" : "Shipping type code"
},
"delivery_by_operator" : {
"type" : "boolean",
"description" : "Shipping type is managed by operator on behalf of shops"
},
"description" : {
"type" : "string",
"description" : "Shipping type description"
},
"ignore_lead_time_to_ship" : {
"type" : "boolean",
"description" : "When true, the lead time to ship is ignored for shipping deadline computation"
},
"label" : {
"type" : "string",
"description" : "Shipping type label"
},
"mandatory_tracking" : {
"type" : "boolean",
"description" : "Shops must provide tracking details before confirming shipment for a given shipping type"
},
"standard_code" : {
"type" : "string",
"description" : "Shipping type standard code"
}
}
},
"SH21_Response_200" : {
"type" : "object",
"properties" : {
"carriers" : {
"type" : "array",
"description" : "List of carriers",
"items" : {
"$ref" : "#/components/schemas/SH21_Response_200_Carriers"
}
}
}
},
"SH21_Response_200_Carriers" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Carrier code"
},
"label" : {
"type" : "string",
"description" : "Carrier label"
},
"standard_code" : {
"type" : "string",
"description" : "Carrier standard code"
},
"tracking_url" : {
"type" : "string",
"description" : "Carrier tracking URL"
}
}
},
"SH31_Response_200" : {
"type" : "object",
"properties" : {
"logistic_classes" : {
"type" : "array",
"description" : "List of logistic classes",
"items" : {
"$ref" : "#/components/schemas/SH31_Response_200_LogisticClasses"
}
}
}
},
"SH31_Response_200_LogisticClasses" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Logistic class code"
},
"description" : {
"type" : "string",
"description" : "Logistic class description"
},
"label" : {
"type" : "string",
"description" : "Logistic class label"
}
}
},
"SH42_Response_200" : {
"type" : "object",
"description" : "Seller shop shipping configuration",
"properties" : {
"delivery_times" : {
"type" : "array",
"description" : "Delivery time configurations per shipping type and zone",
"items" : {
"$ref" : "#/components/schemas/SH42_Response_200_DeliveryTimes"
}
},
"last_updated_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Date of last shipping configuration update"
},
"lead_time_to_ship" : {
"$ref" : "#/components/schemas/SH42_Response_200_LeadTimeToShip",
"description" : "Lead time to ship configuration"
},
"order_cut_off_times" : {
"type" : "array",
"description" : "Order cut-off time configurations per shipping type",
"items" : {
"$ref" : "#/components/schemas/SH42_Response_200_OrderCutOffTimes"
}
},
"order_free_shipping" : {
"type" : "boolean",
"description" : "Whether free shipping is enabled for all orders"
},
"shipping_paid_by_operator" : {
"type" : "boolean",
"description" : "Whether the operator collects shipping charges on behalf of the shops"
},
"shop_id" : {
"type" : "string",
"description" : "Shop identifier"
}
}
},
"SH42_Response_200_DeliveryTimes" : {
"type" : "object",
"description" : "Delivery time entry for a shipping type and zone",
"properties" : {
"delivery_time" : {
"$ref" : "#/components/schemas/SH42_Response_200_DeliveryTimes_DeliveryTime",
"description" : "Delivery time range in days"
},
"set_by" : {
"type" : "string",
"description" : "Whether the delivery time was set by the shop or the operator"
},
"shipping_type_code" : {
"type" : "string",
"description" : "Shipping type code"
},
"shipping_zone_code" : {
"type" : "string",
"description" : "Shipping zone code"
}
}
},
"SH42_Response_200_DeliveryTimes_DeliveryTime" : {
"type" : "object",
"description" : "Delivery time range configuration",
"properties" : {
"earliest_days" : {
"type" : "integer",
"format" : "int32",
"description" : "Minimum number of delivery days"
},
"latest_days" : {
"type" : "integer",
"format" : "int32",
"description" : "Maximum number of delivery days"
}
}
},
"SH42_Response_200_LeadTimeToShip" : {
"type" : "object",
"description" : "Lead time to ship configuration",
"properties" : {
"default_value" : {
"type" : "integer",
"format" : "int32",
"description" : "Platform default lead time to ship in days"
},
"shop_value" : {
"type" : "integer",
"format" : "int32",
"description" : "Shop-specific lead time to ship in days"
}
}
},
"SH42_Response_200_OrderCutOffTimes" : {
"type" : "object",
"description" : "Seller order cut-off time entry for a shipping type",
"properties" : {
"cut_off_time" : {
"type" : "string",
"description" : "Order cut-off time"
},
"is_required" : {
"type" : "boolean",
"description" : "Whether the cut-off time configuration is mandatory for the shop"
},
"set_by" : {
"type" : "string",
"description" : "Whether the cut-off time was set by the shop, the operator, or is not needed"
},
"shipping_type_code" : {
"type" : "string",
"description" : "Shipping type code"
}
}
},
"SH52_Response_200" : {
"type" : "object",
"description" : "Shop shipping configuration",
"properties" : {
"configuration" : {
"type" : "array",
"description" : "The configuration of the shipping charges.",
"items" : {
"$ref" : "#/components/schemas/SH52_Response_200_Configuration"
}
},
"currency_iso_code" : {
"type" : "string",
"description" : "3-letters ISO code of the currency used on the shipping charges."
},
"last_updated_date" : {
"type" : "string",
"format" : "date-time",
"description" : "The date and time of update of the shipping charge configuration."
},
"shop_id" : {
"type" : "integer",
"format" : "int64",
"description" : "The shop identifier for which shipping charges are configured."
}
}
},
"SH52_Response_200_Configuration" : {
"type" : "object",
"properties" : {
"logistic_class_code" : {
"type" : "string",
"description" : "The logistic class code."
},
"overridden_by_shop" : {
"type" : "boolean",
"description" : "Indicates whether the shop provided a custom configuration or not."
},
"prices" : {
"$ref" : "#/components/schemas/SH52_Response_200_Configuration_Prices",
"description" : "The details of the prices applying on the shipping charge."
},
"shipping_method_code" : {
"type" : "string",
"description" : "The shipping method code."
},
"shipping_zone_code" : {
"type" : "string",
"description" : "The shipping zone code."
}
}
},
"SH52_Response_200_Configuration_Prices" : {
"type" : "object",
"properties" : {
"additional_price" : {
"type" : "number",
"description" : "The value of the additional price per additional offer unit in the order. Not applicable when type is FREE_SHIPPING or ORDER_RANGE."
},
"free_shipping_threshold" : {
"type" : "number",
"description" : "The minimum order value threshold, above which shipping becomes free for the customer. Not applicable when type is ORDER_RANGE."
},
"initial_price" : {
"type" : "number",
"description" : "The value of the standard shipping price. Not applicable when type is FREE_SHIPPING or ORDER_RANGE."
},
"ranges" : {
"type" : "array",
"description" : "The details of the shipping price ranges. Applicable only when type is ORDER_RANGE.",
"items" : {
"$ref" : "#/components/schemas/SH52_Response_200_Configuration_Prices_Ranges"
}
},
"type" : {
"type" : "string",
"description" : "The rule applying on the shipping charge."
}
}
},
"SH52_Response_200_Configuration_Prices_Ranges" : {
"type" : "object",
"properties" : {
"price" : {
"type" : "number",
"description" : "The value of the shipping price."
},
"threshold" : {
"type" : "number",
"description" : "The threshold amounts from which the configured shipping price applies."
}
}
},
"ST01_Request" : {
"type" : "object",
"properties" : {
"shipments" : {
"type" : "array",
"description" : "Shipments list",
"items" : {
"$ref" : "#/components/schemas/ST01_Request_Shipments"
},
"maxItems" : 1000,
"minItems" : 1
}
}
},
"ST01_Request_Shipments" : {
"type" : "object",
"description" : "Shipments list",
"properties" : {
"invoice_reference" : {
"type" : "string",
"description" : "Shipment's invoice reference",
"maxLength" : 255,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_-]*"
},
"order_id" : {
"type" : "string",
"description" : "Order identifier",
"maxLength" : 2147483647,
"minLength" : 1
},
"shipment_additional_information" : {
"type" : "array",
"description" : "Shipment's additional information",
"items" : {
"$ref" : "#/components/schemas/ST01_Request_Shipments_ShipmentAdditionalInformation"
}
},
"shipment_lines" : {
"type" : "array",
"description" : "Shipment lines",
"items" : {
"$ref" : "#/components/schemas/ST01_Request_Shipments_ShipmentLines"
},
"maxItems" : 2147483647,
"minItems" : 1
},
"shipped" : {
"type" : "boolean",
"default" : false,
"description" : "If true, the shipment is shipped after its creation"
},
"shipping_from" : {
"$ref" : "#/components/schemas/ST01_Request_Shipments_ShippingFrom",
"description" : "Shipment's shipping origin"
},
"tracking" : {
"$ref" : "#/components/schemas/ST01_Request_Shipments_Tracking",
"description" : "Shipment tracking details"
}
}
},
"ST01_Request_Shipments_ShipmentAdditionalInformation" : {
"type" : "object",
"description" : "Shipment's additional information",
"discriminator" : {
"mapping" : {
"DATE" : "#/components/schemas/ST01_Request_Shipments_ShipmentAdditionalInformation_Date",
"STRING" : "#/components/schemas/ST01_Request_Shipments_ShipmentAdditionalInformation_String"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "The code associated to shipment additional information that you want to complete"
},
"type" : {
"type" : "string",
"description" : "The type associated to the shipment additional information that you want to complete"
},
"value" : {
"type" : "object",
"description" : "The value associated to the shipment additional information that you want to complete for this specific shipment"
}
}
},
"ST01_Request_Shipments_ShipmentAdditionalInformation_Date" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ST01_Request_Shipments_ShipmentAdditionalInformation"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "The value associated to the shipment additional information that you want to complete for this specific shipment"
}
}
},
"ST01_Request_Shipments_ShipmentAdditionalInformation_String" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ST01_Request_Shipments_ShipmentAdditionalInformation"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "The value associated to the shipment additional information that you want to complete for this specific shipment"
}
}
},
"ST01_Request_Shipments_ShipmentLines" : {
"type" : "object",
"description" : "Shipment lines",
"properties" : {
"offer_sku" : {
"type" : "string",
"deprecated" : true,
"description" : "Offer sku"
},
"order_line_id" : {
"type" : "string",
"description" : "Order line id"
},
"package_reference" : {
"type" : "string",
"description" : "Package reference"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity",
"minimum" : 1
}
}
},
"ST01_Request_Shipments_ShippingFrom" : {
"type" : "object",
"description" : "Shipment's shipping origin",
"properties" : {
"warehouse" : {
"$ref" : "#/components/schemas/ST01_Request_Shipments_ShippingFrom_Warehouse",
"description" : "The warehouse from where the shipment is shipped"
}
}
},
"ST01_Request_Shipments_ShippingFrom_Warehouse" : {
"type" : "object",
"description" : "The warehouse from where the shipment is shipped",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code of the warehouse"
}
}
},
"ST01_Request_Shipments_Tracking" : {
"type" : "object",
"description" : "Shipment tracking details",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "The code of a carrier. This information is mandatory for a registered carrier."
},
"carrier_name" : {
"type" : "string",
"description" : "The name of a carrier. This information is mandatory for an unregistered carrier."
},
"carrier_standard_code" : {
"type" : "string",
"description" : "The standard code of a carrier based on mirakl carrier referential"
},
"tracking_number" : {
"type" : "string",
"description" : "The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number."
},
"tracking_url" : {
"type" : "string",
"description" : "The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers.\n"
}
}
},
"ST01_Response_201" : {
"type" : "object",
"properties" : {
"shipment_errors" : {
"type" : "array",
"description" : "Shipment creation errors",
"items" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentErrors"
}
},
"shipment_success" : {
"type" : "array",
"description" : "Shipment creation success",
"items" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess"
}
}
}
},
"ST01_Response_201_ShipmentErrors" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"description" : "Shipment error creation message"
},
"order_id" : {
"type" : "string",
"description" : "Order id of the shipment creation error"
}
}
},
"ST01_Response_201_ShipmentSuccess" : {
"type" : "object",
"properties" : {
"created_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Shipment's creation date"
},
"id" : {
"type" : "string",
"description" : "Shipment id"
},
"invoice_reference" : {
"type" : "string",
"description" : "Shipment's invoice reference"
},
"last_updated_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Shipment's last updated date"
},
"order_id" : {
"type" : "string",
"description" : "Order id"
},
"payment_details" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_PaymentDetails",
"description" : "Shipment's payment details"
},
"shipment_additional_information" : {
"type" : "array",
"description" : "Shipment's additional information",
"items" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation"
}
},
"shipment_lines" : {
"type" : "array",
"description" : "Shipment lines",
"items" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentLines"
}
},
"shipped_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Shipment's shipped date."
},
"shipping_from" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShippingFrom",
"description" : "Shipment's shipping origin"
},
"status" : {
"type" : "string",
"description" : "Shipment status"
},
"status_customer_debit" : {
"type" : "string",
"description" : "Shipment debit status"
},
"tracking" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking",
"description" : "Shipment tracking details"
}
}
},
"ST01_Response_201_ShipmentSuccess_PaymentDetails" : {
"type" : "object",
"properties" : {
"customer_debited_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Payment's date of the shipment by the customer"
},
"transaction_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Payment transaction date"
},
"transaction_number" : {
"type" : "string",
"description" : "Payment transaction number"
}
}
},
"ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"DATE" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation_Date",
"STRING" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation_String"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "Shipment's additional information code"
},
"type" : {
"type" : "string",
"description" : "Shipment's additional information type"
}
}
},
"ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation_Date" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Shipment's additional information value"
}
}
},
"ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation_String" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Shipment's additional information value"
}
}
},
"ST01_Response_201_ShipmentSuccess_ShipmentLines" : {
"type" : "object",
"properties" : {
"offer_sku" : {
"type" : "string",
"deprecated" : true,
"description" : "Offer sku"
},
"order_line_id" : {
"type" : "string",
"description" : "Order line id"
},
"package_reference" : {
"type" : "string",
"description" : "Package reference"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity",
"minimum" : 1
}
}
},
"ST01_Response_201_ShipmentSuccess_ShippingFrom" : {
"type" : "object",
"properties" : {
"address" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShippingFrom_Address",
"description" : "Shipping origin address"
},
"warehouse" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShippingFrom_Warehouse",
"description" : "Shipping origin warehouse"
}
}
},
"ST01_Response_201_ShipmentSuccess_ShippingFrom_Address" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "City"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO code"
},
"state" : {
"type" : "string",
"description" : "State"
},
"street_1" : {
"type" : "string",
"description" : "First information line of the address street"
},
"street_2" : {
"type" : "string",
"description" : "Second information line of the address street"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"ST01_Response_201_ShipmentSuccess_ShippingFrom_Warehouse" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Warehouse's code"
}
}
},
"ST01_Response_201_ShipmentSuccess_Tracking" : {
"type" : "object",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "The code of a carrier. This information is mandatory for a registered carrier."
},
"carrier_expected_delivery_date" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate"
},
"carrier_name" : {
"type" : "string",
"description" : "The name of a carrier. This information is mandatory for an unregistered carrier."
},
"carrier_standard_code" : {
"type" : "string",
"description" : "The standard code of a carrier based on mirakl carrier referential"
},
"last_known_location" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_LastKnownLocation",
"description" : "The last location known and transmitted by carriers"
},
"milestones" : {
"type" : "array",
"description" : "Retrieves the main stages of the delivery of a shipment coming from carrier's systems",
"items" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_Milestones"
}
},
"tracking_number" : {
"type" : "string",
"description" : "The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number."
},
"tracking_url" : {
"type" : "string",
"description" : "The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers."
},
"validity_status" : {
"type" : "string",
"description" : "Retrieves if mirakl is able to get tracking information (if not, then unverified) and if we manage to get tracking information and if we do get tracking information on this tracking, then it moves to verified, if we don't it remains in unverified"
}
}
},
"ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate" : {
"type" : "object",
"properties" : {
"earliest" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate_Earliest"
},
"latest" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate_Latest"
}
}
},
"ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate_Earliest" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date",
"description" : "Date"
},
"offset" : {
"type" : "string",
"description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)."
},
"time" : {
"type" : "string",
"description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]"
}
}
},
"ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate_Latest" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date",
"description" : "Date"
},
"offset" : {
"type" : "string",
"description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)."
},
"time" : {
"type" : "string",
"description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]"
}
}
},
"ST01_Response_201_ShipmentSuccess_Tracking_LastKnownLocation" : {
"type" : "object",
"properties" : {
"location" : {
"type" : "string",
"description" : "Last known location of the shipment"
},
"occurrence_date" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_LastKnownLocation_OccurrenceDate",
"description" : "Occurrence date of the known location"
}
}
},
"ST01_Response_201_ShipmentSuccess_Tracking_LastKnownLocation_OccurrenceDate" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date",
"description" : "Date"
},
"offset" : {
"type" : "string",
"description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)."
},
"time" : {
"type" : "string",
"description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]"
}
}
},
"ST01_Response_201_ShipmentSuccess_Tracking_Milestones" : {
"type" : "object",
"properties" : {
"additional_info" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_Milestones_AdditionalInfo",
"description" : "Additional information about the current milestone"
},
"occurrence_date" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_Milestones_OccurrenceDate",
"description" : "Occurrence date"
},
"type" : {
"type" : "string",
"description" : "Type of milestone"
}
}
},
"ST01_Response_201_ShipmentSuccess_Tracking_Milestones_AdditionalInfo" : {
"type" : "object",
"properties" : {
"occurrence_date" : {
"$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_Milestones_AdditionalInfo_OccurrenceDate",
"description" : "Occurrence date"
},
"type" : {
"type" : "string",
"description" : "Type of the additional information"
}
}
},
"ST01_Response_201_ShipmentSuccess_Tracking_Milestones_AdditionalInfo_OccurrenceDate" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date",
"description" : "Date"
},
"offset" : {
"type" : "string",
"description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)."
},
"time" : {
"type" : "string",
"description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]"
}
}
},
"ST01_Response_201_ShipmentSuccess_Tracking_Milestones_OccurrenceDate" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date",
"description" : "Date"
},
"offset" : {
"type" : "string",
"description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)."
},
"time" : {
"type" : "string",
"description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]"
}
}
},
"ST06_Request" : {
"type" : "object",
"properties" : {
"shipments" : {
"type" : "array",
"description" : "Shipment ids",
"items" : {
"$ref" : "#/components/schemas/ST06_Request_Shipments"
},
"maxItems" : 1000,
"minItems" : 1
}
}
},
"ST06_Request_Shipments" : {
"type" : "object",
"description" : "Shipment ids",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id",
"maxLength" : 2147483647,
"minLength" : 1
}
}
},
"ST06_Response_200" : {
"type" : "object",
"properties" : {
"shipment_errors" : {
"type" : "array",
"description" : "Shipment workflow update errors",
"items" : {
"$ref" : "#/components/schemas/ST06_Response_200_ShipmentErrors"
}
},
"shipment_success" : {
"type" : "array",
"description" : "Shipment workflow update success",
"items" : {
"$ref" : "#/components/schemas/ST06_Response_200_ShipmentSuccess"
}
}
}
},
"ST06_Response_200_ShipmentErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"ST06_Response_200_ShipmentSuccess" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id",
"maxLength" : 2147483647,
"minLength" : 1
}
}
},
"ST07_Request" : {
"type" : "object",
"properties" : {
"shipments" : {
"type" : "array",
"description" : "Shipments list",
"items" : {
"$ref" : "#/components/schemas/ST07_Request_Shipments"
},
"maxItems" : 100,
"minItems" : 1
}
}
},
"ST07_Request_Shipments" : {
"type" : "object",
"description" : "Shipments list",
"properties" : {
"id" : {
"type" : "string",
"description" : "The shipment id"
},
"shipping_from" : {
"$ref" : "#/components/schemas/ST07_Request_Shipments_ShippingFrom",
"description" : "Shipment's shipping origin"
}
}
},
"ST07_Request_Shipments_ShippingFrom" : {
"type" : "object",
"description" : "Shipment's shipping origin",
"properties" : {
"warehouse" : {
"$ref" : "#/components/schemas/ST07_Request_Shipments_ShippingFrom_Warehouse",
"description" : "The warehouse from where the shipment is shipped"
}
}
},
"ST07_Request_Shipments_ShippingFrom_Warehouse" : {
"type" : "object",
"description" : "The warehouse from where the shipment is shipped",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code of the warehouse"
}
}
},
"ST07_Response_200" : {
"type" : "object",
"properties" : {
"shipment_errors" : {
"type" : "array",
"description" : "Shipment update errors",
"items" : {
"$ref" : "#/components/schemas/ST07_Response_200_ShipmentErrors"
}
},
"shipment_success" : {
"type" : "array",
"description" : "Shipment update success",
"items" : {
"$ref" : "#/components/schemas/ST07_Response_200_ShipmentSuccess"
}
}
}
},
"ST07_Response_200_ShipmentErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id"
},
"message" : {
"type" : "string",
"description" : "Shipment update error message"
}
}
},
"ST07_Response_200_ShipmentSuccess" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id"
},
"shipping_from" : {
"$ref" : "#/components/schemas/ST07_Response_200_ShipmentSuccess_ShippingFrom",
"description" : "Shipment's shipping origin"
}
}
},
"ST07_Response_200_ShipmentSuccess_ShippingFrom" : {
"type" : "object",
"properties" : {
"address" : {
"$ref" : "#/components/schemas/ST07_Response_200_ShipmentSuccess_ShippingFrom_Address",
"description" : "Shipping origin address"
},
"warehouse" : {
"$ref" : "#/components/schemas/ST07_Response_200_ShipmentSuccess_ShippingFrom_Warehouse",
"description" : "Shipping origin warehouse"
}
}
},
"ST07_Response_200_ShipmentSuccess_ShippingFrom_Address" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "City"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO code"
},
"state" : {
"type" : "string",
"description" : "State"
},
"street_1" : {
"type" : "string",
"description" : "First information line of the address street"
},
"street_2" : {
"type" : "string",
"description" : "Second information line of the address street"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"ST07_Response_200_ShipmentSuccess_ShippingFrom_Warehouse" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Warehouse's code"
}
}
},
"ST11_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/ST11_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."
}
}
},
"ST11_Response_200_Data" : {
"type" : "object",
"properties" : {
"created_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Shipment's creation date"
},
"id" : {
"type" : "string",
"description" : "Shipment id"
},
"invoice_reference" : {
"type" : "string",
"description" : "Shipment's invoice reference"
},
"last_updated_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Shipment's last updated date"
},
"order_id" : {
"type" : "string",
"description" : "Order id"
},
"payment_details" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_PaymentDetails",
"description" : "Shipment's payment details"
},
"shipment_additional_information" : {
"type" : "array",
"description" : "Shipment's additional information",
"items" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation"
}
},
"shipment_lines" : {
"type" : "array",
"description" : "Shipment lines",
"items" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_ShipmentLines"
}
},
"shipped_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Shipment's shipped date."
},
"shipping_from" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_ShippingFrom",
"description" : "Shipment's shipping origin"
},
"status" : {
"type" : "string",
"description" : "Shipment status"
},
"status_customer_debit" : {
"type" : "string",
"description" : "Shipment debit status"
},
"tracking" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking",
"description" : "Shipment tracking details"
}
}
},
"ST11_Response_200_Data_PaymentDetails" : {
"type" : "object",
"properties" : {
"customer_debited_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Payment's date of the shipment by the customer"
},
"transaction_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Payment transaction date"
},
"transaction_number" : {
"type" : "string",
"description" : "Payment transaction number"
}
}
},
"ST11_Response_200_Data_ShipmentAdditionalInformation" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"DATE" : "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation_Date",
"STRING" : "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation_String"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "Shipment's additional information code"
},
"type" : {
"type" : "string",
"description" : "Shipment's additional information type"
}
}
},
"ST11_Response_200_Data_ShipmentAdditionalInformation_Date" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Shipment's additional information value"
}
}
},
"ST11_Response_200_Data_ShipmentAdditionalInformation_String" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "Shipment's additional information value"
}
}
},
"ST11_Response_200_Data_ShipmentLines" : {
"type" : "object",
"properties" : {
"offer_sku" : {
"type" : "string",
"deprecated" : true,
"description" : "Offer sku"
},
"order_line_id" : {
"type" : "string",
"description" : "Order line id"
},
"package_reference" : {
"type" : "string",
"description" : "Package reference"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity",
"minimum" : 1
}
}
},
"ST11_Response_200_Data_ShippingFrom" : {
"type" : "object",
"properties" : {
"address" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_ShippingFrom_Address",
"description" : "Shipping origin address"
},
"warehouse" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_ShippingFrom_Warehouse",
"description" : "Shipping origin warehouse"
}
}
},
"ST11_Response_200_Data_ShippingFrom_Address" : {
"type" : "object",
"properties" : {
"city" : {
"type" : "string",
"description" : "City"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO code"
},
"state" : {
"type" : "string",
"description" : "State"
},
"street_1" : {
"type" : "string",
"description" : "First information line of the address street"
},
"street_2" : {
"type" : "string",
"description" : "Second information line of the address street"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"ST11_Response_200_Data_ShippingFrom_Warehouse" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Warehouse's code"
}
}
},
"ST11_Response_200_Data_Tracking" : {
"type" : "object",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "The code of a carrier. This information is mandatory for a registered carrier."
},
"carrier_expected_delivery_date" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate"
},
"carrier_name" : {
"type" : "string",
"description" : "The name of a carrier. This information is mandatory for an unregistered carrier."
},
"carrier_standard_code" : {
"type" : "string",
"description" : "The standard code of a carrier based on mirakl carrier referential"
},
"last_known_location" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_LastKnownLocation",
"description" : "The last location known and transmitted by carriers"
},
"milestones" : {
"type" : "array",
"description" : "Retrieves the main stages of the delivery of a shipment coming from carrier's systems",
"items" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_Milestones"
}
},
"tracking_number" : {
"type" : "string",
"description" : "The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number."
},
"tracking_url" : {
"type" : "string",
"description" : "The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers."
},
"validity_status" : {
"type" : "string",
"description" : "Retrieves if mirakl is able to get tracking information (if not, then unverified) and if we manage to get tracking information and if we do get tracking information on this tracking, then it moves to verified, if we don't it remains in unverified"
}
}
},
"ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate" : {
"type" : "object",
"properties" : {
"earliest" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate_Earliest"
},
"latest" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate_Latest"
}
}
},
"ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate_Earliest" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date",
"description" : "Date"
},
"offset" : {
"type" : "string",
"description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)."
},
"time" : {
"type" : "string",
"description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]"
}
}
},
"ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate_Latest" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date",
"description" : "Date"
},
"offset" : {
"type" : "string",
"description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)."
},
"time" : {
"type" : "string",
"description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]"
}
}
},
"ST11_Response_200_Data_Tracking_LastKnownLocation" : {
"type" : "object",
"properties" : {
"location" : {
"type" : "string",
"description" : "Last known location of the shipment"
},
"occurrence_date" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_LastKnownLocation_OccurrenceDate",
"description" : "Occurrence date of the known location"
}
}
},
"ST11_Response_200_Data_Tracking_LastKnownLocation_OccurrenceDate" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date",
"description" : "Date"
},
"offset" : {
"type" : "string",
"description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)."
},
"time" : {
"type" : "string",
"description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]"
}
}
},
"ST11_Response_200_Data_Tracking_Milestones" : {
"type" : "object",
"properties" : {
"additional_info" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_Milestones_AdditionalInfo",
"description" : "Additional information about the current milestone"
},
"occurrence_date" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_Milestones_OccurrenceDate",
"description" : "Occurrence date"
},
"type" : {
"type" : "string",
"description" : "Type of milestone"
}
}
},
"ST11_Response_200_Data_Tracking_Milestones_AdditionalInfo" : {
"type" : "object",
"properties" : {
"occurrence_date" : {
"$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_Milestones_AdditionalInfo_OccurrenceDate",
"description" : "Occurrence date"
},
"type" : {
"type" : "string",
"description" : "Type of the additional information"
}
}
},
"ST11_Response_200_Data_Tracking_Milestones_AdditionalInfo_OccurrenceDate" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date",
"description" : "Date"
},
"offset" : {
"type" : "string",
"description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)."
},
"time" : {
"type" : "string",
"description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]"
}
}
},
"ST11_Response_200_Data_Tracking_Milestones_OccurrenceDate" : {
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"format" : "date",
"description" : "Date"
},
"offset" : {
"type" : "string",
"description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)."
},
"time" : {
"type" : "string",
"description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]"
}
}
},
"ST12_Response_200" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"description" : "Page of data",
"items" : {
"$ref" : "#/components/schemas/ST12_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."
}
}
},
"ST12_Response_200_Data" : {
"type" : "object",
"properties" : {
"fulfillment" : {
"$ref" : "#/components/schemas/ST12_Response_200_Data_Fulfillment",
"description" : "Fulfillment information"
},
"order_id" : {
"type" : "string",
"description" : "Order id"
},
"references" : {
"$ref" : "#/components/schemas/ST12_Response_200_Data_References",
"description" : "References"
},
"shipment_lines" : {
"type" : "array",
"description" : "Shipment lines",
"items" : {
"$ref" : "#/components/schemas/ST12_Response_200_Data_ShipmentLines"
}
},
"shipping_address" : {
"$ref" : "#/components/schemas/ST12_Response_200_Data_ShippingAddress",
"description" : "Customer's shipping address"
},
"shipping_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Shipping date"
},
"shipping_deadline" : {
"type" : "string",
"format" : "date-time",
"description" : "Shipping deadline"
},
"shipping_type_code" : {
"type" : "string",
"description" : "Code of shipping's type"
},
"shipping_type_standard_code" : {
"type" : "string",
"description" : "Shipping type's standard code"
}
}
},
"ST12_Response_200_Data_Fulfillment" : {
"type" : "object",
"properties" : {
"center" : {
"$ref" : "#/components/schemas/ST12_Response_200_Data_Fulfillment_Center",
"description" : "Fulfillment center code"
}
}
},
"ST12_Response_200_Data_Fulfillment_Center" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Center code"
}
}
},
"ST12_Response_200_Data_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"
}
}
},
"ST12_Response_200_Data_ShipmentLines" : {
"type" : "object",
"properties" : {
"offer_sku" : {
"type" : "string",
"description" : "Offer sku"
},
"order_line_id" : {
"type" : "string",
"description" : "Order line id"
},
"package_description" : {
"type" : "string",
"deprecated" : true,
"description" : "Package Description"
},
"package_reference" : {
"type" : "string",
"description" : "Package reference"
},
"product_title" : {
"type" : "string",
"description" : "Product title"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity",
"minimum" : 1
}
}
},
"ST12_Response_200_Data_ShippingAddress" : {
"type" : "object",
"properties" : {
"additional_info" : {
"type" : "string",
"description" : "Additional information for the shipping address"
},
"city" : {
"type" : "string",
"description" : "Address city"
},
"civility" : {
"type" : "string",
"description" : "Civility of the person associated with the address"
},
"company" : {
"type" : "string",
"description" : "Company of the person associated with the address"
},
"company_2" : {
"type" : "string",
"description" : "Second company information of the person associated with the address"
},
"country" : {
"type" : "string",
"description" : "Address country"
},
"country_iso_code" : {
"type" : "string",
"description" : "Country ISO 3166-1 code of the address"
},
"firstname" : {
"type" : "string",
"description" : "First name of the person associated with the address"
},
"lastname" : {
"type" : "string",
"description" : "Last name of the person associated with the address"
},
"phone" : {
"type" : "string",
"description" : "Phone"
},
"phone_secondary" : {
"type" : "string",
"description" : "Phone secondary"
},
"state" : {
"type" : "string",
"description" : "Address state"
},
"street_1" : {
"type" : "string",
"description" : "First information line of the address street"
},
"street_2" : {
"type" : "string",
"description" : "Second information line of the address street"
},
"zip_code" : {
"type" : "string",
"description" : "Address zip code"
}
}
},
"ST23_Request" : {
"type" : "object",
"properties" : {
"shipments" : {
"type" : "array",
"description" : "Shipments list",
"items" : {
"$ref" : "#/components/schemas/ST23_Request_Shipments"
},
"maxItems" : 1000,
"minItems" : 1
}
}
},
"ST23_Request_Shipments" : {
"type" : "object",
"description" : "Shipments list",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id"
},
"tracking" : {
"$ref" : "#/components/schemas/ST23_Request_Shipments_Tracking",
"description" : "Shipment tracking details"
}
}
},
"ST23_Request_Shipments_Tracking" : {
"type" : "object",
"description" : "Shipment tracking details",
"properties" : {
"carrier_code" : {
"type" : "string",
"description" : "The code of a carrier. This information is mandatory for a registered carrier."
},
"carrier_name" : {
"type" : "string",
"description" : "The name of a carrier. This information is mandatory for an unregistered carrier."
},
"carrier_standard_code" : {
"type" : "string",
"description" : "The standard code of a carrier based on mirakl carrier referential"
},
"tracking_number" : {
"type" : "string",
"description" : "The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number."
},
"tracking_url" : {
"type" : "string",
"description" : "The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers.\n"
}
}
},
"ST23_Response_200" : {
"type" : "object",
"properties" : {
"shipment_errors" : {
"type" : "array",
"description" : "Shipment workflow update errors",
"items" : {
"$ref" : "#/components/schemas/ST23_Response_200_ShipmentErrors"
}
},
"shipment_success" : {
"type" : "array",
"description" : "Shipment workflow update success",
"items" : {
"$ref" : "#/components/schemas/ST23_Response_200_ShipmentSuccess"
}
}
}
},
"ST23_Response_200_ShipmentErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"ST23_Response_200_ShipmentSuccess" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id",
"maxLength" : 2147483647,
"minLength" : 1
}
}
},
"ST24_Request" : {
"type" : "object",
"properties" : {
"shipments" : {
"type" : "array",
"description" : "Shipment ids",
"items" : {
"$ref" : "#/components/schemas/ST24_Request_Shipments"
},
"maxItems" : 1000,
"minItems" : 1
}
}
},
"ST24_Request_Shipments" : {
"type" : "object",
"description" : "Shipment ids",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id",
"maxLength" : 2147483647,
"minLength" : 1
}
}
},
"ST24_Response_200" : {
"type" : "object",
"properties" : {
"shipment_errors" : {
"type" : "array",
"description" : "Shipment workflow update errors",
"items" : {
"$ref" : "#/components/schemas/ST24_Response_200_ShipmentErrors"
}
},
"shipment_success" : {
"type" : "array",
"description" : "Shipment workflow update success",
"items" : {
"$ref" : "#/components/schemas/ST24_Response_200_ShipmentSuccess"
}
}
}
},
"ST24_Response_200_ShipmentErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"ST24_Response_200_ShipmentSuccess" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id",
"maxLength" : 2147483647,
"minLength" : 1
}
}
},
"ST26_Request" : {
"type" : "object",
"properties" : {
"shipments" : {
"type" : "array",
"description" : "Shipment ids",
"items" : {
"$ref" : "#/components/schemas/ST26_Request_Shipments"
},
"maxItems" : 1000,
"minItems" : 1
}
}
},
"ST26_Request_Shipments" : {
"type" : "object",
"description" : "Shipment ids",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id",
"maxLength" : 2147483647,
"minLength" : 1
}
}
},
"ST26_Response_200" : {
"type" : "object",
"properties" : {
"shipment_errors" : {
"type" : "array",
"description" : "Shipment workflow update errors",
"items" : {
"$ref" : "#/components/schemas/ST26_Response_200_ShipmentErrors"
}
},
"shipment_success" : {
"type" : "array",
"description" : "Shipment workflow update success",
"items" : {
"$ref" : "#/components/schemas/ST26_Response_200_ShipmentSuccess"
}
}
}
},
"ST26_Response_200_ShipmentErrors" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"ST26_Response_200_ShipmentSuccess" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id",
"maxLength" : 2147483647,
"minLength" : 1
}
}
},
"ST31_Request" : {
"type" : "object",
"properties" : {
"shipments" : {
"type" : "array",
"description" : "List of shipments additional information",
"items" : {
"$ref" : "#/components/schemas/ST31_Request_Shipments"
},
"maxItems" : 100,
"minItems" : 1
}
}
},
"ST31_Request_Shipments" : {
"type" : "object",
"description" : "List of shipments additional information",
"properties" : {
"id" : {
"type" : "string",
"description" : "Shipment id"
},
"shipment_additional_information" : {
"type" : "array",
"description" : "Shipment additional information",
"items" : {
"$ref" : "#/components/schemas/ST31_Request_Shipments_ShipmentAdditionalInformation"
}
}
}
},
"ST31_Request_Shipments_ShipmentAdditionalInformation" : {
"type" : "object",
"description" : "Shipment additional information",
"discriminator" : {
"mapping" : {
"DATE" : "#/components/schemas/ST31_Request_Shipments_ShipmentAdditionalInformation_Date",
"STRING" : "#/components/schemas/ST31_Request_Shipments_ShipmentAdditionalInformation_String"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "The code associated to shipment additional information that you want to complete"
},
"type" : {
"type" : "string",
"description" : "The type associated to the shipment additional information that you want to complete"
},
"value" : {
"type" : "object",
"description" : "The value associated to the shipment additional information that you want to complete for this specific shipment"
}
}
},
"ST31_Request_Shipments_ShipmentAdditionalInformation_Date" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ST31_Request_Shipments_ShipmentAdditionalInformation"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "The value associated to the shipment additional information that you want to complete for this specific shipment"
}
}
},
"ST31_Request_Shipments_ShipmentAdditionalInformation_String" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ST31_Request_Shipments_ShipmentAdditionalInformation"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "The value associated to the shipment additional information that you want to complete for this specific shipment"
}
}
},
"ST31_Response_200" : {
"type" : "object",
"properties" : {
"shipment_update_errors" : {
"type" : "array",
"description" : "Shipment additional information update errors",
"items" : {
"$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateErrors"
}
},
"shipment_update_success" : {
"type" : "array",
"description" : "Shipment additional information update success",
"items" : {
"$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess"
}
}
}
},
"ST31_Response_200_ShipmentUpdateErrors" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"description" : "List of errors",
"items" : {
"$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateErrors_Errors"
}
},
"shipment_id" : {
"type" : "string",
"description" : "Shipment id"
}
}
},
"ST31_Response_200_ShipmentUpdateErrors_Errors" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Error code"
},
"field" : {
"type" : "string",
"description" : "Name of the field on the input object. Can be composed, e.g.: address.zip_code"
},
"message" : {
"type" : "string",
"description" : "Error message"
}
}
},
"ST31_Response_200_ShipmentUpdateSuccess" : {
"type" : "object",
"properties" : {
"shipment_additional_information" : {
"type" : "array",
"description" : "Shipment additional information",
"items" : {
"$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation"
}
},
"shipment_id" : {
"type" : "string",
"description" : "Shipment id"
}
}
},
"ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation" : {
"type" : "object",
"discriminator" : {
"mapping" : {
"DATE" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation_Date",
"STRING" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation_String"
},
"propertyName" : "type"
},
"properties" : {
"code" : {
"type" : "string",
"description" : "The code associated to shipment additional information that you want to complete"
},
"type" : {
"type" : "string",
"description" : "The type associated to the shipment additional information that you want to complete"
},
"value" : {
"type" : "object",
"description" : "The value associated to the shipment additional information that you want to complete for this specific shipment"
}
}
},
"ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation_Date" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "The value associated to the shipment additional information that you want to complete for this specific shipment"
}
}
},
"ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation_String" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation"
} ],
"properties" : {
"value" : {
"type" : "string",
"description" : "The value associated to the shipment additional information that you want to complete for this specific shipment"
}
}
},
"STO01_Response_201" : {
"type" : "object",
"properties" : {
"import_id" : {
"type" : "string",
"description" : "Offer stock import identifier"
}
}
},
"STO02_Response_200" : {
"type" : "object",
"properties" : {
"date_created" : {
"type" : "string",
"format" : "date-time",
"description" : "Import creation date"
},
"has_error_report" : {
"type" : "boolean",
"description" : "Indicate if an error report exists"
},
"import_id" : {
"type" : "string",
"description" : "Import ID"
},
"lines_in_error" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines in error"
},
"lines_in_success" : {
"type" : "integer",
"format" : "int32",
"description" : "Total count of lines in success"
},
"shop_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Shop identifier"
},
"status" : {
"type" : "string",
"description" : "Import status"
}
}
},
"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"
}
}
},
"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 Marketplace 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/document-request/requests" : {
"get" : {
"description" : "",
"operationId" : "DR11",
"parameters" : [ {
"description" : "Filter by accounting document request identifier.",
"explode" : true,
"in" : "query",
"name" : "id",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Filter by accounting document number.",
"explode" : true,
"in" : "query",
"name" : "document_number",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Filter accounting document requests created after the given date.",
"explode" : true,
"in" : "query",
"name" : "date_created_from",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter accounting document requests created before the given date.",
"explode" : true,
"in" : "query",
"name" : "date_created_to",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter accounting document requests updated after the given date.",
"explode" : true,
"in" : "query",
"name" : "last_updated_from",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter accounting document requests updated before the given date.",
"explode" : true,
"in" : "query",
"name" : "last_updated_to",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter accounting document requests issued after the given date.",
"explode" : true,
"in" : "query",
"name" : "issue_date_from",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter accounting document requests issued before the given date.",
"explode" : true,
"in" : "query",
"name" : "issue_date_to",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter by accounting document request state. This parameter can be supplied multiple times.",
"explode" : true,
"in" : "query",
"name" : "state",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "Filter by accounting document request type. This parameter can be supplied multiple times.",
"explode" : true,
"in" : "query",
"name" : "type",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "Filter by accounting document request issuer type. This parameter can be supplied multiple times.",
"explode" : true,
"in" : "query",
"name" : "issuer_type",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "Filter by accounting document request entity identifier. This parameter can be supplied multiple times.\n\nThe `entity_type` must be specified to use this filter, otherwise an error 400 will be returned.\n\nExample: `entity_id=order1-A&entity_id=order20-A&entity_type=PRODUCT_LOGISTIC_ORDER`",
"explode" : true,
"in" : "query",
"name" : "entity_id",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "Filter by accounting document request entity type. This parameter can be supplied multiple times.",
"explode" : true,
"in" : "query",
"name" : "entity_type",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "Filter accounting document requests generated by a shop billing cycle having the given identifier.\n\nThis filter is only available for document requests of the type: `FEES`, `ONE_OFF_FEES`, `SHOP_BILLING_CYCLE_PURCHASE_ORDER`.",
"explode" : true,
"in" : "query",
"name" : "shop_billing_cycle_id",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Filter accounting document requests generated by shop billing cycle after the given date.\n\nThis filter is only available for document requests of the type: `FEES`, `ONE_OFF_FEES`, `SHOP_BILLING_CYCLE_PURCHASE_ORDER`.\n\nThis parameter was previously named `billing_cycle_from`, which is still accepted but deprecated.",
"explode" : true,
"in" : "query",
"name" : "shop_billing_cycle_from",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter accounting document requests generated by shop billing cycle before the given date.\n\nThis filter is only available for document requests of the type: `FEES`, `ONE_OFF_FEES`, `SHOP_BILLING_CYCLE_PURCHASE_ORDER`.\n\nThis parameter was previously named `billing_cycle_to`, which is still accepted but deprecated.",
"explode" : true,
"in" : "query",
"name" : "shop_billing_cycle_to",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter by accounting document request payment state.\n\nThis filter is only available for document requests of the type: `SHOP_BILLING_CYCLE_PURCHASE_ORDER`, `LOGISTIC_PURCHASE_ORDER`, `FEES`.",
"explode" : true,
"in" : "query",
"name" : "payment_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/DR11_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ ]
} ],
"summary" : "List accounting documents requests",
"tags" : [ "Invoicing and Accounting" ]
}
},
"/api/document-request/{document_request_id}/lines" : {
"get" : {
"description" : "",
"operationId" : "DR12",
"parameters" : [ {
"description" : "Document Request identifier",
"explode" : false,
"in" : "path",
"name" : "document_request_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" : "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/DR12_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ ]
} ],
"summary" : "List lines of a document request",
"tags" : [ "Invoicing and Accounting" ]
}
},
"/api/document-request/documents/download" : {
"get" : {
"description" : "At least one of the following filters must be applied: document_id or entity_id\ndocuments-1624624030618.zip\n|\n|__ product-logistic-order/\n| |__order1-A/| |__ INV203837.pdf\n| |__ INV203837.cxml\n| |__order1-B/| |__ INV203839.pdf\n", "operationId" : "DR73", "parameters" : [ { "description" : "The document request unique identifier. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "document_request_id", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Document identifiers. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "document_id", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Document formats. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "document_format", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Entity identifiers related to the documents to download. This parameter can be supplied multiple times.
entity_type must be specified to use this filter, otherwise an error 400 will be returned.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/inbox/threads/{thread_id}" : {
"get" : {
"description" : "",
"operationId" : "M10",
"parameters" : [ {
"description" : "The identifier of the thread to retrieve.",
"explode" : false,
"in" : "path",
"name" : "thread_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" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/M10_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_MESSAGE_READ", "ROLE_PARTNER_MESSAGE_READ" ]
} ],
"summary" : "Retrieve a thread",
"tags" : [ "Messages" ]
}
},
"/api/inbox/threads" : {
"get" : {
"description" : "You may want to retrieve the threads linked to a specific entity, using both entity_type and entity_id.\nentity_type=MMP_ORDER&entity_id=my-order-1.\nentity_type are:\nMMP_ORDER: for threads on product ordersMMP_OFFER: for threads on offersMPS_ORDER: for threads on service ordersMPS_SERVICE: for threads on servicesSELLER_OPERATOR: for threads between sellers and operatorlimit is 50.\n",
"operationId" : "M11",
"parameters" : [ {
"description" : "Entity type to include in result (default: include all).entity_type).\nmultipart/form-data with name file.\"sku\";\"product-id\";\"product-id-type\";\"description\";\"internal-description\";\"price\";\"price-additional-info\";\"quantity\";\"min-quantity-alert\";\"state\";\"available-start-date\";\"available-end-date\";\"discount-price\";\"discount-start-date\";\"discount-end-date\";\"discount-ranges\";\"allow-quote-requests\";\"leadtime-to-ship\";\"min-order-quantity\";\"max-order-quantity\";\"package-quantity\";\"update-delete\";\"price-ranges\";\"ecotax\";\"gift-wrap\";\"min-quantity-ordered\"
\"price[channel=channel code]\";\"discount-price[channel=channel code]\";\"discount-start-date[channel=channel code]\";\"discount-end-date[channel=channel code]\";\"discount-ranges[channel=channel code]\";\"price-ranges[channel=channel code]\"
pricing-unit to specify the unit corresponding to the submitted price.product-tax-code to facilitate tax calculations.\"producer-id[EPR category code]\"; \"eco-contribution-amount[EPR category code]\"EPR category code must be one of:
FR-AGROPACK, FR-ASL, FR-DASRIPAT, FR-DBPS, FR-DDS, FR-DEA, FR-DEEE, FR-DISPMED, FR-DIY, FR-EMBM, FR-GF, FR-JOUETS, FR-LUB, FR-MH, FR-MNU, FR-PA, FR-PAP, FR-PCHIM, FR-PMCB, FR-PNEU, FR-TABAC, FR-TLC, FR-VEHICULE, FR-VHU, DE-BATTG, DE-PACK, DE-WEEE, ES-PACK, ES-GPACK, ES-WEEE
Returns the import identifier to track the status of the update.
You must send all offer fields. Offer fields that are not sent are reset to their default value.
", "operationId" : "OF24", "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/OF24_Request" } } } }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OF24_Response_201" } } }, "description" : "Created", "headers" : { "Location" : { "description" : "Pre-calculated URL to call to get the import status", "explode" : false, "schema" : { }, "style" : "simple" } } } }, "security" : [ { "Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_WRITE" ] } ], "summary" : "Create, update, or delete offers", "tags" : [ "Offers" ] } }, "/api/offers/{offer}" : { "get" : { "description" : "", "operationId" : "OF22", "parameters" : [ { "description" : "Offer identifier", "explode" : false, "in" : "path", "name" : "offer", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" }, { "description" : "Filter used to pick prices on a specific channel", "explode" : true, "in" : "query", "name" : "pricing_channel_code", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "For Customer Pricing users only. Customer identifier code the API will use to return all prices and applicable price for this organization. Ignored if value does not exist.", "explode" : true, "in" : "query", "name" : "pricing_customer_organization_id", "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/OF22_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_READ" ] } ], "summary" : "Get information about an offer", "tags" : [ "Offers" ] } }, "/api/offers/export" : { "get" : { "deprecated" : true, "description" : "Get a CSV file that includes the offers updated and deleted since the last request date.Update orders information field by field: unspecified fields will not be updated. To remove the value for a field, send it with the 'null' value (not allowed for the required fields).
You cannot use API OR04 to update customer-related information if the customer has been anonymized via API AN01.
A maximum of 100 orders can be sent at once.
", "operationId" : "OR04", "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/OR04_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR04_Response_200" } } }, "description" : "OK" }, "400" : { "description" : "Too many orders given" } }, "security" : [ { "Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_EDIT" ] } ], "summary" : "Patch update orders", "tags" : [ "Orders" ] }, "get" : { "description" : "Pagination is enabled by default. For large requests, use asynchronous order export APIs OR13, OR14 and OR15 instead.true, ignore the channel_codes",
"explode" : true,
"in" : "query",
"name" : "only_null_channel",
"schema" : {
"type" : "boolean",
"default" : false
},
"style" : "form"
}, {
"description" : "Start creation date for filtering",
"explode" : true,
"in" : "query",
"name" : "start_date",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "End creation date for filtering",
"explode" : true,
"in" : "query",
"name" : "end_date",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Start update date for filtering. Mirakl will subtract a time delta to ensure no orders are missed due to network and/or software latency.",
"explode" : true,
"in" : "query",
"name" : "start_update_date",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "End update date for filtering",
"explode" : true,
"in" : "query",
"name" : "end_update_date",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Order paid by customer",
"explode" : true,
"in" : "query",
"name" : "customer_debited",
"schema" : {
"type" : "boolean"
},
"style" : "form"
}, {
"description" : "Payment workflow of an order",
"explode" : true,
"in" : "query",
"name" : "payment_workflow",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "If true returns only orders with incidents in progress, if false returns orders without incidents in progress. If not provided, all orders with or without incident will be returned",
"explode" : true,
"in" : "query",
"name" : "has_incident",
"schema" : {
"type" : "boolean"
},
"style" : "form"
}, {
"description" : "Code of the fulfillment center",
"explode" : true,
"in" : "query",
"name" : "fulfillment_center_code",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"maximum" : 100
},
"maximum" : 100
},
"style" : "form"
}, {
"description" : "Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) do not include taxes.TAX_INCLUDED: the price fields include the tax amount. Update shipping origin (shipping_from) information on order lines.
A maximum of 100 order lines can be sent at once.
", "operationId" : "OR07", "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/OR07_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR07_Response_200" } } }, "description" : "OK" }, "400" : { "description" : "Too many order lines specified" } }, "security" : [ { "Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIP" ] } ], "summary" : "Update order line shipping origin", "tags" : [ "Orders" ] } }, "/api/orders/async-export" : { "post" : { "description" : "The API returns a tracking id to be used to query API OR14.
Mirakl recommends to use API OR13 instead of API OR11 as it can handle very large volumes of data.
You must give at least one date range filter: created or last updated date.
API OR13 supports the chunk of the export file into multiple files in order to:
megabytes_per_chunk parameter.items_per_chunk parameter.Use this API to query the order export status after an API OR13 call.
Until the export via API OR13 is complete, the status returned by API OR14 is PENDING.
You must call API OR14 until you get the COMPLETED status which correspond to a completed and successful export from API OR13.
The URLs in API OR14 response contain all the files from API OR13 export.
Browse those urls and query them using the GET method.
In case of error, the status is FAILED.
In case of export canceled, the status is CANCELED.
WAITING_ACCEPTANCE status\n\nORDER_FULFILLED_UNAUTHORIZED | An unauthorized action has been requested on a fulfilled order |\n| ORDER_INVALID_STATE | Order is not in the expected state for this operation |\n| ORDER_LINE_ACCEPTANCE_DECISION_MISSING | Some order lines are missing from the acceptance decision |\n| ORDER_LINE_DUPLICATE_ID | The order lines list contains duplicate order line IDs |\n| ORDER_LINE_NOT_FOUND | The requested order line does not exist or is not associated with the order |\n| ORDER_LINE_NULL_ELEMENT | The order lines list contains a null element |\n| ORDER_NOT_FOUND | The requested order does not exist |\n| ORDER_PARTIAL_ACCEPTANCE_DISABLED | Partial acceptance is disabled for this shop |\n| VALIDATION_ERROR | Input validation failed |\n\nSHIPPING status",
"operationId" : "OR24",
"parameters" : [ {
"description" : "Order's identifier",
"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"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIP" ]
} ],
"summary" : "Validate the shipment of an order",
"tags" : [ "Orders" ]
}
},
"/api/orders/refund" : {
"put" : {
"description" : "",
"operationId" : "OR28",
"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/OR28_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/OR28_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_REFUND_REQUEST", "ROLE_PARTNER_ORDER_REFUND" ]
} ],
"summary" : "Perform refunds on order lines",
"tags" : [ "Orders" ]
}
},
"/api/orders/{order_id}/cancel" : {
"put" : {
"description" : "",
"operationId" : "OR29",
"parameters" : [ {
"description" : "Order's identifier",
"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"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_CANCEL" ]
} ],
"summary" : "Perform a full cancelation of an order",
"tags" : [ "Orders" ]
}
},
"/api/orders/cancel" : {
"put" : {
"description" : "",
"operationId" : "OR30",
"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/OR30_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/OR30_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_CANCEL" ]
} ],
"summary" : "Perform cancelations on order lines",
"tags" : [ "Orders" ]
}
},
"/api/orders/{order_id}/additional_fields" : {
"put" : {
"description" : "Only specified custom field values will be updated.Update order line actual measurement either upwards or downwards, within the limit defined at the platform level.
\n\nORDER_ADJUSTMENT_FEATURE_DISABLED | The order adjustment feature is not enabled |\n| ORDER_LINE_ADJUSTMENT_EQUAL_TO_ORDERED | The actual measurement equals the ordered measurement |\n| ORDER_LINE_ADJUSTMENT_EXCEEDS_DOWNWARD_LIMIT | The downward adjustment exceeds the allowed limit |\n| ORDER_LINE_ADJUSTMENT_EXCEEDS_UPWARD_LIMIT | The upward adjustment exceeds the allowed limit |\n| ORDER_LINE_ALREADY_ADJUSTED | The order line has already been adjusted |\n| ORDER_LINE_ALREADY_REFUNDED | The order line has already been refunded |\n| ORDER_LINE_DUPLICATE_ID | The order lines list contains duplicate order line IDs |\n| ORDER_LINE_INVALID_STATE | Order lines are not in the expected state for this operation |\n| ORDER_LINE_MISSING_MEASUREMENT | The order line does not have a measurement unit |\n| ORDER_LINE_NOT_FOUND | The requested order line does not exist or is not associated with the order |\n| ORDER_LINE_PAY_PER_SHIPMENT_NOT_ADJUSTABLE | The order line cannot be adjusted with the current pay-per-shipment state |\n| ORDER_LINE_PAY_PER_SHIPMENT_WAITING_DEBIT | The order line is part of a shipment waiting for debit |\n| ORDER_LINE_ZERO_AMOUNT | The order line amount is zero |\n| VALIDATION_ERROR | Input validation failed |\n\n\ndocuments-timestamp.zip\n|\n|__ order_id_x/\n| |__ foo.txt\n| |__ bar.txt\n| |__ baz.pdf\n|\n|__ order_id_y/\n| |__ image.png\n| |__ image(1).png\n", "operationId" : "OR73", "parameters" : [ { "description" : "A list of identifiers of the orders (separated by a comma)", "explode" : true, "in" : "query", "name" : "order_ids", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" }, { "description" : "A list of document identifiers (separated by a comma)", "explode" : true, "in" : "query", "name" : "document_ids", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" }, { "description" : "A list of document type codes (separated by a comma)", "explode" : true, "in" : "query", "name" : "document_codes", "schema" : { "type" : "string", "maximum" : 100 }, "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_ORDER_DOCUMENT_READ" ] } ], "summary" : "Download one or multiple documents attached to one or multiple orders", "tags" : [ "Orders" ] } }, "/api/orders/taxes" : { "get" : { "description" : "", "operationId" : "OR75", "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/OR75_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SETTINGS_READ" ] } ], "summary" : "List all the order taxes available on the platform", "tags" : [ "Orders" ] } }, "/api/orders/documents/{document_id}" : { "delete" : { "description" : "", "operationId" : "OR76", "parameters" : [ { "description" : "Identifier of the document 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_ORDER_DOCUMENT_DELETE" ] } ], "summary" : "Delete an order document", "tags" : [ "Orders" ] } }, "/api/products/offers" : { "get" : { "description" : "", "operationId" : "P11", "parameters" : [ { "description" : "List of product's skus separated with comma. Limited to 100 values.\n\nOne of the two is required `product_ids` or `product_references`.\n", "explode" : true, "in" : "query", "name" : "product_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "List of the product's identifiers with type _(structure: \"`product_references=
false returns only active offers. If true return all offers.",
"explode" : true,
"in" : "query",
"name" : "all_offers",
"schema" : {
"type" : "boolean",
"default" : false
},
"style" : "form"
}, {
"description" : "List of the channel codes to filter with, using a comma (,) as a separator. If specified, only offers that can be sold on the specified channel(s) will be returned. If not, offers will be returned regardless of their channels.",
"explode" : true,
"in" : "query",
"name" : "channel_codes",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "If `false`, filters the offers with the given `channel_codes` or all shop channels if no `channel_codes` are given.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"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_WRITE" ]
} ],
"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"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_CONFIGURATION_READ" ]
} ],
"summary" : "Get the product attribute configuration",
"tags" : [ "Products" ]
}
},
"/api/promotions" : {
"get" : {
"description" : "",
"operationId" : "PR01",
"parameters" : [ {
"description" : "A comma separated list of identifiers for a promotion",
"explode" : true,
"in" : "query",
"name" : "ids",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "A comma separated list of types for a promotion [AMOUNT_OFF|FREE_ITEMS|PERCENTAGE_OFF|REDUCED_UNIT_PRICE]",
"explode" : true,
"in" : "query",
"name" : "types",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "A comma separated list of states for a promotion [PENDING|ACTIVE|EXPIRED|PENDING_APPROVAL|REJECTED|ALL]",
"explode" : true,
"in" : "query",
"name" : "states",
"schema" : {
"type" : "string",
"default" : "ACTIVE"
},
"style" : "form"
}, {
"description" : "Returns promotions which ended or will end after this date",
"explode" : true,
"in" : "query",
"name" : "ending_after",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Returns promotions which started or will start before this date",
"explode" : true,
"in" : "query",
"name" : "starting_before",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter promotion creation date lower limit",
"explode" : true,
"in" : "query",
"name" : "date_created_from",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter promotion creation date upper limit",
"explode" : true,
"in" : "query",
"name" : "date_created_to",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Last request date and time. We recommend using the differential mode along with the states parameter.",
"explode" : true,
"in" : "query",
"name" : "last_request_date",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "The locale to filter the medias and the public descriptions with. If not specified, medias and public descriptions of all locales are returned.If specified, only the media and the public description matching the locale will be returned, or, if not exist, the one matching the platform default locale.",
"explode" : true,
"in" : "query",
"name" : "locale",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Promotion-triggering offer ids, separated by commas",
"explode" : true,
"in" : "query",
"name" : "trigger_offer_ids",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Promotion reward offer ids, separated by commas",
"explode" : true,
"in" : "query",
"name" : "reward_offer_ids",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Channel codes on which promotions apply, separated by commas",
"explode" : true,
"in" : "query",
"name" : "channel_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"
}, {
"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/PR01_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PROMOTION_READ" ]
} ],
"summary" : "List promotions",
"tags" : [ "Promotions" ]
},
"post" : {
"description" : "",
"operationId" : "PR03",
"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/PR03_Request"
}
}
}
},
"responses" : {
"201" : {
"description" : "Created",
"headers" : {
"Location" : {
"description" : "URI of the created promotion",
"explode" : false,
"schema" : { },
"style" : "simple"
}
}
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN" ]
} ],
"summary" : "Create a promotion",
"tags" : [ "Promotions" ]
}
},
"/api/promotions/{promotion_internal_id}" : {
"put" : {
"description" : "",
"operationId" : "PR04",
"parameters" : [ {
"description" : "Promotion internal identifier",
"explode" : false,
"in" : "path",
"name" : "promotion_internal_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/PR04_Request"
}
}
}
},
"responses" : {
"200" : {
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN" ]
} ],
"summary" : "Update a promotion",
"tags" : [ "Promotions" ]
}
},
"/api/offers/pricing/imports" : {
"post" : {
"description" : "Import a .csv file to submit all applicable prices for an offer.multipart/form-data with name file.\"offer-sku\";\"price\";\"discount-price\";\"discount-start-date\";\"discount-end-date\"price-ranges and discount-rangeschannelsstart-date and end-datecustomer-organization-ids and customer-group-idsprice-type to define if you are providing a price or a retail price value\nshop_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/shipping/zones" : {
"get" : {
"description" : "Results are sorted by index, set in the back-office",
"operationId" : "SH11",
"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/SH11_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHIPPING_SETTINGS_READ" ]
} ],
"summary" : "List all active shipping zones",
"tags" : [ "Platform Settings" ]
}
},
"/api/shipping/types" : {
"get" : {
"description" : "Results are sorted by index, set in the back-office",
"operationId" : "SH12",
"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/SH12_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHIPPING_SETTINGS_READ" ]
} ],
"summary" : " List all active shipping methods",
"tags" : [ "Platform Settings" ]
}
},
"/api/shipping/carriers" : {
"get" : {
"description" : "Results are sorted alphabetically by carrier label",
"operationId" : "SH21",
"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/SH21_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHIPPING_SETTINGS_READ" ]
} ],
"summary" : "List all carriers",
"tags" : [ "Platform Settings" ]
}
},
"/api/shipping/logistic_classes" : {
"get" : {
"description" : "Results are sorted by index, set in the back-office",
"operationId" : "SH31",
"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/SH31_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHIPPING_SETTINGS_READ" ]
} ],
"summary" : "List all logistic classes",
"tags" : [ "Platform Settings" ]
}
},
"/api/shipping/configuration/shop" : {
"get" : {
"description" : "",
"operationId" : "SH42",
"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/SH42_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN" ]
} ],
"summary" : "Get shop shipping configuration",
"tags" : [ "Platform Settings" ]
}
},
"/api/shipping/charges/shop" : {
"get" : {
"description" : "Get shipping charges and their configuration",
"operationId" : "SH52",
"parameters" : [ {
"description" : "Retrieve only the shipping charge configurations customized by the seller",
"explode" : true,
"in" : "query",
"name" : "overridden_by_shop",
"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"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/SH52_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN" ]
} ],
"summary" : "Get shipping charges configured for a shop account",
"tags" : [ "Platform Settings" ]
}
},
"/api/shipments" : {
"post" : {
"description" : "Limited to 1000 shipments at a time",
"operationId" : "ST01",
"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/ST01_Request"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ST01_Response_201"
}
}
},
"description" : "Created"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIP" ]
} ],
"summary" : "Create shipments",
"tags" : [ "Multiple shipments" ]
},
"put" : {
"description" : "Limited to 100 shipments at a time",
"operationId" : "ST07",
"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/ST07_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ST07_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIPMENT_WRITE" ]
} ],
"summary" : "Update shipment shipping origin",
"tags" : [ "Multiple shipments" ]
},
"get" : {
"description" : "",
"operationId" : "ST11",
"parameters" : [ {
"description" : "Order id for filtering. This parameter can be supplied multiple times (order_id=OR01-A&order_id=OR02-A...).",
"explode" : true,
"in" : "query",
"name" : "order_id",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Shipment state code for filtering. This parameter can be supplied multiple times (shipment_state_code=SHIPPING&shipment_state_code=SHIPPED...).",
"explode" : true,
"in" : "query",
"name" : "shipment_state_code",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Shipment customer debit state code for filtering. This parameter can be supplied multiple times (shipment_customer_debit_state_code=WAITING_TAX_CONFIRMATION&shipment_customer_debit_state_code=DEBIT_OK...).",
"explode" : true,
"in" : "query",
"name" : "shipment_customer_debit_state_code",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Filter shipments updated after the given date.",
"explode" : true,
"in" : "query",
"name" : "last_updated_from",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter shipments updated before the given date.",
"explode" : true,
"in" : "query",
"name" : "last_updated_to",
"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/ST11_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_READ" ]
} ],
"summary" : "List shipments",
"tags" : [ "Multiple shipments" ]
}
},
"/api/shipments/delete" : {
"put" : {
"description" : "Limited to 1000 shipments at a time",
"operationId" : "ST06",
"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/ST06_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ST06_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIPMENT_DELETE" ]
} ],
"summary" : "Delete shipments",
"tags" : [ "Multiple shipments" ]
}
},
"/api/shipments/items_to_ship" : {
"get" : {
"description" : "",
"operationId" : "ST12",
"parameters" : [ {
"description" : "Order id for filtering. This parameter can be supplied multiple times (order_id=OR01-A&order_id=OR02-A...).",
"explode" : true,
"in" : "query",
"name" : "order_id",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Fulfillment center code for filtering. This parameter can be supplied multiple times (fulfillment_center_code=ABC&fulfillment_center_code=DEF...).",
"explode" : true,
"in" : "query",
"name" : "fulfillment_center_code",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
}, {
"description" : "Filter items that moved to shipping status after the given date.",
"explode" : true,
"in" : "query",
"name" : "shipping_date_from",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}, {
"description" : "Filter items that moved to shipping status before the given date.",
"explode" : true,
"in" : "query",
"name" : "shipping_date_to",
"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/ST12_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_READ", "ROLE_PARTNER_ORDER_SHIPMENT_READ" ]
} ],
"summary" : "List items to ship",
"tags" : [ "Multiple shipments" ]
}
},
"/api/shipments/tracking" : {
"post" : {
"description" : "If the carrier is not registered, the complete tracking url can be provided. Limited to 1000 shipments at a time.",
"operationId" : "ST23",
"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/ST23_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ST23_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_TRACKING_WRITE" ]
} ],
"summary" : "Update carrier tracking information for shipments",
"tags" : [ "Multiple shipments" ]
}
},
"/api/shipments/ship" : {
"put" : {
"description" : "Limited to 1000 shipments at a time",
"operationId" : "ST24",
"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/ST24_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ST24_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIP" ]
} ],
"summary" : "Validate shipments as shipped",
"tags" : [ "Multiple shipments" ]
}
},
"/api/shipments/ready_for_pick_up" : {
"put" : {
"description" : "Limited to 1000 shipments at a time",
"operationId" : "ST26",
"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/ST26_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ST26_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_PARTNER_ORDER_SHIPMENT_PICK_UP", "ROLE_SHOP_ADMIN" ]
} ],
"summary" : "Validate shipments as ready to pick up",
"tags" : [ "Multiple shipments" ]
}
},
"/api/shipments/additional_information" : {
"put" : {
"description" : "Limited to 100 shipments at a time",
"operationId" : "ST31",
"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/ST31_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ST31_Response_200"
}
}
},
"description" : "OK"
}
},
"security" : [ {
"Shop-API-Key" : [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIP" ]
} ],
"summary" : "Update shipment additional information",
"tags" : [ "Multiple shipments" ]
}
},
"/api/offers/stock/imports" : {
"post" : {
"description" : "Import a .csv file to update stock for offers, either globally or per warehouse.multipart/form-data with name file.\"offer-sku\";\"quantity\";\"warehouse-code\";\"update-delete\"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.